\Cake\View\WidgetSelectBoxWidget

__construct()

__construct(\Cake\View\StringTemplate  $templates) 

Constructor.

Parameters

render()

render(array  $data, \Cake\View\Form\ContextInterface  $context) : string

Render a select box form input.

Render a select box input given a set of data. Supported keys are:

• name - Set the input name.
• options - An array of options.
• disabled - Either true or an array of options to disable. When true, the select element will be disabled.
• val - Either a string or an array of options to mark as selected.
• empty - Set to true to add an empty option at the top of the option elements. Set to a string to define the display text of the empty option. If an array is used the key will set the value of the empty option while, the value will set the display text.
• escape - Set to false to disable HTML escaping.

Options format

The options option can take a variety of data format depending on the complexity of HTML you want generated.

You can generate simple options using a basic associative array:

'options' => ['elk' => 'Elk', 'beaver' => 'Beaver']

If you need to define additional attributes on your option elements you can use the complex form for options:

'options' => [
  ['value' => 'elk', 'text' => 'Elk', 'data-foo' => 'bar'],
]

This form requires that both the value and text keys be defined. If either is not set options will not be generated correctly.

If you need to define option groups you can do those using nested arrays:

'options' => [
 'Mammals' => [
   'elk' => 'Elk',
   'beaver' => 'Beaver'
 ]
]

And finally, if you need to put attributes on your optgroup elements you can do that with a more complex nested array form:

'options' => [
  [
    'text' => 'Mammals',
    'data-id' => 1,
    'options' => [
      'elk' => 'Elk',
      'beaver' => 'Beaver'
    ]
 ],
]

You are free to mix each of the forms in the same option set, and nest complex types as required.

Parameters

Throws

\RuntimeException

when the name attribute is empty.

Returns

A generated select box.

secureFields()

secureFields(array  $data) : array

Returns a list of fields that need to be secured for this widget. Fields are in the form of Model[field][suffix]

Parameters

Returns

Array of fields to secure.

_renderContent()

_renderContent(array  $data) : array

Render the contents of the select element.

Parameters

Returns

_emptyValue()

_emptyValue(string|boolean|array  $value) : array

Generate the empty value based on the input.

Parameters

Returns

The generated option key/value.

_renderOptgroup()

_renderOptgroup(string  $label, array  $optgroup, array|null  $disabled, array|string|null  $selected, array  $templateVars, boolean  $escape) : string

Render the contents of an optgroup element.

Parameters

Returns

Formatted template string

_renderOptions()

_renderOptions(array  $options, array|null  $disabled, array|string|null  $selected, array  $templateVars, boolean  $escape) : array

Render a set of options.

Will recursively call itself when option groups are in use.

Parameters

Returns

Option elements.

_isSelected()

_isSelected(string  $key, array|string|null  $selected) : boolean

Helper method for deciding what options are selected.

Parameters

Returns

_isDisabled()

_isDisabled(string  $key, array|null  $disabled) : boolean

Helper method for deciding what options are disabled.

Parameters

Returns