Complete reference guide to the Delivery SDK

The first thing that needs to be done is initiating an instance of Contentful\Delivery\Client by giving it three parameters: an access token, a space ID, and an environment ID (which is optional and defaults to master).

$client = new \Contentful\Delivery\Client($accessToken, $spaceId, $environmentId);

The client constructor also takes other optional parameters. This is the complete configuration:

$client = new \Contentful\Delivery\Client(
    $accessToken,
    $spaceId,
    $environmentId = 'master',
    $options = null
);

Usage

• Assets
• Content types
• Entries
• Environments and locales
• Space

Assets

$asset = $client->getAsset($assetId, 'en-US');
echo $asset->getTitle('en-US');
echo $asset->getDescription('en-US');
/** @var Contentful\Core\File\FileInterface $file */
$file = $asset->getFile('en-US');

$assets = $client->getAssets();
foreach ($assets as $asset) {
    echo $asset->getTitle('en-US')
}

Content types

$contentType = $client->getContentType($contentTypeId);
echo $contentType->getName('en-US');

$contentTypes = $client->getContentTypes();
foreach ($contentTypes as $contentType) {
    echo $contentType->getName('en-US');
}

Entries

$entry = $client->getEntry($assetId, 'en-US');
// Entries have magic getters which correspond to field names
// This assumes you have a field named "title"
echo $entry->getTitle('en-US');

$entries = $client->getEntries();
foreach ($entries as $entry) {
    echo $entry->getTitle('en-US')
}

Environment and locales

Environments in this SDK are a virtual resource, which is used as a container for locales:

$environment = $client->getEnvironment();

foreach ($environment->getLocales() as $locale) {
    /** @var \Contentful\Delivery\Resource\Locale $locale */
    echo $locale->getCode();
}

Space

$space = $client->getSpace();
echo $space->getName();