OnRouteStart
extends Event
in package
The OnRouteStart event is responsible for finding a matched route and calling any RouteFile(s) associated with the route/path.
Table of Contents
- $isCancelled : mixed
- $hooks : mixed
- $path : string
- __construct() : mixed
- OnRouteEvent constructor.
- call() : mixed
- getName() : mixed
- getPath() : mixed|string
- hook() : mixed
- isCancelled() : bool
- onEnd() : mixed
- run() : Event
- setIsCancelled() : mixed
- buildHooks() : mixed
Properties
$isCancelled
protected
mixed
$isCancelled
= false
$hooks
private
mixed
$hooks
= []
$path
private
string
$path
Methods
__construct()
OnRouteEvent constructor.
public
__construct(string $path) : mixed
Parameters
- $path : string
Return values
mixed —call()
public
call() : mixed
Return values
mixed —getName()
public
static getName() : mixed
Return values
mixed —getPath()
public
getPath() : mixed|string
Return values
mixed|string —hook()
public
static hook(callable $func) : mixed
Parameters
- $func : callable
Return values
mixed —isCancelled()
public
isCancelled() : bool
Return values
bool —onEnd()
public
onEnd(Event $event) : mixed
Parameters
- $event : Event
Return values
mixed —run()
public
run(Event $event) : Event
Parameters
- $event : Event
Return values
Event —setIsCancelled()
public
setIsCancelled(bool $isCancelled) : mixed
Parameters
- $isCancelled : bool
Return values
mixed —buildHooks()
private
buildHooks() : mixed