Docs For Class Layout

Description

A BIGACE Layout is a Defintion of a set of PHP Pages.

Each Layout has at least a Name and a default Template, which is normally used for displaying a Menus Content.

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

Method Summary

Layout Layout (String $name, [String $key = ''])

void exists ()

void existsKey ([ $key = ''])

void getCSS ()

void getDescription ()

void getFullURL ()

void getKeys ()

void getName ()

void getPortletColumns ()

void getPortletNames ()

void getSetting ( $name, [ $default = ''])

void getSize ()

void getTitle ()

void getURL ()

void getURLForKey ( $key)

void hasPortletSupport ()

void isPublic ()

void isSystem ()

void toString ()

Methods

Constructor Layout (line 59)

Initializes the Object with the given Name

Layout Layout (String $name, [String $key = ''])

String $name: the Name
String $key: the Key

exists (line 215)

Check whether this Layout really exist.

void exists ()

existsKey (line 194)

Checks if the given key exists in this Layout.

If no key was passed, we check for the Key this Layout was constructed with.

void existsKey ([ $key = ''])

$key

getCSS (line 173)

Returns the Default CSS for this Layout. May be used by the Editors to preview HMTL.

void getCSS ()

getDescription (line 104)

Returns the Description of this Layout.

void getDescription ()

getFullURL (line 157)

Returns the Full URL to this Template.

void getFullURL ()

getKeys (line 165)

Returns all configured Keys for this Layout.

void getKeys ()

getName (line 72)

Returns the Name of this Layout.

void getName ()

getPortletColumns (line 124)

void getPortletColumns ()

getPortletNames (line 120)

Return an Array with all supported Portlet Names for this Layout.

void getPortletNames ()

getSetting (line 182)

Returns the configured Setting with the given Name or default (empty String) if none could be found.

void getSetting ( $name, [ $default = ''])

$name
$default

getSize (line 204)

Return the File Size of this Layout.

void getSize ()

getTitle (line 80)

Returns the Title of this Layout.

void getTitle ()

getURL (line 132)

Returns the URL to this Layout.

If a SubKey was specified it returns the URL to this Template.

void getURL ()

getURLForKey (line 144)

Returns the URL for the subKey to this Template.

void getURLForKey ( $key)

$key

hasPortletSupport (line 112)

Returns whether this Layout supports dynamic Portlets.

void hasPortletSupport ()

isPublic (line 88)

Returns whether this Layout is public and therefor may be visible within Dialogs.

void isPublic ()

isSystem (line 96)

Returns whether this Layout is a System Layout (which may not be public visible).

void isSystem ()

toString (line 223)

Returns the qualified String representation of this Layout to be appended to Command Links.

void toString ()