0 follower

Yii Framework 3.0 API Documentation

This is the Yii Framework API Documentation. Here you will find detailed information about all classes provided by the Framework. Below you find a list of the existing classes, interfaces, and traits, ordered by their fully qualified name (including the namespace). Each of them has a dedicated page which contains a description about the purpose of the class, a list of the available methods, properties and constants, and detailed description on how to use each of them.

On this page you find all the classes included in version 3.0 of the framework. You can use the dropdown menu on the top right to switch between versions.

You can search API documentation using the search form on the top. You can search for class names and also method and property names, e.g. ActiveRecord.save() or just .save() or ::save().

This page is also available in JSON format:
curl https://www.yiiframework.com/doc/api/3.0/form -H 'Accept: application/json'

Class Description
Yiisoft\Form\Field\Base\BaseField
Yiisoft\Form\Field\Base\ButtonField
Yiisoft\Form\Field\Base\DateTimeInputField
Yiisoft\Form\Field\Base\EnrichFromValidationRules\EnrichFromValidationRulesInterface Controls whether a field's configuration should be enriched by additional configuration / parameters provided by {@see ValidationRulesEnricherInterface::process()}.
Yiisoft\Form\Field\Base\EnrichFromValidationRules\EnrichFromValidationRulesTrait
Yiisoft\Form\Field\Base\FieldContentTrait Adds functionality for processing with field content.
Yiisoft\Form\Field\Base\InputData\InputDataInterface Represents some common information about input and its validation rules / state.
Yiisoft\Form\Field\Base\InputData\InputDataTrait
Yiisoft\Form\Field\Base\InputData\InputDataWithCustomNameAndValueTrait
Yiisoft\Form\Field\Base\InputField
Yiisoft\Form\Field\Base\PartsField
Yiisoft\Form\Field\Base\Placeholder\PlaceholderInterface
Yiisoft\Form\Field\Base\Placeholder\PlaceholderTrait
Yiisoft\Form\Field\Base\ValidationClass\ValidationClassInterface
Yiisoft\Form\Field\Base\ValidationClass\ValidationClassTrait
Yiisoft\Form\Field\Button Represents <button> element of type "button" are rendered as button without default behavior.
Yiisoft\Form\Field\ButtonGroup Represents a button group widget.
Yiisoft\Form\Field\Checkbox The input element with a type attribute whose value is "checkbox" represents a state or option that can be toggled.
Yiisoft\Form\Field\CheckboxList Represents a list of checkboxes with multiple selection.
Yiisoft\Form\Field\Color Represents <input> element of type "color" that allows the user to select a color.
Yiisoft\Form\Field\Date Represents <input> element of type "date" are let the user enter a date, either with a textbox that validates the input or a special date picker interface.
Yiisoft\Form\Field\DateTimeLocal Represents <input> element of type "datetime-local" are let the user easily enter both a date and a time, including the year, month, and day as well as the time in hours and minutes.
Yiisoft\Form\Field\Email
Yiisoft\Form\Field\ErrorSummary
Yiisoft\Form\Field\Fieldset Represents <fieldset> element are use to group several controls.
Yiisoft\Form\Field\File Represents <input> element of type "file" are ley the user choose one or more files from their device storage.
Yiisoft\Form\Field\Hidden Represents <input> element of type "hidden" are let web developers include data that cannot be seen or modified by users when a form is submitted
Yiisoft\Form\Field\Image Represents <input> element of type "image" are used to create graphical submit buttons.
Yiisoft\Form\Field\Number Represents <input> element of type "number" are used to let the user enter and edit a telephone number.
Yiisoft\Form\Field\Part\Error Represent a field validation error (if there are several errors, the first one is used). If field is no validation error, field part will be hidden.
Yiisoft\Form\Field\Part\Hint Represents hint for a form field.
Yiisoft\Form\Field\Part\Label Represents label for a form field.
Yiisoft\Form\Field\Password Represents <input> element of type "password" are let the user securely enter a password.
Yiisoft\Form\Field\RadioList
Yiisoft\Form\Field\Range Represents <input> element of type "range" are let the user specify a numeric value which must be no less than a given value, and no more than another given value.
Yiisoft\Form\Field\ResetButton Represents <button> element of type "reset" are rendered as button for resets all the controls to their initial values.
Yiisoft\Form\Field\Select Represents <select> element that provides a menu of options.
Yiisoft\Form\Field\SubmitButton Represents <button> element of type "submit" are rendered as button for submitting a form.
Yiisoft\Form\Field\Telephone
Yiisoft\Form\Field\Text Generates a text input tag for the given form attribute.
Yiisoft\Form\Field\Textarea Represents <textarea> element that create a multi-line plain-text editing control.
Yiisoft\Form\Field\Time Represents <input> element of type "time" are let the user enter a time (hour, minute, second, and fraction of a second).
Yiisoft\Form\Field\Url
Yiisoft\Form\PureField\Field
Yiisoft\Form\PureField\FieldFactory
Yiisoft\Form\PureField\InputData Simple input data implementation that can be used within this package. All parameters are passed from outer scope.
Yiisoft\Form\Theme\Theme
Yiisoft\Form\Theme\ThemeContainer
Yiisoft\Form\Theme\ThemePath
Yiisoft\Form\ValidationRulesEnricherInterface