OneManyPropertyService extends AbstractOneManyPropertyService
Contains some of the base programming for a property service backed by a single repository and an array property full of IModel instances.
Table of Contents
| $repo | Repo | IRepository |
|---|---|---|
| $foreignKey | Property name from repo that this queries | string |
| $propCfg | Property config for the service | IPropertySvcConfig |
| $lastId | Last id from getValue() | int |
| $init | ||
| __construct() | Create a new property service | mixed |
| loadModels() | Loads the models from some source | array |
| loadModels() | Loads the models from some source | array |
| __construct() | Create a new property service | mixed |
| getModelServiceConfig() | Get the property config for the main property set | IPropertySvcConfig |
| getSaveFunction() | Retrieve the save function used for saving stuff from the provider. | IRunnable |
| 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 |
| init() | Initialize the model. | void |
| getPropertyConfig() | Get the property config for the main property set | IPropertyConfig |
| callLoadModels() | array | |
| hasAllPriKeyValues() | Test to see if some model has values for all primary keys | bool |
Properties
$repo
Repo
private
IRepository
$repo
$foreignKey
Property name from repo that this queries
private
string
$foreignKey
$propCfg
Property config for the service
private
IPropertySvcConfig
$propCfg
$lastId
Last id from getValue()
private
int
$lastId
= []
$init
private
mixed
$init
= []
Methods
__construct()
Create a new property service
public
__construct(
$cfg :
IPropertyConfig
, $repo :
IRepository
, $foreignKey :
string
)
: mixed
Parameters
- $cfg : IPropertyConfig
- $repo : IRepository
- $foreignKey : string
Property name from supplied IRepository that is queried against IPropertySvcConfig::getPropertyName();
Return values
mixedloadModels()
Loads the models from some source
protected
loadModels(
$parentId :
int
)
: array
Parameters
- $parentId : int
Return values
arrayloadModels()
Loads the models from some source
protected
abstract loadModels(
$parentId :
int
)
: array
Parameters
- $parentId : int
Return values
array__construct()
Create a new property service
public
__construct(
$cfg :
IPropertyConfig
)
: mixed
Parameters
- $cfg : IPropertyConfig
Return values
mixedgetModelServiceConfig()
Get the property config for the main property set
public
getModelServiceConfig(
)
: IPropertySvcConfig
Return values
IPropertySvcConfig —config
getSaveFunction()
Retrieve the save function used for saving stuff from the provider.
public
getSaveFunction(
$parent :
IModel
)
: IRunnable
Parameters
- $parent : IModel
Return values
IRunnablegetValue()
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
init()
Initialize the model.
public
init(
$model :
IModel
)
: void
Parameters
- $model : IModel
Model instance
getPropertyConfig()
Get the property config for the main property set
public
getPropertyConfig(
)
: IPropertyConfig
Return values
IPropertyConfig —config
callLoadModels()
private
callLoadModels(
$parentId :
int
)
: array
Parameters
- $parentId : int
Return values
arrayhasAllPriKeyValues()
Test to see if some model has values for all primary keys
private
hasAllPriKeyValues(
$model :
IModel
)
: bool
Parameters
- $model : IModel
Model
Return values
bool —has all keys