SourceForge.net LogoPHPGallue
[ class tree: gallue ] [ index: gallue ] [ all elements ]
Packages:
gallue
libbase
libgallue
remotegallue
setup


Files:
cleanup.php
export.php
exportlib.inc.php
GALCategory_frontend.inc.php
GALContainer_frontend.inc.php
GALFilm_frontend.inc.php
GALFrontendTranslation.inc.php
GALGroup_frontend.inc.php
GALHelp_frontend.inc.php
GALImage_frontend.inc.php
GALItem_frontend.inc.php
gallerybase.inc.php
gallue.inc.php
GALSeries_frontend.inc.php
GALUser_frontend.inc.php
gsitemap.php
index.php
libgsitemap.inc.php
view.inc.php

Classes:
GALCategory_frontend
GALCategory_multiFrontend
GALCategory_singleFrontend
GALContainer_frontend
GALContainer_multiFrontend
GALContainer_singleFrontend
GALExportPage
GALFilm_frontend
GALFilm_multiFrontend
GALFilm_singleFrontend
GALFrontendTranslation
GALGallerybase
GALGlobals
GALGroup_frontend
GALGroup_multiFrontend
GALGroup_singleFrontend
GALHelp_frontend
GALHelp_multiFrontend
GALHelp_singleFrontend
GALImage_frontend
GALImage_multiFrontend
GALImage_singleFrontend
GALItem_frontend
GALItem_multiFrontend
GALItem_singleFrontend
GALSeries_frontend
GALSeries_multiFrontend
GALSeries_singleFrontend
GALSitemap
GALUser_frontend
GALUser_multiFrontend
GALUser_singleFrontend
GALView
GAL_HTMLExport
exceptions
   GALCategory_frontendException
   GALFilm_frontendException
   GALGroup_frontendException
   GALHelp_frontendException
   GALImage_frontendException
   GALSeries_frontendException
   GALUser_frontendException
   GAL_EHTMLExport
   GAL_ESitemap

Class: GALHelp_frontend

Source Location: /gallue/GALHelp_frontend.inc.php

Class Overview

GALItem_frontend
   |
   --GALHelp_frontend

Generates XHTML markup to display/create/edit instances of GALHelp.

Methods

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 36]
Generates XHTML markup to display/create/edit instances of GALHelp.

This class implements the abstract methods in GALItem_frontend for help items.




[ Top ]

Class Methods

method action [line 499]

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 help ID.
   $param1  
   $param2  

[ Top ]

method create [line 42]

DOMElement create( $node)

Appends a form to create help items to the given DOMNode.



Tags:

return:  The <form> tag.


Overrides GALItem_frontend::create() (Displays a form for creating a new item.)

Parameters:

DOMNode   $node   The node the form is appended to.

[ Top ]

method edit [line 164]

DOMNode edit( $node)

Generates the XHTML markup for the textfield.

This method is called in GALView::build() with the textfield as argument. It is called if the editTarget parameter is help.




Tags:

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


Overrides GALItem_frontend::edit() (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 ]

method editSingle [line 335]

void editSingle( $help, $node)

Display a form to edit a help item.

Not implemented for help items because of support for multiple languages.




Tags:

see:  GALItem_frontend::editMultiple()


Overrides GALItem_frontend::editSingle() (Displays a form to edit a single item.)

Parameters:

GALTableRow   $help  
DOMNode   $node  

[ Top ]

method execute [line 446]

void execute( array &$postvars)

Evaluates POST parameters.

This method evaluates the given POST parameters which are sent by forms created in create(), editMultiple or editSingle.




Overrides GALItem_frontend::execute() (Evaluates the transmitted POST data.)

Parameters:

array   &$postvars   Reference to an array that contains the POST data.

[ Top ]

method fastMenu [line 227]

DOMElement fastMenu( $node)

Displays a menu with elements of the current selection.

This method appends a menu with links to GALHelp 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 541]

void getMultiFrontend( [ $items = false])



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

Parameters:

   $items  

[ Top ]

method getPlural [line 539]

void getPlural( )



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

[ Top ]

method getSingular [line 540]

void getSingular( )



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

[ Top ]

method getTable [line 536]

void getTable( )



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

[ Top ]

method getTarget [line 533]

void getTarget( )



Overrides GALItem_frontend::getTarget() (Returns the string that is used to identify the target class.)

[ Top ]

method layoutMenu [line 190]

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 order [line 518]

GALOrder order( )

Builds an instance of GALOrder.

The returned GALOrder represents the ordering that is used to display help items. In many methods it is important that offsets are the same for an item in multiple queries. In the future this method will evalute GET parameters.




Overrides GALItem_frontend::order() (Builds a GALOrder object.)

[ Top ]

method selection [line 529]

GALExpression selection( )

Builds an instance of GALExpression.

The returned GALExpression represents a SQL expression that is TRUE for items that are displayed. In many methods it is important that offsets are the same for an item in multiple queries. In the future this method will evalute GET parameters.




Overrides GALItem_frontend::selection() (Builds a GALExpression.)

[ Top ]

method show [line 121]

DOMNode show( $node)

Generates the XHTML markup for the textfield.

This method is called in GALView::build() with the textfield as argument.




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:52 +0200 by phpDocumentor 1.3.0RC6