Windwalker\Core\Package\AbstractPackage

class AbstractPackage implements DispatcherAwareInterface (View source)

The AbstractPackage class.

Traits

ContainerAwareTrait

Methods

void

boot()

initialise

AbstractController

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)

void

registerListeners(DispatcherInterface $dispatcher)

registerListeners

void

registerCommands(Console $console)

AbstractPackage

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

addMiddleware

Psr7ChainBuilder

getMiddlewareChain()

getMiddlewareChain

PriorityQueue

getMiddlewares()

Method to get property Middlewares

AbstractPackage

setMiddlewares(PriorityQueue $middlewares)

Method to set property middlewares

AbstractPackage

loadConfig(Structure $config)

loadConfiguration

MainRouter

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

loadRouting

MvcResolver

getMvcResolver()

getMvcResolver

string

getName()

Get bundle name.

AbstractPackage

setName(string $name)

Method to set property name

mixed

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

get

AbstractPackage

set(string $name, mixed $value)

set

string

getFile()

getFile

string

getDir()

getDir

AbstractPackage

enable()

enable

AbstractPackage

disable()

disable

bool

isEnabled()

isEnabled

string

getTask()

Method to get property Task

AbstractPackage

setTask(string $task)

Method to set property task

DispatcherInterface

getDispatcher()

getDispatcher

AbstractPackage

setDispatcher(DispatcherInterface $dispatcher)

setDispatcher

Structure

getConfig()

Method to get property Config

AbstractPackage

setConfig(Structure $config)

Method to set property config

AbstractController

getCurrentController()

Method to get property CurrentController

mixed

__get(string $name)

__get

Details

at line line 116
`void boot()`

initialise

Return Value

void

Exceptions

LogicException

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

getController

Parameters

string	$task
array\|Input	$input
bool	$forceNew

Return Value

AbstractController

at line line 183
`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

at line line 211
`ResponseInterface dispatch(ServerRequestInterface $request, ResponseInterface $response, callable $next = null)`

dispatch

Parameters

ServerRequestInterface	$request
ResponseInterface	$response
callable	$next

Return Value

ResponseInterface

at line line 263
`ResponseInterface executeTask(string|AbstractController $task, array|Input $input = null)`

run

Parameters

string\|AbstractController	$task
array\|Input	$input

Return Value

ResponseInterface

at line line 296
`void registerProviders(Container $container)`

Parameters

Container

$container

void

at line line 420
`AbstractPackage addMiddleware(callable $middleware, int $priority = PriorityQueue::NORMAL)`

addMiddleware

Parameters

callable	$middleware
int	$priority

Return Value

AbstractPackage

at line line 432
`Psr7ChainBuilder getMiddlewareChain()`

getMiddlewareChain

Return Value

Psr7ChainBuilder

at line line 460
`PriorityQueue getMiddlewares()`

Method to get property Middlewares

Return Value

PriorityQueue

at line line 477
`AbstractPackage setMiddlewares(PriorityQueue $middlewares)`

Method to set property middlewares

Parameters

PriorityQueue

$middlewares

Return Value

AbstractPackage

Return self to support chaining.

at line line 491
`AbstractPackage loadConfig(Structure $config)`

loadConfiguration

Parameters

Structure

string

Bundle ame.

at line line 576
`AbstractPackage setName(string $name)`

Method to set property name

Parameters

string

$name

Return Value

AbstractPackage

Return self to support chaining.

at line line 591
`mixed get(string $name, mixed $default = null)`

get

Parameters

string	$name
mixed	$default

Return Value

mixed

at line line 604
`AbstractPackage set(string $name, mixed $value)`

set

Parameters

string	$name
mixed	$value

$name

Return Value

mixed

AbstractPackage

Traits

Methods

Details

at line line 116 void boot()

Return Value

Exceptions

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

Parameters

Return Value

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

Parameters

Return Value

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

Parameters

Return Value

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

Parameters

Return Value

at line line 296 void registerProviders(Container $container)

Parameters

Return Value

at line line 341 void registerListeners(DispatcherInterface $dispatcher)

Parameters

Return Value

at line line 383 void registerCommands(Console $console)

Parameters

Return Value

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

Parameters

Return Value

at line line 432 Psr7ChainBuilder getMiddlewareChain()

Return Value

at line line 460 PriorityQueue getMiddlewares()

Return Value

at line line 477 AbstractPackage setMiddlewares(PriorityQueue $middlewares)

Parameters

Return Value

at line line 491 AbstractPackage loadConfig(Structure $config)

Parameters

Return Value

at line line 532 MainRouter loadRouting(MainRouter $router, string $group = null)

Parameters

Return Value

at line line 554 MvcResolver getMvcResolver()

Return Value

at line line 564 string getName()

Return Value

at line line 576 AbstractPackage setName(string $name)

Parameters

Return Value

at line line 591 mixed get(string $name, mixed $default = null)

Parameters

Return Value

at line line 604 AbstractPackage set(string $name, mixed $value)

Parameters

Return Value

at line line 616 string getFile()

Return Value

at line line 628 string getDir()

Return Value

at line line 638 AbstractPackage enable()

Return Value

at line line 650 AbstractPackage disable()

Return Value

at line line 662 bool isEnabled()

Return Value

at line line 674 string getTask()

Return Value

at line line 688 AbstractPackage setTask(string $task)

Parameters

Return Value

at line line 700 DispatcherInterface getDispatcher()

Return Value

at line line 712 AbstractPackage setDispatcher(DispatcherInterface $dispatcher)

Parameters

Return Value

at line line 726 Structure getConfig()

Return Value

at line line 747 AbstractPackage setConfig(Structure $config)

at line line 116
`void boot()`

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

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

at line line 211
`ResponseInterface dispatch(ServerRequestInterface $request, ResponseInterface $response, callable $next = null)`

at line line 263
`ResponseInterface executeTask(string|AbstractController $task, array|Input $input = null)`

at line line 296
`void registerProviders(Container $container)`

at line line 341
`void registerListeners(DispatcherInterface $dispatcher)`

at line line 383
`void registerCommands(Console $console)`

at line line 420
`AbstractPackage addMiddleware(callable $middleware, int $priority = PriorityQueue::NORMAL)`

at line line 432
`Psr7ChainBuilder getMiddlewareChain()`

at line line 460
`PriorityQueue getMiddlewares()`

at line line 477
`AbstractPackage setMiddlewares(PriorityQueue $middlewares)`

at line line 491
`AbstractPackage loadConfig(Structure $config)`

at line line 532
`MainRouter loadRouting(MainRouter $router, string $group = null)`

at line line 554
`MvcResolver getMvcResolver()`

at line line 564
`string getName()`

at line line 576
`AbstractPackage setName(string $name)`

at line line 591
`mixed get(string $name, mixed $default = null)`

at line line 604
`AbstractPackage set(string $name, mixed $value)`

at line line 616
`string getFile()`

at line line 628
`string getDir()`

at line line 638
`AbstractPackage enable()`

at line line 650
`AbstractPackage disable()`

at line line 662
`bool isEnabled()`

at line line 674
`string getTask()`

at line line 688
`AbstractPackage setTask(string $task)`

at line line 700
`DispatcherInterface getDispatcher()`

at line line 712
`AbstractPackage setDispatcher(DispatcherInterface $dispatcher)`

at line line 726
`Structure getConfig()`

at line line 747
`AbstractPackage setConfig(Structure $config)`

at line line 759
`AbstractController getCurrentController()`

at line line 770
`mixed __get(string $name)`