Source for file query.php

Documentation is available at query.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.  * Content Component Query Helper
  14.  *
  15.  * @static
  16.  * @package     Joomla.Site
  17.  * @subpackage  com_content
  18.  * @since       1.5
  19.  */
  20. class ContentHelperQuery
  21. {
  22.     /**
  23.      * Translate an order code to a field for primary category ordering.
  24.      *
  25.      * @param   string    $orderby    The ordering code.
  26.      *
  27.      * @return  string    The SQL field(s) to order by.
  28.      * @since   1.5
  29.      */
  30.     public static function orderbyPrimary($orderby)
  31.     {
  32.         switch ($orderby)
  33.         {
  34.             case 'alpha' :
  35.                 $orderby = 'c.path, ';
  36.                 break;
  37.  
  38.             case 'ralpha' :
  39.                 $orderby = 'c.path DESC, ';
  40.                 break;
  41.  
  42.             case 'order' :
  43.                 $orderby = 'c.lft, ';
  44.                 break;
  45.  
  46.             default :
  47.                 $orderby = '';
  48.                 break;
  49.         }
  50.  
  51.         return $orderby;
  52.     }
  53.  
  54.     /**
  55.      * Translate an order code to a field for secondary category ordering.
  56.      *
  57.      * @param   string    $orderby    The ordering code.
  58.      * @param   string    $orderDate    The ordering code for the date.
  59.      *
  60.      * @return  string    The SQL field(s) to order by.
  61.      * @since   1.5
  62.      */
  63.     public static function orderbySecondary($orderby, $orderDate = 'created')
  64.     {
  65.         $queryDate = self::getQueryDate($orderDate);
  66.  
  67.         switch ($orderby)
  68.         {
  69.             case 'date' :
  70.                 $orderby = $queryDate;
  71.                 break;
  72.  
  73.             case 'rdate' :
  74.                 $orderby = $queryDate . ' DESC ';
  75.                 break;
  76.  
  77.             case 'alpha' :
  78.                 $orderby = 'a.title';
  79.                 break;
  80.  
  81.             case 'ralpha' :
  82.                 $orderby = 'a.title DESC';
  83.                 break;
  84.  
  85.             case 'hits' :
  86.                 $orderby = 'a.hits DESC';
  87.                 break;
  88.  
  89.             case 'rhits' :
  90.                 $orderby = 'a.hits';
  91.                 break;
  92.  
  93.             case 'order' :
  94.                 $orderby = 'a.ordering';
  95.                 break;
  96.  
  97.             case 'author' :
  98.                 $orderby = 'author';
  99.                 break;
  100.  
  101.             case 'rauthor' :
  102.                 $orderby = 'author DESC';
  103.                 break;
  104.  
  105.             case 'front' :
  106.                 $orderby = 'a.featured DESC, fp.ordering';
  107.                 break;
  108.  
  109.             default :
  110.                 $orderby = 'a.ordering';
  111.                 break;
  112.         }
  113.  
  114.         return $orderby;
  115.     }
  116.  
  117.     /**
  118.      * Translate an order code to a field for primary category ordering.
  119.      *
  120.      * @param   string    $orderDate    The ordering code.
  121.      *
  122.      * @return  string    The SQL field(s) to order by.
  123.      * @since   1.6
  124.      */
  125.     public static function getQueryDate($orderDate)
  126.     {
  127.         $db = JFactory::getDbo();
  128.  
  129.         switch ($orderDate)
  130.         {
  131.             case 'modified' :
  132.                 $queryDate = ' CASE WHEN a.modified = ' . $db->quote($db->getNullDate()) . ' THEN a.created ELSE a.modified END';
  133.                 break;
  134.  
  135.             // use created if publish_up is not set
  136.             case 'published' :
  137.                 $queryDate = ' CASE WHEN a.publish_up = ' . $db->quote($db->getNullDate()) . ' THEN a.created ELSE a.publish_up END ';
  138.                 break;
  139.  
  140.             case 'created' :
  141.             default :
  142.                 $queryDate = ' a.created ';
  143.                 break;
  144.         }
  145.  
  146.         return $queryDate;
  147.     }
  148.  
  149.     /**
  150.      * Get join information for the voting query.
  151.      *
  152.      * @param   JRegistry    $param    An options object for the article.
  153.      *
  154.      * @return  array      A named array with "select" and "join" keys.
  155.      * @since   1.5
  156.      */
  157.     public static function buildVotingQuery($params=null)
  158.     {
  159.         if (!$params)
  160.         {
  161.             $params = JComponentHelper::getParams('com_content');
  162.         }
  163.  
  164.         $voting = $params->get('show_vote');
  165.  
  166.         if ($voting)
  167.         {
  168.             // calculate voting count
  169.             $select = ' , ROUND(v.rating_sum / v.rating_count) AS rating, v.rating_count';
  170.             $join = ' LEFT JOIN #__content_rating AS v ON a.id = v.content_id';
  171.         }
  172.         else
  173.         {
  174.             $select = '';
  175.             $join = '';
  176.         }
  177.  
  178.         $results = array ('select' => $select, 'join' => $join);
  179.  
  180.         return $results;
  181.     }
  182.  
  183.     /**
  184.      * Method to order the intro articles array for ordering
  185.      * down the columns instead of across.
  186.      * The layout always lays the introtext articles out across columns.
  187.      * Array is reordered so that, when articles are displayed in index order
  188.      * across columns in the layout, the result is that the
  189.      * desired article ordering is achieved down the columns.
  190.      *
  191.      * @param   array  $articles    Array of intro text articles
  192.      * @param   integer    $numColumns    Number of columns in the layout
  193.      *
  194.      * @return  array  Reordered array to achieve desired ordering down columns
  195.      * @since   1.6
  196.      */
  197.     public static function orderDownColumns(&$articles, $numColumns = 1)
  198.     {
  199.         $count = count($articles);
  200.  
  201.         // just return the same array if there is nothing to change
  202.         if ($numColumns == 1 || !is_array($articles) || $count <= $numColumns)
  203.         {
  204.             $return = $articles;
  205.         }
  206.         // we need to re-order the intro articles array
  207.         else {
  208.             // we need to preserve the original array keys
  209.             $keys = array_keys($articles);
  210.  
  211.             $maxRows = ceil($count / $numColumns);
  212.             $numCells = $maxRows * $numColumns;
  213.             $numEmpty = $numCells - $count;
  214.             $index = array();
  215.  
  216.             // calculate number of empty cells in the array
  217.  
  218.             // fill in all cells of the array
  219.             // put -1 in empty cells so we can skip later
  220.  
  221.             for ($row = 1, $i = 1; $row <= $maxRows; $row++)
  222.             {
  223.                 for ($col = 1; $col <= $numColumns; $col++)
  224.                 {
  225.                     if ($numEmpty > ($numCells - $i))
  226.                     {
  227.                         // put -1 in empty cells
  228.                         $index[$row][$col] = -1;
  229.                     }
  230.                     else {
  231.                         // put in zero as placeholder
  232.                         $index[$row][$col] = 0;
  233.                     }
  234.                     $i++;
  235.                 }
  236.             }
  237.  
  238.             // layout the articles in column order, skipping empty cells
  239.             $i = 0;
  240.             for ($col = 1; ($col <= $numColumns) && ($i < $count); $col++)
  241.             {
  242.                 for ($row = 1; ($row <= $maxRows) && ($i < $count); $row++)
  243.                 {
  244.                     if ($index[$row][$col] != - 1)
  245.                     {
  246.                         $index[$row][$col] = $keys[$i];
  247.                         $i++;
  248.                     }
  249.                 }
  250.             }
  251.  
  252.             // now read the $index back row by row to get articles in right row/col
  253.             // so that they will actually be ordered down the columns (when read by row in the layout)
  254.             $return = array();
  255.             $i = 0;
  256.             for ($row = 1; ($row <= $maxRows) && ($i < $count); $row++)
  257.             {
  258.                 for ($col = 1; ($col <= $numColumns) && ($i < $count); $col++)
  259.                 {
  260.                     $return[$keys[$i]] = $articles[$index[$row][$col]];
  261.                     $i++;
  262.                 }
  263.             }
  264.         }
  265.         return $return;
  266.     }
  267. }

Documentation generated on Tue, 19 Nov 2013 15:11:25 +0100 by phpDocumentor 1.4.3