FormBuilder

класс FormBuilder (View source)

Черты

Свойства

static protected array	$macros	Зарегистрированные строковые макросы.	из MacroableTrait
protected HtmlBuilder	$html	Экземпляр HTML-билдера.
protected UrlGenerator	$url	Экземпляр генератора URL.
protected string	$csrfToken	Токен CSRF, используемый билдером форм.
protected Store	$session	Реализация хранилища сессий.
protected mixed	$model	Текущий экземпляр модели для формы.
protected array	$labels	Массив созданных нами имен меток.
protected array	$reserved	Зарезервированные атрибуты открытия формы.
protected array	$spoofedMethods	Методы формы, которые должны быть подделаны, в верхнем регистре.
protected array	$skipValueTypes	Типы полей ввода, для которых по умолчанию не заполняются значения.

Методы

static void	macro(string $name, callable $macro) Зарегистрировать пользовательский макрос.	from MacroableTrait
static boolean	hasMacro(string $name) Проверяет, зарегистрирован ли макрос	from MacroableTrait
static mixed	__callStatic(string $method, array $parameters) Динамически обрабатывает вызовы класса.	from MacroableTrait
mixed	__call(string $method, array $parameters) Динамически обрабатывает вызовы класса.	from MacroableTrait
void	__construct(HtmlBuilder $html, UrlGenerator $url, $csrfToken) Создать новый экземпляр построителя форм.
string	open(array $options = array()) Открыть новую HTML форму.
string	model(mixed $model, array $options = array()) Создать новый построитель форм на основе модели.
void	setModel(mixed $model) Установить экземпляр модели в построителе форм.
string	close() Закрыть текущую форму.
string	token() Сгенерировать скрытое поле с текущим токеном CSRF.
string	label(string $name, string $value = null, array $options = array()) Создать элемент метки формы.
string	formatLabel(string $name, string\|null $value) Отформатировать значение метки.
string	input(string $type, string $name, string $value = null, array $options = array()) Создать поле ввода формы.
string	text(string $name, string $value = null, array $options = array()) Создать текстовое поле ввода.
string	password(string $name, array $options = array()) Создать поле ввода пароля.
string	hidden(string $name, string $value = null, array $options = array()) Создать скрытое поле ввода.
string	email(string $name, string $value = null, array $options = array()) Создать поле ввода электронной почты.
string	url(string $name, string $value = null, array $options = array()) Создать поле ввода URL.
string	file(string $name, array $options = array()) Создать поле ввода файла.
string	textarea(string $name, string $value = null, array $options = array()) Создать поле ввода textarea.
array	setTextAreaSize(array $options) Установить размер поля textarea в атрибутах.
array	setQuickTextAreaSize(array $options) Установить размер поля textarea используя быстрый атрибут "size".
string	number(string $name, string\|null $value = null, array $options = array()) Создать числовое поле ввода.
string	select(string $name, array $list = array(), string $selected = null, array $options = array()) Создать поле списка выбора.
string	selectRange(string $name, string $begin, string $end, string $selected = null, array $options = array()) Создать поле выбора диапазона.
string	selectYear() Создать поле выбора года.
string	selectMonth(string $name, string $selected = null, array $options = array(), string $format = '%B') Создать поле выбора месяца.
string	getSelectOption(string $display, string $value, string $selected) Получить опцию выбора для заданного значения.
string	optionGroup(array $list, string $label, string $selected) Создать элемент формы группы опций.
string	option(string $display, string $value, string $selected) Создать опцию элемента выбора.
string	getSelectedValue(string $value, string $selected) Определить, выбрано ли значение.
string	checkbox(string $name, mixed $value = 1, bool $checked = null, array $options = array()) Создать поле ввода флажка.
string	radio(string $name, mixed $value = null, bool $checked = null, array $options = array()) Создать поле ввода переключателя.
string	checkable(string $type, string $name, mixed $value, bool $checked, array $options) Создать поле ввода с выбором.
bool	getCheckedState(string $type, string $name, mixed $value, bool $checked) Получить состояние выбора для поля с выбором.
bool	getCheckboxCheckedState(string $name, mixed $value, bool $checked) Получить состояние выбора для поля флажка.
bool	getRadioCheckedState(string $name, mixed $value, bool $checked) Получить состояние выбора для поля переключателя.
bool	missingOldAndModel(string $name) Определить, существует ли старый ввод или ввод модели для ключа.
string	reset(string $value, array $attributes = array()) Создать элемент ввода HTML сброса.
string	image(string $url, string $name = null, array $attributes = array()) Создать элемент ввода изображения HTML.
string	submit(string $value = null, array $options = array()) Создать элемент кнопки отправки.
string	button(string $value = null, array $options = array()) Создать элемент кнопки.
string	getMethod(string $method) Разбор метода действия формы.
string	getAction(array $options) Получить действие формы из параметров.

string	getUrlAction(array\|string $options) Получить действие для опции "url".
string	getRouteAction(array\|string $options) Получить действие для опции "route".
string	getControllerAction(array\|string $options) Получить действие для опции "action".
string	getAppendage(string $method) Получить дополнение к форме для данного метода.
string	getIdAttribute(string $name, array $attributes) Получить атрибут ID для имени поля.
string	getValueAttribute(string $name, string $value = null) Получить значение, которое должно быть присвоено полю.
string	getModelValueAttribute(string $name) Получить значение модели, которое должно быть присвоено полю.
string	old(string $name) Получить значение из старого ввода сессии.
bool	oldInputIsEmpty() Определить, пуст ли старый ввод.
string	transformKey(string $key) Преобразовать ключ из массива в точечную нотацию.
Store	getSessionStore() Получить реализацию хранилища сессии.
$this	setSessionStore(Store $session) Установить реализацию хранилища сессии.

Подробности

static void macro(string $name, callable $macro)

Зарегистрировать пользовательский макрос.

Параметры

string	$name
callable	$macro

Возвращаемое значение

void

static boolean hasMacro(string $name)

Проверяет, зарегистрирован ли макрос

Параметры

string

$name

Возвращаемое значение

boolean

static mixed __callStatic(string $method, array $parameters)

Динамически обрабатывает вызовы класса.

Параметры

string	$method
array	$parameters

Возвращаемое значение

mixed

Исключения

BadMethodCallException

mixed __call(string $method, array $parameters)

Динамически обрабатывает вызовы класса.

Параметры

string	$method
array	$parameters

Возвращаемое значение

mixed

Исключения

BadMethodCallException

void __construct(HtmlBuilder $html, UrlGenerator $url, $csrfToken)

Создать новый экземпляр построителя форм.

Параметры

HtmlBuilder	$html
UrlGenerator	$url
	$csrfToken

Возвращаемое значение

void

string open(array $options = array())

Открыть новую HTML-форму.

Параметры

array

$options

Возвращаемое значение

string

string model(mixed $model, array $options = array())

Создать новый построитель форм на основе модели.

Параметры

mixed	$model
array	$options

Возвращаемое значение

string

void setModel(mixed $model)

Установить экземпляр модели в построителе форм.

Параметры

mixed

$model

Возвращаемое значение

void

string close()

Закрыть текущую форму.

Возвращаемое значение

string

string token()

Сгенерировать скрытое поле с текущим токеном CSRF.

Возвращаемое значение

string

string label(string $name, string $value = null, array $options = array())

Создать элемент метки формы.

Параметры

string	$name
string	$value
array	$options

Возвращаемое значение

string

protected string formatLabel(string $name, string|null $value)

Отформатировать значение метки.

Параметры

string	$name
string\|null	$value

Возвращаемое значение

string

string input(string $type, string $name, string $value = null, array $options = array())

Создать поле ввода формы.

Параметры

string	$type
string	$name
string	$value
array	$options

Возвращаемое значение

string

string text(string $name, string $value = null, array $options = array())

Создать текстовое поле ввода.

Параметры

string	$name
string	$value
array	$options

Возвращаемое значение

string

string password(string $name, array $options = array())

Создать поле ввода пароля.

Параметры

string	$name
array	$options

Возвращаемое значение

string

string hidden(string $name, string $value = null, array $options = array())

Создать скрытое поле ввода.

Параметры

string	$name
string	$value
array	$options

Возвращаемое значение

string

string email(string $name, string $value = null, array $options = array())

Создать поле ввода электронной почты.

Параметры

string	$name
string	$value
array	$options

Возвращаемое значение

string

string url(string $name, string $value = null, array $options = array())

Создать поле ввода URL.

Параметры

string	$name
string	$value
array	$options

Возвращаемое значение

string

string file(string $name, array $options = array())

Создать поле ввода файла.

Параметры

string	$name
array	$options

Возвращаемое значение

string

string textarea(string $name, string $value = null, array $options = array())

Создать поле ввода textarea.

Параметры

string	$name
string	$value
array	$options

Возвращаемое значение

string

protected array setTextAreaSize(array $options)

Установить размер поля text area в атрибутах.

Параметры

array

$options

Возвращаемое значение

array

protected array setQuickTextAreaSize(array $options)

Установить размер поля text area используя быстрый атрибут "size".

Параметры

array

$options

Возвращаемое значение

array

string number(string $name, string|null $value = null, array $options = array())

Создать поле ввода числа.

Параметры

string	$name
string\|null	$value
array	$options

Возвращаемое значение

string

string select(string $name, array $list = array(), string $selected = null, array $options = array())

Создать поле списка выбора.

Параметры

string	$name
array	$list
string	$selected
array	$options

Возвращаемое значение

string

string selectRange(string $name, string $begin, string $end, string $selected = null, array $options = array())

Создать поле диапазона выбора.

Параметры

string	$name
string	$begin
string	$end
string	$selected
array	$options

Возвращаемое значение

string

string selectYear()

Создать поле выбора года.

Возвращаемое значение

string

string selectMonth(string $name, string $selected = null, array $options = array(), string $format = '%B')

Создать поле выбора месяца.

Параметры

string	$name
string	$selected
array	$options
string	$format

Возвращаемое значение

string

string getSelectOption(string $display, string $value, string $selected)

Получить опцию выбора для заданного значения.

Параметры

string	$display
string	$value
string	$selected

Возвращаемое значение

string

protected string optionGroup(array $list, string $label, string $selected)

Создать элемент формы группы опций.

Параметры

array	$list
string	$label
string	$selected

Возвращаемое значение

string

protected string option(string $display, string $value, string $selected)

Создать опцию элемента выбора.

Параметры

string	$display
string	$value
string	$selected

Возвращаемое значение

string

protected string getSelectedValue(string $value, string $selected)

Определить, выбрано ли значение.

Параметры

string	$value
string	$selected

Возвращаемое значение

string

string checkbox(string $name, mixed $value = 1, bool $checked = null, array $options = array())

Создать поле ввода флажка.

Параметры

string	$name
mixed	$value
bool	$checked
array	$options

Возвращаемое значение

string

string radio(string $name, mixed $value = null, bool $checked = null, array $options = array())

Создать поле ввода переключателя.

Параметры

string	$name
mixed	$value
bool	$checked
array	$options

Возвращаемое значение

string

protected string checkable(string $type, string $name, mixed $value, bool $checked, array $options)

Создать поле ввода с возможностью выбора.

Parameters

string	$type
string	$name
mixed	$value
bool	$checked
array	$options

Return Value

string

protected bool getCheckedState(string $type, string $name, mixed $value, bool $checked)

Получить состояние выбора для поля ввода с возможностью выбора.

Parameters

string	$type
string	$name
mixed	$value
bool	$checked

Return Value

bool

protected bool getCheckboxCheckedState(string $name, mixed $value, bool $checked)

Получить состояние выбора для поля ввода типа "checkbox".

Parameters

string	$name
mixed	$value
bool	$checked

Return Value

bool

protected bool getRadioCheckedState(string $name, mixed $value, bool $checked)

Получить состояние выбора для поля ввода типа "radio".

Parameters

string	$name
mixed	$value
bool	$checked

Return Value

bool

protected bool missingOldAndModel(string $name)

Определить, существует ли старый ввод или ввод модели для ключа.

Parameters

string

$name

Return Value

bool

string reset(string $value, array $attributes = array())

Создать элемент ввода HTML типа "reset".

Parameters

string	$value
array	$attributes

Return Value

string

string image(string $url, string $name = null, array $attributes = array())

Создать элемент ввода HTML типа "image".

Parameters

string	$url
string	$name
array	$attributes

Return Value

string

string submit(string $value = null, array $options = array())

Создать элемент кнопки отправки.

Parameters

string	$value
array	$options

Return Value

string

string button(string $value = null, array $options = array())

Создать элемент кнопки.

Parameters

string	$value
array	$options

Return Value

string

protected string getMethod(string $method)

Разбор метода действия формы.

Parameters

string

$method

Return Value

string

protected string getAction(array $options)

Получить действие формы из параметров.

Parameters

array

$options

Return Value

string

protected string getUrlAction(array|string $options)

Получить действие для параметра "url".

Parameters

array|string

$options

Return Value

string

protected string getRouteAction(array|string $options)

Получить действие для параметра "route".

Parameters

array|string

$options

Return Value

string

protected string getControllerAction(array|string $options)

Получить действие для параметра "action".

Parameters

array|string

$options

Return Value

string

protected string getAppendage(string $method)

Получить дополнение формы для заданного метода.

Parameters

string

$method

Return Value

string

string getIdAttribute(string $name, array $attributes)

Получить атрибут ID для имени поля.

Parameters

string	$name
array	$attributes

Return Value

string

string getValueAttribute(string $name, string $value = null)

Получить значение, которое должно быть присвоено полю.

Parameters

string	$name
string	$value

Return Value

string

protected string getModelValueAttribute(string $name)

Получить значение модели, которое должно быть присвоено полю.

Parameters

string

$name

Return Value

string

string old(string $name)

Получить значение из старого ввода сессии.

Parameters

string

$name

Return Value

string

bool oldInputIsEmpty()

Определить, является ли старый ввод пустым.

Return Value

bool

protected string transformKey(string $key)

Преобразовать ключ из массива в точечную нотацию.

Parameters

string

$key

Return Value

string

Store getSessionStore()

Получить реализацию хранилища сессии.

Возвращаемое значение

Store

$session

$this setSessionStore(Store $session)

Установить реализацию хранилища сессии.

Параметры

Store

$session

Возвращаемое значение

$this

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/4.2/Illuminate/Html/FormBuilder.html