Class icms_module_Object

A Module

icms_core_Object

Extended by

icms_module_Object

Package: Module
Category: ICMS
Copyright: Copyright (c) 2000 XOOPS.org
License: LICENSE.txt
Author: Kazumi Ono onokazu@xoops.org
Located at module/Object.php

Methods summary
`public`	# `__construct( )` Constructor Constructor Overrides `icms_core_Object::__construct()`
`public`	# `launch( )` Initializes the module/application. This method is called during execution of icms::launchModule() to allow the module to setup its global structures. Initializes the module/application. This method is called during execution of icms::launchModule() to allow the module to setup its global structures.
`public`	# `registerClassPath( boolean $isactive = NULL )` register class path with autoloader notice: this function may not be used for the system module register class path with autoloader notice: this function may not be used for the system module Parameters `$isactive` if TRUE, the class path is only registered if the module is active if FALSE, the class path is only registered if the module is inactive
`public`	# `loadInfoAsVar( string $dirname, boolean $verbose = true )` Load module info Load module info Parameters `$dirname` Directory Name `$verbose`
`public array\|string &`	# `getInfo( string $name = null )` Get module info Get module info Parameters `$name` Returns array\|string Array of module information. If $name is set, returns a single module information item as string.
`public integer`	# `getDBVersion( )` Retreive the database version of this module Retreive the database version of this module Returns integer dbversion
`public string`	# `mainLink( )` Get a link to the modules main page Get a link to the modules main page Returns string $ret or FALSE on fail
`public string`	# `subLink( )` Get links to the subpages Get links to the subpages Returns string $ret
`public`	# `loadAdminMenu( )` Load the admin menu for the module Load the admin menu for the module
`public string &`	# `getAdminMenu( )` Get the admin menu for the module Get the admin menu for the module Returns string $this->adminmenu
`public string &`	# `getAdminHeaderMenu( )` Get the admin header menu for the module Get the admin header menu for the module Returns string $this->adminmenu
`public boolean`	# `loadInfo( string $dirname, boolean $verbose = true )` Load the module info for this module Load the module info for this module Parameters `$dirname` Module directory `$verbose` Give an error on fail? Returns boolean TRUE if success, FALSE if fail.
`public mixed`	# `search( string $term = '', string $andor = 'AND', integer $limit = 0, integer $offset = 0, integer $userid = 0 )` Search contents within a module Search contents within a module Parameters `$term` `$andor` 'AND' or 'OR' `$limit` `$offset` `$userid` Returns mixed Search result or False if fail.
`public datatype`	# `displayAdminMenu( integer $currentoption = 0, string $breadcrumb = '', boolean $submenus = false, integer $currentsub = -1 )` Displays the (good old) adminmenu Displays the (good old) adminmenu Parameters `$currentoption` The current option of the admin menu `$breadcrumb` The breadcrumb trail `$submenus` Show the submenus! `$currentsub` The current submenu Returns datatype description
`public`	# `setMessage( string $msg, string $title = '', boolean $render = false )` Modules Message Function Modules Message Function Parameters `$msg` The Error Message `$title` The Error Message title `$render` Whether to echo (render) or return the HTML string Author Sina Asghari (aka stranger) stranger@impresscms.org Since ImpressCMS 1.2

Methods inherited from icms_core_Object
`assignVar(), assignVars(), cleanVars(), getErrors(), getHtmlErrors(), getValues(), getVar(), getVars(), initVar(), isDirty(), isNew(), isNewConfig(), registerFilter(), setDirty(), setErrors(), setFormVars(), setNew(), setNewConfig(), setVar(), setVars(), unsetDirty(), unsetNew(), unsetNewConfig(), xoopsClone()`

Properties summary
`public array`	`$config` Module configuration Module configuration	# `NULL`
`public string`	`$modinfo`	#
`public array`	`$adminmenu` AdminMenu of the module AdminMenu of the module	#
`public array`	`$adminheadermenu` Header menu on admin of the module Header menu on admin of the module	#
`public array`	`$messages` array for messages array for messages	#

Properties inherited from icms_core_Object
`$_isNewConfig, $cleanVars, $vars`