CakePHP
  • Documentation
    • Book
    • API
    • Videos
    • Reporting Security Issues
    • Privacy Policy
    • Logos & Trademarks
  • Business Solutions
  • Swag
  • Road Trip
  • Team
  • Community
    • Community
    • Get Involved
    • Issues (Github)
    • Bakery
    • Featured Resources
    • Training
    • Meetups
    • My CakePHP
    • CakeFest
    • Newsletter
    • Linkedin
    • YouTube
    • Facebook
    • Twitter
    • Mastodon
    • Help & Support
    • Forum
    • Stack Overflow
    • IRC
    • Slack
    • Paid Support
CakePHP

C CakePHP 3.0 Red Velvet API

  • Project:
    • CakePHP
      • CakePHP
      • Authentication
      • Authorization
      • Chronos
      • Elastic Search
      • Queue
  • Version:
    • 3.0
      • 5.2
      • 5.1
      • 5.0
      • 4.6
      • 4.5
      • 4.4
      • 4.3
      • 4.2
      • 4.1
      • 4.0
      • 3.10
      • 3.9
      • 3.8
      • 3.7
      • 3.6
      • 3.5
      • 3.4
      • 3.3
      • 3.2
      • 3.1
      • 3.0
      • 2.10
      • 2.9
      • 2.8
      • 2.7
      • 2.6
      • 2.5
      • 2.4
      • 2.3
      • 2.2
      • 2.1
      • 2.0
      • 1.3
      • 1.2

Namespaces

  • Global
  • Cake
    • Auth
    • Cache
    • Collection
    • Console
    • Controller
    • Core
    • Database
    • Datasource
    • Error
    • Event
    • Filesystem
    • Form
    • I18n
    • Log
    • Network
    • ORM
    • Routing
    • Shell
    • TestSuite
    • Utility
    • Validation
    • View
      • Exception
      • Form
      • Helper
      • Widget

Class SelectBoxWidget

Input widget class for generating a selectbox.

This class is intended as an internal implementation detail of Cake\View\Helper\FormHelper and is not intended for direct use.

Namespace: Cake\View\Widget

Property Summary

  • $_templates protected
    Cake\View\StringTemplate

    StringTemplate instance.

Method Summary

  • __construct() public

    Constructor.

  • _emptyValue() protected

    Generate the empty value based on the input.

  • _isDisabled() protected

    Helper method for deciding what options are disabled.

  • _isSelected() protected

    Helper method for deciding what options are selected.

  • _renderContent() protected

    Render the contents of the select element.

  • _renderOptgroup() protected

    Render the contents of an optgroup element.

  • _renderOptions() protected

    Render a set of options.

  • render() public

    Render a select box form input.

  • secureFields() public

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

Method Detail

__construct() ¶ public

__construct(Cake\View\StringTemplate $templates)

Constructor.

Parameters
Cake\View\StringTemplate $templates

Templates list.

_emptyValue() ¶ protected

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

Generate the empty value based on the input.

Parameters
string|bool|array $value

The provided empty value.

Returns
array

_isDisabled() ¶ protected

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

Helper method for deciding what options are disabled.

Parameters
string $key

The key to test.

array|null $disabled

The disabled values.

Returns
bool

_isSelected() ¶ protected

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

Helper method for deciding what options are selected.

Parameters
string $key

The key to test.

array|string|null $selected

The selected values.

Returns
bool

_renderContent() ¶ protected

_renderContent(array $data): array

Render the contents of the select element.

Parameters
array $data

The context for rendering a select.

Returns
array

_renderOptgroup() ¶ protected

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

Render the contents of an optgroup element.

Parameters
string $label

The optgroup label text

array $optgroup

The opt group data.

array|null $disabled

The options to disable.

array|string|null $selected

The options to select.

bool $escape

Toggle HTML escaping

Returns
string

_renderOptions() ¶ protected

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

Render a set of options.

Will recursively call itself when option groups are in use.

Parameters
array $options

The options to render.

array|null $disabled

The options to disable.

array|string|null $selected

The options to select.

bool $escape

Toggle HTML escaping.

Returns
array

render() ¶ public

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
array $data

Data to render with.

Cake\View\Form\ContextInterface $context

The current form context.

Returns
string
Throws
RuntimeException
when the name attribute is empty.

secureFields() ¶ public

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
array $data
Returns
array

Property Detail

$_templates ¶ protected

StringTemplate instance.

Type
Cake\View\StringTemplate
OpenHub
Pingping
Linode
  • Business Solutions
  • Showcase
  • Documentation
  • Book
  • API
  • Videos
  • Reporting Security Issues
  • Privacy Policy
  • Logos & Trademarks
  • Community
  • Get Involved
  • Issues (Github)
  • Bakery
  • Featured Resources
  • Training
  • Meetups
  • My CakePHP
  • CakeFest
  • Newsletter
  • Linkedin
  • YouTube
  • Facebook
  • Twitter
  • Mastodon
  • Help & Support
  • Forum
  • Stack Overflow
  • IRC
  • Slack
  • Paid Support

Generated using CakePHP API Docs