EntityLinker

Allows the creation of <a> nodes that point to an entity's canonical location.

interface EntityLinker
Copyright
2015-2016 Appertly
License
Apache-2.0

Instance Methods

Public
ReturnsSignature and Description
Awaitable<XHPRoot>
compose(mixed $entity)

Composes the link for a given entity.

bool
supports(mixed $entity)

Whether this linker supports the provided entity.

Method Details

compose

abstract public function compose(mixed $entity)

Composes the link for a given entity.

Parameters
NameTypeDescription
$entitymixed

The entity to link

Returns
TypeDescription
Awaitable<XHPRoot>

The XHP node for the entity's link

Throws
TypeConditions
InvalidArgumentException

if the entity isn't supported

supports

abstract public function supports(mixed $entity)

Whether this linker supports the provided entity.

Parameters
NameTypeDescription
$entitymixed

The entity to link

Returns
TypeDescription
bool

true if the entity is supported