Xmf\Module\Helper\AbstractHelper Class Reference

Inheritance diagram for Xmf\Module\Helper\AbstractHelper:

Public Member Functions
	__construct ($module=null)
	addLog ($log)
	init ()
	setDebug ($bool=true)

Protected Attributes
	$debug
	$module

Detailed Description

Definition at line 31 of file AbstractHelper.php.

Constructor & Destructor Documentation

Xmf\Module\Helper\AbstractHelper::__construct

(

$module = null

)

Instantiate a XoopsModule object for the helper to use. This occurs in one of three ways

• if null is passed, use the current module
• if a string is passed, use as dirname for a module
• if an object is passed, use it as the module object

Parameters

mixed

$module

string dirname | object XoopsModule

Definition at line 52 of file AbstractHelper.php.

References $GLOBALS, $helper, Xmf\Module\Helper\AbstractHelper\$module, $xoops, Xmf\Module\Helper\getHelper(), Xoops\getInstance(), and Xmf\Module\Helper\AbstractHelper\init().

Here is the call graph for this function:

Member Function Documentation

Xmf\Module\Helper\AbstractHelper::addLog

(

$log

)

Add a message to the module log

Parameters

string

$log

log message

Returns

void

Definition at line 112 of file AbstractHelper.php.

References Xoops\getInstance().

Here is the call graph for this function:

Xmf\Module\Helper\AbstractHelper::init ( )

abstract

init() is called once/if __construct has a module object. $this->module will have a module object that any further initialization can use.

Returns

void

Referenced by Xmf\Module\Helper\AbstractHelper\__construct().

Here is the caller graph for this function:

Xmf\Module\Helper\AbstractHelper::setDebug

(

$bool = true

)

Set debug option on or off

Parameters

bool

$bool

true to turn on debug logging, false for off

Returns

void

Definition at line 100 of file AbstractHelper.php.

Member Data Documentation

Xmf\Module\Helper\AbstractHelper::$debug

protected

Definition at line 41 of file AbstractHelper.php.

Xmf\Module\Helper\AbstractHelper::$module

protected

Definition at line 36 of file AbstractHelper.php.

Referenced by Xmf\Module\Helper\AbstractHelper\__construct().

---

The documentation for this class was generated from the following file:

• C:/usr64/htdocs/xoops_lib/Xmf/Module/Helper/AbstractHelper.php