\Charcoal\Cms\RouteEventRoute

Event Route Handler

Summary

Methods

Properties

Constants

__construct()
pathResolvable()
__invoke()

No public properties found

No constants found

loadEventFromPath()

No protected properties found

N/A

No private methods found

$path
$event
$objType

N/A

File: Cms/Route/EventRoute.php
Package: Default
Class hierarchy: \Charcoal\App\Route\TemplateRoute

\Charcoal\Cms\Route\EventRoute
Uses traits: \Charcoal\Translator\TranslatorAwareTrait

Properties

$path

$path : string

URI path.

Type

string

$event

$event : \Charcoal\Cms\EventInterface|\Charcoal\Object\RoutableInterface

The event object matching the URI path.

Type

\Charcoal\Cms\EventInterface|\Charcoal\Object\RoutableInterface

$objType

$objType : string

The event model.

Type

string

Methods

__construct()

__construct(array  $data)

Parameters

array

$data

Class depdendencies.

pathResolvable()

pathResolvable(\Pimple\Container  $container) : boolean

Determine if the URI path resolves to an object.

Parameters

\Pimple\Container

$container

A DI (Pimple) container.

Returns

boolean

__invoke()

__invoke(\Pimple\Container  $container, \Psr\Http\Message\RequestInterface  $request, \Psr\Http\Message\ResponseInterface  $response) : \Psr\Http\Message\ResponseInterface

Parameters

\Pimple\Container	$container	A DI (Pimple) container.
\Psr\Http\Message\RequestInterface	$request	A PSR-7 compatible Request instance.
\Psr\Http\Message\ResponseInterface	$response	A PSR-7 compatible Response instance.

Returns

\Psr\Http\Message\ResponseInterface

loadEventFromPath()

loadEventFromPath(\Pimple\Container  $container) : \Charcoal\Cms\EventInterface

Parameters

\Pimple\Container

$container

Pimple DI container.

Returns

\Charcoal\Cms\EventInterface