Controller
class Controller
Base class for all Controllers
Traits
Properties
protected string|null | $extensionName | Extension name | from BaseController |
protected Container|null | $container | Container | from BaseController |
protected string|null | $pageName | Page name | from BaseController |
protected array | $params | Controller params | from BaseController |
protected array | $messages | Response messages | from Multilanguage |
protected string | $messagesComponentName | Messages component name | from Multilanguage |
protected boolean | $messagesLoaded | Messages loaded | from Multilanguage |
Methods
Get page url
Get page url
Get query param
Load messages from html component json file
Return true if page load is with new language code
Reguire permission check if current user have permission
Return true if user have access permission
Require control panel permission
Display page not found error
Display system error page
Constructor
Init controller, override this method in child classes
Call
Load page
Set redirect headers
Set no cache in Cache-Control
Write XML to reponse body
Details
in BaseController at line 59
string|false
getRouteUrl(string|null $routeName, string|null $extension, array $params = [], string|null $language = null, bool $relative = false)
Get page url
in BaseController at line 88
string
getPageUrl(string $path = '', bool $relative = false, string|null $language = null)
Get page url
in BaseController at line 98
array
getParams()
Get params
in BaseController at line 110
mixed|null
getParam(string $key, mixed|null $default = null)
Get param
in BaseController at line 121
protected bool
resolveRouteParams(Request $request)
Resolve route params
in BaseController at line 146
string|null
getPageName()
Get page name
in BaseController at line 157
void
setExtensionName(string|null $name)
Set extension name
in BaseController at line 167
string|null
getExtensionName()
Get extension name
in BaseController at line 178
mixed
get(string $id)
Get item from container
in BaseController at line 194
bool
has(string $id)
Return tru if container item esist
in BaseController at line 204
Container
getContainer()
Get container
in BaseController at line 216
bool
logInfo(string $message, array $context = [])
Log message
in BaseController at line 227
array
getRequestParams(Request $request)
Get request params
in BaseController at line 244
mixed
getQueryParam(ServerRequestInterface $request, string $name, mixed $default = null)
Get query param
in BaseController at line 258
array
resolveRequestParams(Request $request, array $paramsKeys)
Resolve params
in BaseController at line 275
string
getUrl(ServerRequestInterface $request, bool $relative = false)
Get url
in BaseController at line 289
string|null
getError(string $errorCode, array $params = [])
Get error
in BaseController at line 303
bool
logError(string $message, array $context = [])
Log error
in Multilanguage at line 50
string|null
getMessage(string $name)
Get message
in Multilanguage at line 66
void
loadMessages(string $componentName)
Load messages from html component json file
in Multilanguage at line 78
protected void
loadMesasgesComponent(string|null $language = null)
Load messages component
in Multilanguage at line 106
string
getPageLanguage(array $data = [])
Get page language
in Multilanguage at line 129
bool
isLanguageChange(array $data)
Return true if page load is with new language code
in Multilanguage at line 143
string
getDefaultLanguage()
Get default language
in UserAccess at line 25
void
requireAccess(string $name, mixed $type = null, object|null $response = null)
Reguire permission check if current user have permission
in UserAccess at line 43
bool
hasControlPanelAccess()
Return true if user have control panel access
in UserAccess at line 55
bool
hasAccess(string $name, string $type = null)
Return true if user have access permission
in UserAccess at line 66
mixed
requireControlPanelPermission(object|null $response = null)
Require control panel permission
in UserAccess at line 80
mixed
user()
Return current logged user
in UserAccess at line 90
int|null
getUserId()
Return current logged user id
in PageErrors at line 25
ResponseInterface
pageNotFound(ResponseInterface $response, array $data = [], string|null $templateName = null)
Display page not found error
in PageErrors at line 43
ResponseInterface
pageSystemError(ResponseInterface $response, array $error = [], string $templateName = 'system')
Display system error page
at line 37
__construct(Container $container = null)
Constructor
at line 48
void
init()
Init controller, override this method in child classes
at line 59
mixed
__call(string $name, array $arguments)
Call
at line 85
ResponseInterface
pageLoad($request, $response, $data, $pageName = null, string|null $language = null)
Load page
at line 122
ResponseInterface
withRedirect(ResponseInterface $response, string $url)
Set redirect headers
at line 136
@return
noCacheHeaders(@return $response)
Set no cache in Cache-Control
at line 152
ResponseInterface
writeXml(ResponseInterface $response, string $xml)
Write XML to reponse body