1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 <?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) 2018, 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;
}
}