1. class
  2. Arikaim
  3. \
  4. Core
  5. \
  6. Controllers
  7. \
  8. BaseApiController

BaseApiController

class BaseApiController

BaseApiController class

Traits

BaseController
Controller trait
ApiResponse
ApiResponse trait

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 $result Response result from ApiResponse
protected bool $prettyFormat pretty format json from ApiResponse

Methods

string|false
getRouteUrl(string|null $routeName, string|null $extension, array $params = [], string|null $language = null, bool $relative = false)

Get page url

from BaseController
string
getPageUrl(string $path = '', bool $relative = false, string|null $language = null)

Get page url

from BaseController
array
getParams()

Get params

from BaseController
mixed|null
getParam(string $key, mixed|null $default = null)

Get param

from BaseController
bool
resolveRouteParams(Request $request)

Resolve route params

from BaseController
string|null
getPageName()

Get page name

from BaseController
void
setExtensionName(string|null $name)

Set extension name

from BaseController
string|null
getExtensionName()

Get extension name

from BaseController
mixed
get(string $id)

Get item from container

from BaseController
bool
has(string $id)

Return tru if container item esist

from BaseController
Container
getContainer()

Get container

from BaseController
bool
logInfo(string $message, array $context = [])

Log message

from BaseController
array
getRequestParams(Request $request)

Get request params

from BaseController
mixed
getQueryParam(ServerRequestInterface $request, string $name, mixed $default = null)

Get query param

from BaseController
array
resolveRequestParams(Request $request, array $paramsKeys)

Resolve params

from BaseController
string
getUrl(ServerRequestInterface $request, bool $relative = false)

Get url

from BaseController
string|null
getError(string $errorCode, array $params = [])

Get error

from BaseController
bool
logError(string $message, array $context = [])

Log error

from BaseController
ResponseInterface
getResponse(bool $raw = false)

Return response

from ApiResponse
ApiController
message(string $name)

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

from ApiResponse
Self
field(string $name, mixed $value)

Set result field

from ApiResponse
Self
useJsonPrettyformat()

Set json pretty format to true

from ApiResponse
mixed
setResponse(bool $condition, array|string|Closure $data, string|string|Closure $error)

Set response

from ApiResponse
Self
setResult(mixed $data)

Set response result

from ApiResponse
void
clearResult()

Clear result

from ApiResponse
void
setResultField(string $name, mixed $value)

Set field to result array

from ApiResponse
void
setResultFields(array $values, string|null $filedName = null)

Set result filelds

from ApiResponse
string
getResponseJson(bool $raw = false)

Return json

from ApiResponse
__construct(Container $container = null)

Constructor

void
init()

Init controller, override this method in child classes

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

Parameters

string|null $routeName
string|null $extension
array $params
string|null $language
bool $relative

Return Value

string|false

in BaseController at line 88
string getPageUrl(string $path = '', bool $relative = false, string|null $language = null)

Get page url

Parameters

string $path
bool $relative
string|null $language

Return Value

string

in BaseController at line 98
array getParams()

Get params

Return Value

array

in BaseController at line 110
mixed|null getParam(string $key, mixed|null $default = null)

Get param

Parameters

string $key
mixed|null $default

Return Value

mixed|null

in BaseController at line 121
protected bool resolveRouteParams(Request $request)

Resolve route params

Parameters

Request $request

Return Value

bool

in BaseController at line 146
string|null getPageName()

Get page name

Return Value

string|null

in BaseController at line 157
void setExtensionName(string|null $name)

Set extension name

Parameters

string|null $name

Return Value

void

in BaseController at line 167
string|null getExtensionName()

Get extension name

Return Value

string|null

in BaseController at line 178
mixed get(string $id)

Get item from container

Parameters

string $id

Return Value

mixed

in BaseController at line 194
bool has(string $id)

Return tru if container item esist

Parameters

string $id

Return Value

bool

in BaseController at line 204
Container getContainer()

Get container

Return Value

Container

in BaseController at line 216
bool logInfo(string $message, array $context = [])

Log message

Parameters

string $message
array $context

Return Value

bool

in BaseController at line 227
array getRequestParams(Request $request)

Get request params

Parameters

Request $request

Return Value

array

in BaseController at line 244
mixed getQueryParam(ServerRequestInterface $request, string $name, mixed $default = null)

Get query param

Parameters

ServerRequestInterface $request
string $name
mixed $default

Return Value

mixed

in BaseController at line 258
array resolveRequestParams(Request $request, array $paramsKeys)

Resolve params

Parameters

Request $request
array $paramsKeys

Return Value

array

in BaseController at line 275
string getUrl(ServerRequestInterface $request, bool $relative = false)

Get url

Parameters

ServerRequestInterface $request
bool $relative

Return Value

string

in BaseController at line 289
string|null getError(string $errorCode, array $params = [])

Get error

Parameters

string $errorCode
array $params

Return Value

string|null

in BaseController at line 303
bool logError(string $message, array $context = [])

Log error

Parameters

string $message
array $context

Return Value

bool

in ApiResponse at line 37
ResponseInterface getResponse(bool $raw = false)

Return response

Parameters

bool $raw

Return Value

ResponseInterface

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

Parameters

string $name

Return Value

ApiController

in ApiResponse at line 72
Self field(string $name, mixed $value)

Set result field

Parameters

string $name
mixed $value

Return Value

Self

in ApiResponse at line 84
Self useJsonPrettyformat()

Set json pretty format to true

Return Value

Self

in ApiResponse at line 99
mixed setResponse(bool $condition, array|string|Closure $data, string|string|Closure $error)

Set response

Parameters

bool $condition
array|string|Closure $data
string|string|Closure $error

Return Value

mixed

in ApiResponse at line 124
Self setResult(mixed $data)

Set response result

Parameters

mixed $data

Return Value

Self

in ApiResponse at line 136
void clearResult()

Clear result

Return Value

void

in ApiResponse at line 153
void setResultField(string $name, mixed $value)

Set field to result array

Parameters

string $name
mixed $value

Return Value

void

in ApiResponse at line 165
void setResultFields(array $values, string|null $filedName = null)

Set result filelds

Parameters

array $values
string|null $filedName

Return Value

void

in ApiResponse at line 182
string getResponseJson(bool $raw = false)

Return json

Parameters

bool $raw

Return Value

string

at line 29
__construct(Container $container = null)

Constructor

Parameters

Container $container

at line 42
void init()

Init controller, override this method in child classes

Return Value

void