From 389d9e2fd2b1f5d94fd806fe2cf3cd306316bfbf Mon Sep 17 00:00:00 2001 From: Carsten Brandt Date: Sun, 4 Jan 2015 19:03:46 +0100 Subject: [PATCH] add hint about custom element id and selectors property to Active Field fixes #6734 --- framework/widgets/ActiveField.php | 39 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+) diff --git a/framework/widgets/ActiveField.php b/framework/widgets/ActiveField.php index 8638566..4250ddc 100644 --- a/framework/widgets/ActiveField.php +++ b/framework/widgets/ActiveField.php @@ -43,6 +43,8 @@ class ActiveField extends Component * * - tag: the tag name of the container element. Defaults to "div". * + * If you set a custom `id` for the container element, you may need to adjust the [[$selectors]] accordingly. + * * @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered. */ public $options = ['class' => 'form-group']; @@ -54,6 +56,9 @@ class ActiveField extends Component /** * @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. + * + * If you set a custom `id` for the input element, you may need to adjust the [[$selectors]] accordingly. + * * @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered. */ public $inputOptions = ['class' => 'form-control']; @@ -65,6 +70,8 @@ class ActiveField extends Component * - tag: the tag name of the container element. Defaults to "div". * - encode: whether to encode the error output. Defaults to true. * + * If you set a custom `id` for the error element, you may need to adjust the [[$selectors]] accordingly. + * * @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered. */ public $errorOptions = ['class' => 'help-block']; @@ -271,6 +278,8 @@ class ActiveField extends Component * * If this parameter is false, no error tag will be rendered. * + * If you set a custom `id` for the error element, you may need to adjust the [[$selectors]] accordingly. + * * @return static the field object itself */ public function error($options = []) @@ -311,6 +320,9 @@ class ActiveField extends Component * @param string $type the input type (e.g. 'text', 'password') * @param array $options the tag options in terms of name-value pairs. These will be rendered as * the attributes of the resulting tag. The values will be HTML-encoded using [[Html::encode()]]. + * + * If you set a custom `id` for the input element, you may need to adjust the [[$selectors]] accordingly. + * * @return static the field object itself */ public function input($type, $options = []) @@ -328,6 +340,9 @@ class ActiveField extends Component * unless they are explicitly specified in `$options`. * @param array $options the tag options in terms of name-value pairs. These will be rendered as * the attributes of the resulting tag. The values will be HTML-encoded using [[Html::encode()]]. + * + * If you set a custom `id` for the input element, you may need to adjust the [[$selectors]] accordingly. + * * @return static the field object itself */ public function textInput($options = []) @@ -350,6 +365,9 @@ class ActiveField extends Component * unless they are explicitly specified in `$options`. * @param array $options the tag options in terms of name-value pairs. These will be rendered as * the attributes of the resulting tag. The values will be HTML-encoded using [[Html::encode()]]. + * + * If you set a custom `id` for the input element, you may need to adjust the [[$selectors]] accordingly. + * * @return static the field object itself */ public function hiddenInput($options = []) @@ -367,6 +385,9 @@ class ActiveField extends Component * unless they are explicitly specified in `$options`. * @param array $options the tag options in terms of name-value pairs. These will be rendered as * the attributes of the resulting tag. The values will be HTML-encoded using [[Html::encode()]]. + * + * If you set a custom `id` for the input element, you may need to adjust the [[$selectors]] accordingly. + * * @return static the field object itself */ public function passwordInput($options = []) @@ -384,6 +405,9 @@ class ActiveField extends Component * unless they are explicitly specified in `$options`. * @param array $options the tag options in terms of name-value pairs. These will be rendered as * the attributes of the resulting tag. The values will be HTML-encoded using [[Html::encode()]]. + * + * If you set a custom `id` for the input element, you may need to adjust the [[$selectors]] accordingly. + * * @return static the field object itself */ public function fileInput($options = []) @@ -403,6 +427,9 @@ class ActiveField extends Component * The model attribute value will be used as the content in the textarea. * @param array $options the tag options in terms of name-value pairs. These will be rendered as * the attributes of the resulting tag. The values will be HTML-encoded using [[Html::encode()]]. + * + * If you set a custom `id` for the textarea element, you may need to adjust the [[$selectors]] accordingly. + * * @return static the field object itself */ public function textarea($options = []) @@ -430,6 +457,9 @@ class ActiveField extends Component * * The rest of the options will be rendered as the attributes of the resulting tag. The values will * be HTML-encoded using [[Html::encode()]]. If a value is null, the corresponding attribute will not be rendered. + * + * If you set a custom `id` for the input element, you may need to adjust the [[$selectors]] accordingly. + * * @param boolean $enclosedByLabel whether to enclose the radio within the label. * If true, the method will still use [[template]] to layout the checkbox and the error message * except that the radio is enclosed by the label tag. @@ -471,6 +501,9 @@ class ActiveField extends Component * * The rest of the options will be rendered as the attributes of the resulting tag. The values will * be HTML-encoded using [[Html::encode()]]. If a value is null, the corresponding attribute will not be rendered. + * + * If you set a custom `id` for the input element, you may need to adjust the [[$selectors]] accordingly. + * * @param boolean $enclosedByLabel whether to enclose the checkbox within the label. * If true, the method will still use [[template]] to layout the checkbox and the error message * except that the checkbox is enclosed by the label tag. @@ -527,6 +560,8 @@ class ActiveField extends Component * The rest of the options will be rendered as the attributes of the resulting tag. The values will * be HTML-encoded using [[Html::encode()]]. If a value is null, the corresponding attribute will not be rendered. * + * If you set a custom `id` for the input element, you may need to adjust the [[$selectors]] accordingly. + * * @return static the field object itself */ public function dropDownList($items, $options = []) @@ -571,6 +606,8 @@ class ActiveField extends Component * The rest of the options will be rendered as the attributes of the resulting tag. The values will * be HTML-encoded using [[Html::encode()]]. If a value is null, the corresponding attribute will not be rendered. * + * If you set a custom `id` for the input element, you may need to adjust the [[$selectors]] accordingly. + * * @return static the field object itself */ public function listBox($items, $options = []) @@ -665,6 +702,8 @@ class ActiveField extends Component * ]); * ``` * + * If you set a custom `id` for the input element, you may need to adjust the [[$selectors]] accordingly. + * * @param string $class the widget class name * @param array $config name-value pairs that will be used to initialize the widget * @return static the field object itself