Documentation

Base
in package

Abstract base controller class.

Table of Contents

$headers  : Headers
$activatedLocale  : bool
$csrfInitiated  : bool
__construct()  : mixed
Constructor.
checkPermission()  : mixed
Function to check permission.
isSessionExtend()  : bool
Function to check if session is extended.
loginRequired()  : bool
Function to check login required permission.
postProcess()  : mixed
Post process function.
postProcessAjax()  : mixed
Post process ajax function.
preProcess()  : mixed
Pre process function.
preProcessAjax()  : mixed
Pre process ajax function.
process()  : mixed
Process function.
sendHeaders()  : mixed
Send headers.
validateRequest()  : void
Function to validate request method.

Properties

$headers

public Headers $headers

Headers instance.

$activatedLocale

protected static bool $activatedLocale = false

Activated language locale.

$csrfInitiated

private static bool $csrfInitiated = false

CSRF already initiated.

Methods

__construct()

Constructor.

public __construct() : mixed
Return values
mixed

checkPermission()

Function to check permission.

public abstract checkPermission(Request $request) : mixed
Parameters
$request : Request
Tags
throws
NoPermitted
Return values
mixed

isSessionExtend()

Function to check if session is extended.

public isSessionExtend(Request $request) : bool
Parameters
$request : Request
Return values
bool

loginRequired()

Function to check login required permission.

public loginRequired() : bool
Return values
bool

postProcess()

Post process function.

public postProcess(Request $request[, bool $display = true ]) : mixed
Parameters
$request : Request
$display : bool = true
Return values
mixed

postProcessAjax()

Post process ajax function.

public postProcessAjax(Request $request) : mixed
Parameters
$request : Request
Return values
mixed

preProcess()

Pre process function.

public preProcess(Request $request[, bool $display = true ]) : mixed
Parameters
$request : Request
$display : bool = true
Return values
mixed

preProcessAjax()

Pre process ajax function.

public preProcessAjax(Request $request) : mixed
Parameters
$request : Request
Return values
mixed

process()

Process function.

public abstract process(Request $request) : mixed
Parameters
$request : Request
Return values
mixed

sendHeaders()

Send headers.

public sendHeaders() : mixed
Return values
mixed

validateRequest()

Function to validate request method.

public validateRequest(Request $request) : void
Parameters
$request : Request
Return values
void

        

Search results