1 <?php
  2 /**
  3  * @package     Joomla.Libraries
  4  * @subpackage  HTML
  5  *
  6  * @copyright   Copyright (C) 2005 - 2017 Open Source Matters, Inc. All rights reserved.
  7  * @license     GNU General Public License version 2 or later; see LICENSE.txt
  8  */
  9 
 10 defined('JPATH_PLATFORM') or die;
 11 
 12 /**
 13  * Utility class for creating HTML Grids
 14  *
 15  * @since  1.5
 16  */
 17 abstract class JHtmlGrid
 18 {
 19     /**
 20      * Display a boolean setting widget.
 21      *
 22      * @param   integer  $i        The row index.
 23      * @param   integer  $value    The value of the boolean field.
 24      * @param   string   $taskOn   Task to turn the boolean setting on.
 25      * @param   string   $taskOff  Task to turn the boolean setting off.
 26      *
 27      * @return  string   The boolean setting widget.
 28      *
 29      * @since   1.6
 30      */
 31     public static function boolean($i, $value, $taskOn = null, $taskOff = null)
 32     {
 33         // Load the behavior.
 34         static::behavior();
 35         JHtml::_('bootstrap.tooltip');
 36 
 37         // Build the title.
 38         $title = $value ? JText::_('JYES') : JText::_('JNO');
 39         $title = JHtml::_('tooltipText', $title, JText::_('JGLOBAL_CLICK_TO_TOGGLE_STATE'), 0);
 40 
 41         // Build the <a> tag.
 42         $bool = $value ? 'true' : 'false';
 43         $task = $value ? $taskOff : $taskOn;
 44         $toggle = (!$task) ? false : true;
 45 
 46         if ($toggle)
 47         {
 48             return '<a class="grid_' . $bool . ' hasTooltip" title="' . $title . '" rel="{id:\'cb' . $i . '\', task:\'' . $task
 49                 . '\'}" href="#toggle"></a>';
 50         }
 51         else
 52         {
 53             return '<a class="grid_' . $bool . '"></a>';
 54         }
 55     }
 56 
 57     /**
 58      * Method to sort a column in a grid
 59      *
 60      * @param   string  $title          The link title
 61      * @param   string  $order          The order field for the column
 62      * @param   string  $direction      The current direction
 63      * @param   string  $selected       The selected ordering
 64      * @param   string  $task           An optional task override
 65      * @param   string  $new_direction  An optional direction for the new column
 66      * @param   string  $tip            An optional text shown as tooltip title instead of $title
 67      * @param   string  $form           An optional form selector
 68      *
 69      * @return  string
 70      *
 71      * @since   1.5
 72      */
 73     public static function sort($title, $order, $direction = 'asc', $selected = '', $task = null, $new_direction = 'asc', $tip = '', $form = null)
 74     {
 75         JHtml::_('behavior.core');
 76         JHtml::_('bootstrap.popover');
 77 
 78         $direction = strtolower($direction);
 79         $icon = array('arrow-up-3', 'arrow-down-3');
 80         $index = (int) ($direction === 'desc');
 81 
 82         if ($order != $selected)
 83         {
 84             $direction = $new_direction;
 85         }
 86         else
 87         {
 88             $direction = $direction === 'desc' ? 'asc' : 'desc';
 89         }
 90 
 91         if ($form)
 92         {
 93             $form = ', document.getElementById(\'' . $form . '\')';
 94         }
 95 
 96         $html = '<a href="#" onclick="Joomla.tableOrdering(\'' . $order . '\',\'' . $direction . '\',\'' . $task . '\'' . $form . ');return false;"'
 97             . ' class="hasPopover" title="' . htmlspecialchars(JText::_($tip ?: $title)) . '"'
 98             . ' data-content="' . htmlspecialchars(JText::_('JGLOBAL_CLICK_TO_SORT_THIS_COLUMN')) . '" data-placement="top">';
 99 
100         if (isset($title['0']) && $title['0'] === '<')
101         {
102             $html .= $title;
103         }
104         else
105         {
106             $html .= JText::_($title);
107         }
108 
109         if ($order == $selected)
110         {
111             $html .= '<span class="icon-' . $icon[$index] . '"></span>';
112         }
113 
114         $html .= '</a>';
115 
116         return $html;
117     }
118 
119     /**
120      * Method to check all checkboxes in a grid
121      *
122      * @param   string  $name    The name of the form element
123      * @param   string  $tip     The text shown as tooltip title instead of $tip
124      * @param   string  $action  The action to perform on clicking the checkbox
125      *
126      * @return  string
127      *
128      * @since   3.1.2
129      */
130     public static function checkall($name = 'checkall-toggle', $tip = 'JGLOBAL_CHECK_ALL', $action = 'Joomla.checkAll(this)')
131     {
132         JHtml::_('behavior.core');
133         JHtml::_('bootstrap.tooltip');
134 
135         return '<input type="checkbox" name="' . $name . '" value="" class="hasTooltip" title="' . JHtml::_('tooltipText', $tip)
136             . '" onclick="' . $action . '" />';
137     }
138 
139     /**
140      * Method to create a checkbox for a grid row.
141      *
142      * @param   integer  $rowNum      The row index
143      * @param   integer  $recId       The record id
144      * @param   boolean  $checkedOut  True if item is checked out
145      * @param   string   $name        The name of the form element
146      * @param   string   $stub        The name of stub identifier
147      *
148      * @return  mixed    String of html with a checkbox if item is not checked out, null if checked out.
149      *
150      * @since   1.5
151      */
152     public static function id($rowNum, $recId, $checkedOut = false, $name = 'cid', $stub = 'cb')
153     {
154         return $checkedOut ? '' : '<input type="checkbox" id="' . $stub . $rowNum . '" name="' . $name . '[]" value="' . $recId
155             . '" onclick="Joomla.isChecked(this.checked);" />';
156     }
157 
158     /**
159      * Displays a checked out icon.
160      *
161      * @param   object   &$row        A data object (must contain checkedout as a property).
162      * @param   integer  $i           The index of the row.
163      * @param   string   $identifier  The property name of the primary key or index of the row.
164      *
165      * @return  string
166      *
167      * @since   1.5
168      */
169     public static function checkedOut(&$row, $i, $identifier = 'id')
170     {
171         $user = JFactory::getUser();
172         $userid = $user->get('id');
173 
174         if ($row instanceof JTable)
175         {
176             $result = $row->isCheckedOut($userid);
177         }
178         else
179         {
180             $result = false;
181         }
182 
183         if ($result)
184         {
185             return static::_checkedOut($row);
186         }
187         else
188         {
189             if ($identifier === 'id')
190             {
191                 return JHtml::_('grid.id', $i, $row->$identifier);
192             }
193             else
194             {
195                 return JHtml::_('grid.id', $i, $row->$identifier, $result, $identifier);
196             }
197         }
198     }
199 
200     /**
201      * Method to create a clickable icon to change the state of an item
202      *
203      * @param   mixed    $value   Either the scalar value or an object (for backward compatibility, deprecated)
204      * @param   integer  $i       The index
205      * @param   string   $img1    Image for a positive or on value
206      * @param   string   $img0    Image for the empty or off value
207      * @param   string   $prefix  An optional prefix for the task
208      *
209      * @return  string
210      *
211      * @since   1.5
212      */
213     public static function published($value, $i, $img1 = 'tick.png', $img0 = 'publish_x.png', $prefix = '')
214     {
215         if (is_object($value))
216         {
217             $value = $value->published;
218         }
219 
220         $img = $value ? $img1 : $img0;
221         $task = $value ? 'unpublish' : 'publish';
222         $alt = $value ? JText::_('JPUBLISHED') : JText::_('JUNPUBLISHED');
223         $action = $value ? JText::_('JLIB_HTML_UNPUBLISH_ITEM') : JText::_('JLIB_HTML_PUBLISH_ITEM');
224 
225         return '<a href="#" onclick="return listItemTask(\'cb' . $i . '\',\'' . $prefix . $task . '\')" title="' . $action . '">'
226             . JHtml::_('image', 'admin/' . $img, $alt, null, true) . '</a>';
227     }
228 
229     /**
230      * Method to create a select list of states for filtering
231      * By default the filter shows only published and unpublished items
232      *
233      * @param   string  $filter_state  The initial filter state
234      * @param   string  $published     The JText string for published
235      * @param   string  $unpublished   The JText string for Unpublished
236      * @param   string  $archived      The JText string for Archived
237      * @param   string  $trashed       The JText string for Trashed
238      *
239      * @return  string
240      *
241      * @since   1.5
242      */
243     public static function state($filter_state = '*', $published = 'JPUBLISHED', $unpublished = 'JUNPUBLISHED', $archived = null, $trashed = null)
244     {
245         $state = array('' => '- ' . JText::_('JLIB_HTML_SELECT_STATE') . ' -', 'P' => JText::_($published), 'U' => JText::_($unpublished));
246 
247         if ($archived)
248         {
249             $state['A'] = JText::_($archived);
250         }
251 
252         if ($trashed)
253         {
254             $state['T'] = JText::_($trashed);
255         }
256 
257         return JHtml::_(
258             'select.genericlist',
259             $state,
260             'filter_state',
261             array(
262                 'list.attr' => 'class="inputbox" size="1" onchange="Joomla.submitform();"',
263                 'list.select' => $filter_state,
264                 'option.key' => null,
265             )
266         );
267     }
268 
269     /**
270      * Method to create an icon for saving a new ordering in a grid
271      *
272      * @param   array   $rows   The array of rows of rows
273      * @param   string  $image  The image [UNUSED]
274      * @param   string  $task   The task to use, defaults to save order
275      *
276      * @return  string
277      *
278      * @since   1.5
279      */
280     public static function order($rows, $image = 'filesave.png', $task = 'saveorder')
281     {
282         return '<a href="javascript:saveorder('
283             . (count($rows) - 1) . ', \'' . $task . '\')" rel="tooltip" class="saveorder btn btn-micro pull-right" title="'
284             . JText::_('JLIB_HTML_SAVE_ORDER') . '"><span class="icon-menu-2"></span></a>';
285     }
286 
287     /**
288      * Method to create a checked out icon with optional overlib in a grid.
289      *
290      * @param   object   &$row     The row object
291      * @param   boolean  $overlib  True if an overlib with checkout information should be created.
292      *
293      * @return  string   HTMl for the icon and overlib
294      *
295      * @since   1.5
296      */
297     protected static function _checkedOut(&$row, $overlib = true)
298     {
299         $hover = '';
300 
301         if ($overlib)
302         {
303             JHtml::_('bootstrap.tooltip');
304 
305             $date = JHtml::_('date', $row->checked_out_time, JText::_('DATE_FORMAT_LC1'));
306             $time = JHtml::_('date', $row->checked_out_time, 'H:i');
307 
308             $hover = '<span class="editlinktip hasTooltip" title="' . JHtml::_('tooltipText', 'JLIB_HTML_CHECKED_OUT', $row->editor)
309                 . '<br />' . $date . '<br />' . $time . '">';
310         }
311 
312         return $hover . JHtml::_('image', 'admin/checked_out.png', null, null, true) . '</span>';
313     }
314 
315     /**
316      * Method to build the behavior script and add it to the document head.
317      *
318      * @return  void
319      *
320      * @since   1.6
321      */
322     public static function behavior()
323     {
324         static $loaded;
325 
326         if (!$loaded)
327         {
328             // Include jQuery
329             JHtml::_('jquery.framework');
330 
331             // Build the behavior script.
332             $js = '
333         jQuery(function($){
334             $actions = $(\'a.move_up, a.move_down, a.grid_true, a.grid_false, a.grid_trash\');
335             $actions.each(function(){
336                 $(this).on(\'click\', function(){
337                     args = JSON.decode(this.rel);
338                     listItemTask(args.id, args.task);
339                 });
340             });
341             $(\'input.check-all-toggle\').each(function(){
342                 $(this).on(\'click\', function(){
343                     if (this.checked) {
344                         $(this).closest(\'form\').find(\'input[type="checkbox"]\').each(function(){
345                             this.checked = true;
346                         })
347                     }
348                     else {
349                         $(this).closest(\'form\').find(\'input[type="checkbox"]\').each(function(){
350                             this.checked = false;
351                         })
352                     }
353                 });
354             });
355         });';
356 
357             // Add the behavior to the document head.
358             $document = JFactory::getDocument();
359             $document->addScriptDeclaration($js);
360 
361             $loaded = true;
362         }
363     }
364 }
365 

Joomla! Framework TM API documentation generated by ApiGen 2.8.0
Joomla!® and Joomla! Framework™ are trademarks of Open Source Matters, Inc. in the United States and other countries.