class SystemPackage extends AbstractPackage (View source)

Class SystemPackage

Traits

ContainerAwareTrait

Methods

void
boot()

initialise

getController(string $task, array|Input $input = null, bool $forceNew = false)

getController

ResponseInterface
execute(string|AbstractController $controller, ServerRequestInterface $request, ResponseInterface $response, bool $hmvc = false)

execute

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

dispatch

ResponseInterface
executeTask(string|AbstractController $task, array|Input $input = null)

run

void
registerProviders(Container $container)

Register providers.

void
registerListeners(DispatcherInterface $dispatcher)

registerListeners

void
registerCommands(Console $console)

Register commands to console.

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

addMiddleware

Psr7ChainBuilder
getMiddlewareChain()

getMiddlewareChain

PriorityQueue
getMiddlewares()

Method to get property Middlewares

setMiddlewares(PriorityQueue $middlewares)

Method to set property middlewares

loadConfig(Structure $config)

loadConfiguration

loadRouting(MainRouter $router, string $group = null)

loadRouting

getMvcResolver()

getMvcResolver

string
getName()

Get bundle name.

setName(string $name)

Method to set property name

mixed
get(string $name, mixed $default = null)

get

set(string $name, mixed $value)

set

string
getFile()

getFile

string
getDir()

getDir

bool
isEnabled()

isEnabled

string
getTask()

Method to get property Task

setTask(string $task)

Method to set property task

DispatcherInterface
getDispatcher()

getDispatcher

setDispatcher(DispatcherInterface $dispatcher)

setDispatcher

Structure
getConfig()

Method to get property Config

setConfig(Structure $config)

Method to set property config

getCurrentController()

Method to get property CurrentController

mixed
__get(string $name)

__get

Details

void boot()

initialise

Return Value

void

Exceptions

LogicException

AbstractController getController(string $task, array|Input $input = null, bool $forceNew = false)

getController

Parameters

string $task
array|Input $input
bool $forceNew

Return Value

AbstractController

ResponseInterface execute(string|AbstractController $controller, ServerRequestInterface $request, ResponseInterface $response, bool $hmvc = false)

execute

Parameters

string|AbstractController $controller
ServerRequestInterface $request
ResponseInterface $response
bool $hmvc

Return Value

ResponseInterface

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

dispatch

Parameters

ServerRequestInterface $request
ResponseInterface $response
callable $next

Return Value

ResponseInterface

ResponseInterface executeTask(string|AbstractController $task, array|Input $input = null)

run

Parameters

string|AbstractController $task
array|Input $input

Return Value

ResponseInterface

void registerProviders(Container $container)

Register providers.

Parameters

Container $container

Return Value

void

void registerListeners(DispatcherInterface $dispatcher)

registerListeners

Parameters

DispatcherInterface $dispatcher

Return Value

void

void registerCommands(Console $console)

Register commands to console.

Parameters

Console $console Windwalker console object.

Return Value

void

AbstractPackage addMiddleware(callable $middleware, int $priority = PriorityQueue::NORMAL)

addMiddleware

Parameters

callable $middleware
int $priority

Return Value

AbstractPackage

Psr7ChainBuilder getMiddlewareChain()

getMiddlewareChain

Return Value

Psr7ChainBuilder

PriorityQueue getMiddlewares()

Method to get property Middlewares

Return Value

PriorityQueue

AbstractPackage setMiddlewares(PriorityQueue $middlewares)

Method to set property middlewares

Parameters

PriorityQueue $middlewares

Return Value

AbstractPackage Return self to support chaining.

AbstractPackage loadConfig(Structure $config)

loadConfiguration

Parameters

Structure $config

Return Value

AbstractPackage

MainRouter loadRouting(MainRouter $router, string $group = null)

loadRouting

Parameters

MainRouter $router
string $group

Return Value

MainRouter

MvcResolver getMvcResolver()

getMvcResolver

Return Value

MvcResolver

string getName()

Get bundle name.

Return Value

string Bundle ame.

AbstractPackage setName(string $name)

Method to set property name

Parameters

string $name

Return Value

AbstractPackage Return self to support chaining.

mixed get(string $name, mixed $default = null)

get

Parameters

string $name
mixed $default

Return Value

mixed

AbstractPackage set(string $name, mixed $value)

set

Parameters

string $name
mixed $value

Return Value

AbstractPackage

string getFile()

getFile

Return Value

string

string getDir()

getDir

Return Value

string

AbstractPackage enable()

enable

Return Value

AbstractPackage

AbstractPackage disable()

disable

Return Value

AbstractPackage

bool isEnabled()

isEnabled

Return Value

bool

string getTask()

Method to get property Task

Return Value

string

AbstractPackage setTask(string $task)

Method to set property task

Parameters

string $task

Return Value

AbstractPackage Return self to support chaining.

DispatcherInterface getDispatcher()

getDispatcher

Return Value

DispatcherInterface

AbstractPackage setDispatcher(DispatcherInterface $dispatcher)

setDispatcher

Parameters

DispatcherInterface $dispatcher

Return Value

AbstractPackage Return self to support chaining.

Structure getConfig()

Method to get property Config

Return Value

Structure

AbstractPackage setConfig(Structure $config)

Method to set property config

Parameters

Structure $config

Return Value

AbstractPackage Return self to support chaining.

AbstractController getCurrentController()

Method to get property CurrentController

Return Value

AbstractController

mixed __get(string $name)

__get

Parameters

string $name

Return Value

mixed