Commit 6fff5662 by Carsten Brandt

better use @see for See in phpdoc

parent c94a40e9
...@@ -72,7 +72,7 @@ class Choice extends Widget ...@@ -72,7 +72,7 @@ class Choice extends Widget
public $clientIdGetParamName = 'authclient'; public $clientIdGetParamName = 'authclient';
/** /**
* @var array the HTML attributes that should be rendered in the div HTML tag representing the container element. * @var array the HTML attributes that should be rendered in the div HTML tag representing the container element.
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered. * @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
*/ */
public $options = [ public $options = [
'class' => 'auth-clients' 'class' => 'auth-clients'
......
...@@ -39,7 +39,7 @@ class ButtonDropdown extends Widget ...@@ -39,7 +39,7 @@ class ButtonDropdown extends Widget
public $label = 'Button'; public $label = 'Button';
/** /**
* @var array the HTML attributes of the button. * @var array the HTML attributes of the button.
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered. * @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
*/ */
public $options = []; public $options = [];
/** /**
......
...@@ -44,7 +44,7 @@ class NavBar extends Widget ...@@ -44,7 +44,7 @@ class NavBar extends Widget
* *
* - tag: string, defaults to "nav", the name of the container tag. * - tag: string, defaults to "nav", the name of the container tag.
* *
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered. * @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
*/ */
public $options = []; public $options = [];
/** /**
...@@ -52,7 +52,7 @@ class NavBar extends Widget ...@@ -52,7 +52,7 @@ class NavBar extends Widget
* *
* - tag: string, defaults to "div", the name of the container tag. * - tag: string, defaults to "div", the name of the container tag.
* *
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered. * @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
*/ */
public $containerOptions = []; public $containerOptions = [];
/** /**
...@@ -67,7 +67,7 @@ class NavBar extends Widget ...@@ -67,7 +67,7 @@ class NavBar extends Widget
public $brandUrl; public $brandUrl;
/** /**
* @var array the HTML attributes of the brand link. * @var array the HTML attributes of the brand link.
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered. * @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
*/ */
public $brandOptions = []; public $brandOptions = [];
/** /**
...@@ -81,7 +81,7 @@ class NavBar extends Widget ...@@ -81,7 +81,7 @@ class NavBar extends Widget
public $renderInnerContainer = true; public $renderInnerContainer = true;
/** /**
* @var array the HTML attributes of the inner container. * @var array the HTML attributes of the inner container.
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered. * @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
*/ */
public $innerContainerOptions = []; public $innerContainerOptions = [];
......
...@@ -69,7 +69,7 @@ class Progress extends Widget ...@@ -69,7 +69,7 @@ class Progress extends Widget
public $percent = 0; public $percent = 0;
/** /**
* @var array the HTML attributes of the bar. * @var array the HTML attributes of the bar.
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered. * @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
*/ */
public $barOptions = []; public $barOptions = [];
/** /**
......
...@@ -76,19 +76,19 @@ class Tabs extends Widget ...@@ -76,19 +76,19 @@ class Tabs extends Widget
* *
* - tag: string, defaults to "div", the tag name of the item container tags. * - tag: string, defaults to "div", the tag name of the item container tags.
* *
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered. * @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
*/ */
public $itemOptions = []; public $itemOptions = [];
/** /**
* @var array list of HTML attributes for the header container tags. This will be overwritten * @var array list of HTML attributes for the header container tags. This will be overwritten
* by the "headerOptions" set in individual [[items]]. * by the "headerOptions" set in individual [[items]].
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered. * @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
*/ */
public $headerOptions = []; public $headerOptions = [];
/** /**
* @var array list of HTML attributes for the tab header link tags. This will be overwritten * @var array list of HTML attributes for the tab header link tags. This will be overwritten
* by the "linkOptions" set in individual [[items]]. * by the "linkOptions" set in individual [[items]].
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered. * @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
*/ */
public $linkOptions = []; public $linkOptions = [];
/** /**
......
...@@ -21,7 +21,7 @@ class Widget extends \yii\base\Widget ...@@ -21,7 +21,7 @@ class Widget extends \yii\base\Widget
{ {
/** /**
* @var array the HTML attributes for the widget container tag. * @var array the HTML attributes for the widget container tag.
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered. * @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
*/ */
public $options = []; public $options = [];
/** /**
......
...@@ -48,7 +48,7 @@ class Accordion extends Widget ...@@ -48,7 +48,7 @@ class Accordion extends Widget
* *
* - tag: string, defaults to "div", the tag name of the container tag of this widget * - tag: string, defaults to "div", the tag name of the container tag of this widget
* *
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered. * @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
*/ */
public $options = []; public $options = [];
/** /**
...@@ -72,7 +72,7 @@ class Accordion extends Widget ...@@ -72,7 +72,7 @@ class Accordion extends Widget
* *
* - tag: string, defaults to "div", the tag name of the item container tags. * - tag: string, defaults to "div", the tag name of the item container tags.
* *
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered. * @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
*/ */
public $itemOptions = []; public $itemOptions = [];
/** /**
...@@ -81,7 +81,7 @@ class Accordion extends Widget ...@@ -81,7 +81,7 @@ class Accordion extends Widget
* *
* - tag: string, defaults to "h3", the tag name of the item container tags. * - tag: string, defaults to "h3", the tag name of the item container tags.
* *
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered. * @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
*/ */
public $headerOptions = []; public $headerOptions = [];
......
...@@ -56,7 +56,7 @@ class DatePicker extends InputWidget ...@@ -56,7 +56,7 @@ class DatePicker extends InputWidget
public $inline = false; public $inline = false;
/** /**
* @var array the HTML attributes for the container tag. This is only used when [[inline]] is true. * @var array the HTML attributes for the container tag. This is only used when [[inline]] is true.
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered. * @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
*/ */
public $containerOptions = []; public $containerOptions = [];
......
...@@ -53,7 +53,7 @@ class Selectable extends Widget ...@@ -53,7 +53,7 @@ class Selectable extends Widget
* *
* - tag: string, defaults to "ul", the tag name of the container tag of this widget. * - tag: string, defaults to "ul", the tag name of the container tag of this widget.
* *
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered. * @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
*/ */
public $options = []; public $options = [];
/** /**
...@@ -75,7 +75,7 @@ class Selectable extends Widget ...@@ -75,7 +75,7 @@ class Selectable extends Widget
* *
* - tag: string, defaults to "li", the tag name of the item container tags. * - tag: string, defaults to "li", the tag name of the item container tags.
* *
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered. * @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
*/ */
public $itemOptions = []; public $itemOptions = [];
......
...@@ -55,7 +55,7 @@ class SliderInput extends InputWidget ...@@ -55,7 +55,7 @@ class SliderInput extends InputWidget
]; ];
/** /**
* @var array the HTML attributes for the container tag. * @var array the HTML attributes for the container tag.
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered. * @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
*/ */
public $containerOptions = []; public $containerOptions = [];
......
...@@ -43,7 +43,7 @@ class Sortable extends Widget ...@@ -43,7 +43,7 @@ class Sortable extends Widget
* *
* - tag: string, defaults to "ul", the tag name of the container tag of this widget. * - tag: string, defaults to "ul", the tag name of the container tag of this widget.
* *
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered. * @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
*/ */
public $options = []; public $options = [];
/** /**
...@@ -65,7 +65,7 @@ class Sortable extends Widget ...@@ -65,7 +65,7 @@ class Sortable extends Widget
* *
* - tag: string, defaults to "li", the tag name of the item container tags. * - tag: string, defaults to "li", the tag name of the item container tags.
* *
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered. * @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
*/ */
public $itemOptions = []; public $itemOptions = [];
......
...@@ -58,7 +58,7 @@ class Tabs extends Widget ...@@ -58,7 +58,7 @@ class Tabs extends Widget
* *
* - tag: string, defaults to "div", the tag name of the container tag of this widget. * - tag: string, defaults to "div", the tag name of the container tag of this widget.
* *
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered. * @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
*/ */
public $options = []; public $options = [];
/** /**
...@@ -80,13 +80,13 @@ class Tabs extends Widget ...@@ -80,13 +80,13 @@ class Tabs extends Widget
* *
* - tag: string, defaults to "div", the tag name of the item container tags. * - tag: string, defaults to "div", the tag name of the item container tags.
* *
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered. * @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
*/ */
public $itemOptions = []; public $itemOptions = [];
/** /**
* @var array list of HTML attributes for the header container tags. This will be overwritten * @var array list of HTML attributes for the header container tags. This will be overwritten
* by the "headerOptions" set in individual [[items]]. * by the "headerOptions" set in individual [[items]].
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered. * @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
*/ */
public $headerOptions = []; public $headerOptions = [];
/** /**
......
...@@ -24,7 +24,7 @@ class Widget extends \yii\base\Widget ...@@ -24,7 +24,7 @@ class Widget extends \yii\base\Widget
public static $theme = 'yii\jui\ThemeAsset'; public static $theme = 'yii\jui\ThemeAsset';
/** /**
* @var array the HTML attributes for the widget container tag. * @var array the HTML attributes for the widget container tag.
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered. * @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
*/ */
public $options = []; public $options = [];
/** /**
......
...@@ -41,7 +41,7 @@ class Captcha extends InputWidget ...@@ -41,7 +41,7 @@ class Captcha extends InputWidget
public $captchaAction = 'site/captcha'; public $captchaAction = 'site/captcha';
/** /**
* @var array HTML attributes to be applied to the CAPTCHA image tag. * @var array HTML attributes to be applied to the CAPTCHA image tag.
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered. * @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
*/ */
public $imageOptions = []; public $imageOptions = [];
/** /**
...@@ -52,7 +52,7 @@ class Captcha extends InputWidget ...@@ -52,7 +52,7 @@ class Captcha extends InputWidget
public $template = '{image} {input}'; public $template = '{image} {input}';
/** /**
* @var array the HTML attributes for the input tag. * @var array the HTML attributes for the input tag.
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered. * @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
*/ */
public $options = ['class' => 'form-control']; public $options = ['class' => 'form-control'];
......
...@@ -19,7 +19,7 @@ use yii\base\InvalidCallException; ...@@ -19,7 +19,7 @@ use yii\base\InvalidCallException;
/** /**
* ActiveRecord is the base class for classes representing relational data in terms of objects. * ActiveRecord is the base class for classes representing relational data in terms of objects.
* *
* See [[yii\db\ActiveRecord]] for a concrete implementation. * See [[\yii\db\ActiveRecord]] for a concrete implementation.
* *
* @property array $dirtyAttributes The changed attribute values (name-value pairs). This property is * @property array $dirtyAttributes The changed attribute values (name-value pairs). This property is
* read-only. * read-only.
......
...@@ -14,7 +14,7 @@ use yii\helpers\Html; ...@@ -14,7 +14,7 @@ use yii\helpers\Html;
/** /**
* CheckboxColumn displays a column of checkboxes in a grid view. * CheckboxColumn displays a column of checkboxes in a grid view.
* *
* * To add a CheckboxColumn to the [[GridView]], add it to the [[GridView::columns|columns]] configuration as follows: * To add a CheckboxColumn to the [[GridView]], add it to the [[GridView::columns|columns]] configuration as follows:
* *
* ```php * ```php
* 'columns' => [ * 'columns' => [
...@@ -45,7 +45,7 @@ class CheckboxColumn extends Column ...@@ -45,7 +45,7 @@ class CheckboxColumn extends Column
public $name = 'selection'; public $name = 'selection';
/** /**
* @var array HTML attributes for the checkboxes. * @var array HTML attributes for the checkboxes.
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered. * @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
*/ */
public $checkboxOptions = []; public $checkboxOptions = [];
/** /**
......
...@@ -41,12 +41,12 @@ class Column extends Object ...@@ -41,12 +41,12 @@ class Column extends Object
public $visible = true; public $visible = true;
/** /**
* @var array the HTML attributes for the column group tag. * @var array the HTML attributes for the column group tag.
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered. * @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
*/ */
public $options = []; public $options = [];
/** /**
* @var array the HTML attributes for the header cell tag. * @var array the HTML attributes for the header cell tag.
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered. * @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
*/ */
public $headerOptions = []; public $headerOptions = [];
/** /**
...@@ -55,17 +55,17 @@ class Column extends Object ...@@ -55,17 +55,17 @@ class Column extends Object
* The signature of the function should be the following: `function ($model, $key, $index, $gridView)`. * The signature of the function should be the following: `function ($model, $key, $index, $gridView)`.
* A function may be used to assign different attributes to different rows based on the data in that row. * A function may be used to assign different attributes to different rows based on the data in that row.
* *
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered. * @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
*/ */
public $contentOptions = []; public $contentOptions = [];
/** /**
* @var array the HTML attributes for the footer cell tag. * @var array the HTML attributes for the footer cell tag.
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered. * @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
*/ */
public $footerOptions = []; public $footerOptions = [];
/** /**
* @var array the HTML attributes for the filter cell tag. * @var array the HTML attributes for the filter cell tag.
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered. * @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
*/ */
public $filterOptions = []; public $filterOptions = [];
......
...@@ -62,7 +62,7 @@ class DataColumn extends Column ...@@ -62,7 +62,7 @@ class DataColumn extends Column
/** /**
* @var array the HTML attributes for the link tag in the header cell * @var array the HTML attributes for the link tag in the header cell
* generated by [[\yii\data\Sort::link]] when sorting is enabled for this column. * generated by [[\yii\data\Sort::link]] when sorting is enabled for this column.
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered. * @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
*/ */
public $sortLinkOptions = []; public $sortLinkOptions = [];
/** /**
...@@ -79,7 +79,7 @@ class DataColumn extends Column ...@@ -79,7 +79,7 @@ class DataColumn extends Column
* @var array the HTML attributes for the filter input fields. This property is used in combination with * @var array the HTML attributes for the filter input fields. This property is used in combination with
* the [[filter]] property. When [[filter]] is not set or is an array, this property will be used to * the [[filter]] property. When [[filter]] is not set or is an array, this property will be used to
* render the HTML attributes for the generated filter input fields. * render the HTML attributes for the generated filter input fields.
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered. * @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
*/ */
public $filterInputOptions = ['class' => 'form-control', 'id' => null]; public $filterInputOptions = ['class' => 'form-control', 'id' => null];
......
...@@ -42,29 +42,29 @@ class GridView extends BaseListView ...@@ -42,29 +42,29 @@ class GridView extends BaseListView
public $caption; public $caption;
/** /**
* @var array the HTML attributes for the caption element. * @var array the HTML attributes for the caption element.
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered. * @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
* @see caption * @see caption
*/ */
public $captionOptions = []; public $captionOptions = [];
/** /**
* @var array the HTML attributes for the grid table element. * @var array the HTML attributes for the grid table element.
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered. * @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
*/ */
public $tableOptions = ['class' => 'table table-striped table-bordered']; public $tableOptions = ['class' => 'table table-striped table-bordered'];
/** /**
* @var array the HTML attributes for the container tag of the grid view. * @var array the HTML attributes for the container tag of the grid view.
* The "tag" element specifies the tag name of the container element and defaults to "div". * The "tag" element specifies the tag name of the container element and defaults to "div".
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered. * @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
*/ */
public $options = ['class' => 'grid-view']; public $options = ['class' => 'grid-view'];
/** /**
* @var array the HTML attributes for the table header row. * @var array the HTML attributes for the table header row.
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered. * @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
*/ */
public $headerRowOptions = []; public $headerRowOptions = [];
/** /**
* @var array the HTML attributes for the table footer row. * @var array the HTML attributes for the table footer row.
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered. * @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
*/ */
public $footerRowOptions = []; public $footerRowOptions = [];
/** /**
...@@ -82,7 +82,7 @@ class GridView extends BaseListView ...@@ -82,7 +82,7 @@ class GridView extends BaseListView
* - `$index`: the zero-based index of the data model in the model array returned by [[dataProvider]] * - `$index`: the zero-based index of the data model in the model array returned by [[dataProvider]]
* - `$grid`: the GridView object * - `$grid`: the GridView object
* *
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered. * @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
*/ */
public $rowOptions = []; public $rowOptions = [];
/** /**
...@@ -170,7 +170,7 @@ class GridView extends BaseListView ...@@ -170,7 +170,7 @@ class GridView extends BaseListView
public $filterPosition = self::FILTER_POS_BODY; public $filterPosition = self::FILTER_POS_BODY;
/** /**
* @var array the HTML attributes for the filter row element. * @var array the HTML attributes for the filter row element.
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered. * @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
*/ */
public $filterRowOptions = ['class' => 'filters']; public $filterRowOptions = ['class' => 'filters'];
......
...@@ -80,6 +80,7 @@ class BaseHtml ...@@ -80,6 +80,7 @@ class BaseHtml
'media', 'media',
]; ];
/** /**
* Encodes special characters into HTML entities. * Encodes special characters into HTML entities.
* The [[\yii\base\Application::charset|application charset]] will be used for encoding. * The [[\yii\base\Application::charset|application charset]] will be used for encoding.
...@@ -685,12 +686,12 @@ class BaseHtml ...@@ -685,12 +686,12 @@ class BaseHtml
* - options: array, the attributes for the select option tags. The array keys must be valid option values, * - options: array, the attributes for the select option tags. The array keys must be valid option values,
* and the array values are the extra attributes for the corresponding option tags. For example, * and the array values are the extra attributes for the corresponding option tags. For example,
* *
* ~~~ * ~~~
* [ * [
* 'value1' => ['disabled' => true], * 'value1' => ['disabled' => true],
* 'value2' => ['label' => 'value 2'], * 'value2' => ['label' => 'value 2'],
* ]; * ];
* ~~~ * ~~~
* *
* - groups: array, the attributes for the optgroup tags. The structure of this is similar to that of 'options', * - groups: array, the attributes for the optgroup tags. The structure of this is similar to that of 'options',
* except that the array keys represent the optgroup labels specified in $items. * except that the array keys represent the optgroup labels specified in $items.
...@@ -729,12 +730,12 @@ class BaseHtml ...@@ -729,12 +730,12 @@ class BaseHtml
* - options: array, the attributes for the select option tags. The array keys must be valid option values, * - options: array, the attributes for the select option tags. The array keys must be valid option values,
* and the array values are the extra attributes for the corresponding option tags. For example, * and the array values are the extra attributes for the corresponding option tags. For example,
* *
* ~~~ * ~~~
* [ * [
* 'value1' => ['disabled' => true], * 'value1' => ['disabled' => true],
* 'value2' => ['label' => 'value 2'], * 'value2' => ['label' => 'value 2'],
* ]; * ];
* ~~~ * ~~~
* *
* - groups: array, the attributes for the optgroup tags. The structure of this is similar to that of 'options', * - groups: array, the attributes for the optgroup tags. The structure of this is similar to that of 'options',
* except that the array keys represent the optgroup labels specified in $items. * except that the array keys represent the optgroup labels specified in $items.
...@@ -792,13 +793,13 @@ class BaseHtml ...@@ -792,13 +793,13 @@ class BaseHtml
* - item: callable, a callback that can be used to customize the generation of the HTML code * - item: callable, a callback that can be used to customize the generation of the HTML code
* corresponding to a single item in $items. The signature of this callback must be: * corresponding to a single item in $items. The signature of this callback must be:
* *
* ~~~ * ~~~
* function ($index, $label, $name, $checked, $value) * function ($index, $label, $name, $checked, $value)
* ~~~ * ~~~
* *
* where $index is the zero-based index of the checkbox in the whole list; $label * where $index is the zero-based index of the checkbox in the whole list; $label
* is the label for the checkbox; and $name, $value and $checked represent the name, * is the label for the checkbox; and $name, $value and $checked represent the name,
* value and the checked status of the checkbox input, respectively. * value and the checked status of the checkbox input, respectively.
* *
* See [[renderTagAttributes()]] for details on how attributes are being rendered. * See [[renderTagAttributes()]] for details on how attributes are being rendered.
* *
...@@ -863,13 +864,13 @@ class BaseHtml ...@@ -863,13 +864,13 @@ class BaseHtml
* - item: callable, a callback that can be used to customize the generation of the HTML code * - item: callable, a callback that can be used to customize the generation of the HTML code
* corresponding to a single item in $items. The signature of this callback must be: * corresponding to a single item in $items. The signature of this callback must be:
* *
* ~~~ * ~~~
* function ($index, $label, $name, $checked, $value) * function ($index, $label, $name, $checked, $value)
* ~~~ * ~~~
* *
* where $index is the zero-based index of the radio button in the whole list; $label * where $index is the zero-based index of the radio button in the whole list; $label
* is the label for the radio button; and $name, $value and $checked represent the name, * is the label for the radio button; and $name, $value and $checked represent the name,
* value and the checked status of the radio button input, respectively. * value and the checked status of the radio button input, respectively.
* *
* See [[renderTagAttributes()]] for details on how attributes are being rendered. * See [[renderTagAttributes()]] for details on how attributes are being rendered.
* *
...@@ -923,12 +924,12 @@ class BaseHtml ...@@ -923,12 +924,12 @@ class BaseHtml
* - item: callable, a callback that is used to generate each individual list item. * - item: callable, a callback that is used to generate each individual list item.
* The signature of this callback must be: * The signature of this callback must be:
* *
* ~~~ * ~~~
* function ($item, $index) * function ($item, $index)
* ~~~ * ~~~
* *
* where $index is the array key corresponding to `$item` in `$items`. The callback should return * where $index is the array key corresponding to `$item` in `$items`. The callback should return
* the whole list item tag. * the whole list item tag.
* *
* See [[renderTagAttributes()]] for details on how attributes are being rendered. * See [[renderTagAttributes()]] for details on how attributes are being rendered.
* *
...@@ -967,12 +968,12 @@ class BaseHtml ...@@ -967,12 +968,12 @@ class BaseHtml
* - item: callable, a callback that is used to generate each individual list item. * - item: callable, a callback that is used to generate each individual list item.
* The signature of this callback must be: * The signature of this callback must be:
* *
* ~~~ * ~~~
* function ($item, $index) * function ($item, $index)
* ~~~ * ~~~
* *
* where $index is the array key corresponding to `$item` in `$items`. The callback should return * where $index is the array key corresponding to `$item` in `$items`. The callback should return
* the whole list item tag. * the whole list item tag.
* *
* See [[renderTagAttributes()]] for details on how attributes are being rendered. * See [[renderTagAttributes()]] for details on how attributes are being rendered.
* *
...@@ -1260,12 +1261,12 @@ class BaseHtml ...@@ -1260,12 +1261,12 @@ class BaseHtml
* - options: array, the attributes for the select option tags. The array keys must be valid option values, * - options: array, the attributes for the select option tags. The array keys must be valid option values,
* and the array values are the extra attributes for the corresponding option tags. For example, * and the array values are the extra attributes for the corresponding option tags. For example,
* *
* ~~~ * ~~~
* [ * [
* 'value1' => ['disabled' => true], * 'value1' => ['disabled' => true],
* 'value2' => ['label' => 'value 2'], * 'value2' => ['label' => 'value 2'],
* ]; * ];
* ~~~ * ~~~
* *
* - groups: array, the attributes for the optgroup tags. The structure of this is similar to that of 'options', * - groups: array, the attributes for the optgroup tags. The structure of this is similar to that of 'options',
* except that the array keys represent the optgroup labels specified in $items. * except that the array keys represent the optgroup labels specified in $items.
...@@ -1309,12 +1310,12 @@ class BaseHtml ...@@ -1309,12 +1310,12 @@ class BaseHtml
* - options: array, the attributes for the select option tags. The array keys must be valid option values, * - options: array, the attributes for the select option tags. The array keys must be valid option values,
* and the array values are the extra attributes for the corresponding option tags. For example, * and the array values are the extra attributes for the corresponding option tags. For example,
* *
* ~~~ * ~~~
* [ * [
* 'value1' => ['disabled' => true], * 'value1' => ['disabled' => true],
* 'value2' => ['label' => 'value 2'], * 'value2' => ['label' => 'value 2'],
* ]; * ];
* ~~~ * ~~~
* *
* - groups: array, the attributes for the optgroup tags. The structure of this is similar to that of 'options', * - groups: array, the attributes for the optgroup tags. The structure of this is similar to that of 'options',
* except that the array keys represent the optgroup labels specified in $items. * except that the array keys represent the optgroup labels specified in $items.
...@@ -1361,13 +1362,13 @@ class BaseHtml ...@@ -1361,13 +1362,13 @@ class BaseHtml
* - item: callable, a callback that can be used to customize the generation of the HTML code * - item: callable, a callback that can be used to customize the generation of the HTML code
* corresponding to a single item in $items. The signature of this callback must be: * corresponding to a single item in $items. The signature of this callback must be:
* *
* ~~~ * ~~~
* function ($index, $label, $name, $checked, $value) * function ($index, $label, $name, $checked, $value)
* ~~~ * ~~~
* *
* where $index is the zero-based index of the checkbox in the whole list; $label * where $index is the zero-based index of the checkbox in the whole list; $label
* is the label for the checkbox; and $name, $value and $checked represent the name, * is the label for the checkbox; and $name, $value and $checked represent the name,
* value and the checked status of the checkbox input. * value and the checked status of the checkbox input.
* *
* See [[renderTagAttributes()]] for details on how attributes are being rendered. * See [[renderTagAttributes()]] for details on how attributes are being rendered.
* *
...@@ -1405,13 +1406,13 @@ class BaseHtml ...@@ -1405,13 +1406,13 @@ class BaseHtml
* - item: callable, a callback that can be used to customize the generation of the HTML code * - item: callable, a callback that can be used to customize the generation of the HTML code
* corresponding to a single item in $items. The signature of this callback must be: * corresponding to a single item in $items. The signature of this callback must be:
* *
* ~~~ * ~~~
* function ($index, $label, $name, $checked, $value) * function ($index, $label, $name, $checked, $value)
* ~~~ * ~~~
* *
* where $index is the zero-based index of the radio button in the whole list; $label * where $index is the zero-based index of the radio button in the whole list; $label
* is the label for the radio button; and $name, $value and $checked represent the name, * is the label for the radio button; and $name, $value and $checked represent the name,
* value and the checked status of the radio button input. * value and the checked status of the radio button input.
* *
* See [[renderTagAttributes()]] for details on how attributes are being rendered. * See [[renderTagAttributes()]] for details on how attributes are being rendered.
* *
......
...@@ -41,7 +41,7 @@ class ActiveField extends Component ...@@ -41,7 +41,7 @@ class ActiveField extends Component
* *
* - tag: the tag name of the container element. Defaults to "div". * - tag: the tag name of the container element. Defaults to "div".
* *
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered. * @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
*/ */
public $options = ['class' => 'form-group']; public $options = ['class' => 'form-group'];
/** /**
...@@ -52,7 +52,7 @@ class ActiveField extends Component ...@@ -52,7 +52,7 @@ class ActiveField extends Component
/** /**
* @var array the default options for the input tags. The parameter passed to individual input methods * @var array the default options for the input tags. The parameter passed to individual input methods
* (e.g. [[textInput()]]) will be merged with this property when rendering the input tag. * (e.g. [[textInput()]]) will be merged with this property when rendering the input tag.
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered. * @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
*/ */
public $inputOptions = ['class' => 'form-control']; public $inputOptions = ['class' => 'form-control'];
/** /**
...@@ -62,13 +62,13 @@ class ActiveField extends Component ...@@ -62,13 +62,13 @@ class ActiveField extends Component
* *
* - tag: the tag name of the container element. Defaults to "div". * - tag: the tag name of the container element. Defaults to "div".
* *
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered. * @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
*/ */
public $errorOptions = ['class' => 'help-block']; public $errorOptions = ['class' => 'help-block'];
/** /**
* @var array the default options for the label tags. The parameter passed to [[label()]] will be * @var array the default options for the label tags. The parameter passed to [[label()]] will be
* merged with this property when rendering the label tag. * merged with this property when rendering the label tag.
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered. * @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
*/ */
public $labelOptions = ['class' => 'control-label']; public $labelOptions = ['class' => 'control-label'];
/** /**
...@@ -78,7 +78,7 @@ class ActiveField extends Component ...@@ -78,7 +78,7 @@ class ActiveField extends Component
* *
* - tag: the tag name of the container element. Defaults to "div". * - tag: the tag name of the container element. Defaults to "div".
* *
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered. * @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
*/ */
public $hintOptions = ['class' => 'hint-block']; public $hintOptions = ['class' => 'hint-block'];
/** /**
......
...@@ -34,7 +34,7 @@ class ActiveForm extends Widget ...@@ -34,7 +34,7 @@ class ActiveForm extends Widget
public $method = 'post'; public $method = 'post';
/** /**
* @var array the HTML attributes (name-value pairs) for the form tag. * @var array the HTML attributes (name-value pairs) for the form tag.
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered. * @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
*/ */
public $options = []; public $options = [];
/** /**
......
...@@ -22,7 +22,7 @@ abstract class BaseListView extends Widget ...@@ -22,7 +22,7 @@ abstract class BaseListView extends Widget
/** /**
* @var array the HTML attributes for the container tag of the list view. * @var array the HTML attributes for the container tag of the list view.
* The "tag" element specifies the tag name of the container element and defaults to "div". * The "tag" element specifies the tag name of the container element and defaults to "div".
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered. * @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
*/ */
public $options = []; public $options = [];
/** /**
......
...@@ -53,7 +53,7 @@ class Breadcrumbs extends Widget ...@@ -53,7 +53,7 @@ class Breadcrumbs extends Widget
public $tag = 'ul'; public $tag = 'ul';
/** /**
* @var array the HTML attributes for the breadcrumb container tag. * @var array the HTML attributes for the breadcrumb container tag.
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered. * @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
*/ */
public $options = ['class' => 'breadcrumb']; public $options = ['class' => 'breadcrumb'];
/** /**
......
...@@ -91,7 +91,7 @@ class DetailView extends Widget ...@@ -91,7 +91,7 @@ class DetailView extends Widget
/** /**
* @var array the HTML attributes for the container tag of this widget. The "tag" option specifies * @var array the HTML attributes for the container tag of this widget. The "tag" option specifies
* what container tag should be used. It defaults to "table" if not set. * what container tag should be used. It defaults to "table" if not set.
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered. * @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
*/ */
public $options = ['class' => 'table table-striped table-bordered detail-view']; public $options = ['class' => 'table table-striped table-bordered detail-view'];
/** /**
......
...@@ -43,7 +43,7 @@ class InputWidget extends Widget ...@@ -43,7 +43,7 @@ class InputWidget extends Widget
public $value; public $value;
/** /**
* @var array the HTML attributes for the input tag. * @var array the HTML attributes for the input tag.
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered. * @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
*/ */
public $options = []; public $options = [];
......
...@@ -35,12 +35,12 @@ class LinkPager extends Widget ...@@ -35,12 +35,12 @@ class LinkPager extends Widget
public $pagination; public $pagination;
/** /**
* @var array HTML attributes for the pager container tag. * @var array HTML attributes for the pager container tag.
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered. * @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
*/ */
public $options = ['class' => 'pagination']; public $options = ['class' => 'pagination'];
/** /**
* @var array HTML attributes for the link in a pager container tag. * @var array HTML attributes for the link in a pager container tag.
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered. * @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
*/ */
public $linkOptions = []; public $linkOptions = [];
/** /**
......
...@@ -35,7 +35,7 @@ class LinkSorter extends Widget ...@@ -35,7 +35,7 @@ class LinkSorter extends Widget
/** /**
* @var array HTML attributes for the sorter container tag. * @var array HTML attributes for the sorter container tag.
* @see \yii\helpers\Html::ul() for special attributes. * @see \yii\helpers\Html::ul() for special attributes.
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered. * @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
*/ */
public $options = ['class' => 'sorter']; public $options = ['class' => 'sorter'];
......
...@@ -22,7 +22,7 @@ class ListView extends BaseListView ...@@ -22,7 +22,7 @@ class ListView extends BaseListView
* @var array the HTML attributes for the container of the rendering result of each data model. * @var array the HTML attributes for the container of the rendering result of each data model.
* The "tag" element specifies the tag name of the container element and defaults to "div". * The "tag" element specifies the tag name of the container element and defaults to "div".
* If "tag" is false, it means no container element will be rendered. * If "tag" is false, it means no container element will be rendered.
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered. * @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
*/ */
public $itemOptions = []; public $itemOptions = [];
/** /**
...@@ -56,7 +56,7 @@ class ListView extends BaseListView ...@@ -56,7 +56,7 @@ class ListView extends BaseListView
/** /**
* @var array the HTML attributes for the container tag of the list view. * @var array the HTML attributes for the container tag of the list view.
* The "tag" element specifies the tag name of the container element and defaults to "div". * The "tag" element specifies the tag name of the container element and defaults to "div".
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered. * @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
*/ */
public $options = ['class' => 'list-view']; public $options = ['class' => 'list-view'];
......
...@@ -63,7 +63,7 @@ class MaskedInput extends InputWidget ...@@ -63,7 +63,7 @@ class MaskedInput extends InputWidget
public $completed; public $completed;
/** /**
* @var array the HTML attributes for the input tag. * @var array the HTML attributes for the input tag.
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered. * @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
*/ */
public $options = ['class' => 'form-control']; public $options = ['class' => 'form-control'];
......
...@@ -75,7 +75,7 @@ class Menu extends Widget ...@@ -75,7 +75,7 @@ class Menu extends Widget
* *
* - tag: string, defaults to "li", the tag name of the item container tags. * - tag: string, defaults to "li", the tag name of the item container tags.
* *
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered. * @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
*/ */
public $itemOptions = []; public $itemOptions = [];
/** /**
...@@ -125,7 +125,7 @@ class Menu extends Widget ...@@ -125,7 +125,7 @@ class Menu extends Widget
* *
* - tag: string, defaults to "ul", the tag name of the item container tags. * - tag: string, defaults to "ul", the tag name of the item container tags.
* *
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered. * @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
*/ */
public $options = []; public $options = [];
/** /**
......
...@@ -45,7 +45,7 @@ class Pjax extends Widget ...@@ -45,7 +45,7 @@ class Pjax extends Widget
{ {
/** /**
* @var array the HTML attributes for the widget container tag. * @var array the HTML attributes for the widget container tag.
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered. * @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
*/ */
public $options = []; public $options = [];
/** /**
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment