\Charcoal\Admin\Property\InputDualSelectInput

choices()

choices() : \Charcoal\Admin\Property\Generator|array

Retrieve the selectable options.

Returns

isChoiceSelected()

isChoiceSelected(mixed  $choice) : boolean

Determine if the provided option is a selected value.

Parameters

Returns

setEmptyChoice()

setEmptyChoice(array|string  $choice) : \Charcoal\Admin\Property\PropertyInputInterface

Set the empty option's structure.

Parameters

Throws

\InvalidArgumentException

If the choice structure is invalid.

Returns

Chainable

emptyChoice()

emptyChoice() : array|null

Retrieve the empty option structure.

Returns

mapObjToChoice()

mapObjToChoice(array|\ArrayAccess  $obj) : array

Convert the given object into a choice structure.

Parameters

Returns

setChoiceObjMap()

setChoiceObjMap(array  $map) : \Charcoal\Admin\Property\TagsInput

Set the object-to-choice data map.

Parameters

Returns

Chainable

choiceObjMap()

choiceObjMap() : array

Retrieve the object-to-choice data map.

Returns

Returns a data map to abide.

inputNameFallback()

inputNameFallback() : string

Retrieve the property input name without `[]` as fallback.

This allows to submit empty value from select input while preventing submitting the fallback when the property is multiple.

Returns

defaultChoiceObjMap()

defaultChoiceObjMap() : array

Retrieve the default object-to-choice data map.

Returns

__construct()

__construct(array|\ArrayAccess  $data = null) 

Parameters

setDependencies()

setDependencies(\Pimple\Container  $container) : void

Inject dependencies from a DI Container.

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.

unselectedChoices()

unselectedChoices() : \Charcoal\Admin\Property\Input\Generator|array

Retrieve the unselected options.

Returns

selectedChoices()

selectedChoices() : \Charcoal\Admin\Property\Input\Generator|array

Retrieve the selected options.

Returns

searchable()

searchable() : mixed

Returns

reorderable()

reorderable() : boolean

Determine if the right-side can be manually sorted.

Returns

setDualSelectOptions()

setDualSelectOptions(array  $settings) : \Charcoal\Admin\Property\Input\Selectinput

Set the dual-select's options.

This method always merges default settings.

Parameters

Returns

Chainable

mergeDualSelectOptions()

mergeDualSelectOptions(array  $settings) : \Charcoal\Admin\Property\Input\Selectinput

Merge (replacing or adding) dual-select options.

Parameters

Returns

Chainable

addSelectOption()

addSelectOption(string  $key, mixed  $val) : \Charcoal\Admin\Property\Input\Selectinput

Add (or replace) an dual-select option.

Parameters

Throws

\InvalidArgumentException

If the identifier is not a string.

Returns

Chainable

dualSelectOptions()

dualSelectOptions() : array

Retrieve the dual-select's options.

Returns

defaultDualSelectOptions()

defaultDualSelectOptions() : array

Retrieve the default dual-select options.

Returns

dualSelectOptionsAsJson()

dualSelectOptionsAsJson() : string

Retrieve the dual-select's options as a JSON string.

Returns

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

parseChoice()

parseChoice(string|integer  $ident, array|object  $choice) : array|null

Prepare a single selectable option for output.

Parameters

Returns

parseChoiceVal()

parseChoiceVal(mixed  $value) : mixed

Convert the value to a scalar.

Parameters

Returns

defaultEmptyChoice()

defaultEmptyChoice() : array

Retrieve the default empty option structure.

Returns

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.

camelize()

camelize(string  $str) : string

Transform a snake_case string to camelCase.

Parameters

Returns

The camelCase string.