Index | Contentful CDA SDK for PHP

A

Application — Class in namespace Contentful\Delivery\Console: CLI Application with Helpers for the Contentful SDK.
Asset — Class in namespace Contentful\Delivery\Mapper: Asset class.
Asset — Class in namespace Contentful\Delivery\Resource
BaseResource::asLink() — Method in class BaseResource: {@inheritdoc}
ContentType::addUnknownField() — Method in class ContentType: Adds a runtime field, of type unknown.

B

Asset::buildFile() — Method in class Asset: Creates a File or a subclass thereof.
BaseMapper — Class in namespace Contentful\Delivery\Mapper: BaseMapper class.
$BaseMapper — Property in class BaseMapper
BaseMapper::buildSystemProperties() — Method in class BaseMapper
ResourceBuilder::build() — Method in class ResourceBuilder: {@inheritdoc}
BaseResource — Class in namespace Contentful\Delivery\Resource

C

CacheClearer — Class in namespace Contentful\Delivery\Cache: CacheClearer class.
CacheClearer::clear() — Method in class CacheClearer
CacheItemPoolFactoryInterface — Class in namespace Contentful\Delivery\Cache: CacheItemPoolFactoryInterface.
CacheWarmer — Class in namespace Contentful\Delivery\Cache: CacheWarmer class.
Client — Class in namespace Contentful\Delivery: A Client is used to communicate the Contentful Delivery API.
ClearCacheCommand — Class in namespace Contentful\Delivery\Console
ClearCacheCommand::configure() — Method in class ClearCacheCommand
WarmUpCacheCommand::configure() — Method in class WarmUpCacheCommand
$BaseMapper — Property in class BaseMapper
ContentType — Class in namespace Contentful\Delivery\Mapper: ContentType class.
ResourceBuilder::createMapper() — Method in class ResourceBuilder: {@inheritdoc}
$BaseResource — Property in class BaseResource
ContentType — Class in namespace Contentful\Delivery\Resource: Content Types are schemas that define the fields of Entries. Every Entry can only contain values in the fields defined by its Content Type, and the values of those fields must match the data type defined in the Content Type.
$Locale — Property in class Locale
Manager::continueSync() — Method in class Manager: Continues the synchronization either at the next page, or with the results since the initial synchronization.

D

DeletedAsset — Class in namespace Contentful\Delivery\Mapper: DeletedAsset class.
DeletedContentType — Class in namespace Contentful\Delivery\Mapper: DeletedContentType class.
DeletedEntry — Class in namespace Contentful\Delivery\Mapper: DeletedEntry class.
$Asset — Property in class Asset
$ContentType — Property in class ContentType: Description of the Content Type.
$ContentType — Property in class ContentType: ID of main field used for display.
$Field — Property in class Field: Describes whether the Field is disabled.
DeletedAsset — Class in namespace Contentful\Delivery\Resource: A DeletedAsset describes an asset that has been deleted.
DeletedContentType — Class in namespace Contentful\Delivery\Resource: A DeletedContentType describes a content type that has been deleted.
DeletedEntry — Class in namespace Contentful\Delivery\Resource: A DeletedEntry describes an entry that has been deleted.
DeletedResource — Class in namespace Contentful\Delivery\Resource: A DeletedResource encodes metadata about a deleted resource.
$Locale — Property in class Locale

E

Client::extractEnvironmentId() — Method in class Client: Checks a data structure and extracts the environment ID, if present.
ClearCacheCommand::execute() — Method in class ClearCacheCommand
WarmUpCacheCommand::execute() — Method in class WarmUpCacheCommand
Entry — Class in namespace Contentful\Delivery\Mapper: Entry class.
Environment — Class in namespace Contentful\Delivery\Mapper: Environment class.
Entry — Class in namespace Contentful\Delivery\Resource
Environment — Class in namespace Contentful\Delivery\Resource

F

Field — Class in namespace Contentful\Delivery\Mapper\ContentType: Field class.
$Asset — Property in class Asset
$ContentType — Property in class ContentType: The fields, keyed by ID.
Field — Class in namespace Contentful\Delivery\Resource\ContentType: A Field describes one field of a ContentType.
$Entry — Property in class Entry
$Locale — Property in class Locale

G

CacheItemPoolFactoryInterface::getCacheItemPool() — Method in class CacheItemPoolFactoryInterface: Returns a PSR-6 CacheItemPoolInterface object.
Client::getApi() — Method in class Client: {@inheritdoc}
Client::getResourceBuilder() — Method in class Client
Client::getSdkName() — Method in class Client: The name of the library to be used in the User-Agent header.
Client::getSdkVersion() — Method in class Client: The version of the library to be used in the User-Agent header.
Client::getApiContentType() — Method in class Client: Returns the Content-Type (MIME-Type) to be used when communication with the API.
Client::getInstanceRepository() — Method in class Client: Returns the instance repository currently in use.
Client::getAsset() — Method in class Client
Client::getAssets() — Method in class Client
Client::getContentType() — Method in class Client
Client::getContentTypes() — Method in class Client
Client::getEnvironment() — Method in class Client
Client::getEntry() — Method in class Client
Client::getEntries() — Method in class Client
Client::getSpace() — Method in class Client
Client::getSynchronizationManager() — Method in class Client: Get an instance of the synchronization manager. Note that with the Preview API only an inital sync is giving valid results.
Application::getDefaultCommands() — Method in class Application
InstanceRepository::get() — Method in class InstanceRepository
InstanceRepository::generateCacheKey() — Method in class InstanceRepository
Query::getQueryData() — Method in class Query: Returns the parameters to execute this query.
ResourceBuilder::getMapperNamespace() — Method in class ResourceBuilder: {@inheritdoc}
ResourceBuilder::getSystemType() — Method in class ResourceBuilder: {@inheritdoc}
Asset::getSpace() — Method in class Asset: Returns the space this asset belongs to.
Asset::getEnvironment() — Method in class Asset: Returns the environment this asset belongs to.
Asset::getTitle() — Method in class Asset
Asset::getDescription() — Method in class Asset
Asset::getFile() — Method in class Asset
BaseResource::getSystemProperties() — Method in class BaseResource: {@inheritdoc}
BaseResource::getId() — Method in class BaseResource: {@inheritdoc}
BaseResource::getType() — Method in class BaseResource: {@inheritdoc}
ContentType::getSpace() — Method in class ContentType: Returns the space this content type belongs to.
ContentType::getEnvironment() — Method in class ContentType: Returns the environment this content type belongs to.
ContentType::getName() — Method in class ContentType: Returns the name of this content type.
ContentType::getFields() — Method in class ContentType: Returns all the fields of this content type as an associative array. The key is the ID of the field.
ContentType::getDescription() — Method in class ContentType: Returns the content type's description.
ContentType::getField() — Method in class ContentType: Returns the field for the passed id.
ContentType::getDisplayField() — Method in class ContentType: Returns the the display field of a content type. Commonly this is the title.
Field::getId() — Method in class Field: Returns the ID of the content type.
Field::getName() — Method in class Field: Returns the name of the content type.
Field::getType() — Method in class Field: Returns the type of the field.
Field::getLinkType() — Method in class Field: If the field is a link, this will return the type of the linked resource.
Field::getItemsType() — Method in class Field: If the field is an array, this returns the type of its items.
Field::getItemsLinkType() — Method in class Field: If the field is an array, and it's items are links, this returns the type of the linked resources.
DeletedEntry::getContentType() — Method in class DeletedEntry: This method always returns null when used with the sync API.
Entry::getSpace() — Method in class Entry: Returns the space this entry belongs to.
Entry::getEnvironment() — Method in class Entry: Returns the environment this entry belongs to.
Entry::getContentType() — Method in class Entry
Entry::get() — Method in class Entry: Returns a the value of a field using the given locale.
Entry::getReferences() — Method in class Entry: Gets all entries that contain links to the current one.
Environment::getLocales() — Method in class Environment
Environment::getLocale() — Method in class Environment
Environment::getDefaultLocale() — Method in class Environment: Returns the default locale for this space.
Locale::getCode() — Method in class Locale: Returns the locale code.
Locale::getName() — Method in class Locale: Returns the human readable name.
Locale::getFallbackCode() — Method in class Locale: Returns the code of the locale used for for the fallback.
LocalizedResource::getLocale() — Method in class LocalizedResource: The locale code for the currently set locale.
LocalizedResource::getLocaleFromInput() — Method in class LocalizedResource
Space::getName() — Method in class Space: Returns the name of this space.
Query::getQueryData() — Method in class Query: Returns the parameters to execute this query.
Query::getQueryString() — Method in class Query: The urlencoded query string for this query.
Result::getItems() — Method in class Result: Returns the items retrieved by this synchronization operation.
Result::getToken() — Method in class Result: Returns the token needed to continue the synchronization.
SystemProperties::getId() — Method in class SystemProperties
SystemProperties::getType() — Method in class SystemProperties
SystemProperties::getSpace() — Method in class SystemProperties
SystemProperties::getContentType() — Method in class SystemProperties
SystemProperties::getEnvironment() — Method in class SystemProperties
SystemProperties::getRevision() — Method in class SystemProperties
SystemProperties::getLocale() — Method in class SystemProperties
SystemProperties::getCreatedAt() — Method in class SystemProperties
SystemProperties::getUpdatedAt() — Method in class SystemProperties
SystemProperties::getDeletedAt() — Method in class SystemProperties

H

InstanceRepository::has() — Method in class InstanceRepository
BaseMapper::hydrate() — Method in class BaseMapper
Entry::has() — Method in class Entry: Checks whether the current entry has a field with a certain ID.

I

Client::isPreview() — Method in class Client: Returns true when using the Preview API.
InstanceRepository — Class in namespace Contentful\Delivery: InstanceRepository class.
BaseMapper::injectClient() — Method in class BaseMapper: Override this method for blocking the mapper from injecting the client property.
Field::injectClient() — Method in class Field: Override this method for blocking the mapper from injecting the client property.
Locale::injectClient() — Method in class Locale: Override this method for blocking the mapper from injecting the client property.
$Field — Property in class Field: ID of the Field.
$Field — Property in class Field: (Array type only) Type for items.
$Field — Property in class Field: (Array of links only) Type of links.
Field::isRequired() — Method in class Field: Returns true if this field is required.
Field::isLocalized() — Method in class Field: Returns true if the field contains locale dependent content.
Field::isDisabled() — Method in class Field: True if the field is disabled.
Locale::isDefault() — Method in class Locale: Returns true if this is the default locale for the space.
LocalizedResource::initLocales() — Method in class LocalizedResource
Result::isDone() — Method in class Result: Returns true if there are currently no more results in the synchronization.

J

Asset::jsonSerialize() — Method in class Asset: {@inheritdoc}
ContentType::jsonSerialize() — Method in class ContentType: {@inheritdoc}
Field::jsonSerialize() — Method in class Field: {@inheritdoc}
DeletedResource::jsonSerialize() — Method in class DeletedResource: {@inheritdoc}
Entry::jsonSerialize() — Method in class Entry: {@inheritdoc}
Environment::jsonSerialize() — Method in class Environment: {@inheritdoc}
Locale::jsonSerialize() — Method in class Locale: {@inheritdoc}
Space::jsonSerialize() — Method in class Space: {@inheritdoc}
SystemProperties::jsonSerialize() — Method in class SystemProperties: {@inheritdoc}

L

Locale — Class in namespace Contentful\Delivery\Mapper: Locale class.
$Field — Property in class Field: Type of the linked resource.
$Field — Property in class Field: Describes whether the Field is localized.
$Environment — Property in class Environment
Locale — Class in namespace Contentful\Delivery\Resource: Value object encoding a locale.
LocalizedResource — Class in namespace Contentful\Delivery\Resource: A LocalizedResource can store information for multiple locales.
$LocalizedResource — Property in class LocalizedResource: List of codes for all the locales available in the space this resource belongs to.

M

Asset::map() — Method in class Asset: {@inheritdoc}
ContentType::map() — Method in class ContentType: {@inheritdoc}
ContentType::mapField() — Method in class ContentType
Field::map() — Method in class Field: {@inheritdoc}
DeletedAsset::map() — Method in class DeletedAsset: {@inheritdoc}
DeletedContentType::map() — Method in class DeletedContentType: {@inheritdoc}
DeletedEntry::map() — Method in class DeletedEntry: {@inheritdoc}
Entry::map() — Method in class Entry: {@inheritdoc}
Environment::map() — Method in class Environment: {@inheritdoc}
Locale::map() — Method in class Locale: {@inheritdoc}
ResourceArray::map() — Method in class ResourceArray: {@inheritdoc}
Space::map() — Method in class Space: {@inheritdoc}
Manager — Class in namespace Contentful\Delivery\Synchronization: The synchronization Manager can be used to sync a Space to this server.

N

BaseMapper::normalizeFieldData() — Method in class BaseMapper
$ContentType — Property in class ContentType: Name of the Content Type.
$Field — Property in class Field: Name of the Field.
$Locale — Property in class Locale
$Space — Property in class Space

O

Entry::offsetGet() — Method in class Entry: {@inheritdoc}
Entry::offsetExists() — Method in class Entry: {@inheritdoc}
Entry::offsetSet() — Method in class Entry: {@inheritdoc}
Entry::offsetUnset() — Method in class Entry: {@inheritdoc}

P

Client::parseJson() — Method in class Client: Parse a JSON string.

Q

Query — Class in namespace Contentful\Delivery: A Query is used to filter and order collections when making API requests.
Query — Class in namespace Contentful\Delivery\Synchronization: A sync Query can be used to limit what type of resources and events should be synced.

R

Client::resolveLink() — Method in class Client: Resolve a link to it's resource.
ResourceArray — Class in namespace Contentful\Delivery\Mapper: ResourceArray class.
ResourceBuilder — Class in namespace Contentful\Delivery: ResourceBuilder class.
$Field — Property in class Field: Describes whether the Field is mandatory.
Result — Class in namespace Contentful\Delivery\Synchronization: The Result of synchronization.

S

Client::syncRequest() — Method in class Client: Internal method for \Contentful\Delivery\Synchronization\Manager.
InstanceRepository::set() — Method in class InstanceRepository
Space — Class in namespace Contentful\Delivery\Mapper: Space class.
Query::setInclude() — Method in class Query: Set the amount of levels of links that should be resolved.
Query::setLocale() — Method in class Query: Sets the locale for which content should be retrieved. Set it to * to retrieve all locales.
$BaseResource — Property in class BaseResource
LocalizedResource::setLocale() — Method in class LocalizedResource: Set the locale for this instance.
Space — Class in namespace Contentful\Delivery\Resource: The Space class represents a single space identified by its ID and holding some metadata.
Manager::sync() — Method in class Manager
Manager::startSync() — Method in class Manager: Starts a new Synchronization.
Query::setType() — Method in class Query: Set the Type of event or resource to sync.
Query::setContentType() — Method in class Query: Set the content type to which results should be limited. Set to NULL to not filter for a content type.
SystemProperties — Class in namespace Contentful\Delivery: A SystemProperties instance contains the metadata of a resource.

T

$Asset — Property in class Asset
$Field — Property in class Field: Type of the Field.

W

CacheWarmer::warmUp() — Method in class CacheWarmer
WarmUpCacheCommand — Class in namespace Contentful\Delivery\Console
LocalizedResource::walkFallbackChain() — Method in class LocalizedResource

_

CacheClearer::__construct() — Method in class CacheClearer: CacheClearer constructor.
CacheItemPoolFactoryInterface::__construct() — Method in class CacheItemPoolFactoryInterface: Empty constructor.
CacheWarmer::__construct() — Method in class CacheWarmer: CacheWarmer constructor.
Client::__construct() — Method in class Client: Client constructor.
Application::__construct() — Method in class Application
InstanceRepository::__construct() — Method in class InstanceRepository
BaseMapper::__construct() — Method in class BaseMapper: BaseMapper constructor.
ResourceBuilder::__construct() — Method in class ResourceBuilder: ResourceBuilder constructor.
BaseResource::__construct() — Method in class BaseResource: Resources in this SDK should not be built using $new Class().
Field::__construct() — Method in class Field: Regular field construction should happen through the field mapper.
Entry::__call() — Method in class Entry
Entry::__get() — Method in class Entry: Shortcut for accessing fields using $entry->fieldName.
Manager::__construct() — Method in class Manager: Manager constructor.
Result::__construct() — Method in class Result: Result constructor.
SystemProperties::__construct() — Method in class SystemProperties: SystemProperties constructor.