Client
class Client extends BaseClient implements ClientInterface, SynchronizationClientInterface, JsonDecoderClientInterface
A Client is used to communicate the Contentful Delivery API.
A Client is only responsible for one space and one environment. When access to multiple spaces or environments is required, create multiple Clients.
This class can be configured to use the Preview API instead of the Delivery API. This grants access to not yet published content.
Constants
| MAX_DEPTH |
|
| API_DELIVERY |
|
| API_PREVIEW |
|
| URI_DELIVERY |
The URI for the Delivery API. |
| URI_PREVIEW |
The URI for the Preview API. |
Properties
| protected int | $currentDepth |
Methods
Client constructor.
Returns a string representation of the API currently in use.
Returns the ID of the space currently in use.
Returns the ID of the environment currently in use.
No description
No description
{@inheritdoc}
{@inheritdoc}
{@inheritdoc}
Returns the resource pool currently in use.
Returns a single Asset object corresponding to the given ID.
Returns a single ContentType object corresponding to the given ID.
Returns a collection of ContentType objects wrapped in a ResourceArray instance.
Returns the Environment object corresponding to the one in use.
Returns a single Entry object corresponding to the given ID.
Returns a collection of Entry objects wrapped in a ResourceArray instance.
Returns the Space object corresponding to the one in use.
Resolve a link to its actual resource.
Resolves an array of links.
Parse a JSON string.
Returns true when using the Delivery API.
Returns true when using the Preview API.
Get an instance of the synchronization manager.
Internal method for the sync manager.
{@inheritdoc}
Details
at line 128
__construct(string $token, string $spaceId, string $environmentId = 'master', ClientOptions $options = null)
Client constructor.
at line 157
getApi()
Returns a string representation of the API currently in use.
at line 162
getSpaceId()
Returns the ID of the space currently in use.
at line 167
getEnvironmentId()
Returns the ID of the environment currently in use.
at line 172
getResourceBuilder()
at line 177
getRichTextParser()
at line 185
static protected
getSdkName()
{@inheritdoc}
at line 193
static protected
getPackageName()
{@inheritdoc}
at line 201
static protected
getApiContentType()
{@inheritdoc}
at line 209
getResourcePool()
Returns the resource pool currently in use.
at line 229
getAsset(string $assetId, string $locale = null)
Returns a single Asset object corresponding to the given ID.
at line 248
ResourceArray|Asset[]
getAssets(Query $query = null)
Returns a collection of Asset objects wrapped in a ResourceArray instance.
at line 268
getContentType(string $contentTypeId)
Returns a single ContentType object corresponding to the given ID.
at line 284
ResourceArray|ContentType[]
getContentTypes(Query $query = null)
Returns a collection of ContentType objects wrapped in a ResourceArray instance.
at line 299
getEnvironment()
Returns the Environment object corresponding to the one in use.
at line 334
getEntry(string $entryId, string $locale = null)
Returns a single Entry object corresponding to the given ID.
at line 363
ResourceArray|Entry[]
getEntries(Query $query = null)
Returns a collection of Entry objects wrapped in a ResourceArray instance.
at line 383
getSpace()
Returns the Space object corresponding to the one in use.
at line 412
resolveLink(Link $link, string $locale = null)
Resolve a link to its actual resource.
at line 422
ResourceInterface[]
resolveLinkCollection(array $links, string $locale = null)
Resolves an array of links.
A method implementing this may apply some optimizations to reduce the amount of necessary API calls.
at line 436
ResourceInterface|ResourceArray
parseJson(string $json)
Parse a JSON string.
at line 446
isDeliveryApi()
Returns true when using the Delivery API.
at line 454
isPreviewApi()
Returns true when using the Preview API.
at line 462
getSynchronizationManager()
Get an instance of the synchronization manager.
Note that with the Preview API only an initial sync gives valid results.
at line 470
syncRequest(array $queryData)
Internal method for the sync manager.
at line 480
request(string $method, string $uri, array $options = [])
{@inheritdoc}