1 <?php
  2 /**
  3  * @package     Joomla.Libraries
  4  * @subpackage  Menu
  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  * JMenu class
 14  *
 15  * @since  1.5
 16  */
 17 class JMenuSite extends JMenu
 18 {
 19     /**
 20      * Application object
 21      *
 22      * @var    JApplicationCms
 23      * @since  3.5
 24      */
 25     protected $app;
 26 
 27     /**
 28      * Database driver
 29      *
 30      * @var    JDatabaseDriver
 31      * @since  3.5
 32      */
 33     protected $db;
 34 
 35     /**
 36      * Language object
 37      *
 38      * @var    JLanguage
 39      * @since  3.5
 40      */
 41     protected $language;
 42 
 43     /**
 44      * Class constructor
 45      *
 46      * @param   array  $options  An array of configuration options.
 47      *
 48      * @since   1.5
 49      */
 50     public function __construct($options = array())
 51     {
 52         // Extract the internal dependencies before calling the parent constructor since it calls $this->load()
 53         $this->app      = isset($options['app']) && $options['app'] instanceof JApplicationCms ? $options['app'] : JFactory::getApplication();
 54         $this->db       = isset($options['db']) && $options['db'] instanceof JDatabaseDriver ? $options['db'] : JFactory::getDbo();
 55         $this->language = isset($options['language']) && $options['language'] instanceof JLanguage ? $options['language'] : JFactory::getLanguage();
 56 
 57         parent::__construct($options);
 58     }
 59 
 60     /**
 61      * Loads the entire menu table into memory.
 62      *
 63      * @return  boolean  True on success, false on failure
 64      *
 65      * @since   1.5
 66      */
 67     public function load()
 68     {
 69         // For PHP 5.3 compat we can't use $this in the lambda function below
 70         $db = $this->db;
 71 
 72         $loader = function () use ($db)
 73         {
 74             $query = $db->getQuery(true)
 75                 ->select('m.id, m.menutype, m.title, m.alias, m.note, m.path AS route, m.link, m.type, m.level, m.language')
 76                 ->select($db->quoteName('m.browserNav') . ', m.access, m.params, m.home, m.img, m.template_style_id, m.component_id, m.parent_id')
 77                 ->select('e.element as component')
 78                 ->from('#__menu AS m')
 79                 ->join('LEFT', '#__extensions AS e ON m.component_id = e.extension_id')
 80                 ->where('m.published = 1')
 81                 ->where('m.parent_id > 0')
 82                 ->where('m.client_id = 0')
 83                 ->order('m.lft');
 84 
 85             // Set the query
 86             $db->setQuery($query);
 87 
 88             return $db->loadObjectList('id', 'JMenuItem');
 89         };
 90 
 91         try
 92         {
 93             /** @var JCacheControllerCallback $cache */
 94             $cache = JFactory::getCache('com_menus', 'callback');
 95 
 96             $this->_items = $cache->get($loader, array(), md5(get_class($this)), false);
 97         }
 98         catch (JCacheException $e)
 99         {
100             try
101             {
102                 $this->_items = $loader();
103             }
104             catch (JDatabaseExceptionExecuting $databaseException)
105             {
106                 JError::raiseWarning(500, JText::sprintf('JERROR_LOADING_MENUS', $databaseException->getMessage()));
107 
108                 return false;
109             }
110         }
111         catch (JDatabaseExceptionExecuting $e)
112         {
113             JError::raiseWarning(500, JText::sprintf('JERROR_LOADING_MENUS', $e->getMessage()));
114 
115             return false;
116         }
117 
118         foreach ($this->_items as &$item)
119         {
120             // Get parent information.
121             $parent_tree = array();
122 
123             if (isset($this->_items[$item->parent_id]))
124             {
125                 $parent_tree  = $this->_items[$item->parent_id]->tree;
126             }
127 
128             // Create tree.
129             $parent_tree[] = $item->id;
130             $item->tree = $parent_tree;
131 
132             // Create the query array.
133             $url = str_replace('index.php?', '', $item->link);
134             $url = str_replace('&amp;', '&', $url);
135 
136             parse_str($url, $item->query);
137         }
138 
139         return true;
140     }
141 
142     /**
143      * Gets menu items by attribute
144      *
145      * @param   string   $attributes  The field name
146      * @param   string   $values      The value of the field
147      * @param   boolean  $firstonly   If true, only returns the first item found
148      *
149      * @return  JMenuItem|JMenuItem[]  An array of menu item objects or a single object if the $firstonly parameter is true
150      *
151      * @since   1.6
152      */
153     public function getItems($attributes, $values, $firstonly = false)
154     {
155         $attributes = (array) $attributes;
156         $values     = (array) $values;
157 
158         if ($this->app->isClient('site'))
159         {
160             // Filter by language if not set
161             if (($key = array_search('language', $attributes)) === false)
162             {
163                 if (JLanguageMultilang::isEnabled())
164                 {
165                     $attributes[] = 'language';
166                     $values[]     = array(JFactory::getLanguage()->getTag(), '*');
167                 }
168             }
169             elseif ($values[$key] === null)
170             {
171                 unset($attributes[$key], $values[$key]);
172             }
173 
174             // Filter by access level if not set
175             if (($key = array_search('access', $attributes)) === false)
176             {
177                 $attributes[] = 'access';
178                 $values[] = $this->user->getAuthorisedViewLevels();
179             }
180             elseif ($values[$key] === null)
181             {
182                 unset($attributes[$key], $values[$key]);
183             }
184         }
185 
186         // Reset arrays or we get a notice if some values were unset
187         $attributes = array_values($attributes);
188         $values = array_values($values);
189 
190         return parent::getItems($attributes, $values, $firstonly);
191     }
192 
193     /**
194      * Get menu item by id
195      *
196      * @param   string  $language  The language code.
197      *
198      * @return  JMenuItem|null  The item object or null when not found for given language
199      *
200      * @since   1.6
201      */
202     public function getDefault($language = '*')
203     {
204         if (array_key_exists($language, $this->_default) && $this->app->isClient('site') && $this->app->getLanguageFilter())
205         {
206             return $this->_items[$this->_default[$language]];
207         }
208 
209         if (array_key_exists('*', $this->_default))
210         {
211             return $this->_items[$this->_default['*']];
212         }
213 
214         return;
215     }
216 }
217 

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.