Joomla Standard: Ordering in der eigenen Komponente verwenden

Joomla verwendet an vielen Stellen eine komfortable Sortierfunktion. In der Übersicht kann z.B. die neue Reihenfolge eingetragen und dann mit Klick auf das Diskettensymbol gespeichert werden. Oder es können mit den Pfeiltasten die Einträge nach oben oder unten verschoben werden.

Diese Funktion kann auch für eine eigene Komponente interessant sein.

Ordering (ohne Breichszuordnung)

Joomla verwendet diese Funktionalität auch im Zusammenhang mit den definierten Bereichen. Dabei wird innerhalb der Bereiche sortiert. Welche Anpassungen dafür notwendig sind, prüfe ich noch, die Beschreibung folgt dann.

Um diese Standardsortierung vom Joomla (ohne Bereichszuordnung) in der eigenen Komponente zu verwenden:

• muss die Tabelle, z.B. Land, die Spalte: ordering (Integer) besitzen.
• administrator\components\com_meineKomponente\views\land\tmpl\default.php
  • in der Definition für den Kopf der Tabelle $ordering zuweisen (Zeile 68 in der default.php)
    $ordering = ($this->lists['order'] == 'ordering');
  • in der Definition für den Kopf der Tabelle den Code für das Sortieren einfügen (Zeile 52-55)
    <th width="100px" nowrap="nowrap"> <?php echo JHTML::_('grid.sort', 'Order', 'ordering', $this->lists['order_Dir'], $this->lists['order'] ); ?> <?php echo JHTML::_('grid.order', $this->items ); ?> </th>
  • in der Definition für die Zeilen der Tabelle mit den Werten, die Vorgabe der geänderten Sortierung, sowie die Definition für die grünen Pfeile nach oben bzw. nach unten ergänzen (Zeile 85-95 in der default.php)
    <td class="order"> <span> <?php echo $this->pagination->orderUpIcon( $i, true,'orderup', 'Move Up', $ordering ); ?> </span> <span> <?php echo $this->pagination->orderDownIcon( $i, $n, true, 'orderdown', 'Move Down', $ordering ); ?> </span> <?php $disabled = $ordering ? '' : 'disabled="disabled"'; ?> <input type="text" name="order[]" size="5" value="<?php echo $row->ordering;?>" <?php echo $disabled ?> class="text_area" style="text-align: center" /> </td>
• administrator\components\com_meineKomponente\controller\land.php
  • Tabellendefinition in Controller einbinden.
    JTable::addIncludePath(JPATH_ADMINISTRATOR.DS.'components'.DS.'com_vitadb'.DS.'tables');
  • Definition der soeben verwendeten Funktionen: orderup (Zeile 172-178 in controller/land.php) function orderup() { if ($this->order == 'desc') $this->_reOrder(1); else $this->_reOrder(-1); }//function und orderdown (Zeile 180-186 in controller/land.php) function orderdown() { if ($this->order == 'desc') $this->_reOrder(-1); else $this->_reOrder(1); }//function
  • Definition der Funktion _reOrder, die über JavaScript aufgerufen wird, wenn auf die grünen Pfeile geklickt wird (Zeile 110-132 in controller/land.php). function _reOrder($direction) { global $mainframe; // Check for request forgeries JRequest::checkToken() or jexit( 'Invalid Token' ); // Initialize variables $db = & JFactory::getDBO(); $cid = JRequest::getVar( 'cid', array(), 'post', 'array' ); if (isset( $cid[0] )) { $row = & JTable::getInstance('land', 'Table'); $row->load( (int) $cid[0] ); $row->move($direction); $cache = & JFactory::getCache('com_vitadb'); $cache->clean(); } $mainframe->redirect('index.php?option=com_vitadb&view=lands'); }//function
  • Definition der Funktion saveorder, die über JavaScript aufgerufen wird, wenn auf das Diskettensymbol geklickt wird (Zeile 110-132 in controller/land.php). function saveorder() { global $mainframe; // Check for request forgeries JRequest::checkToken() or jexit( 'Invalid Token' ); // Initialize variables $db =& JFactory::getDBO(); $cid = JRequest::getVar( 'cid', array(), 'post', 'array' ); $total = count( $cid ); $order = JRequest::getVar( 'order', array(0), 'post', 'array' ); JArrayHelper::toInteger($order, array(0)); $row =& JTable::getInstance('land', 'Table'); // update ordering values for( $i=0; $i < $total; $i++ ) { $row->load( (int) $cid[$i] ); // track sections if ($row->ordering != $order[$i]) { $row->ordering = $order[$i]; if (!$row->store()) { JError::raiseError(500, $db->getErrorMsg()); } } }//for $row->reorder(); $msg = JText::_( 'New ordering saved' ); $mainframe->redirect('index.php?option=com_vitadb&view=lands', $msg); }//function
• administrator\components\com_meineKomponente\models\lands.php
  • Definition der Liste: order im Model, in der Funktion getList() $lists['order'] = $this->filter_order;
• administrator\components\com_meineKomponente\views\lands\viewhtml.php
  • Die Datei: viewhtml.php muss die Zeile $lists = & $this->get('List'); enthalten.

Quelltexte:

• Quelltext: default.php
• Quelltext: controller\land.php
• Quelltext: Funktion getList() models\land.php
• Quelltext: viewhtml.php