From 3b3beca04cada53fc4b15988d5986a2ed95a8458 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Michael=20H=C3=A4rtl?= Date: Wed, 9 Apr 2014 14:21:56 +0200 Subject: [PATCH] Issue #3029: Implement ActiveForm and ActiveField --- ActiveField.php | 319 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ ActiveForm.php | 101 ++++++++++++++++++ CHANGELOG.md | 1 + 3 files changed, 421 insertions(+) create mode 100644 ActiveField.php create mode 100644 ActiveForm.php diff --git a/ActiveField.php b/ActiveField.php new file mode 100644 index 0000000..d4c5938 --- /dev/null +++ b/ActiveField.php @@ -0,0 +1,319 @@ + 'horizontal']) + * + * // Form field without label + * echo $form->field($model, 'demo', [ + * 'inputOptions' => [ + * 'placeholder' => $model->getAttributeLabel('demo'), + * ], + * ])->label(false); + * + * // Inline radio list + * echo $form->field($model, 'demo')->inline()->radioList($items); + * + * // Control sizing in horizontal mode + * echo $form->field($model, 'demo', [ + * 'horizontalCssClasses' => [ + * 'wrapper' => 'col-sm-2', + * ] + * ]); + * + * // With standard layout you would use 'template' to size a specific field: + * // echo $form->field($model, 'demo', [ + * // 'template' => '{label}
{input}{error}{hint}
' + * // ]); + * + * // Input group + * echo $form->field($model, 'demo', [ + * 'inputTemplate' => '
@{input}
', + * ]); + * + * ActiveForm::end(); + * ``` + * + * @see \yii\bootstrap\ActiveForm + * @see http://getbootstrap.com/css/#forms + * + * @author Michael Härtl + * @since 2.0 + */ +class ActiveField extends \yii\widgets\ActiveField +{ + /** + * @var bool whether to render [[checkboxList()]] and [[radioList()]] inline. Default is `false`. + */ + public $inline = false; + + /** + * @var string|null optional template to render the `{input}` placheolder content + */ + public $inputTemplate; + + /** + * @var array options for the wrapper tag, used in the `{beginWrapper}` placeholder + */ + public $wrapperOptions = []; + + /** + * @var null|array CSS grid classes for horizontal layout. This must be an array with these keys: + * - 'offset' the offset grid class to append to the wrapper if no label is rendered + * - 'label' the label grid class + * - 'wrapper' the wrapper grid class + * - 'error' the error grid class + * - 'hint' the hint grid class + */ + public $horizontalCssClasses; + + /** + * @var bool whether to render the error. Default is `true` except for layout `inline`. + */ + public $enableError = true; + + /** + * @var bool whether to render the label. Default is `true`. + */ + public $enableLabel = true; + + /** + * @inheritDoc + */ + public function __construct($config = []) + { + $layoutConfig = $this->createLayoutConfig($config); + $config = ArrayHelper::merge($layoutConfig, $config); + return parent::__construct($config); + } + + /** + * @inheritDoc + */ + public function render($content = null) + { + if ($content === null) { + if (!isset($this->parts['{beginWrapper}'])) { + $options = $this->wrapperOptions; + $tag = ArrayHelper::remove($options, 'tag', 'div'); + $this->parts['{beginWrapper}'] = Html::beginTag($tag, $options); + $this->parts['{endWrapper}'] = Html::endTag($tag); + } + if ($this->enableLabel===false) { + $this->parts['{label}'] = ''; + $this->parts['{beginLabel}'] = ''; + $this->parts['{labelTitle}'] = ''; + $this->parts['{endLabel}'] = ''; + } elseif (!isset($this->parts['{beginLabel}'])) { + $this->renderLabelParts(); + } + if ($this->enableError===false) { + $this->parts['{error}'] = ''; + } + if ($this->inputTemplate) { + $input = isset($this->parts['{input}']) ? + $this->parts['{input}'] : Html::activeTextInput($this->model, $this->attribute, $this->inputOptions); + $this->parts['{input}'] = strtr($this->inputTemplate, ['{input}' => $input]); + } + } + return parent::render($content); + } + + /** + * @inheritDoc + */ + public function checkbox($options = [], $enclosedByLabel = true) + { + if ($enclosedByLabel) { + if (!isset($options['template'])) { + if ($this->form->layout==='horizontal') { + $this->template = "{beginWrapper}\n
\n{beginLabel}\n{input}\n{labelTitle}\n{endLabel}\n
\n{error}\n{endWrapper}\n{hint}"; + Html::addCssClass($this->wrapperOptions, $this->horizontalCssClasses['offset']); + } else { + $this->template = "
\n{beginLabel}\n{input}\n{labelTitle}\n{endLabel}\n{error}\n{hint}\n
"; + } + } + $this->labelOptions['class'] = null; + } + + parent::checkbox($options, false); + return $this; + } + + /** + * @inheritDoc + */ + public function checkboxList($items, $options = []) + { + if ($this->inline) { + if (!isset($options['template'])) { + $this->template = "{label}\n{beginWrapper}\n{input}\n{error}\n{endWrapper}\n{hint}"; + } + if (!isset($options['itemOptions'])) { + $options['itemOptions'] = [ + 'container' => false, + 'labelOptions' => ['class' => 'checkbox-inline'], + ]; + } + } + parent::checkboxList($items, $options); + return $this; + } + + /** + * @inheritDoc + */ + public function radioList($items, $options = []) + { + if ($this->inline) { + if (!isset($options['template'])) { + $this->template = "{label}\n{beginWrapper}\n{input}\n{error}\n{endWrapper}\n{hint}"; + } + if (!isset($options['itemOptions'])) { + $options['itemOptions'] = [ + 'container' => false, + 'labelOptions' => ['class' => 'radio-inline'], + ]; + } + } + parent::radioList($items, $options); + return $this; + } + + /** + * @inheritDoc + */ + public function label($label = null, $options = []) + { + if (is_bool($label)) { + $this->enableLabel = $label; + if ($label===false && $this->form->layout==='horizontal') { + Html::addCssClass($this->wrapperOptions, $this->horizontalCssClasses['offset']); + } + } else { + $this->renderLabelParts($label, $options); + parent::label($label, $options); + } + return $this; + } + + /** + * @param bool $value whether to render a inline list + * @return static the field object itself + * Make sure you call this method before [[checkboxList()]] or [[radioList()]] to have any effect. + */ + public function inline($value = true) + { + $this->inline = (bool)$value; + return $this; + } + + /** + * @param array $instanceConfig the configuration passed to this instance's constructor + * @return array the layout specific default configuration for this instance + */ + protected function createLayoutConfig($instanceConfig) + { + $config = [ + 'hintOptions' => [ + 'tag' => 'p', + 'class' => 'help-block', + ], + 'errorOptions' => [ + 'tag' => 'p', + 'class' => 'help-block', + ], + 'inputOptions' => [ + 'class' => 'form-control', + ], + ]; + + $layout = $instanceConfig['form']->layout; + + if ($layout==='horizontal') { + $config['template'] = "{label}\n{beginWrapper}\n{input}\n{error}\n{endWrapper}\n{hint}"; + $cssClasses = [ + 'offset' => 'col-sm-offset-3', + 'label' => 'col-sm-3', + 'wrapper' => 'col-sm-6', + 'error' => '', + 'hint' => 'col-sm-3', + ]; + if (isset($instanceConfig['horizontalCssClasses'])) { + $cssClasses = ArrayHelper::merge($cssClasses, $instanceConfig['horizontalCssClasses']); + } + $config['horizontalCssClasses'] = $cssClasses; + $config['wrapperOptions'] = ['class' => $cssClasses['wrapper']]; + $config['labelOptions'] = ['class' => 'control-label '.$cssClasses['label']]; + $config['errorOptions'] = ['class' => 'help-block '.$cssClasses['error']]; + $config['hintOptions'] = ['class' => 'help-block '.$cssClasses['hint'] ]; + } elseif ($layout==='inline') { + $config['labelOptions'] = ['class' => 'sr-only']; + $config['enableError'] = false; + } + + return $config; + } + + /** + * @param string|null $label the label or null to use model label + * @param array $options the tag options + */ + protected function renderLabelParts($label = null, $options = []) + { + $options = array_merge($this->labelOptions, $options); + if ($label===null) { + if (isset($options['label'])) { + $label = $options['label']; + unset($options['label']); + } else { + $attribute = Html::getAttributeName($this->attribute); + $label = $this->model->getAttributeLabel($attribute); + } + } + $this->parts['{beginLabel}'] = Html::beginTag('label', $options); + $this->parts['{endLabel}'] = Html::endTag('label'); + $this->parts['{labelTitle}'] = Html::encode($label); + } +} diff --git a/ActiveForm.php b/ActiveForm.php new file mode 100644 index 0000000..5edf57c --- /dev/null +++ b/ActiveForm.php @@ -0,0 +1,101 @@ + 'horizontal']) + * ``` + * + * This will set default values for the [[yii\bootstrap\ActiveField|ActiveField]] + * to render horizontal form fields. In particular the [[yii\bootstrap\ActiveField::template|template]] + * is set to `{label} {beginWrapper} {input} {error} {endWrapper} {hint}` and the + * [[yii\bootstrap\ActiveField::horizontalCssClasses|horizontalCssClasses]] are set to: + * + * ```php + * [ + * 'offset' => 'col-sm-offset-3', + * 'label' => 'col-sm-3', + * 'wrapper' => 'col-sm-6', + * 'error' => '', + * 'hint' => 'col-sm-3', + * ] + * ``` + * + * To get a different column layout in horizontal mode you can modify those options + * through [[fieldConfig]]: + * + * + * ```php + * $form = ActiveForm::begin([ + * 'layout' => 'horizontal', + * 'fieldConfig' => [ + * 'template' => "{label}\n{beginWrapper}\n{input}\n{hint}\n{error}\n{endWrapper}", + * 'horizontalCssClasses' => [ + * 'label' => 'col-sm-4', + * 'offset' => 'col-sm-offset-4', + * 'wrapper' => 'col-sm-8', + * 'error' => '', + * 'hint' => '', + * ], + * ], + * ]); + * ``` + * + * @see \yii\bootstrap\ActiveField for details on the [[fieldConfig]] options + * @see http://getbootstrap.com/css/#forms + * + * @author Michael Härtl + * @since 2.0 + */ +class ActiveForm extends \yii\widgets\ActiveForm +{ + /** + * @var array HTML attributes for the form tag. Default is `['role' => 'form']`. + */ + public $options = ['role' => 'form']; + + /** + * @var string the form layout. Either 'standard' (default), 'horizontal' or 'inline'. + * By chosing a layout, an appropriate default field configuration is applied. This will + * render the form fields with slightly different markup for each layout. You can + * override these defaults through [[fieldConfig]]. + * @see \yii\bootstrap\ActiveField for details on Bootstrap 3 field configuration + */ + public $layout = 'standard'; + + /** + * @inheritDoc + */ + public function init() + { + if (!in_array($this->layout, ['standard','horizontal','inline'])) { + throw new InvalidConfigException('Invalid layout type: '.$this->layout); + } + + if ($this->layout!=='standard') { + Html::addCssClass($this->options, 'form-'.$this->layout); + } + if (!isset($this->fieldConfig['class'])) { + $this->fieldConfig['class'] = ActiveField::className(); + } + return parent::init(); + } +} diff --git a/CHANGELOG.md b/CHANGELOG.md index 75239af..27a28c4 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,6 +4,7 @@ Yii Framework 2 bootstrap extension Change Log 2.0.0 beta under development ---------------------------- +- Enh #3029: Added `ActiveForm` and `ActiveField` (mikehaertl) - Bug #2361: `yii\bootstrap\NavBar::brandUrl` should default to the home URL of application (qiangxue) - Enh #1474: Added option to make NavBar 100% width (cebe) - Enh #1552: It is now possible to use multiple bootstrap NavBar in a single page (Alex-Code)