extends |
XoopsObject |
---|
A Module
Methods | ||||||
---|---|---|---|---|---|---|
public
|
__construct()
Constructor
|
# | ||||
public
|
loadInfoAsVar(string $dirname, boolean $verbose = true)
Load module info
Load module info Parameters
|
# | ||||
public
|
setMessage(string $str)
add a message
add a message Parameters
|
# | ||||
public
|
getMessages(): array
return the messages for this object as an array
return the messages for this object as an array Returnsan array of messages |
# | ||||
public
|
setInfo(string $name, mixed $value): bool
Set module info
Set module info |
# | ||||
public
&
|
getInfo(string $name = null): array|string
Get module info
Get module info ReturnsArray of module information. If {@link $name} is set, returns a single module information item as string. |
# | ||||
public
|
getStatus(): string
Get status
Get status |
# | ||||
public
|
versionCompare(string $version1 = '', string $version2 = '', string $operator = '<'): boolean
Compares two "XOOPS-standardized" version number strings.
Compares two "XOOPS-standardized" version number strings. ReturnsThe function will return true if the relationship is the one specified by the operator, false otherwise. |
# | ||||
public
|
mainLink(): string
Get a link to the modules main page
Get a link to the modules main page ReturnsFALSE on fail |
# | ||||
public
|
subLink(): string
Get links to the subpages
Get links to the subpages |
# | ||||
public
|
loadAdminMenu()
Load the admin menu for the module
Load the admin menu for the module |
# | ||||
public
&
|
getAdminMenu(): array
Get the admin menu for the module
Get the admin menu for the module |
# | ||||
public
|
loadInfo(string $dirname, bool $verbose = true): bool
Load the module info for this module
Load the module info for this module Parameters
Returnstrue if loaded |
# | ||||
public
|
search(string $term = '', string $andor = 'AND', integer $limit = 0, integer $offset = 0, integer $userid = 0): mixed
Search contents within a module
Search contents within a module Parameters
ReturnsSearch result. |
# | ||||
public
|
id(string $format = 'N'): mixed
Returns Class Base Variable mid
Returns Class Base Variable mid |
# | ||||
public
|
mid(string $format = ''): mixed
Returns Class Base Variable mid
Returns Class Base Variable mid |
# | ||||
public
|
name(string $format = ''): mixed
Returns Class Base Variable name
Returns Class Base Variable name |
# | ||||
public
|
version(string $format = ''): mixed
Returns Class Base Variable version
Returns Class Base Variable version |
# | ||||
public
|
last_update(string $format = ''): mixed
Returns Class Base Variable last_update
Returns Class Base Variable last_update |
# | ||||
public
|
weight(string $format = ''): mixed
Returns Class Base Variable weight
Returns Class Base Variable weight |
# | ||||
public
|
isactive(string $format = ''): mixed
Returns Class Base Variable isactive
Returns Class Base Variable isactive |
# | ||||
public
|
dirname(string $format = ''): mixed
Returns Class Base Variable dirname
Returns Class Base Variable dirname |
# | ||||
public
|
hasmain(string $format = ''): mixed
Returns Class Base Variable hasmain
Returns Class Base Variable hasmain |
# | ||||
public
|
hasadmin(string $format = ''): mixed
Returns Class Base Variable hasadmin
Returns Class Base Variable hasadmin |
# | ||||
public
|
hassearch(string $format = ''): mixed
Returns Class Base Variable hassearch
Returns Class Base Variable hassearch |
# | ||||
public
|
hasconfig(string $format = ''): mixed
Returns Class Base Variable hasconfig
Returns Class Base Variable hasconfig |
# | ||||
public
|
hascomments(string $format = ''): mixed
Returns Class Base Variable hascomments
Returns Class Base Variable hascomments |
# | ||||
public
|
hasnotification(string $format = ''): mixed
Returns Class Base Variable hasnotification
Returns Class Base Variable hasnotification |
# | ||||
public
static
|
getByDirname($dirname): mixed
|
# | ||||
public
|
checkAccess()
|
# | ||||
public
|
loadLanguage(string $type = 'main'): bool
|
# | ||||
public
|
loadErrorMessages(): bool
|
# | ||||
public
|
getCurrentPage(): bool
|
# | ||||
public
|
install(array $admingroups = [], array $accessgroups = []): bool
|
# | ||||
public
|
update(): bool
|
# | ||||
public
|
insert(): bool
|
# | ||||
public
|
executeSQL(): bool
|
# | ||||
public
|
insertTemplates(): bool
|
# | ||||
public
|
gettemplate($template, bool $block = false): bool
|
# | ||||
public
|
insertBlocks(): bool
|
# | ||||
public
|
insertConfigCategories(): bool
|
# | ||||
public
|
insertConfig(): bool
|
# | ||||
public
|
insertProfileFields(): bool
|
# | ||||
public
|
executeScript($type, int $state = 2): bool
|
# | ||||
public
|
insertGroupPermissions($groups, $type): bool
|
# |
Properties | |||
---|---|---|---|
public
|
string
|
$modinfo
|
# |
public
|
array
|
$adminmenu
|
# |
public
|
array
|
$_msg
|
# |
public
|
|
$mid
|
# |
public
|
|
$name
|
# |
public
|
|
$version
|
# |
public
|
|
$last_update
|
# |
public
|
|
$weight
|
# |
public
|
|
$isactive
|
# |
public
|
|
$dirname
|
# |
public
|
|
$hasmain
|
# |
public
|
|
$hasadmin
|
# |
public
|
|
$hassearch
|
# |
public
|
|
$hasconfig
|
# |
public
|
|
$hascomments
|
# |
public
|
|
$hasnotification
|
# |
Properties inherited from XoopsObject |
---|
$vars, $cleanVars, $_isNew, $_isDirty, $_errors, $_filters |