NamedPropertyBehaviorBuilder
A builder object for the NamedPropertyBehavior class.
NamedPropertyBehavior accepts an instance of this object as a constructor argument.
Table of Contents
| $name | Property name | string |
|---|---|---|
| $validate | Validate data closure for save() [bool is valid] = function( IProperty, [input value] ) | Closure |
| $getter | Get value callback | Closure |
| $setter | Set value callback | Closure |
| $mgetter | Get value callback | Closure |
| $msetter | Set value callback | Closure |
| $init | Initializer callback | Closure |
| $beforeSave | Before save | Closure |
| $afterSave | After save | Closure |
| $mValidate | Model Validation | Closure|null |
| __construct() | Create a new property behavior builder | mixed |
| getName() | Retrieve the property name | string |
| withValidate() | Validate some property value IProperty $prop Property object mixed $value The property value return is valid throws ValidationException | self |
| getValidate() | Retrieve the validate closure | Closure|null |
| withGetter() | Modify the value of some property on get. | self |
| getGetter() | Retrieve the getter function | Closure|null |
| withSetter() | Modify the value of some property prior to committing the value to the underlying property. | self |
| getSetter() | Retrieve the setter function | Closure|null |
| withModelGetter() | Modify the value of some property on get. | self |
| getModelGetter() | Retrieve the model getter function | Closure|null |
| withModelSetter() | Modify the value of some property prior to committing the value to the underlying property. | self |
| getModelSetter() | Get the model setter function | Closure|null |
| withInit() | A callback used to initialize the default value within the model. | self |
| getInit() | Get the init function | Closure|null |
| withBeforeSave() | Called prior to the save event and is returned as part of the save function chain. | self |
| getBeforeSave() | Retrieve the before save function | Closure|null |
| withAfterSave() | Called after the save event and is returned as part of the save function chain. | self |
| getAfterSave() | Retrieve the after save function | Closure|null |
| withModelValidation() | Sets the model validation callback. | this |
| getModelValidation() | Retrieve the model validation callback. | Closure|null |
| build() | Retrieve the NamedPropertyBehavior instance | NamedPropertyBehavior |
Properties
$name
Property name
private
string
$name
$validate
Validate data closure for save() [bool is valid] = function( IProperty, [input value] )
private
Closure
$validate
= null
$getter
Get value callback
private
Closure
$getter
= null
$setter
Set value callback
private
Closure
$setter
= null
$mgetter
Get value callback
private
Closure
$mgetter
= null
$msetter
Set value callback
private
Closure
$msetter
= null
$init
Initializer callback
private
Closure
$init
= null
$beforeSave
Before save
private
Closure
$beforeSave
= null
$afterSave
After save
private
Closure
$afterSave
= null
$mValidate
Model Validation
private
Closure|null
$mValidate
= null
Methods
__construct()
Create a new property behavior builder
public
__construct(
$name :
string
)
: mixed
Parameters
- $name : string
Property name. All supplied functions will only apply to the specified name.
Tags
Return values
mixedgetName()
Retrieve the property name
public
getName(
)
: string
Return values
string —name
withValidate()
Validate some property value IProperty $prop Property object mixed $value The property value return is valid throws ValidationException
public
withValidate(
$f :
Closure
)
: self
f( IProperty $prop, mixed $value ) : bool
Parameters
- $f : Closure
function
Return values
self —this
getValidate()
Retrieve the validate closure
public
getValidate(
)
: Closure|null
Return values
Closure|nullwithGetter()
Modify the value of some property on get.
public
withGetter(
$f :
Closure
)
: self
IProperty $prop Property object mixed $value The property value f( IProperty $prop, mixed $value ) : void
Parameters
- $f : Closure
function
Return values
self —this
getGetter()
Retrieve the getter function
public
getGetter(
)
: Closure|null
Return values
Closure|null —function
withSetter()
Modify the value of some property prior to committing the value to the underlying property.
public
withSetter(
$f :
Closure
)
: self
IProperty $prop Property object mixed $value The property value f( IProperty $prop, mixed $value ) : void
Parameters
- $f : Closure
function
Return values
self —this
getSetter()
Retrieve the setter function
public
getSetter(
)
: Closure|null
Return values
Closure|null —function
withModelGetter()
Modify the value of some property on get.
public
withModelGetter(
$f :
Closure
)
: self
Called prior to getter callback.
IModel $model The model containing the property IProperty $prop Property object mixed $value The property value f( IModel $model, IProperty $prop, mixed $value ) : void
Parameters
- $f : Closure
function
Return values
self —this
getModelGetter()
Retrieve the model getter function
public
getModelGetter(
)
: Closure|null
Return values
Closure|null —function
withModelSetter()
Modify the value of some property prior to committing the value to the underlying property.
public
withModelSetter(
$f :
Closure
)
: self
Called prior to setter callback.
IModel $model The model containing the property IProperty $prop Property object mixed $value The property value f( IModel $model, IProperty $prop, mixed $value ) : void
Parameters
- $f : Closure
function
Return values
self —this
getModelSetter()
Get the model setter function
public
getModelSetter(
)
: Closure|null
Return values
Closure|null —function
withInit()
A callback used to initialize the default value within the model.
public
withInit(
$f :
Closure
)
: self
This is called only once, when the model is first loaded.
Default value is supplied, and the returned value is used as the new default value.
f( mixed $defaultValue ) : mixed
Parameters
- $f : Closure
function
Return values
self —this
getInit()
Get the init function
public
getInit(
)
: Closure|null
Return values
Closure|null —function
withBeforeSave()
Called prior to the save event and is returned as part of the save function chain.
public
withBeforeSave(
$f :
Closure
)
: self
f( IModel $model ) : \buffalokiwi\magicgraph\persist\IRunnable
This is only used with IPropertySvcConfig instances.
Parameters
- $f : Closure
function
Return values
self —this
getBeforeSave()
Retrieve the before save function
public
getBeforeSave(
)
: Closure|null
Return values
Closure|null —function
withAfterSave()
Called after the save event and is returned as part of the save function chain.
public
withAfterSave(
$f :
Closure
)
: self
f( IModel $model ) : \buffalokiwi\magicgraph\persist\IRunnable
This is only used with IPropertySvcConfig instances.
Parameters
- $f : Closure
function
Return values
self —this
getAfterSave()
Retrieve the after save function
public
getAfterSave(
)
: Closure|null
Return values
Closure|null —function
withModelValidation()
Sets the model validation callback.
public
withModelValidation(
$f :
Closure
)
: this
f( IModel $model ) throws ValidationException
Parameters
- $f : Closure
function
Return values
thisgetModelValidation()
Retrieve the model validation callback.
public
getModelValidation(
)
: Closure|null
f( IModel $model ) throws ValidationException
Return values
Closure|nullbuild()
Retrieve the NamedPropertyBehavior instance
public
build(
)
: NamedPropertyBehavior
Return values
NamedPropertyBehavior —behavior