Module
in package
Class Module Provides a struct like object for use when loading and using modules
Table of Contents
- $author : null
- The full name of the author of the plugin For example: Shawn Clake
- $description : null
- A brief description of the module's purpose In the case of the forum module the description might be something like: "Provides user stats and forum content for other plugins to easily utilize"
- $name : null
- The name of the module Please use the syntax of authorModuleName
- $version : null
- The version the module is running on.
- $visible : bool
- Whether or not other modules are able to access your modules extensible class.
- getAuthor() : null
- Returns the modules author
- getDescription() : null
- Returns the modules description
- getDocumentation() : array<string|int, mixed>
- Returns an array of documentation for the module Returns documentation in MD or html format back to display on the module manager.
- getName() : null
- Returns the modules name
- getUpdateNotes() : array<string|int, mixed>
- Returns an array of update notes for the module Returns an array where the key is the version number and value at that key is the update notes for that version.
- getVersion() : null
- Returns the modules version
- getVisible() : bool
- Returns the modules visibility state
Properties
$author
The full name of the author of the plugin For example: Shawn Clake
public
null
$author
= ''
$description
A brief description of the module's purpose In the case of the forum module the description might be something like: "Provides user stats and forum content for other plugins to easily utilize"
public
null
$description
= ''
$name
The name of the module Please use the syntax of authorModuleName
public
null
$name
= ''
$version
The version the module is running on.
public
null
$version
= ''
For example: 0.0.1
$visible
Whether or not other modules are able to access your modules extensible class.
public
bool
$visible
= true
Typically this should always be true, the only cases where you would want to override this would be if your module does not provide any extra functions for other modules to use.
Methods
getAuthor()
Returns the modules author
public
getAuthor() : null
Return values
null —getDescription()
Returns the modules description
public
getDescription() : null
Return values
null —getDocumentation()
Returns an array of documentation for the module Returns documentation in MD or html format back to display on the module manager.
public
getDocumentation() : array<string|int, mixed>
The key is the page name in slug form and the value is the documentation content for that page.
Return values
array<string|int, mixed> —getName()
Returns the modules name
public
getName() : null
Return values
null —getUpdateNotes()
Returns an array of update notes for the module Returns an array where the key is the version number and value at that key is the update notes for that version.
public
getUpdateNotes() : array<string|int, mixed>
Return values
array<string|int, mixed> —getVersion()
Returns the modules version
public
getVersion() : null
Return values
null —getVisible()
Returns the modules visibility state
public
getVisible() : bool