Skip to content

icms_module_Object

Jump to bottom
Raimondas Rimkevičius edited this page Mar 9, 2020 · 1 revision
Notice: Wiki was automatic generated from project sources as project API documentation. Do not edit manually!

icms_module_Object

A Module

  • Class name: icms_module_Object
  • Namespace:
  • Parent class: icms_ipf_Object

Properties

$config

public array $config = \null

Module configuration

  • Visibility: public

$modinfo

public string $modinfo
  • Visibility: public

$adminmenu

public array $adminmenu

AdminMenu of the module

  • Visibility: public

$adminheadermenu

public array $adminheadermenu

Header menu on admin of the module

  • Visibility: public

$messages

public array $messages

array for messages

  • Visibility: public

mid

public int mid

Module ID

  • Visibility: public

name

public string name

Name displayed for users

  • Visibility: public

version

public int version

Version

  • Visibility: public

last_update

public int last_update

Last update

  • Visibility: public

weight

public int weight

Weigth used for sorting modules on lists

  • Visibility: public

isactive

public int isactive

Is activated?

  • Visibility: public

dirname

public string dirname

Directory name

  • Visibility: public

hasmain

public int hasmain

Has main page?

  • Visibility: public

hasadmin

public int hasadmin

Has admin?

  • Visibility: public

hassearch

public int hassearch

Has search?

  • Visibility: public

hasconfig

public int hasconfig

Has config?

  • Visibility: public

hascomments

public int hascomments

Has comments?

  • Visibility: public

hasnotification

public int hasnotification

Has notifications?

  • Visibility: public

dbversion

public int dbversion

Database version

  • Visibility: public

modname

public string modname

Internal name

  • Visibility: public

ipf

public int ipf

Is this module IPF based?

  • Visibility: public

Methods

__construct

mixed icms_module_Object::__construct(mixed handler, mixed data)

Constructor

  • Visibility: public

Arguments

  • handler mixed
  • data mixed

launch

void icms_module_Object::launch()

Initializes the module/application.

This method is called during execution of icms::launchModule() to allow the module to setup its global structures.

  • Visibility: public

registerClassPath

void icms_module_Object::registerClassPath(bool isactive)

register class path with autoloader notice: this function may not be used for the system module

  • Visibility: public

Arguments

  • isactive bool - <p>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</p>

loadInfoAsVar

mixed icms_module_Object::loadInfoAsVar(string dirname, bool verbose)

Load module info

  • Visibility: public

Arguments

  • dirname string - <p>Directory Name</p>
  • verbose bool

getInfo

array|string|bool icms_module_Object::getInfo(string name)

Get module info

  • Visibility: public

Arguments

  • name string

getDBVersion

int icms_module_Object::getDBVersion()

Retreive the database version of this module

  • Visibility: public

mainLink

string icms_module_Object::mainLink()

Get a link to the modules main page

  • Visibility: public

subLink

string icms_module_Object::subLink()

Get links to the subpages

  • Visibility: public

loadAdminMenu

mixed icms_module_Object::loadAdminMenu()

Load the admin menu for the module

  • Visibility: public

getAdminMenu

string icms_module_Object::getAdminMenu()

Get the admin menu for the module

  • Visibility: public

getAdminHeaderMenu

string icms_module_Object::getAdminHeaderMenu()

Get the admin header menu for the module

  • Visibility: public

loadInfo

bool icms_module_Object::loadInfo(string dirname, bool verbose)

Load the module info for this module

  • Visibility: public

Arguments

  • dirname string - <p>Module directory</p>
  • verbose bool - <p>Give an error on fail?</p>

search

mixed icms_module_Object::search(string term, string andor, int limit, int offset, int userid)

Search contents within a module

  • Visibility: public

Arguments

  • term string
  • andor string - <p>'AND' or 'OR'</p>
  • limit int
  • offset int
  • userid int

displayAdminMenu

\datatype icms_module_Object::displayAdminMenu(int currentoption, string breadcrumb, bool submenus, int currentsub)

Displays the (good old) adminmenu

  • Visibility: public

Arguments

  • currentoption int - <p>The current option of the admin menu</p>
  • breadcrumb string - <p>The breadcrumb trail</p>
  • submenus bool - <p>Show the submenus!</p>
  • currentsub int - <p>The current submenu</p>

getAdminMenuItems

array icms_module_Object::getAdminMenuItems()

Get admin menu items for current module

  • Visibility: public

setMessage

mixed icms_module_Object::setMessage(string msg, string title, bool render)

Modules Message Function

  • Visibility: public

Arguments

  • msg string - <p>The Error Message</p>
  • title string - <p>The Error Message title</p>
  • render bool - <p>Whether to echo (render) or return the HTML string</p>

Clone this wiki locally