API Documentation
\
Charcoal
Admin
Widget
Cms
Cms
Config
Mixin
Traits
Route
Section
Service
Loader
Manager
ServiceProvider
Support
Helpers
Interfaces
Traits
Property

\Charcoal\Cms\RouteNewsRoute

News Route Handler

Summary

Methods
Properties
Constants
__construct()
pathResolvable()
__invoke()
No public properties found
No constants found
loadNewsFromPath()
No protected properties found
N/A
No private methods found
$path
$news
$objType
N/A

Properties

$path

$path : string

URI path.

Type

string

$news

$news : \Charcoal\Cms\NewsInterface|\Charcoal\Object\RoutableInterface

The news entry matching the URI path.

Type

\Charcoal\Cms\NewsInterface|\Charcoal\Object\RoutableInterface

$objType

$objType : string

The news entry 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

loadNewsFromPath()

loadNewsFromPath(\Pimple\Container  $container) : \Charcoal\Cms\NewsInterface

Parameters

\Pimple\Container $container

Pimple DI container.

Returns

\Charcoal\Cms\NewsInterface