* @license http://www.gnu.org/licenses/gpl-2.0.txt GPL, version 2 * @author Icinga Development Team * */ // {{{ICINGA_LICENSE_HEADER}}} 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 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; /** * 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)) { $icon = Url::fromPath($icon); } $this->icon = $icon; } /** * Set's an icon class that will be used in an 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; } /** * @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; } /** * 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; } /** * 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 self */ public function setActive($active = true) { $this->active = (bool) $active; return $this; } /** * @see Widget::render() */ public function render() { $view = $this->view(); $class = $this->active ? ' class="active" ' : ''; $caption = $view->escape($this->title); if ($this->icon !== null) { $caption = $view->img($this->icon, array('class' => 'icon')) . ' ' . $caption; } if ($this->url !== null) { $this->url->overwriteParams($this->urlParams); $tagParams = ''; if ($this->tagParams !== null) { $tagParams = $view->propertiesToString($this->tagParams); } $tab = sprintf( '%s', $this->url, $tagParams, $caption ); } else { $tab = $caption; } return '

' . $tab . "

\n"; } }