ResourceInterface
in
The Resource Object described in the JSON Hypertext Application Language (draft-kelly-json-hal-07).
Tags
Table of Contents
- fromJson() : resource
- Builds a Resource from its JSON representation.
- getAllEmbeddedResources() : array<string|int, mixed>
- All the embedded resources directly available in the resource.
- getAllLinks() : array<string|int, mixed>
- All the links directly available in the resource.
- getEmbeddedResource() : resource
- Finds a unique embedded resource by its relation type.
- getEmbeddedResources() : array<string|int, mixed>
- Finds an array of embedded resources by their relation type.
- getLink() : Link
- Finds a unique link by its relation type.
- getLinks() : array<string|int, mixed>
- Finds an array of links by their relation type.
- getState() : array<string|int, mixed>
- All the properties of the resource ("_links" and "_embedded" not included).
Methods
fromJson()
Builds a Resource from its JSON representation.
public
static fromJson(string|array<string|int, mixed>|object $json) : resource
Parameters
- $json : string|array<string|int, mixed>|object
-
A JSON representing the resource
Return values
resource —getAllEmbeddedResources()
All the embedded resources directly available in the resource.
public
getAllEmbeddedResources() : array<string|int, mixed>
The key is the relation type (Rel) and the value can be either a Resource or a numeric array of Resources.
Note that there is no guarantees as to the order of the embedded resources.
Return values
array<string|int, mixed> —getAllLinks()
All the links directly available in the resource.
public
getAllLinks() : array<string|int, mixed>
The key is the relation type (Rel) and the value can be either a Link or a numeric array of Links.
Note that there is no guarantees as to the order of the links.
Return values
array<string|int, mixed> —getEmbeddedResource()
Finds a unique embedded resource by its relation type.
public
getEmbeddedResource(RegisteredRel|CustomRel $rel) : resource
Parameters
- $rel : RegisteredRel|CustomRel
-
The relation type
Tags
Return values
resource —the Resource referenced by the given rel
getEmbeddedResources()
Finds an array of embedded resources by their relation type.
public
getEmbeddedResources(RegisteredRel|CustomRel $rel) : array<string|int, mixed>
Note that there is no guarantees as to the order of the resources.
Parameters
- $rel : RegisteredRel|CustomRel
-
The relation type
Tags
Return values
array<string|int, mixed> —Array of embedded resources referenced by the given rel
getLink()
Finds a unique link by its relation type.
public
getLink(RegisteredRel|CustomRel $rel) : Link
Parameters
- $rel : RegisteredRel|CustomRel
-
The relation type
Tags
Return values
Link —the Link referenced by the given rel
getLinks()
Finds an array of links by their relation type.
public
getLinks(RegisteredRel|CustomRel $rel) : array<string|int, mixed>
Note that there is no guarantees as to the order of the links.
Parameters
- $rel : RegisteredRel|CustomRel
-
The relation type
Tags
Return values
array<string|int, mixed> —Array of links referenced by the given rel
getState()
All the properties of the resource ("_links" and "_embedded" not included).
public
getState() : array<string|int, mixed>