\Charcoal\Admin\Property\InputStructureWidgetInput

setDependencies()

setDependencies(\Pimple\Container  $container) : void

Inject dependencies from a DI Container.

Parameters

setFormGroup()

setFormGroup(\Charcoal\Ui\FormGroup\FormGroupInterface  $formGroup) : \Charcoal\Ui\FormInput\FormInputInterface

Set the form input's parent group.

Parameters

Returns

Chainable

formGroup()

formGroup() : \Charcoal\Ui\FormGroup\FormGroupInterface

Retrieve the input's parent group.

Returns

widget()

widget() : \Charcoal\App\Template\WidgetInterface|\Charcoal\Admin\Ui\Generator

Yield the nested widget.

Returns

getWidget()

getWidget() : \Charcoal\App\Template\WidgetInterface

Retrieve the nested widget.

Returns

setWidgetData()

setWidgetData(array  $settings) : self

Set the nested widget's options.

This method always merges default settings.

Parameters

Returns

mergeWidgetData()

mergeWidgetData(array  $settings) : self

Merge (replacing or adding) nested widget options.

Parameters

Returns

addWidgetData()

addWidgetData(string  $key, mixed  $val) : self

Add (or replace) an nested widget option.

Parameters

Throws

\InvalidArgumentException

If the identifier is not a string.

Returns

widgetData()

widgetData(string|null  $key = null, mixed|null  $default = null) : mixed

Retrieve the nested widget's options or a single option.

Parameters

Returns

defaultWidgetData()

defaultWidgetData() : array

Retrieve the default structure widget options.

Returns

widgetDataAsJson()

widgetDataAsJson() : string

Retrieve the nested widget's options as a JSON string.

Returns

Returns data serialized with {@see json_encode()}.

renderableData()

renderableData() : array

Retrieve the nested widget's renderable options.

Returns

setRenderableData()

setRenderableData(array  $data) : self

Set the nested widget's renderable options.

Parameters

Returns

__construct()

__construct(array|\ArrayAccess  $data = null) 

Parameters

setData()

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

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\PropertyInputInterface

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

hidden()

hidden() : boolean

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

setReadOnly()

setReadOnly(boolean  $readOnly) : \Charcoal\Admin\Property\Widget

Parameters

Returns

(Chainable)

readOnly()

readOnly() : boolean

Returns

setRequired()

setRequired(boolean  $required) : \Charcoal\Admin\Property\Widget

Parameters

Returns

(Chainable)

required()

required() : boolean

Returns

setDisabled()

setDisabled(boolean  $disabled) : \Charcoal\Admin\Property\Widget

Parameters

Returns

(Chainable)

disabled()

disabled() : boolean

Returns

setMultiple()

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

Parameters

Returns

(Chainable)

multiple()

multiple() : boolean

Returns

setPlaceholder()

setPlaceholder(mixed  $placeholder) : \Charcoal\Admin\Property\AbstractPropertyInput

Set the form control's placeholder.

A placeholder is a hint to the user of what can be entered in the property control.

Parameters

Returns

Chainable

placeholder()

placeholder() : \Charcoal\Translator\Translation|string|null

Retrieve the placeholder.

Returns

setInputId()

setInputId(string  $inputId) : \Charcoal\Admin\Property\AbstractPropertyInput

Set the input ID.

Used for the HTML "ID" attribute.

Parameters

Returns

Chainable

inputId()

inputId() : string

Retrieve the input ID.

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

Returns

setInputClass()

setInputClass(string  $inputClass) : \Charcoal\Admin\Property\AbstractPropertyInput

Parameters

Throws

\InvalidArgumentException

If the class is not a string.

Returns

Chainable

inputClass()

inputClass() : string

Returns

setInputName()

setInputName(string  $inputName) : \Charcoal\Admin\Property\AbstractPropertyInput

Set the input name.

Used for the HTML "name" attribute.

Parameters

Returns

Chainable

inputName()

inputName() : string

Retrieve the input name.

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

Returns

inputVal()

inputVal() : string

Throws

\UnexpectedValueException

If the value is invalid.

Returns

setInputMode()

setInputMode(string  $inputMode) : \Charcoal\Admin\Property\AbstractPropertyInput

Set the hint to the browser for which keyboard to display.

Parameters

Throws

\InvalidArgumentException

If the provided argument is not a string.

Returns

Chainable

inputMode()

inputMode() : string

Retrieve the hint to the browser for which keyboard to display.

Returns

setInputType()

setInputType(string  $inputType) : \Charcoal\Admin\Property\AbstractPropertyInput

Parameters

Throws

\InvalidArgumentException

If the provided argument is not a string.

Returns

Chainable

inputType()

inputType() : string

Returns

hasInputAffix()

hasInputAffix() : boolean

Determine if the property has an affix.

Textual <input>s only

Avoid using <select> elements here as they cannot be fully styled in WebKit browsers.

Avoid using <textarea> elements here as their rows attribute will not be respected in some cases.

Returns

setInputPrefix()

setInputPrefix(mixed  $affix) : self

Retrieve the control's prefix.

Parameters

Throws

\InvalidArgumentException

If the suffix is not translatable.

Returns

inputPrefix()

inputPrefix() : \Charcoal\Translator\Translation|string|null

Retrieve the control's prefix.

Returns

setInputSuffix()

setInputSuffix(mixed  $affix) : self

Retrieve the control's suffix.

Parameters

Throws

\InvalidArgumentException

If the suffix is not translatable.

Returns

inputSuffix()

inputSuffix() : \Charcoal\Translator\Translation|string|null

Retrieve the control's suffix.

Returns

setType()

setType(string  $type) : \Charcoal\Admin\Property\AbstractPropertyInput

Set the control type for the HTML element `<input>`.

Parameters

Throws

\InvalidArgumentException

If the provided argument is not a string.

Returns

Chainable

type()

type() : string

Retrieve the control type for the HTML element `<input>`.

Returns

propertyIdent()

propertyIdent() : string

Returns

setProperty()

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

Parameters

Returns

Chainable

property()

property() : \Charcoal\Property\PropertyInterface

Returns

p()

p() : \Charcoal\Property\PropertyInterface

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

Returns

renderTranslatableTemplate()

renderTranslatableTemplate(mixed  $templateString) : string

Render the given template from string.

Parameters

Returns

The rendered template.

setWidgetFactory()

setWidgetFactory(\Charcoal\Factory\FactoryInterface  $factory) : self

Set the widget factory.

Parameters

Returns

widgetFactory()

widgetFactory() : \Charcoal\Factory\FactoryInterface

Retrieve the widget factory.

Throws

\RuntimeException

If the widget factory was not previously set.

Returns

setFormGroupFactory()

setFormGroupFactory(\Charcoal\Factory\FactoryInterface  $factory) : self

Set the form group factory.

Parameters

Returns

formGroupFactory()

formGroupFactory() : \Charcoal\Factory\FactoryInterface

Retrieve the form group factory.

Throws

\RuntimeException

If the form group factory was not previously set.

Returns

createWidget()

createWidget() : \Charcoal\App\Template\WidgetInterface

Create the nested widget.

Throws

\DomainException

If the widget is not a structure widget.

Returns

resolveWidget()

resolveWidget(string  $type) : \Charcoal\App\Template\WidgetInterface

Resolve the nested widget.

Parameters

Throws

\InvalidArgumentException

If the widget is invalid.

Returns

renderDataRecursive()

renderDataRecursive(array|\Traversable  $data) : array|\Traversable

Render the given data recursively.

Parameters

Throws

\InvalidArgumentException

If the data is not iterable.

\RuntimeException

If the form doesn't have a model.

Returns

The rendered data.

renderData()

renderData(string  $data) : string

Render the given data.

Parameters

Returns

The rendered data.

createMetadata()

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

Parameters

Returns

generateInputId()

generateInputId() : string

Generate a unique input ID.

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.

parseDataToken()

parseDataToken(string|array  $token) : string

Parse the given slug (URI token) for the current object.

Parameters

Throws

\InvalidArgumentException

If a route token is not a string.

Returns

filterDataToken()

filterDataToken(mixed  $value, string  $token = null) : string

Filter the given value for a URI.

Parameters

Returns

The filtered $value.

camelize()

camelize(string  $str) : string

Transform a snake_case string to camelCase.

Parameters

Returns

The camelCase string.