Přidáváme kategorie

Domů

Přidáváme kategorie

Napsal uživatel Filip Bartmann | 26 Červen 2010
Posted in Dokumentace - Komponenty

Ve dnešním pokračování si do komponenty přidáme kategorie a na nich si ukážeme zajímavé věci jako řazení pohledu seznamu, uložení řazení a také filtrování seznamu

Přidáváme kategorie

Jako první si vytvoříme potřebné soubory a to controller categories.php, dále 2 modely categories.php a category.,php a nakonec 2 pohledy categories a category a soubor pro objektové-relační mapování tabulky(v adresáři tables). Stačí použít soubory z minulých dílů a přejmenovat v nich sections na categories a section na category. Také nesníme zapomenout přidat do instalačního xml souboru Joomly přidat odpovídající soubory a také položku do menu a přidat do databáze do tabulky #__sf_categories sloupec ordering.

)

UPDATE jos_sf_categories ADD ordering int(5) NOT NULL);

Filtrování

Filtrování si ukážeme na příkladu vyfiltrování kategorií patřících do dané sekce našeho fóra. To zařídíme vytvořením rozbalovacího seznamu, do kterého musíme nejprve načíst data, což zajistíme pomocí jednoduchého dotazu do databáze. Daleko zajímavější je jeho zpracování. Jelikož potřebujeme jednu položku(volbu pro zobrazení všech kategorií) oproti datům načteným z databáze navíc, tak si jí do pole objektů, které jsme z databáze metodou loadObjectList() získali jednoduše přidáme fukncí PHP array_merge. Zde si všimněme, důležitého detailu tato položka musí být v poli, takže je nutné ji obalit ve funkci array(). Samotnou položku vytvoříme metodou select.option, jejiž název předáme do továrny HTML kódu JHTML::_(). Tento zápis je Joomlou interpretován jako volání metody JHTMLSelectOption(). Ta obsahuje parametry id položky (nastavujeme na -1, abychom jí odlišili od platných položek z databáze), text volby, a nakonec hodnoty, kde najdeme id a hodnotu(title) rozbalovacího seznamu ve výsledku SQL dotazu. Tyto dvě hodnoty musí být stejné pro celý rozbalovací seznam a zadáváme je také do metody pro samotné vytvoření seznamu select.genericlist.

    $query="SELECT id, title \n";
    $query.="FROM ".$this->getTable('section')->getTableName()." \n";
    $query.="ORDER BY title \n";
    $this->_db->setQuery($query);
    $sections_ol=array_merge(array(JHTML::_('select.option',-1,JText::_('Select section'),'id','title')),$this->_db->loadObjectList());
 
    $lists["section_id"]=JHTML::_('select.genericlist',$sections_ol,'section_id','class="inputbox" size="1" onchange="document.adminForm.submit();"','id','title',$this->_section_id);

Jak vidíme jedná se opět o továrnu HTML, se kterou se setkáme ještě hodně krát. Jako parametry musíme uvést pole objektů výsledků dotazu, název seznamu, css stylování (zde je důležité si všimnout js kódu onchange, který nám zajistí interativitu seznamu), hodnoty, kde najdeme id a hodnotu(title) a jako poslední také jaká hodnota bude vybraná. Tu ještě nemáme vytvořenu, ale to hned napravíme v konstruktoru, kde si jí metodou getUserStateFromRequest() načteme.

$this->_section_id=$app->getUserStateFromRequest($option.'section_id','section_id',-1,'int');

Dále je nutné filtr promítnout do samotného SQL dotazu. Z praxe mi vyšel jako nejlepší způsob, kdy si vytvořím vlastní metodu _setWhere(), kde do pole $where, v případě, že hodnota filtru je větší než 0, nebo v případě textu obsahuje nějaký text, ukládám části SQL dotazu pro filtrování(WHERE). Metodu končím navrácením řetězce spojeného pomocí PHP funkce implode() v případě, že v pole $where nějaké podmínky obsahuje, nebo prázdný řetězec v opačném případě. Tuto metodu pak volám v SQL dotazu _setQuery().

  private function _setWhere() {
    $where=array();
    if($this->_section_id>0) {
      $where[]="c.section_id=".$this->_section_id;
    }
    return count($where)?("WHERE ".implode(" AND ",$where)." \n"):"";
  }
 
  private function _setQuery() {
    $query="SELECT c.*, s.title AS section \n";
    $query.="FROM ".$this->getTable('category')->getTableName()." AS c \n";
    $query.="LEFT JOIN ".$this->getTable('section')->getTableName()." AS s ON c.section_id=s.id \n";
    $query.=$this->_setWhere();
    $query.="ORDER BY ".$this->_orderBy." ".$this->_orderDir." \n";
    return $query;
  }

Zobrazení filtru je velice jednoduché. Stačí jej přidat do souboru default.php daného pohledu v našem případě categories. Tady si dejte pouze pozor, aby filtr začínal až ve formuláři, nikoliv nad ním, což se mi několikrát stalo a pak jsem se divil proč filtrování nefunguje.

<table width="100%">
  <tr>
    <td><?php echo Jtext::_('Section'); ?>: <?php echo $this->lists["section_id"]; ?>
  </tr>
</table>

Přidání rozbalovacího seznamu do editace

Abychom mohli sekce filtrovat, tak je nutné si je neprve přiřadit k dané sekci. Postupovat budeme víceméně stejně jako u filtru seznamu. Pouze do css stylování metody select.genericlist nepřidáme akci onchange. Také si musíme přidat předání dat listingu do přípravy pohledu.

    <tr>
      <td>
      <?php echo JText::_('Section'); ?>
      </td>
      <td>
      <?php echo $this->lists["section_id"]; ?>
      </td>
    </tr>

$this->assignRef('lists',$this->get('lists'));

Řazení seznamu

V případě řazení seznamu si vystačíme pouze v pohledu, konkrétně v jeho záhlaví, kde nahradíme popisky sloupců za další metodu HTML továrny a to grid.sort, které jako parametry předáme Popisek sloupce, jméno pole v SQL databázi podle kterého se má řadit, dále uloženou položku listingu orderDir, ve které máme uložen směr řazení a také ještě aktuální sloupec podle kterého se řadí(orderBy). Tyto hodnoty máme již v modelu připravené. Jako druhý krok ještě na konec formuláře přidáme dvě skrytá (hidden) pole s názvy filter_order a filter_order_Dir. Do těchto polí nám totiž js Joomly ukládá aktuální filtrování.

    <thead>
      <tr>
        <th width="5">
        <?php echo JText::_('NUM'); ?>
        </th>
        <th width="5">
        <input class="inputbox" type="checkbox" name="toggle" value="0" onclick="checkAll('<?php echo count($this->data); ?>')" />
        </th>
        <th>
        <?php echo JHTML::_('grid.sort',JText::_('Title'),"c.title",$this->lists["orderDir"],$this->lists["orderBy"]); ?>
        </th>
        <th>
        <?php echo JHTML::_('grid.sort',JText::_('Section'),"s.title",$this->lists["orderDir"],$this->lists["orderBy"]); ?>
        </th>
    </thead>

<input type="hidden" name="filter_order" value="<?php echo $this->lists["orderBy"]; ?>" />
<input type="hidden" name="filter_order_Dir" value="<?php echo $this->lists["orderDir"]; ?>" />

Uložení řazení

Někdy se nám může hodit, aby se položky ve veřejné části, na kterou dojde později, zobrazovaly seřazené podle určitého způsobu. Ani na toto Joomla nezapomíná a pomůže nám s tím. Do tabulky seznamu si přidáme sloupec určující řazení. Záhlaví sloupce obsahuje metodu grid.order s parametrem všech dat seznamu. Jako nepovinný parametr můžeme zadat název akce(task), pokud nám výchozí saveorder nevyhovuje. Tato metoda zajistí zobrazení tlačítka diskety, které pomocí js kódu předá zadané řazení k uložení.

        <th width="100px">
        <?php echo JHTML::_('grid.sort',JText::_('Ordering'),"c.ordering",$this->lists["orderDir"],$this->lists["orderBy"]); ?>
        <?php echo JHTML::_('grid.order',$this->data); ?>
        </th>

<td align="center"><input class="inputbox" type="text" size="5" name="ordering[<?php echo $row->id; ?>];" value="<?php echo $row->ordering; ?>" /></td>

Do datové části sloupce vložíme textové pole, které nám umožní zadat požadované řazení. Tady je důležité, aby název pole byl ve tvaru jmeno[id], v našem případě tedy ordering[id]. Takto jej půjde později jednoduše zpracovat. Zpracování probíhá hlavně v modelu. Controller obsahuje pouze volání metody reorder modelu. Zpracování dat v modelu spočívá v projetí všech položek v cyklu foreach(), kde perfektně využijeme, že jsme pro hodnoty řazení využili pole v požadavku. V cyklu načítáme záznam podle id a přiřazujeme mu aktuální hodnotu řazení a tento záznam následně ukládáme. Hlavní práce se ale skrývá v metodě reorder(), kdy Joomla za nas vyřeší, aby číslovaní položek bylo kontinuální bez mezer.

  function reorder() {
    $ordering=JRequest::getVar('ordering',array(),'post','array');
 
    foreach($ordering as $k=>$v) {
      $this->_table->load($k);
      $this->_table->ordering=$v;
      if(!$this->_table->store()) {
        $this->setError($this->_db->stderr(true));
        return false;
      }    
    }
    $this->_table->reorder();
    return true;
  }

Jako domácí úkol nechávám přidání uložení řazení v sekcích. Výsledný kód najdete v příštím díle.

Příště

V dalším pokračování přejdeme k samotným příspěvkům našeho fóra a ukážeme si na nich mimo jiné, jak pomocí AJAXu načítat kategorie v závislosti na vybrané sekci. Aktuální stav komponenty naleznete ke stažení zde.