ICanBoogie/Routing master
  • Namespace
  • Class

Namespaces

  • ICanBoogie
    • Routing
      • Controller
      • Route
      • RouteDispatcher

Classes

  • BeforeDispatchEvent
  • DispatchEvent

Class BeforeDispatchEvent

Event class for the ICanBoogie\Routing\RouteDispatcher::dispatch:before event.

Third parties may use this event to provide a response to the request before the route is mapped. The event is usually used by third parties to redirect requests or provide cached responses.

ICanBoogie\Event
Extended by ICanBoogie\Routing\RouteDispatcher\BeforeDispatchEvent
Namespace: ICanBoogie\Routing\RouteDispatcher
Located at RouteDispatcher/BeforeDispatchEvent.php

Methods summary

protected ICanBoogie\Routing\Route
# get_route( )

Returns

ICanBoogie\Routing\Route
protected ICanBoogie\HTTP\Request
# get_request( )

Returns

ICanBoogie\HTTP\Request
protected ICanBoogie\HTTP\Response|null
# get_response( )

Returns

ICanBoogie\HTTP\Response|null
protected
# set_response( ICanBoogie\HTTP\Response & $response = null )

Parameters

$response
public
# __construct( ICanBoogie\Routing\RouteDispatcher $target, ICanBoogie\Routing\Route $route, ICanBoogie\HTTP\Request $request, ICanBoogie\HTTP\Response & $response = null )

The event is constructed with the type self::TYPE.

The event is constructed with the type self::TYPE.

Parameters

$target
$route
$request
$response

Constants summary

string TYPE
# 'dispatch:before'

Properties summary

Magic properties

public ICanBoogie\HTTP\Response $response
public read-only ICanBoogie\Routing\Route $route
public read-only ICanBoogie\HTTP\Request $request
ICanBoogie/Routing master API documentation generated by ApiGen