TopLevelDataInterface
interface TopLevelDataInterface (View source)
| internal | JSON:API maintains no PHP API since its API is the HTTP API. This class may change at any time and this will break any dependencies on it. |
Interface for objects that can appear as top-level object data.
Methods
getOmissions()
Returns the data that was omitted from the JSON:API document.
array
getMergedMeta(array $top_level_meta)
Merges the object's meta member with the top-level meta member.
Details
Data
getData()
Returns the data for the top-level data member of a JSON:API document.
OmittedData
getOmissions()
Returns the data that was omitted from the JSON:API document.
LinkCollection
getMergedLinks(LinkCollection $top_level_links)
Merges the object's links with the top-level links.
array
getMergedMeta(array $top_level_meta)
Merges the object's meta member with the top-level meta member.