Arikaim CMS

Module
in package
implements ModuleInterface

Module class.

Table of Contents

Interfaces

ModuleInterface
Module interface

Properties

$config  : array<string|int, mixed>
Module config
$consoleCommandClasses  : array<string|int, mixed>
Console command classes
$error  : string|null
test error
$middlewareClasses  : array<string|int, mixed>
Middleware classes
$moduleName  : string
Module name

Methods

__call()  : mxied
Call
addConsoleClass()  : void
Add console class
addMiddlewareClass()  : void
Add middleware class
boot()  : void
Boot module
getConfig()  : array<string|int, mixed>
Get module config
getConsoleCommandClasses()  : array<string|int, mixed>
Get console commands classes
getInstance()  : mixed|null
Get module instance
getMiddlewareClasses()  : array<string|int, mixed>
get middleware classes
getModuleName()  : string
Get module name
getTestError()  : string|null
Get test error
install()  : void
Install module
setConfig()  : void
Set module config
setModuleName()  : void
Set module name
test()  : bool
Test module function

Properties

$config

Module config

protected array<string|int, mixed> $config = []

$consoleCommandClasses

Console command classes

protected array<string|int, mixed> $consoleCommandClasses = []

$error

test error

protected string|null $error = null

$middlewareClasses

Middleware classes

protected array<string|int, mixed> $middlewareClasses = []

$moduleName

Module name

protected string $moduleName = ''

Methods

__call()

Call

public __call(string $name, array<string|int, mixed> $args) : mxied
Parameters
$name : string
$args : array<string|int, mixed>
Return values
mxied

addConsoleClass()

Add console class

public addConsoleClass(string $class) : void
Parameters
$class : string

addMiddlewareClass()

Add middleware class

public addMiddlewareClass(string $class) : void
Parameters
$class : string

boot()

Boot module

public boot() : void

getConfig()

Get module config

public getConfig([string|null $key = null ]) : array<string|int, mixed>
Parameters
$key : string|null = null
Return values
array<string|int, mixed>

getConsoleCommandClasses()

Get console commands classes

public getConsoleCommandClasses() : array<string|int, mixed>
Return values
array<string|int, mixed>

getInstance()

Get module instance

public getInstance() : mixed|null
Return values
mixed|null

getMiddlewareClasses()

get middleware classes

public getMiddlewareClasses() : array<string|int, mixed>
Return values
array<string|int, mixed>

getModuleName()

Get module name

public getModuleName() : string
Return values
string

getTestError()

Get test error

public getTestError() : string|null
Return values
string|null

install()

Install module

public install() : void

setConfig()

Set module config

public setConfig(array<string|int, mixed> $config) : void
Parameters
$config : array<string|int, mixed>

setModuleName()

Set module name

public setModuleName(string $name) : void
Parameters
$name : string

test()

Test module function

public test() : bool
Return values
bool 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results