API Documentation
Back to top  

Controller class

package Default

 Methods

Handling Shutdown

handleShutdown() : void

If you need to customize the handling of shutdown, please override it with subclasses.

codeCoverageIgnore

Main Processing

main(string $controller, \Kore\array<string> $args) : void

Parameters

$controller

string

controller namespace

$args

\Kore\array<string>

path arguments

Action

action() : void

The action is implemented in subclasses.

Extract the view

extractView(string $path, \Kore\array<mixed> $data = array()) : string | false

Parameters

$path

string

view file path

$data

\Kore\array<mixed>

response data

Returns

stringfalseview

Get the path arguments

getArg(string|null $key = null, mixed $default = null) : mixed

If no key is specified, all path arguments are returned.

Parameters

$key

stringnull

path argument key

$default

mixed

default value if there is no value specified in the key

Returns

mixedpath arguments

Get the body data

getBody() : string

Returns

stringbody data

Get the cookie parameters

getCookie(string|null $key = null, mixed $default = null) : mixed

If no key is specified, all cookie parameters are returned.

Parameters

$key

stringnull

cookie parameter key

$default

mixed

default value if there is no value specified in the key

Returns

mixedcookie parameters

Get from array

getFromArray(\Kore\array<mixed> $array, string|null $key = null, mixed $default = null) : mixed

If no key is specified, array is returned.

Parameters

$array

\Kore\array<mixed>

array

$key

stringnull

path key

$default

mixed

default value if there is no value specified in the key

Returns

mixedvalue

Get the http header

getHeader(string $key, mixed $default = null) : mixed

Parameters

$key

string

header key

$default

mixed

default value if there is no value specified in the key

Returns

mixedhttp header

Get the body data in json format

getJsonBody() : \Kore\array<mixed>

Returns

\Kore\array<mixed>body data

Get the http method

getMethod() : mixed

Returns

mixedhttp method

Get the post parameters

getPost(string|null $key = null, mixed $default = null) : mixed

If no key is specified, all post parameters are returned.

Parameters

$key

stringnull

post parameter key

$default

mixed

default value if there is no value specified in the key

Returns

mixedpost parameters

Get the query parameters

getQuery(string|null $key = null, mixed $default = null) : mixed

If no key is specified, all query parameters are returned.

Parameters

$key

stringnull

query parameter key

$default

mixed

default value if there is no value specified in the key

Returns

mixedquery parameters

Get the server parameters

getServer(string|null $key = null, mixed $default = null) : mixed

If no key is specified, all server parameters are returned.

Parameters

$key

stringnull

server parameter key

$default

mixed

default value if there is no value specified in the key

Returns

mixedserver parameters

Get the User Agent

getUserAgent() : mixed

Returns

mixedUser Agent

Handling Errors

handleError(\Exception $e) : void

If you need to customize the handling of errors, please override it with subclasses.

Parameters

$e

\Exception

errors

Exceptions

\Exception

Get the log level

logLevel() : integer

The default is Log::LEVEL_DEBUG. If you need to customize, please override it with subclasses.

see \Kore\Log

Returns

integerlog level

Get the module name

moduleName() : string

The default is 'app'. If you need to customize, please override it with subclasses.

Returns

stringmodule name

Preprocessing of the action

preaction() : void

If you need to customize, please override it with subclasses.

Redirect

redirect(string $url, integer $responseCode = 302) : void

Parameters

$url

string

redirect url

$responseCode

integer

http status code, the default is 302

Respond in json format

respondJson(\Kore\array<mixed> $data = array(), integer $responseCode = 200) : void

Parameters

$data

\Kore\array<mixed>

response data

$responseCode

integer

http status code, the default is 200

Respond in view format

respondView(string $path, \Kore\array<mixed> $data = array(), integer $responseCode = 200) : void

Parameters

$path

string

view file path

$data

\Kore\array<mixed>

response data

$responseCode

integer

http status code, the default is 200

 Properties

 

path arguments

$args : \Kore\array<string>

Default

array()
 

request body

$body : string

Default

 

controller namespace

$controller : string

Default