\Charcoal\Admin\Property\DisplayObjectDisplay

__construct()

__construct(array|\Charcoal\Admin\Property\ArrayAccess  $data = null) 

Parameters

setDependencies()

setDependencies(\Pimple\Container  $container) : void

Inject dependencies from a DI Container.

Parameters

setData()

setData(array  $data) : \Charcoal\Admin\Property\Display

This function takes an array and fill the model object with its value.

This method either calls a setter for each key (set_{$key}()) or sets a public member.

For example, calling with setData(['properties'=>$properties]) would call setProperties($properties), becasue setProperties() exists.

But calling with setData(['foobar'=>$foo]) would set the $foobar member on the metadata object, because the method set_foobar() does not exist.

Parameters

Returns

Chainable

setPropertyVal()

setPropertyVal(mixed  $val) : \Charcoal\Admin\Property\PropertyDisplayInterface

Parameters

Returns

Chainable

propertyVal()

propertyVal() : mixed

Returns

setLang()

setLang(string  $lang) : \Charcoal\Admin\Property\PropertyInputInterface

Parameters

Returns

Chainable

lang()

lang() : string

Get the input language

Returns

setIdent()

setIdent(string  $ident) : \Charcoal\Admin\Property\Widget

Parameters

Throws

\InvalidArgumentException

If the ident is not a string.

Returns

Chainable

ident()

ident() : string

Returns

setMultiple()

setMultiple(boolean  $multiple) : \Charcoal\Admin\Property\Widget

Parameters

Returns

(Chainable)

multiple()

multiple() : boolean

Returns

setDisplayId()

setDisplayId(string  $displayId) : \Charcoal\Admin\Property\Display

Parameters

Returns

Chainable

displayId()

displayId() : string

Get the display ID.

If none was previously set, than a unique random one will be generated.

Returns

setDisplayClass()

setDisplayClass(string  $displayClass) : \Charcoal\Admin\Property\AbstractPropertyDisplay

Parameters

Throws

\InvalidArgumentException

If the class is not a string.

Returns

Chainable

displayClass()

displayClass() : string

Returns

setDisplayName()

setDisplayName(string  $displayName) : \Charcoal\Admin\Property\AbstractPropertyInput

Set the display name.

Used for the HTML "name" attribute.

Parameters

Returns

Chainable

displayName()

displayName() : string

Retrieve the display name.

The input name should always be the property's ident.

Returns

displayVal()

displayVal() : string

Returns

setDisplayType()

setDisplayType(string  $displayType) : \Charcoal\Admin\Property\AbstractPropertyDisplay

Parameters

Throws

\InvalidArgumentException

If provided argument is not of type 'string'.

Returns

Chainable

displayType()

displayType() : string

Returns

propertyIdent()

propertyIdent() : string

Returns

setProperty()

setProperty(\Charcoal\Property\PropertyInterface  $p) : \Charcoal\Admin\Property\AbstractPropertyDisplay

Parameters

Returns

Chainable

property()

property() : \Charcoal\Property\PropertyInterface

Returns

p()

p() : \Charcoal\Property\PropertyInterface

Alias of {@see self::property()}

Returns

createMetadata()

createMetadata(array  $data = null) : \Charcoal\Property\PropertyMetadata

Parameters

Returns

getter()

getter(string  $key) : string

Allow an object to define how the key getter are called.

Parameters

Returns

The getter method name, for a given key.

setter()

setter(string  $key) : string

Allow an object to define how the key setter are called.

Parameters

Returns

The setter method name, for a given key.

camelize()

camelize(string  $str) : string

Transform a snake_case string to camelCase.

Parameters

Returns

The camelCase string.