| Methods |
public
|
init(): void
Initialize parent::__construct calls this after verifying module object.
Initialize parent::__construct calls this after verifying module object.
Implements
|
#
|
public
|
getModule(): XoopsModule
get the module object
|
#
|
public
|
getConfig(string $name = null, mixed $default = null): mixed
get a module config item
Parameters
| $name |
name of config item, or blank for all items
|
| $default |
default value to return if config $name is not set
|
Returns
string config item, array of config items,
or null if config not found
|
#
|
public
|
getHandler(string $name): bool|XoopsObjectHandler|XoopsPersistableObjectHandler
Get an Object Handler
Parameters
| $name |
name of handler to load
|
|
#
|
protected
|
initObject(): void
get a module object
|
#
|
protected
|
initConfig(): void
get module configs
|
#
|
protected
|
initHandler(string $name): void
get a handler instance and store in $this->_handlers
get a handler instance and store in $this->_handlers
Parameters
| $name |
name of handler to load
|
|
#
|
public
|
loadLanguage(string $name): bool
load a language file for this module
load a language file for this module
Parameters
| $name |
basename of language file (i.e. 'admin')
|
|
#
|
public
|
isCurrentModule(): bool
Is this the currently active module?
Is this the currently active module?
|
#
|
public
|
isUserAdmin(): bool
Does user have admin rights to this module?
Does user have admin rights to this module?
Returns
true is user has admin right, else false
|
#
|
public
|
url(string $url = ''): string
Return absolute URL for a module relative URL
Return absolute URL for a module relative URL
Parameters
|
#
|
public
|
path(string $path = ''): string
Return absolute filesystem path for a module relative path
Return absolute filesystem path for a module relative path
Parameters
| $path |
module relative file system path
|
|
#
|
public
|
redirect(string $url, int $time = 3, string $message = ''): void
Redirect the user to a page within this module
Redirect the user to a page within this module
Parameters
| $url |
module relative url (i.e. index.php)
|
| $time |
time in seconds to show redirect message
|
| $message |
redirect message
|
|
#
|
public
|
uploadUrl(string $url = ''): string
Return absolute URL for a module relative upload file
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.
Parameters
| $url |
module relative upload URL
|
|
#
|
public
|
uploadPath(string $path = ''): string
Return absolute filesystem path for a module relative upload file
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.
Parameters
| $path |
module relative upload file path
|
|
#
|