[class tree: bigace-classes] [index: bigace-classes] [all elements]

Class: Layout

Source Location: /CORE/system/classes/layout/Layout.php

Class Layout

Class Overview

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

Each Layout has at least a Name and a default Template, which is used to render a requested Menu.

Located in /CORE/system/classes/layout/Layout.php [line 40]

MenuTemplate
   |
   --Layout

Author(s):

Kevin Papst

Information Tags:

Version:	$Id: Layout.php,v 1.18 2008/06/03 20:15:59 kpapst Exp $
Copyright:	Copyright (C) Kevin Papst
License:	GNU Public License

Methods

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From MenuTemplate

MenuTemplate::getContentNames()

Returns an array of Strings, each String representing one Name of an additional Content piece.

MenuTemplate::getDescription()

Returns the Description of this Template.

MenuTemplate::getName()

Returns the Name of this Template.

MenuTemplate::getPortletColumns()

Returns an array of Strings, each String representing one Portlet column definition.

MenuTemplate::hasPortletSupport()

Returns whether this Layout supports dynamic Portlets.

[ Top ]

Method Summary

Layout	Layout()	Initializes the Object with the given Name
void	exists()	Check whether this Layout really exist.
void	existsKey()	Checks if the given key exists in this Layout.
array	getContentNames()	Returns an array of Strings, each String representing one Name of an additional Content piece.
void	getCSS()	Returns the Default CSS for this Layout. May be used by the Editors to preview HMTL.
void	getDescription()	Returns the Description of this Layout.
void	getFullURL()	Returns the Full URL to this Template.
void	getKeys()	Returns all configured Keys for this Layout.
void	getName()	Returns the Name of this Layout.
array	getPortletColumns()
void	getSetting()	Returns the configured Setting with the given Name or default (empty String) if none could be found.
void	getSize()	Return the File Size of this Layout.
void	getTitle()	Returns the Title of this Layout.
void	getURL()	Returns the URL to this Layout.
void	getURLForKey()	Returns the URL for the subKey to this Template.
void	hasPortletSupport()	Returns whether this Layout supports dynamic Portlets.
void	isPublic()	Returns whether this Layout is public and therefor may be visible within Dialogs.
void	isSystem()	Returns whether this Layout is a System Layout (which may not be public visible).
void	toString()	Returns the qualified String representation of this Layout to be appended to Command Links.

[ Top ]

Methods

Constructor Layout [line 61]

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

Initializes the Object with the given Name

Parameters:

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

[ Top ]

exists [line 232]

void exists(
)

Check whether this Layout really exist.

[ Top ]

existsKey [line 211]

void existsKey(
[
$key = ''] 
)

Checks if the given key exists in this Layout.

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

Parameters:

$key:

[ Top ]

getContentNames [line 191]

array getContentNames(
)

Returns an array of Strings, each String representing one Name of an additional Content piece.

Each of these Content pieces will be editable as HTML Content. If an empty array or null is returned, no additional content columns are defined.

API Tags:

Return:

an array of Strings, an empty array or null

Redefinition of:

MenuTemplate::getContentNames(): Returns an array of Strings, each String representing one Name of an additional Content piece.

[ Top ]

getCSS [line 180]

void getCSS(
)

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

[ Top ]

getDescription [line 107]

void getDescription(
)

Returns the Description of this Layout.

Redefinition of:

MenuTemplate::getDescription(): Returns the Description of this Template.

[ Top ]

getFullURL [line 164]

void getFullURL(
)

Returns the Full URL to this Template.

[ Top ]

getKeys [line 172]

void getKeys(
)

Returns all configured Keys for this Layout.

[ Top ]

getName [line 75]

void getName(
)

Returns the Name of this Layout.

Redefinition of:

MenuTemplate::getName(): Returns the Name of this Template.

[ Top ]

getPortletColumns [line 131]

array getPortletColumns(
)

API Tags:

Return:

an array of column names

Redefinition of:

MenuTemplate::getPortletColumns(): Returns an array of Strings, each String representing one Portlet column definition.

[ Top ]

getSetting [line 199]

void getSetting(

$name, [
$default = ''] 
)

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

Parameters:

	$name:
	$default:

[ Top ]

getSize [line 221]

void getSize(
)

Return the File Size of this Layout.

[ Top ]

getTitle [line 83]

void getTitle(
)

Returns the Title of this Layout.

[ Top ]

getURL [line 139]

void getURL(
)

Returns the URL to this Layout.

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

[ Top ]

getURLForKey [line 151]

void getURLForKey(

$key 
)

Returns the URL for the subKey to this Template.

Parameters:

$key:

[ Top ]

hasPortletSupport [line 115]

void hasPortletSupport(
)

Returns whether this Layout supports dynamic Portlets.

Redefinition of:

MenuTemplate::hasPortletSupport(): Returns whether this Layout supports dynamic Portlets.

[ Top ]

isPublic [line 91]

void isPublic(
)

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

[ Top ]

isSystem [line 99]

void isSystem(
)

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

[ Top ]

toString [line 240]

void toString(
)

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

[ Top ]