Link
in package
The Link object described in: - section 5 of the HAL specification.
Tags
Table of Contents
- $deprecation : mixed
- $href : mixed
- $hreflang : mixed
- $name : mixed
- $profile : mixed
- $templated : mixed
- $title : mixed
- $type : mixed
- __construct() : mixed
- See getters for details about each param.
- __set() : mixed
- The magic setter is overridden to insure immutability.
- __toString() : mixed
- fromJson() : Link
- Constructor from a map of properties (json).
- getDeprecation() : string|null
- OPTIONAL Its presence indicates that the link is to be deprecated (i.e.
- getHref() : string
- REQUIRED Its value is either a URI [RFC3986] or a URI Template [RFC6570].<br> If the value is a URI Template then the Link Object SHOULD have a "templated" attribute whose value is true.
- getHreflang() : string|null
- OPTIONAL Its value is a string and is intended for indicating the language of the target resource (as defined by [RFC5988]).
- getName() : string|null
- OPTIONAL Its value MAY be used as a secondary key for selecting Link Objects which share the same relation type.
- getProfile() : string|null
- OPTIONAL Its value is a string which is a URI that hints about the profile (as defined by [I-D.wilde-profile-link]) of the target resource.
- getTitle() : string|null
- OPTIONAL Its value is a string and is intended for labelling the link with a human-readable identifier (as defined by [RFC5988]).
- getType() : string|null
- OPTIONAL Its value is a string used as a hint to indicate the media type expected when dereferencing the target resource.
- isTemplated() : bool|null
- OPTIONAL Its value is boolean and SHOULD be true when the Link Object's "href" property is a URI Template.<br> Its value SHOULD be considered false if it is undefined or any other value than true.
Properties
$deprecation
private
mixed
$deprecation
$href
private
mixed
$href
$hreflang
private
mixed
$hreflang
$name
private
mixed
$name
$profile
private
mixed
$profile
$templated
private
mixed
$templated
$title
private
mixed
$title
$type
private
mixed
$type
Methods
__construct()
See getters for details about each param.
public
__construct(string $href[, bool|null $templated = null ][, string|null $type = null ][, string|null $deprecation = null ][, string|null $name = null ][, string|null $profile = null ][, string|null $title = null ][, string|null $hreflang = null ]) : mixed
Parameters
- $href : string
- $templated : bool|null = null
- $type : string|null = null
- $deprecation : string|null = null
- $name : string|null = null
- $profile : string|null = null
- $title : string|null = null
- $hreflang : string|null = null
Return values
mixed —__set()
The magic setter is overridden to insure immutability.
public
final __set( $name, $value) : mixed
Parameters
Return values
mixed —__toString()
public
__toString() : mixed
Return values
mixed —fromJson()
Constructor from a map of properties (json).
public
static fromJson(string|array<string|int, mixed>|object $json) : Link
Keys that are not a valid property are ignored.
Parameters
- $json : string|array<string|int, mixed>|object
Return values
Link —getDeprecation()
OPTIONAL Its presence indicates that the link is to be deprecated (i.e.
public
getDeprecation() : string|null
removed) at a future date. Its value is a URL that SHOULD provide further information about the deprecation. A client SHOULD provide some notification (for example, by logging a warning message) whenever it traverses over a link that has this property. The notification SHOULD include the deprecation property's value so that a client maintainer can easily find information about the deprecation.
Return values
string|null —getHref()
REQUIRED Its value is either a URI [RFC3986] or a URI Template [RFC6570].<br> If the value is a URI Template then the Link Object SHOULD have a "templated" attribute whose value is true.
public
getHref() : string
Return values
string —getHreflang()
OPTIONAL Its value is a string and is intended for indicating the language of the target resource (as defined by [RFC5988]).
public
getHreflang() : string|null
Return values
string|null —getName()
OPTIONAL Its value MAY be used as a secondary key for selecting Link Objects which share the same relation type.
public
getName() : string|null
Return values
string|null —getProfile()
OPTIONAL Its value is a string which is a URI that hints about the profile (as defined by [I-D.wilde-profile-link]) of the target resource.
public
getProfile() : string|null
Return values
string|null —getTitle()
OPTIONAL Its value is a string and is intended for labelling the link with a human-readable identifier (as defined by [RFC5988]).
public
getTitle() : string|null
Return values
string|null —getType()
OPTIONAL Its value is a string used as a hint to indicate the media type expected when dereferencing the target resource.
public
getType() : string|null
Return values
string|null —isTemplated()
OPTIONAL Its value is boolean and SHOULD be true when the Link Object's "href" property is a URI Template.<br> Its value SHOULD be considered false if it is undefined or any other value than true.
public
isTemplated() : bool|null