menu.php 5.28 KB
<?php
// namespace administrator\components\com_jmap\framework\route;
/**
 *
* @package JMAP::FRAMEWORK::administrator::components::com_jmap
* @subpackage framework
* @subpackage route
* @author Joomla! Extensions Store
* @copyright (C) 2015 - Joomla! Extensions Store
* @license GNU/GPLv2 http://www.gnu.org/licenses/gpl-2.0.html
*/
defined ( '_JEXEC' ) or die ();

/**
 * Helper to route menu links
 *
 * @package JMAP::FRAMEWORK::administrator::components::com_jmap
 * @subpackage framework
 * @subpackage route
 * @since 2.3
 */
class JMapRouteMenu extends JObject {
	/**
	 * Array to hold the menu items
	 *
	 * @var array
	 * @since 11.1
	 */
	protected $_items = array ();
	
	/**
	 * Identifier of the default menu item
	 *
	 * @var integer
	 * @since 11.1
	 */
	protected $_default = array ();
	
	/**
	 * Identifier of the active menu item
	 *
	 * @var integer
	 * @since 11.1
	 */
	protected $_active = 0;
	
	/**
	 * Class constructor
	 *
	 * @param array $options
	 *        	An array of configuration options.
	 *        	
	 * @since 11.1
	 */
	public function __construct($options = array()) {
		// Load the menu items
		$this->load ();
		
		foreach ( $this->_items as $item ) {
			if ($item ['home']) {
				$this->_default [trim ( $item ['language'] )] = $item ['id'];
			}
			
			// Decode the item params
			$result = new JRegistry ();
			$result->loadString ( $item ['params'] );
			$item ['params'] = $result;
		}
	}
	
	/**
	 * Get menu item by id.
	 *
	 * @return object The item object.
	 *        
	 * @since 11.1
	 */
	public function getActive() {
		if ($this->_active) {
			$item = &$this->_items [$this->_active];
			return $item;
		}
		
		return null;
	}
	
	/**
	 * Gets menu items by attribute
	 *
	 * @param mixed $attributes
	 *        	The field name(s).
	 * @param mixed $values
	 *        	The value(s) of the field. If an array, need to match field names
	 *        	each attribute may have multiple values to lookup for.
	 * @param boolean $firstonly
	 *        	If true, only returns the first item found
	 *        	
	 * @return array
	 *
	 * @since 11.1
	 */
	public function getItems($attributes, $values, $firstonly = false) {
		$items = array ();
		$attributes = ( array ) $attributes;
		$values = ( array ) $values;
		$app = JApplicationCms::getInstance ( 'site' );
		
		if ($app->isSite ()) {
			// Filter by language if not set
			if (($key = array_search ( 'language', $attributes )) === false) {
				if ($app->getLanguageFilter ()) {
					$attributes [] = 'language';
					$values [] = array (
							JFactory::getLanguage ()->getTag (),
							'*' 
					);
				}
			} elseif ($values [$key] === null) {
				unset ( $attributes [$key] );
				unset ( $values [$key] );
			}
			
			// Filter by access level if not set
			if (($key = array_search ( 'access', $attributes )) === false) {
				$attributes [] = 'access';
				$values [] = JFactory::getUser ()->getAuthorisedViewLevels ();
			} elseif ($values [$key] === null) {
				unset ( $attributes [$key] );
				unset ( $values [$key] );
			}
		}
		
		foreach ( $this->_items as $item ) {
			if (! is_array ( $item )) {
				continue;
			}
			
			$test = true;
			for($i = 0, $count = count ( $attributes ); $i < $count; $i ++) {
				if (is_array ( $values [$i] )) {
					if (! in_array ( $item [$attributes [$i]], $values [$i] )) {
						$test = false;
						break;
					}
				} else {
					if ($item [$attributes [$i]] != $values [$i]) {
						$test = false;
						break;
					}
				}
			}
			
			if ($test) {
				if ($firstonly) {
					return $item;
				}
				
				$items [$item ['id']] = $item;
			}
		}
		
		return $items;
	}
	
	/**
	 * Gets the parameter object for a certain menu item
	 *
	 * @param integer $id
	 *        	The item id
	 *        	
	 * @return JRegistry A JRegistry object
	 *        
	 * @since 11.1
	 */
	public function getParams($id) {
		if ($menu = $this->getItem ( $id )) {
			return $menu->params;
		} else {
			return new JRegistry ();
		}
	}
	
	/**
	 * Loads the menu items
	 *
	 * @return array
	 *
	 * @since 11.1
	 */
	public function load() {
		// Initialise variables.
		$db = JFactory::getDbo ();
		$app = JApplicationCms::getInstance ( 'site' );
		$query = $db->getQuery ( true );
		
		$query->select ( 'm.id, m.menutype, m.title, m.alias, m.note, m.path AS route, m.link, m.type, m.level, m.language' );
		$query->select ( 'm.browserNav, m.access, m.params, m.home, m.img, m.template_style_id, m.component_id, m.parent_id' );
		$query->select ( 'e.element as component' );
		$query->from ( '#__menu AS m' );
		$query->leftJoin ( '#__extensions AS e ON m.component_id = e.extension_id' );
		$query->where ( 'm.published = 1' );
		$query->where ( 'm.parent_id > 0' );
		$query->where ( 'm.client_id = 0' );
		$query->order ( 'm.lft' );
		
		// Set the query
		$db->setQuery ( $query );
		if (! ($this->_items = $db->loadAssocList ( 'id' ))) {
			return false;
		}
		
		foreach ( $this->_items as &$item ) {
			// Get parent information.
			$parent_tree = array ();
			if (isset ( $this->_items [$item ['parent_id']] )) {
				$parent_tree = $this->_items [$item ['parent_id']] ['tree'];
			}
			
			// Create tree.
			$parent_tree [] = $item ['id'];
			$item ['tree'] = $parent_tree;
			
			// Create the query array.
			$url = str_replace ( 'index.php?', '', $item ['link'] );
			$url = str_replace ( '&amp;', '&', $url );
			
			parse_str ( $url, $item ['query'] );
		}
	}
}