Service

Creates Views and broadcasts the render event.

class Service implements ContainerAware
use ContainerSetter
Copyright
2015-2016 Appertly
License
Apache-2.0

Constructors / Destructors

Public
ReturnsSignature and Description
void
__construct(?Container $container)

Creates a new ViewService.

Instance Methods

Public
ReturnsSignature and Description
void
clearFlashMessages(bool $current = false)

Clears Flash Messages.

ConstVector<Block>
getBlocks(string $region)

Gets all blocks registered for a given region

ConstVector<DbRefResolver>
getDbRefResolvers()

Gets any Labrys\Db\DbRefResolver objects in the container.

?ServerRequestInterface
getDispatchedRequest()

Gets the last request that the Dispatcher sent to a controller.

ConstVector<EntityLinker>
getEntityLinkers()

Gets any Labrys\View\EntityLinker objects in the container.

ConstMap<string,ImmVector<string>>
getFlashMessages()

Gets any flash messages in the session keyed by status.

Page
getPage(Stringish $title)

Gets the Page for this request (created lazily).

void
keepFlashMessages()

Keeps all current flash messages for the next request.

void
setFlashMessage(string $name, string $value, bool $current = false)

Sets a Flash Message.

Protected
ReturnsSignature and Description
Awaitable<Vector<mixed>>
callPageVisitors(Page $page)

Calls the page visitors.

string
getPageTitle(?Stringish $title)

Generates a page title.

Method Details

__construct

public function __construct(?Container $container)

Creates a new ViewService.

Parameters
NameTypeDescription
$container?Container

The dependency injection container

callPageVisitors

protected function callPageVisitors(Page $page)

Calls the page visitors.

Parameters
NameTypeDescription
$pagePage

The page to visit

Returns
TypeDescription
Awaitable<Vector<mixed>>

clearFlashMessages

public function clearFlashMessages(bool $current = false)

Clears Flash Messages.

Parameters
NameTypeDescription
$currentbool

Whether to add message to the current request

getBlocks

public function getBlocks(string $region)

Gets all blocks registered for a given region

Parameters
NameTypeDescription
$regionstring

The region to search

Returns
TypeDescription
ConstVector<Block>

The found blocks in that region, or an empty array.

getDbRefResolvers

public function getDbRefResolvers()

Gets any Labrys\Db\DbRefResolver objects in the container.

Since
0.5.0
Returns
TypeDescription
ConstVector<DbRefResolver>

The DbRefResolver objects found.

getDispatchedRequest

public function getDispatchedRequest()

Gets the last request that the Dispatcher sent to a controller.

Since
0.6.3
Returns
TypeDescription
?ServerRequestInterface

The last dispatched request, or null

getEntityLinkers

public function getEntityLinkers()

Gets any Labrys\View\EntityLinker objects in the container.

Since
0.5.0
Returns
TypeDescription
ConstVector<EntityLinker>

The EntityLinker objects found.

getFlashMessages

public function getFlashMessages()

Gets any flash messages in the session keyed by status.

Returns
TypeDescription
ConstMap<string,ImmVector<string>>

ImmMap of flash messages

getPage

public function getPage(Stringish $title)

Gets the Page for this request (created lazily).

Parameters
NameTypeDescription
$titleStringish

The page title

Returns
TypeDescription
Page

A Page

getPageTitle

protected function getPageTitle(?Stringish $title)

Generates a page title.

Parameters
NameTypeDescription
$title?Stringish

The page title

Returns
TypeDescription
string

The formatted page title

keepFlashMessages

public function keepFlashMessages()

Keeps all current flash messages for the next request.

setFlashMessage

public function setFlashMessage(string $name, string $value, bool $current = false)

Sets a Flash Message.

Parameters
NameTypeDescription
$namestring

The status

$valuestring

The message

$currentbool

Whether to add message to the current request