Docs For Class ApplicationLinks

Class ApplicationLinks

Description

This class provides basic methods to build URLs to the BIGACE Applications.

version: $Id: ApplicationLinks.php,v 1.10 2006/11/26 22:04:03 kpapst Exp $
copyright: Copyright (C) 2002-2006 Kevin Papst
author: Kevin Papst
license: GNU Public License

Method Summary

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

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

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

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

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

void getHomeURL ([String $id = ''])

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

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

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

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

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

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

Methods

getAdministrationURL (line 102)

Gets the URL for opening the BIGACE Administration Console.

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

String $id: id the Admin ID (default is _BIGACE_TOP_LEVEL)

getAjaxItemInfoURL (line 229)

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

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

$itemtype
$id
$langid

getChangeSessionLanguageURL (line 215)

Gets the URL to change the Session Language.

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

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

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

getEditorTypeURL (line 137)

Gets the URL to the Editor.

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

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

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

getEditorURL (line 123)

Gets the URL to the Editor.

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

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

getHomeURL (line 45)

Gets the URL for the Home Link.

void getHomeURL ([String $id = ''])

String $id: id the Home ID (default is_BIGACE_TOP_LEVEL)

getItemInfoURL (line 195)

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()

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

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

getLoginFormURL (line 60)

Build the URL for displaying the Login Formular.

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

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

getLoginURL (line 74)

Build the URL for performing a Login.

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

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

getLogoutURL (line 88)

Build the URL for a logout.

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

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

getPortletAdminURL (line 176)

Gets the URL for opening the Portlet Administration.

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

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

getSearchURL (line 160)

Gets the URL for opening the Default Search.

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

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

Documentation generated by phpDocumentor 1.3.1