com.lokorin.lokorin.lib
[ class tree: com.lokorin.lokorin.lib ] [ index: com.lokorin.lokorin.lib ] [ all elements ]

Class: DetailsModule

Source Location: /_includes/lib_admin_panel.php

Class Overview

AdminModule
   |
   --DetailsModule

Describes a module that shows read only contents of a specified row.


Author(s):

  • Andreas Launila

Variables

Methods


Inherited Variables

Inherited Methods

Class: AdminModule

AdminModule::__construct()
Constructor for AdminModule.
AdminModule::getAdminActions()
Gets all admin actions handled by the module.
AdminModule::getEntryLinkPattern()
Override this function if the module should be linked to once for every entry displayed in the panel's overview. The pattern can use fieldnames as $row['foo'] (where foo is the fieldname).
AdminModule::getGlobalLinkPattern()
Override this function if the module should be linked to once in the panel.
AdminModule::getOutput()
Gets the output that the module wants to diaply.
AdminModule::handlesAction()
Checks if an action can be handled by the module.
AdminModule::logActivity()
Notifies everything that should be notified of admin activity. This function should be called whenever a module alters a table.

Class Details

[line 861]
Describes a module that shows read only contents of a specified row.



Tags:

author:  Andreas Launila


[ Top ]


Class Variables

$callbacks =

[line 884]

Contains all format callbacks with the corresponding table field as key and the callback as value.



Tags:

access:  private

Type:   array


[ Top ]

$fieldsToView =

[line 872]

Contains TableField instances representing the fields that should be viewed in the detailed overview.



Tags:

access:  private

Type:   array


[ Top ]

$idFields =

[line 878]

Contains the fields (as TableField instances) that identify which row that should be viewed.



Tags:

access:  private

Type:   array


[ Top ]

$table =

[line 866]

The table that should be read from.



Tags:

access:  private

Type:   string


[ Top ]



Class Methods


constructor __construct [line 897]

DetailsModule __construct( string $table, array $fieldsToView, array $idFields, [array $formatCallbacks = array()])

Constructor for DetailsModule.



Tags:

access:  public


Overrides AdminModule::__construct() (Constructor for AdminModule.)

Parameters:

string   $table   The table to read from.
array   $fieldsToView   The TableField instances that should be shown in the detailed version.
array   $idFields   The Tablefield instances that identifies which row that contains the specified entry.
array   $formatCallbacks   An optional set of callbacks that should be used to format output (i.e. timestamps). The key should be the corresponding table field.

[ Top ]

method getEntryLinkPattern [line 943]

void getEntryLinkPattern( )



Tags:

access:  public
see:  AdminModule.getEntryLinkPattern()


Overrides AdminModule::getEntryLinkPattern() (Override this function if the module should be linked to once for every entry displayed in the panel's overview. The pattern can use fieldnames as $row['foo'] (where foo is the fieldname).)

[ Top ]

method getOutput [line 912]

void getOutput( mixed $action)



Tags:

access:  public
see:  AdminModule.getOutput($action)


Overrides AdminModule::getOutput() (Gets the output that the module wants to diaply.)

[ Top ]


Documentation generated on Sun, 16 Apr 2006 21:03:09 +0200 by phpDocumentor 1.3.0RC4