Source for file controller.php

Documentation is available at controller.php

  1. <?php
  2. /**
  3.  * @package     Joomla.Administrator
  4.  * @subpackage  com_categories
  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.  * Categories view class for the Category package.
  14.  *
  15.  * @package     Joomla.Administrator
  16.  * @subpackage  com_categories
  17.  * @since       1.6
  18.  */
  19. class CategoriesController extends JControllerLegacy
  20. {
  21.     /**
  22.      * @var    string  The extension for which the categories apply.
  23.      * @since  1.6
  24.      */
  25.     protected $extension;
  26.  
  27.     /**
  28.      * Constructor.
  29.      *
  30.      * @param   array  $config  An optional associative array of configuration settings.
  31.      *
  32.      * @see     JController
  33.      * @since   1.6
  34.      */
  35.     public function __construct($config = array())
  36.     {
  37.         parent::__construct($config);
  38.  
  39.         // Guess the JText message prefix. Defaults to the option.
  40.         if (empty($this->extension))
  41.         {
  42.             $this->extension = $this->input->get('extension', 'com_content');
  43.         }
  44.     }
  45.  
  46.     /**
  47.      * Method to display a view.
  48.      *
  49.      * @param   boolean      $cachable   If true, the view output will be cached
  50.      * @param   array        $urlparams  An array of safe url parameters and their variable types, for valid values see {@link JFilterInput::clean()}.
  51.      *
  52.      * @return  JController  This object to support chaining.
  53.      *
  54.      * @since   1.5
  55.      */
  56.     public function display($cachable = false, $urlparams = false)
  57.     {
  58.         // Get the document object.
  59.         $document = JFactory::getDocument();
  60.  
  61.         // Set the default view name and format from the Request.
  62.         $vName   = $this->input->get('view', 'categories');
  63.         $vFormat = $document->getType();
  64.         $lName   = $this->input->get('layout', 'default');
  65.         $id      = $this->input->getInt('id');
  66.  
  67.         // Check for edit form.
  68.         if ($vName == 'category' && $lName == 'edit' && !$this->checkEditId('com_categories.edit.category', $id))
  69.         {
  70.             // Somehow the person just went to the form - we don't allow that.
  71.             $this->setError(JText::sprintf('JLIB_APPLICATION_ERROR_UNHELD_ID', $id));
  72.             $this->setMessage($this->getError(), 'error');
  73.             $this->setRedirect(JRoute::_('index.php?option=com_categories&view=categories&extension=' . $this->extension, false));
  74.  
  75.             return false;
  76.         }
  77.  
  78.         // Get and render the view.
  79.         if ($view = $this->getView($vName, $vFormat))
  80.         {
  81.             // Get the model for the view.
  82.             $model = $this->getModel($vName, 'CategoriesModel', array('name' => $vName . '.' . substr($this->extension, 4)));
  83.  
  84.             // Push the model into the view (as default).
  85.             $view->setModel($model, true);
  86.             $view->setLayout($lName);
  87.  
  88.             // Push document object into the view.
  89.             $view->document = $document;
  90.  
  91.             // Load the submenu.
  92.             require_once JPATH_COMPONENT . '/helpers/categories.php';
  93.  
  94.             CategoriesHelper::addSubmenu($model->getState('filter.extension'));
  95.             $view->display();
  96.         }
  97.  
  98.         return $this;
  99.     }
  100. }

Documentation generated on Tue, 19 Nov 2013 14:57:04 +0100 by phpDocumentor 1.4.3