Class: GALContainer_frontend

Source Location: /gallue/GALContainer_frontend.inc.php

Class Overview

GALItem_frontend
   |
   --GALContainer_frontend

Abstract base class to handle container-like items in gallue.

Author(s):

Child classes:

GALCategory_frontend: Generates XHTML markup to display/create/edit instances of GALCategory.

GALFilm_frontend: Generates XHTML markup to display/create/edit instances of GALFilm.

GALSeries_frontend: Generates XHTML markup to display/create/edit instances of GALSeries.

GALGroup_frontend: Generates XHTML markup to display/create/edit instances of GALGroup.

Inherited Variables

Class: GALItem_frontend

GALItem_frontend::$container
GALItem_frontend::$containerFrontend
GALItem_frontend::$glb
GALItem_frontend::$langs

Inherited Methods

Class: GALItem_frontend

GALItem_frontend::__construct()
GALItem_frontend::action(): Executes an one-click action.
GALItem_frontend::appendEdit()
GALItem_frontend::appendInput_comment()
GALItem_frontend::appendInput_permission()
GALItem_frontend::appendInput_sortHint()
GALItem_frontend::appendInput_tag()
GALItem_frontend::appendInput_title()
GALItem_frontend::button()
GALItem_frontend::calculateNavbar(): Calculates offsets for a logarithmic navigation bar.
GALItem_frontend::countSelection()
GALItem_frontend::create(): Displays a form for creating a new item.
GALItem_frontend::defaultEditFields()
GALItem_frontend::edit(): Evaluates the settings in the global GALGlobalvars object and determines which method to call with wich parameters.
GALItem_frontend::editFields()
GALItem_frontend::editSingle(): Displays a form to edit a single item.
GALItem_frontend::evalEdit()
GALItem_frontend::evalEdit_permission()
GALItem_frontend::execute(): Evaluates the transmitted POST data.
GALItem_frontend::fastMenu(): Evaluates the settings in the global GALGlobalvars object and displays a list of links for fast switching of the current item, e.g. for editing.
GALItem_frontend::getContainer()
GALItem_frontend::getContainerFrontend()
GALItem_frontend::getMultiFrontend()
GALItem_frontend::getPlural()
GALItem_frontend::getSingular()
GALItem_frontend::getTable()
GALItem_frontend::getTarget(): Returns the string that is used to identify the target class.
GALItem_frontend::layoutMenu(): Evaluates the settings in the global GALGlobalvars object and displays a list of links with available layout variants.
GALItem_frontend::navbar(): Displays a navigation bar.
GALItem_frontend::navdiv()
GALItem_frontend::order(): Builds a GALOrder object.
GALItem_frontend::permission2str()
GALItem_frontend::registerVars(): Registers the necessary GET parameters.
GALItem_frontend::selection(): Builds a GALExpression.
GALItem_frontend::show(): Evaluates the settings in the global GALGlobalvars object and determines which method to call with wich parameters.
GALItem_frontend::str2permission()

Class Details

[line 33]
Abstract base class to handle container-like items in gallue.

This class defines some generic methods that are useful to display, edit or create container-like items like e.g. groups, films or categories.

Tags:

abstract:

[ Top ]

Class Methods

static method registerVars [line 378]

static void registerVars(

$globalvars)

Overrides GALItem_frontend::registerVars() (Registers the necessary GET parameters.)

Parameters:

$globalvars

[ Top ]

method action [line 350]

void action(
string
$action, int
$id, 
$param1, 
$param2)

This method executes one click actions.

It performs actions like deleting items according to the GET parameters 'action' and 'id'.

Overrides GALItem_frontend::action() (Executes an one-click action.)

Parameters:

string	$action	This class supports 'delete'.
int	$id	A image ID.
	$param1
	$param2

[ Top ]

method contentOrder [line 377]

GALOrder contentOrder(
[string
$target = 'image'])

A GALOrder that determines the order of the items inside this container.

The $target parameter is introduced for the GALFolder class that will be implemented later.

Parameters:

string

$target

If a container contains items of different types

[ Top ]

method contentSelection [line 370]

GALExpression contentSelection(
[string
$target = 'image'])

A GALExpression that determines the items inside this container that are displayed.

The $target parameter is introduced for the GALFolder class that will be implemented later.

Parameters:

string

$target

If a container contains items of different types

[ Top ]

method countContentSelection [line 381]

void countContentSelection(

$row, [
$target = 'image'])

Parameters:

GALTableRow	$row
	$target

[ Top ]

method fastMenu [line 41]

DOMElement fastMenu(

$node)

Displays a menu with elements of the current selection.

This method appends a menu with links to GALImage objects that are close to the item viewed currently.

Tags:

return:

The <ul> tag or FALSE if empty selection.

Overrides GALItem_frontend::fastMenu() (Evaluates the settings in the global GALGlobalvars object and displays a list of links for fast switching of the current item, e.g. for editing.)

Parameters:

DOMNode

$node

The node the menu is appended to.

[ Top ]

method getMultiFrontend [line 382]

void getMultiFrontend(
[
$items = false])

Overridden in child classes as:

GALCategory_frontend::getMultiFrontend()

GALFilm_frontend::getMultiFrontend()

GALSeries_frontend::getMultiFrontend()

GALGroup_frontend::getMultiFrontend()

Overrides GALItem_frontend::getMultiFrontend() (parent method not documented)

Parameters:

$items

[ Top ]

method layoutMenu [line 276]

DOMElement layoutMenu(

$node)

Displays a menu with all layouts suitable for this class.

This method appends a list of all layouts that can be displayed by this class to the given DOMNode.

Tags:

return:

An <ul> tag or FALSE, if no layout available (improbable).

Overrides GALItem_frontend::layoutMenu() (Evaluates the settings in the global GALGlobalvars object and displays a list of links with available layout variants.)

[ Top ]

method navbar [line 385]

void navbar(

$count, 
$step, 
$node)

Overrides GALItem_frontend::navbar() (Displays a navigation bar.)

Parameters:

	$count
	$step
DOMNode	$node

[ Top ]

method show [line 180]

DOMNode show(

$node)

Generates the XHTML markup for the textfield.

This method is called in GALView::build() with the textfield as argument. By evaluating the GET parameters if the GALGlobalVars object it decides which item(s) to load and delegates the displaying to the appropiate methods.

Tags:

return:

A tag or text element. It depends on what is displayed.

Overrides GALItem_frontend::show() (Evaluates the settings in the global GALGlobalvars object and determines which method to call with wich parameters.)

Parameters:

DOMNode

$node

The node the output is appended to.

[ Top ]

Documentation generated on Wed, 16 Aug 2006 15:35:45 +0200 by phpDocumentor 1.3.0RC6