Your IP : 216.73.216.43
<?php
/**
* @package FLEXIcontent
* @version 3.3
*
* @author Emmanuel Danan, Georgios Papadakis, Yannick Berges, others, see contributor page
* @link https://flexicontent.org
* @copyright Copyright © 2017, FLEXIcontent team, All Rights Reserved
* @license http://www.gnu.org/licenses/gpl-2.0.html GNU/GPL
*/
// no direct access
defined( '_JEXEC' ) or die( 'Restricted access' );
use Joomla\Registry\Registry;
use Joomla\CMS\Language\LanguageHelper;
// Component Helper
jimport('cms.component.helper');
//include constants file
require_once (JPATH_ADMINISTRATOR.DS.'components'.DS.'com_flexicontent'.DS.'defineconstants.php');
/**
* FLEXIcontent Component Route Helper
*
* @static
* @package Joomla
* @subpackage FLEXIcontent
* @since 1.5
*/
class FlexicontentHelperRoute
{
protected static $lookup = null;
protected static $lang_lookup = null;
protected static $add_url_lang = null;
protected static $interface_langs = null;
protected static $menuitems = null;
protected static $route_active_lang = null;
/**
* function to retrieve component menuitems only once;
*/
protected static function _setMenuitems($language = '*')
{
// Return already retrieved data
if ( isset(self::$menuitems[$language]) ) return self::$menuitems[$language];
// Get component
$component = JComponentHelper::getComponent('com_flexicontent');
// Get frontend menu items
$menus = JFactory::getApplication()->getMenu('site', array());
/**
* Limit to flexicontent component
*/
$attribs = array('component_id');
$values = array($component->id);
/**
* Limit to given language and ... to language ALL ('*')
*/
if ($language != '*')
{
$attribs[] = 'language';
$values[] = array($language, '*');
}
/**
* Getting menu items regardless language
* A. If language filtering is enabled, then menu items with currently active language - OR - language '*'
* B. If language filtering is disabled, then menu items of any language are returned
*/
else ;
/**
* Get frontend menu items pointing to the Flexicontent component and of language selected above
*/
$_menuitems = $menus->getItems($attribs, $values);
/**
* Assign menu item objects to per language array, and also index by menu id
*/
self::$menuitems[$language] = array();
if ($_menuitems) foreach ($_menuitems as $menuitem)
{
/**
* We do not need to check and skip menu items of non-allowed access level, since
* filtering by access levels of current user, is already done by JMenuSite::getItems()
*/
// Index by menu id
self::$menuitems[$language][$menuitem->id] = $menuitem;
}
return self::$menuitems[$language];
}
/**
* function to discover if a active menu item id is of flexicontent component
*/
protected static function _getActiveFlexiMenuitem()
{
static $active = null;
$active = JFactory::getApplication()->getMenu('site', array())->getActive();
if (!$active || !isset($active->query['option']) || $active->query['option'] !== 'com_flexicontent')
{
$active = false;
}
return $active;
}
/**
* function to discover a default item id only once
*/
protected static function _setDefaultMenuitemId()
{
// Cache the result on multiple calls
static $_component_default_menuitem_id = null;
if ( $_component_default_menuitem_id!==null ) return $_component_default_menuitem_id;
// Default item not found (yet) ... set it to false to indicate that we tried
$_component_default_menuitem_id = false;
// Get 'current' language. This SITE Default language if we are in Backend, and Current UI language if we are in Frontend
$current_language = JFactory::getApplication()->isClient('administrator')
? JComponentHelper::getParams('com_languages')->get('site', 'en-GB')
: JFactory::getLanguage()->getTag();
// Get preference for default menu item
$params = JComponentHelper::getParams('com_flexicontent');
$default_menuitem_preference = $params->get('default_menuitem_preference', 0);
switch ($default_menuitem_preference)
{
case 1:
// Try to use ACTIVE (current) menu item if pointing to Flexicontent, (if so configure in global options)
$menu = FlexicontentHelperRoute::_getActiveFlexiMenuitem();
// Check that (a) it exists and is active (b) points to com_flexicontent
if ($menu)
{
// Check language, checking access is not needed as it was done already above, by the JMenu::getItem()
$item_matches = $current_language === '*' || in_array($menu->language, array('*', $current_language)) || !JLanguageMultilang::isEnabled();
// If item matched then set it as default and return it
if ($item_matches) return $_component_default_menuitem_id = $menu->id;
}
// DO NOT BREAK HERE !! FALLBACK to 2
case 2:
// Try to use (user defined) component's default menu item, (if so configure in global options)
$menuitem_id = $params->get('default_menu_itemid', false);
// Verify the menu item, clearing it if invalid, or setting to its language associated menu item if needed
FlexicontentHelperRoute::verifyMenuItem($menuitem_id);
$_component_default_menuitem_id = $menuitem_id;
return $_component_default_menuitem_id;
}
}
/**
* function to discover a default item id only once
*/
protected static function _setLayoutDefaultMenuitemIds()
{
// Cache the result on multiple calls
static $_layouts_default_menuitem_id = null;
if ( $_layouts_default_menuitem_id!==null ) return $_layouts_default_menuitem_id;
// Default item not found (yet) ... set it to empty array to indicate that we tried
$_layouts_default_menuitem_id = array();
// Get 'current' language. This SITE Default language if we are in Backend, and Current UI language if we are in Frontend
$current_language = JFactory::getApplication()->isClient('administrator')
? JComponentHelper::getParams('com_languages')->get('site', 'en-GB')
: JFactory::getLanguage()->getTag();
// Get preference for default menu item
$params = JComponentHelper::getParams('com_flexicontent');
$_layouts_default_menuitem_id = array();
$_layouts_default_menuitem_id['tags'] = $params->get('cat_tags_default_menu_itemid', 0);
$_layouts_default_menuitem_id['favs'] = $params->get('cat_favs_default_menu_itemid', 0);
$_layouts_default_menuitem_id['author'] = $params->get('cat_author_default_menu_itemid', 0);
$_layouts_default_menuitem_id['myitems'] = $params->get('cat_myitems_default_menu_itemid', 0);
$_layouts_default_menuitem_id['mcats'] = $params->get('cat_mcats_default_menu_itemid', 0);
foreach ($_layouts_default_menuitem_id as $layout => $menuitem_id)
{
// Verify the menu item, clearing it if invalid, or setting to its language associated menu item if needed
FlexicontentHelperRoute::verifyMenuItem($menuitem_id);
$_layouts_default_menuitem_id[$layout] = $menuitem_id;
}
return $_layouts_default_menuitem_id;
}
/**
* Get language data
*/
protected static function _buildLanguageLookup()
{
if (self::$lang_lookup !== null)
{
return;
}
$db = JFactory::getDbo();
/**
* Create map of: item language code to SEF URL language code
* We don't use helper function so that we also get non-published ones
*/
$query = $db->getQuery(true)
->select('a.sef AS sef')
->select('a.lang_code AS lang_code')
->from('#__languages AS a');
$langs = $db->setQuery($query)->loadObjectList();
foreach ($langs as $lang)
{
self::$lang_lookup[$lang->lang_code] = $lang->sef;
}
// Get configuration whether to remove SEF language code from URL
$plugin = JPluginHelper::getPlugin('system', 'languagefilter');
if (!empty($plugin))
{
$pluginParams = new JRegistry($plugin->params);
self::$add_url_lang = ! $pluginParams->get('remove_default_prefix', 0);
}
else
{
self::$add_url_lang = 1;
}
// No need to do more work since we will not add language code to the URLs
if ( !self::$add_url_lang ) return;
// Get user's access levels
$user = JFactory::getUser();
$levels = JAccess::getAuthorisedViewLevels($user->id);
// Get home page menu items according to language, and
$menus = JFactory::getApplication()->getMenu('site', array());
// Get content languages and filter them to include only inteface languages
$content_langs = JLanguageHelper::getLanguages();
$interface_langs = array();
foreach ($content_langs as $i => &$language)
{
if (
// Do not display language without frontend UI
!LanguageHelper::exists($language->lang_code) ||
// Do not display language without specific home menu
!$menus->getDefault($language->lang_code) ||
// Do not display language without authorized access level
(isset($language->access) && $language->access && !in_array($language->access, $levels))
)
{
continue;
}
self::$interface_langs[$language->lang_code] = $language;
}
// DEBUG print the filtered languages
//foreach (self::$interface_langs as $lang_code => $lang) echo $lang->title.'['.$lang_code.']'."<br/>\n";
}
/**
* Get type parameters
*/
protected static function _getTypeParams()
{
static $types = null;
if ($types !== null)
{
return $types;
}
// Retrieve item's Content Type parameters
$db = JFactory::getDbo();
$query = $db->getQuery(true)
->select('t.attribs, t.id')
->from('#__flexicontent_types AS t');
$types = $db->setQuery($query)->loadObjectList('id');
foreach ($types as $type)
{
$type->params = new JRegistry($type->attribs);
}
return $types;
}
/**
* Load an item
*/
protected static function _loadItem($_id, $doQuery = true)
{
global $fc_list_items;
static $items = array();
//echo "FlexicontentHelperRoute::_loadItem(".$_id .")<br/>";
//echo "<pre>"; debug_print_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS); echo "</pre>";
if ( isset($fc_list_items[$_id]) ) return $fc_list_items[$_id];
if ( isset($items[$_id]) ) return $fc_list_items[$_id];
if (!$doQuery) return false;
// Finally last fallback, make a DB query to load the item
//echo "FlexicontentHelperRoute::_loadItem(".$_id .") doing query<br/>";
$db = JFactory::getDbo();
$query = $db->getQuery(true)
->select('i.*, ie.type_id')
->from('#__content AS i')
->join('LEFT', '#__flexicontent_items_ext AS ie ON ie.item_id = i.id')
->where('i.id='.$_id);
$items[$_id] = $db->setQuery($query)->loadObject();
return $items[$_id];
}
/**
* Get routed links for content items
*/
static function getItemRoute($id, $catid = 0, $_Itemid = 0, $item = null)
{
$Itemid = $_Itemid == -1 ? 0 : $_Itemid; // -1 indicates to return the found menu Itemid instead of the produced link
static $component_default_menuitem_id = null; // Calculate later only if needed
static $current_language = null;
static $use_language = null;
if ($current_language === null)
{
// Get 'current' language. This SITE Default language if we are in Backend, and Current UI language if we are in Frontend
$current_language = JFactory::getApplication()->isClient('administrator')
? JComponentHelper::getParams('com_languages')->get('site', 'en-GB')
: JFactory::getLanguage()->getTag();
}
if ($use_language === null)
{
$use_language = JLanguageMultilang::isEnabled();
if ($use_language)
{
self::_buildLanguageLookup();
}
}
global $globalcats;
if ($globalcats === null)
{
JLoader::register('plgSystemFlexisystem', JPATH_ROOT . '/plugins/system/flexisystem/flexisystem.php');
plgSystemFlexisystem::getCategoriesTree();
}
$_catid = (int) $catid;
$_id = (int) $id;
// ***
// *** Get data of the FLEXIcontent item (only if not already given)
// *** including data like: type id, language, but do not do 1 SQL query
// *** per item, to get the type id and language ...
// *** for language we will use current language, for type_id, we ignore
// ***
// Compatibility with calls not passing item data, check for item data in global object, avoiding an extra SQL call
if ( !$item ) $item = FlexicontentHelperRoute::_loadItem($_id, $doQuery = false);
// Get language
$language = (!$item || @!$item->language) ? $current_language : $item->language;
// Get type ID
$type_id = ($item && isset($item->type_id))? $item->type_id : 0;
// Get type data
static $types = null;
if ($type_id && $types === null) {
$types = FlexicontentHelperRoute::_getTypeParams();
}
$type = $type_id && isset($types[$type_id]) ? $types[$type_id] : false;
// ***
// *** DONE ONCE (per encountered type): Get content type's default menu
// ***
if ( $type )
{
$type_menu_itemid_usage = $type->params->get('type_menu_itemid_usage', 0); // ZERO: do not use, 1: before item's category, 2: after item's category
$type_menu_itemid = $type->params->get('type_menu_itemid', 0);
if ($type_menu_itemid_usage && $type_menu_itemid && !isset($type->typeMenuItem))
{
// Verify the menu item, clearing it if invalid, or setting to its language associated menu item if needed
$type->typeMenuItem = FlexicontentHelperRoute::verifyMenuItem($type_menu_itemid);
}
}
// ***
// *** Get item's parent categores to be used in search a menu item of type category view
// ***
$parents_ids = array();
if ( $_catid && isset($globalcats[$_catid]->ancestorsarray) )
{
$parents_ids = array_reverse($globalcats[$_catid]->ancestorsarray);
}
// ***
// *** Create the needles for table lookup in descending priority
// ***
$needles = array();
// Priority 1: Item view menu items of given item ID
$needles[FLEXI_ITEMVIEW] = array($_id);
// Priority 2: Type's default before categories (if so configured): ... giving an object means no-lookup and just use it
if ($type && $type_menu_itemid_usage==1 && $type->typeMenuItem) $needles['type_before'] = $type->typeMenuItem;
// Priority 3: Category view menu items of given category IDs ... item's category and its parent categories in ascending order
$needles['category'] = $parents_ids;
// Priority 4: Directory view menu items ... pointing to same category IDs as above
$needles['flexicontent'] = $needles['category'];
// Priority 5: Type's default after categories (if so configured): ... giving an object means no-lookup and just use it
if ($type && $type_menu_itemid_usage==2 && $type->typeMenuItem) $needles['type_after'] = $type->typeMenuItem;
// Do not add component's default menu item to allow trying "ALL" language items ? before component default ?
// Other data to pass to _findItem()
$data = array();
$data['item'] = $item;
// ***
// *** Create the link
// ***
// view
$link = 'index.php?option=com_flexicontent&view='.FLEXI_ITEMVIEW;
// category id
if ($_catid)
{
$link .= '&cid='.$catid;
}
// item id
$link .= '&id='. $id;
// use SEF language code as so configured
$data['language'] = '*'; // Default to ALL
if ($use_language && $language && $language != "*")
{
if(isset(self::$lang_lookup[$language]))
{
if ( self::$add_url_lang && isset(self::$interface_langs[$language]) ) {
$link .= '&lang='.self::$lang_lookup[$language];
}
$data['language'] = $language;
}
}
// ***
// *** Finally find the menu item id (best match) to use
// ***
// USE the itemid provided, if we were given one it means it is "appropriate and relevant"
if ($Itemid)
{
$link .= '&Itemid='.$Itemid;
}
// Try to find the most appropriate/relevant menu item, using the priority set via needles array
elseif ($menuitem = FlexicontentHelperRoute::_findItem($needles, $data))
{
$Itemid = $menuitem->id;
$link .= '&Itemid='.$Itemid;
}
// Try to use component's default menu item, this is according to COMPONENT CONFIGURATION and includes ACTIVE menu item if appropriate
else
{
if ($component_default_menuitem_id === null)
{
$component_default_menuitem_id = FlexicontentHelperRoute::_setDefaultMenuitemId();
}
if ($component_default_menuitem_id)
{
$Itemid = $component_default_menuitem_id;
$link .= '&Itemid='.$Itemid;
}
}
// Return menu Itemid or the produced link
return $_Itemid == -1 ? $Itemid : $link;
}
/**
* Get routed links for categories
*/
static function getCategoryRoute($catid, $_Itemid = 0, $urlvars = array(), $category = null)
{
$Itemid = $_Itemid == -1 ? 0 : $_Itemid; // -1 indicates to return the found menu Itemid instead of the produced link
// Calculate later only if needed
static $component_default_menuitem_id = null;
static $layout_default_menuitem_ids = null;
static $current_language = null;
static $use_language = null;
if ($current_language === null)
{
// Get 'current' language. This SITE Default language if we are in Backend, and Current UI language if we are in Frontend
$current_language = JFactory::getApplication()->isClient('administrator')
? JComponentHelper::getParams('com_languages')->get('site', 'en-GB')
: JFactory::getLanguage()->getTag();
}
if ($use_language === null)
{
$use_language = JLanguageMultilang::isEnabled();
if ($use_language) {
self::_buildLanguageLookup();
}
}
global $globalcats;
if ($globalcats === null)
{
JLoader::register('plgSystemFlexisystem', JPATH_ROOT . '/plugins/system/flexisystem/flexisystem.php');
plgSystemFlexisystem::getCategoriesTree();
}
$_catid = (int) $catid;
// **************************************
// Get data of the FLEXIcontent category
// data like: language, and ancestors ids
// **************************************
// Get language
$language = $category && !empty($category->language) ? $category->language : null;
if (!$language) {
$language = isset($globalcats[$_catid]->language) ? $globalcats[$_catid]->language : $current_language;
}
// Get item's parent categores to be used in search a menu item of type category view
$parents_ids = array();
if ( $_catid && isset($globalcats[$_catid]->ancestorsarray) ) {
$parents_ids = array_reverse($globalcats[$_catid]->ancestorsarray);
}
// **********************************************************
// Create the needles for table lookup in descending priority
// **********************************************************
$needles = array();
// Category view menu items of given category ID ... and then parent categories in ascending order
$needles['category'] = $parents_ids;
// Directory view menu items starting at given category ID ... and then parent categories in ascending order
$needles['flexicontent'] = $parents_ids;
// If layout is set, then add cid: 0 (indexes: LayoutID_0), -1 (indexes: 0_0) as last needles
$layout = !empty($urlvars['layout']) ? $urlvars['layout'] : false;
if ($layout) {
$needles['category'][] = 0;
$needles['category'][] = -1;
}
// ***
// *** Create the link
// ***
// view
$link = 'index.php?option=com_flexicontent&view=category';
// category id
if ($_catid)
{
$link .= '&cid='.$catid;
}
// Other data to pass to _findCategory()
$data = array();
// Append given variables, but exclude 'cid' if already added ('catslug')
foreach ($urlvars as $varname => $varval)
{
if ($varval && ($varname !== 'cid' || !$_catid))
{
$link .= '&' . $varname . '=' . $varval;
}
else
{
unset($urlvars[$varname]);
}
}
$data['urlvars'] = $urlvars;
// use SEF language code as so configured
$data['language'] = '*'; // Default to ALL
if ($use_language && $language && $language != "*")
{
if(isset(self::$lang_lookup[$language]))
{
if ( self::$add_url_lang && isset(self::$interface_langs[$language]) ) {
$link .= '&lang='.self::$lang_lookup[$language];
}
$data['language'] = $language;
}
}
// USE the itemid provided, if we were given one it means it is "appropriate and relevant"
if ($Itemid)
{
$link .= '&Itemid='.$Itemid;
}
// Try to find the most appropriate/relevant menu item, using the priority set via needles array
elseif ($menuitem = FlexicontentHelperRoute::_findCategory($needles, $data))
{
$Itemid = $menuitem->id;
$link .= '&Itemid='.$Itemid;
// Special handly if directory view was matched
if ( $menuitem->query['view'] == 'flexicontent' )
{
$link = str_replace('view=category', 'view=flexicontent', $link);
$link = str_replace('cid=', 'rootcat=', $link);
}
}
// Try to use component's default menu item, this is according to COMPONENT CONFIGURATION and includes ACTIVE menu item if appropriate
// but try layout specific first
else
{
$layout = !empty($urlvars['layout']) ? $urlvars['layout'] : false;
if ($layout && $layout_default_menuitem_ids === null)
{
$layout_default_menuitem_ids = FlexicontentHelperRoute::_setLayoutDefaultMenuitemIds();
}
if ($layout && !empty($layout_default_menuitem_ids[$layout]))
{
$Itemid = $layout_default_menuitem_ids[$layout];
}
else
{
if ($component_default_menuitem_id === null)
{
$component_default_menuitem_id = FlexicontentHelperRoute::_setDefaultMenuitemId();
}
$Itemid = (int) $component_default_menuitem_id; // if false (aka not set) then it will be typecasted to ZERO
}
if ($Itemid) $link .= '&Itemid='.$Itemid;
}
// Return menu Itemid or the produced link
return $_Itemid == -1 ? $Itemid : $link;
}
/**
* Get routed link for search view
*/
static function getSearchRoute($reserved=0, $_Itemid = 0)
{
$Itemid = $_Itemid == -1 ? 0 : $_Itemid; // -1 indicates to return the found menu Itemid instead of the produced link
static $component_default_menuitem_id = null; // Calculate later only if needed
// Get default menu item for 'search' view
static $_search_default_menuitem_id = null;
if ($_search_default_menuitem_id === null)
{
$params = JComponentHelper::getParams('com_flexicontent');
$_search_default_menuitem_id = $params->get('search_view_default_menu_itemid', false);
}
// ***************
// Create the link
// ***************
$link = 'index.php?option=com_flexicontent&view=search';
// USE the itemid provided, if we were given one it means it is "appropriate and relevant"
if ($Itemid)
{
$link .= '&Itemid='.$Itemid;
}
// Fallback to default menu item for the view
elseif ($_search_default_menuitem_id)
{
$Itemid = $_search_default_menuitem_id;
$link .= '&Itemid='.$Itemid;
}
// Try to use component's default menu item, this is according to COMPONENT CONFIGURATION and includes ACTIVE menu item if appropriate
else
{
if ($component_default_menuitem_id === null)
{
$component_default_menuitem_id = FlexicontentHelperRoute::_setDefaultMenuitemId();
}
$Itemid = (int) $component_default_menuitem_id; // if false (aka not set) then it will be typecasted to ZERO
if ($Itemid) $link .= '&Itemid='.$Itemid;
}
// Return menu Itemid or the produced link
return $_Itemid == -1 ? $Itemid : $link;
}
/**
* Get routed link for favourites view
*/
static function getFavsRoute($reserved=0, $_Itemid = 0)
{
$Itemid = $_Itemid == -1 ? 0 : $_Itemid; // -1 indicates to return the found menu Itemid instead of the produced link
static $component_default_menuitem_id = null; // Calculate later only if needed
// Get default menu item for 'favourites' view
static $_favs_default_menuitem_id = null;
if ($_favs_default_menuitem_id === null)
{
$params = JComponentHelper::getParams('com_flexicontent');
$_favs_default_menuitem_id = $params->get('favs_view_default_menu_itemid', false);
}
// ***************
// Create the link
// ***************
$link = 'index.php?option=com_flexicontent&view=favourites';
// USE the itemid provided, if we were given one it means it is "appropriate and relevant"
if ($Itemid)
{
$link .= '&Itemid='.$Itemid;
}
// Fallback to default menu item for the view
elseif ($_favs_default_menuitem_id)
{
$Itemid = $_favs_default_menuitem_id;
$link .= '&Itemid='.$Itemid;
}
// Try to use component's default menu item, this is according to COMPONENT CONFIGURATION and includes ACTIVE menu item if appropriate
else
{
if ($component_default_menuitem_id === null)
{
$component_default_menuitem_id = FlexicontentHelperRoute::_setDefaultMenuitemId();
}
$Itemid = (int) $component_default_menuitem_id; // if false (aka not set) then it will be typecasted to ZERO
if ($Itemid) $link .= '&Itemid='.$Itemid;
}
// Return menu Itemid or the produced link
return $_Itemid == -1 ? $Itemid : $link;
}
/**
* Get routed links for tags
*/
static function getTagRoute($id, $_Itemid = 0)
{
$Itemid = $_Itemid == -1 ? 0 : $_Itemid; // -1 indicates to return the found menu Itemid instead of the produced link
static $component_default_menuitem_id = null; // Calculate later only if needed
static $current_language = null;
static $use_language = null;
if ($current_language === null)
{
// Get 'current' language. This SITE Default language if we are in Backend, and Current UI language if we are in Frontend
$current_language = JFactory::getApplication()->isClient('administrator')
? JComponentHelper::getParams('com_languages')->get('site', 'en-GB')
: JFactory::getLanguage()->getTag();
}
if ($use_language === null)
{
$use_language = JLanguageMultilang::isEnabled();
if ($use_language)
{
self::_buildLanguageLookup();
}
}
// Get default menu item for 'tags' view
static $_tags_default_menuitem_id = null;
if ($_tags_default_menuitem_id === null)
{
$params = JComponentHelper::getParams('com_flexicontent');
$_tags_default_menuitem_id = $params->get('tags_view_default_menu_itemid', false);
}
// ***
// *** Get data of given TAG
// *** data like: language
// ***
// Get language, IN FUTURE tags will have language because we will use J3+ tags
$language = '*';
// ***
// *** Create the needles for table lookup in descending priority
// ***
$needles = array();
$needles['tags'] = array( (int) $id );
// ***
// *** Create the link
// ***
$link = 'index.php?option=com_flexicontent&view=tags&id='.$id;
// Other data to pass to _findTag()
$data = array();
// use SEF language code as so configured
$data['language'] = '*'; // Default to ALL
if ($use_language && $language && $language != "*")
{
if(isset(self::$lang_lookup[$language]))
{
if ( self::$add_url_lang && isset(self::$interface_langs[$language]) ) {
$link .= '&lang='.self::$lang_lookup[$language];
}
$data['language'] = $language;
}
}
// USE the itemid provided, if we were given one it means it is "appropriate and relevant"
if ($Itemid)
{
$link .= '&Itemid='.$Itemid;
}
// Try to find the most appropriate/relevant menu item, using the priority set via needles array
elseif ($menuitem = FlexicontentHelperRoute::_findTag($needles, $data))
{
$Itemid = $menuitem->id;
$link .= '&Itemid='.$Itemid;
}
// Fallback to default menu item for the view
elseif ($_tags_default_menuitem_id)
{
$Itemid = $_tags_default_menuitem_id;
$link .= '&Itemid='.$Itemid;
}
// Try to use component's default menu item, this is according to COMPONENT CONFIGURATION and includes ACTIVE menu item if appropriate
else
{
if ($component_default_menuitem_id === null)
{
$component_default_menuitem_id = FlexicontentHelperRoute::_setDefaultMenuitemId();
}
$Itemid = (int) $component_default_menuitem_id; // if false (aka not set) then it will be typecasted to ZERO
if ($Itemid) $link .= '&Itemid='.$Itemid;
}
// Return menu Itemid or the produced link
return $_Itemid == -1 ? $Itemid : $link;
}
protected static function _findItem($needles, &$data)
{
if ( !$needles ) return false;
// Get language, item ,current (matched) category menu item
$language = $data['language'];
$item = $data['item'];
/**
* Get 'current' language. This SITE Default language if we are in Backend, and Current UI language if we are in Frontend
*/
static $current_language = null;
if ($current_language === null)
{
$current_language = JFactory::getApplication()->isClient('administrator')
? JComponentHelper::getParams('com_languages')->get('site', 'en-GB')
: JFactory::getLanguage()->getTag();
}
/**
* Set language menu items if not already done
*/
$component_menuitems = array();
if (!isset(self::$menuitems[$current_language]))
{
FlexicontentHelperRoute::_setMenuitems($current_language);
}
$component_menuitems[$current_language] = & self::$menuitems[$current_language];
if (!isset(self::$menuitems[$language]))
{
FlexicontentHelperRoute::_setMenuitems($language);
}
$component_menuitems[$language] = & self::$menuitems[$language];
/**
* Get current menu item, we will prefer current menu if it points to given category,
* thus maintaining current menu item if multiple menu items to same category exist !!
*/
static $active = null;
if ($active === null)
{
$active = FlexicontentHelperRoute::_getActiveFlexiMenuitem();
// Get if active language menu items are allowed for language all records
self::$route_active_lang = self::$route_active_lang !== null ? self::$route_active_lang : (int) JComponentHelper::getParams('com_flexicontent')->get('route_active_lang', 1);
}
$route_active_lang = self::$route_active_lang && $language === '*';
/**
* Done ONCE per language: Iterate through menu items pointing to FLEXIcontent component, to create a reverse lookup
* table for the given language, not if given language is missing the an '*' menu item will be allowed in its place
*/
if (!isset(self::$lookup[$language]))
{
FlexicontentHelperRoute::populateLookupTable($language);
}
if ($route_active_lang && !isset(self::$lookup[$current_language]))
{
FlexicontentHelperRoute::populateLookupTable($current_language);
}
// Now find menu item for given needles
$matched_menu = false;
//JFactory::getApplication()->enqueueMessage("Finding Item: ".$item->id ."<br/>Language:".$language." <br/> ". print_r(self::$lookup[$language]['item'], true)."<br/>".print_r($needles,true),'message');
foreach ($needles as $view => $ids)
{
if ( is_object($ids) && ($ids->language=='*' || $ids->language==$language) ) return $ids; // done, this an already appropriate menu item object
// Lookup if then given ids for the given view exists for the given language
if (!isset(self::$lookup[$language][$view]) && (!$route_active_lang || !isset(self::$lookup[$current_language][$view])))
{
continue;
}
foreach($ids as $id)
{
// Try to find the language of the the item
if (isset(self::$lookup[$language][$view][(int)$id]))
{
$lookup_language = $language;
}
// Otherwise if record being routed has language ALL, then try to match menus having the active language
elseif ($route_active_lang && isset(self::$lookup[$current_language][$view][(int)$id]))
{
$lookup_language = $current_language;
}
else
{
continue;
}
//JFactory::getApplication()->enqueueMessage("MATCHED $language $view $id : ". self::$lookup[$language][$view][(int)$id],'message');
$menuid = self::$lookup[$lookup_language][$view][(int)$id];
$menuitem = $component_menuitems[$lookup_language][$menuid];
// menu item matched, break out
$matched_menu = $menuitem;
break;
}
if ($matched_menu) break;
}
// Prefer current category menu item if also appropriate
if ($matched_menu && $active &&
@ $matched_menu->query['view'] == 'category' && $active->query['view'] == 'category' &&
@ $matched_menu->query['view'] == @ $active->query['view'] &&
@ $matched_menu->query['cid'] == @ $active->query['cid'] &&
($current_language == $language || $current_language === '*'
// Also allow matching menu items of any language, if record being routed has language 'ALL'
|| (self::$route_active_lang && $language === '*')
)
) {
$matched_menu = $active;
}
return $matched_menu;
}
protected static function _findCategory($needles, &$data)
{
if ( !$needles ) return false;
// For 'mcats' layout, we will support specific menu match only selection for cids in same order ... for performance reasons
static $layout_idvars = array
(
'tags'=>'tagid',
'author'=>'authorid',
'mcats'=>'cids',
);
static $layout_default_menuitem_ids;
// Get language, url variables
$language = $data['language'];
$urlvars = $data['urlvars'];
// Get per layout id variable to use it for hashing (indexing the lookup array)
$layout = !empty($urlvars['layout']) ? $urlvars['layout'] : false;
if ($layout)
{
$i_name = @ $layout_idvars[$layout];
$i_val = $i_name && !empty($urlvars[$i_name]) ? ((int)$urlvars[$i_name]).'_' : '0_';
// Get default menu items per layout
if ($layout_default_menuitem_ids === null)
{
$layout_default_menuitem_ids = FlexicontentHelperRoute::_setLayoutDefaultMenuitemIds();
}
}
/**
* Get 'current' language. This SITE Default language if we are in Backend, and Current UI language if we are in Frontend
*/
static $current_language = null;
if ($current_language === null)
{
$current_language = JFactory::getApplication()->isClient('administrator')
? JComponentHelper::getParams('com_languages')->get('site', 'en-GB')
: JFactory::getLanguage()->getTag();
}
/**
* Set language menu items if not already done
*/
$component_menuitems = array();
if (!isset(self::$menuitems[$current_language]))
{
FlexicontentHelperRoute::_setMenuitems($current_language);
}
$component_menuitems[$current_language] = & self::$menuitems[$current_language];
if (!isset(self::$menuitems[$language]))
{
FlexicontentHelperRoute::_setMenuitems($language);
}
$component_menuitems[$language] = & self::$menuitems[$language];
/**
* Get current menu item, we will prefer current menu if it points to given category,
* thus maintaining current menu item if multiple menu items to same category exist !!
*/
static $active = null;
if ($active === null)
{
$active = FlexicontentHelperRoute::_getActiveFlexiMenuitem();
// Get if active language menu items are allowed for language all records
self::$route_active_lang = self::$route_active_lang !== null ? self::$route_active_lang : (int) JComponentHelper::getParams('com_flexicontent')->get('route_active_lang', 1);
}
$route_active_lang = self::$route_active_lang && $language === '*';
/**
* Done ONCE per language: Iterate through menu items pointing to FLEXIcontent component, to create a reverse lookup
* table for the given language, not if given language is missing the an '*' menu item will be allowed in its place
*/
if (!isset(self::$lookup[$language]))
{
FlexicontentHelperRoute::populateLookupTable($language);
}
if ($route_active_lang && !isset(self::$lookup[$current_language]))
{
FlexicontentHelperRoute::populateLookupTable($current_language);
}
// Now find menu item for given needles
$matched_menu = false;
//echo '<pre>'; print_r($needles); echo '</pre>';
foreach ($needles as $view => $ids)
{
// Check if this an already appropriate menu item object
if (is_object($ids) && ($ids->language === '*' || $ids->language == $language))
{
return $ids;
}
if ($view === '_language')
{
continue;
}
$i_view = $view . ($layout ? '_' . $layout : '');
// Lookup if then given ids for the given view exists for the given language
if (!isset(self::$lookup[$language][$i_view]) && (!$route_active_lang || !isset(self::$lookup[$current_language][$i_view])))
{
continue;
}
foreach($ids as $id)
{
$i_id = (int) $id;
if ($layout)
{
// Do not try to match a non-specific "layout" menu item if default menu item for this layout has been configured
if ($i_id === -1 && !empty($layout_default_menuitem_ids[$layout]))
{
continue;
}
$i_id = $i_id === -1 ? '0_0' : $i_val . $i_id;
}
//echo "i_id: ". $i_id ."<br/>";
// Check if not found and continue
if (isset(self::$lookup[$language][$i_view][$i_id]))
{
$lookup_language = $language;
}
// Otherwise if record being routed has language ALL, then try to match menus having the active language
elseif ($route_active_lang && isset(self::$lookup[$current_language][$i_view][(int)$id]))
{
$lookup_language = $current_language;
}
else
{
continue;
}
//echo "$language $i_view $i_id : ". self::$lookup[$language][$i_view][$i_id] ."<br/>";
$menuid = self::$lookup[$lookup_language][$i_view][$i_id];
$menuitem = $component_menuitems[$lookup_language][$menuid];
// menu item matched, break out
$matched_menu = $menuitem;
break;
}
if ($matched_menu)
{
break;
}
}
// Prefer current category menu item if also appropriate
if ($matched_menu && $active && @ $matched_menu->query['view'] == 'category' &&
@ $matched_menu->query['view'] == @ $active->query['view'] &&
@ $matched_menu->query['cid'] == @ $active->query['cid'] &&
@ $matched_menu->query['layout'] == @ $active->query['layout'] &&
@ $matched_menu->query['authorid'] == @ $active->query['authorid'] &&
@ $matched_menu->query['cids'] == @ $active->query['cids'] &&
@ $matched_menu->query['tagid'] == @ $active->query['tagid'] &&
($current_language == $language || $current_language === '*'
// Also allow matching menu items of any language, if record being routed has language 'ALL'
|| (self::$route_active_lang && $language === '*')
)
) {
$matched_menu = $active;
}
return $matched_menu;
}
protected static function _findTag($needles, &$data)
{
if ( !$needles ) return false;
// Get language, item, current (matched) category menu item
$language = $data['language'];
/**
* Get 'current' language. This SITE Default language if we are in Backend, and Current UI language if we are in Frontend
*/
static $current_language = null;
if ($current_language === null)
{
$current_language = JFactory::getApplication()->isClient('administrator')
? JComponentHelper::getParams('com_languages')->get('site', 'en-GB')
: JFactory::getLanguage()->getTag();
}
/**
* Set language menu items if not already done
*/
$component_menuitems = array();
if (!isset(self::$menuitems[$current_language]))
{
FlexicontentHelperRoute::_setMenuitems($current_language);
}
$component_menuitems[$current_language] = & self::$menuitems[$current_language];
if (!isset(self::$menuitems[$language]))
{
FlexicontentHelperRoute::_setMenuitems($language);
}
$component_menuitems[$language] = & self::$menuitems[$language];
/**
* Get current menu item, we will prefer current menu if it points to given category,
* thus maintaining current menu item if multiple menu items to same category exist !!
*/
static $active = null;
if ($active === null)
{
$active = FlexicontentHelperRoute::_getActiveFlexiMenuitem();
// Get if active language menu items are allowed for language all records
self::$route_active_lang = self::$route_active_lang !== null ? self::$route_active_lang : (int) JComponentHelper::getParams('com_flexicontent')->get('route_active_lang', 1);
}
$route_active_lang = self::$route_active_lang && $language === '*';
/**
* Done ONCE per language: Iterate through menu items pointing to FLEXIcontent component, to create a reverse lookup
* table for the given language, not if given language is missing the an '*' menu item will be allowed in its place
*/
if (!isset(self::$lookup[$language]))
{
FlexicontentHelperRoute::populateLookupTable($language);
}
if ($route_active_lang && !isset(self::$lookup[$current_language]))
{
FlexicontentHelperRoute::populateLookupTable($current_language);
}
// Now find menu item for given needles
$matched_menu = false;
foreach ($needles as $view => $ids)
{
// This an already appropriate menu item object
if (is_object($ids) && ($ids->language === '*' || $ids->language == $language))
{
return $ids;
}
// Lookup if then given ids for the given view exists for the given language
if (!isset(self::$lookup[$language][$view]) && (!$route_active_lang || !isset(self::$lookup[$current_language][$view])))
{
continue;
}
foreach($ids as $id)
{
// Check if not found
if (isset(self::$lookup[$language][$view][(int) $id]))
{
$lookup_language = $language;
}
// Otherwise if record being routed has language ALL, then try to match menus having the active language
elseif ($route_active_lang && isset(self::$lookup[$current_language][$view][(int)$id]))
{
$lookup_language = $current_language;
}
else
{
continue;
}
//echo "$language $view $id : ". self::$lookup[$language][$view][(int)$id] ."<br/>";
$menuid = self::$lookup[$lookup_language][$view][(int) $id];
$menuitem = $component_menuitems[$lookup_language][$menuid];
// menu item matched, break out
$matched_menu = $menuitem;
break;
}
if ($matched_menu) break;
}
// Prefer current tags menu item if also appropriate
if ($matched_menu && $active && @ $matched_menu->query['view'] == 'tags' &&
@ $matched_menu->query['view'] == @ $active->query['view'] &&
@ $matched_menu->query['id'] == @ $active->query['id'] &&
($current_language == $language || $current_language === '*'
// Also allow matching menu items of any language, if record being routed has language 'ALL'
|| (self::$route_active_lang && $language === '*')
)
) {
$matched_menu = $active;
}
return $matched_menu;
}
static function populateLookupTable($language)
{
$component_menuitems = array();
// Set language menu items if not already done
if (!isset(self::$menuitems[$language]))
{
FlexicontentHelperRoute::_setMenuitems($language);
}
$component_menuitems[$language] = & self::$menuitems[$language];
// Every VIEW may have a different variable for the lookup table in which we will add the menu items
static $view_varnames = array(FLEXI_ITEMVIEW=>'id', 'category'=>'cid', 'tags'=>'id', 'flexicontent'=>'rootcatid');
static $layout_idvars = array(
'tags'=>'tagid',
'author'=>'authorid',
'mcats'=>'cids',
);
self::$lookup[$language] = array();
$user = JFactory::getUser();
foreach($component_menuitems[$language] as $menuitem)
{
if ( !isset($menuitem->query) || !isset($menuitem->query['view']) ) continue; // view not set
if ( $menuitem->language != $language && $menuitem->language!='*') continue; // wrong menu item language, neither item's language, nor '*' = ALL
$view = $menuitem->query['view'];
$layout = $view=='category' && !empty($menuitem->query['layout']) ? $menuitem->query['layout'] : false;
// Create lookup table for view if it does not exist already
$i_view = $view . ($layout && $view=='category' ? '_'.$layout : '');
if (!isset(self::$lookup[$language][$i_view])) self::$lookup[$language][$i_view] = array();
// Check if view 's variable (used in lookup table) exists in the menu item
if ( !isset($view_varnames[$view]) ) continue;
$i_name = $view_varnames[$view];
if ( empty($menuitem->query[$i_name]) && ! $layout ) continue;
$i_val = !empty($menuitem->query[$i_name]) ? (int)$menuitem->query[$i_name] : 0;
if ( $layout )
{
$i_name = @ $layout_idvars[$layout];
$i_val = ((int)($i_name ? @ $menuitem->query[$i_name] : '0')) . '_' . $i_val;
}
// Only a specific language menu item can override an existing lookup entry
if ( isset(self::$lookup[$language][$i_view][$i_val]) && $menuitem->language === '*' ) continue;
// Finally set new lookup entry or override existing lookup entry with language specific menu item
self::$lookup[$language][$i_view][$i_val] = (int) $menuitem->id;
}
//echo "<pre>"; print_r(self::$lookup); echo "</pre>"; exit;
}
static function verifyMenuItem(& $menuitem_id)
{
// Get 'current' language. This SITE Default language if we are in Backend, and Current UI language if we are in Frontend
$current_language = JFactory::getApplication()->isClient('administrator')
? JComponentHelper::getParams('com_languages')->get('site', 'en-GB')
: JFactory::getLanguage()->getTag();
$menus = JFactory::getApplication()->getMenu('site', array()); // this will work in J1.5 backend too !!!
$menu = $menus->getItem($menuitem_id); // Try to load the menu item
// Check that (a) it exists and is active (b) points to com_flexicontent
if ($menu && isset($menu->query['option']) && $menu->query['option'] === 'com_flexicontent')
{
// Check language, checking access is not needed as it was done already above, by the JMenu::getItem()
$item_matches = $current_language === '*' || in_array($menu->language, array('*', $current_language)) || !JLanguageMultilang::isEnabled();
// If matched set default and return it
if ($item_matches) ;
// We also need to try menu item associations and select the current language item
else if ( $menu->language!='*' && $menu->language!='' && $menu->language!=$current_language )
{
// Clear menu item and and menu item id
$menuitem_id = 0;
$menu = false;
require_once (JPATH_ADMINISTRATOR.DS.'components'.DS.'com_menus'.DS.'helpers'.DS.'menus.php');
$helper = new MenusHelper();
$associated = $helper->getAssociations($menuitem_id);
// Use the associated menu item for current language
if ( isset($associated[$current_language]) )
{
// Check the associated menu item too
$menuitem_id = $associated[$current_language];
$menu = $menus->getItem($menuitem_id);
if (!$menu || !isset($menu->query['option']) || $menu->query['option'] !== 'com_flexicontent')
{
// Clear menu item and and menu item id
$menuitem_id = 0;
$menu = false;
}
}
}
}
else
{
// Clear menu item and and menu item id
$menuitem_id = 0;
$menu = false;
}
return $menu;
}
}