Source for file view.html.php

Documentation is available at view.html.php

  1. <?php
  2. /**
  3.  * @package     Joomla.Site
  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.  * HTML View class for the Newsfeeds component
  14.  *
  15.  * @package     Joomla.Site
  16.  * @subpackage  com_newsfeeds
  17.  * @since       1.0
  18.  */
  19. class NewsfeedsViewNewsfeed extends JViewLegacy
  20. {
  21.     /**
  22.      * @var        object 
  23.      * @since   1.6
  24.      */
  25.     protected $state;
  26.  
  27.     /**
  28.      * @var        object 
  29.      * @since   1.6
  30.      */
  31.     protected $item;
  32.  
  33.     /**
  34.      * @var        boolean 
  35.      * @since   1.6
  36.      */
  37.     protected $print;
  38.  
  39.     /**
  40.      * Execute and display a template script.
  41.      *
  42.      * @param   string  $tpl  The name of the template file to parse; automatically searches through the template paths.
  43.      *
  44.      * @return  mixed  A string if successful, otherwise a Error object.
  45.      *
  46.      * @since   1.6
  47.      */
  48.     public function display($tpl = null)
  49.     {
  50.         $app        = JFactory::getApplication();
  51.         $user        = JFactory::getUser();
  52.  
  53.         // Get view related request variables.
  54.         $print = $app->input->getBool('print');
  55.  
  56.         // Get model data.
  57.         $state = $this->get('State');
  58.         $item = $this->get('Item');
  59.  
  60.         if ($item)
  61.         {
  62.             // Get Category Model data
  63.             $categoryModel = JModelLegacy::getInstance('Category', 'NewsfeedsModel', array('ignore_request' => true));
  64.             $categoryModel->setState('category.id', $item->catid);
  65.             $categoryModel->setState('list.ordering', 'a.name');
  66.             $categoryModel->setState('list.direction', 'asc');
  67.             // TODO: $items is not used. Remove this line?
  68.             $items = $categoryModel->getItems();
  69.         }
  70.  
  71.         // Check for errors.
  72.         // @TODO Maybe this could go into JComponentHelper::raiseErrors($this->get('Errors'))
  73.         if (count($errors = $this->get('Errors')))
  74.         {
  75.             JError::raiseWarning(500, implode("\n", $errors));
  76.  
  77.             return false;
  78.         }
  79.  
  80.         // Add router helpers.
  81.         $item->slug = $item->alias ? ($item->id . ':' . $item->alias) : $item->id;
  82.         $item->catslug = $item->category_alias ? ($item->catid . ':' . $item->category_alias) : $item->catid;
  83.         $item->parent_slug = $item->category_alias ? ($item->parent_id . ':' . $item->parent_alias) : $item->parent_id;
  84.  
  85.         // check if cache directory is writeable
  86.         $cacheDir = JPATH_CACHE . '/';
  87.  
  88.         if (!is_writable($cacheDir))
  89.         {
  90.             JError::raiseNotice('0', JText::_('COM_NEWSFEEDS_CACHE_DIRECTORY_UNWRITABLE'));
  91.             return;
  92.         }
  93.  
  94.         // Merge newsfeed params. If this is single-newsfeed view, menu params override newsfeed params
  95.         // Otherwise, newsfeed params override menu item params
  96.         $params = $state->get('params');
  97.         $newsfeed_params = clone $item->params;
  98.         $active = $app->getMenu()->getActive();
  99.         $temp = clone ($params);
  100.  
  101.         // Check to see which parameters should take priority
  102.         if ($active)
  103.         {
  104.             $currentLink = $active->link;
  105.             // If the current view is the active item and an newsfeed view for this feed, then the menu item params take priority
  106.             if (strpos($currentLink, 'view=newsfeed') && (strpos($currentLink, '&id='.(string) $item->id)))
  107.             {
  108.                 // $item->params are the newsfeed params, $temp are the menu item params
  109.                 // Merge so that the menu item params take priority
  110.                 $newsfeed_params->merge($temp);
  111.                 $item->params = $newsfeed_params;
  112.                 // Load layout from active query (in case it is an alternative menu item)
  113.                 if (isset($active->query['layout']))
  114.                 {
  115.                     $this->setLayout($active->query['layout']);
  116.                 }
  117.             }
  118.             else
  119.             {
  120.                 // Current view is not a single newsfeed, so the newsfeed params take priority here
  121.                 // Merge the menu item params with the newsfeed params so that the newsfeed params take priority
  122.                 $temp->merge($newsfeed_params);
  123.                 $item->params = $temp;
  124.                 // Check for alternative layouts (since we are not in a single-newsfeed menu item)
  125.                 if ($layout = $item->params->get('newsfeed_layout'))
  126.                 {
  127.                     $this->setLayout($layout);
  128.                 }
  129.             }
  130.         }
  131.         else
  132.         {
  133.             // Merge so that newsfeed params take priority
  134.             $temp->merge($newsfeed_params);
  135.             $item->params = $temp;
  136.             // Check for alternative layouts (since we are not in a single-newsfeed menu item)
  137.             if ($layout = $item->params->get('newsfeed_layout'))
  138.             {
  139.                 $this->setLayout($layout);
  140.             }
  141.         }
  142.  
  143.         // Check the access to the newsfeed
  144.         $levels = $user->getAuthorisedViewLevels();
  145.  
  146.         if (!in_array($item->access, $levels) or ((in_array($item->access, $levels) and (!in_array($item->category_access, $levels)))))
  147.         {
  148.             JError::raiseWarning(403, JText::_('JERROR_ALERTNOAUTHOR'));
  149.             return;
  150.         }
  151.  
  152.         // Get the current menu item
  153.         $params    = $app->getParams();
  154.  
  155.         // Get the newsfeed
  156.         $newsfeed = $item;
  157.  
  158.         $temp = new JRegistry;
  159.         $temp->loadString($item->params);
  160.         $params->merge($temp);
  161.  
  162.         try
  163.         {
  164.             $feed = new JFeedFactory;
  165.             $this->rssDoc = $feed->getFeed($newsfeed->link);
  166.         }
  167.         catch (InvalidArgumentException $e)
  168.         {
  169.             $msg = JText::_('COM_NEWSFEEDS_ERRORS_FEED_NOT_RETRIEVED');
  170.         }
  171.         catch (RunTimeException $e)
  172.         {
  173.             $msg = JText::_('COM_NEWSFEEDS_ERRORS_FEED_NOT_RETRIEVED');
  174.         }
  175.         if (empty($this->rssDoc))
  176.         {
  177.             $msg = JText::_('COM_NEWSFEEDS_ERRORS_FEED_NOT_RETRIEVED');
  178.         }
  179.  
  180.         $feed_display_order = $params->get('feed_display_order', 'des');
  181.         if ($feed_display_order == 'asc')
  182.         {
  183.             $newsfeed->items = array_reverse($newsfeed->items);
  184.         }
  185.  
  186.         //Escape strings for HTML output
  187.         $this->pageclass_sfx = htmlspecialchars($params->get('pageclass_sfx'));
  188.  
  189.         $this->assignRef('params', $params);
  190.         $this->assignRef('newsfeed', $newsfeed);
  191.         $this->assignRef('state', $state);
  192.         $this->assignRef('item', $item);
  193.         $this->assignRef('user', $user);
  194.         if (!empty($msg))
  195.         {
  196.             $this->assignRef('msg', $msg);
  197.         }
  198.         $this->print = $print;
  199.  
  200.         $item->tags = new JHelperTags;
  201.         $item->tags->getItemTags('com_newsfeeds.newsfeed', $item->id);
  202.  
  203.         // Increment the hit counter of the newsfeed.
  204.         $model = $this->getModel();
  205.         $model->hit();
  206.  
  207.         $this->_prepareDocument();
  208.  
  209.         return parent::display($tpl);
  210.     }
  211.  
  212.     /**
  213.      * Prepares the document
  214.      *
  215.      * @return  void 
  216.      * @since   1.6
  217.      */
  218.     protected function _prepareDocument()
  219.     {
  220.         $app        = JFactory::getApplication();
  221.         $menus        = $app->getMenu();
  222.         $pathway    = $app->getPathway();
  223.         $title        = null;
  224.  
  225.         // Because the application sets a default page title,
  226.         // we need to get it from the menu item itself
  227.         $menu = $menus->getActive();
  228.  
  229.         if ($menu)
  230.         {
  231.             $this->params->def('page_heading', $this->params->get('page_title', $menu->title));
  232.         }
  233.         else
  234.         {
  235.             $this->params->def('page_heading', JText::_('COM_NEWSFEEDS_DEFAULT_PAGE_TITLE'));
  236.         }
  237.  
  238.         $title = $this->params->get('page_title', '');
  239.  
  240.         $id = (int) @$menu->query['id'];
  241.  
  242.         // if the menu item does not concern this newsfeed
  243.         if ($menu && ($menu->query['option'] != 'com_newsfeeds' || $menu->query['view'] != 'newsfeed' || $id != $this->item->id))
  244.         {
  245.             // If this is not a single newsfeed menu item, set the page title to the newsfeed title
  246.             if ($this->item->name)
  247.             {
  248.                 $title = $this->item->name;
  249.             }
  250.  
  251.             $path = array(array('title' => $this->item->name, 'link' => ''));
  252.             $category = JCategories::getInstance('Newsfeeds')->get($this->item->catid);
  253.             while (($menu->query['option'] != 'com_newsfeeds' || $menu->query['view'] == 'newsfeed' || $id != $category->id) && $category->id > 1)
  254.             {
  255.                 $path[] = array('title' => $category->title, 'link' => NewsfeedsHelperRoute::getCategoryRoute($category->id));
  256.                 $category = $category->getParent();
  257.             }
  258.             $path = array_reverse($path);
  259.             foreach ($path as $item)
  260.             {
  261.                 $pathway->addItem($item['title'], $item['link']);
  262.             }
  263.         }
  264.  
  265.         if (empty($title))
  266.         {
  267.             $title = $app->getCfg('sitename');
  268.         }
  269.         elseif ($app->getCfg('sitename_pagetitles', 0) == 1)
  270.         {
  271.             $title = JText::sprintf('JPAGETITLE', $app->getCfg('sitename'), $title);
  272.         }
  273.         elseif ($app->getCfg('sitename_pagetitles', 0) == 2)
  274.         {
  275.             $title = JText::sprintf('JPAGETITLE', $title, $app->getCfg('sitename'));
  276.         }
  277.         if (empty($title))
  278.         {
  279.             $title = $this->item->name;
  280.         }
  281.         $this->document->setTitle($title);
  282.  
  283.         if ($this->item->metadesc)
  284.         {
  285.             $this->document->setDescription($this->item->metadesc);
  286.         }
  287.         elseif (!$this->item->metadesc && $this->params->get('menu-meta_description'))
  288.         {
  289.             $this->document->setDescription($this->params->get('menu-meta_description'));
  290.         }
  291.  
  292.         if ($this->item->metakey)
  293.         {
  294.             $this->document->setMetadata('keywords', $this->item->metakey);
  295.         }
  296.         elseif (!$this->item->metakey && $this->params->get('menu-meta_keywords'))
  297.         {
  298.             $this->document->setMetadata('keywords', $this->params->get('menu-meta_keywords'));
  299.         }
  300.  
  301.         if ($this->params->get('robots'))
  302.         {
  303.             $this->document->setMetadata('robots', $this->params->get('robots'));
  304.         }
  305.  
  306.         if ($app->getCfg('MetaTitle') == '1')
  307.         {
  308.             $this->document->setMetaData('title', $this->item->name);
  309.         }
  310.  
  311.         if ($app->getCfg('MetaAuthor') == '1')
  312.         {
  313.             $this->document->setMetaData('author', $this->item->author);
  314.         }
  315.  
  316.         $mdata = $this->item->metadata->toArray();
  317.         foreach ($mdata as $k => $v)
  318.         {
  319.             if ($v)
  320.             {
  321.                 $this->document->setMetadata($k, $v);
  322.             }
  323.         }
  324.     }
  325. }

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