1. class
  2. Windwalker
  3. Core
  4. Application
  5. WebApplication

WebApplication

class WebApplication extends AbstractWebApplication implements WindwalkerApplicationInterface, DispatcherAwareInterface, ContainerAwareInterface (View source)

The WebApplication class.

Traits

WindwalkerTrait
The main Windwalker instantiate class.
BootableTrait
The BootableTrait class.
DispatcherAwareTrait
ContainerAwareTrait

Methods

string
getName()

getName

from WindwalkerTrait
Structure
getConfig()

getConfig

from WindwalkerTrait
void
boot()

boot

from WindwalkerTrait
AbstractPackage
getPackage(string $name = null)

getPackage

from WindwalkerTrait
WindwalkerTrait
addPackage(string $name, AbstractPackage $package)

addPackage

from WindwalkerTrait
boolean
isConsole()

isConsole

from WindwalkerTrait
boolean
isWeb()

isWeb

from WindwalkerTrait
__construct(ServerRequestInterface $request = null, Config $config = null, WebEnvironment $environment = null)

Class constructor.

ResponseInterface
execute()

Execute the application.

ResponseInterface
dispatch(ServerRequestInterface $request, ResponseInterface $response, callable $finalHandler = null)

Method as the Psr7 WebHttpServer handler.

MainRouter
getRouter(bool $new = false)

getRouter

WebApplication
bootRouting(bool $refresh = false)

bootRouting

WebApplication
setCurrentPackage(string|AbstractPackage $package)

setCurrentPackage

WebApplication
setTask(string|AbstractPackage $package, string|AbstractController $controller)

setTask

Psr7ChainBuilder
getMiddlewareChain()

getMiddlewareChain

PriorityQueue
getMiddlewares()

Method to get property Middlewares

WebApplication
setMiddlewares(PriorityQueue $middlewares)

Method to set property middlewares

WebApplication
addMiddleware(callable|Psr7InvokableInterface $middleware, int $priority = PriorityQueue::NORMAL)

addMiddleware

WindwalkerApplicationInterface
addMessage(string|array $messages, string $type = 'info')

addMessage

WebApplication
clearMessages()

clearMessage

LoggerManager
getLogger()

Get the logger.

void
redirect(string $url, boolean|int $code = 303)

Redirect to another URL.

string
getMode()

Method to get property Mode

WebApplication
setMode(string $mode)

Method to set property mode

mixed
__get($name)

is utilized for reading data from inaccessible members.

Details

in WindwalkerTrait at line line 46
string getName()

getName

Return Value

string

in WindwalkerTrait at line line 68
Structure getConfig()

getConfig

Return Value

Structure

in WindwalkerTrait at line line 78
void boot()

boot

Return Value

void

in WindwalkerTrait at line line 291
AbstractPackage getPackage(string $name = null)

getPackage

Parameters

string $name

Return Value

AbstractPackage

in WindwalkerTrait at line line 307
WindwalkerTrait addPackage(string $name, AbstractPackage $package)

addPackage

Parameters

string $name
AbstractPackage $package

Return Value

WindwalkerTrait

in WindwalkerTrait at line line 322
boolean isConsole()

isConsole

Return Value

boolean

in WindwalkerTrait at line line 332
boolean isWeb()

isWeb

Return Value

boolean

at line line 113
__construct(ServerRequestInterface $request = null, Config $config = null, WebEnvironment $environment = null)

Class constructor.

Parameters

ServerRequestInterface $request An optional argument to provide dependency injection for the Http request object.
Config $config An optional argument to provide dependency injection for the application's config object.
WebEnvironment $environment An optional argument to provide dependency injection for the application's environment object.

at line line 150
ResponseInterface execute()

Execute the application.

Return Value

ResponseInterface

at line line 212
ResponseInterface dispatch(ServerRequestInterface $request, ResponseInterface $response, callable $finalHandler = null)

Method as the Psr7 WebHttpServer handler.

Parameters

ServerRequestInterface $request The Psr7 ServerRequest to get request params.
ResponseInterface $response The Psr7 Response interface to prepare respond data.
callable $finalHandler The next handler to support middleware pattern.

Return Value

ResponseInterface The returned response object.

at line line 232
MainRouter getRouter(bool $new = false)

getRouter

Parameters

bool $new

Return Value

MainRouter

at line line 256
WebApplication bootRouting(bool $refresh = false)

bootRouting

Parameters

bool $refresh

Return Value

WebApplication

at line line 270
WebApplication setCurrentPackage(string|AbstractPackage $package)

setCurrentPackage

Parameters

string|AbstractPackage $package

Return Value

WebApplication

at line line 290
WebApplication setTask(string|AbstractPackage $package, string|AbstractController $controller)

setTask

Parameters

string|AbstractPackage $package
string|AbstractController $controller

Return Value

WebApplication

at line line 326
Psr7ChainBuilder getMiddlewareChain()

getMiddlewareChain

Return Value

Psr7ChainBuilder

at line line 358
PriorityQueue getMiddlewares()

Method to get property Middlewares

Return Value

PriorityQueue

at line line 375
WebApplication setMiddlewares(PriorityQueue $middlewares)

Method to set property middlewares

Parameters

PriorityQueue $middlewares

Return Value

WebApplication Return self to support chaining.

at line line 390
WebApplication addMiddleware(callable|Psr7InvokableInterface $middleware, int $priority = PriorityQueue::NORMAL)

addMiddleware

Parameters

callable|Psr7InvokableInterface $middleware
int $priority

Return Value

WebApplication

at line line 405
WindwalkerApplicationInterface addMessage(string|array $messages, string $type = 'info')

addMessage

Parameters

string|array $messages
string $type

Return Value

WindwalkerApplicationInterface

at line line 417
WebApplication clearMessages()

clearMessage

Return Value

WebApplication

at line line 431
LoggerManager getLogger()

Get the logger.

Return Value

LoggerManager

at line line 450
void redirect(string $url, boolean|int $code = 303)

Redirect to another URL.

If the headers have not been sent the redirect will be accomplished using a "301 Moved Permanently" or "303 See Other" code in the header pointing to the new location. If the headers have already been sent this will be accomplished using a JavaScript statement.

Parameters

string $url The URL to redirect to. Can only be http/https URL
boolean|int $code True if the page is 301 Permanently Moved, otherwise 303 See Other is assumed.

Return Value

void

at line line 466
string getMode()

Method to get property Mode

Return Value

string

at line line 478
WebApplication setMode(string $mode)

Method to set property mode

Parameters

string $mode

Return Value

WebApplication Return self to support chaining.

at line line 492
mixed __get($name)

is utilized for reading data from inaccessible members.

Parameters

$name string

Return Value

mixed