Source for file featured.php

Documentation is available at featured.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. require_once __DIR__ . '/articles.php';
  13.  
  14. /**
  15.  * Frontpage Component Model
  16.  *
  17.  * @package     Joomla.Site
  18.  * @subpackage  com_content
  19.  * @since       1.5
  20.  */
  21. class ContentModelFeatured extends ContentModelArticles
  22. {
  23.     /**
  24.      * Model context string.
  25.      *
  26.      * @var        string 
  27.      */
  28.     public $_context = 'com_content.frontpage';
  29.  
  30.     /**
  31.      * Method to auto-populate the model state.
  32.      *
  33.      * Note. Calling getState in this method will result in recursion.
  34.      *
  35.      * @since   1.6
  36.      */
  37.     protected function populateState($ordering = null, $direction = null)
  38.     {
  39.         parent::populateState($ordering, $direction);
  40.  
  41.         $input = JFactory::getApplication()->input;
  42.         $user  = JFactory::getUser();
  43.  
  44.         // List state information
  45.         $limitstart = $input->getUInt('limitstart', 0);
  46.         $this->setState('list.start', $limitstart);
  47.  
  48.         $params = $this->state->params;
  49.         $limit = $params->get('num_leading_articles') + $params->get('num_intro_articles') + $params->get('num_links');
  50.         $this->setState('list.limit', $limit);
  51.         $this->setState('list.links', $params->get('num_links'));
  52.  
  53.         $this->setState('filter.frontpage', true);
  54.  
  55.         if ((!$user->authorise('core.edit.state', 'com_content')) &&  (!$user->authorise('core.edit', 'com_content'))){
  56.             // filter on published for those who do not have edit or edit.state rights.
  57.             $this->setState('filter.published', 1);
  58.         }
  59.         else
  60.         {
  61.             $this->setState('filter.published', array(0, 1, 2));
  62.         }
  63.  
  64.         // check for category selection
  65.         if ($params->get('featured_categories') && implode(',', $params->get('featured_categories')) == true)
  66.         {
  67.             $featuredCategories = $params->get('featured_categories');
  68.             $this->setState('filter.frontpage.categories', $featuredCategories);
  69.         }
  70.     }
  71.  
  72.     /**
  73.      * Method to get a list of articles.
  74.      *
  75.      * @return  mixed  An array of objects on success, false on failure.
  76.      */
  77.     public function getItems()
  78.     {
  79.         $params = clone $this->getState('params');
  80.         $limit = $params->get('num_leading_articles') + $params->get('num_intro_articles') + $params->get('num_links');
  81.         if ($limit > 0)
  82.         {
  83.             $this->setState('list.limit', $limit);
  84.             return parent::getItems();
  85.         }
  86.         return array();
  87.  
  88.     }
  89.  
  90.     /**
  91.      * Method to get a store id based on model configuration state.
  92.      *
  93.      * This is necessary because the model is used by the component and
  94.      * different modules that might need different sets of data or different
  95.      * ordering requirements.
  96.      *
  97.      * @param   string  $id    A prefix for the store id.
  98.      *
  99.      * @return  string  A store id.
  100.      */
  101.     protected function getStoreId($id = '')
  102.     {
  103.         // Compile the store id.
  104.         $id .= $this->getState('filter.frontpage');
  105.  
  106.         return parent::getStoreId($id);
  107.     }
  108.  
  109.     /**
  110.      * @return  JDatabaseQuery 
  111.      */
  112.     protected function getListQuery()
  113.     {
  114.         // Set the blog ordering
  115.         $params = $this->state->params;
  116.         $articleOrderby = $params->get('orderby_sec', 'rdate');
  117.         $articleOrderDate = $params->get('order_date');
  118.         $categoryOrderby = $params->def('orderby_pri', '');
  119.         $secondary = ContentHelperQuery::orderbySecondary($articleOrderby, $articleOrderDate) . ', ';
  120.         $primary = ContentHelperQuery::orderbyPrimary($categoryOrderby);
  121.  
  122.         $orderby = $primary . ' ' . $secondary . ' a.created DESC ';
  123.         $this->setState('list.ordering', $orderby);
  124.         $this->setState('list.direction', '');
  125.  
  126.         // Create a new query object.
  127.         $query = parent::getListQuery();
  128.  
  129.         // Filter by frontpage.
  130.         if ($this->getState('filter.frontpage'))
  131.         {
  132.             $query->join('INNER', '#__content_frontpage AS fp ON fp.content_id = a.id');
  133.         }
  134.  
  135.         // Filter by categories
  136.         $featuredCategories = $this->getState('filter.frontpage.categories');
  137.  
  138.         if (is_array($featuredCategories) && !in_array('', $featuredCategories))
  139.         {
  140.             $query->where('a.catid IN (' . implode(',', $featuredCategories) . ')');
  141.         }
  142.  
  143.         return $query;
  144.     }
  145. }

Documentation generated on Tue, 19 Nov 2013 15:02:51 +0100 by phpDocumentor 1.4.3