Class JHelperRoute

Route Helper

A class providing basic routing for urls that are for content types found in the #__content_types table and rows found in the #__ucm_content table.

Package: Joomla\Libraries\Helper
Copyright: Copyright (C) 2005 - 2017 Open Source Matters, Inc. All rights reserved.
License: General Public License version 2 or later; see LICENSE.txt
Since: 3.1
Located at cms/helper/route.php

Methods summary

`public string`	# `getRoute( integer $id, string $typealias, string $link = '', string $language = null, integer $catid = null )` A method to get the route for a specific item A method to get the route for a specific item Parameters `$id` `integer` - $id Value of the primary key for the item in its content table `$typealias` `string` - $typealias The type_alias for the item being routed. Of the form extension.view. `$link` `string` - $link The link to be routed `$language` `string` - $language The language of the content for multilingual sites `$catid` `integer` - $catid Optional category id Returns `string` - The route of the item Since 3.1
`protected mixed`	# `findItem( array $needles = array() )` Method to find the item in the menu structure Method to find the item in the menu structure Parameters `$needles` `array` - $needles Array of lookup values Returns `mixed` Since 3.1
`public static string`	# `getCategoryRoute( mixed $catid, mixed $language = 0, string $extension = '' )` Fetches the category route Fetches the category route Parameters `$catid` `mixed` - $catid Category ID or JCategoryNode instance `$language` `mixed` - $language Language code `$extension` `string` - $extension Extension to lookup Returns `string` Throws `InvalidArgumentException` Since 3.2
`protected static mixed`	# `lookupItem( array $needles = array() )` Static alias to findItem() used to find the item in the menu structure Static alias to findItem() used to find the item in the menu structure Parameters `$needles` `array` - $needles Array of lookup values Returns `mixed` Since 3.2

Magic methods summary

Properties summary

`protected static array`	`$lookup`	# Holds the reverse lookup Holds the reverse lookup Since 3.1
`protected string`	`$extension`	# Option for the extension (such as com_content) Option for the extension (such as com_content) Since 3.1
`protected string`	`$id`	# Value of the primary key in the content type table Value of the primary key in the content type table Since 3.1
`protected string`	`$view`	# Name of the view for the url Name of the view for the url Since 3.1

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Class JHelperRoute

Methods summary

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Throws

Since

Parameters

Returns

Since

Magic methods summary

Properties summary

Since

Since

Since

Since