ISaveableObjectFactory extends IObjectFactory
Table of Contents
| save() | Save some record. | void |
|---|---|---|
| saveAll() | Saves a batch of records. | void |
| remove() | Removes a model. | void |
| removeById() | Remove an entry by id. This does not work for compound keys. | void |
| create() | Create a new Model instance using the internal data mapper. | IModel |
| createPropertyNameSet() | Retrieves a set containing the property names. | IBigSet |
| createPropertySet() | Clones and returns the internal property set used to construct objects. | IPropertySet |
| addPropertyConfig() | Adds an additional property config to this repo. | mixed |
Methods
save()
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.
Parameters
- $model : IModel
Model to save
Tags
remove()
Removes a model.
public
remove(
$model :
IModel
)
: void
Parameters
- $model : IModel
Model to remove
Tags
removeById()
Remove an entry by id. This does not work for compound keys.
public
removeById(
$id :
string
)
: void
Parameters
- $id : string
id
Tags
create()
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
createPropertyNameSet()
Retrieves a set containing the property names.
public
createPropertyNameSet(
)
: IBigSet
Return values
IBigSet —set
createPropertySet()
Clones and returns the internal property set used to construct objects.
public
createPropertySet(
)
: IPropertySet
Return values
IPropertySet —property set
addPropertyConfig()
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...
Parameters
- $config : type