VersionNegotiatorInterface
interface VersionNegotiatorInterface (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. |
Defines the common interface for all version negotiators.
Methods
Details
EntityInterface
getRevision(EntityInterface $entity, string $version_argument)
Gets the identified revision.
The JSON:API module exposes revisions in terms of RFC5829. As such, the public API always refers to "versions" and "working copies" instead of "revisions". There are multiple ways to request a specific revision. For example, one might like to load a particular revision by its ID. On the other hand, it may be useful if an HTTP consumer is able to always request the "latest version" regardless of its ID. It is possible to imagine other scenarios as well, like fetching a revision based on a date or time.
Each version negotiator provides one of these strategies and is able to map a version argument to an existing revision.