1 <?php
  2 /**
  3  * @package     Joomla.Legacy
  4  * @subpackage  View
  5  *
  6  * @copyright   Copyright (C) 2005 - 2017 Open Source Matters, Inc. All rights reserved.
  7  * @license     GNU General Public License version 2 or later; see LICENSE.txt
  8  */
  9 
 10 defined('JPATH_PLATFORM') or die;
 11 
 12 /**
 13  * Base HTML View class for the a Category list
 14  *
 15  * @since  3.2
 16  */
 17 class JViewCategory extends JViewLegacy
 18 {
 19     /**
 20      * State data
 21      *
 22      * @var    \Joomla\Registry\Registry
 23      * @since  3.2
 24      */
 25     protected $state;
 26 
 27     /**
 28      * Category items data
 29      *
 30      * @var    array
 31      * @since  3.2
 32      */
 33     protected $items;
 34 
 35     /**
 36      * The category model object for this category
 37      *
 38      * @var    JModelCategory
 39      * @since  3.2
 40      */
 41     protected $category;
 42 
 43     /**
 44      * The list of other categories for this extension.
 45      *
 46      * @var    array
 47      * @since  3.2
 48      */
 49     protected $categories;
 50 
 51     /**
 52      * Pagination object
 53      *
 54      * @var    JPagination
 55      * @since  3.2
 56      */
 57     protected $pagination;
 58 
 59     /**
 60      * Child objects
 61      *
 62      * @var    array
 63      * @since  3.2
 64      */
 65     protected $children;
 66 
 67     /**
 68      * The name of the extension for the category
 69      *
 70      * @var    string
 71      * @since  3.2
 72      */
 73     protected $extension;
 74 
 75     /**
 76      * The name of the view to link individual items to
 77      *
 78      * @var    string
 79      * @since  3.2
 80      */
 81     protected $viewName;
 82 
 83     /**
 84      * Default title to use for page title
 85      *
 86      * @var    string
 87      * @since  3.2
 88      */
 89     protected $defaultPageTitle;
 90 
 91     /**
 92      * Whether to run the standard Joomla plugin events.
 93      * Off by default for b/c
 94      *
 95      * @var    bool
 96      * @since  3.5
 97      */
 98     protected $runPlugins = false;
 99 
100     /**
101      * Method with common display elements used in category list displays
102      *
103      * @return  boolean|JException|void  Boolean false or JException instance on error, nothing otherwise
104      *
105      * @since   3.2
106      */
107     public function commonCategoryDisplay()
108     {
109         $app    = JFactory::getApplication();
110         $user   = JFactory::getUser();
111         $params = $app->getParams();
112 
113         // Get some data from the models
114         $model       = $this->getModel();
115         $paramsModel = $model->getState('params');
116         
117         $paramsModel->set('check_access_rights', 0);
118         $model->setState('params', $paramsModel);
119 
120         $state       = $this->get('State');
121         $category    = $this->get('Category');
122         $children    = $this->get('Children');
123         $parent      = $this->get('Parent');
124 
125         if ($category == false)
126         {
127             return JError::raiseError(404, JText::_('JGLOBAL_CATEGORY_NOT_FOUND'));
128         }
129 
130         if ($parent == false)
131         {
132             return JError::raiseError(404, JText::_('JGLOBAL_CATEGORY_NOT_FOUND'));
133         }
134         
135         // Check whether category access level allows access.
136         $groups = $user->getAuthorisedViewLevels();
137         
138         if (!in_array($category->access, $groups))
139         {
140             return JError::raiseError(403, JText::_('JERROR_ALERTNOAUTHOR'));
141         }
142 
143         $items      = $this->get('Items');
144         $pagination = $this->get('Pagination');
145 
146         // Check for errors.
147         if (count($errors = $this->get('Errors')))
148         {
149             JError::raiseError(500, implode("\n", $errors));
150 
151             return false;
152         }
153 
154         // Setup the category parameters.
155         $cparams          = $category->getParams();
156         $category->params = clone $params;
157         $category->params->merge($cparams);
158 
159         $children = array($category->id => $children);
160 
161         // Escape strings for HTML output
162         $this->pageclass_sfx = htmlspecialchars($params->get('pageclass_sfx'));
163 
164         if ($this->runPlugins)
165         {
166             JPluginHelper::importPlugin('content');
167 
168             foreach ($items as $itemElement)
169             {
170                 $itemElement = (object) $itemElement;
171                 $itemElement->event = new stdClass;
172 
173                 // For some plugins.
174                 !empty($itemElement->description)? $itemElement->text = $itemElement->description : $itemElement->text = null;
175 
176                 $dispatcher = JEventDispatcher::getInstance();
177 
178                 $dispatcher->trigger('onContentPrepare', array($this->extension . '.category', &$itemElement, &$itemElement->params, 0));
179 
180                 $results = $dispatcher->trigger('onContentAfterTitle', array($this->extension . '.category', &$itemElement, &$itemElement->core_params, 0));
181                 $itemElement->event->afterDisplayTitle = trim(implode("\n", $results));
182 
183                 $results = $dispatcher->trigger('onContentBeforeDisplay', array($this->extension . '.category', &$itemElement, &$itemElement->core_params, 0));
184                 $itemElement->event->beforeDisplayContent = trim(implode("\n", $results));
185 
186                 $results = $dispatcher->trigger('onContentAfterDisplay', array($this->extension . '.category', &$itemElement, &$itemElement->core_params, 0));
187                 $itemElement->event->afterDisplayContent = trim(implode("\n", $results));
188 
189                 if ($itemElement->text)
190                 {
191                     $itemElement->description = $itemElement->text;
192                 }
193             }
194         }
195 
196         $maxLevel         = $params->get('maxLevel', -1) < 0 ? PHP_INT_MAX : $params->get('maxLevel', PHP_INT_MAX);
197         $this->maxLevel   = &$maxLevel;
198         $this->state      = &$state;
199         $this->items      = &$items;
200         $this->category   = &$category;
201         $this->children   = &$children;
202         $this->params     = &$params;
203         $this->parent     = &$parent;
204         $this->pagination = &$pagination;
205         $this->user       = &$user;
206 
207         // Check for layout override only if this is not the active menu item
208         // If it is the active menu item, then the view and category id will match
209         $active = $app->getMenu()->getActive();
210 
211         if ((!$active) || ((strpos($active->link, 'view=category') === false) || (strpos($active->link, '&id=' . (string) $this->category->id) === false)))
212         {
213             if ($layout = $category->params->get('category_layout'))
214             {
215                 $this->setLayout($layout);
216             }
217         }
218         elseif (isset($active->query['layout']))
219         {
220             // We need to set the layout in case this is an alternative menu item (with an alternative layout)
221             $this->setLayout($active->query['layout']);
222         }
223 
224         $this->category->tags = new JHelperTags;
225         $this->category->tags->getItemTags($this->extension . '.category', $this->category->id);
226     }
227 
228     /**
229      * Execute and display a template script.
230      *
231      * @param   string  $tpl  The name of the template file to parse; automatically searches through the template paths.
232      *
233      * @return  mixed  A string if successful, otherwise an Error object.
234      *
235      * @since   3.2
236      */
237     public function display($tpl = null)
238     {
239         $this->prepareDocument();
240 
241         return parent::display($tpl);
242     }
243 
244     /**
245      * Method to prepares the document
246      *
247      * @return  void
248      *
249      * @since   3.2
250      */
251     protected function prepareDocument()
252     {
253         $app           = JFactory::getApplication();
254         $menus         = $app->getMenu();
255         $this->pathway = $app->getPathway();
256         $title         = null;
257 
258         // Because the application sets a default page title, we need to get it from the menu item itself
259         $this->menu = $menus->getActive();
260 
261         if ($this->menu)
262         {
263             $this->params->def('page_heading', $this->params->get('page_title', $this->menu->title));
264         }
265         else
266         {
267             $this->params->def('page_heading', JText::_($this->defaultPageTitle));
268         }
269 
270         $title = $this->params->get('page_title', '');
271 
272         if (empty($title))
273         {
274             $title = $app->get('sitename');
275         }
276         elseif ($app->get('sitename_pagetitles', 0) == 1)
277         {
278             $title = JText::sprintf('JPAGETITLE', $app->get('sitename'), $title);
279         }
280         elseif ($app->get('sitename_pagetitles', 0) == 2)
281         {
282             $title = JText::sprintf('JPAGETITLE', $title, $app->get('sitename'));
283         }
284 
285         $this->document->setTitle($title);
286 
287         if ($this->params->get('menu-meta_description'))
288         {
289             $this->document->setDescription($this->params->get('menu-meta_description'));
290         }
291 
292         if ($this->params->get('menu-meta_keywords'))
293         {
294             $this->document->setMetadata('keywords', $this->params->get('menu-meta_keywords'));
295         }
296 
297         if ($this->params->get('robots'))
298         {
299             $this->document->setMetadata('robots', $this->params->get('robots'));
300         }
301     }
302 
303     /**
304      * Method to add an alternative feed link to a category layout.
305      *
306      * @return  void
307      *
308      * @since   3.2
309      */
310     protected function addFeed()
311     {
312         if ($this->params->get('show_feed_link', 1) == 1)
313         {
314             $link    = '&format=feed&limitstart=';
315             $attribs = array('type' => 'application/rss+xml', 'title' => 'RSS 2.0');
316             $this->document->addHeadLink(JRoute::_($link . '&type=rss'), 'alternate', 'rel', $attribs);
317             $attribs = array('type' => 'application/atom+xml', 'title' => 'Atom 1.0');
318             $this->document->addHeadLink(JRoute::_($link . '&type=atom'), 'alternate', 'rel', $attribs);
319         }
320     }
321 }
322 

Joomla! Framework TM API documentation generated by ApiGen 2.8.0
Joomla!® and Joomla! Framework™ are trademarks of Open Source Matters, Inc. in the United States and other countries.