IModelPropertyProvider extends IPropertyServiceProvider
This is a common interface used to create relationships between different data sources attached to a single model. (Think foreign keys in a database).
This provider is normally coupled to a repository, and will pull one or more records from that repo based on some property value within the model this property is attached.
Table of Contents
| init() | Initialize the model. | void |
|---|---|---|
| getValue() | Retrieve the value of some property | mixed |
| setValue() | Sets the value of some property | void |
| validate() | Test to see if this model is valid prior to save() | void |
| getModelServiceConfig() | Retrieve the configuration used to build this provider | IPropertySvcConfig |
| getPropertyConfig() | Get the property config for the main property set | IPropertyConfig |
| getSaveFunction() | Retrieve the save function used for saving stuff from the provider. | IRunnable |
Methods
init()
Initialize the model.
public
init(
$model :
IModel
)
: void
Parameters
- $model : IModel
Model instance
getValue()
Retrieve the value of some property
public
getValue(
$model :
IModel
, $value :
mixed
[, $context :
array
= [] ]
)
: mixed
Parameters
- $model : IModel
- $value : mixed
- $context : array = []
Tags
Return values
mixed —value
setValue()
Sets the value of some property
public
setValue(
$model :
IModel
, $value :
mixed
)
: void
Parameters
- $model : IModel
- $value : mixed
property value
Tags
validate()
Test to see if this model is valid prior to save()
public
validate(
$model :
IModel
)
: void
Parameters
- $model : IModel
Tags
getModelServiceConfig()
Retrieve the configuration used to build this provider
public
getModelServiceConfig(
)
: IPropertySvcConfig
Return values
IPropertySvcConfig —config
getPropertyConfig()
Get the property config for the main property set
public
getPropertyConfig(
)
: IPropertyConfig
Return values
IPropertyConfig —config
getSaveFunction()
Retrieve the save function used for saving stuff from the provider.
public
getSaveFunction(
$parent :
IModel
)
: IRunnable
Parameters
- $parent : IModel