Source for file categories.php

Documentation is available at categories.php

  1. <?php
  2. /**
  3.  * @package     Joomla.Administrator
  4.  * @subpackage  com_categories
  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.  * Categories Component Categories Model
  14.  *
  15.  * @package     Joomla.Administrator
  16.  * @subpackage  com_categories
  17.  * @since       1.6
  18.  */
  19. class CategoriesModelCategories extends JModelList
  20. {
  21.     /**
  22.      * Constructor.
  23.      *
  24.      * @param   array  $config  An optional associative array of configuration settings.
  25.      *
  26.      * @see     JController
  27.      * @since   1.6
  28.      */
  29.     public function __construct($config = array())
  30.     {
  31.         if (empty($config['filter_fields']))
  32.         {
  33.             $config['filter_fields'] = array(
  34.                 'id', 'a.id',
  35.                 'title', 'a.title',
  36.                 'alias', 'a.alias',
  37.                 'published', 'a.published',
  38.                 'access', 'a.access', 'access_level',
  39.                 'language', 'a.language',
  40.                 'checked_out', 'a.checked_out',
  41.                 'checked_out_time', 'a.checked_out_time',
  42.                 'created_time', 'a.created_time',
  43.                 'created_user_id', 'a.created_user_id',
  44.                 'lft', 'a.lft',
  45.                 'rgt', 'a.rgt',
  46.                 'level', 'a.level',
  47.                 'path', 'a.path',
  48.                 'tag'
  49.             );
  50.         }
  51.  
  52.         parent::__construct($config);
  53.     }
  54.  
  55.     /**
  56.      * Method to auto-populate the model state.
  57.      *
  58.      * Note. Calling getState in this method will result in recursion.
  59.      *
  60.      * @param   string  $ordering   An optional ordering field.
  61.      * @param   string  $direction  An optional direction (asc|desc).
  62.      *
  63.      * @return  void 
  64.      *
  65.      * @since   1.6
  66.      */
  67.     protected function populateState($ordering = null, $direction = null)
  68.     {
  69.         $app = JFactory::getApplication();
  70.         $context = $this->context;
  71.  
  72.         $extension = $app->getUserStateFromRequest('com_categories.categories.filter.extension', 'extension', 'com_content', 'cmd');
  73.  
  74.         $this->setState('filter.extension', $extension);
  75.         $parts = explode('.', $extension);
  76.  
  77.         // Extract the component name
  78.         $this->setState('filter.component', $parts[0]);
  79.  
  80.         // Extract the optional section name
  81.         $this->setState('filter.section', (count($parts) > 1) ? $parts[1] : null);
  82.  
  83.         $search = $this->getUserStateFromRequest($context . '.search', 'filter_search');
  84.         $this->setState('filter.search', $search);
  85.  
  86.         $level = $this->getUserStateFromRequest($context . '.filter.level', 'filter_level', 0, 'int');
  87.         $this->setState('filter.level', $level);
  88.  
  89.         $access = $this->getUserStateFromRequest($context . '.filter.access', 'filter_access', 0, 'int');
  90.         $this->setState('filter.access', $access);
  91.  
  92.         $published = $this->getUserStateFromRequest($context . '.filter.published', 'filter_published', '');
  93.         $this->setState('filter.published', $published);
  94.  
  95.         $language = $this->getUserStateFromRequest($context . '.filter.language', 'filter_language', '');
  96.         $this->setState('filter.language', $language);
  97.  
  98.         $tag = $this->getUserStateFromRequest($this->context . '.filter.tag', 'filter_tag', '');
  99.         $this->setState('filter.tag', $tag);
  100.  
  101.         // List state information.
  102.         parent::populateState('a.lft', 'asc');
  103.  
  104.         // Force a language
  105.         $forcedLanguage = $app->input->get('forcedLanguage');
  106.  
  107.         if (!empty($forcedLanguage))
  108.         {
  109.             $this->setState('filter.language', $forcedLanguage);
  110.             $this->setState('filter.forcedLanguage', $forcedLanguage);
  111.         }
  112.     }
  113.  
  114.     /**
  115.      * Method to get a store id based on model configuration state.
  116.      *
  117.      * This is necessary because the model is used by the component and
  118.      * different modules that might need different sets of data or different
  119.      * ordering requirements.
  120.      *
  121.      * @param   string  $id  A prefix for the store id.
  122.      *
  123.      * @return  string  A store id.
  124.      *
  125.      * @since   1.6
  126.      */
  127.     protected function getStoreId($id = '')
  128.     {
  129.         // Compile the store id.
  130.         $id .= ':' . $this->getState('filter.search');
  131.         $id .= ':' . $this->getState('filter.extension');
  132.         $id .= ':' . $this->getState('filter.published');
  133.         $id .= ':' . $this->getState('filter.language');
  134.  
  135.         return parent::getStoreId($id);
  136.     }
  137.  
  138.     /**
  139.      * @return  string 
  140.      *
  141.      * @since   1.6
  142.      */
  143.     protected function getListQuery()
  144.     {
  145.         // Create a new query object.
  146.         $db = $this->getDbo();
  147.         $query = $db->getQuery(true);
  148.         $user = JFactory::getUser();
  149.  
  150.         // Select the required fields from the table.
  151.         $query->select(
  152.             $this->getState(
  153.                 'list.select',
  154.                 'a.id, a.title, a.alias, a.note, a.published, a.access' .
  155.                 ', a.checked_out, a.checked_out_time, a.created_user_id' .
  156.                 ', a.path, a.parent_id, a.level, a.lft, a.rgt' .
  157.                 ', a.language'
  158.             )
  159.         );
  160.         $query->from('#__categories AS a');
  161.  
  162.         // Join over the language
  163.         $query->select('l.title AS language_title')
  164.             ->join('LEFT', $db->quoteName('#__languages') . ' AS l ON l.lang_code = a.language');
  165.  
  166.         // Join over the users for the checked out user.
  167.         $query->select('uc.name AS editor')
  168.             ->join('LEFT', '#__users AS uc ON uc.id=a.checked_out');
  169.  
  170.         // Join over the asset groups.
  171.         $query->select('ag.title AS access_level')
  172.             ->join('LEFT', '#__viewlevels AS ag ON ag.id = a.access');
  173.  
  174.         // Join over the users for the author.
  175.         $query->select('ua.name AS author_name')
  176.             ->join('LEFT', '#__users AS ua ON ua.id = a.created_user_id');
  177.  
  178.         // Join over the associations.
  179.         $assoc = $this->getAssoc();
  180.         if ($assoc)
  181.         {
  182.             $query->select('COUNT(asso2.id)>1 as association')
  183.                 ->join('LEFT', '#__associations AS asso ON asso.id = a.id AND asso.context=' . $db->quote('com_categories.item'))
  184.                 ->join('LEFT', '#__associations AS asso2 ON asso2.key = asso.key')
  185.                 ->group('a.id');
  186.         }
  187.  
  188.         // Filter by extension
  189.         if ($extension = $this->getState('filter.extension'))
  190.         {
  191.             $query->where('a.extension = ' . $db->quote($extension));
  192.         }
  193.  
  194.         // Filter on the level.
  195.         if ($level = $this->getState('filter.level'))
  196.         {
  197.             $query->where('a.level <= ' . (int) $level);
  198.         }
  199.  
  200.         // Filter by access level.
  201.         if ($access = $this->getState('filter.access'))
  202.         {
  203.             $query->where('a.access = ' . (int) $access);
  204.         }
  205.  
  206.         // Implement View Level Access
  207.         if (!$user->authorise('core.admin'))
  208.         {
  209.             $groups = implode(',', $user->getAuthorisedViewLevels());
  210.             $query->where('a.access IN (' . $groups . ')');
  211.         }
  212.  
  213.         // Filter by published state
  214.         $published = $this->getState('filter.published');
  215.         if (is_numeric($published))
  216.         {
  217.             $query->where('a.published = ' . (int) $published);
  218.         }
  219.         elseif ($published === '')
  220.         {
  221.             $query->where('(a.published IN (0, 1))');
  222.         }
  223.  
  224.         // Filter by search in title
  225.         $search = $this->getState('filter.search');
  226.         if (!empty($search))
  227.         {
  228.             if (stripos($search, 'id:') === 0)
  229.             {
  230.                 $query->where('a.id = ' . (int) substr($search, 3));
  231.             }
  232.             elseif (stripos($search, 'author:') === 0)
  233.             {
  234.                 $search = $db->quote('%' . $db->escape(substr($search, 7), true) . '%');
  235.                 $query->where('(ua.name LIKE ' . $search . ' OR ua.username LIKE ' . $search . ')');
  236.             }
  237.             else
  238.             {
  239.                 $search = $db->quote('%' . $db->escape($search, true) . '%');
  240.                 $query->where('(a.title LIKE ' . $search . ' OR a.alias LIKE ' . $search . ' OR a.note LIKE ' . $search . ')');
  241.             }
  242.         }
  243.  
  244.         // Filter on the language.
  245.         if ($language = $this->getState('filter.language'))
  246.         {
  247.             $query->where('a.language = ' . $db->quote($language));
  248.         }
  249.  
  250.         // Filter by a single tag.
  251.         $tagId = $this->getState('filter.tag');
  252.         if (is_numeric($tagId))
  253.         {
  254.             $query->where($db->quoteName('tagmap.tag_id') . ' = ' . (int) $tagId)
  255.                 ->join(
  256.                     'LEFT', $db->quoteName('#__contentitem_tag_map', 'tagmap')
  257.                     . ' ON ' . $db->quoteName('tagmap.content_item_id') . ' = ' . $db->quoteName('a.id')
  258.                     . ' AND ' . $db->quoteName('tagmap.type_alias') . ' = ' . $db->quote($extension . '.category')
  259.                 );
  260.         }
  261.  
  262.         // Add the list ordering clause
  263.         $listOrdering = $this->getState('list.ordering', 'a.lft');
  264.         $listDirn = $db->escape($this->getState('list.direction', 'ASC'));
  265.         if ($listOrdering == 'a.access')
  266.         {
  267.             $query->order('a.access ' . $listDirn . ', a.lft ' . $listDirn);
  268.         }
  269.         else
  270.         {
  271.             $query->order($db->escape($listOrdering) . ' ' . $listDirn);
  272.         }
  273.  
  274.         //echo nl2br(str_replace('#__','jos_',$query));
  275.         return $query;
  276.     }
  277.  
  278.     /**
  279.      * Method to determine if an association exists
  280.      *
  281.      * @return  boolean  True if the association exists
  282.      *
  283.      * @since  3.0
  284.      */
  285.  
  286.     public function getAssoc()
  287.     {
  288.         static $assoc = null;
  289.  
  290.         if (!is_null($assoc))
  291.         {
  292.             return $assoc;
  293.         }
  294.  
  295.         $app = JFactory::getApplication();
  296.         $extension = $this->getState('filter.extension');
  297.  
  298.         $assoc = JLanguageAssociations::isEnabled();
  299.         $extension = explode('.', $extension);
  300.         $component = array_shift($extension);
  301.         $cname = str_replace('com_', '', $component);
  302.  
  303.         if (!$assoc || !$component || !$cname)
  304.         {
  305.             $assoc = false;
  306.         }
  307.         else
  308.         {
  309.             $hname = $cname . 'HelperAssociation';
  310.             JLoader::register($hname, JPATH_SITE . '/components/' . $component . '/helpers/association.php');
  311.  
  312.             $assoc = class_exists($hname) && !empty($hname::$category_association);
  313.         }
  314.  
  315.         return $assoc;
  316.     }
  317. }

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