Arikaim CMS

Controller
in package
Uses BaseController, Multilanguage, UserAccess, PageErrors

Base class for all Controllers

Table of Contents

Properties

$container  : Container|null
Container
$dataErrorCallback  : Closure|null
Data error callback
$dataValidCallback  : Closure|null
Data validatin callback
$extensionName  : string|null
Extension name
$messages  : array<string|int, mixed>
Response messages
$messagesComponentName  : string
Messages component name
$messagesLoaded  : bool
Messages loaded
$pageName  : string|null
Page name
$params  : array<string|int, mixed>
Controller params
$response  : ResponseInterface|null
Response

Methods

__call()  : mixed
Call
__construct()  : mixed
Constructor
get()  : mixed
Get item from container
getContainer()  : Container
Get container
getDataValidCallback()  : Closure|null
Get data validation callback
getDefaultLanguage()  : string
Get default language
getExtensionName()  : string|null
Get extension name
getMessage()  : string|null
Get message
getPageLanguage()  : string
Get page language
getPageName()  : string|null
Get page name
getPageUrl()  : string
Get page url
getParam()  : mixed|null
Get param
getParams()  : array<string|int, mixed>
Get params
getQueryParam()  : mixed
Get query param
getRequestParams()  : array<string|int, mixed>
Get request params
getUrl()  : string
Get url
getUserId()  : int|null
Return current logged user id
getValidationErrorCallback()  : Closure|null
Get validation error callback
has()  : bool
Return true if container item esist
hasAccess()  : bool
Return true if user have access permission
hasControlPanelAccess()  : bool
Return true if user have control panel access
hasService()  : bool
Return true service exists
init()  : void
Init controller, override this method in child classes
isLanguageChange()  : bool
Return true if page load is with new language code
loadMessages()  : void
Load messages from html component json file
logError()  : bool
Log error
logInfo()  : bool
Log message
message()  : ApiController
Add message to response, first find in messages array if not found display name value as message
noCacheHeaders()  : ResponseInterface
Set no cache in Cache-Control
onDataValid()  : void
Set callback for validation done
onValidationError()  : void
Set callback for validation errors
pageLoad()  : ResponseInterface
Load page
pageNotFound()  : ResponseInterface
Display page not found error
pageSystemError()  : ResponseInterface
Display system error page
requireAccess()  : void
Reguire permission check if current user have permission
requireControlPanelPermission()  : void
Require control panel permission
requireUser()  : void
Check logged user id
requireUserOrControlPanel()  : void
Check logged user id or contorl panel
resolveRequestParams()  : array<string|int, mixed>
Resolve params
setExtensionName()  : void
Set extension name
setHttpResponse()  : void
Set http response instance
user()  : mixed
Return current logged user
withRedirect()  : ResponseInterface
Set redirect headers
withService()  : mixed
Run closure with serice
writeXml()  : ResponseInterface
Write XML to reponse body
loadMesasgesComponent()  : void
Load messages component
resolveRouteParams()  : bool
Resolve route params

Properties

$dataErrorCallback

Data error callback

protected Closure|null $dataErrorCallback = null

$dataValidCallback

Data validatin callback

protected Closure|null $dataValidCallback = null

$extensionName

Extension name

protected string|null $extensionName = null

$messages

Response messages

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

$messagesComponentName

Messages component name

protected string $messagesComponentName = ''

$messagesLoaded

Messages loaded

protected bool $messagesLoaded = false

$params

Controller params

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

$response

Response

protected ResponseInterface|null $response = null

Methods

__call()

Call

public __call(string $name, array<string|int, mixed> $arguments) : mixed
Parameters
$name : string
$arguments : array<string|int, mixed>

__construct()

Constructor

public __construct([Container $container = null ]) : mixed
Parameters
$container : Container = null

get()

Get item from container

public get(string $id) : mixed
Parameters
$id : string

getContainer()

Get container

public getContainer() : Container
Return values
Container

getDataValidCallback()

Get data validation callback

public getDataValidCallback() : Closure|null
Return values
Closure|null

getDefaultLanguage()

Get default language

public getDefaultLanguage() : string
Return values
string

getExtensionName()

Get extension name

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

getMessage()

Get message

public getMessage(string $name) : string|null
Parameters
$name : string
Return values
string|null

getPageLanguage()

Get page language

public getPageLanguage([array<string|int, mixed> $data = [] ][, bool $skipSession = false ]) : string
Parameters
$data : array<string|int, mixed> = []
$skipSession : bool = false
Return values
string

getPageName()

Get page name

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

getPageUrl()

Get page url

public getPageUrl([string $path = '' ][, bool $relative = false ][, string|null $language = null ]) : string
Parameters
$path : string = ''
$relative : bool = false
$language : string|null = null
Return values
string

getParam()

Get param

public getParam(string $key[, mixed|null $default = null ]) : mixed|null
Parameters
$key : string
$default : mixed|null = null
Return values
mixed|null

getParams()

Get params

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

getQueryParam()

Get query param

public getQueryParam(ServerRequestInterface $request, string $name[, mixed $default = null ]) : mixed
Parameters
$request : ServerRequestInterface
$name : string
$default : mixed = null

getRequestParams()

Get request params

public getRequestParams(Request $request) : array<string|int, mixed>
Parameters
$request : Request
Return values
array<string|int, mixed>

getUrl()

Get url

public getUrl(ServerRequestInterface $request[, bool $relative = false ]) : string
Parameters
$request : ServerRequestInterface
$relative : bool = false
Return values
string

getUserId()

Return current logged user id

public getUserId() : int|null
Return values
int|null

getValidationErrorCallback()

Get validation error callback

public getValidationErrorCallback() : Closure|null
Return values
Closure|null

has()

Return true if container item esist

public has(string $id) : bool
Parameters
$id : string
Return values
bool

hasAccess()

Return true if user have access permission

public hasAccess(string $name[, mixed $type = null ][, string|int|null $authId = null ]) : bool
Parameters
$name : string
$type : mixed = null
$authId : string|int|null = null

For current user - null

Return values
bool

hasControlPanelAccess()

Return true if user have control panel access

public hasControlPanelAccess() : bool
Return values
bool

hasService()

Return true service exists

public hasService(string $id) : bool
Parameters
$id : string
Return values
bool

init()

Init controller, override this method in child classes

public init() : void

isLanguageChange()

Return true if page load is with new language code

public isLanguageChange(array<string|int, mixed> $data) : bool
Parameters
$data : array<string|int, mixed>
Return values
bool

loadMessages()

Load messages from html component json file

public loadMessages(string $componentName) : void
Parameters
$componentName : string

logError()

Log error

public logError(string $message[, array<string|int, mixed> $context = [] ]) : bool
Parameters
$message : string
$context : array<string|int, mixed> = []
Return values
bool

logInfo()

Log message

public logInfo(string $message[, array<string|int, mixed> $context = [] ]) : bool
Parameters
$message : string
$context : array<string|int, mixed> = []
Return values
bool

message()

Add message to response, first find in messages array if not found display name value as message

public message(string $name[, string|null $default = null ]) : ApiController
Parameters
$name : string
$default : string|null = null
Return values
ApiController

noCacheHeaders()

Set no cache in Cache-Control

public noCacheHeaders(mixed $response) : ResponseInterface
Parameters
$response : mixed
Return values
ResponseInterface

onDataValid()

Set callback for validation done

public onDataValid(Closure $callback) : void
Parameters
$callback : Closure

onValidationError()

Set callback for validation errors

public onValidationError(Closure $callback) : void
Parameters
$callback : Closure

pageLoad()

Load page

public pageLoad(ServerRequestInterface $request, ResponseInterface $response, CollectionInterface|array<string|int, mixed> $data[, string|null $pageName = null ][, string|null $language = null ][, bool $dispatchEvent = false ]) : ResponseInterface
Parameters
$request : ServerRequestInterface
$response : ResponseInterface
$data : CollectionInterface|array<string|int, mixed>
$pageName : string|null = null
$language : string|null = null
$dispatchEvent : bool = false
Return values
ResponseInterface

pageNotFound()

Display page not found error

public pageNotFound(ResponseInterface $response[, array<string|int, mixed> $data = [] ][, string|null $templateName = null ]) : ResponseInterface
Parameters
$response : ResponseInterface
$data : array<string|int, mixed> = []
$templateName : string|null = null
Return values
ResponseInterface

pageSystemError()

Display system error page

public pageSystemError(ResponseInterface $response[, array<string|int, mixed> $error = [] ][, string $templateName = 'system' ]) : ResponseInterface
Parameters
$response : ResponseInterface
$error : array<string|int, mixed> = []
$templateName : string = 'system'
Return values
ResponseInterface

requireAccess()

Reguire permission check if current user have permission

public requireAccess(string $name[, mixed $type = null ][, string|int|null $authId = null ]) : void
Parameters
$name : string
$type : mixed = null
$authId : string|int|null = null

For current user - null

Tags
throws
HttpException

requireControlPanelPermission()

Require control panel permission

public requireControlPanelPermission() : void
Tags
throws
HttpException

requireUser()

Check logged user id

public requireUser(string|int $userId) : void
Parameters
$userId : string|int
Tags
throws
HttpException

requireUserOrControlPanel()

Check logged user id or contorl panel

public requireUserOrControlPanel(string|int $userId) : void
Parameters
$userId : string|int
Tags
throws
HttpException

resolveRequestParams()

Resolve params

public resolveRequestParams(Request $request, array<string|int, mixed> $paramsKeys) : array<string|int, mixed>
Parameters
$request : Request
$paramsKeys : array<string|int, mixed>
Return values
array<string|int, mixed>

setExtensionName()

Set extension name

public setExtensionName(string|null $name) : void
Parameters
$name : string|null

setHttpResponse()

Set http response instance

public setHttpResponse(ResponseInterface $response) : void
Parameters
$response : ResponseInterface

user()

Return current logged user

public user() : mixed

withRedirect()

Set redirect headers

public withRedirect(ResponseInterface $response, string $url) : ResponseInterface
Parameters
$response : ResponseInterface
$url : string
Return values
ResponseInterface

withService()

Run closure with serice

public withService(string $name, Closure $callback) : mixed
Parameters
$name : string
$callback : Closure

writeXml()

Write XML to reponse body

public writeXml(ResponseInterface $response, string $xml) : ResponseInterface
Parameters
$response : ResponseInterface
$xml : string
Return values
ResponseInterface

loadMesasgesComponent()

Load messages component

protected loadMesasgesComponent([string|null $language = null ]) : void
Parameters
$language : string|null = null

resolveRouteParams()

Resolve route params

protected resolveRouteParams(Request $request) : bool
Parameters
$request : Request
Return values
bool 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results