Docs For Class WH

Description

Cambio v0.5a

http://cambiocms.org/

Located in /cms/includes/550_module.php (line 10)

Direct descendents

Class	Description
WH_AdminModule	Cambio v0.5a
WH_ModuleAdmin	Cambio v0.5a
WH_ModuleBreadcrumbs	Cambio v0.5a
WH_ModuleCathiel	Cambio v0.5a
WH_ModuleConfig	Cambio v0.5a
WH_ModuleDownload	Cambio v0.5a
WH_ModuleDynamic	Cambio v0.5a
WH_ModuleEmail	Cambio v0.5a
WH_ModuleGallery	Cambio v0.5a
WH_ModuleHeader	Cambio v0.5a
WH_ModuleHello	Cambio v0.5a
WH_ModuleHtml	Cambio v0.5a
WH_ModuleImage	Cambio v0.5a
WH_ModuleLang	Cambio v0.5a
WH_ModuleLayout	Cambio v0.5a
WH_ModuleLink	Cambio v0.5a
WH_ModuleList	Cambio v0.5a
WH_ModuleLogin	Cambio v0.5a
WH_ModuleMenu	Cambio v0.5a
WH_ModuleModules	Cambio v0.5a
WH_ModulePages	Cambio v0.5a
WH_ModulePrint	Cambio v0.5a
WH_ModuleQuote	Cambio v0.5a
WH_ModuleShare	Cambio v0.5a
WH_ModuleSIFR	Cambio v0.5a
WH_ModuleSwitchlang	Cambio v0.5a
WH_ModuleSwitchlayout	Cambio v0.5a
WH_ModuleTest	Cambio v0.5a
WH_ModuleText	Cambio v0.5a
WH_ModuleUser	Cambio v0.5a

Variable Summary

mixed $access

mixed $align

mixed $attr

mixed $buttons

mixed $id

mixed $module

mixed $ordering

mixed $pagina

mixed $pos

mixed $titel

mixed $tmpl

mixed $user_access

Method Summary

WH_Module WH_Module ( $data)

void delete ([boolean $batch = false])

void edit ()

array getAttrArray ( &$array, array $array)

WH_Module getInstance (integer $id)

array getParameterArray ( &$array, array $array)

void getTitle ( $newtitle, $customtitle, $id)

void hasLinks ([ $id = NULL])

void hideAdminCode ()

void loadModule ([ $rel = null], [ $admin = false])

void parseTmpl (string $file)

bool render ([string $tmpl = null])

void retrieveLangQuery ( $query, $lang, $contentfield)

void saveParameters ( &$postdata, [ $title = NULL], [ $id = NULL])

bool setProperties (integer $id)

void setTitle ([ $a = null], [ $b = null])

void writeModuleProperties ([array $parameters = null], [ $show = 0], [ $sidebar = true])

void _init ( $data)

void _initAttr ()

Variables

mixed $access (line 23)

mixed $align (line 22)

mixed $attr (line 25)

mixed $buttons (line 17)

mixed $id (line 12)

mixed $module (line 14)

mixed $ordering (line 21)

mixed $pagina (line 13)

mixed $pos (line 15)

mixed $titel (line 20)

mixed $tmpl (line 16)

mixed $user_access (line 24)

Methods

Constructor WH_Module (line 32)

Module class for WH website

WH_Module WH_Module ( $data)

$data

delete (line 428)

Default delete function

void delete ([boolean $batch = false])

boolean $batch

Redefined in descendants as:

edit (line 417)

Placeholder edit function

void edit ()

Redefined in descendants as:

getAttrArray (line 299)

Gets attr array and deletes from given input

array getAttrArray ( &$array, array $array)

array $array
&$array

getInstance (line 59)

Get instance creating one if necessary

WH_Module getInstance (integer $id)

integer $id

getParameterArray (line 287)

Gets parameter array and deletes from given input

array getParameterArray ( &$array, array $array)

array $array
&$array

getTitle (line 226)

Below are functions for module parameter handling

void getTitle ( $newtitle, $customtitle, $id)

$newtitle
$customtitle
$id

hasLinks (line 207)

void hasLinks ([ $id = NULL])

$id

hideAdminCode (line 407)

void hideAdminCode ()

loadModule (line 88)

Load the module

void loadModule ([ $rel = null], [ $admin = false])

$rel
$admin

parseTmpl (line 172)

Parse the template (and replace language strings)

void parseTmpl (string $file)

string $file

render (line 120)

Render the module, calling the specified template

bool render ([string $tmpl = null])

string $tmpl

retrieveLangQuery (line 386)

void retrieveLangQuery ( $query, $lang, $contentfield)

$query
$lang
$contentfield

saveParameters (line 244)

void saveParameters ( &$postdata, [ $title = NULL], [ $id = NULL])

&$postdata
$title
$id

setProperties (line 78)

Set properties according to data in WH_Modules

bool setProperties (integer $id)

integer $id

setTitle (line 277)

Compatibility

void setTitle ([ $a = null], [ $b = null])

$a
$b

writeModuleProperties (line 310)

Echoes Module parameter input admin screen for given parameters (in array $parameters)

void writeModuleProperties ([array $parameters = null], [ $show = 0], [ $sidebar = true])

array $parameters
$show
$sidebar

_init (line 38)

void _init ( $data)

$data

_initAttr (line 47)

void _initAttr ()