Magrathea PHP 2

AdminManager extends Singleton
in package

Class for managing Magrathea's Admin

Table of Contents

Properties

$instance  : array<string|int, mixed>|null
$admin  : null|Admin
$css  : null|CssCompressor
$javascript  : null|JavascriptCompressor
$menu  : null|AdminMenu

Methods

__wakeup()  : mixed
AddCss()  : AdminManger
Adds a css file to admin
AddJs()  : AdminManger
Adds a javascript file to admin
Auth()  : bool
Permission verification
ErrorPage()  : mixed
display error page
GetActiveFeature()  : AdminFeature|null
returns active feature (the one from "magrathea_feature" data)
GetAdmin()  : null|Admin
returns the current admin.
GetColor()  : string
Gets color
GetCss()  : string
Gets Js code
GetCSSManager()  : CssCompressor
Gets CSS compressor
GetFeature()  : AdminFeature
gets admin feature id and returns its object
GetJs()  : string
Gets Js code
GetJSManager()  : JavascriptCompressor
Gets Js compressor
GetLoggedUser()  : AdminUser|null
Return logged user
GetMenu()  : array<string|int, mixed>
Gets the AdminMenu
GetTitle()  : string
Gets title
Initialize()  : mixed
Instance()  : static|Singleton
Log()  : void
Log an action
MockClass()  : static|Singleton
PermissionDenied()  : mixed
Show permission denied page
PrintLogo()  : void
Prints the logo
SetInstance()  : mixed
SetMenu()  : AdminManager
Sets the menu
Start()  : AdminManager
Starts Admin
StartDefault()  : AdminManager
Starts a default admin
__clone()  : mixed
__construct()  : mixed

Properties

$instance

protected static array<string|int, mixed>|null $instance = []

Methods

AddCss()

Adds a css file to admin

public AddCss(string $file) : AdminManger
Parameters
$file : string
Return values
AdminManger —

itself

AddJs()

Adds a javascript file to admin

public AddJs(string $file) : AdminManger
Parameters
$file : string
Return values
AdminManger —

itself

Auth()

Permission verification

public Auth() : bool
Return values
bool

ErrorPage()

display error page

public ErrorPage(mixed $message) : mixed
Parameters
$message : mixed

GetColor()

Gets color

public GetColor() : string
Return values
string —

color in decimal format (255, 255, 255)

GetCss()

Gets Js code

public GetCss() : string
Return values
string —

code

GetFeature()

gets admin feature id and returns its object

public GetFeature(string $featureId) : AdminFeature
Parameters
$featureId : string

admin feature id

Return values
AdminFeature —

| null Admin Feature class (null if it does not exists)

GetJs()

Gets Js code

public GetJs() : string
Return values
string —

code

GetMenu()

Gets the AdminMenu

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

menu items

GetTitle()

Gets title

public GetTitle() : string
Return values
string —

title

Log()

Log an action

public Log(string $action[, array<string|int, mixed>|object|string $victim = null ][, array<string|int, mixed>|object $data = null ][, int $user_id = false ]) : void
Parameters
$action : string

action executed

$victim : array<string|int, mixed>|object|string = null

victim of action

$data : array<string|int, mixed>|object = null

data for log

$user_id : int = false

action user id

PermissionDenied()

Show permission denied page

public PermissionDenied() : mixed

Prints the logo

public PrintLogo(int $logoSize) : void
Parameters
$logoSize : int

size of the logo

SetInstance()

public SetInstance(mixed $inst) : mixed
Parameters
$inst : mixed

StartDefault()

Starts a default admin

public StartDefault([null|string $title = null ][, null|string $color = null ]) : AdminManager
Parameters
$title : null|string = null

(optional) default title

$color : null|string = null

(optional) default color

Return values
AdminManager —

itself

__construct()

private final __construct() : mixed 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results