Docs For Class Module

Class Overview

Module class (only useful if derived)

Located in /blogs/inc/_core/model/_module.class.php [line 29]

Direct descendents

Child Class	Description
_core_Module	_core_Module definition
files_Module	adsense_Module definition
sessions_Module	sessions_Module definition
maintenance_Module	maintenance_Module definition
messaging_Module	messaging_Module definition
collections_Module	adsense_Module definition

[ Top ]

Method Summary

void	build_evobar_menu()	Build teh evobar menu
void	build_menu_1()	Builds the 1st half of the menu. This is the one with the most important features
void	build_menu_2()	Builds the 2nd half of the menu. This is the one with the configuration features
void	build_menu_3()	Builds the 3rd half of the menu. This is the one with the configuration features
boolean	check_perm()	Check module permission
void	init()	Do the initializations. Called from in _main.inc.php.
void	SkinEndHtmlBody()	could be used e.g. by a google_analytics plugin to add the javascript snippet

[ Top ]

Methods

build_evobar_menu [line 47]

void build_evobar_menu(
)

Build teh evobar menu

Redefined in descendants as:

_core_Module::build_evobar_menu() : Build teh evobar menu
files_Module::build_evobar_menu() : Build teh evobar menu
sessions_Module::build_evobar_menu() : Build the evobar menu
messaging_Module::build_evobar_menu() : Build the evobar menu
collections_Module::build_evobar_menu() : Build teh evobar menu

[ Top ]

build_menu_1 [line 55]

void build_menu_1(
)

Builds the 1st half of the menu. This is the one with the most important features

Redefined in descendants as:

files_Module::build_menu_1() : Builds the 1st half of the menu. This is the one with the most important features
sessions_Module::build_menu_1() : Builds the 1st half of the menu. This is the one with the most important features
collections_Module::build_menu_1() : Builds the 1st half of the menu. This is the one with the most important features

[ Top ]

build_menu_2 [line 64]

void build_menu_2(
)

Builds the 2nd half of the menu. This is the one with the configuration features

At some point this might be displayed differently than the 1st half.

Redefined in descendants as:

collections_Module::build_menu_2() : Builds the 2nd half of the menu. This is the one with the configuration features

[ Top ]

build_menu_3 [line 74]

void build_menu_3(
)

Builds the 3rd half of the menu. This is the one with the configuration features

At some point this might be displayed differently than the 1st half.

Redefined in descendants as:

_core_Module::build_menu_3() : Builds the 3rd half of the menu. This is the one with the configuration features
files_Module::build_menu_3() : Builds the 3rd half of the menu. This is the one with the configuration features
sessions_Module::build_menu_3() : Builds the 3rd half of the menu. This is the one with the configuration features
maintenance_Module::build_menu_3() : Builds the 3rd half of the menu. This is the one with the configuration features
messaging_Module::build_menu_3() : Builds the 3rd half of the menu. This is the one with the configuration features
collections_Module::build_menu_3() : Builds the 3rd half of the menu. This is the one with the configuration features

[ Top ]

check_perm [line 95]

boolean check_perm(
string
$permname, string
$permlevel, mixed
$permtarget, string
$function 
)

Check module permission

Parameters:

string	$permname:	Permission name
string	$permlevel:	Requested permission level
mixed	$permtarget:	Permission target (blog ID, array of cat IDs...)
string	$function:	function name

API Tags:

Return:

True on success (permission is granted), false if permission is not granted NULL if permission not implemented.

Redefined in descendants as:

sessions_Module::check_perm() : Check global permissions for this module (not for specific object - those should be handled in the appropriate DataObject class)

[ Top ]

init [line 40]

void init(
)

Do the initializations. Called from in _main.inc.php.

This is typically where classes matching DB tables for this module are registered/loaded.

Note: this should only load/register things that are going to be needed application wide, for example: for constructing menus. Anything that is needed only in a specific controller should be loaded only there. Anything that is needed only in a specific view should be loaded only there.

Redefined in descendants as:

_core_Module::init() : Do the initializations. Called from in _main.inc.php.
files_Module::init() : Do the initializations. Called from in _main.inc.php.
sessions_Module::init() : Do the initializations. Called from in _main.inc.php.
maintenance_Module::init() : Do the initializations. Called from in _main.inc.php.
messaging_Module::init() : Do the initializations. Called from in _main.inc.php.
collections_Module::init() : Do the initializations. Called from in _main.inc.php.

[ Top ]

SkinEndHtmlBody [line 81]

void SkinEndHtmlBody(
)

could be used e.g. by a google_analytics plugin to add the javascript snippet

[ Top ]

Multilingual multiuser multiblog engine

Class: Module

Class Module

Packages

Classes

Files