Docs For Class applications

Class applications

Description

Use this Library to create Links to the Default Applications, devlivered with BIGACE.

The rendered HTML can be customized with various methods.

Use this Class to get Links for

Home : The Top Level Page for your Consumer
Status : Login or Logoff
Admin : The Administration Console in a new Window
Search : The Standard Search in a POP-UP Window
Editor : The Editor in a POP-UP Windows, editing the current Page (Editor type depends on the Default Editor settings)

version: $Id: applications.php,v 1.16 2006/12/29 18:21:21 kpapst Exp $
copyright: Copyright (C) 2002-2006 Kevin Papst
author: Kevin Papst
license: GNU Public License

Variable Summary

mixed $ADMIN

mixed $EDITOR

mixed $HOME

mixed $PORTLETS

mixed $SEARCH

mixed $STATUS

Method Summary

applications applications ()

void canAccessEditor ()

void canAccessPortletAdmin ()

void createConfiguredAppLink ( $link, $description, $icon, [ $target = '_self'])

void getAdminLink ([String $desc = ''], [String $img = ''])

String getAllJavascript ()

void getAllLink ()

void getDelimiter ()

String getEditorJS ()

String getEditorLink ([String $desc = ''], [String $img = ''])

void getHomeLink ([String $desc = ''], [String $img = ''])

void getJavascript (String $name)

void getLink (String $name, [String $desc = ''], [String $img = ''])

String getPortletAdminJS ()

String getPortletAdminLink ([ $desc = ''], [ $img = ''])

void getSearchJS ()

void getSearchLink ([String $desc = ''], [String $img = ''])

void getStatusLink ([String $desc = ''], [String $img = ''])

void hide (String $app)

void setAddPostDelim (boolean $delim)

void setAddPreDelim (boolean $delim)

void setDelimiter (String $delim)

void setHomeID (String $id)

void setImageAlign ([ $align = null])

void setImageDimension (String $width, $height)

void setLinkClass (String $class)

void setPostDelimiter (String $delim)

void setPreDelimiter (String $delim)

void setShowPicture (boolean $val)

void setShowText (boolean $val)

Variables

mixed $ADMIN = 'admin' (line 57)

Constant for the ADMINISTRATION Link.

mixed $EDITOR = 'editor' (line 65)

Constant for the EDITOR Link.

mixed $HOME = 'home' (line 53)

Constant for the HOME Link.

mixed $PORTLETS = 'portletadmin' (line 73)

Constant for the PORTLET ADMINISTRATION Link.

mixed $SEARCH = 'search' (line 61)

Constant for the SEARCH Link.

mixed $STATUS = 'status' (line 69)

Constant for the STATUS Link.

Methods

Constructor applications (line 155)

Constructor setting up some default values.

applications applications ()

canAccessEditor (line 452)

Returns whether the User has the rights to access the Editor.

void canAccessEditor ()

canAccessPortletAdmin (line 507)

Calculates whether the Portlet Administration Link and/or Javascript will be shown.

Uses the Layout (global for this request) and Functional Rights.

void canAccessPortletAdmin ()

createConfiguredAppLink (line 712)

void createConfiguredAppLink ( $link, $description, $icon, [ $target = '_self'])

$link
$description
$icon
$target

getAdminLink (line 420)

Gets the Administration Link, opening the BIGACE Administration Console.

void getAdminLink ([String $desc = ''], [String $img = ''])

String $desc: the text information for the Link
String $img: the image name for the Link

getAllJavascript (line 683)

Returns the Javascript Code that has to be set within the HTML File, to make the links work properly.

return: the Javascript to past to the Page

String getAllJavascript ()

getAllLink (line 636)

Returns all Links that should be shown, hide the ones configured by

hide(String)

or the ones the User may not see cause of missing Functional rights or missing rights on the actual Menu.

see: applications::hide()

void getAllLink ()

getDelimiter (line 319)

Returns the Delimiter that will be used.

deprecated: use getPreDelimiter() and getPostDelimiter() instead!

void getDelimiter ()

getEditorJS (line 492)

Returns the Javascript used for opening the Default Editor.

return: the Javascript or an empty String

String getEditorJS ()

getEditorLink (line 477)

Gets the Link to the Default Editor.

return: the Link or an empty String

String getEditorLink ([String $desc = ''], [String $img = ''])

String $desc: the text information for the Link
String $img: the image name for the Link

getHomeLink (line 381)

Gets the Home Link.

void getHomeLink ([String $desc = ''], [String $img = ''])

String $desc: the textual description for the Link (default is a Translation String called 'home')
String $img: the image filename for the Link (defalt is 'home.gif')

getJavascript (line 617)

Returns the Javascript for the given Application or an empty String if no javascript is used.

void getJavascript (String $name)

String $name: the Application Name

getLink (line 593)

Gets the Link for the given Application, or an empty String if the Application is not supported.

void getLink (String $name, [String $desc = ''], [String $img = ''])

String $name: the Application name ($HOME,$ADMIN,$SEARCH,$EDITOR,$STATUS)
String $desc: the text information for the Link
String $img: the image name for the Link

getPortletAdminJS (line 549)

Returns the Javascript used for opening the Portlet Administration.

return: the Javascript or an empty String

String getPortletAdminJS ()

getPortletAdminLink (line 534)

Gets the Link to the Portlet Administration.

return: the Link or an empty String

String getPortletAdminLink ([ $desc = ''], [ $img = ''])

$desc
$img

getSearchJS (line 577)

Returns the Javascript used for opening the Search.

void getSearchJS ()

getSearchLink (line 567)

Gets the Link for opening the Default Search.

void getSearchLink ([String $desc = ''], [String $img = ''])

String $desc: the text information for the Link
String $img: the image name for the Link

getStatusLink (line 397)

Gets the Status Link, depending on the Users Status we show a Login or Logoff Link.

void getStatusLink ([String $desc = ''], [String $img = ''])

String $desc: the text information for the Link
String $img: the image name for the Link

hide (line 183)

Adds the given Application to the Hide Array. All submitted Applications will not be added automatically to the Link when calling

getAllLink()

This does not affect hte work of the methods like

getEditorLink()

void hide (String $app)

String $app: the Application name ($HOME,$ADMIN,$SEARCH,$EDITOR,$STATUS)

setAddPostDelim (line 284)

Set whether the Delimiter should be added behind each link.

void setAddPostDelim (boolean $delim)

boolean $delim: true for adding or false for not adding behind each link

setAddPreDelim (line 261)

Set whether the Delimiter should be added in front of each link.

void setAddPreDelim (boolean $delim)

boolean $delim: true for adding or false for not adding before each link

setDelimiter (line 294)

Sets both Delimiter (Pre and Post) to the same value.

Those will be used when creating Links.

void setDelimiter (String $delim)

String $delim: the Delimiter to use (normally some kind of HTML TAG)

setHomeID (line 371)

Set the ID used for the Home Link created by

getHomeLink()

void setHomeID (String $id)

String $id: id the Menu ID for Home

setImageAlign (line 239)

Sets the Alignment for Images.

void setImageAlign ([ $align = null])

$align

setImageDimension (line 231)

Sets the Image width and height. Pass an empty String(default) to define that the attribute should not be set within the image TAG.

void setImageDimension (String $width, $height)

String $width: the size or an empty String ''
$height

setLinkClass (line 222)

Set the CSS Class that will be used for setting up each links.

void setLinkClass (String $class)

String $class: the name of the CSS Class

setPostDelimiter (line 311)

Sets the Post-Link-Delimiter.

void setPostDelimiter (String $delim)

String $delim: the Delimiter to use (normally some kind of HTML TAG)

setPreDelimiter (line 303)

Sets the Pre-Link-Delimiter.

void setPreDelimiter (String $delim)

String $delim: the Delimiter to use (normally some kind of HTML TAG)

setShowPicture (line 353)

Sets whether we show Pictures within the Links.

void setShowPicture (boolean $val)

boolean $val: true for showing image links, false for hiding the image

setShowText (line 344)

Sets whether we show Text within the Links.

Make sure to pass a REAL boolean, we perfom a check on the argument and only accept it, if

is_bool($val)

returns true!

void setShowText (boolean $val)

boolean $val: true for showing text links, false for hiding the textual description

Documentation generated by phpDocumentor 1.3.1