• Home
• Cake
• View
• Helper
• FormHelper

PHP Class Cake\View\Helper\FormHelper

Automatic generation of HTML FORMs from given data. 显示文件 Open project: cakephp/cakephp Class Usage Examples

Public Properties

Property	Type	Description
$fields	array	List of fields created, used with secure forms.
$helpers	array	Other helpers used by FormHelper
$requestType	string	Defines the type of form being created. Set by FormHelper::create().

Protected Properties

Property	Type	Description
$_context	Cake\View\Form\ContextInterface	Context for the current form.
$_contextProviders	array	Context provider methods.
$_datetimeOptions	array	Special options used for datetime inputs.
$_datetimeParts	array	The various pickers that make up a datetime picker.
$_defaultConfig	array	Default config for the helper.
$_defaultWidgets	array	Default widgets
$_lastAction	string	Used to make form/request specific hashes for SecurityComponent.
$_registry	Cake\View\Widget\WidgetRegistry	Registry for input widgets.
$_unlockedFields	array	An array of field names that have been excluded from the Token hash used by SecurityComponent's validatePost method

Public Methods

Method	Description
__call ( string $method, array $params ) : string	Missing method handler - implements various simple input types. Is used to create inputs of various types. e.g. $this->Form->text(); will create while $this->Form->range(); will create
__construct ( Cake\View\View $View, array $config = [] )	Construct the widgets and binds the default context providers
addContextProvider ( string $type, callable $check ) : void	Add a new context type.
addWidget ( string $name, array | Cake\View\Widget\WidgetInterface $spec ) : void	Add a new widget to FormHelper.
allInputs ( array $fields = [], array $options = [] ) : string	Generate a set of inputs for $fields. If $fields is empty the fields of current model will be used.
button ( string $title, array $options = [] ) : string	Creates a tag.
checkbox ( string $fieldName, array $options = [] ) : string | array	Creates a checkbox input widget.
context ( Cake\View\Form\ContextInterface | null $context = null ) : null | Cake\View\Form\ContextInterface	Get the context instance for the current form set.
create ( mixed $model = null, array $options = [] ) : string	Returns an HTML FORM element.
date ( string $fieldName, array $options = [] ) : string	Generate date inputs.
dateTime ( string $fieldName, array $options = [] ) : string	Returns a set of SELECT elements for a full datetime setup: day, month and year, and then time.
day ( string | null $fieldName = null, array $options = [] ) : string	Returns a SELECT element for days.
end ( array $secureAttributes = [] ) : string	Closes an HTML form, cleans up values set by FormHelper::create(), and writes hidden input fields where appropriate.
error ( string $field, string | array | null $text = null, array $options = [] ) : string	Returns a formatted error message for given form field, '' if no errors.
fieldset ( string $fields = '', array $options = [] ) : string	Wrap a set of inputs in a fieldset
file ( string $fieldName, array $options = [] ) : string	Creates file input widget.
hidden ( string $fieldName, array $options = [] ) : string	Creates a hidden input field.
hour ( string $fieldName, array $options = [] ) : string	Returns a SELECT element for hours.
implementedEvents ( ) : array	Event listeners.
input ( string $fieldName, array $options = [] ) : string	Generates a form input element complete with label and wrapper div
inputs ( array $fields, array $options = [] ) : string	Generate a set of inputs for $fields wrapped in a fieldset element.
isFieldError ( string $field ) : boolean	Returns true if there is an error for the given field, otherwise false
label ( string $fieldName, string | null $text = null, array $options = [] ) : string	Returns a formatted LABEL element for HTML forms.
meridian ( string $fieldName, array $options = [] ) : string	Returns a SELECT element for AM or PM.
minute ( string $fieldName, array $options = [] ) : string	Returns a SELECT element for minutes.
month ( string $fieldName, array $options = [] ) : string	Returns a SELECT element for months.
multiCheckbox ( string $fieldName, array | Traversable $options, array $attributes = [] ) : string	Creates a set of checkboxes out of options.
postButton ( string $title, string | array $url, array $options = [] ) : string	Create a tag with a surrounding that submits via POST as default.
postLink ( string $title, string | array | null $url = null, array $options = [] ) : string	Creates an HTML link, but access the URL using the method you specify (defaults to POST). Requires javascript to be enabled in browser.
radio ( string $fieldName, array | Traversable $options = [], array $attributes = [] ) : string	Creates a set of radio widgets.
resetTemplates ( ) : void	Restores the default values built into FormHelper.
secure ( array $fields = [], array $secureAttributes = [] ) : string	Generates a hidden field with a security hash based on the fields used in the form.
select ( string $fieldName, array | Traversable $options = [], array $attributes = [] ) : string	Returns a formatted SELECT element.
submit ( string | null $caption = null, array $options = [] ) : string	Creates a submit button element. This method will generate elements that can be used to submit, and reset forms by using $options. image submits can be created by supplying an image path for $caption.
textarea ( string $fieldName, array $options = [] ) : string	Creates a textarea widget.
time ( string $fieldName, array $options = [] ) : string	Generate time inputs.
unlockField ( string | null $name = null ) : array | null	Add to or get the list of fields that are currently unlocked.
widget ( string $name, array $data = [] ) : string	Render a named widget.
widgetRegistry ( Cake\View\Widget\WidgetRegistry $instance = null, array $widgets = [] ) : Cake\View\Widget\WidgetRegistry	Set the widget registry the helper will use.
year ( string $fieldName, array $options = [] ) : string	Returns a SELECT element for years

Protected Methods

Method	Description
_addDefaultContextProviders ( ) : void	Add the default suite of context providers provided by CakePHP.
_csrfField ( ) : string	Return a CSRF input if the request data is present.
_datetimeOptions ( array $options ) : array	Helper method for converting from FormHelper options data to widget format.
_extractOption ( string $name, array $options, mixed $default = null ) : mixed	Extracts a single option from an options array.
_formUrl ( Cake\View\Form\ContextInterface $context, array $options ) : string	Create the URL for a form based on the options.
_getContext ( mixed $data = [] ) : mixed	Find the matching context provider for the data.
_getInput ( string $fieldName, array $options ) : string	Generates an input element
_getLabel ( string $fieldName, array $options ) : boolean | string	Generate label for input
_groupTemplate ( array $options ) : string	Generates an group template element
_initInputField ( string $field, array $options = [] ) : array	Sets field defaults and adds field to form security input hash.
_inputContainerTemplate ( array $options ) : string	Generates an input container template
_inputLabel ( string $fieldName, string $label, array $options ) : string	Generate a label for an input() call.
_inputType ( string $fieldName, array $options ) : string	Returns the input type that was guessed for the provided fieldName, based on the internal type it is associated too, its name and the variables that can be found in the view template
_isRequiredField ( Cake\Validation\ValidationSet $validationRules ) : boolean	Returns if a field is required to be filled based on validation properties from the validating object.
_lastAction ( string | array $url ) : void	Correctly store the last created form action URL.
_magicOptions ( string $fieldName, array $options, boolean $allowOverride ) : array	Magically set option type and corresponding options
_optionsOptions ( string $fieldName, array $options ) : array	Selects the variable containing the options for a select field if present, and sets the value to the 'options' key in the options array.
_parseOptions ( string $fieldName, array $options ) : array	Generates input options array
_secure ( boolean $lock, string | array $field, mixed $value = null ) : void	Determine which fields of a form should be used for hash.
_secureFieldName ( string $name ) : array	Get the field name for use with _secure().
_singleDatetime ( array $options, string $keep ) : array	Helper method for the various single datetime component methods.

Method Details

Property Details