Source for file view.html.php

Documentation is available at view.html.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.  * HTML View class for the Content component
  14.  *
  15.  * @package     Joomla.Site
  16.  * @subpackage  com_content
  17.  * @since       1.5
  18.  */
  19. class ContentViewCategory extends JViewCategory
  20. {
  21.     /**
  22.      * @var    array  Array of leading items for blog display
  23.      * @since  3.2
  24.      */
  25.     protected $lead_items = array();
  26.  
  27.     /**
  28.      * @var    array  Array of intro (multicolumn display) items for blog display
  29.      * @since  3.2
  30.      */
  31.     protected $intro_items = array();
  32.  
  33.     /**
  34.      * @var    array  Array of links in blog display
  35.      * @since  3.2
  36.      */
  37.     protected $link_items = array();
  38.  
  39.     /**
  40.      * @var    integer  Number of columns in a multi column display
  41.      * @since  3.2
  42.      */
  43.     protected $columns = 1;
  44.  
  45.     /**
  46.      * @var    string  The name of the extension for the category
  47.      * @since  3.2
  48.      */
  49.     protected $extension = 'com_content';
  50.  
  51.     /**
  52.      * @var    string  Default title to use for page title
  53.      * @since  3.2
  54.      */
  55.     protected $defaultPageTitle = 'JGLOBAL_ARTICLES';
  56.  
  57.     /**
  58.      * @var    string  The name of the view to link individual items to
  59.      * @since  3.2
  60.      */
  61.     protected $viewName = 'article';
  62.  
  63.     /**
  64.      * Execute and display a template script.
  65.      *
  66.      * @param   string  $tpl  The name of the template file to parse; automatically searches through the template paths.
  67.      *
  68.      * @return  mixed  A string if successful, otherwise a Error object.
  69.      */
  70.     public function display($tpl = null)
  71.     {
  72.         parent::commonCategoryDisplay();
  73.  
  74.         // Prepare the data
  75.         // Get the metrics for the structural page layout.
  76.         $params        = $this->params;
  77.         $numLeading    = $params->def('num_leading_articles', 1);
  78.         $numIntro    = $params->def('num_intro_articles', 4);
  79.         $numLinks    = $params->def('num_links', 4);
  80.  
  81.         // Compute the article slugs and prepare introtext (runs content plugins).
  82.         foreach ($this->items as $item)
  83.         {
  84.             $item->slug = $item->alias ? ($item->id . ':' . $item->alias) : $item->id;
  85.  
  86.             $item->parent_slug = ($item->parent_alias) ? ($item->parent_id . ':' . $item->parent_alias) : $item->parent_id;
  87.  
  88.             // No link for ROOT category
  89.             if ($item->parent_alias == 'root')
  90.             {
  91.                 $item->parent_slug = null;
  92.             }
  93.  
  94.             $item->catslug = $item->category_alias ? ($item->catid.':'.$item->category_alias) : $item->catid;
  95.             $item->event   = new stdClass;
  96.  
  97.             $dispatcher = JEventDispatcher::getInstance();
  98.  
  99.             // Old plugins: Ensure that text property is available
  100.             if (!isset($item->text))
  101.             {
  102.                 $item->text = $item->introtext;
  103.             }
  104.  
  105.             JPluginHelper::importPlugin('content');
  106.             $dispatcher->trigger('onContentPrepare', array ('com_content.category', &$item, &$this->params, 0));
  107.  
  108.             // Old plugins: Use processed text as introtext
  109.             $item->introtext = $item->text;
  110.  
  111.             $results = $dispatcher->trigger('onContentAfterTitle', array('com_content.category', &$item, &$item->params, 0));
  112.             $item->event->afterDisplayTitle = trim(implode("\n", $results));
  113.  
  114.             $results = $dispatcher->trigger('onContentBeforeDisplay', array('com_content.category', &$item, &$item->params, 0));
  115.             $item->event->beforeDisplayContent = trim(implode("\n", $results));
  116.  
  117.             $results = $dispatcher->trigger('onContentAfterDisplay', array('com_content.category', &$item, &$item->params, 0));
  118.             $item->event->afterDisplayContent = trim(implode("\n", $results));
  119.         }
  120.  
  121.         // Check for layout override only if this is not the active menu item
  122.         // If it is the active menu item, then the view and category id will match
  123.         $app = JFactory::getApplication();
  124.         $active    = $app->getMenu()->getActive();
  125.  
  126.         if ((!$active) || ((strpos($active->link, 'view=category') === false) || (strpos($active->link, '&id=' . (string) $this->category->id) === false)))
  127.         {
  128.             // Get the layout from the merged category params
  129.             if ($layout = $this->category->params->get('category_layout'))
  130.             {
  131.                 $this->setLayout($layout);
  132.             }
  133.         }
  134.         // At this point, we are in a menu item, so we don't override the layout
  135.         elseif (isset($active->query['layout']))
  136.         {
  137.             // We need to set the layout from the query in case this is an alternative menu item (with an alternative layout)
  138.             $this->setLayout($active->query['layout']);
  139.         }
  140.  
  141.         // For blog layouts, preprocess the breakdown of leading, intro and linked articles.
  142.         // This makes it much easier for the designer to just interrogate the arrays.
  143.         if (($params->get('layout_type') == 'blog') || ($this->getLayout() == 'blog'))
  144.         {
  145.             //$max = count($this->items);
  146.  
  147.             foreach ($this->items as $i => $item)
  148.             {
  149.                 if ($i < $numLeading)
  150.                 {
  151.                     $this->lead_items[] = $item;
  152.                 }
  153.  
  154.                 elseif ($i >= $numLeading && $i < $numLeading + $numIntro)
  155.                 {
  156.                     $this->intro_items[] = $item;
  157.                 }
  158.  
  159.                 elseif ($i < $numLeading + $numIntro + $numLinks)
  160.                 {
  161.                     $this->link_items[] = $item;
  162.                 }
  163.                 else
  164.                 {
  165.                     continue;
  166.                 }
  167.             }
  168.  
  169.             $this->columns = max(1, $params->def('num_columns', 1));
  170.  
  171.             $params->def('multi_column_order', 1);
  172.         }
  173.  
  174.         return parent::display($tpl);
  175.     }
  176.  
  177.     /**
  178.      * Prepares the document
  179.      *
  180.      * @return  void 
  181.      */
  182.     protected function prepareDocument()
  183.     {
  184.         parent::prepareDocument();
  185.         $menu = $this->menu;
  186.         $id = (int) @$menu->query['id'];
  187.  
  188.         if ($menu && ($menu->query['option'] != 'com_content' || $menu->query['view'] == 'article' || $id != $this->category->id))
  189.         {
  190.             $path = array(array('title' => $this->category->title, 'link' => ''));
  191.             $category = $this->category->getParent();
  192.  
  193.             while (($menu->query['option'] != 'com_content' || $menu->query['view'] == 'article' || $id != $category->id) && $category->id > 1)
  194.             {
  195.                 $path[] = array('title' => $category->title, 'link' => ContentHelperRoute::getCategoryRoute($category->id));
  196.                 $category = $category->getParent();
  197.             }
  198.  
  199.             $path = array_reverse($path);
  200.  
  201.             foreach ($path as $item)
  202.             {
  203.                 $this->pathway->addItem($item['title'], $item['link']);
  204.             }
  205.         }
  206.  
  207.         parent::addFeed();
  208.     }
  209. }

Documentation generated on Tue, 19 Nov 2013 15:17:04 +0100 by phpDocumentor 1.4.3