Module Interface.md

Module Interface

General

init() : void

This method is called when the module is initialized.

protected function init() : void {
  	/* Override Me */
}

preLoad() : void

load($submodule = null) : void

onPost($data = []) : void

onUpdate($data = []) : ?string

onSave($data = []) : ?string

frame() : mixed

content($submodule = null) : void

System

getRouter() : Router

getModules() : array

getTemplate() : Template

getCore() : Core

getInstance() : Module

Module Settings

setSettings(string $name, mixed $value = NULL)

getSettings(string $name, mixed $default = NULL) : mixed

UI

addButton(Button | array $button, bool $logged_in = false)

addModal(Modal $modal, bool $logged_in = false)

assign(string $name, mixed $value)

url(string $path = '') : string

Hook-System

Filters

addFilter(string $name, Closure | array $method, int $priority = 50, bool $logged_in = true) : bool

removeFilter(string $name, Closure | array $method, int $priority = 50) : bool

hasFilter(string $name, mixed $method = false) : bool

applyFilter(string $name, mixed $arguments) : mixed

Actions

addAction(string $name, Closure | array $method, int $priority = 50, bool $logged_in = true) : bool

removeAction(string $name, Closure | array $method, int $priority = 50) : bool

hasAction(string $name, mixed $method = false) : bool

runAction(string $name, mixed $arguments) : mixed