Class Module

Description

Located in /lib/Module.php (line 24)


	
			
Variable Summary
 mixed $category
 mixed $name
 string $page
 mixed $type
Method Summary
 void createNew (string $pageId, string $category, mixed $name, string $type, [bool $replaceTemplate = 1])
Variables
mixed $category (line 36)

Name of category for which this module operates. (Optional)

$var string

  • access: public
mixed $name (line 48)

The name of the file that holds the module code.

$var string

  • access: public
string $page (line 30)

Id of page for which this module operates. (Optional)

  • access: public
bool $replaceTemplate (line 55)

If true, template specified or implied for requested position will not be processed. Module output will be assumed to be the content.

  • access: public
mixed $type (line 42)

Module type specifies which region this module controls.

$var string

  • access: public
Methods
createNew (line 67)

Adds a new module defenition to the database.

It is possible to register a module for both a page and a category but this could lead to problems.

  • static:
  • access: public
void createNew (string $pageId, string $category, mixed $name, string $type, [bool $replaceTemplate = 1])
  • string $pageId: page for which this module should be registered
  • string $category: category for which this module should be registered
  • string $type: module type (header, footer, side[top|bottom])
  • bool $replaceTemplate: if true, template is removed, else module use assumed to compliment template

Documentation generated on Mon, 25 Oct 2004 15:21:44 -0700 by phpDocumentor 1.3.0RC3