SaveableMappingObjectFactory extends MappingObjectFactory implements ISaveableObjectFactory
Tags
Table of Contents
| $mapper | Data mapper | IModelMapper |
|---|---|---|
| $properties | Properties | IPropertySet |
| $pNames | Property names | string[] |
| saveModel() | What to do when saving the model. | mixed |
| save() | Save some record. | void |
| saveAll() | Saves a batch of records. | void |
| beforeSave() | Called before the repo save call is made. | void |
| afterSave() | Called after the repo save call is made | void |
| beforeValidate() | Called before the validate call is made | void |
| getSaveClosure() | Retrieve an IRunnable instance to be used with some ITransaction instance. | Closure |
| runBeforeSave() | void | |
| runAfterSave() | void | |
| __construct() | mixed | |
| addPropertyConfig() | Adds an additional property config to this repo. | mixed |
| create() | Create a new Model instance using the internal data mapper. | IModel |
| createPropertySet() | Clones and returns the internal property set used to construct objects. | IPropertySet |
| createPropertyNameSet() | Retrieves a set containing the property names. | IBigSet |
| test() | Test that one or more models is the correct type. | void |
| mapper() | IModelMapper | |
| properties() | IPropertySet | |
| getInsertProperties() | IBigSet | |
| getModifiedProperties() | IBigSet | |
| filterPropertyNamesForSave() | Removes any properties flagged with SUBCONFIG from the list of property names | array |
Properties
$mapper
Data mapper
private
IModelMapper
$mapper
$properties
Properties
private
IPropertySet
$properties
$pNames
Property names
private
string[]
$pNames
Methods
saveModel()
What to do when saving the model.
protected
abstract saveModel(
$model :
IModel
)
: mixed
ie: commit to some database or whatever.
Parameters
- $model : IModel
Model to save
Tags
Return values
mixedsave()
Save some record.
public
save(
$model :
IModel
[, $validate :
bool
= true ]
)
: void
If the primary key value is specified, this is considered to be an update. Otherwise, this is considered to be an insert.
Parameters
- $model : IModel
Model to save
- $validate : bool = true
Validate the model prior to save
Tags
saveAll()
Saves a batch of records.
public
saveAll(
...$model :
IModel
)
: void
All records are first validated, then saved sequentially. Validation exceptions will be thrown prior to any saves happening.
If the primary key value is specified, this is considered to be an update. Otherwise, this is considered to be an insert.
This is split into 3 batches (iterations of supplied models):
1) beforeValidate, validate and beforeSave 2) saveModel 3) afterSave
Parameters
- $model : IModel
Model to save
Tags
beforeSave()
Called before the repo save call is made.
protected
beforeSave(
$model :
IModel
)
: void
Parameters
- $model : IModel
afterSave()
Called after the repo save call is made
protected
afterSave(
$model :
IModel
)
: void
Parameters
- $model : IModel
beforeValidate()
Called before the validate call is made
protected
beforeValidate(
$model :
IModel
)
: void
Parameters
- $model : IModel
getSaveClosure()
Retrieve an IRunnable instance to be used with some ITransaction instance.
protected
final getSaveClosure(
$beforeSave :
Closure
, $afterSave :
Closure
, ...$models :
IModel
)
: Closure
This runnable will execute the supplied function prior to saving the model.
Parameters
- $beforeSave : Closure
What to run prior to saving f( IRepository, ...IModel )
- $afterSave : Closure
What to run after saving f( IRepository, ...IModel )
- $models : IModel
One or more models to save
Return values
Closure —Function
runBeforeSave()
private
runBeforeSave(
$model :
IModel
)
: void
Parameters
- $model : IModel
runAfterSave()
private
runAfterSave(
$model :
IModel
)
: void
Parameters
- $model : IModel
__construct()
public
__construct(
$mapper :
IModelMapper
[, $properties :
IPropertySet|null
= null ]
)
: mixed
Parameters
- $mapper : IModelMapper
- $properties : IPropertySet|null = null
Return values
mixedaddPropertyConfig()
Adds an additional property config to this repo.
public
addPropertyConfig(
...$config :
type
)
: mixed
When models reference themselves, sometimes it's necessary for a property config to reference the repository (circular).
Feels a bit like cheating to me...
Warning: This method should only be caled from composition root. This can obviously have some unintended side effects when used in other locations.
Parameters
- $config : type
Return values
mixedcreate()
Create a new Model instance using the internal data mapper.
public
create(
$data :
array
[, $readOnly :
bool
= false ]
)
: IModel
Parameters
- $data : array
Raw data to use
- $readOnly : bool = false
Set the produced model to read only
Tags
Return values
IModel —model instance
createPropertySet()
Clones and returns the internal property set used to construct objects.
public
createPropertySet(
)
: IPropertySet
Return values
IPropertySet —property set
createPropertyNameSet()
Retrieves a set containing the property names.
public
createPropertyNameSet(
)
: IBigSet
Return values
IBigSet —set
test()
Test that one or more models is the correct type.
protected
test(
...$models :
IModel
)
: void
Parameters
- $models : IModel
Models
mapper()
protected
mapper(
)
: IModelMapper
Return values
IModelMapperproperties()
protected
properties(
)
: IPropertySet
Return values
IPropertySetgetInsertProperties()
protected
getInsertProperties(
$model :
IModel
)
: IBigSet
Parameters
- $model : IModel
Return values
IBigSetgetModifiedProperties()
protected
getModifiedProperties(
$model :
IModel
)
: IBigSet
Parameters
- $model : IModel
Return values
IBigSetfilterPropertyNamesForSave()
Removes any properties flagged with SUBCONFIG from the list of property names
private
filterPropertyNamesForSave(
$names :
string[]
, $model :
IModel
)
: array
Parameters
- $names : string[]
Property names
- $model : IModel
Tags
Return values
array —filtered names