-
-
Notifications
You must be signed in to change notification settings - Fork 3.6k
/
toolbar.php
521 lines (482 loc) · 15 KB
/
toolbar.php
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
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
<?php
/**
* @version $Id$
* @copyright Copyright (C) 2005 - 2010 Open Source Matters, Inc. All rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE.txt
*/
// No direct access
defined('_JEXEC') or die;
jimport('joomla.html.toolbar');
/**
* Utility class for the button bar.
*
* @package Joomla.Administrator
* @subpackage Application
*/
abstract class JToolBarHelper
{
/**
* Title cell.
* For the title and toolbar to be rendered correctly,
* this title fucntion must be called before the starttable function and the toolbars icons
* this is due to the nature of how the css has been used to postion the title in respect to the toolbar.
*
* @param string $title The title.
* @param string $icon The name of the image.
* @since 1.5
*/
public static function title($title, $icon = 'generic.png')
{
// Strip the extension.
$icon = preg_replace('#\.[^.]*$#', '', $icon);
$html = "<div class=\"pagetitle icon-48-$icon\"><h2>\n";
$html .= "$title\n";
$html .= "</h2></div>\n";
$app = JFactory::getApplication();
$app->set('JComponentTitle', $html);
}
/**
* Writes a spacer cell.
*
* @param string $width The width for the cell
* @since 1.0
*/
public static function spacer($width = '')
{
$bar = JToolBar::getInstance('toolbar');
// Add a spacer.
$bar->appendButton('Separator', 'spacer', $width);
}
/**
* Writes a divider between menu buttons
*
* @since 1.0
*/
public static function divider()
{
$bar = JToolBar::getInstance('toolbar');
// Add a divider.
$bar->appendButton('Separator', 'divider');
}
/**
* Writes a custom option and task button for the button bar.
*
* @param string $task The task to perform (picked up by the switch($task) blocks.
* @param string $icon The image to display.
* @param string $iconOver The image to display when moused over.
* @param string $alt The alt text for the icon image.
* @param bool $listSelect True if required to check that a standard list item is checked.
* @since 1.0
*/
public static function custom($task = '', $icon = '', $iconOver = '', $alt = '', $listSelect = true)
{
$bar = JToolBar::getInstance('toolbar');
// Strip extension.
$icon = preg_replace('#\.[^.]*$#', '', $icon);
// Add a standard button.
$bar->appendButton('Standard', $icon, $alt, $task, $listSelect);
}
/**
* Writes a custom option and task button for the button bar.
*
* @param string $task The task to perform (picked up by the switch($task) blocks.
* @param string $icon The image to display.
* @param string $iconOver The image to display when moused over.
* @param string $alt The alt text for the icon image.
* @param bool $listSelect True if required to check that a standard list item is checked.
* @since 1.0
* @deprecated
*/
public static function customX($task = '', $icon = '', $iconOver = '', $alt = '', $listSelect = true)
{
self::custom($task, $icon, $iconOver, $alt, $listSelect);
}
/**
* Writes a preview button for a given option (opens a popup window).
*
* @param string $url The name of the popup file (excluding the file extension)
* @param bool $updateEditors
* @since 1.0
*/
public static function preview($url = '', $updateEditors = false)
{
$bar = JToolBar::getInstance('toolbar');
// Add a preview button.
$bar->appendButton('Popup', 'preview', 'Preview', $url.'&task=preview');
}
/**
* Writes a preview button for a given option (opens a popup window).
*
* @param string $ref The name of the popup file (excluding the file extension for an xml file).
* @param bool $com Use the help file in the component directory.
* @since 1.0
*/
public static function help($ref, $com = false)
{
$bar = JToolBar::getInstance('toolbar');
// Add a help button.
$bar->appendButton('Help', $ref, $com);
}
/**
* Writes a cancel button that will go back to the previous page without doing
* any other operation.
*
* @param string $alt Alternative text.
* @param string $href URL of the href attribute.
* @since 1.0
*/
public static function back($alt = 'Back', $href = 'javascript:history.back();')
{
$bar = JToolBar::getInstance('toolbar');
// Add a back button.
$bar->appendButton('Link', 'back', $alt, $href);
}
/**
* Writes a media_manager button.
*
* @param string $directory The sub-drectory to upload the media to.
* @param string $alt An override for the alt text.
* @since 1.0
*/
public static function media_manager($directory = '', $alt = 'Upload')
{
$bar = JToolBar::getInstance('toolbar');
// Add an upload button.
$bar->appendButton('Popup', 'upload', $alt, 'index.php?option=com_media&tmpl=component&task=popupUpload&directory='.$directory, 640, 520);
}
/**
* Writes a common 'default' button for a record.
*
* @param string $task An override for the task.
* @param string $alt An override for the alt text.
* @since 1.0
*/
public static function makeDefault($task = 'default', $alt = 'Default')
{
$bar = JToolBar::getInstance('toolbar');
// Add a default button.
$bar->appendButton('Standard', 'default', $alt, $task, true);
}
/**
* Writes a common 'assign' button for a record.
*
* @param string $task An override for the task.
* @param string $alt An override for the alt text.
* @since 1.0
*/
public static function assign($task = 'assign', $alt = 'Assign')
{
$bar = JToolBar::getInstance('toolbar');
// Add an assign button.
$bar->appendButton('Standard', 'assign', $alt, $task, true);
}
/**
* Writes the common 'new' icon for the button bar.
*
* @param string $task An override for the task.
* @param string $alt An override for the alt text.
* @since 1.0
*/
public static function addNew($task = 'add', $alt = 'New')
{
$bar = JToolBar::getInstance('toolbar');
// Add a new button.
$bar->appendButton('Standard', 'new', $alt, $task, false);
}
/**
* Writes the common 'new' icon for the button bar.
* Extended version of addNew() calling hideMainMenu() before submitbutton().
*
* @param string $task An override for the task.
* @param string $alt An override for the alt text.
* @since 1.0
* @deprecated
*/
public static function addNewX($task = 'add', $alt = 'New')
{
self::addNew($task, $alt);
}
/**
* Writes a common 'publish' button.
*
* @param string $task An override for the task.
* @param string $alt An override for the alt text.
* @since 1.0
*/
public static function publish($task = 'publish', $alt = 'Publish')
{
$bar = JToolBar::getInstance('toolbar');
// Add a publish button.
$bar->appendButton('Standard', 'publish', $alt, $task, false);
}
/**
* Writes a common 'publish' button for a list of records.
*
* @param string $task An override for the task.
* @param string $alt An override for the alt text.
* @since 1.0
*/
public static function publishList($task = 'publish', $alt = 'Publish')
{
$bar = JToolBar::getInstance('toolbar');
// Add a publish button (list).
$bar->appendButton('Standard', 'publish', $alt, $task, true);
}
/**
* Writes a common 'unpublish' button.
*
* @param string $task An override for the task.
* @param string $alt An override for the alt text.
* @since 1.0
*/
public static function unpublish($task = 'unpublish', $alt = 'Unpublish')
{
$bar = JToolBar::getInstance('toolbar');
// Add an unpublish button
$bar->appendButton('Standard', 'unpublish', $alt, $task, false);
}
/**
* Writes a common 'unpublish' button for a list of records.
*
* @param string $task An override for the task.
* @param string $alt An override for the alt text.
* @since 1.0
*/
public static function unpublishList($task = 'unpublish', $alt = 'Unpublish')
{
$bar = JToolBar::getInstance('toolbar');
// Add an unpublish button (list).
$bar->appendButton('Standard', 'unpublish', $alt, $task, true);
}
/**
* Writes a common 'archive' button for a list of records.
*
* @param string $task An override for the task.
* @param string $alt An override for the alt text.
* @since 1.0
*/
public static function archiveList($task = 'archive', $alt = 'Archive')
{
$bar = JToolBar::getInstance('toolbar');
// Add an archive button.
$bar->appendButton('Standard', 'archive', $alt, $task, true);
}
/**
* Writes an unarchive button for a list of records.
*
* @param string $task An override for the task.
* @param string $alt An override for the alt text.
* @since 1.0
*/
public static function unarchiveList($task = 'unarchive', $alt = 'Unarchive')
{
$bar = JToolBar::getInstance('toolbar');
// Add an unarchive button (list).
$bar->appendButton('Standard', 'unarchive', $alt, $task, true);
}
/**
* Writes a common 'edit' button for a list of records.
*
* @param string $task An override for the task.
* @param string $alt An override for the alt text.
* @since 1.0
*/
public static function editList($task = 'edit', $alt = 'Edit')
{
$bar = JToolBar::getInstance('toolbar');
// Add an edit button.
$bar->appendButton('Standard', 'edit', $alt, $task, true);
}
/**
* Writes a common 'edit' button for a list of records.
* Extended version of editList() calling hideMainMenu() before submitbutton().
*
* @param string $task An override for the task.
* @param string $alt An override for the alt text.
* @since 1.0
* @deprecated
*/
public static function editListX($task = 'edit', $alt = 'Edit')
{
self::editList($task, $alt);
}
/**
* Writes a common 'edit' button for a template html.
*
* @param string $task An override for the task.
* @param string $alt An override for the alt text.
* @since 1.0
*/
public static function editHtml($task = 'edit_source', $alt = 'EDIT_HTML')
{
$bar = JToolBar::getInstance('toolbar');
// Add an edit html button.
$bar->appendButton('Standard', 'edithtml', $alt, $task, true);
}
/**
* Writes a common 'edit' button for a template html.
* Extended version of editHtml() calling hideMainMenu() before submitbutton().
*
* @param string $task An override for the task.
* @param string $alt An override for the alt text.
* @since 1.0
* @deprecated
*/
public static function editHtmlX($task = 'edit_source', $alt = 'EDIT_HTML')
{
self::editHtml($task, $alt);
}
/**
* Writes a common 'edit' button for a template css.
*
* @param string $task An override for the task.
* @param string $alt An override for the alt text.
* @since 1.0
*/
public static function editCss($task = 'edit_css', $alt = 'EDIT_CSS')
{
$bar = JToolBar::getInstance('toolbar');
// Add an edit css button (hide).
$bar->appendButton('Standard', 'editcss', $alt, $task, true);
}
/**
* Writes a common 'edit' button for a template css.
* Extended version of editCss() calling hideMainMenu() before submitbutton().
*
* @param string $task An override for the task.
* @param string $alt An override for the alt text.
* @since 1.0
* @deprecated
*/
public static function editCssX($task = 'edit_css', $alt = 'EDIT_CSS')
{
self::editCss($task, $alt);
}
/**
* Writes a common 'delete' button for a list of records.
*
* @param string $msg Postscript for the 'are you sure' message.
* @param string $task An override for the task.
* @param string $alt An override for the alt text.
* @since 1.0
*/
public static function deleteList($msg = '', $task = 'remove', $alt = 'Delete')
{
$bar = JToolBar::getInstance('toolbar');
// Add a delete button.
if ($msg) {
$bar->appendButton('Confirm', $msg, 'delete', $alt, $task, true);
} else {
$bar->appendButton('Standard', 'delete', $alt, $task, true);
}
}
/**
* Writes a common 'delete' button for a list of records.
* Extended version of deleteList() calling hideMainMenu() before submitbutton().
*
* @param string $msg Postscript for the 'are you sure' message.
* @param string $task An override for the task.
* @param string $alt An override for the alt text.
* @since 1.0
* @deprecated
*/
public static function deleteListX($msg = '', $task = 'remove', $alt = 'Delete')
{
self::deleteList($msg, $task, $alt);
}
/**
* Write a trash button that will move items to Trash Manager.
*
* @param string $task An override for the task.
* @param string $alt An override for the alt text.
* @param bool $check
* @since 1.0
*/
public static function trash($task = 'remove', $alt = 'Trash', $check = true)
{
$bar = JToolBar::getInstance('toolbar');
// Add a trash button.
$bar->appendButton('Standard', 'trash', $alt, $task, $check, false);
}
/**
* Writes a save button for a given option.
* Apply operation leads to a save action only (does not leave edit mode).
*
* @param string $task An override for the task.
* @param string $alt An override for the alt text.
* @since 1.0
*/
public static function apply($task = 'apply', $alt = 'Apply')
{
$bar = JToolBar::getInstance('toolbar');
// Add an apply button
$bar->appendButton('Standard', 'apply', $alt, $task, false);
}
/**
* Writes a save button for a given option.
* Save operation leads to a save and then close action.
*
* @param string $task An override for the task.
* @param string $alt An override for the alt text.
* @since 1.0
*/
public static function save($task = 'save', $alt = 'Save')
{
$bar = JToolBar::getInstance('toolbar');
// Add a save button.
$bar->appendButton('Standard', 'save', $alt, $task, false);
}
/**
* Writes a cancel button and invokes a cancel operation (eg a checkin).
*
* @param string $task An override for the task.
* @param string $alt An override for the alt text.
* @since 1.0
*/
public static function cancel($task = 'cancel', $alt = 'Cancel')
{
$bar = JToolBar::getInstance('toolbar');
// Add a cancel button.
$bar->appendButton('Standard', 'cancel', $alt, $task, false);
}
/**
* Writes a configuration button and invokes a cancel operation (eg a checkin).
*
* @param string $component The name of the component, eg, com_content.
* @param int $height The height of the popup.
* @param int $width The width of the popup.
* @param string $alt The name of the button.
* @param string $path An alternative path for the configuation xml relative to JPATH_SITE.
* @since 1.0
*/
public static function preferences($component, $height = '450', $width = '800', $alt = 'JToolbar_Options', $path = '', $onClose = '')
{
$component = urlencode($component);
$path = urlencode($path);
$top = 0;
$left = 0;
$bar = JToolBar::getInstance('toolbar');
// Add a configuration button.
$bar->appendButton('Popup', 'config', $alt, 'index.php?option=com_config&view=component&component='.$component.'&path='.$path.'&tmpl=component', $width, $height, $top, $left, $onClose);
}
}
/**
* Utility class for the submenu.
*
* @package Joomla.Administrator
*/
abstract class JSubMenuHelper
{
/**
* Method to add a menu item to submenu.
*
* @param string $name Name of the menu item.
* @param string $link URL of the menu item.
* @param bool True if the item is active, false otherwise.
*/
public static function addEntry($name, $link = '', $active = false)
{
$menu = JToolBar::getInstance('submenu');
$menu->appendButton($name, $link, $active);
}
}