Source for file newsfeeds.php

Documentation is available at newsfeeds.php

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

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