Référence de la classe GenericHelper

Graphe d'héritage de GenericHelper:

Graphe de collaboration de GenericHelper:

Fonctions membres publiques
	init ()
	getModule ()
	getConfig ($name=null, $default=null)
	getHandler ($name)
	loadLanguage ($name)
	isCurrentModule ()
	isUserAdmin ()
	url ($url='')
	path ($path='')
	redirect ($url, $time=3, $message='')
	uploadUrl ($url='')
	uploadPath ($path='')
Fonctions membres publiques hérités de AbstractHelper
	__construct ($dirname=null)
	dirname ()
	setDebug ($bool=true)
	addLog ($log)

Fonctions membres protégées
	initObject ()
	initConfig ()
	initHandler ($name)
Fonctions membres protégées hérités de AbstractHelper
	serializeForHelperLog ($value)

Attributs protégés
	$object
	$handlers
	$configs
Attributs protégés hérités de AbstractHelper
	$dirname
	$module
	$debug

Documentation des fonctions membres

getConfig()

getConfig	(		$name = null,
			$default = null
	)

get a module config item

Paramètres

string	$name	name of config item, or blank for all items
mixed	$default	default value to return if config $name is not set

Renvoie

mixed string config item, array of config items, or null if config not found

Voici le graphe d'appel pour cette fonction :

getHandler()

getHandler

(

$name

)

Get an Object Handler

Paramètres

string

$name

name of handler to load

Renvoie

bool|XoopsObjectHandler|XoopsPersistableObjectHandler

Voici le graphe d'appel pour cette fonction :

getModule()

getModule

(

)

get the module object

Renvoie

\XoopsModule

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

init()

init

(

)

Initialize parent::__construct calls this after verifying module object.

Renvoie

void

Réimplémentée à partir de AbstractHelper.

initConfig()

initConfig ( )

protected

get module configs

Renvoie

void

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

initHandler()

initHandler (   $name )

protected

get a handler instance and store in $this->_handlers

Paramètres

string

$name

name of handler to load

Renvoie

void

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

initObject()

initObject ( )

protected

get a module object

Renvoie

void

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

isCurrentModule()

isCurrentModule

(

)

Is this the currently active module?

Renvoie

bool

Voici le graphe d'appel pour cette fonction :

isUserAdmin()

isUserAdmin

(

)

Does user have admin rights to this module?

Renvoie

bool true is user has admin right, else false

Voici le graphe d'appel pour cette fonction :

loadLanguage()

loadLanguage

(

$name

)

load a language file for this module

Paramètres

string

$name

basename of language file (i.e. 'admin')

Renvoie

bool

Voici le graphe d'appel pour cette fonction :

path()

path

(

$path = ''

)

Return absolute filesystem path for a module relative path

Paramètres

string

$path

module relative file system path

Renvoie

string

Voici le graphe d'appel pour cette fonction :

redirect()

redirect	(		$url,
			$time = 3,
			$message = ''
	)

Redirect the user to a page within this module

Paramètres

string	$url	module relative url (i.e. index.php)
int	$time	time in seconds to show redirect message
string	$message	redirect message

Renvoie

void

Voici le graphe d'appel pour cette fonction :

uploadPath()

uploadPath

(

$path = ''

)

Return absolute filesystem path for a module relative upload file

Uploads may be stored in special directories for many reasons, such as permissions, security, replication and directory balancing Rather than build their own URL's, modules should use this method which will know how to reference the upload now and in the future.

Paramètres

string

$path

module relative upload file path

Renvoie

string

Voici le graphe d'appel pour cette fonction :

uploadUrl()

uploadUrl

(

$url = ''

)

Return absolute URL for a module relative upload file

Uploads may be stored in special directories for many reasons, such as permissions, security, replication and directory balancing Rather than build their own URL's, modules should use this method which will know how to reference the upload now and in the future.

Paramètres

string

$url

module relative upload URL

Renvoie

string

Voici le graphe d'appel pour cette fonction :

url()

url

(

$url = ''

)

Return absolute URL for a module relative URL

Paramètres

string

$url

module relative URL

Renvoie

string

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

Documentation des champs

$configs

$configs

protected

$handlers

$handlers

protected

$object

$object

protected

---

La documentation de cette classe a été générée à partir du fichier suivant :

• XoopsCore25-2.5.11-Beta1/htdocs/class/libraries/vendor/xoops/xmf/src/Module/Helper/GenericHelper.php