Index | Contentful CDA SDK for PHP

A

Asset — Class in namespace Contentful\Delivery
Application — Class in namespace Contentful\Delivery\Console: CLI Application with Helpers for the Contentful SDK.
InstanceCache::addAsset() — Method in class InstanceCache
InstanceCache::addContentType() — Method in class InstanceCache
InstanceCache::addEntry() — Method in class InstanceCache
ArrayLogger — Class in namespace Contentful\Log: Saves requests information in array so they can be retrieved later.

B

BearerToken — Class in namespace Contentful: BearerToken is a Guzzle handler to add the necessary headers to authenticate against the Contentful APIs.
ResourceBuilder::buildObjectsFromRawData() — Method in class ResourceBuilder: Build objects based on PHP classes from the raw JSON based objects.

C

Client — Class in namespace Contentful: Abstract client for common code for the different clients.
Client — Class in namespace Contentful\Delivery: A Client is used to communicate the Contentful Delivery API.
GenerateClassesCommand::configure() — Method in class GenerateClassesCommand
ContentType — Class in namespace Contentful\Delivery: Content Types are schemas that define the fields of Entries. Every Entry can only contain values in the fields defined by it's Content Type, and the values of those fields must match the data type defined in the Content Type.
ContentTypeField — Class in namespace Contentful\Delivery: A ContentTypeField describes one field of a ContentType. This includes essential information for the display of the field's value.
$DynamicEntry — Property in class DynamicEntry
Manager::continueSync() — Method in class Manager: Continues the synchronization either at the next page or with the results since the initial synchronization.
ClassGenerator — Class in namespace Contentful\Delivery\Tool: The ClassGenerator generates PHP classes for entries.
$ClassGenerator — Property in class ClassGenerator
ResourceArray::count() — Method in class ResourceArray: Returns the number of resources in this array.

D

Client::decodeJson() — Method in class Client
DynamicEntry — Class in namespace Contentful\Delivery
DeletedAsset — Class in namespace Contentful\Delivery\Synchronization: A DeletedAsset describes an asset that has been deleted.
DeletedEntry — Class in namespace Contentful\Delivery\Synchronization: A DeletedEntry describes an entry that has been deleted.
DeletedResource — Class in namespace Contentful\Delivery\Synchronization: A DeletedResource encodes metadata about a deleted resource.

E

GenerateClassesCommand::execute() — Method in class GenerateClassesCommand
EntryInterface — Class in namespace Contentful\Delivery

F

File — Class in namespace Contentful\Delivery

G

Client::getUserAgentAppName() — Method in class Client
Client::getUserAgent() — Method in class Client
Asset::getTitle() — Method in class Asset: The title of the asset.
Asset::getDescription() — Method in class Asset
Asset::getFile() — Method in class Asset
Asset::getId() — Method in class Asset: Returns the ID of this Asset.
Asset::getRevision() — Method in class Asset: Returns the Revision of this Asset.
Asset::getUpdatedAt() — Method in class Asset: Returns the time when this Asset was last changed.
Asset::getCreatedAt() — Method in class Asset: Returns the time when this Asset was created.
Asset::getSpace() — Method in class Asset: Returns the Space this Asset belongs to.
Client::getUserAgentAppName() — Method in class Client
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::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.
Application::getDefaultCommands() — Method in class Application
GenerateClassesCommand — Class in namespace Contentful\Delivery\Console\Command: The GenerateClassesCommand can be used to generate a set of classes for every content type. This yields improved performance.
GenerateClassesCommand::getClassGenerator() — Method in class GenerateClassesCommand: Returns the ClassGenerator used by this command. Override this method if you need to customize the generated classes.
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.
ContentType::getId() — Method in class ContentType: Returns the ID of this content type.
ContentType::getRevision() — Method in class ContentType: Returns the revision of this content type.
ContentType::getUpdatedAt() — Method in class ContentType: Returns the time when this content type was last updated.
ContentType::getCreatedAt() — Method in class ContentType: Returns the time when this content type was created.
ContentType::getSpace() — Method in class ContentType: Returns the space this content type belongs to.
ContentTypeField::getId() — Method in class ContentTypeField: Returns the ID of the content type.
ContentTypeField::getName() — Method in class ContentTypeField: Returns the name of the content type.
ContentTypeField::getType() — Method in class ContentTypeField: Returns the type of the field.
ContentTypeField::getLinkType() — Method in class ContentTypeField: If the field is a link, this will return the type of the linked resource.
ContentTypeField::getItemsType() — Method in class ContentTypeField: If the field is an array, this returns the type of its items.
ContentTypeField::getItemsLinkType() — Method in class ContentTypeField: If the field is an array, and it's items are links, this returns the type of the linked resources.
DynamicEntry::getId() — Method in class DynamicEntry
DynamicEntry::getRevision() — Method in class DynamicEntry
DynamicEntry::getUpdatedAt() — Method in class DynamicEntry
DynamicEntry::getCreatedAt() — Method in class DynamicEntry
DynamicEntry::getSpace() — Method in class DynamicEntry
DynamicEntry::getContentType() — Method in class DynamicEntry
File::getFileName() — Method in class File: The name of this file
File::getContentType() — Method in class File: The Content- (or MIME-)Type of this file.
File::getUrl() — Method in class File: The Url where this file can be retrieved.
File::getSize() — Method in class File: The size in bytes of this file.
ImageFile::getWidth() — Method in class ImageFile: Returns the width of the image.
ImageFile::getHeight() — Method in class ImageFile: Returns the height of the image.
ImageFile::getUrl() — Method in class ImageFile
ImageOptions::getQueryString() — Method in class ImageOptions: The urlencoded query string for these options.
ImageOptions::getWidth() — Method in class ImageOptions: Get the width of the image. Will be null if no width is set.
ImageOptions::getHeight() — Method in class ImageOptions: Get the height of the image. Will be null if no height is set.
ImageOptions::getFormat() — Method in class ImageOptions: Format of the image. Possible values are "png" and "jpg". Will be null if no format is set.
ImageOptions::getQuality() — Method in class ImageOptions: Quality of the JPEG encoded image. Will be null if no quality is set.
InstanceCache::getSpace() — Method in class InstanceCache: Get the space to which this instance Cache belongs.
InstanceCache::getAsset() — Method in class InstanceCache: Get the asset with the specified ID out of the cache
InstanceCache::getContentType() — Method in class InstanceCache
InstanceCache::getEntry() — Method in class InstanceCache
Link::getId() — Method in class Link: Get the ID of the referenced resource
Link::getLinkType() — Method in class Link: Get the type of the Link.
Locale::getCode() — Method in class Locale: Returns the locale code
Locale::getName() — Method in class Locale: Returns the human readable name
LocalizedResource::getLocale() — Method in class LocalizedResource: The locale code for the currently set locale.
LocalizedResource::getLocaleFromInput() — Method in class LocalizedResource
Query::getQueryData() — Method in class Query: Returns the parameters to execute this query.
Query::getInclude() — Method in class Query: Get the amount of levels of links that should be resolved.
Space::getName() — Method in class Space: Returns the name of this space.
Space::getLocales() — Method in class Space: Returns the list of all locales supported by this Space.
Space::getDefaultLocale() — Method in class Space: Returns the default locale for this space.
Space::getId() — Method in class Space: Returns the id of this space.
DeletedResource::getId() — Method in class DeletedResource: Returns the ID of the resource.
DeletedResource::getSpace() — Method in class DeletedResource: Returns the space the resource used to belong to.
DeletedResource::getRevision() — Method in class DeletedResource: Returns the last revision of the resource before it was deleted.
DeletedResource::getUpdatedAt() — Method in class DeletedResource: Returns the time when the resource was updated.
DeletedResource::getCreatedAt() — Method in class DeletedResource: Returns the time when the resource was created.
DeletedResource::getDeletedAt() — Method in class DeletedResource: Returns the time when the resource was deleted.
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.
Query::getType() — Method in class Query: Set the Type of event or resource to sync.
Query::getContentType() — Method in class Query: Returns the name of the content type for which results will be retrieved. Can be NULL if no content type is set
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::getRevision() — Method in class SystemProperties
SystemProperties::getCreatedAt() — Method in class SystemProperties
SystemProperties::getUpdatedAt() — Method in class SystemProperties
SystemProperties::getDeletedAt() — Method in class SystemProperties
ClassGenerator::generateEntryClass() — Method in class ClassGenerator: Generate a class for entries of the provided ContentType.
ClassGenerator::generateUseStatement() — Method in class ClassGenerator: Generate the use statements.
ClassGenerator::generateClassName() — Method in class ClassGenerator: Generate the class declaration
ClassGenerator::generateClassBody() — Method in class ClassGenerator: Generate the class body.
ClassGenerator::getPropertyName() — Method in class ClassGenerator: Get the name of the property of the given field.
ClassGenerator::getPropertyDocBlockType() — Method in class ClassGenerator: Get the docblock for the property of the given field.
ClassGenerator::getMethodDocBlockType() — Method in class ClassGenerator: Get the docblock for the getter method for the given field.
ClassGenerator::generateProperty() — Method in class ClassGenerator: Generate the property of the given field.
ClassGenerator::generateConstructor() — Method in class ClassGenerator: Generate the Constructor.
ClassGenerator::generateJsonSerialize() — Method in class ClassGenerator: Generate the jsonSerialize function.
ClassGenerator::generateMethod() — Method in class ClassGenerator: Generate the getter method for the field.
ClassGenerator::generateSimpleMethodBody() — Method in class ClassGenerator: Generate the getter method body in simple cases.
ClassGenerator::generateLinkMethodBody() — Method in class ClassGenerator: Generate the getter method body for links.
ClassGenerator::generateArrayMethodBody() — Method in class ClassGenerator: Generate the getter method body for arrays.
ClassGenerator::generateIdMethod() — Method in class ClassGenerator: Fields that reference links (or arrays of links) also get a method to get just the ID.
ClassGenerator::getClassName() — Method in class ClassGenerator: Get the class name for and entry of the provided ContentType.
Location::getLatitude() — Method in class Location: Returns the latitude.
Location::getLongitude() — Method in class Location: Returns the longitude
ArrayLogger::getTimer() — Method in class ArrayLogger: Returns a timer to be used to gather timing information for the next request.
ArrayLogger::getLogs() — Method in class ArrayLogger: Returns the collected logs.
LogEntry::getApi() — Method in class LogEntry
LogEntry::getRequest() — Method in class LogEntry
LogEntry::getException() — Method in class LogEntry
LogEntry::getDuration() — Method in class LogEntry
LoggerInterface::getTimer() — Method in class LoggerInterface: Returns a timer to be used to gather timing information for the next request.
NullLogger::getTimer() — Method in class NullLogger
NullTimer::getDuration() — Method in class NullTimer: Returns the time (in seconds) the timer ran.
StandardTimer::getDuration() — Method in class StandardTimer: Returns the time (in seconds) the timer ran.
TimerInterface::getDuration() — Method in class TimerInterface: Returns the time (in seconds) the timer ran.
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.
Query::getSkip() — Method in class Query: Returns the index of the first result to retrieve. Can return NULL if no index is specified.
Query::getLimit() — Method in class Query: Returns the maximum number of results to retrieve. Can return NULL if no maximum is defined.
Query::getContentType() — Method in class Query: Returns the name of the content type for which results will be retrieved. Can be NULL if no content type is set
Query::getMimeTypeGroup() — Method in class Query
ResourceArray::getTotal() — Method in class ResourceArray: Returns the total amount of resources matching the filter.
ResourceArray::getLimit() — Method in class ResourceArray: The limit used when retrieving this ResourceArray.
ResourceArray::getSkip() — Method in class ResourceArray: The number of skipped resources when retrieving this ResourceArray.
ResourceArray::getIterator() — Method in class ResourceArray: Returns a \Traversable to allow iterating the ResourceArray.

H

InstanceCache::hasSpace() — Method in class InstanceCache: Whether the space has been cached or not
InstanceCache::hasAsset() — Method in class InstanceCache
InstanceCache::hasContentType() — Method in class InstanceCache
InstanceCache::hasEntry() — Method in class InstanceCache

I

Client::isPreview() — Method in class Client: Returns true when using the Preview API
ContentTypeField::isRequired() — Method in class ContentTypeField: Returns true if this field is required
ContentTypeField::isLocalized() — Method in class ContentTypeField: Returns true if the field contains locale dependent content.
ContentTypeField::isDisabled() — Method in class ContentTypeField: True if the field is disabled.
ImageFile — Class in namespace Contentful\Delivery
ImageOptions — Class in namespace Contentful\Delivery: ImageOptions allows specifying extended options to the Contentful Image API .
ImageOptions::isProgressive() — Method in class ImageOptions: Returns true if the image will be loaded as progressive JPEG.
InstanceCache — Class in namespace Contentful\Delivery
Locale::isDefault() — Method in class Locale: Returns true if this is the default locale for the space.
Result::isDone() — Method in class Result: Returns true if there are currently no more results in the synchronization.
ClassGenerator::isSimpleType() — Method in class ClassGenerator: Returns true if the type does not need any further processing.
NullTimer::isRunning() — Method in class NullTimer: Returns true if the timer is currently running.
StandardTimer::isRunning() — Method in class StandardTimer: Returns true if the timer is currently running.
TimerInterface::isRunning() — Method in class TimerInterface: Returns true if the timer is currently running.

J

Asset::jsonSerialize() — Method in class Asset: Returns an object to be used by json_encode to serialize objects of this class.
ContentType::jsonSerialize() — Method in class ContentType: Returns an object to be used by json_encode to serialize objects of this class.
ContentTypeField::jsonSerialize() — Method in class ContentTypeField: Returns an object to be used by json_encode to serialize objects of this class.
DynamicEntry::jsonSerialize() — Method in class DynamicEntry
File::jsonSerialize() — Method in class File: Returns an object to be used by json_encode to serialize objects of this class.
ImageFile::jsonSerialize() — Method in class ImageFile: Returns an object to be used by json_encode to serialize objects of this class.
Locale::jsonSerialize() — Method in class Locale: Returns an object to be used by json_encode to serialize objects of this class.
Space::jsonSerialize() — Method in class Space: Returns an object to be used by json_encode to serialize objects of this class.
DeletedResource::jsonSerialize() — Method in class DeletedResource: Returns an object to be used by json_encode to serialize objects of this class.
SystemProperties::jsonSerialize() — Method in class SystemProperties: Returns an object to be used by json_encode to serialize objects of this class.
Location::jsonSerialize() — Method in class Location: Returns an object to be used by json_encode to serialize objects of this class.
ResourceArray::jsonSerialize() — Method in class ResourceArray: Returns an object to be used by json_encode to serialize objects of this class.

L

Link — Class in namespace Contentful\Delivery: A link encodes a reference to a resource.
Locale — Class in namespace Contentful\Delivery: Value object encoding a locale.
LocalizedResource — Class in namespace Contentful\Delivery: A LocalizedResource can store information for multiple locales. The methods in this base class allow switching between the locales.
$LocalizedResource — Property in class LocalizedResource: The code of the currently active locale
Location — Class in namespace Contentful: The Location class encodes a geographic Location based on latitude and longitude.
ArrayLogger::log() — Method in class ArrayLogger: Log information about a request.
LogEntry — Class in namespace Contentful\Log
LoggerInterface — Class in namespace Contentful\Log
LoggerInterface::log() — Method in class LoggerInterface: Log information about a request.
NullLogger::log() — Method in class NullLogger: Log information about a request.

M

Manager — Class in namespace Contentful\Delivery\Synchronization: The synchronization Manager can be used to sync a Space to this server.

N

NullLogger — Class in namespace Contentful\Log: Implementation of LoggerInterface that logs nothing.
NullTimer — Class in namespace Contentful\Log: Implementation of TimerInterface that does not actually record any time.

O

Query::orderBy() — Method in class Query: Set the order of the items retrieved by this query.
ResourceArray::offsetExists() — Method in class ResourceArray
ResourceArray::offsetGet() — Method in class ResourceArray
ResourceArray::offsetSet() — Method in class ResourceArray: This method is not implemented since a ResourceArray is read-only.
ResourceArray::offsetUnset() — Method in class ResourceArray: This method is not implemented since a ResourceArray is read-only.

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
Location::queryStringFormatted() — Method in class Location: Format the encoded value as required by the Contentful API.
Query — Class in namespace Contentful: A Query is used to filter and order collections when making API requests.

R

Client::request() — Method in class Client
Client::resolveLink() — Method in class Client: Resolve a link to it's resource.
Client::reviveJson() — Method in class Client: Revive JSON previously cached.
ResourceBuilder — Class in namespace Contentful\Delivery: The ResourceBuilder is responsible for turning the responses from the API into instances of PHP classes.
Result — Class in namespace Contentful\Delivery\Synchronization: The Result of synchronization.
ResourceArray — Class in namespace Contentful: A ResourceArray holds the response of an API request if more than one resource has been requested.
ResourceNotFoundException — Class in namespace Contentful: A ResourceNotFoundException indicates that the desired resource could not be found on the server.

S

Client::syncRequest() — Method in class Client: Internal method for \Contentful\Delivery\Synchronization\Manager
$DynamicEntry — Property in class DynamicEntry
ImageOptions::setWidth() — Method in class ImageOptions: Set the width of the image.
ImageOptions::setHeight() — Method in class ImageOptions: Set the height of the image.
ImageOptions::setFormat() — Method in class ImageOptions: Set the format of the image. Valid values are "png" and "jpg". Can be set to null to not enforce a format.
ImageOptions::setQuality() — Method in class ImageOptions: Quality of the JPEG encoded image.
ImageOptions::setProgressive() — Method in class ImageOptions: Set to true to load the image as a progressive JPEG.
InstanceCache::setSpace() — Method in class InstanceCache: Set the space to which this instance Cache belongs.
LocalizedResource::setLocale() — Method in class LocalizedResource: Set the locale for this instance. All future calls to a getter will return the information for this locale.
Query::setInclude() — Method in class Query: Set the amount of levels of links that should be resolved.
Space — Class in namespace Contentful\Delivery: The Space class represents a single space identified by it's ID and holding some metadata.
SpaceMismatchException — Class in namespace Contentful\Delivery: A SpaceMismatchException is thrown when attempting to create a Resource for a different Space than the one configured for the client.
Manager::startSync() — Method in class Manager: Starts a new Synchronization. Will contain all the Resources currently present in the space.
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.
$ClassGenerator — Property in class ClassGenerator
NullTimer::start() — Method in class NullTimer: Starts the timer.
NullTimer::stop() — Method in class NullTimer: Stops the timer.
StandardTimer — Class in namespace Contentful\Log
StandardTimer::start() — Method in class StandardTimer: Starts the timer.
StandardTimer::stop() — Method in class StandardTimer: Stops the timer.
TimerInterface::start() — Method in class TimerInterface: Starts the timer.
TimerInterface::stop() — Method in class TimerInterface: Stops the timer.
Query::setSkip() — Method in class Query: Sets the index of the first result to retrieve. To reset set to NULL.
Query::setLimit() — Method in class Query: Set the maximum number of results to retrieve. To reset set to NULL;
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.
Query::setMimeTypeGroup() — Method in class Query

T

TimerInterface — Class in namespace Contentful\Log: The TimerInterface is used to record the duration of requests against Contentful's API.

W

Query::where() — Method in class Query: Add a filter condition to this query.

_

BearerToken::__construct() — Method in class BearerToken: BearerToken constructor.
BearerToken::__invoke() — Method in class BearerToken: Makes this class callable. Runs the necessary set up to add the Authorization header.
Client::__construct() — Method in class Client: Client constructor.
Asset::__construct() — Method in class Asset: LocalizedResource constructor.
Client::__construct() — Method in class Client: Client constructor.
Application::__construct() — Method in class Application
ContentType::__construct() — Method in class ContentType: ContentType constructor.
ContentTypeField::__construct() — Method in class ContentTypeField: ContentTypeField constructor.
DynamicEntry::__construct() — Method in class DynamicEntry: Entry constructor.
DynamicEntry::__call() — Method in class DynamicEntry
File::__construct() — Method in class File: File constructor.
ImageFile::__construct() — Method in class ImageFile: ImageFile constructor.
ImageOptions::__construct() — Method in class ImageOptions: ImageOptions constructor.
InstanceCache::__construct() — Method in class InstanceCache: InstanceCache constructor.
Link::__construct() — Method in class Link: Link constructor.
Locale::__construct() — Method in class Locale: Locale constructor.
LocalizedResource::__construct() — Method in class LocalizedResource: LocalizedResource constructor.
ResourceBuilder::__construct() — Method in class ResourceBuilder: ResourceBuilder constructor.
Space::__construct() — Method in class Space: Space constructor.
DeletedResource::__construct() — Method in class DeletedResource: DeletedResource constructor.
Manager::__construct() — Method in class Manager: Manager constructor.
Query::__construct() — Method in class Query: Query constructor.
Result::__construct() — Method in class Result: Result constructor.
SystemProperties::__construct() — Method in class SystemProperties: SystemProperties constructor.
ClassGenerator::__construct() — Method in class ClassGenerator: ClassGenerator constructor.
Location::__construct() — Method in class Location
ArrayLogger::__construct() — Method in class ArrayLogger: Empty constructor for forward compatibility.
LogEntry::__construct() — Method in class LogEntry: LogEntry constructor.
NullLogger::__construct() — Method in class NullLogger: Empty constructor for forward compatibility.
NullTimer::__construct() — Method in class NullTimer: Empty constructor for forward compatibility.
StandardTimer::__construct() — Method in class StandardTimer: Empty constructor for forward compatibility.
Query::__construct() — Method in class Query: Query constructor.
ResourceArray::__construct() — Method in class ResourceArray: ResourceArray constructor.