dmgpage\yii2materialize\widgets\Button

Complexity

Total Complexity

8

Size/Duplication

Total Lines	100
Duplicated Lines	0 %

Importance

Changes	2
Bugs	0	Features	0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	init()	0	4	1
B	run()	0	28	7

<?php
/**
 * @link https://github.com/DMGPage/yii2-materialize
 * @copyright Copyright (c) 2018 Dmitrijs Reinmanis
 * @license https://github.com/DMGPage/yii2-materialize/blob/master/LICENSE
 */

namespace dmgpage\yii2materialize\widgets;

use dmgpage\yii2materialize\helpers\Html;
use yii\helpers\ArrayHelper;

/**
 * Button renders a Materialize button.
 *
 * For example,
 *
 * ```php
 * echo Button::widget([
 *     'waves' => Waves::LIGHT,
 *     'icon' => [
 *         'name' => 'alarm',
 *         'position' => Position::LEFT,
 *         'options' =>  ['class' => 'red'],
 *     ]
 * ]);
 * ```
 * @see https://materializecss.com/buttons.html
 * @package widgets
 */
class Button extends Widget
{
    /**
     * @var string the tag to use to render the button
     */
    public $tagName = 'button';

    /**
     * @var string the button label. Set to "false", if you do not want a label text to be rendered
     */
    public $label = 'Button';

    /**
     * @var bool whether the label should be HTML-encoded.
     */
    public $encodeLabel = true;

    /**
     * @var array the options for the optional icon.
     *
     * An example of how to specify an icon:
     *
     * ```php
     * [
     *     'name' => 'alarm',
     *     'position' => Position::LEFT,
     *     'options' =>  ['class' => 'red'],
     * ]
     * ```
     *
     * @see \dmgpage\yii2materialize\helpers\Html::icon()
     */
    public $icon = [];

    /**
     * @var string|array one or several wave effects
     */
    public $waves;

    /**
     * @var string the type of button to be rendered. Default is 'btn'
     * @see \dmgpage\yii2materialize\helpers\Type
     */
    public $type;

    /**
     * @var string the size (large or small) of button to be rendered
     * @see \dmgpage\yii2materialize\helpers\Size
     */
    public $size;

    /**
     * @var boolean whether the button shall be disabled.
     */
    public $disabled = false;

    /**
     * Initializes the widget.
     * If you override this method, make sure you call the parent implementation first.
     */
    public function init()
    {
        parent::init();
        $this->clientOptions = [];
    }

    /**
     * Renders the widget.
     *
     * @return string the result of widget execution to be outputted.
     * @uses [[renderIcon]]
     */
    public function run()
    {
        if ($this->label !== false) {
            $label = $this->encodeLabel ? Html::encode($this->label) : $this->label;
        } else {
            $label = '';
        }

        if (!empty($this->type)) {
            Html::addCssClass($this->options, "btn-$this->type");
        } else {
            Html::addCssClass($this->options, 'btn');
        }

        if (!empty($this->size)) {
            Html::addCssClass($this->options, "btn-$this->size");
        }

        if ($this->disabled) {
            Html::addCssClass($this->options, 'disabled');
        }

        if (!empty($this->waves)) {
            $this->options = Html::addWaves($this->waves, $this->options);
        }

        $this->registerPlugin('button');
        return Html::tag($this->tagName, $this->renderIcon($this->icon) . $label, $this->options);
    }
}