Alpha\View\Widget\Button

Complexity

Total Complexity

12

Size/Duplication

Total Lines	143
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes

0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	12	2
D	render()	0	42	10

<?php

namespace Alpha\View\Widget;

use Alpha\Util\Config\ConfigProvider;
use Alpha\Util\Security\SecurityUtils;

/**
 * Button HTML custom widget.
 *
 * @since 1.0
 *
 * @author John Collins <dev@alphaframework.org>
 * @license http://www.opensource.org/licenses/bsd-license.php The BSD License
 * @copyright Copyright (c) 2017, John Collins (founder of Alpha Framework).
 * All rights reserved.
 *
 * <pre>
 * Redistribution and use in source and binary forms, with or
 * without modification, are permitted provided that the
 * following conditions are met:
 *
 * * Redistributions of source code must retain the above
 *   copyright notice, this list of conditions and the
 *   following disclaimer.
 * * Redistributions in binary form must reproduce the above
 *   copyright notice, this list of conditions and the
 *   following disclaimer in the documentation and/or other
 *   materials provided with the distribution.
 * * Neither the name of the Alpha Framework nor the names
 *   of its contributors may be used to endorse or promote
 *   products derived from this software without specific
 *   prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
 * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
 * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 * </pre>
 */
class Button
{
    /**
     * The Javascript action to carry out when the button is pressed.
     *
     * @var string
     *
     * @since 1.0
     */
    private $action;

    /**
     * The title to display on the button.
     *
     * @var string
     *
     * @since 1.0
     */
    private $title;

    /**
     * The HTML id attribute for the button.
     *
     * @var string
     *
     * @since 1.0
     */
    private $id;

    /**
     * If provided, the button will be a clickable image using this image.
     *
     * @var string
     *
     * @since 1.0
     */
    private $imgURL;
    
    /**
     * If provided, the Bootsrap glyphIcon to use for this button.
     *
     * @var string
     *
     * @since 3.0
     */
    private $glyphIcon;

    /**
     * If provided, the Bootsrap tooltip to use for this button.
     *
     * @var string
     *
     * @since 3.0
     */
    private $tooltip;

    /**
     * If provided, the Bootsrap tooltip position (left|right|top|bottom) to use for this button.
     *
     * @var string
     *
     * @since 3.0
     */
    private $tooltipPosition;

    /**
     * The constructor.
     *
     * @param string $action           The javascript action to be carried out (or set to "submit" to make a submit button, "file" for file uploads).
     * @param string $title            The title to appear on the button.
     * @param string $id               The HTML id attribute for the button.
     * @param string $imgURL           If provided, the button will be a clickable image using this image.
     * @param string $glyphIcon        If provided, the Bootsrap glyphIcon to use for this button.
     * @param string $tooltip          If provided, the Bootsrap tooltip to use for this button.
     * @param string $tooltipPosition  If provided, the Bootsrap tooltip position (left|right|top|bottom) to use for this button.
     *
     * @since 1.0
     */
    public function __construct($action, $title, $id, $imgURL = '', $glyphIcon = '', $tooltip = '', $tooltipPosition = '')
    {
        $config = ConfigProvider::getInstance();

        $this->action = $action;
        $this->title = $title;
        $this->id = ($config->get('security.encrypt.http.fieldnames') ? base64_encode(SecurityUtils::encrypt($id)) : $id);
        $this->imgURL = $imgURL;
        $this->glyphIcon = $glyphIcon;
        $this->tooltip = $tooltip;
        $this->tooltipPosition = $tooltipPosition;
    }

    /**
     * Renders the HTML and javascript for the button.
     *
     * @param int $width The width in pixels of the button (will also accept percentage values), defaults to 0 meaning auto-width to fit text.
     *
     * @since 1.0
     *
     * @return string
     */
    public function render($width = 0)
    {
        $html = '';
        $tooltip = '';

        if (!empty($this->tooltip)) {
            $position = 'bottom';
            if (!empty($this->tooltipPosition)) {
                $position = $this->tooltipPosition;
            }

            $tooltip = ' data-toggle="tooltip" data-placement="'.$position.'" title="'.$this->tooltip.'"';
        }

        if (!empty($this->glyphIcon)) {
            $html .= '<button type="button" id="'.$this->id.'" name="'.$this->id.'" class="btn btn-default btn-xs"'.$tooltip.'><span class="glyphicon '.$this->glyphIcon.'"></span> '.$this->title.'</button>';
            $html .= '<script>document.getElementById(\''.$this->id.'\').onclick = function() { '.$this->action.'; };</script>';

            return $html;
        }

        if (!empty($this->imgURL)) {
            $html .= '<img src="'.$this->imgURL.'" alt="'.$this->title.'" onClick="'.$this->action.'" style="cursor:pointer; vertical-align:bottom;" id="'.$this->id.'"'.$tooltip.'/>';

            return $html;
        }

        switch ($this->action) {
            case 'submit':
                $html .= '<input type="submit" id="'.$this->id.'" name="'.$this->id.'" value="'.$this->title.'" class="btn btn-primary"'.($width == 0 ? '' : ' style="width:'.$width.';"').$tooltip.'/>';
            break;
            case 'file':
                $html .= '<input type="file" id="'.$this->id.'" name="'.$this->id.'" value="'.$this->title.'" class="btn btn-primary"'.($width == 0 ? '' : ' style="width:'.$width.';"').$tooltip.'/>';
            break;
            default:
                $html .= '<input type="button" id="'.$this->id.'" name="'.$this->id.'" value="'.$this->title.'" class="btn btn-primary"'.($width == 0 ? '' : ' style="width:'.$width.';"').$tooltip.'/>';
                $html .= '<script>document.getElementById(\''.$this->id.'\').onclick = function() { '.$this->action.'; };</script>';
            break;
        }

        return $html;
    }
}