Documentation

LinkProviderInterface

A link provider object.

Table of Contents

Methods

getLinks()  : iterable<string|int, LinkInterface>
Returns an iterable of LinkInterface objects.
getLinksByRel()  : iterable<string|int, LinkInterface>
Returns an iterable of LinkInterface objects that have a specific relationship.

Methods

Returns an iterable of LinkInterface objects.

public getLinks() : iterable<string|int, LinkInterface>

The iterable may be an array or any PHP \Traversable object. If no links are available, an empty array or \Traversable MUST be returned.

Return values
iterable<string|int, LinkInterface>

getLinksByRel()

Returns an iterable of LinkInterface objects that have a specific relationship.

public getLinksByRel(string $rel) : iterable<string|int, LinkInterface>

The iterable may be an array or any PHP \Traversable object. If no links with that relationship are available, an empty array or \Traversable MUST be returned.

Parameters
$rel : string

The relationship name for which to retrieve links.

Return values
iterable<string|int, LinkInterface>

        
On this page

Search results