Class InputFields

Input Fields

Provides the structure for inputs to set which fields to appear when interacting with the input via Blesta in various places.

Blesta\Core\Util\Input\Fields\InputFields implements Blesta\Core\Util\Input\Fields\Common\FieldsInterface

Direct known subclasses

ModuleFields

Namespace: Blesta\Core\Util\Input\Fields
Package: blesta\core\Util\Input\Fields
Copyright: Copyright (c) 2020, Phillips Data, Inc.
License: The Blesta License Agreement
See: Blesta\Core\Util\Input\Fields\InputField
Link: Blesta
Located at core/Util/Input/Fields/InputFields.php

`public array`	# `getFields( )` Returns an array of fields set for this group of fields Returns an array of fields set for this group of fields Returns array An array of FieldInterface objects set for this group of fields
`public string`	# `getHtml( )` Returns an HTML content set for this group of fields Returns an HTML content set for this group of fields Returns string The HTML content set for this group of fields
`public`	# `setHtml( string $html )` Sets HTML content to be rendered into the view when outputting the fields. This is intended to allow for the inclusion of javascript to dynamically handle the rendering of the fields, but is not limited to such. Sets HTML content to be rendered into the view when outputting the fields. This is intended to allow for the inclusion of javascript to dynamically handle the rendering of the fields, but is not limited to such. Parameters `$html` The HTML content to render into the view when outputting the fields
`public`	# `setField( Blesta\Core\Util\Input\Fields\Common\FieldInterface $field )` Sets the field into the collection of FieldInterface objects Sets the field into the collection of FieldInterface objects Parameters `$field` A FieldInterface object to be passed set into the list of FieldInterface objects
`public Blesta\Core\Util\Input\Fields\InputField`	# `label( string $name, string $for = null, array $attributes = null, boolean $preserve_tags = false )` Creates a label with the given name and marks it for the given field Creates a label with the given name and marks it for the given field Parameters `$name` The name of this label `$for` The ID of the form element this label is part of `$attributes` Attributes for this label `$preserve_tags` True to preserve tags in the label name Returns `Blesta\Core\Util\Input\Fields\InputField` An InputField object to be passed into one of the various field methods to assign this label to that field Implementation of `Blesta\Core\Util\Input\Fields\Common\FieldsInterface::label()`
`public Blesta\Core\Util\Input\Fields\InputField`	# `tooltip( string $message )` Creates a tooltip with the given message Creates a tooltip with the given message Parameters `$message` The tooltip message Returns `Blesta\Core\Util\Input\Fields\InputField` An InputField object that can be attached to an InputField label Implementation of `Blesta\Core\Util\Input\Fields\Common\FieldsInterface::tooltip()`
`public Blesta\Core\Util\Input\Fields\InputField`	# `fieldText( string $name, string $value = null, array $attributes = [], Blesta\Core\Util\Input\Fields\Common\FieldInterface $label = null )` Creates a text input field Creates a text input field Parameters `$name` The name to set in the HTML name field `$value` The value to set in the HTML value field `$attributes` Attributes for this input field `$label` A FieldInterface object representing the label to attach to this field (see InputFields::label) Returns `Blesta\Core\Util\Input\Fields\InputField` An InputField object that can be attached to a FieldInterface label See `Blesta\Core\Util\Input\Fields\InputFields::label()` `Blesta\Core\Util\Input\Fields\InputField::attach()` Implementation of `Blesta\Core\Util\Input\Fields\Common\FieldsInterface::fieldText()`
`public Blesta\Core\Util\Input\Fields\InputField`	# `fieldHidden( string $name, string $value = null, array $attributes = [] )` Creates a hidden input field Creates a hidden input field Parameters `$name` The name to set in the HTML name field `$value` The value to set in the HTML value field `$attributes` Attributes for this input field Returns `Blesta\Core\Util\Input\Fields\InputField` An InputField object that can be attached to an InputField label See `Blesta\Core\Util\Input\Fields\InputFields::label()` `Blesta\Core\Util\Input\Fields\InputField::attach()` Implementation of `Blesta\Core\Util\Input\Fields\Common\FieldsInterface::fieldHidden()`
`public Blesta\Core\Util\Input\Fields\InputField`	# `fieldImage( string $name, string $value = null, array $attributes = [], Blesta\Core\Util\Input\Fields\Common\FieldInterface $label = null )` Creates an image input field Creates an image input field Parameters `$name` The name to set in the HTML name field `$value` The value to set in the HTML value field `$attributes` Attributes for this input field `$label` A FieldInterface object representing the label to attach to this field (see InputFields::label) Returns `Blesta\Core\Util\Input\Fields\InputField` An InputField object that can be attached to a FieldInterface label See `Blesta\Core\Util\Input\Fields\InputFields::label()` `Blesta\Core\Util\Input\Fields\InputField::attach()` Implementation of `Blesta\Core\Util\Input\Fields\Common\FieldsInterface::fieldImage()`
`public Blesta\Core\Util\Input\Fields\InputField`	# `fieldReset( string $name, string $value = null, array $attributes = [], Blesta\Core\Util\Input\Fields\Common\FieldInterface $label = null )` Creates a reset input field Creates a reset input field Parameters `$name` The name to set in the HTML name field `$value` The value to set in the HTML value field `$attributes` Attributes for this input field `$label` A FieldInterface object representing the label to attach to this field (see InputFields::label) Returns `Blesta\Core\Util\Input\Fields\InputField` An InputField object that can be attached to a FieldInterface label See `Blesta\Core\Util\Input\Fields\InputFields::label()` `Blesta\Core\Util\Input\Fields\InputField::attach()` Implementation of `Blesta\Core\Util\Input\Fields\Common\FieldsInterface::fieldReset()`
`public Blesta\Core\Util\Input\Fields\InputField`	# `fieldCheckbox( string $name, string $value = null, boolean $checked = false, array $attributes = [], Blesta\Core\Util\Input\Fields\Common\FieldInterface $label = null )` Creates a checkbox Creates a checkbox Parameters `$name` The name to set in the HTML name field `$value` The value to set in the HTML value field `$checked` True to set this field as checked `$attributes` Attributes for this input field `$label` A FieldInterface object representing the label to attach to this field (see InputFields::label) Returns `Blesta\Core\Util\Input\Fields\InputField` An InputField object that can be attached to a FieldInterface label See `Blesta\Core\Util\Input\Fields\InputFields::label()` `Blesta\Core\Util\Input\Fields\InputField::attach()` Implementation of `Blesta\Core\Util\Input\Fields\Common\FieldsInterface::fieldCheckbox()`
`public Blesta\Core\Util\Input\Fields\InputField`	# `fieldRadio( string $name, string $value = null, boolean $checked = false, array $attributes = [], Blesta\Core\Util\Input\Fields\Common\FieldInterface $label = null )` Creates a radio box Creates a radio box Parameters `$name` The name to set in the HTML name field `$value` The value to set in the HTML value field `$checked` True to set this field as checked `$attributes` Attributes for this input field `$label` A FieldInterface object representing the label to attach to this field (see InputFields::label) Returns `Blesta\Core\Util\Input\Fields\InputField` An InputField object that can be attached to a FieldInterface label See `Blesta\Core\Util\Input\Fields\InputFields::label()` `Blesta\Core\Util\Input\Fields\InputField::attach()` Implementation of `Blesta\Core\Util\Input\Fields\Common\FieldsInterface::fieldRadio()`
`public Blesta\Core\Util\Input\Fields\InputField`	# `fieldTextarea( string $name, string $value = null, array $attributes = [], Blesta\Core\Util\Input\Fields\Common\FieldInterface $label = null )` Creates a textarea field Creates a textarea field Parameters `$name` The name to set in the HTML name field `$value` The value to set in this textarea `$attributes` Attributes for this input field `$label` A FieldInterface object representing the label to attach to this field (see InputFields::label) Returns `Blesta\Core\Util\Input\Fields\InputField` An InputField object that can be attached to a FieldInterface label See `Blesta\Core\Util\Input\Fields\InputFields::label()` `Blesta\Core\Util\Input\Fields\InputField::attach()` Implementation of `Blesta\Core\Util\Input\Fields\Common\FieldsInterface::fieldTextarea()`
`public Blesta\Core\Util\Input\Fields\InputField`	# `fieldPassword( string $name, array $attributes = [], Blesta\Core\Util\Input\Fields\Common\FieldInterface $label = null )` Creates a password input field Creates a password input field Parameters `$name` The name to set in the HTML name field `$attributes` Attributes for this input field `$label` A FieldInterface object representing the label to attach to this field (see InputFields::label) Returns `Blesta\Core\Util\Input\Fields\InputField` An InputField object that can be attached to a FieldInterface label See `Blesta\Core\Util\Input\Fields\InputFields::label()` `Blesta\Core\Util\Input\Fields\InputField::attach()` Implementation of `Blesta\Core\Util\Input\Fields\Common\FieldsInterface::fieldPassword()`
`public Blesta\Core\Util\Input\Fields\InputField`	# `fieldFile( string $name, array $attributes = [], Blesta\Core\Util\Input\Fields\Common\FieldInterface $label = null )` Creates a file input field Creates a file input field Parameters `$name` The name to set in the HTML name field `$attributes` Attributes for this input field `$label` A FieldInterface object representing the label to attach to this field (see InputFields::label) Returns `Blesta\Core\Util\Input\Fields\InputField` An InputField object that can be attached to a FieldInterface label See `Blesta\Core\Util\Input\Fields\InputFields::label()` `Blesta\Core\Util\Input\Fields\InputField::attach()` Implementation of `Blesta\Core\Util\Input\Fields\Common\FieldsInterface::fieldFile()`
`public Blesta\Core\Util\Input\Fields\InputField`	# `fieldSelect( string $name, array $options = [], mixed $selected_value = null, array $attributes = [], array $option_attributes = [], Blesta\Core\Util\Input\Fields\Common\FieldInterface $label = null )` Creates a select list Creates a select list Parameters `$name` The name to set in the HTML name field `$options` The options to place in this select list `$selected_value` The option(s) to set as selected `$attributes` Attributes for this input field `$option_attributes` Attributes for each option to set. If single dimension will set the attributes for every option, if multi-dimensional will set option for each element key that matches in $options `$label` A FieldInterface object representing the label to attach to this field (see InputFields::label) Returns `Blesta\Core\Util\Input\Fields\InputField` An InputField object that can be attached to a FieldInterface label See `Blesta\Core\Util\Input\Fields\InputFields::label()` `Blesta\Core\Util\Input\Fields\InputField::attach()` Implementation of `Blesta\Core\Util\Input\Fields\Common\FieldsInterface::fieldSelect()`
`public Blesta\Core\Util\Input\Fields\InputField`	# `fieldMultiSelect( string $name, array $options = [], string $selected_values = [], array $attributes = [], array $option_attributes = [], Blesta\Core\Util\Input\Fields\Common\FieldInterface $label = null )` Creates a select list with multiple selectable options Creates a select list with multiple selectable options Parameters `$name` The name to set in the HTML name field `$options` The options to place in this select list `$selected_values` The options to set as selected `$attributes` Attributes for this input field `$option_attributes` Attributes for each option to set. If single dimension will set the attributes for every option, if multi-dimensional will set option for each element key that matches in $options `$label` A FieldInterface object representing the label to attach to this field (see InputFields::label) Returns `Blesta\Core\Util\Input\Fields\InputField` An InputField object that can be attached to a FieldInterface label See `Blesta\Core\Util\Input\Fields\InputFields::label()` `Blesta\Core\Util\Input\Fields\InputField::attach()` Implementation of `Blesta\Core\Util\Input\Fields\Common\FieldsInterface::fieldMultiSelect()`
`public Blesta\Core\Util\Input\Fields\InputField`	# `fieldButton( string $name, string $value = null, array $attributes = [], Blesta\Core\Util\Input\Fields\Common\FieldInterface $label = null )` Creates a button with default type=button, can be overriden by attirbutes Creates a button with default type=button, can be overriden by attirbutes Parameters `$name` The name to set in the HTML name field `$value` The value to set in the HTML value field `$attributes` Attributes for this input field `$label` A FieldInterface object representing the label to attach to this field (see InputFields::label) Returns `Blesta\Core\Util\Input\Fields\InputField` An InputField object that can be attached to a FieldInterface label See `Blesta\Core\Util\Input\Fields\InputFields::label()` `Blesta\Core\Util\Input\Fields\InputField::attach()` Implementation of `Blesta\Core\Util\Input\Fields\Common\FieldsInterface::fieldButton()`
`public Blesta\Core\Util\Input\Fields\InputField`	# `fieldSubmit( string $name, string $value = null, array $attributes = [], Blesta\Core\Util\Input\Fields\Common\FieldInterface $label = null )` Creates a button of type submit Creates a button of type submit Parameters `$name` The name to set in the HTML name field `$value` The value to set in the HTML value field `$attributes` Attributes for this input field `$label` A FieldInterface object representing the label to attach to this field (see InputFields::label) Returns `Blesta\Core\Util\Input\Fields\InputField` An InputField object that can be attached to a FieldInterface label See `Blesta\Core\Util\Input\Fields\InputFields::label()` `Blesta\Core\Util\Input\Fields\InputField::attach()` Implementation of `Blesta\Core\Util\Input\Fields\Common\FieldsInterface::fieldSubmit()`

Packages

Classes

Class InputFields

Direct known subclasses

Returns

Returns

Parameters

Parameters

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

See

Implementation of

Parameters

Returns

See

Implementation of

Parameters

Returns

See

Implementation of

Parameters

Returns

See

Implementation of

Parameters

Returns

See

Implementation of

Parameters

Returns

See

Implementation of

Parameters

Returns

See

Implementation of

Parameters

Returns

See

Implementation of

Parameters

Returns

See

Implementation of

Parameters

Returns

See

Implementation of

Parameters

Returns

See

Implementation of

Parameters

Returns

See

Implementation of

Parameters

Returns

See

Implementation of