Page
class Page extends ApiController
Page Api controller
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 |
protected array | $result | Response result | from ApiResponse |
protected bool | $prettyFormat | pretty format json | from ApiResponse |
protected Closure|null | $dataValidCallback | Data validatin callback | from Errors |
protected Closure|null | $dataErrorCallback | Data error callback | from Errors |
protected array|null | $validationErrorMessages | Validation error messages | from Errors |
protected array | $errors | Errors list | from Errors |
protected string | $modelClass | Model class name | from ApiController |
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
Add message to response, first find in messages array if not found display name value as message
Set response
Set result filelds
Set error, first find in messages array if not found display name value as error
Run {method name}Controller function if exist
Load library details
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 ApiResponse at line 37
ResponseInterface
getResponse(bool $raw = false)
Return response
in ApiResponse at line 55
ApiController
message(string $name)
Add message to response, first find in messages array if not found display name value as message
in ApiResponse at line 72
Self
field(string $name, mixed $value)
Set result field
in ApiResponse at line 84
Self
useJsonPrettyformat()
Set json pretty format to true
in ApiResponse at line 99
mixed
setResponse(bool $condition, array|string|Closure $data, string|string|Closure $error)
Set response
in ApiResponse at line 124
Self
setResult(mixed $data)
Set response result
in ApiResponse at line 136
void
clearResult()
Clear result
in ApiResponse at line 153
void
setResultField(string $name, mixed $value)
Set field to result array
in ApiResponse at line 165
void
setResultFields(array $values, string|null $filedName = null)
Set result filelds
in ApiResponse at line 182
string
getResponseJson(bool $raw = false)
Return json
in Errors at line 54
void
setErrors(array $errors)
Set errors
in Errors at line 66
ApiController
error(string $name, array $params = [])
Set error, first find in messages array if not found display name value as error
in Errors at line 85
void
addError(string $errorCode)
Add system error
in Errors at line 99
protected string|null
getValidationErrorMessage(string $code)
Get validaiton error message
in Errors at line 110
void
addErrors(array $errors)
Add errors
in Errors at line 120
int
getErrorCount()
Return errors count
in Errors at line 130
bool
hasError()
Return true if response have error
in Errors at line 142
Self
withError(string $errorMessage, bool $condition = true)
Set error message
in Errors at line 156
void
setError(string $errorMessage, bool $condition = true)
Set error message
in Errors at line 168
void
clearErrors()
Clear all errors.
in Errors at line 220
void
loadValidationErrors()
Load validation error messages
in Errors at line 236
protected array
resolveValidationErrors(array $errors)
Resolve validation errors
in ApiController at line 42
__construct(Container $container = null)
Constructor
in ApiController at line 61
void
init()
Init controller, override this method in child classes
in ApiController at line 72
mixed|false
dispatch(string $eventName, array $params)
Dispatch event
in ApiController at line 83
void
setModelClass(string $class)
Set model class name
in ApiController at line 93
string|null
getModelClass()
Get model class name
in ApiController at line 105
mixed
__call(string $name, array $arguments)
Run {method name}Controller function if exist
at line 27
ResponseInterface
loadLibraryDetails(ServerRequestInterface $request, ResponseInterface $response, Validator $data)
Load library details