Documentation

WebApp extends App
in package

Handles HTTP request/response

Table of Contents

CONFIG_BASE_URL  = 'app.base_url'
CONFIG_ENVIRONMENT  = 'app.environment'
CONFIG_ERROR_PAGES_FOLDER  = 'app.error_pages_folder'
CONFIG_ROOT_PATH  = 'app.root_path'
CONTENT_TYPE_HTML  = 'text/html; charset=UTF-8'
CONTENT_TYPE_JSON  = 'application/json'
ERROR_CONTENT_PLACEHOLDER  = '<!-- content -->'
HEADER_CONTENT_TYPE  = 'Content-Type'
HEADER_LOCATION  = 'Location'
PRODUCTION_ENVIRONMENT  = 'prod'
$config  : Config
$configPaths  : array<string|int, string>
$exitOnFinish  : bool
$logger  : Logger
$middlewares  : array<string|int, Middleware>
Stores the middleware class names in a list
$response  : Response
$router  : Router
__construct()  : mixed
addMiddleware()  : mixed
Adds a middleware
finish()  : null
Finishes the application
fullInit()  : mixed
Fully initializes the application
fullProcess()  : mixed
Calls the `process()` method within a try/catch, handles exception with the `handleException()` method
init()  : mixed
Abstract function for initialize the application
process()  : mixed
Abstract function for processing the application
redirect()  : mixed
sendContent()  : mixed
sendError()  : mixed
Sends an error response
useRouteAnnotations()  : mixed
Call this if you want to use &#64;route annotations
handleException()  : void
Handles the exception
isWeb()  : bool
Returns true if the call is from the web
loadConfigs()  : mixed
Loads all of the configs by the `$configPaths`
loadErrorPageContent()  : string
If it exists, loads the content of an error HTML page otherwise returns the HTML comment for the error placeholder
runMiddlewares()  : mixed
Runs all of the added middlewares

Constants

CONFIG_BASE_URL

public mixed CONFIG_BASE_URL = 'app.base_url'

CONFIG_ENVIRONMENT

public mixed CONFIG_ENVIRONMENT = 'app.environment'

CONFIG_ERROR_PAGES_FOLDER

public mixed CONFIG_ERROR_PAGES_FOLDER = 'app.error_pages_folder'

CONFIG_ROOT_PATH

public mixed CONFIG_ROOT_PATH = 'app.root_path'

CONTENT_TYPE_HTML

public mixed CONTENT_TYPE_HTML = 'text/html; charset=UTF-8'

CONTENT_TYPE_JSON

public mixed CONTENT_TYPE_JSON = 'application/json'

ERROR_CONTENT_PLACEHOLDER

public mixed ERROR_CONTENT_PLACEHOLDER = '<!-- content -->'

HEADER_CONTENT_TYPE

public mixed HEADER_CONTENT_TYPE = 'Content-Type'

HEADER_LOCATION

public mixed HEADER_LOCATION = 'Location'

PRODUCTION_ENVIRONMENT

public mixed PRODUCTION_ENVIRONMENT = 'prod'

Properties

$configPaths

protected array<string|int, string> $configPaths

$exitOnFinish

protected bool $exitOnFinish = true

$middlewares

Stores the middleware class names in a list

protected array<string|int, Middleware> $middlewares = []

Methods

__construct()

public __construct(array<string|int, mixed> $configPaths) : mixed
Parameters
$configPaths : array<string|int, mixed>
Return values
mixed —

addMiddleware()

Adds a middleware

public addMiddleware(string $interface) : mixed

It adds only if it isn't in the middlewares yet

Parameters
$interface : string
Return values
mixed —

finish()

Finishes the application

public finish(string|int $content) : null

If the $exitOnFinish true (default) calls the exit, otherwise just prints out the content.

Parameters
$content : string|int

Content for the output. If it's an int, it is the return code of the process.

Return values
null —

fullInit()

Fully initializes the application

public fullInit() : mixed

Creates the Config, loads the configs, creates the Logger, calls the init() method then runs all of the middlewares. If an exception happens, handles it with the handleException() method.

Return values
mixed —

fullProcess()

Calls the `process()` method within a try/catch, handles exception with the `handleException()` method

public fullProcess() : mixed
Return values
mixed —

init()

Abstract function for initialize the application

public init() : mixed
Return values
mixed —

process()

Abstract function for processing the application

public process() : mixed
Return values
mixed —

redirect()

public redirect(mixed $location[, mixed $params = [] ]) : mixed
Parameters
$location : mixed
$params : mixed = []
Return values
mixed —

sendContent()

public sendContent(mixed $content) : mixed
Parameters
$content : mixed
Return values
mixed —

sendError()

Sends an error response

public sendError(int $code[, string $content = '' ]) : mixed
Parameters
$code : int

The error code

$content : string = ''

The error content

Return values
mixed —

useRouteAnnotations()

Call this if you want to use &#64;route annotations

public useRouteAnnotations() : mixed
Return values
mixed —

handleException()

Handles the exception

protected handleException(Exception $e) : void

Calls the parent exception handler, then calls the sendError with HTTP error 500. Sets the content for the error placeholder if the environment is not production.

Parameters
$e : Exception

The exception for handling

Return values
void —

isWeb()

Returns true if the call is from the web

protected isWeb() : bool
Return values
bool —

loadConfigs()

Loads all of the configs by the `$configPaths`

protected loadConfigs() : mixed
Return values
mixed —

loadErrorPageContent()

If it exists, loads the content of an error HTML page otherwise returns the HTML comment for the error placeholder

protected loadErrorPageContent(int $code) : string
Parameters
$code : int

The HTTP status code for the error

Return values
string —

The content of the HTML file or the HTML comment for the error placeholder

runMiddlewares()

Runs all of the added middlewares

protected runMiddlewares() : mixed
Return values
mixed —

Search results