Source for file module.php

Documentation is available at module.php

  1. <?php
  2. /**
  3.  * @package     Joomla.Administrator
  4.  * @subpackage  com_modules
  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.  * Module controller class.
  14.  *
  15.  * @package     Joomla.Administrator
  16.  * @subpackage  com_modules
  17.  * @since       1.6
  18.  */
  19. class ModulesControllerModule extends JControllerForm
  20. {
  21.     /**
  22.      * Override parent add method.
  23.      *
  24.      * @return  mixed  True if the record can be added, a JError object if not.
  25.      *
  26.      * @since   1.6
  27.      */
  28.     public function add()
  29.     {
  30.         $app = JFactory::getApplication();
  31.  
  32.         // Get the result of the parent method. If an error, just return it.
  33.         $result = parent::add();
  34.         if ($result instanceof Exception)
  35.         {
  36.             return $result;
  37.         }
  38.  
  39.         // Look for the Extension ID.
  40.         $extensionId = $app->input->get('eid', 0, 'int');
  41.         if (empty($extensionId))
  42.         {
  43.             $this->setRedirect(JRoute::_('index.php?option='.$this->option.'&view='.$this->view_item.'&layout=edit', false));
  44.             return JError::raiseWarning(500, JText::_('COM_MODULES_ERROR_INVALID_EXTENSION'));
  45.         }
  46.  
  47.         $app->setUserState('com_modules.add.module.extension_id', $extensionId);
  48.         $app->setUserState('com_modules.add.module.params', null);
  49.  
  50.         // Parameters could be coming in for a new item, so let's set them.
  51.         $params = $app->input->get('params', array(), 'array');
  52.         $app->setUserState('com_modules.add.module.params', $params);
  53.     }
  54.  
  55.     /**
  56.      * Override parent cancel method to reset the add module state.
  57.      *
  58.      * @param   string  $key  The name of the primary key of the URL variable.
  59.      *
  60.      * @return  boolean  True if access level checks pass, false otherwise.
  61.      *
  62.      * @since   1.6
  63.      */
  64.     public function cancel($key = null)
  65.     {
  66.         $app = JFactory::getApplication();
  67.  
  68.         $result = parent::cancel();
  69.  
  70.         $app->setUserState('com_modules.add.module.extension_id', null);
  71.         $app->setUserState('com_modules.add.module.params', null);
  72.  
  73.         return $result;
  74.     }
  75.  
  76.     /**
  77.      * Override parent allowSave method.
  78.      *
  79.      * @param   array   $data  An array of input data.
  80.      * @param   string  $key   The name of the key for the primary key.
  81.      *
  82.      * @return  boolean 
  83.      *
  84.      * @since   1.6
  85.      */
  86.     protected function allowSave($data, $key = 'id')
  87.     {
  88.         // use custom position if selected
  89.         if (isset($data['custom_position']))
  90.         {
  91.             if (empty($data['position']))
  92.             {
  93.                 $data['position'] = $data['custom_position'];
  94.             }
  95.  
  96.             unset($data['custom_position']);
  97.         }
  98.  
  99.         return parent::allowSave($data, $key);
  100.     }
  101.  
  102.     /**
  103.      * Method override to check if you can edit an existing record.
  104.      *
  105.      * @param   array   $data  An array of input data.
  106.      * @param   string  $key   The name of the key for the primary key.
  107.      *
  108.      * @return  boolean 
  109.      *
  110.      * @since   3.2
  111.      */
  112.     protected function allowEdit($data = array(), $key = 'id')
  113.     {
  114.         // Initialise variables.
  115.         $recordId = (int) isset($data[$key]) ? $data[$key] : 0;
  116.         $user = JFactory::getUser();
  117.         $userId = $user->get('id');
  118.  
  119.         // Check general edit permission first.
  120.         if ($user->authorise('core.edit', 'com_modules.module.' . $recordId))
  121.         {
  122.             return true;
  123.         }
  124.  
  125.         // Since there is no asset tracking, revert to the component permissions.
  126.         return parent::allowEdit($data, $key);
  127.     }
  128.  
  129.     /**
  130.      * Method to run batch operations.
  131.      *
  132.      * @param   string  $model  The model
  133.      *
  134.      * @return  boolean  True on success.
  135.      *
  136.      * @since   1.7
  137.      */
  138.     public function batch($model = null)
  139.     {
  140.         JSession::checkToken() or jexit(JText::_('JINVALID_TOKEN'));
  141.  
  142.         // Set the model
  143.         $model    = $this->getModel('Module', '', array());
  144.  
  145.         // Preset the redirect
  146.         $this->setRedirect(JRoute::_('index.php?option=com_modules&view=modules'.$this->getRedirectToListAppend(), false));
  147.  
  148.         return parent::batch($model);
  149.     }
  150.  
  151.     /**
  152.      * Function that allows child controller access to model data after the data has been saved.
  153.      *
  154.      * @param   JModelLegacy  $model      The data model object.
  155.      * @param   array         $validData  The validated data.
  156.      *
  157.      * @return  void 
  158.      *
  159.      * @since   1.6
  160.      */
  161.     protected function postSaveHook(JModelLegacy $model, $validData = array())
  162.     {
  163.         $app = JFactory::getApplication();
  164.         $task = $this->getTask();
  165.  
  166.         switch ($task)
  167.         {
  168.             case 'save2new':
  169.                 $app->setUserState('com_modules.add.module.extension_id', $model->getState('module.extension_id'));
  170.                 break;
  171.  
  172.             default:
  173.                 $app->setUserState('com_modules.add.module.extension_id', null);
  174.                 break;
  175.         }
  176.  
  177.         $app->setUserState('com_modules.add.module.params', null);
  178.     }
  179. }

Documentation generated on Tue, 19 Nov 2013 15:08:43 +0100 by phpDocumentor 1.4.3