Class: Module

Source Location: /include/module.php

Class Module

Class Overview

This class provides some basic functionality for every epesi module.

Located in /include/module.php [line 19]

ModuleAcl
   |
   --ModulePrimitive
      |
      --Module

Author(s):

Paul Bukowski <pbukowski@telaxus.com>

API Tags:

Abstract:

Information Tags:

Version:	1.0
Copyright:	Copyright © 2006, Telaxus LLC

Properties

Methods

[ Top ]

Descendants

Child Class	Description
Applets_Birthdays
Applets_Calc
Applets_Clock	Flash clock (clock taken from http://www.kirupa.com/developer/actionscript/clock.htm)
Applets_Google
Applets_GTalk
Applets_Host	Gets host ip or domain
Applets_MonthView
Applets_Note
Applets_RssFeed	Simple RSS Feed applet
Apps_Forum
Apps_Gallery
Apps_MailClient	Simple mail client
Apps_Shoutbox
Apps_StaticPage
Apps_Timetrack
Apps_TwisterGame
Base_About	About Epesi
Base_ActionBar	ActionBar
Base_Admin	This class provides administration menu. Just place admin(), admin_caption() (and admin_access()) functions inside your module.
Base_Backup	Backup class.
Base_Box	Box class.
Base_Dashboard	Something like igoogle
Base_Error	Provides error to mail handling.
Base_Lang_Administrator	Lang_Administrator class.
Base_Mail_ContactUs	Mail_ContactUs class.
Base_Mail	Mail class.
Base_MainModuleIndicator	MainModuleIndicator class.
Base_MaintenanceMode_Administrator	MaintenanceMode class.
Base_Menu	Menu class.
Base_ModuleManager
Base_Navigation	Navigation component: back, refresh, forward.
Base_Search	Search class.
Base_Setup	This class provides for administration of modules.
Base_StatusBar	Fancy statusbar.
Base_Theme_Administrator	Theme_Administrator class.
Base_Theme	Provides module templating.
Base_User_Administrator	User_Administrator class.
Base_User_Login	Login class.
Base_User_Settings	User_Settings class.
CRM_Calendar
CRM_Calendar_Reports	Simple reports for CRM Calendar
CRM_Contacts_Activities	Activities history for Company and Contacts
CRM_Contacts	CRM Contacts class.
CRM_Filters
CRM_Import	Import data from csv file
CRM_LoginAudit	Provides login audit log
CRM_MailClient	Apps/MailClient and other CRM functions connector
CRM_PhoneCall	CRM Phone Call Class
CRM_Tasks
CRM_WhoIsOnline	Shows who is logged to epesi.
Custom_TasksModified	Example Tasks modifications
Data_Countries
Develop_ModuleCreator	TODO: add menu entries, php editor
Develop_ModuleEditor	Epesi developer editor
Develop_TableBrowserCreator
FirstRun
Tests_Attachment
Tests_BookmarkBrowser
Tests_Bugtrack	Software Development - Bug Tracking
Tests_Calendar
Tests_Callbacks_a
Tests_Callbacks	Example event module
Tests_Codepress	Example event module
Tests_Colorpicker
Tests_Comment
Tests_FPDF
Tests_GenericBrowser
Tests_Image
Tests_Lang
Tests_Leightbox
Tests_Lytebox
Tests_Menu
Tests_OpenFlashChart	Testing flash charts
Tests_QuickForm
Tests_Report
Tests_Search
Tests_SharedUniqueHref_a
Tests_SharedUniqueHref
Tests_TabbedBrowser
Tests_Tooltip
Tests_Wizard	WizardTest class.
Tools_FontSize	Tools_FontSize class.
Tools_WhoIsOnline	Shows who is logged to epesi.
Utils_Attachment_Administrator
Utils_Attachment	Use this module if you want to add attachments to some page.
Utils_BookmarkBrowser	Utils_BookmarkBrowser.
Utils_Calendar
Utils_Calendar_Event	This class provides some basic functionality for every epesi module.
Utils_CatFile	CatFileInstall class.
Utils_Comment
Utils_CommonData
Utils_CustomMenu
Utils_DirtyRead	This class delivers functions protecting against dirty reads.
Utils_ExportXLS
Utils_FileDownload
Utils_FileUpload	Uploads file
Utils_Gallery	Utils_Gallery One-method module for displaying images from one directory.
Utils_GenericBrowser	This class provides some basic functionality for every epesi module.
Utils_LeightboxPrompt
Utils_Menu	Utils_Menu Module for creating menus. Very easy.
Utils_Messenger	TODO: save users in autosave==false mode
Utils_Path	Utils_Path Module for creating path like You know from most GTK applications.
Utils_RecordBrowser	RecordBrowserCommon class.
Utils_RecordBrowser_RecordPicker
Utils_RecordBrowser_Reports
Utils_TabbedBrowser	TabbedBrowser class.
Utils_Tree
Utils_Watchdog
Utils_Wizard	Wizard class.

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From ModulePrimitive

ModulePrimitive::__construct()

ModulePrimitive::check_access()

Checks access to function which name is passed as first parameter.

ModulePrimitive::create_data_dir()

Creates default data directory for module. Typical usage: in module installation

ModulePrimitive::get_data_dir()

Returns path to the default data directory for module calling this method.

ModulePrimitive::get_module_dir()

Returns path to the module directory.

ModulePrimitive::get_type()

Returns name(type) of module that called this function.

ModulePrimitive::get_type_with_bt()

ModulePrimitive::remove_data_dir()

Removes default data directory of a module. Typical usage: in module uninstallation

Inherited From ModuleAcl

ModuleAcl::acl_check()

ModuleAcl::add_aco()

ModuleAcl::del_aco()

ModuleAcl::get_type()

[ Top ]

Property Summary

mixed	$children
mixed	$display_func
mixed	$parent

[ Top ]

Method Summary

static string	create_confirm_href()	Create onClick action string (with href="javascript:void(0);").
static string	create_href()	Create onClick action string (with href="javascript:void(0);").
static string	create_href_js()	Create onClick action string destined for js code.
static void	register_method()
static mixed	&static_get_module_variable()	Returns value of a module variable. If the variable is not set, function will return value given as third parameter.
static bool	static_isset_module_variable()	Checks if variable exists.
static void	static_set_module_variable()	Sets variable that will be available only for module instance that called this function.
static void	static_unset_module_variable()
Module	__construct()	Constructor. Should not be called directly using new Module('name').
void	call_callback_href()
void	clear_module_variables()	Unset all module variables.
string	create_back_href()	Creates link that will lead back to previous page content.
void	create_back_href_js()
string	create_callback_href()	Creates link similar to link created with create_href.
string	create_callback_href_js()	Creates link similar to link created with create_href.
string	create_callback_href_with_id()	Creates link similar to links created with create_href.
string	create_callback_href_with_id_js()	Creates link similar to links created with create_href.
string	create_confirm_callback_href()	Creates link similar to link created with create_href.
string	create_confirm_callback_href_with_id()	Creates link similar to links created with create_href.
string	create_confirm_unique_href()	Similar to create_href, but variables passed to this function will only be accessible in module that called this function.
string	create_unique_href()	Similar to create_href, but variables passed to this function will only be accessible in module that called this function.
string	create_unique_href_js()	Create onClick action string destined for js code.
string	create_unique_key()	Returns unique key name, generated from unique name of this module (function get_path) and string parameter.
true	displayed()	Returns whether this module instance was already displayed.
mixed	display_module()	Call method of the module passed as first parameter, which name is passed as second parameter.
void	freeze_module()	Makes child module to not loose its module variables
module	&get_child()	Gets child module with specified node id.
array	&get_children()	Gets array of children modules.
mixed	get_html_of_module()	Call method of the module passed as first parameter, which name is passed as second parameter.
mixed	get_instance_id()	Returns id of module instance.
array	get_jses()	Returns list of jses to evaluate.
mixed	&get_module_variable()	Returns value of a module variable. If the variable is not set, function will return value given as second parameter.
mixed	&get_module_variable_or_unique_href_variable()	Returns href variable.
string	get_node_id()	Get node identifier.
string	get_parent_path()	Returns unique path of parent module.
string	get_parent_type()	Returns name(type) of parent module.
string	get_path()	Returns unique path of calling module.
bool	get_reload()	Returns current reload settings.
mixed	get_unique_href_variable()	Returns variable passed with create_unique_href.
mixed	init_module()	Creates module instance which name is given as first parameter.
bool	isset_module_variable()	Checks if variable exists.
bool	isset_unique_href_variable()	Checks if variable given as first parameter was passed with create_unique_href function.
bool	is_back()	Checks if set_back_location was used.
true	is_fast_process()	Returns whether this module instance has fast processing turned on.
true	is_inline_display()	Returns whether this module instance is displayed inline.
void	js()	Appends js code to list of jses to evaluate.
void	mark_displayed()	Marks this module instance as it was displayed.
mixed	pack_module()	Creates instance of module given as first parameter as a child of the module that has called this function.
void	set_back_location()	Sets reload location to previous page display.
void	set_fast_process()	Enable fast processing for this module instance.
void	set_inline_display()	Changes display behavior for this module instance to inline.
void	set_module_variable()	Sets variable that will be available only for module instance that called this function.
void	set_reload()	Mark module to force its reload or prevent being reloaded.
bool	share_module_variable()	Share variable passed as first parameter with module passed as second parameter.
bool	share_unique_href_variable()	Share href variable passed as first parameter with module passed as second parameter.
void	unset_module_variable()	Unset module variable.
void	unset_unique_href_variable()	Unsets *unique_href variable.
void	&__call()

[ Top ]

Properties

mixed $children = array() [line 21]

API Tags:

Access:

protected

[ Top ]

mixed $display_func = false [line 33]

API Tags:

Access:

public

[ Top ]

mixed $parent = null [line 20]

API Tags:

Access:

protected

[ Top ]

Methods

static method create_confirm_href [line 382]

static string create_confirm_href(
string
$confirm, [
$variables = array ()], [string
$indicator = null], [string
$mode = null] 
)

Create onClick action string (with href="javascript:void(0);").

Use variables passed as first parameter, to generate variables accessible by $_REQUEST array. This function will trigger js confirm dialog before launching processing. If cancelled, no processing will be done.

<xmp> print('<a '.$this->create_href(array('somekey'=>'somevalue'))).'>Link</a>'); </xmp>

Parameters:

string	$confirm:	question displayed in confirmation box
array	$variables:	variables to pass along with href
string	$indicator:	status bar indicator text
string	$mode:	block, allow, queue click on simutanous click

API Tags:

Return:	href string
Access:	public

[ Top ]

static method create_href [line 362]

static string create_href(
[
$variables = array ()], [string
$indicator = null], [string
$mode = null] 
)

Create onClick action string (with href="javascript:void(0);").

Use variables passed as first parameter, to generate variables accessible by $_REQUEST array.

<xmp> print('<a '.$this->create_href(array('somekey'=>'somevalue'))).'>Link</a>'); </xmp>

Parameters:

array	$variables:	variables to pass along with href
string	$indicator:	status bar indicator text
string	$mode:	block, allow, queue click on simutanous click

API Tags:

Return:	href string
Access:	public

[ Top ]

static method create_href_js [line 343]

static string create_href_js(
[
$variables = array ()], [string
$indicator = null], [string
$mode = null] 
)

Create onClick action string destined for js code.

Use variables passed as first parameter, to generate variables accessible by $_REQUEST array.

<xmp> print('<a '.$this->create_href(array('somekey'=>'somevalue'))).'>Link</a>'); </xmp>

Parameters:

array	$variables:	variables to pass along with href
string	$indicator:	status bar indicator text
string	$mode:	block, allow, queue click on simutanous click

API Tags:

Return:	href string
Access:	public

[ Top ]

static method register_method [line 942]

static void register_method(

$name, 
$func 
)

Parameters:

	$name:
	$func:

API Tags:

Access:

public

[ Top ]

static method static_get_module_variable [line 198]

static mixed &static_get_module_variable(
integer
$path, string
$name, [string
$default = null], mixed
3 
)

Returns value of a module variable. If the variable is not set, function will return value given as third parameter.

For details concerning module variables, see set_module_variable.

Parameters:

mixed	3:	default value
integer	$path:	client id
string	$name:	module path (returned by get_path() method);
string	$default:	key

API Tags:

Return:	value
Access:	public

[ Top ]

static method static_isset_module_variable [line 245]

static bool static_isset_module_variable(
integer
$path, string
$name, string
2 
)

Checks if variable exists.

For details concerning module variables, see set_module_variable.

Parameters:

string	2:	key
integer	$path:	client id
string	$name:	module path (returned by get_path() method);

API Tags:

Return:	true if variable exists, false otherwise
Access:	public

[ Top ]

static method static_set_module_variable [line 167]

static void static_set_module_variable(
integer
$path, string
$name, string
$value, mixed
3 
)

Sets variable that will be available only for module instance that called this function.

Note that after page refresh, this variable will preserve its value in contrary to module field variables. Module variables are hold separately for every client.

Parameters:

mixed	3:	value
integer	$path:	client id
string	$name:	module path (returned by get_path() method);
string	$value:	key

API Tags:

Access:

public

[ Top ]

static method static_unset_module_variable [line 260]

static void static_unset_module_variable(

$path, 
$name 
)

Parameters:

	$path:
	$name:

API Tags:

Access:

public

[ Top ]

Constructor __construct [line 41]

Module __construct(
string
$type, 
$parent, 
$name, 
$clear_vars 
)

Constructor. Should not be called directly using new Module('name').

Use $this->pack_module or $this->init_module (inside other module).

Parameters:

string	$type:	module name
	$parent:
	$name:
	$clear_vars:

API Tags:

Access:

public

Redefinition of:

ModulePrimitive::__construct()

[ Top ]

call_callback_href [line 520]

void call_callback_href(

$func, [
$args = null] 
)

Parameters:

	$func:
	$args:

API Tags:

Access:

public

[ Top ]

clear_module_variables [line 268]

void clear_module_variables(
)

Unset all module variables.

For details concerning module variables see set_module_variable.

API Tags:

Access:

public

[ Top ]

create_back_href [line 633]

string create_back_href(
[integer
$i = 1], [string
$indicator = null], [string
$mode = null] 
)

Creates link that will lead back to previous page content.

Use is_back to check it was called.

Parameters:

integer	$i:	number of times isback() should return true after this link is used
string	$indicator:	status bar indicator text
string	$mode:	block, allow, queue click on simutanous click

API Tags:

Return:	string that should be placed inside html tag. See create_href for example.
Access:	public

[ Top ]

create_back_href_js [line 637]

void create_back_href_js(
[
$i = 1], [
$indicator = null], [
$mode = null] 
)

Parameters:

	$i:
	$indicator:
	$mode:

API Tags:

Access:

public

[ Top ]

create_callback_href [line 496]

string create_callback_href(
mixed
$func, [mixed
$args = null], [string
$indicator = null], [string
$mode = null] 
)

Creates link similar to link created with create_href.

The link, when used, will lead to calling of function which name is given as first parameter. Callback returns true if you use this link again after page refresh.

WARNING: id of callback is generated using arguments passed to this function, so if you want to create callback that run on every page reload, with different arguments, use create_callback_href_with_id

Parameters:

mixed	$func:	function
mixed	$args:	arguments
string	$indicator:	status bar indicator text
string	$mode:	block, allow, queue click on simutanous click

API Tags:

Return:	href string
Access:	public

[ Top ]

create_callback_href_js [line 515]

string create_callback_href_js(
mixed
$func, [mixed
$args = null], [string
$indicator = null], [
$mode = null] 
)

Creates link similar to link created with create_href.

The link, when used, will lead to calling of function which name is given as first parameter. Callback returns true if you use this link again after page refresh.

Parameters:

mixed	$func:	function
mixed	$args:	arguments
string	$indicator:	status bar indicator text
	$mode:

API Tags:

Return:	href string
Access:	public

[ Top ]

create_callback_href_with_id [line 579]

string create_callback_href_with_id(
string
$name, mixed
$func, [mixed
$args = null], [string
$indicator = null], [string
$mode = null] 
)

Creates link similar to links created with create_href.

The link, when used, will lead to calling of function which name is given as first parameter. Callback returns true if you use this link again after page refresh.

Parameters:

string	$name:	callback id (name)
mixed	$func:	function
mixed	$args:	arguments
string	$indicator:	status bar indicator text
string	$mode:	block, allow, queue click on simutanous click

API Tags:

Access:

public

[ Top ]

create_callback_href_with_id_js [line 595]

string create_callback_href_with_id_js(
string
$name, mixed
$func, [
$args = null], [
$indicator = null], [
$mode = null] 
)

Creates link similar to links created with create_href.

The link, when used, will lead to calling of function which name is given as first parameter. Callback returns true if you use this link again after page refresh.

Parameters:

string	$name:	callback id (name)
mixed	$func:	function
	$args:
	$indicator:
	$mode:

API Tags:

Access:

public

[ Top ]

create_confirm_callback_href [line 545]

string create_confirm_callback_href(
string
$confirm, mixed
$func, [mixed
$args = null], [string
$indicator = null], [string
$mode = null] 
)

Creates link similar to link created with create_href.

The link, when used, will lead to calling of function which name is given as first parameter. Callback returns true if you use this link again after page refresh.

This function will trigger js confirm dialog before launching processing. If cancelled, no processing will be done.

Parameters:

string	$confirm:	question displayed in confirmation box
mixed	$func:	function
mixed	$args:	arguments
string	$indicator:	status bar indicator text
string	$mode:	block, allow, queue click on simutanous click

API Tags:

Return:	href string
Access:	public

[ Top ]

create_confirm_callback_href_with_id [line 618]

string create_confirm_callback_href_with_id(
string
$name, string
$confirm, mixed
$func, [mixed
$args = null], [string
$indicator = null], [string
$mode = null] 
)

Creates link similar to links created with create_href.

The link, when used, will lead to calling of function which name is given as first parameter. Callback returns true if you use this link again after page refresh.

This function will trigger js confirm dialog before launching processing. If cancelled, no processing will be done.

Parameters:

string	$name:	question displayed in confirmation box
string	$confirm:	callback id (name)
mixed	$func:	function
mixed	$args:	arguments
string	$indicator:	status bar indicator text
string	$mode:	block, allow, queue click on simutanous click

API Tags:

Access:

public

[ Top ]

create_confirm_unique_href [line 429]

string create_confirm_unique_href(
string
$confirm, [
$variables = array ()], [string
$indicator = null], [string
$mode = null] 
)

Similar to create_href, but variables passed to this function will only be accessible in module that called this function.

Those variables can be accessed with get_unique_href_variable. This function will trigger js confirm dialog before launching processing. If cancelled, no processing will be done.

Parameters:

string	$confirm:	question displayed in confirmation box
array	$variables:	variables to pass along with href
string	$indicator:	status bar indicator text
string	$mode:	block, allow, queue click on simutanous click

API Tags:

Return:	href string
Access:	public

[ Top ]

create_unique_href [line 395]

string create_unique_href(
[
$variables = array ()], [string
$indicator = null], [string
$mode = null] 
)

Similar to create_href, but variables passed to this function will only be accessible in module that called this function.

Those variables can be accessed with get_unique_href_variable.

Parameters:

array	$variables:	variables to pass along with href
string	$indicator:	status bar indicator text
string	$mode:	block, allow, queue click on simutanous click

API Tags:

Return:	href string
Access:	public

[ Top ]

create_unique_href_js [line 411]

string create_unique_href_js(
[
$variables = array ()], [string
$indicator = null], [string
$mode = null] 
)

Create onClick action string destined for js code.

Similar to create_href, but variables passed to this function will only be accessible in module that called this function. Those variables can be accessed with get_unique_href_variable.

Parameters:

array	$variables:	variables to pass along with href
string	$indicator:	status bar indicator text
string	$mode:	block, allow, queue click on simutanous click

API Tags:

Return:	href string
Access:	public

[ Top ]

create_unique_key [line 922]

string create_unique_key(
string
$name 
)

Returns unique key name, generated from unique name of this module (function get_path) and string parameter.

This function is called inside create_unique_href function and should not be used directly.

Parameters:

string

$name:

API Tags:

Access:

public

[ Top ]

displayed [line 817]

true displayed(
)

Returns whether this module instance was already displayed.

API Tags:

Return:	if this module instance was aready displayed, false otherwise
Access:	public

[ Top ]

display_module [line 705]

mixed display_module(
module
&$m, [mixed
$args = null], [string
$function_name = null] 
)

Call method of the module passed as first parameter, which name is passed as second parameter.

You can pass additional arguments as next parameters.

Parameters:

module	&$m:	child module
mixed	$args:	arguments
string	$function_name:	function to call (get output from), if user has enought privileges.

API Tags:

Return:	if access denied returns false, else true
Access:	public

[ Top ]

freeze_module [line 931]

void freeze_module(
string
$module_type, [
$name = null] 
)

Makes child module to not loose its module variables

Parameters:

string	$module_type:	module
	$name:

API Tags:

Access:

public

[ Top ]

get_child [line 82]

module &get_child(
string
$id 
)

Gets child module with specified node id.

Parameters:

string

$id:

API Tags:

Return:	object
Access:	public

[ Top ]

get_children [line 96]

array &get_children(
)

Gets array of children modules.

API Tags:

Return:	node id is a key, module object is value
Access:	public

[ Top ]

get_html_of_module [line 723]

mixed get_html_of_module(
module
&$m, [string
$args = null], [mixed
$function_name = null] 
)

Call method of the module passed as first parameter, which name is passed as second parameter.

You can pass additional arguments as next parameters. Attention: do not pass the result of this function by one module to another module.

Parameters:

module	&$m:	child module
string	$args:	function to call (get output from), if user has enought privileges.
mixed	$function_name:	arguments

API Tags:

Return:	if access denied returns false, else string
Access:	public

[ Top ]

get_instance_id [line 910]

mixed get_instance_id(
)

Returns id of module instance.

API Tags:

Return:	instance id
Access:	public

[ Top ]

get_jses [line 890]

array get_jses(
)

Returns list of jses to evaluate.

API Tags:

Return:	list of js commands
Access:	public

[ Top ]

get_module_variable [line 180]

mixed &get_module_variable(
string
$name, [mixed
$default = null] 
)

Returns value of a module variable. If the variable is not set, function will return value given as second parameter.

For details concerning module variables, see set_module_variable.

Parameters:

string	$name:	key
mixed	$default:	default value

API Tags:

Return:	value
Access:	public

[ Top ]

get_module_variable_or_unique_href_variable [line 216]

mixed &get_module_variable_or_unique_href_variable(
string
$name, [
$default_value = null] 
)

Returns href variable.

If unique href variable, given as first parameter, is not set, function will try to return value of module variable by that same name. If module variable, given as first parameter, is not set, function will return default value given as second parameter.

For details concerning href variables, see create_href. For details concerning module variables, see set_module_variable.

Parameters:

string	$name:
	$default_value:

API Tags:

Access:

public

[ Top ]

get_node_id [line 123]

string get_node_id(
)

Get node identifier.

API Tags:

Access:

public

[ Top ]

get_parent_path [line 112]

string get_parent_path(
)

Returns unique path of parent module.

Path contains modules hierarchy information (parent of parent etc.) for the current module. Each module in the path is described as name and instance id.

API Tags:

Access:

public

[ Top ]

get_parent_type [line 899]

string get_parent_type(
)

Returns name(type) of parent module.

API Tags:

Return:	module name
Access:	public

[ Top ]

get_path [line 139]

string get_path(
)

Returns unique path of calling module.

Path contains modules hierarchy information (parent of parent etc.) for current module. Each module in the path is described as name and instance id.

Example: Module named Base/Box, instance 1, without parents: get_path returns '/Base_Box|1'

API Tags:

Return:	unique module name
Access:	public

[ Top ]

get_reload [line 326]

bool get_reload(
)

Returns current reload settings.

API Tags:

Return:	true - force reload, false - no reload, null - default (reload changes only if module output changed)
Access:	public

[ Top ]

get_unique_href_variable [line 442]

mixed get_unique_href_variable(
string
$key 
)

Returns variable passed with create_unique_href.

Parameters:

string

$key:

key

API Tags:

Return:	value
Access:	public

[ Top ]

init_module [line 680]

mixed init_module(
string
$module_type, [mixed
$args = null], [string
$name = null], [
$clear_vars = false] 
)

Creates module instance which name is given as first parameter.

Created module instance will be a child to the module which called this function.

Parameters:

string	$module_type:	module name
mixed	$args:	arguments for module constructor
string	$name:	unique name for the instance, will be assigned automatically by default
	$clear_vars:

API Tags:

Return:	if access denied returns null, else child module object
Access:	public

[ Top ]

isset_module_variable [line 232]

bool isset_module_variable(
string
$name 
)

Checks if variable exists.

For details concerning module variables, see set_module_variable.

Parameters:

string

$name:

key

API Tags:

Return:	true if variable exists, false otherwise
Access:	public

[ Top ]

isset_unique_href_variable [line 464]

bool isset_unique_href_variable(
string
$key 
)

Checks if variable given as first parameter was passed with create_unique_href function.

Parameters:

string

$key:

key

API Tags:

Return:	true if variable was declared, false otherwise
Access:	public

[ Top ]

is_back [line 654]

bool is_back(
)

Checks if set_back_location was used.

API Tags:

Return:	true if back link was used, false otherwise
Access:	public

[ Top ]

is_fast_process [line 833]

true is_fast_process(
)

Returns whether this module instance has fast processing turned on.

API Tags:

Return:	if this module instance has fast processing turned on, false otherwise
Access:	public

[ Top ]

is_inline_display [line 849]

true is_inline_display(
)

Returns whether this module instance is displayed inline.

API Tags:

Return:	if this module instance is displayed inline, false otherwise
Access:	public

[ Top ]

js [line 881]

void js(
string
$js 
)

Appends js code to list of jses to evaluate.

Parameters:

string

$js:

js code

API Tags:

Access:

public

[ Top ]

mark_displayed [line 824]

void mark_displayed(
)

Marks this module instance as it was displayed.

API Tags:

Access:

public

[ Top ]

pack_module [line 870]

mixed pack_module(
string
$module_type, [string
$display_args = null], [mixed
$function_name = null], [
$construct_args = null], [
$name = null] 
)

Creates instance of module given as first parameter as a child of the module that has called this function.

Also, this function will call newly created module's method, which name is passed as second parameter. You can pass additional arguments as next parameters.

Parameters:

string	$module_type:	child module name
string	$display_args:	function to call
mixed	$function_name:	variables
	$construct_args:
	$name:

API Tags:

Return:	if access denied returns null, otherwise returns child module object
Access:	public

[ Top ]

set_back_location [line 645]

void set_back_location(
[
$i = 1] 
)

Sets reload location to previous page display.

Use is_back to control when this method was called.

Parameters:

$i:

API Tags:

Access:

public

[ Top ]

set_fast_process [line 840]

void set_fast_process(
)

Enable fast processing for this module instance.

API Tags:

Access:

public

[ Top ]

set_inline_display [line 856]

void set_inline_display(
)

Changes display behavior for this module instance to inline.

API Tags:

Access:

public

[ Top ]

set_module_variable [line 153]

void set_module_variable(
string
$name, mixed
$value 
)

Sets variable that will be available only for module instance that called this function.

Note that after page refresh, this variable will preserve its value in contrary to module field variables. Module variables are hold separately for every client.

Parameters:

string	$name:	key
mixed	$value:	value

API Tags:

Access:

public

[ Top ]

set_reload [line 316]

void set_reload(
bool
$b 
)

Mark module to force its reload or prevent being reloaded.

If this method is not called, module is reloaded by default, which means that only if output changed reload proceeds.

Parameters:

bool

$b:

true to force reload of whole module, false to suspend reloading

API Tags:

Access:

public

[ Top ]

share_module_variable [line 280]

bool share_module_variable(
string
$name, object module
&$m, [
$name2 = null] 
)

Share variable passed as first parameter with module passed as second parameter.

Any change of this variable will be visible in both modules.

Parameters:

string	$name:	varaible name
object module	&$m:	object
	$name2:

API Tags:

Return:	false if module is invalid, true otherwise
Access:	public

[ Top ]

share_unique_href_variable [line 298]

bool share_unique_href_variable(
string
$name, object module
&$m, [
$name2 = null] 
)

Share href variable passed as first parameter with module passed as second parameter.

Any change of this variable will be visible in both modules.

Parameters:

string	$name:	href variable name
object module	&$m:	object
	$name2:

API Tags:

Return:	false if module is invalid, true otherwise
Access:	public

[ Top ]

unset_module_variable [line 255]

void unset_module_variable(
string
$name 
)

Unset module variable.

For details concerning module variables see set_module_variable.

Parameters:

string

$name:

key

API Tags:

Access:

public

[ Top ]

unset_unique_href_variable [line 453]

void unset_unique_href_variable(
string
$key 
)

Unsets *unique_href variable.

Parameters:

string

$key:

key

API Tags:

Access:

public

[ Top ]

__call [line 946]

void &__call(

$func_name, [
$args = array()] 
)

Parameters:

	$func_name:
array	$args:

API Tags:

Access:

public

Redefined in descendants as:

Utils_FileUpload::__call() : Calls QuickForm method addRule() on own QuickForm object.

[ Top ]

Documentation generated on Fri, 26 Dec 2008 21:44:05 -0500 by phpDocumentor 1.4.2

	epesi-base module

[ class tree: epesi-base ] [ index: epesi-base ] [ all elements ]