Source for file menus.php

Documentation is available at menus.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.  * Menus component helper.
  14.  *
  15.  * @package     Joomla.Administrator
  16.  * @subpackage  com_menus
  17.  * @since       1.6
  18.  */
  19. class MenusHelper
  20. {
  21.     /**
  22.      * Defines the valid request variables for the reverse lookup.
  23.      */
  24.     protected static $_filter = array('option', 'view', 'layout');
  25.  
  26.     /**
  27.      * Configure the Linkbar.
  28.      *
  29.      * @param   string    The name of the active view.
  30.      */
  31.     public static function addSubmenu($vName)
  32.     {
  33.         JHtmlSidebar::addEntry(
  34.             JText::_('COM_MENUS_SUBMENU_MENUS'),
  35.             'index.php?option=com_menus&view=menus',
  36.             $vName == 'menus'
  37.         );
  38.         JHtmlSidebar::addEntry(
  39.             JText::_('COM_MENUS_SUBMENU_ITEMS'),
  40.             'index.php?option=com_menus&view=items',
  41.             $vName == 'items'
  42.         );
  43.     }
  44.  
  45.     /**
  46.      * Gets a list of the actions that can be performed.
  47.      *
  48.      * @param   integer  The menu ID.
  49.      *
  50.      * @return  JObject 
  51.      * @since   1.6
  52.      */
  53.     public static function getActions($parentId = 0)
  54.     {
  55.         $user = JFactory::getUser();
  56.         $result = new JObject;
  57.  
  58.         if (empty($parentId))
  59.         {
  60.             $assetName = 'com_menus';
  61.         }
  62.         else
  63.         {
  64.             $assetName = 'com_menus.item.' . (int) $parentId;
  65.         }
  66.  
  67.         $actions = JAccess::getActions('com_menus');
  68.  
  69.         foreach ($actions as $action)
  70.         {
  71.             $result->set($action->name, $user->authorise($action->name, $assetName));
  72.         }
  73.  
  74.         return $result;
  75.     }
  76.  
  77.     /**
  78.      * Gets a standard form of a link for lookups.
  79.      *
  80.      * @param   mixed    A link string or array of request variables.
  81.      *
  82.      * @return  mixed  A link in standard option-view-layout form, or false if the supplied response is invalid.
  83.      */
  84.     public static function getLinkKey($request)
  85.     {
  86.         if (empty($request))
  87.         {
  88.             return false;
  89.         }
  90.  
  91.         // Check if the link is in the form of index.php?...
  92.         if (is_string($request))
  93.         {
  94.             $args = array();
  95.             if (strpos($request, 'index.php') === 0)
  96.             {
  97.                 parse_str(parse_url(htmlspecialchars_decode($request), PHP_URL_QUERY), $args);
  98.             }
  99.             else
  100.             {
  101.                 parse_str($request, $args);
  102.             }
  103.             $request = $args;
  104.         }
  105.  
  106.         // Only take the option, view and layout parts.
  107.         foreach ($request as $name => $value)
  108.         {
  109.             if ((!in_array($name, self::$_filter)) && (!($name == 'task' && !array_key_exists('view', $request))))
  110.             {
  111.                 // Remove the variables we want to ignore.
  112.                 unset($request[$name]);
  113.             }
  114.         }
  115.  
  116.         ksort($request);
  117.  
  118.         return 'index.php?' . http_build_query($request, '', '&');
  119.     }
  120.  
  121.     /**
  122.      * Get the menu list for create a menu module
  123.      *
  124.      * @return    array    The menu array list
  125.      * @since        1.6
  126.      */
  127.     public static function getMenuTypes()
  128.     {
  129.         $db = JFactory::getDbo();
  130.         $query = $db->getQuery(true)
  131.             ->select('a.menutype')
  132.             ->from('#__menu_types AS a');
  133.         $db->setQuery($query);
  134.  
  135.         return $db->loadColumn();
  136.     }
  137.  
  138.     /**
  139.      * Get a list of menu links for one or all menus.
  140.      *
  141.      * @param   string    An option menu to filter the list on, otherwise all menu links are returned as a grouped array.
  142.      * @param   integer   An optional parent ID to pivot results around.
  143.      * @param   integer   An optional mode. If parent ID is set and mode=2, the parent and children are excluded from the list.
  144.      * @param   array     An optional array of states
  145.      */
  146.     public static function getMenuLinks($menuType = null, $parentId = 0, $mode = 0, $published = array(), $languages = array())
  147.     {
  148.         $db = JFactory::getDbo();
  149.         $query = $db->getQuery(true)
  150.             ->select('a.id AS value, a.title AS text, a.alias, a.level, a.menutype, a.type, a.template_style_id, a.checked_out')
  151.             ->from('#__menu AS a')
  152.             ->join('LEFT', $db->quoteName('#__menu') . ' AS b ON a.lft > b.lft AND a.rgt < b.rgt');
  153.  
  154.         // Filter by the type
  155.         if ($menuType)
  156.         {
  157.             $query->where('(a.menutype = ' . $db->quote($menuType) . ' OR a.parent_id = 0)');
  158.         }
  159.  
  160.         if ($parentId)
  161.         {
  162.             if ($mode == 2)
  163.             {
  164.                 // Prevent the parent and children from showing.
  165.                 $query->join('LEFT', '#__menu AS p ON p.id = ' . (int) $parentId)
  166.                     ->where('(a.lft <= p.lft OR a.rgt >= p.rgt)');
  167.             }
  168.         }
  169.  
  170.         if (!empty($languages))
  171.         {
  172.             if (is_array($languages))
  173.             {
  174.                 $languages = '(' . implode(',', array_map(array($db, 'quote'), $languages)) . ')';
  175.             }
  176.             $query->where('a.language IN ' . $languages);
  177.         }
  178.  
  179.         if (!empty($published))
  180.         {
  181.             if (is_array($published))
  182.             {
  183.                 $published = '(' . implode(',', $published) . ')';
  184.             }
  185.             $query->where('a.published IN ' . $published);
  186.         }
  187.  
  188.         $query->where('a.published != -2')
  189.             ->group('a.id, a.title, a.level, a.menutype, a.type, a.template_style_id, a.checked_out, a.lft')
  190.             ->order('a.lft ASC');
  191.  
  192.         // Get the options.
  193.         $db->setQuery($query);
  194.  
  195.         try
  196.         {
  197.             $links = $db->loadObjectList();
  198.         }
  199.         catch (RuntimeException $e)
  200.         {
  201.             JError::raiseWarning(500, $e->getMessage());
  202.             return false;
  203.         }
  204.  
  205.         if (empty($menuType))
  206.         {
  207.             // If the menutype is empty, group the items by menutype.
  208.             $query->clear()
  209.                 ->select('*')
  210.                 ->from('#__menu_types')
  211.                 ->where('menutype <> ' . $db->quote(''))
  212.                 ->order('title, menutype');
  213.             $db->setQuery($query);
  214.  
  215.             try
  216.             {
  217.                 $menuTypes = $db->loadObjectList();
  218.             }
  219.             catch (RuntimeException $e)
  220.             {
  221.                 JError::raiseWarning(500, $e->getMessage());
  222.                 return false;
  223.             }
  224.  
  225.             // Create a reverse lookup and aggregate the links.
  226.             $rlu = array();
  227.             foreach ($menuTypes as &$type)
  228.             {
  229.                 $rlu[$type->menutype] = & $type;
  230.                 $type->links = array();
  231.             }
  232.  
  233.             // Loop through the list of menu links.
  234.             foreach ($links as &$link)
  235.             {
  236.                 if (isset($rlu[$link->menutype]))
  237.                 {
  238.                     $rlu[$link->menutype]->links[] = & $link;
  239.  
  240.                     // Cleanup garbage.
  241.                     unset($link->menutype);
  242.                 }
  243.             }
  244.  
  245.             return $menuTypes;
  246.         }
  247.         else
  248.         {
  249.             return $links;
  250.         }
  251.     }
  252.  
  253.     static public function getAssociations($pk)
  254.     {
  255.         $associations = array();
  256.         $db = JFactory::getDbo();
  257.         $query = $db->getQuery(true)
  258.             ->from('#__menu as m')
  259.             ->join('INNER', '#__associations as a ON a.id=m.id AND a.context=' . $db->quote('com_menus.item'))
  260.             ->join('INNER', '#__associations as a2 ON a.key=a2.key')
  261.             ->join('INNER', '#__menu as m2 ON a2.id=m2.id')
  262.             ->where('m.id=' . (int) $pk)
  263.             ->select('m2.language, m2.id');
  264.         $db->setQuery($query);
  265.  
  266.         try
  267.         {
  268.             $menuitems = $db->loadObjectList('language');
  269.         }
  270.         catch (RuntimeException $e)
  271.         {
  272.             throw new Exception($e->getMessage(), 500);
  273.         }
  274.  
  275.         foreach ($menuitems as $tag => $item)
  276.         {
  277.             // Do not return itself as result
  278.             if ((int) $item->id != $pk)
  279.             {
  280.                 $associations[$tag] = $item->id;
  281.             }
  282.         }
  283.         return $associations;
  284.     }
  285. }

Documentation generated on Tue, 19 Nov 2013 15:07:58 +0100 by phpDocumentor 1.4.3