PHP Класс BootstrapUI\View\Helper\FormHelper

Наследование: extends Cake\View\Helper\FormHelper, use trait OptionsAwareTrait
Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство Тип Описание
$_align string Set on Form::create() to tell if the type of alignment used (i.e. horizontal).
$_templateSet array Templates set per alignment type
$_templates array Default Bootstrap string templates.
$_widgets array Default Bootstrap widgets.

Открытые методы

Метод Описание
__construct ( Cake\View\View $View, array $config = [] ) Construct the widgets and binds the default context providers.
create ( mixed $model = null, array $options = [] ) : string Returns an HTML FORM element.
end ( array $secureAttributes = [] ) : string Closes an HTML form, cleans up values set by FormHelper::create(), and writes hidden input fields where appropriate.
input ( string $fieldName, array $options = [] ) : string Generates a form input element complete with label and wrapper div.
staticControl ( string $fieldName, array $options = [] ) : string Used to place plain text next to label within a form.
submit ( string $caption = null, array $options = [] ) : string Creates a submit button element.

Защищенные методы

Метод Описание
_detectFormAlignment ( array $options ) : string Detects the form alignment when possible.
_formAlignment ( array $options ) : array Form alignment detector/switcher.
_getInput ( string $fieldName, array $options ) : string Generates an input element.
_gridClass ( string $position, boolean $offset = false ) : string Returns a Bootstrap grid class (i.e. col-md-2).
_groupTemplate ( array $options ) : string Generates an group template element
_inputContainerTemplate ( array $options ) : string Generates an input container template
_parseOptions ( string $fieldName, array $options ) : array Generates input options array

Описание методов

__construct() публичный Метод

Construct the widgets and binds the default context providers.
public __construct ( Cake\View\View $View, array $config = [] )
$View Cake\View\View The View this helper is being attached to.
$config array Configuration settings for the helper.

_detectFormAlignment() защищенный Метод

Detects the form alignment when possible.
protected _detectFormAlignment ( array $options ) : string
$options array Options.
Результат string Form alignment type. One of `default`, `horizontal` or `inline`.

_formAlignment() защищенный Метод

Form alignment detector/switcher.
protected _formAlignment ( array $options ) : array
$options array Options.
Результат array Modified options.

_getInput() защищенный Метод

Overrides parent method to unset 'help' key.
protected _getInput ( string $fieldName, array $options ) : string
$fieldName string The field's name.
$options array The options for the input element.
Результат string The generated input element.

_gridClass() защищенный Метод

Returns a Bootstrap grid class (i.e. col-md-2).
protected _gridClass ( string $position, boolean $offset = false ) : string
$position string One of `left`, `middle` or `right`.
$offset boolean If true, will append `offset-` to the class.
Результат string Classes.

_groupTemplate() защищенный Метод

Generates an group template element
protected _groupTemplate ( array $options ) : string
$options array The options for group template
Результат string The generated group template

_inputContainerTemplate() защищенный Метод

Generates an input container template
protected _inputContainerTemplate ( array $options ) : string
$options array The options for input container template.
Результат string The generated input container template.

_parseOptions() защищенный Метод

Generates input options array
protected _parseOptions ( string $fieldName, array $options ) : array
$fieldName string The name of the field to parse options for.
$options array Options list.
Результат array Options

create() публичный Метод

Returns an HTML FORM element.
public create ( mixed $model = null, array $options = [] ) : string
$model mixed The context for which the form is being defined. Can be an ORM entity, ORM resultset, or an array of meta data. You can use false or null to make a model-less form.
$options array An array of html attributes and options.
Результат string An formatted opening FORM tag.

end() публичный Метод

Overrides parent method to reset the form alignment and grid size.
public end ( array $secureAttributes = [] ) : string
$secureAttributes array Secure attributes which will be passed as HTML attributes into the hidden input elements generated for the Security Component.
Результат string A closing FORM tag.

input() публичный Метод

Adds extra option besides the ones supported by parent class method: - append - Append addon to input. - prepend - Prepend addon to input. - inline - Boolean for generating inline checkbox/radio. - help - Help text of include in the input container.
public input ( string $fieldName, array $options = [] ) : string
$fieldName string This should be "Modelname.fieldname".
$options array Each type of input takes different options.
Результат string Completed form widget.

staticControl() публичный Метод

### Options: - hiddenField - boolean to indicate if you want value for field included in a hidden input. Defaults to true.
public staticControl ( string $fieldName, array $options = [] ) : string
$fieldName string Name of a field, like this "modelname.fieldname"
$options array Array of HTML attributes.
Результат string An HTML text input element.

submit() публичный Метод

Overrides parent method to add CSS class btn, to the element.
См. ссылку: http://book.cakephp.org/3.0/en/views/helpers/form.html#creating-buttons-and-submit-elements
public submit ( string $caption = null, array $options = [] ) : string
$caption string The label appearing on the button OR if string contains :// or the extension .jpg, .jpe, .jpeg, .gif, .png use an image if the extension exists, AND the first character is /, image is relative to webroot, OR if the first character is not /, image is relative to webroot/img.
$options array Array of options. See above.
Результат string A HTML submit button

Описание свойств

$_align защищенное свойство

Set on Form::create() to tell if the type of alignment used (i.e. horizontal).
protected string $_align
Результат string

$_templateSet защищенное свойство

Templates set per alignment type
protected array $_templateSet
Результат array

$_templates защищенное свойство

Default Bootstrap string templates.
protected array $_templates
Результат array

$_widgets защищенное свойство

Default Bootstrap widgets.
protected array $_widgets
Результат array