/usr/share/php/Icinga/Web/Widget/Tab.php is in php-icinga 2.1.0-1ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 | <?php
/* Icinga Web 2 | (c) 2013-2015 Icinga Development Team | GPLv2+ */
namespace Icinga\Web\Widget;
use Icinga\Web\Url;
/**
* A single tab, usually used through the tabs widget
*
* Will generate an <li> list item, with an optional link and icon
*
* @property string $name Tab identifier
* @property string $title Tab title
* @property string $icon Icon URL, preferrably relative to the Icinga
* base URL
* @property string $url Action URL, preferrably relative to the Icinga
* base URL
* @property string $urlParams Action URL Parameters
*
*/
class Tab extends AbstractWidget
{
/**
* Whether this tab is currently active
*
* @var bool
*/
private $active = false;
/**
* Default values for widget properties
*
* @var array
*/
private $name = null;
/**
* The title displayed for this tab
*
* @var string
*/
private $title = '';
/**
* The label displayed for this tab
*
* @var string
*/
private $label = '';
/**
* The Url this tab points to
*
* @var string|null
*/
private $url = null;
/**
* The parameters for this tab's Url
*
* @var array
*/
private $urlParams = array();
/**
* The icon image to use for this tab or null if none
*
* @var string|null
*/
private $icon = null;
/**
* The icon class to use if $icon is null
*
* @var string|null
*/
private $iconCls = null;
/**
* Additional a tag attributes
*
* @var array
*/
private $tagParams;
/**
* Whether to open the link target on a new page
*
* @var boolean
*/
private $targetBlank = false;
/**
* Data base target that determines if the link will be opened in a side-bar or in the main container
*
* @var null
*/
private $baseTarget = null;
/**
* Sets an icon image for this tab
*
* @param string $icon The url of the image to use
*/
public function setIcon($icon)
{
if (is_string($icon) && strpos($icon, '.') !== false) {
$icon = Url::fromPath($icon);
}
$this->icon = $icon;
}
/**
* Set's an icon class that will be used in an <i> tag if no icon image is set
*
* @param string $iconCls The CSS class of the icon to use
*/
public function setIconCls($iconCls)
{
$this->iconCls = $iconCls;
}
/**
* @param mixed $name
*/
public function setName($name)
{
$this->name = $name;
}
/**
* @return mixed
*/
public function getName()
{
return $this->name;
}
/**
* Set the tab label
*
* @param string $label
*/
public function setLabel($label)
{
$this->label = $label;
}
/**
* Get the tab label
*
* @return string
*/
public function getLabel()
{
if (! $this->label) {
return $this->title;
}
return $this->label;
}
/**
* @param mixed $title
*/
public function setTitle($title)
{
$this->title = $title;
}
/**
* Set the Url this tab points to
*
* @param string $url The Url to use for this tab
*/
public function setUrl($url)
{
if (is_string($url)) {
$url = Url::fromPath($url);
}
$this->url = $url;
}
/**
* Get the tab's target URL
*
* @return Url
*/
public function getUrl()
{
return $this->url;
}
/**
* Set the parameters to be set for this tabs Url
*
* @param array $url The Url parameters to set
*/
public function setUrlParams(array $urlParams)
{
$this->urlParams = $urlParams;
}
/**
* Set additional a tag attributes
*
* @param array $tagParams
*/
public function setTagParams(array $tagParams)
{
$this->tagParams = $tagParams;
}
public function setTargetBlank($value = true)
{
$this->targetBlank = $value;
}
public function setBaseTarget($value)
{
$this->baseTarget = $value;
}
/**
* Create a new Tab with the given properties
*
* Allowed properties are all properties for which a setter exists
*
* @param array $properties An array of properties
*/
public function __construct(array $properties = array())
{
foreach ($properties as $name => $value) {
$setter = 'set' . ucfirst($name);
if (method_exists($this, $setter)) {
$this->$setter($value);
}
}
}
/**
* Set this tab active (default) or inactive
*
* This is usually done through the tabs container widget, therefore it
* is not a good idea to directly call this function
*
* @param bool $active Whether the tab should be active
*
* @return $this
*/
public function setActive($active = true)
{
$this->active = (bool) $active;
return $this;
}
/**
* @see Widget::render()
*/
public function render()
{
$view = $this->view();
$classes = array();
if ($this->active) {
$classes[] = 'active';
}
$caption = $view->escape($this->getLabel());
$tagParams = $this->tagParams;
if ($this->targetBlank) {
// add warning to links that open in new tabs to improve accessibility, as recommended by WCAG20 G201
$caption .= '<span class="info-box display-on-hover"> opens in new window </span>';
$tagParams['target'] ='_blank';
}
if ($this->title) {
if ($tagParams !== null) {
$tagParams['title'] = $this->title;
$tagParams['aria-label'] = $this->title;
} else {
$tagParams = array(
'title' => $this->title,
'aria-label' => $this->title
);
}
}
if ($this->baseTarget !== null) {
$tagParams['data-base-target'] = $this->baseTarget;
}
if ($this->icon !== null) {
if (strpos($this->icon, '.') === false) {
$caption = $view->icon($this->icon) . $caption;
} else {
$caption = $view->img($this->icon, null, array('class' => 'icon')) . $caption;
}
}
if ($this->url !== null) {
$this->url->overwriteParams($this->urlParams);
if ($tagParams !== null) {
$params = $view->propertiesToString($tagParams);
} else {
$params = '';
}
$tab = sprintf(
'<a href="%s"%s>%s</a>',
$this->url,
$params,
$caption
);
} else {
$tab = $caption;
}
$class = empty($classes) ? '' : sprintf(' class="%s"', implode(' ', $classes));
return '<li ' . $class . '>' . $tab . "</li>\n";
}
}
|