Index | Contentful Core for PHP

A

Message::asString() — Method in class Message: Returns a string representation of the current message.
AccessTokenInvalidException — Class in namespace Contentful\Core\Exception: An AccessTokenInvalidException gets thrown when the access token was not accepted by the API.
NullLogger::alert() — Method in class NullLogger: {@inheritdoc}
ResourceInterface::asLink() — Method in class ResourceInterface: Creates a Link representation of the current resource.

B

BaseClient — Class in namespace Contentful\Core\Api: Abstract client for common code for the different clients.
BaseQuery — Class in namespace Contentful\Core\Api: BaseQuery class.
RequestBuilder::build() — Method in class RequestBuilder
BadRequestException — Class in namespace Contentful\Core\Exception: A BadRequestException indicates that there was a problem with the request.
BaseResourceBuilder — Class in namespace Contentful\Core\ResourceBuilder: BaseResourceBuilder class.
BaseResourceBuilder::build() — Method in class BaseResourceBuilder: Creates or updates an object using given data.

C

Message::createFromString() — Method in class Message: Creates a new instance of the class from a JSON string.
NullLogger::critical() — Method in class NullLogger: {@inheritdoc}
BaseResourceBuilder::createMapper() — Method in class BaseResourceBuilder: Abstract function for instantianting a mapper.
ResourceArray::count() — Method in class ResourceArray: Returns the number of resources in this array.

D

DateTimeImmutable — Class in namespace Contentful\Core\Api: DateTimeImmutable class.
NullLogger::debug() — Method in class NullLogger: {@inheritdoc}

E

Exception — Class in namespace Contentful\Core\Api: An Exception is thrown when an errors occurs while communicating with the API.
NullLogger::emergency() — Method in class NullLogger: {@inheritdoc}
NullLogger::error() — Method in class NullLogger: {@inheritdoc}

F

DateTimeImmutable::formatForJson() — Method in class DateTimeImmutable: Formats the string for an easier interoperability with Contentful.
File — Class in namespace Contentful\Core\File: File class.
FileInterface — Class in namespace Contentful\Core\File: FileInterface.

G

BaseClient::getExceptionNamespace() — Method in class BaseClient: Override this method for registering a custom namespace where the Client will look for an exception. If no exception is found in the custom namespace, the default namespace will be used.
BaseClient::getLogger() — Method in class BaseClient
BaseClient::getMessages() — Method in class BaseClient
BaseClient::getApi() — Method in class BaseClient: Returns a string representation of the API currently in use.
BaseClient::getSdkName() — Method in class BaseClient: The name of the library to be used in the User-Agent header.
BaseClient::getSdkVersion() — Method in class BaseClient: The version of the library to be used in the User-Agent header.
BaseClient::getApiContentType() — Method in class BaseClient: Returns the Content-Type (MIME-Type) to be used when communication with the API.
BaseQuery::getQueryData() — Method in class BaseQuery: Returns the parameters to execute this query.
BaseQuery::getQueryString() — Method in class BaseQuery: The urlencoded query string for this query.
Exception::getRequest() — Method in class Exception: Get the request that caused the exception.
Exception::getResponse() — Method in class Exception: Get the associated response.
Exception::getRequestId() — Method in class Exception
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.
Location::getLatitude() — Method in class Location: Returns the latitude.
Location::getLongitude() — Method in class Location: Returns the longitude.
Message::getLogLevel() — Method in class Message
Message::getApi() — Method in class Message
Message::getRequest() — Method in class Message
Message::getException() — Method in class Message
Message::getDuration() — Method in class Message
Message::getResponse() — Method in class Message
UserAgentGenerator::getUserAgent() — Method in class UserAgentGenerator: Returns the value of the User-Agent header for any requests made to Contentful.
RateLimitExceededException::getRateLimitReset() — Method in class RateLimitExceededException: Returns the number of seconds until the rate limit expires.
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.
FileInterface::getFileName() — Method in class FileInterface: The name of this file.
FileInterface::getContentType() — Method in class FileInterface: The Content- (or MIME-)Type 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.
LocalUploadFile::getFileName() — Method in class LocalUploadFile: The name of this file.
LocalUploadFile::getContentType() — Method in class LocalUploadFile: The Content- (or MIME-)Type of this file.
LocalUploadFile::getUploadFrom() — Method in class LocalUploadFile
RemoteUploadFile::getFileName() — Method in class RemoteUploadFile: The name of this file.
RemoteUploadFile::getContentType() — Method in class RemoteUploadFile: The Content- (or MIME-)Type of this file.
RemoteUploadFile::getUpload() — Method in class RemoteUploadFile
Timer::getDuration() — Method in class Timer: Returns the time (in seconds) the timer ran.
BaseResourceBuilder::getMapper() — Method in class BaseResourceBuilder: Returns the mapper object appropriate for the given data.
BaseResourceBuilder::getMapperNamespace() — Method in class BaseResourceBuilder: Returns the namespace where mapper classes are located.
BaseResourceBuilder::getSystemType() — Method in class BaseResourceBuilder: Determines the SDK resource type given the API system type.
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::getItems() — Method in class ResourceArray: Get the returned values as a PHP array.
ResourceArray::getIterator() — Method in class ResourceArray: Returns a \Traversable to allow iterating the ResourceArray.
ResourceInterface::getSystemProperties() — Method in class ResourceInterface: Returns the resource's system properties, defined in the object "sys" in Contentful's responses.
ResourceInterface::getId() — Method in class ResourceInterface: Shortcut for retrieving the resource ID from the system properties object.
ResourceInterface::getType() — Method in class ResourceInterface: Shortcut for retrieving the resource type from the system properties object.
SystemPropertiesInterface::getId() — Method in class SystemPropertiesInterface
SystemPropertiesInterface::getType() — Method in class SystemPropertiesInterface

H

Exception::hasResponse() — Method in class Exception: Check if a response was received.

I

Message::isError() — Method in class Message: True if the requests threw an error.
InvalidQueryException — Class in namespace Contentful\Core\Exception: An InvalidQueryException is thrown when the query could not be executed. The most common case is setting a non-existing content type or field name.
ImageFile — Class in namespace Contentful\Core\File: ImageFile class.
ImageOptions — Class in namespace Contentful\Core\File: ImageOptions class.
NullLogger::info() — Method in class NullLogger: {@inheritdoc}
Timer::isRunning() — Method in class Timer: Returns true if the timer is currently running.

J

Link::jsonSerialize() — Method in class Link: {@inheritdoc}
Location::jsonSerialize() — Method in class Location: {@inheritdoc}
Message::jsonSerialize() — Method in class Message: {@inheritdoc}
File::jsonSerialize() — Method in class File: {@inheritdoc}
ImageFile::jsonSerialize() — Method in class ImageFile: {@inheritdoc}
LocalUploadFile::jsonSerialize() — Method in class LocalUploadFile: {@inheritdoc}
RemoteUploadFile::jsonSerialize() — Method in class RemoteUploadFile: {@inheritdoc}
ResourceArray::jsonSerialize() — Method in class ResourceArray: {@inheritdoc}

L

BaseQuery::linksToEntry() — Method in class BaseQuery: Filters for all entries that link to an entry.
BaseQuery::linksToAsset() — Method in class BaseQuery: Filters for all entries that link to an asset.
Link — Class in namespace Contentful\Core\Api: Link class.
Location — Class in namespace Contentful\Core\Api: The Location class encodes a geographic Location based on latitude and longitude.
LocalUploadFile — Class in namespace Contentful\Core\File: LocalUploadFile class.
NullLogger::log() — Method in class NullLogger: {@inheritdoc}

M

Message — Class in namespace Contentful\Core\Api: Message class.
MapperInterface — Class in namespace Contentful\Core\ResourceBuilder: MapperInterface.
MapperInterface::map() — Method in class MapperInterface: Maps the given data to a resource.

N

NotFoundException — Class in namespace Contentful\Core\Exception: A NotFoundException indicates that the desired resource could not be found on the server.
NullLogger — Class in namespace Contentful\Core\Log
NullLogger::notice() — Method in class NullLogger: {@inheritdoc}

O

BaseQuery::orderBy() — Method in class BaseQuery: 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

Location::queryStringFormatted() — Method in class Location: Format the encoded value as required by the Contentful API.

R

BaseClient::request() — Method in class BaseClient
RequestBuilder — Class in namespace Contentful\Core\Api: RequestBuilder class.
RateLimitExceededException — Class in namespace Contentful\Core\Exception: A RateLimitExceededException is thrown when there have been too many requests.
RemoteUploadFile — Class in namespace Contentful\Core\File: RemoteUploadFile class.
ResourceArray — Class in namespace Contentful\Core\Resource: A ResourceArray holds the response of an API request if more than one resource has been requested.
ResourceInterface — Class in namespace Contentful\Core\Resource: ResourceInterface.

S

BaseClient::setApplication() — Method in class BaseClient: Set the application name and version. The values are used as part of the X-Contentful-User-Agent header.
BaseClient::setIntegration() — Method in class BaseClient: Set the integration name and version. The values are used as part of the X-Contentful-User-Agent header.
BaseQuery::setSkip() — Method in class BaseQuery: Sets the index of the first result to retrieve. To reset set to NULL.
BaseQuery::setLimit() — Method in class BaseQuery: Set the maximum number of results to retrieve. To reset set to NULL;.
BaseQuery::setContentType() — Method in class BaseQuery: Set the content type to which results should be limited. Set to NULL to not filter for a content type.
BaseQuery::setMimeTypeGroup() — Method in class BaseQuery
BaseQuery::select() — Method in class BaseQuery: The select operator allows you to choose what to return from an entity.
Exception::serialize() — Method in class Exception
Message::serialize() — Method in class Message: {@inheritdoc}
UserAgentGenerator::setApplication() — Method in class UserAgentGenerator: Set the application name and version. The values are used as part of the X-Contentful-User-Agent header.
UserAgentGenerator::setIntegration() — Method in class UserAgentGenerator: Set the application name and version. The values are used as part of the X-Contentful-User-Agent header.
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".
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.
ImageOptions::setResizeFit() — Method in class ImageOptions: Change the behavior when resizing the image.
ImageOptions::setResizeFocus() — Method in class ImageOptions: Set the focus area when the resize fit is set to 'thumb'.
ImageOptions::setRadius() — Method in class ImageOptions: Add rounded corners to your image or crop to a circle/ellipsis.
ImageOptions::setBackgroundColor() — Method in class ImageOptions: Background color, relevant if the resize fit type 'pad' is used.
Timer::start() — Method in class Timer: Starts the timer.
Timer::stop() — Method in class Timer: Stops the timer.
BaseResourceBuilder::setDataMapperMatcher() — Method in class BaseResourceBuilder: Sets a callable which will receive raw data (the JSON payload converted to a PHP array) and will determine the FQCN for appropriate mapping of that resource.
SystemPropertiesInterface — Class in namespace Contentful\Core\Resource: SystemPropertiesInterface.

T

Timer — Class in namespace Contentful\Core\Log

U

Exception::unserialize() — Method in class Exception
Message::unserialize() — Method in class Message: {@inheritdoc}
UserAgentGenerator — Class in namespace Contentful\Core\Api
UnprocessedFileInterface — Class in namespace Contentful\Core\File: UnprocessedFileInterface.

W

BaseQuery::where() — Method in class BaseQuery: Add a filter condition to this query.
NullLogger::warning() — Method in class NullLogger: {@inheritdoc}

_

BaseClient::__construct() — Method in class BaseClient: Client constructor.
BaseQuery::__construct() — Method in class BaseQuery: Query constructor.
DateTimeImmutable::__toString() — Method in class DateTimeImmutable: Returns a string representation of the current object.
Exception::__construct() — Method in class Exception: Exception constructor.
Link::__construct() — Method in class Link: Link constructor.
Location::__construct() — Method in class Location
Message::__construct() — Method in class Message: Constructor.
Message::__toString() — Method in class Message
RequestBuilder::__construct() — Method in class RequestBuilder
UserAgentGenerator::__construct() — Method in class UserAgentGenerator: UserAgentGenerator constructor.
RateLimitExceededException::__construct() — Method in class RateLimitExceededException: RateLimitExceededException constructor.
File::__construct() — Method in class File: File constructor.
ImageFile::__construct() — Method in class ImageFile: ImageFile constructor.
LocalUploadFile::__construct() — Method in class LocalUploadFile
RemoteUploadFile::__construct() — Method in class RemoteUploadFile
BaseResourceBuilder::__construct() — Method in class BaseResourceBuilder: ResourceBuilder constructor.
ResourceArray::__construct() — Method in class ResourceArray: ResourceArray constructor.
SystemPropertiesInterface::__construct() — Method in class SystemPropertiesInterface