Source for file item.php

Documentation is available at item.php

  1. <?php
  2. /**
  3.  * @package     Joomla.Administrator
  4.  * @subpackage  com_menus
  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.  * The Menu Item Controller
  14.  *
  15.  * @package     Joomla.Administrator
  16.  * @subpackage  com_menus
  17.  * @since       1.6
  18.  */
  19. class MenusControllerItem extends JControllerForm
  20. {
  21.     /**
  22.      * Method to add a new menu item.
  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.         $context = 'com_menus.edit.item';
  32.  
  33.         $result = parent::add();
  34.         if ($result)
  35.         {
  36.             $app->setUserState($context . '.type', null);
  37.             $app->setUserState($context . '.link', null);
  38.  
  39.             $menuType = $app->getUserStateFromRequest($this->context . '.filter.menutype', 'menutype', 'mainmenu', 'cmd');
  40.  
  41.             $this->setRedirect(JRoute::_('index.php?option=com_menus&view=item&menutype=' . $menuType . $this->getRedirectToItemAppend(), false));
  42.         }
  43.  
  44.         return $result;
  45.     }
  46.  
  47.     /**
  48.      * Method to run batch operations.
  49.      *
  50.      * @param   object  $model  The model.
  51.      *
  52.      * @return  boolean     True if successful, false otherwise and internal error is set.
  53.      *
  54.      * @since   1.6
  55.      */
  56.     public function batch($model = null)
  57.     {
  58.         JSession::checkToken() or jexit(JText::_('JINVALID_TOKEN'));
  59.  
  60.         $model = $this->getModel('Item', '', array());
  61.  
  62.         // Preset the redirect
  63.         $this->setRedirect(JRoute::_('index.php?option=com_menus&view=items' . $this->getRedirectToListAppend(), false));
  64.  
  65.         return parent::batch($model);
  66.     }
  67.  
  68.     /**
  69.      * Method to cancel an edit.
  70.      *
  71.      * @param   string  $key  The name of the primary key of the URL variable.
  72.      *
  73.      * @return  boolean  True if access level checks pass, false otherwise.
  74.      *
  75.      * @since   1.6
  76.      */
  77.     public function cancel($key = null)
  78.     {
  79.         JSession::checkToken() or jexit(JText::_('JINVALID_TOKEN'));
  80.  
  81.         $app = JFactory::getApplication();
  82.         $context = 'com_menus.edit.item';
  83.         $result = parent::cancel();
  84.  
  85.         if ($result)
  86.         {
  87.             // Clear the ancillary data from the session.
  88.             $app->setUserState($context . '.type', null);
  89.             $app->setUserState($context . '.link', null);
  90.         }
  91.     }
  92.  
  93.     /**
  94.      * Method to edit an existing record.
  95.      *
  96.      * @param   string  $key     The name of the primary key of the URL variable.
  97.      * @param   string  $urlVar  The name of the URL variable if different from the primary key
  98.      *  (sometimes required to avoid router collisions).
  99.      *
  100.      * @return  boolean  True if access level check and checkout passes, false otherwise.
  101.      *
  102.      * @since   1.6
  103.      */
  104.     public function edit($key = null, $urlVar = null)
  105.     {
  106.         $app = JFactory::getApplication();
  107.         $result = parent::edit();
  108.  
  109.         if ($result)
  110.         {
  111.             // Push the new ancillary data into the session.
  112.             $app->setUserState('com_menus.edit.item.type', null);
  113.             $app->setUserState('com_menus.edit.item.link', null);
  114.         }
  115.  
  116.         return true;
  117.     }
  118.  
  119.     /**
  120.      * Method to save a record.
  121.      *
  122.      * @param   string  $key     The name of the primary key of the URL variable.
  123.      * @param   string  $urlVar  The name of the URL variable if different from the primary key (sometimes required to avoid router collisions).
  124.      *
  125.      * @return  boolean  True if successful, false otherwise.
  126.      *
  127.      * @since   1.6
  128.      */
  129.     public function save($key = null, $urlVar = null)
  130.     {
  131.         // Check for request forgeries.
  132.         JSession::checkToken() or jexit(JText::_('JINVALID_TOKEN'));
  133.  
  134.         $app      = JFactory::getApplication();
  135.         $model    = $this->getModel('Item', '', array());
  136.         $data     = $this->input->post->get('jform', array(), 'array');
  137.         $task     = $this->getTask();
  138.         $context  = 'com_menus.edit.item';
  139.         $recordId = $this->input->getInt('id');
  140.  
  141.         // Populate the row id from the session.
  142.         $data['id'] = $recordId;
  143.  
  144.         // The save2copy task needs to be handled slightly differently.
  145.         if ($task == 'save2copy')
  146.         {
  147.             // Check-in the original row.
  148.             if ($model->checkin($data['id']) === false)
  149.             {
  150.                 // Check-in failed, go back to the item and display a notice.
  151.                 $this->setMessage(JText::sprintf('JLIB_APPLICATION_ERROR_CHECKIN_FAILED', $model->getError()), 'warning');
  152.                 return false;
  153.             }
  154.  
  155.             // Reset the ID and then treat the request as for Apply.
  156.             $data['id'] = 0;
  157.             $data['associations'] = array();
  158.             $task = 'apply';
  159.         }
  160.  
  161.         // Validate the posted data.
  162.         // This post is made up of two forms, one for the item and one for params.
  163.         $form = $model->getForm($data);
  164.  
  165.         if (!$form)
  166.         {
  167.             JError::raiseError(500, $model->getError());
  168.  
  169.             return false;
  170.         }
  171.  
  172.         if ($data['type'] == 'url')
  173.         {
  174.              $data['link'] = str_replace(array('"', '>', '<'), '', $data['link']);
  175.  
  176.             if (strstr($data['link'], ':'))
  177.             {
  178.                 $segments = explode(':', $data['link']);
  179.                 $protocol = strtolower($segments[0]);
  180.                 $scheme = array('http', 'https', 'ftp', 'ftps', 'gopher', 'mailto', 'news', 'prospero', 'telnet', 'rlogin', 'tn3270', 'wais', 'url',
  181.                     'mid', 'cid', 'nntp', 'tel', 'urn', 'ldap', 'file', 'fax', 'modem', 'git');
  182.  
  183.                 if (!in_array($protocol, $scheme))
  184.                 {
  185.                     $app->enqueueMessage(JText::_('JLIB_APPLICATION_ERROR_SAVE_NOT_PERMITTED'), 'warning');
  186.                     $this->setRedirect(
  187.                          JRoute::_('index.php?option=' . $this->option . '&view=' . $this->view_item . $this->getRedirectToItemAppend($recordId), false)
  188.                     );
  189.  
  190.                     return false;
  191.                 }
  192.             }
  193.         }
  194.  
  195.         $data = $model->validate($form, $data);
  196.  
  197.         // Check for the special 'request' entry.
  198.         if ($data['type'] == 'component' && isset($data['request']) && is_array($data['request']) && !empty($data['request']))
  199.         {
  200.             $removeArgs = array();
  201.  
  202.             // Preprocess request fields to ensure that we remove not set or empty request params
  203.             $request = $form->getGroup('request');
  204.  
  205.             if (!empty($request))
  206.             {
  207.                 foreach ($request as $field)
  208.                 {
  209.                     $fieldName = $field->getAttribute('name');
  210.  
  211.                     if (!isset($data['request'][$fieldName]) || $data['request'][$fieldName] == '')
  212.                     {
  213.                         $removeArgs[$fieldName] = '';
  214.                     }
  215.                 }
  216.             }
  217.  
  218.             // Parse the submitted link arguments.
  219.             $args = array();
  220.             parse_str(parse_url($data['link'], PHP_URL_QUERY), $args);
  221.  
  222.             // Merge in the user supplied request arguments.
  223.             $args = array_merge($args, $data['request']);
  224.  
  225.             // Remove the unused request params
  226.             if (!empty($args) && !empty($removeArgs))
  227.             {
  228.                 $args = array_diff_key($args, $removeArgs);
  229.             }
  230.  
  231.             $data['link'] = 'index.php?' . urldecode(http_build_query($args, '', '&'));
  232.             unset($data['request']);
  233.         }
  234.  
  235.         // Check for validation errors.
  236.         if ($data === false)
  237.         {
  238.             // Get the validation messages.
  239.             $errors = $model->getErrors();
  240.  
  241.             // Push up to three validation messages out to the user.
  242.             for ($i = 0, $n = count($errors); $i < $n && $i < 3; $i++)
  243.             {
  244.                 if ($errors[$i] instanceof Exception)
  245.                 {
  246.                     $app->enqueueMessage($errors[$i]->getMessage(), 'warning');
  247.                 }
  248.                 else
  249.                 {
  250.                     $app->enqueueMessage($errors[$i], 'warning');
  251.                 }
  252.             }
  253.  
  254.             // Save the data in the session.
  255.             $app->setUserState('com_menus.edit.item.data', $data);
  256.  
  257.             // Redirect back to the edit screen.
  258.             $this->setRedirect(JRoute::_('index.php?option=' . $this->option . '&view=' . $this->view_item . $this->getRedirectToItemAppend($recordId), false));
  259.  
  260.             return false;
  261.         }
  262.  
  263.         // Attempt to save the data.
  264.         if (!$model->save($data))
  265.         {
  266.             // Save the data in the session.
  267.             $app->setUserState('com_menus.edit.item.data', $data);
  268.  
  269.             // Redirect back to the edit screen.
  270.             $this->setMessage(JText::sprintf('JLIB_APPLICATION_ERROR_SAVE_FAILED', $model->getError()), 'warning');
  271.             $this->setRedirect(JRoute::_('index.php?option=' . $this->option . '&view=' . $this->view_item . $this->getRedirectToItemAppend($recordId), false));
  272.  
  273.             return false;
  274.         }
  275.  
  276.         // Save succeeded, check-in the row.
  277.         if ($model->checkin($data['id']) === false)
  278.         {
  279.             // Check-in failed, go back to the row and display a notice.
  280.             $this->setMessage(JText::sprintf('JLIB_APPLICATION_ERROR_CHECKIN_FAILED', $model->getError()), 'warning');
  281.             $this->setRedirect(JRoute::_('index.php?option=' . $this->option . '&view=' . $this->view_item . $this->getRedirectToItemAppend($recordId), false));
  282.  
  283.             return false;
  284.         }
  285.  
  286.         $this->setMessage(JText::_('COM_MENUS_SAVE_SUCCESS'));
  287.  
  288.         // Redirect the user and adjust session state based on the chosen task.
  289.         switch ($task)
  290.         {
  291.             case 'apply':
  292.                 // Set the row data in the session.
  293.                 $recordId = $model->getState($this->context . '.id');
  294.                 $this->holdEditId($context, $recordId);
  295.                 $app->setUserState('com_menus.edit.item.data', null);
  296.                 $app->setUserState('com_menus.edit.item.type', null);
  297.                 $app->setUserState('com_menus.edit.item.link', null);
  298.  
  299.                 // Redirect back to the edit screen.
  300.                 $this->setRedirect(JRoute::_('index.php?option=' . $this->option . '&view=' . $this->view_item . $this->getRedirectToItemAppend($recordId), false));
  301.                 break;
  302.  
  303.             case 'save2new':
  304.                 // Clear the row id and data in the session.
  305.                 $this->releaseEditId($context, $recordId);
  306.                 $app->setUserState('com_menus.edit.item.data', null);
  307.                 $app->setUserState('com_menus.edit.item.type', null);
  308.                 $app->setUserState('com_menus.edit.item.link', null);
  309.                 $app->setUserState('com_menus.edit.item.menutype', $model->getState('item.menutype'));
  310.  
  311.                 // Redirect back to the edit screen.
  312.                 $this->setRedirect(JRoute::_('index.php?option=' . $this->option . '&view=' . $this->view_item . $this->getRedirectToItemAppend(), false));
  313.                 break;
  314.  
  315.             default:
  316.                 // Clear the row id and data in the session.
  317.                 $this->releaseEditId($context, $recordId);
  318.                 $app->setUserState('com_menus.edit.item.data', null);
  319.                 $app->setUserState('com_menus.edit.item.type', null);
  320.                 $app->setUserState('com_menus.edit.item.link', null);
  321.  
  322.                 // Redirect to the list screen.
  323.                 $this->setRedirect(JRoute::_('index.php?option=' . $this->option . '&view=' . $this->view_list . $this->getRedirectToListAppend(), false));
  324.                 break;
  325.         }
  326.     }
  327.  
  328.     /**
  329.      * Sets the type of the menu item currently being edited.
  330.      *
  331.      * @return  void 
  332.      *
  333.      * @since   1.6
  334.      */
  335.     public function setType()
  336.     {
  337.         $app = JFactory::getApplication();
  338.  
  339.         // Get the posted values from the request.
  340.         $data = $this->input->post->get('jform', array(), 'array');
  341.  
  342.         // Get the type.
  343.         $type = $data['type'];
  344.  
  345.         $type = json_decode(base64_decode($type));
  346.         $title = isset($type->title) ? $type->title : null;
  347.         $recordId = isset($type->id) ? $type->id : 0;
  348.  
  349.         $specialTypes = array('alias', 'separator', 'url', 'heading');
  350.         if (!in_array($title, $specialTypes))
  351.         {
  352.             $title = 'component';
  353.         }
  354.  
  355.         $app->setUserState('com_menus.edit.item.type', $title);
  356.         if ($title == 'component')
  357.         {
  358.             if (isset($type->request))
  359.             {
  360.                 $component = JComponentHelper::getComponent($type->request->option);
  361.                 $data['component_id'] = $component->id;
  362.  
  363.                 $app->setUserState('com_menus.edit.item.link', 'index.php?' . JUri::buildQuery((array) $type->request));
  364.             }
  365.         }
  366.         // If the type is alias you just need the item id from the menu item referenced.
  367.         elseif ($title == 'alias')
  368.         {
  369.             $app->setUserState('com_menus.edit.item.link', 'index.php?Itemid=');
  370.         }
  371.  
  372.         unset($data['request']);
  373.         $data['type'] = $title;
  374.         if ($this->input->get('fieldtype') == 'type')
  375.         {
  376.             $data['link'] = $app->getUserState('com_menus.edit.item.link');
  377.         }
  378.  
  379.         //Save the data in the session.
  380.         $app->setUserState('com_menus.edit.item.data', $data);
  381.  
  382.         $this->type = $type;
  383.         $this->setRedirect(JRoute::_('index.php?option=' . $this->option . '&view=' . $this->view_item . $this->getRedirectToItemAppend($recordId), false));
  384.     }
  385.  
  386.     /**
  387.      * Gets the parent items of the menu location currently.
  388.      *
  389.      * @return  void 
  390.      *
  391.      * @since   3.2
  392.      */
  393.     function getParentItem()
  394.     {
  395.         $app = JFactory::getApplication();
  396.  
  397.         $menutype = $this->input->get->get('menutype');
  398.  
  399.         $model = $this->getModel('Items', '', array());
  400.         $model->setState('filter.menutype', $menutype);
  401.         $model->setState('list.select', 'a.id, a.title, a.level');
  402.  
  403.         $results = $model->getItems();
  404.  
  405.         // Pad the option text with spaces using depth level as a multiplier.
  406.         for ($i = 0, $n = count($results); $i < $n; $i++)
  407.         {
  408.             $results[$i]->title = str_repeat('- ', $results[$i]->level) . $results[$i]->title;
  409.         }
  410.  
  411.         // Output a JSON object
  412.         echo json_encode($results);
  413.  
  414.         $app->close();
  415.     }
  416. }

Documentation generated on Tue, 19 Nov 2013 15:05:59 +0100 by phpDocumentor 1.4.3