1. interface
  2. Ceo
  3. Core
  4. MetaProperties
  5. MetaPropertyInterface

MetaPropertyInterface

interface MetaPropertyInterface

Describes standard meta property interface

Methods

string
getType()

React type

boolean
validate(MetaProperty $prop)

Validate the property value

mixed
sanitize(mixed $value)

Sanitize the property value

object
beforeSave(MetaProperty $prop)

Called by parent model's beforeSave method

object
afterSave(MetaProperty $prop)

Called by parent model's afterSave method

Array
toArray(MetaProperty $prop, array $return)

Called by parent model's toArray. Should return the modified array

Details

at line line 19
string getType()

React type

Return Value

string 'TextMetaProperty'

at line line 26
boolean validate(MetaProperty $prop)

Validate the property value

Parameters

MetaProperty $prop property

Return Value

boolean

at line line 33
mixed sanitize(mixed $value)

Sanitize the property value

Parameters

mixed $value

Return Value

mixed

at line line 40
object beforeSave(MetaProperty $prop)

Called by parent model's beforeSave method

Parameters

MetaProperty $prop &$prop property

Return Value

object Self

at line line 47
object afterSave(MetaProperty $prop)

Called by parent model's afterSave method

Parameters

MetaProperty $prop &$prop property

Return Value

object Self

at line line 56
Array toArray(MetaProperty $prop, array $return)

Called by parent model's toArray. Should return the modified array

Parameters

MetaProperty $prop The property
array $return The pre-processed array to return

Return Value

Array Array with modifications