Skip to content

Y
yii2
Commit a5759771 by Antonio Ramirez
Options

buttons refactored (2nd round)

parent fce33a25
Showing with 310 additions and 104 deletions
framework/yii/bootstrap/Button.php
...@@ -12,82 +12,34 @@ use yii\helpers\Html; ...@@ -12,82 +12,34 @@ use yii\helpers\Html;
/** /**
* Button renders a group or split button dropdown bootstrap component. * Button renders a bootstrap button.
* *
* For example, * For example,
* *
* ```php * ```php
* // a button group using Dropdown widget * echo Button::widget(array(
* echo \yii\bootstrap\Button::widget(array(
* 'label' => 'Action', * 'label' => 'Action',
* 'items' => Dropdown::widget(array( * 'options' => array('class' => 'btn-large'),
* 'clientOptions' => false,
* 'items' => array(
* array(
* 'label' => 'DropdownA',
* 'url' => '/',
* ),
* array(
* 'label' => 'DropdownB',
* 'url' => '#',
* ),
* ),
* )),
* ));
*
* // split button group using `items` dropdown configuration
* echo \yii\bootstrap\Button::widget(array(
* 'label' => 'Action',
* 'split' => true,
* 'items' => array(
* array(
* 'label' => 'DropdownA',
* 'url' => '/',
* ),
* array(
* 'label' => 'DropdownB',
* 'url' => '#',
* ),
* ),
* )); * ));
* ``` * ```
* @see http://twitter.github.io/bootstrap/javascript.html#buttons * @see http://twitter.github.io/bootstrap/javascript.html#buttons
* @see http://twitter.github.io/bootstrap/components.html#buttonDropdowns
* @author Antonio Ramirez <amigo.cobos@gmail.com> * @author Antonio Ramirez <amigo.cobos@gmail.com>
* @since 2.0 * @since 2.0
*/ */
class Button extends Widget class Button extends Widget
{ {
/** /**
* @var string the button label * @var string the tag to use to render the button
*/
public $label;
/**
* @var array the HTML attributes of the button.
*/ */
public $buttonOptions = array(); public $tagName = 'button';
/** /**
* @var array list of menu items in the dropdown. Each array element represents a single * @var string the button label
* menu with the following structure:
*
* - label: string, required, the label of the item link
* - url: string, optional, the url of the item link. Defaults to "#".
* - linkOptions: array, optional, the HTML attributes of the item link.
* - options: array, optional, the HTML attributes of the item.
* - items: array, optional, the dropdown items configuration array.
*
* @see https://github.com/twitter/bootstrap/issues/5050#issuecomment-11741727
* @see [[Dropdown]]
*/
public $items = array();
/**
* @var boolean whether to display a group or split styled button group.
*/ */
public $split = false; public $label;
/** /**
* @var boolean whether the labels for dropdown items should be HTML-encoded. * @var boolean whether the label should be HTML-encoded.
*/ */
public $encodeLabels = true; public $encodeLabel = true;
/** /**
...@@ -101,7 +53,9 @@ class Button extends Widget ...@@ -101,7 +53,9 @@ class Button extends Widget
throw new InvalidConfigException("The 'label' option is required."); throw new InvalidConfigException("The 'label' option is required.");
} }
parent::init(); parent::init();
$this->addCssClass($this->options, 'btn-group'); $this->clientOptions = false;
$this->addCssClass($this->options, 'btn');
$this->label = $this->encodeLabel ? Html::encode($this->label) : $this->label;
} }
/** /**
...@@ -109,51 +63,7 @@ class Button extends Widget ...@@ -109,51 +63,7 @@ class Button extends Widget
*/ */
public function run() public function run()
{ {
echo Html::beginTag('div', $this->options) . "\n"; echo Html::tag($this->tagName, $this->label, $this->options) . "\n";
echo $this->renderLabel() . "\n";
echo $this->renderItems() . "\n";
echo Html::endTag('div') . "\n";
$this->registerPlugin('button'); $this->registerPlugin('button');
} }
/**
* Generates the button label.
* @return string the rendering result.
*/
protected function renderLabel()
{
$label = $this->encodeLabels ? Html::encode($this->label) : $this->label;
$this->addCssClass($this->buttonOptions, 'btn');
$splitButton = '';
if ($this->split) {
$tag = 'button';
$options = $this->buttonOptions;
$this->buttonOptions['data-toggle'] = 'dropdown';
$this->addCssClass($this->buttonOptions, 'dropdown-toggle');
$splitButton = Html::tag('button', '<span class="caret"></span>', $this->buttonOptions);
} else {
$tag = 'a';
$label .= ' <span class="caret"></span>';
$options = $this->buttonOptions;
if (!isset($options['href'])) {
$options['href'] = '#';
}
$this->addCssClass($options, 'dropdown-toggle');
$options['data-toggle'] = 'dropdown';
}
return Html::tag($tag, $label, $options) . "\n" . $splitButton;
}
/**
* Generates the dropdown menu as specified on [[items]].
* @return string the rendering result.
*/
protected function renderItems()
{
if (is_string($this->items)) {
return $this->items;
}
$config = array('items' => $this->items, 'clientOptions' => false);
return Dropdown::widget($config);
}
} }
\ No newline at end of file
framework/yii/bootstrap/ButtonDropdown.php 0 → 100644
<?php
/**
* @link http://www.yiiframework.com/
* @copyright Copyright (c) 2008 Yii Software LLC
* @license http://www.yiiframework.com/license/
*/
namespace yii\bootstrap;
use yii\base\InvalidConfigException;
use yii\helpers\Html;
/**
* ButtonDropdown renders a group or split button dropdown bootstrap component.
*
* For example,
*
* ```php
* // a button group using Dropdown widget
* echo ButtonDropdown::widget(array(
* 'label' => 'Action',
* 'items' => Dropdown::widget(array(
* 'clientOptions' => false,
* 'items' => array(
* array(
* 'label' => 'DropdownA',
* 'url' => '/',
* ),
* array(
* 'label' => 'DropdownB',
* 'url' => '#',
* ),
* ),
* )),
* ));
*
* // split button dropdown using `items` configuration
* echo ButtonDropdown::widget(array(
* 'label' => 'Action',
* 'split' => true,
* 'items' => array(
* array(
* 'label' => 'DropdownA',
* 'url' => '/',
* ),
* array(
* 'label' => 'DropdownB',
* 'url' => '#',
* ),
* ),
* ));
* ```
* @see http://twitter.github.io/bootstrap/javascript.html#buttons
* @see http://twitter.github.io/bootstrap/components.html#buttonDropdowns
* @author Antonio Ramirez <amigo.cobos@gmail.com>
* @since 2.0
*/
class ButtonDropdown extends Widget
{
/**
* @var string the button label
*/
public $label;
/**
* @var array the HTML attributes of the button.
*/
public $buttonOptions = array();
/**
* @var array list of menu items in the dropdown. Each array element represents a single
* menu with the following structure:
*
* - label: string, required, the label of the item link
* - url: string, optional, the url of the item link. Defaults to "#".
* - linkOptions: array, optional, the HTML attributes of the item link.
* - options: array, optional, the HTML attributes of the item.
* - items: array, optional, the dropdown items configuration array.
*
* @see https://github.com/twitter/bootstrap/issues/5050#issuecomment-11741727
* @see [[Dropdown]]
*/
public $items = array();
/**
* @var boolean whether to display a group or split styled button group.
*/
public $split = false;
/**
* @var boolean whether the labels for dropdown items should be HTML-encoded.
*/
public $encodeLabels = true;
/**
* Initializes the widget.
* If you override this method, make sure you call the parent implementation first.
* @throws InvalidConfigException
*/
public function init()
{
if ($this->label === null) {
throw new InvalidConfigException("The 'label' option is required.");
}
parent::init();
$this->addCssClass($this->options, 'btn-group');
}
/**
* Renders the widget.
*/
public function run()
{
echo Html::beginTag('div', $this->options) . "\n";
echo $this->renderButton() . "\n";
echo $this->renderItems() . "\n";
echo Html::endTag('div') . "\n";
$this->registerPlugin('button');
}
/**
* Generates the button dropdown.
* @return string the rendering result.
*/
protected function renderButton()
{
$this->addCssClass($this->buttonOptions, 'btn');
$splitButton = '';
if ($this->split) {
$tag = 'button';
$options = $this->buttonOptions;
$this->buttonOptions['data-toggle'] = 'dropdown';
$this->addCssClass($this->buttonOptions, 'dropdown-toggle');
$splitButton = Button::widget(array(
'label' => '<span class="caret"></span>',
'encodeLabel' => false,
'options' => $this->buttonOptions,
)
);
} else {
$tag = 'a';
$this->label .= ' <span class="caret"></span>';
$options = $this->buttonOptions;
if (!isset($options['href'])) {
$options['href'] = '#';
}
$this->addCssClass($options, 'dropdown-toggle');
$options['data-toggle'] = 'dropdown';
}
return Button::widget(array(
'tagName' => $tag,
'label' => $this->label,
'options' => $options,
'encodeLabel' => false,
)) . "\n" . $splitButton;
}
/**
* Generates the dropdown menu as specified on [[items]].
* @return string the rendering result.
*/
protected function renderItems()
{
if (is_string($this->items)) {
return $this->items;
}
$config = array('items' => $this->items, 'clientOptions' => false);
return Dropdown::widget($config);
}
}
\ No newline at end of file
framework/yii/bootstrap/ButtonGroup.php 0 → 100644
<?php
/**
* @link http://www.yiiframework.com/
* @copyright Copyright (c) 2008 Yii Software LLC
* @license http://www.yiiframework.com/license/
*/
namespace yii\bootstrap;
use yii\helpers\base\ArrayHelper;
use yii\helpers\Html;
/**
* ButtonGroup renders a button group bootstrap component.
*
* For example,
*
* ```php
* // a button group with items configuration
* echo ButtonGroup::::widget(array(
* 'items' => array(
* array('label'=>'A'),
* array('label'=>'B'),
* )
* ));
*
* // button group with an item as a string
* echo ButtonGroup::::widget(array(
* 'items' => array(
* Button::widget(array('label'=>'A')),
* array('label'=>'B'),
* )
* ));
*
* // button group with body content as string
* ButtonGroup::beging();
* Button::widget(array('label'=>'A')), // you can also use plain string
* ButtonGroup::end();
* ```
* @see http://twitter.github.io/bootstrap/javascript.html#buttons
* @see http://twitter.github.io/bootstrap/components.html#buttonGroups
* @author Antonio Ramirez <amigo.cobos@gmail.com>
* @since 2.0
*/
class ButtonGroup extends Widget
{
/**
* @var array list of buttons. Each array element represents a single
* menu with the following structure:
*
* - label: string, required, the button label.
* - options: array, optional, the HTML attributes of the button.
*/
public $items = array();
/**
* @var boolean whether the labels for dropdown items should be HTML-encoded.
*/
public $encodeLabels = true;
/**
* Initializes the widget.
* If you override this method, make sure you call the parent implementation first.
*/
public function init()
{
parent::init();
$this->clientOptions = false;
$this->addCssClass($this->options, 'btn-group');
echo $this->renderGroupBegin() . "\n";
}
/**
* Renders the widget.
*/
public function run()
{
echo "\n" . $this->renderGroupEnd();
$this->registerPlugin('button');
}
/**
* Renders the opening tag of the button group.
* @return string the rendering result.
*/
protected function renderGroupBegin()
{
return Html::beginTag('div', $this->options);
}
/**
* Renders the items and closing tag of the button group.
* @return string the rendering result.
*/
protected function renderGroupEnd()
{
return $this->renderItems() . "\n" . Html::endTag('div');
}
/**
* Generates the buttons that compound the group as specified on [[items]].
* @return string the rendering result.
*/
protected function renderItems()
{
if (is_string($this->items)) {
return $this->items;
}
$buttons = array();
foreach ($this->items as $item) {
if (is_string($item)) {
$buttons[] = $item;
continue;
}
$label = ArrayHelper::getValue($item, 'label');
$options = ArrayHelper::getValue($item, 'options');
$buttons[] = Button::widget(array(
'label' => $label,
'options' => $options,
'encodeLabel' => $this->encodeLabels
)
);
}
return implode("\n", $buttons);
}
}
\ No newline at end of file
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