AbstractHelper Class Reference

Inheritance diagram for AbstractHelper:

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

Protected Member Functions
	serializeForHelperLog ($value)

Protected Attributes
	$dirname
	$module
	$debug

Constructor & Destructor Documentation

__construct()

__construct

(

$dirname = null

)

Instantiate a XoopsModule object for the helper to use. The module is determined as follows:

• if null is passed, use the current module
• if a string is passed, use as dirname to load

Parameters

string | null

$dirname

dirname

Here is the call graph for this function:

Member Function Documentation

addLog()

addLog

(

$log

)

Add a message to the module log

Parameters

mixed

$log

log item, can be message or variable

Returns

void

Here is the call graph for this function:

Here is the caller graph for this function:

dirname()

dirname

(

)

Return the dirname for this helper

Returns

string|null a dirname

Here is the caller graph for this function:

init()

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

Reimplemented in Cache, GenericHelper, Permission, and Session.

Here is the caller graph for this function:

serializeForHelperLog()

serializeForHelperLog (   $value )

protected

Serialize an arbitrary value to string. Intended for data being addLog()ed

Parameters

mixed

$value

Returns

string

Here is the caller graph for this function:

setDebug()

setDebug

(

$bool = true

)

Set debug option on or off

Parameters

bool

$bool

true to turn on debug logging, false for off

Returns

void

Field Documentation

$debug

$debug

protected

$dirname

$dirname

protected

$module

$module

protected

---

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

• C:/xoops2511b2/htdocs/class/libraries/vendor/xoops/xmf/src/Module/Helper/AbstractHelper.php