class Printonly extends Module implements MetaPropertyInterface

Can be used as an all purpose hidden property but the intent is a meta property that exists only in print components and is hidden but still tracked on the web.

Methods

string
getType()

React type

boolean
validate(MetaProperty $prop)

Validate the property value

mixed
sanitize(mixed $value)

Clean the submitted input

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 20
string getType()

React type

Return Value

string 'TextMetaProperty'

at line line 30
boolean validate(MetaProperty $prop)

Validate the property value

Parameters

MetaProperty $prop property

Return Value

boolean

at line line 40
mixed sanitize(mixed $value)

Clean the submitted input

Parameters

mixed $value

Return Value

mixed

at line line 50
object beforeSave(MetaProperty $prop)

Called by parent model's beforeSave method

Parameters

MetaProperty $prop &$prop property

Return Value

object Self

at line line 60
object afterSave(MetaProperty $prop)

Called by parent model's afterSave method

Parameters

MetaProperty $prop &$prop property

Return Value

object Self

at line line 72
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