Docs For Class ApplicationLinks - BIGACE Web CMS

Class ApplicationLinks

Method Summary

static void	getAdministrationURL()	Gets the URL for opening the BIGACE Administration Console.
static void	getAjaxItemInfoURL()	Get the URL to request Ajax XML Information about a special Item.
static void	getChangeSessionLanguageURL()	Gets the URL to change the Session Language.
static void	getEditorTypeURL()	Gets the URL to the Editor.
static void	getEditorURL()	Gets the URL to the Editor.
static void	getHomeURL()	Gets the URL for the Home Link.
static void	getItemInfoURL()	Gets the URL to display several Information about the requested Item.
static void	getLoginFormURL()	Build the URL for displaying the Login Formular.
static void	getLoginURL()	Build the URL for performing a Login.
static void	getLogoutURL()	Build the URL for a logout.
static void	getPortletAdminURL()	Gets the URL for opening the Portlet Administration.
static void	getSearchURL()	Gets the URL for opening the Default Search.

[ Top ]

Methods

static method getAdministrationURL [line 102]

static void getAdministrationURL(
[String
$id = ''] 
)

Gets the URL for opening the BIGACE Administration Console.

Parameters:

String

$id:

id the Admin ID (default is _BIGACE_TOP_LEVEL)

[ Top ]

static method getAjaxItemInfoURL [line 218]

static void getAjaxItemInfoURL(
[
$itemtype = ''], [
$id = ''], [
$langid = ''] 
)

Get the URL to request Ajax XML Information about a special Item.

Parameters:

	$itemtype:
	$id:
	$langid:

[ Top ]

static method getChangeSessionLanguageURL [line 203]

static void getChangeSessionLanguageURL(
String
$locale, [String
$id = ''] 
)

Gets the URL to change the Session Language.

Pass a Language String as Locale (for example 'de' or 'en').

Parameters:

String	$locale:	locale the Language to switch to
String	$id:	id the Menu ID to jump to (default is current Menu ID)

[ Top ]

static method getEditorTypeURL [line 130]

static void getEditorTypeURL(
[String
$type = null], [String
$id = ''], [String
$langid = ''], [array
$params = array()] 
)

Gets the URL to the Editor.

The Default Editor is used if none is given, it is configured in your Consumer Config.

Parameters:

String	$type:	type the Editor type (required)
String	$id:	id the Menu ID to edit (optional, if not passed global menu id is used)
String	$langid:	langid the Language ID (optional, if not passed global menu language id is used)
array	$params:	params further URL Parameter to append

[ Top ]

static method getEditorURL [line 117]

static void getEditorURL(
[String
$id = ''], [String
$langid = ''], [array
$params = array()] 
)

Gets the URL to the Editor.

Parameters:

String	$id:	id the Menu ID to edit
String	$langid:	langid the Language ID
array	$params:	params further URL Parameter to append

[ Top ]

static method getHomeURL [line 46]

static void getHomeURL(
[String
$id = null] 
)

Gets the URL for the Home Link.

Parameters:

String

$id:

id the Home ID (default is_BIGACE_TOP_LEVEL)

[ Top ]

static method getItemInfoURL [line 183]

static void getItemInfoURL(
[String
$itemtype = ''], [String
$id = ''], [String
$langid = ''] 
)

Gets the URL to display several Information about the requested Item.

If you want to display the currents Menu Information, leave everything empty. Default is

_BIGACE_ITEM_MENU, $GLOBALS['MENU']->getID(), $GLOBALS['MENU']->getLanguageID()

Parameters:

String	$itemtype:	itemtype the Itemtype
String	$id:	id the Menu ID to edit
String	$langid:	langid the Language ID

[ Top ]

static method getLoginFormURL [line 60]

static void getLoginFormURL(
[String
$id = ''], [
$params = array()] 
)

Build the URL for displaying the Login Formular.

Parameters:

String	$id:	id the Menu ID to redirect after a Login (default is current Menu)
	$params:

[ Top ]

static method getLoginURL [line 74]

static void getLoginURL(
[String
$id = ''], [
$params = array()] 
)

Build the URL for performing a Login.

Parameters:

String	$id:	id the Menu ID to redirect after a successful Login
	$params:

[ Top ]

static method getLogoutURL [line 88]

static void getLogoutURL(
[String
$id = ''] 
)

Build the URL for a logout.

Parameters:

String

$id:

id the Menu ID to redirect after the Logout (default is current Menu)

[ Top ]

static method getPortletAdminURL [line 164]

static void getPortletAdminURL(
[String
$id = ''], [array
$params = array()] 
)

Gets the URL for opening the Portlet Administration.

Parameters:

String	$id:	id the Menu ID used to open the Administration for
array	$params:	params extended URL Parameter

[ Top ]

static method getSearchURL [line 148]

static void getSearchURL(
[String
$id = ''], [
$langid = ''] 
)

Gets the URL for opening the Default Search.

Parameters:

String	$id:	id the Menu ID used to open the Search with
	$langid:

[ Top ]

bigace-classes

Class: ApplicationLinks

Class ApplicationLinks