Source for file categories.php

Documentation is available at categories.php

  1. <?php
  2. /**
  3.  * @package     Joomla.Site
  4.  * @subpackage  com_content
  5.  *
  6.  * @copyright   Copyright (C) 2005 - 2013 Open Source Matters, Inc. All rights reserved.
  7.  * @license     GNU General Public License version 2 or later; see LICENSE.txt
  8.  */
  9.  
  10. defined('_JEXEC') or die;
  11.  
  12. /**
  13.  * This models supports retrieving lists of article categories.
  14.  *
  15.  * @package     Joomla.Site
  16.  * @subpackage  com_content
  17.  * @since       1.6
  18.  */
  19. class ContentModelCategories extends JModelList
  20. {
  21.     /**
  22.      * Model context string.
  23.      *
  24.      * @var        string 
  25.      */
  26.     public $_context = 'com_content.categories';
  27.  
  28.     /**
  29.      * The category context (allows other extensions to derived from this model).
  30.      *
  31.      * @var        string 
  32.      */
  33.     protected $_extension = 'com_content';
  34.  
  35.     private $_parent = null;
  36.  
  37.     private $_items = null;
  38.  
  39.     /**
  40.      * Method to auto-populate the model state.
  41.      *
  42.      * Note. Calling getState in this method will result in recursion.
  43.      *
  44.      * @since   1.6
  45.      */
  46.     protected function populateState($ordering = null, $direction = null)
  47.     {
  48.         $app = JFactory::getApplication();
  49.         $this->setState('filter.extension', $this->_extension);
  50.  
  51.         // Get the parent id if defined.
  52.         $parentId = $app->input->getInt('id');
  53.         $this->setState('filter.parentId', $parentId);
  54.  
  55.         $params = $app->getParams();
  56.         $this->setState('params', $params);
  57.  
  58.         $this->setState('filter.published',    1);
  59.         $this->setState('filter.access',    true);
  60.     }
  61.  
  62.     /**
  63.      * Method to get a store id based on model configuration state.
  64.      *
  65.      * This is necessary because the model is used by the component and
  66.      * different modules that might need different sets of data or different
  67.      * ordering requirements.
  68.      *
  69.      * @param   string  $id    A prefix for the store id.
  70.      *
  71.      * @return  string  A store id.
  72.      */
  73.     protected function getStoreId($id = '')
  74.     {
  75.         // Compile the store id.
  76.         $id    .= ':'.$this->getState('filter.extension');
  77.         $id    .= ':'.$this->getState('filter.published');
  78.         $id    .= ':'.$this->getState('filter.access');
  79.         $id    .= ':'.$this->getState('filter.parentId');
  80.  
  81.         return parent::getStoreId($id);
  82.     }
  83.  
  84.     /**
  85.      * Redefine the function an add some properties to make the styling more easy
  86.      *
  87.      * @param   bool    $recursive    True if you want to return children recursively.
  88.      *
  89.      * @return  mixed  An array of data items on success, false on failure.
  90.      * @since   1.6
  91.      */
  92.     public function getItems($recursive = false)
  93.     {
  94.         if (!count($this->_items))
  95.         {
  96.             $app = JFactory::getApplication();
  97.             $menu = $app->getMenu();
  98.             $active = $menu->getActive();
  99.             $params = new JRegistry;
  100.  
  101.             if ($active)
  102.             {
  103.                 $params->loadString($active->params);
  104.             }
  105.  
  106.             $options = array();
  107.             $options['countItems'] = $params->get('show_cat_num_articles_cat', 1) || !$params->get('show_empty_categories_cat', 0);
  108.             $categories = JCategories::getInstance('Content', $options);
  109.             $this->_parent = $categories->get($this->getState('filter.parentId', 'root'));
  110.  
  111.             if (is_object($this->_parent))
  112.             {
  113.                 $this->_items = $this->_parent->getChildren($recursive);
  114.             }
  115.             else {
  116.                 $this->_items = false;
  117.             }
  118.         }
  119.  
  120.         return $this->_items;
  121.     }
  122.  
  123.     public function getParent()
  124.     {
  125.         if (!is_object($this->_parent))
  126.         {
  127.             $this->getItems();
  128.         }
  129.  
  130.         return $this->_parent;
  131.     }
  132. }

Documentation generated on Tue, 19 Nov 2013 14:55:13 +0100 by phpDocumentor 1.4.3