Source for file weblinks.php

Documentation is available at weblinks.php

  1. <?php
  2. /**
  3.  * @package     Joomla.Administrator
  4.  * @subpackage  com_weblinks
  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.  * Methods supporting a list of weblink records.
  14.  *
  15.  * @package     Joomla.Administrator
  16.  * @subpackage  com_weblinks
  17.  * @since       1.6
  18.  */
  19. class WeblinksModelWeblinks extends JModelList
  20. {
  21.     /**
  22.      * Constructor.
  23.      *
  24.      * @param   array  An optional associative array of configuration settings.
  25.      * @see     JController
  26.      * @since   1.6
  27.      */
  28.     public function __construct($config = array())
  29.     {
  30.         if (empty($config['filter_fields']))
  31.         {
  32.             $config['filter_fields'] = array(
  33.                 'id', 'a.id',
  34.                 'title', 'a.title',
  35.                 'alias', 'a.alias',
  36.                 'checked_out', 'a.checked_out',
  37.                 'checked_out_time', 'a.checked_out_time',
  38.                 'catid', 'a.catid', 'category_title',
  39.                 'state', 'a.state',
  40.                 'access', 'a.access', 'access_level',
  41.                 'created', 'a.created',
  42.                 'created_by', 'a.created_by',
  43.                 'ordering', 'a.ordering',
  44.                 'featured', 'a.featured',
  45.                 'language', 'a.language',
  46.                 'hits', 'a.hits',
  47.                 'publish_up', 'a.publish_up',
  48.                 'publish_down', 'a.publish_down',
  49.                 'url', 'a.url',
  50.             );
  51.         }
  52.  
  53.         parent::__construct($config);
  54.     }
  55.  
  56.     /**
  57.      * Method to auto-populate the model state.
  58.      *
  59.      * Note. Calling getState in this method will result in recursion.
  60.      *
  61.      * @since   1.6
  62.      */
  63.     protected function populateState($ordering = null, $direction = null)
  64.     {
  65.         // Load the filter state.
  66.         $search = $this->getUserStateFromRequest($this->context . '.filter.search', 'filter_search');
  67.         $this->setState('filter.search', $search);
  68.  
  69.         $accessId = $this->getUserStateFromRequest($this->context . '.filter.access', 'filter_access', null, 'int');
  70.         $this->setState('filter.access', $accessId);
  71.  
  72.         $published = $this->getUserStateFromRequest($this->context . '.filter.state', 'filter_state', '', 'string');
  73.         $this->setState('filter.state', $published);
  74.  
  75.         $categoryId = $this->getUserStateFromRequest($this->context . '.filter.category_id', 'filter_category_id', '');
  76.         $this->setState('filter.category_id', $categoryId);
  77.  
  78.         $language = $this->getUserStateFromRequest($this->context . '.filter.language', 'filter_language', '');
  79.         $this->setState('filter.language', $language);
  80.  
  81.         $tag = $this->getUserStateFromRequest($this->context . '.filter.tag', 'filter_tag', '');
  82.         $this->setState('filter.tag', $tag);
  83.  
  84.         // Load the parameters.
  85.         $params = JComponentHelper::getParams('com_weblinks');
  86.         $this->setState('params', $params);
  87.  
  88.         // List state information.
  89.         parent::populateState('a.title', 'asc');
  90.     }
  91.  
  92.     /**
  93.      * Method to get a store id based on model configuration state.
  94.      *
  95.      * This is necessary because the model is used by the component and
  96.      * different modules that might need different sets of data or different
  97.      * ordering requirements.
  98.      *
  99.      * @param   string  $id    A prefix for the store id.
  100.      * @return  string  A store id.
  101.      * @since   1.6
  102.      */
  103.     protected function getStoreId($id = '')
  104.     {
  105.         // Compile the store id.
  106.         $id .= ':' . $this->getState('filter.search');
  107.         $id .= ':' . $this->getState('filter.access');
  108.         $id .= ':' . $this->getState('filter.state');
  109.         $id .= ':' . $this->getState('filter.category_id');
  110.         $id .= ':' . $this->getState('filter.language');
  111.  
  112.         return parent::getStoreId($id);
  113.     }
  114.  
  115.     /**
  116.      * Build an SQL query to load the list data.
  117.      *
  118.      * @return  JDatabaseQuery 
  119.      * @since   1.6
  120.      */
  121.     protected function getListQuery()
  122.     {
  123.         // Create a new query object.
  124.         $db = $this->getDbo();
  125.         $query = $db->getQuery(true);
  126.         $user = JFactory::getUser();
  127.  
  128.         // Select the required fields from the table.
  129.         $query->select(
  130.             $this->getState(
  131.                 'list.select',
  132.                 'a.id, a.title, a.alias, a.checked_out, a.checked_out_time, a.catid,' .
  133.                     'a.hits,' .
  134.                     'a.state, a.access, a.ordering,' .
  135.                     'a.language, a.publish_up, a.publish_down'
  136.             )
  137.         );
  138.         $query->from($db->quoteName('#__weblinks') . ' AS a');
  139.  
  140.         // Join over the language
  141.         $query->select('l.title AS language_title')
  142.             ->join('LEFT', $db->quoteName('#__languages') . ' AS l ON l.lang_code = a.language');
  143.  
  144.         // Join over the users for the checked out user.
  145.         $query->select('uc.name AS editor')
  146.             ->join('LEFT', '#__users AS uc ON uc.id=a.checked_out');
  147.  
  148.         // Join over the asset groups.
  149.         $query->select('ag.title AS access_level')
  150.             ->join('LEFT', '#__viewlevels AS ag ON ag.id = a.access');
  151.  
  152.         // Join over the categories.
  153.         $query->select('c.title AS category_title')
  154.             ->join('LEFT', '#__categories AS c ON c.id = a.catid');
  155.  
  156.         // Filter by access level.
  157.         if ($access = $this->getState('filter.access'))
  158.         {
  159.             $query->where('a.access = ' . (int) $access);
  160.         }
  161.  
  162.         // Implement View Level Access
  163.         if (!$user->authorise('core.admin'))
  164.         {
  165.             $groups = implode(',', $user->getAuthorisedViewLevels());
  166.             $query->where('a.access IN (' . $groups . ')');
  167.         }
  168.  
  169.         // Filter by published state
  170.         $published = $this->getState('filter.state');
  171.         if (is_numeric($published))
  172.         {
  173.             $query->where('a.state = ' . (int) $published);
  174.         }
  175.         elseif ($published === '')
  176.         {
  177.             $query->where('(a.state IN (0, 1))');
  178.         }
  179.  
  180.         // Filter by category.
  181.         $categoryId = $this->getState('filter.category_id');
  182.         if (is_numeric($categoryId))
  183.         {
  184.             $query->where('a.catid = ' . (int) $categoryId);
  185.         }
  186.  
  187.         // Filter by search in title
  188.         $search = $this->getState('filter.search');
  189.         if (!empty($search))
  190.         {
  191.             if (stripos($search, 'id:') === 0)
  192.             {
  193.                 $query->where('a.id = ' . (int) substr($search, 3));
  194.             }
  195.             else
  196.             {
  197.                 $search = $db->quote('%' . $db->escape($search, true) . '%');
  198.                 $query->where('(a.title LIKE ' . $search . ' OR a.alias LIKE ' . $search . ')');
  199.             }
  200.         }
  201.  
  202.         // Filter on the language.
  203.         if ($language = $this->getState('filter.language'))
  204.         {
  205.             $query->where('a.language = ' . $db->quote($language));
  206.         }
  207.  
  208.         $tagId = $this->getState('filter.tag');
  209.         // Filter by a single tag.
  210.         if (is_numeric($tagId))
  211.         {
  212.             $query->where($db->quoteName('tagmap.tag_id') . ' = ' . (int) $tagId)
  213.                 ->join(
  214.                     'LEFT', $db->quoteName('#__contentitem_tag_map', 'tagmap')
  215.                     . ' ON ' . $db->quoteName('tagmap.content_item_id') . ' = ' . $db->quoteName('a.id')
  216.                     . ' AND ' . $db->quoteName('tagmap.type_alias') . ' = ' . $db->quote('com_weblinks.weblink')
  217.                 );
  218.         }
  219.  
  220.         // Add the list ordering clause.
  221.         $orderCol = $this->state->get('list.ordering');
  222.         $orderDirn = $this->state->get('list.direction');
  223.         if ($orderCol == 'a.ordering' || $orderCol == 'category_title')
  224.         {
  225.             $orderCol = 'c.title ' . $orderDirn . ', a.ordering';
  226.         }
  227.         $query->order($db->escape($orderCol . ' ' . $orderDirn));
  228.  
  229.         //echo nl2br(str_replace('#__','jos_',$query));
  230.         return $query;
  231.     }
  232. }

Documentation generated on Tue, 19 Nov 2013 15:18:30 +0100 by phpDocumentor 1.4.3