Documentation

Follow extends AbstractRequest
in package
implements FollowInterface

A Follow link request.

Interfaces, Classes, Traits and Enums

FollowInterface
The Follow link request interface.

Table of Contents

$headers  : mixed
$messageBody  : mixed
$method  : mixed
$urlVariables  : mixed
$rel  : mixed
__construct()  : mixed
__set()  : mixed
The magic setter is overridden to insure immutability.
getHeaders()  : array<string|int, mixed>
getMessageBody()  : AbstractMessageBody
getMethod()  : string
getRel()  : Rel
getUrl()  : string
Looks for a unique Link referenced by the set relation type (Rel) and returns its href property.
getUrlVariables()  : array<string|int, mixed>

Properties

Methods

__construct()

public __construct(Rel $rel[, string $method = 'GET' ][, array<string|int, mixed> $urlVariables = null ][, AbstractMessageBody $messageBody = null ][, array<string|int, mixed> $headers = null ]) : mixed
Parameters
$rel : Rel

The relation type

$method : string = 'GET'

GET, POST, PUT, PATCH or DELETE

$urlVariables : array<string|int, mixed> = null

The value of the URL variables contained in the URL template

$messageBody : AbstractMessageBody = null

The messageBody to send with the request

$headers : array<string|int, mixed> = null

Optional headers

Return values
mixed —

__set()

The magic setter is overridden to insure immutability.

public final __set( $name,  $value) : mixed
Parameters
$name :
$value :
Return values
mixed —

getHeaders()

public getHeaders() : array<string|int, mixed>
Return values
array<string|int, mixed> —

The optional headers

getMethod()

public getMethod() : string
Return values
string —

GET, POST, PUT, PATCH or DELETE

getRel()

public getRel() : Rel
Return values
Rel —

the relation type

getUrl()

Looks for a unique Link referenced by the set relation type (Rel) and returns its href property.

public getUrl(ResourceInterface $resource) : string
Parameters
$resource : ResourceInterface

The Resource containing a Link referenced by the set relation type (Rel)

Return values
string —

the URL in the href property of the Link

getUrlVariables()

public getUrlVariables() : array<string|int, mixed>
Return values
array<string|int, mixed> —

the value of the URL variables contained in the URL template

Search results