summaryrefslogtreecommitdiffstats
path: root/vendor/ipl/web/src/Widget/Tabs.php
blob: 32ba8e99f4900ff38b1514cee860b23e7dedd2fb (plain)
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
<?php

namespace ipl\Web\Widget;

use Exception;
use Icinga\Web\Widget\Tabextension\DashboardAction;
use Icinga\Web\Widget\Tabextension\MenuAction;
use Icinga\Web\Widget\Tabextension\OutputFormat;
use Icinga\Web\Widget\Tabextension\Tabextension;
use InvalidArgumentException;
use ipl\Html\BaseHtmlElement;
use ipl\Html\HtmlString;
use ipl\Web\Url;

/**
 * @TODO(el): Don't depend on Icinga Web's Tabs
 */
class Tabs extends BaseHtmlElement
{
    protected $tag = 'ul';

    protected $defaultAttributes = ['class' => 'tabs primary-nav nav'];

    /** @var \Icinga\Web\Widget\Tabs */
    protected $tabs;

    /** @var bool Whether data exports are enabled */
    protected $dataExportsEnabled = false;

    /** @var bool Whether the legacy extensions should be shown by default */
    protected $legacyExtensionsEnabled = true;

    /** @var Url */
    protected $refreshUrl;

    public function __construct()
    {
        $this->tabs = new \Icinga\Web\Widget\Tabs();
    }

    /**
     * Don't show legacy extensions by default
     */
    public function disableLegacyExtensions()
    {
        $this->legacyExtensionsEnabled = false;
    }

    /**
     * Show export actions for JSON and CSV
     */
    public function enableDataExports()
    {
        $this->dataExportsEnabled = true;
    }

    /**
     * Set the url for the refresh button
     *
     * @param Url $url
     *
     * @return $this
     */
    public function setRefreshUrl(Url $url)
    {
        $this->refreshUrl = $url;

        return $this;
    }

    protected function assemble()
    {
        if ($this->legacyExtensionsEnabled) {
            $this->tabs->extend(new OutputFormat(
                $this->dataExportsEnabled
                    ? []
                    : [OutputFormat::TYPE_CSV, OutputFormat::TYPE_JSON]
            ))
                ->extend(new DashboardAction())
                ->extend(new MenuAction());
        }

        $tabHtml = substr($this->tabs->render(), 34, -5);
        if ($this->refreshUrl !== null) {
            $tabHtml = preg_replace(
                '/(?<=class="refresh-container-control spinner" href=")([^"]*)/',
                $this->refreshUrl->getAbsoluteUrl(),
                $tabHtml
            );
        }

        parent::add(HtmlString::create($tabHtml));
    }

    /**
     * Activate the tab with the given name
     *
     * @param string $name
     *
     * @return $this
     *
     * @throws InvalidArgumentException
     */
    public function activate($name)
    {
        try {
            $this->tabs->activate($name);
        } catch (Exception $e) {
            throw new InvalidArgumentException($e->getMessage());
        }

        return $this;
    }

    /**
     * Get active tab
     *
     * @return \Icinga\Web\Widget\Tab
     */
    public function getActiveTab()
    {
        return $this->tabs->get($this->tabs->getActiveName());
    }

    /**
     * Add the given tab
     *
     * @param string $name
     * @param mixed  $tab
     *
     * @return $this
     *
     * @throws InvalidArgumentException
     */
    public function add($name, $tab = null)
    {
        if ($tab === null) {
            throw new InvalidArgumentException('Argument $tab is required');
        }

        try {
            $this->tabs->add($name, $tab);
        } catch (Exception $e) {
            throw new InvalidArgumentException($e->getMessage());
        }

        if (is_array($tab) && isset($tab['active']) && $tab['active']) {
            // Otherwise Tabs::getActiveName() returns null
            $this->tabs->activate($name);
        }

        return $this;
    }

    /**
     * Get a tab
     *
     * @param string $name
     *
     * @return \Icinga\Web\Widget\Tab|null
     */
    public function get($name)
    {
        return $this->tabs->get($name);
    }

    /**
     * Count tabs
     *
     * @return int
     */
    public function count(): int
    {
        return $this->tabs->count();
    }

    /**
     * Apply a Tabextension on $this->tabs object not on this class
     *
     * @param   Tabextension $extension
     *
     * @return  $this
     */
    public function extend(Tabextension $extension)
    {
        $this->tabs->extend($extension);

        return $this;
    }
}