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
|
<?php
/**
* This is a view of the application-specific sidebar.
*
* Useful properties:
* - newLink: (string, optional) Link of the "New" button
* - newText: (string) Text of the "New" button
* - newExtra: (string, optional) HTML content of the extra link
* - containers: (array, optional) HTML content of any sidebar sections. A list
* of hashes with the following properties:
* - id: (string, optional) The container's DOM ID.
* - header: (array, optional) Container header, also used to
* toggle the section:
* - id: (string) The header's DOM ID.
* - label: (string) Header label.
* - collapsed: (boolean, optional) Start section collapsed?
* Overriden by cookies.
* - add: (string|array, optional) Link to add something:
* - url: (string) Link URL.
* - label: (string) Link text.
* - content: (string, optional) The container's HTML content.
* - rows: (array, optional) A list of row hashes, if 'content'
* is not specified. @see addRow().
* - resources: (boolean, optional) Does the container contain
* switchable resource lists? Automatically set
* through addRow().
* - type: (string, optional) @see addRow().
* - content: (string, optional) HTML content of the sidebar, if 'containers'
* is not specified.
*
* Copyright 2012-2014 Horde LLC (http://www.horde.org/)
*
* See the enclosed file COPYING for license information (LGPL-2). If you
* did not receive this file, see http://www.horde.org/licenses/lgpl.
*
* @author Jan Schneider <jan@horde.org>
* @category Horde
* @license http://www.horde.org/licenses/lgpl LGPL-2
* @package Horde
*/
class Horde_View_Sidebar extends Horde_View
{
/**
* Constructor.
*
* @param array $config Configuration key-value pairs.
*/
public function __construct($config = array())
{
if (empty($config['templatePath'])) {
$config['templatePath'] = $GLOBALS['registry']->get('templates', 'horde') . '/sidebar';
}
parent::__construct($config);
$this->addHelper('Text');
$this->containers = array();
$this->width = $GLOBALS['prefs']->getValue('sidebar_width');
$this->left = ($GLOBALS['registry']->nlsconfig->curr_rtl ? 'right:' : 'left:')
. $this->width;
$pageOutput = $GLOBALS['injector']->getInstance('Horde_PageOutput');
$pageOutput->addScriptFile('sidebar.js', 'horde');
$pageOutput->addInlineJsVars(array(
'HordeSidebar.text' => array(
'collapse' => _("Collapse"),
'expand' => _("Expand"),
),
'HordeSidebar.opts' => array(
'cookieDomain' => $GLOBALS['conf']['cookie']['domain'],
'cookiePath' => $GLOBALS['conf']['cookie']['path'],
),
));
}
/**
* Returns the HTML code for the sidebar.
*
* @param string $name The template to process.
*
* @return string The sidebar's HTML code.
*/
public function render($name = 'sidebar', $locals = array())
{
$effects = false;
foreach ($this->containers as $id => &$container) {
if (!isset($container['header'])) {
continue;
}
if (isset($container['header']['id'])) {
$id = $container['header']['id'];
}
if (isset($_COOKIE['horde_sidebar_c_' . $id])) {
$container['header']['collapsed'] = !empty($_COOKIE['horde_sidebar_c_' . $id]);
}
$effects = true;
}
if ($effects) {
$GLOBALS['injector']
->getInstance('Horde_PageOutput')
->addScriptFile('scriptaculous/effects.js', 'horde');
}
$this->containers = array_values($this->containers);
return parent::render($name, $locals);
}
/**
* Handler for string casting.
*
* @return string The sidebar's HTML code.
*/
public function __toString()
{
return $this->render();
}
/**
* Adds a "New ..." button to the sidebar.
*
* @param string $label The button text, including access key.
* @param string $url The button URL.
* @param array $extra Extra attributes for the link tag.
*/
public function addNewButton($label, $url, $extra = array())
{
$ak = Horde::getAccessKey($label);
$attributes = $ak
? Horde::getAccessKeyAndTitle($label, true, true)
: array();
$this->newLink = $url->link($attributes + $extra);
$this->newText = Horde::highlightAccessKey($label, $ak);
}
/**
* Adds a row to the sidebar.
*
* If containers/sections are not added explicitly to the view
* through the "containers" property, these rows will be used
* instead.
*
* @param array $row A hash with the row information. Possible
* values:
* - label: (string) The row text.
* - selected: (boolean) Whether to mark the row as active.
* - style: (string) Additional CSS styles to apply to the row.
* - url (string) URL to link the row to.
* - type (string, optional) The row type, defaults to "tree". Further
* $row properties depending on the type:
* - tree:
* - cssClass: (string) CSS class for the icon.
* - id: (string) DOM ID for the row link.
* - checkbox:
* - radiobox:
* - color: (string, optional) Background color.
* - edit: (string, optional) URL for extra edit icon.
* @param string $container If using multiple sidebar sections, the ID of
* the section to add the row to. Sections will
* be rendered in the order of their first usage.
*/
public function addRow(array $row, $container = '')
{
if (!isset($this->containers[$container])) {
$this->containers[$container] = array('rows' => array());
if ($container) {
$this->containers[$container]['id'] = $container;
}
}
$boxrow = isset($row['type']) &&
($row['type'] == 'checkbox' || $row['type'] == 'radiobox');
$label = htmlspecialchars($row['label']);
if (isset($row['url'])) {
$ak = Horde::getAccessKey($label);
$url = empty($row['url']) ? new Horde_Url() : $row['url'];
$attributes = $ak
? array('accesskey' => $ak)
: array();
foreach (array('onclick', 'target', 'class') as $attribute) {
if (!empty($row[$attribute])) {
$attributes[$attribute] = $row[$attribute];
}
}
if ($boxrow) {
$class = 'horde-resource-'
. (empty($row['selected']) ? 'off' : 'on');
if ($row['type'] == 'radiobox') {
$class .= ' horde-radiobox';
}
if (empty($attributes['class'])) {
$attributes['class'] = $class;
} else {
$attributes['class'] .= ' ' . $class;
}
}
$row['link'] = $url->link($attributes)
. Horde::highlightAccessKey($label, $ak)
. '</a>';
} else {
$row['link'] = '<span class="horde-resource-none">'
. $label . '</span>';
}
if ($boxrow) {
$this->containers[$container]['type'] = $row['type'];
if (!isset($row['style'])) {
$row['style'] = '';
}
if (!isset($row['color'])) {
$row['color'] = '#dddddd';
}
$foreground = '000';
if (Horde_Image::brightness($row['color']) < 128) {
$foreground = 'fff';
}
if (strlen($row['style'])) {
$row['style'] .= ';';
}
$row['style'] .= 'background-color:' . $row['color']
. ';color:#' . $foreground;
if (isset($row['edit'])) {
$row['editLink'] = $row['edit']
->link(array(
'title' => _("Edit"),
'class' => 'horde-resource-edit-' . $foreground))
. '►' . '</a>';
}
}
$this->containers[$container]['rows'][] = $row;
}
}
|
