Class: MenuTemplate

Source Location: /CORE/system/api/menu/MenuTemplate.php

Class MenuTemplate

Class Overview

This represents a MenuTemplate, that is used to render a requested Menu.

Located in /CORE/system/api/menu/MenuTemplate.php [line 35]



		
				Author(s):
		
  • Kevin Papst
Information Tags:
Version:  $Id: MenuTemplate.php,v 1.3 2008/06/03 20:15:36 kpapst Exp $
Copyright:  Copyright (C) 2002-2006 Kevin Papst
License:  GNU Public License

Methods

[ Top ]
Descendants
Child Class Description
SmartyDesign This represents a Design which is chooseable in the Menu Administration.
Layout A Layout is a Defintion of a set of PHP Pages.

[ Top ]
Method Summary
array   getContentNames()   Returns an array of Strings, each String representing one Name of an additional Content piece.
String   getDescription()   Returns the Description of this Template.
String   getName()   Returns the Name of this Template.
array   getPortletColumns()   Returns an array of Strings, each String representing one Portlet column definition.
boolean   hasPortletSupport()   Returns whether this Layout supports dynamic Portlets.

[ Top ]
Methods
getContentNames  [line 80]

  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


Redefined in descendants as:

[ Top ]
getDescription  [line 49]

  String getDescription( )

Returns the Description of this Template.


API Tags:
Return:  the Template Description


Redefined in descendants as:

[ Top ]
getName  [line 41]

  String getName( )

Returns the Name of this Template.


API Tags:
Return:  the Template Name


Redefined in descendants as:

[ Top ]
getPortletColumns  [line 70]

  array getPortletColumns( )

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

Each of these Strings will be represented in the Portlet Administration as a Select Box. If an empty array or null is returned, the default value will be taken: See constant PORTLET_DEFAULT_COLUMN.


API Tags:
Return:  an array of Strings, an empty array or null


Redefined in descendants as:

[ Top ]
hasPortletSupport  [line 57]

  boolean hasPortletSupport( )

Returns whether this Layout supports dynamic Portlets.


API Tags:
Return:  if portlets are supported


Redefined in descendants as:

[ Top ]