IPropertySvcConfig extends IPropertyConfig
Property service configuration
Table of Contents
| getPropertyName() | Retrieve the property name used to load the backing model for a property service. | string |
|---|---|---|
| getModelPropertyName() | Retrieve the property name used for the backing model for some property service. | string |
| getSaveFunction() | Retrieve a save function to be used with some transaction. | IRunnable |
| getConfig() | Retrieve the config array | array |
| getPropertyNames() | Retrieve a list of property names defined via this config | array |
| beforeSave() | Called via SaveableMappingObjectFactory, and happens as part of the beforeSave event. | void |
| afterSave() | Called via SaveableMappingObjectFactory, and happens as part of the afterSave event. | void |
Methods
getPropertyName()
Retrieve the property name used to load the backing model for a property service.
public
getPropertyName(
)
: string
In an alternate configuration, this property can be used as the backing array of model property name;
Return values
string —name
getModelPropertyName()
Retrieve the property name used for the backing model for some property service.
public
getModelPropertyName(
)
: string
In an alternate configuration, this function may return an empty string.
Return values
string —name
getSaveFunction()
Retrieve a save function to be used with some transaction.
public
getSaveFunction(
$parent :
IModel
)
: IRunnable
Parameters
- $parent : IModel
Model this provider is linked to
Tags
Return values
IRunnable —Something the saves data
getConfig()
Retrieve the config array
public
getConfig(
)
: array
Return values
array —config
getPropertyNames()
Retrieve a list of property names defined via this config
public
getPropertyNames(
)
: array
Return values
array —names
beforeSave()
Called via SaveableMappingObjectFactory, and happens as part of the beforeSave event.
public
beforeSave(
$model :
IModel
)
: void
Parameters
- $model : IModel
Model being saved
afterSave()
Called via SaveableMappingObjectFactory, and happens as part of the afterSave event.
public
afterSave(
$model :
IModel
)
: void
Parameters
- $model : IModel
Model being saved