Index | Contentful Core for PHP

A

ApplicationInterface — Class in namespace Contentful\Core\Api
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.
ArraySystemProperties — Class in namespace Contentful\Core\Resource
AssetInterface — Class in namespace Contentful\Core\Resource
ResourceArray::asLink() — Method in class ResourceArray: Creates a Link representation of the current resource.
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.
ResourceBuilderInterface::build() — Method in class ResourceBuilderInterface: Creates or updates an object using given data.
BaseResourcePool — Class in namespace Contentful\Core\Resource

C

BaseClient::callApi() — Method in class BaseClient: Make a call to the API and returns the parsed JSON.
BaseClient::clearMesssages() — Method in class BaseClient: Clears the store of Message objects.
ClientInterface — Class in namespace Contentful\Core\Api
Message::createFromString() — Method in class Message: Creates a new instance of the class from a JSON string.
BaseResourceBuilder::createMapper() — Method in class BaseResourceBuilder: Abstract function for instantiating a mapper.
ContentTypeInterface — Class in namespace Contentful\Core\Resource
ResourceArray::count() — Method in class ResourceArray: {@inheritdoc}

D

DateTimeImmutable — Class in namespace Contentful\Core\Api: DateTimeImmutable class.

E

Exception — Class in namespace Contentful\Core\Api: An Exception is thrown when an errors occurs while communicating with the API.
EntryInterface — Class in namespace Contentful\Core\Resource

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

ApplicationInterface::getApplicationName() — Method in class ApplicationInterface: Returns the name of the current application.
ApplicationInterface::getApplicationPackageName() — Method in class ApplicationInterface: Returns the package name of the current application.
ApplicationInterface::getApplicationVersion() — Method in class ApplicationInterface: Returns the version of the current application.
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: Returns an array of Message objects.
BaseClient::getHost() — Method in class BaseClient
BaseClient::getVersion() — Method in class BaseClient
BaseClient::getVersionForPackage() — Method in class BaseClient
BaseClient::getPackageName() — Method in class BaseClient: Returns the packagist name of the current package.
BaseClient::getSdkName() — Method in class BaseClient: The name 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.
ClientInterface::getApi() — Method in class ClientInterface: Returns a string representation of the API currently in use.
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
IntegrationInterface::getIntegrationName() — Method in class IntegrationInterface: Returns the name of the current integration.
IntegrationInterface::getIntegrationPackageName() — Method in class IntegrationInterface: Returns the package name of the current integration.
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: The duration in microseconds.
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: The URL where this file can be retrieved.
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
ProcessedFileInterface::getUrl() — Method in class ProcessedFileInterface: The URL where this file can be retrieved.
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
UrlOptionsInterface::getQueryString() — Method in class UrlOptionsInterface: The urlencoded query string for these options.
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.
ArraySystemProperties::getId() — Method in class ArraySystemProperties
ArraySystemProperties::getType() — Method in class ArraySystemProperties
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::getSystemProperties() — Method in class ResourceArray: Returns the resource's system properties, defined in the object "sys" in Contentful's responses.
ResourceArray::getId() — Method in class ResourceArray: Shortcut for retrieving the resource ID from the system properties object.
ResourceArray::getType() — Method in class ResourceArray: Shortcut for retrieving the resource type from the system properties object.
ResourceArray::getIterator() — Method in class ResourceArray: {@inheritdoc}
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.
ResourcePoolInterface::get() — Method in class ResourcePoolInterface: Returns the resource for the given key.
ResourcePoolInterface::generateKey() — Method in class ResourcePoolInterface: Generates a unique key for the given data.
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.
ObjectHydrator::hydrate() — Method in class ObjectHydrator: If given a class name as target, the hydrator will create an instance of that class, but skipping the constructor. The hydrator will then update the internal properties, according to the keys defined in the $data parameter.
ResourcePoolInterface::has() — Method in class ResourcePoolInterface: Returns whether the pool contains the given resource.

I

ApplicationInterface::isPackagedApplication() — Method in class ApplicationInterface: Returns whether the current application is distributed as a Composer package.
IntegrationInterface — Class in namespace Contentful\Core\Api
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.
InvalidResponseBodyException — Class in namespace Contentful\Core\Exception: A InvalidResponseBodyException indicates that there was problem with response body.
ImageFile — Class in namespace Contentful\Core\File: ImageFile class.
ImageOptions — Class in namespace Contentful\Core\File: ImageOptions class.

J

DateTimeImmutable::jsonSerialize() — Method in class DateTimeImmutable: Returns a JSON representation of the current object.
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}
ArraySystemProperties::jsonSerialize() — Method in class ArraySystemProperties: {@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.
LinkResolverInterface — Class in namespace Contentful\Core\Api
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.

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

O

BaseQuery::orderBy() — Method in class BaseQuery: Set the order of the items retrieved by this query.
ObjectHydrator — Class in namespace Contentful\Core\ResourceBuilder: Class ObjectHydrator.
ResourceArray::offsetExists() — Method in class ResourceArray: {@inheritdoc}
ResourceArray::offsetGet() — Method in class ResourceArray: {@inheritdoc}
ResourceArray::offsetSet() — Method in class ResourceArray: {@inheritdoc}
ResourceArray::offsetUnset() — Method in class ResourceArray: {@inheritdoc}

P

ProcessedFileInterface — Class in namespace Contentful\Core\File: ProcessedFileInterface.

Q

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

R

ClientInterface::request() — Method in class ClientInterface: Sends a request to the API, and returns a resource object.
LinkResolverInterface::resolveLink() — Method in class LinkResolverInterface
LinkResolverInterface::resolveLinkCollection() — Method in class LinkResolverInterface: Resolves an array of links.
RequestBuilder — Class in namespace Contentful\Core\Api: RequestBuilder class.
Requester — Class in namespace Contentful\Core\Api
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.
ResourceBuilderInterface — Class in namespace Contentful\Core\ResourceBuilder: ResourceBuilderInterface.
$BaseResourcePool — Property in class BaseResourcePool
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.
ResourcePoolInterface — Class in namespace Contentful\Core\Resource: ResourcePoolInterface.

S

BaseClient::setApplication() — Method in class BaseClient: Set the application name and version.
BaseClient::setIntegration() — Method in class BaseClient: Set the integration name and version.
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.
ClientInterface::setApplication() — Method in class ClientInterface: Set the application name and version.
ClientInterface::setIntegration() — Method in class ClientInterface: Set the integration name and version.
Exception::serialize() — Method in class Exception: {@inheritdoc}
Message::serialize() — Method in class Message: {@inheritdoc}
Requester::sendRequest() — Method in class Requester: Queries the API, and returns a message object which contains all information needed for processing and logging.
UserAgentGenerator::setApplication() — Method in class UserAgentGenerator: Set the application name and version.
UserAgentGenerator::setIntegration() — Method in class UserAgentGenerator: Set the application name and version.
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::setPng8Bit() — Method in class ImageOptions: Set to true to load the image as a 8-bit PNG.
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.
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.
BaseResourcePool::sanitize() — Method in class BaseResourcePool: Sanitizes potentially problematic characters for resource keys.
ResourcePoolInterface::save() — Method in class ResourcePoolInterface: Saves the given resource into the pool.
SystemPropertiesInterface — Class in namespace Contentful\Core\Resource: SystemPropertiesInterface.

U

BaseClient::useApplication() — Method in class BaseClient: Sets the current application.
BaseClient::useIntegration() — Method in class BaseClient: Sets the current integration.
ClientInterface::useApplication() — Method in class ClientInterface: Sets the current application.
ClientInterface::useIntegration() — Method in class ClientInterface: Sets the current integration.
Exception::unserialize() — Method in class Exception: {@inheritdoc}
Message::unserialize() — Method in class Message: {@inheritdoc}
UserAgentGenerator — Class in namespace Contentful\Core\Api: UserAgentGenerator class.
UnprocessedFileInterface — Class in namespace Contentful\Core\File: UnprocessedFileInterface.
UrlOptionsInterface — Class in namespace Contentful\Core\File: UrlOptionsInterface.

V

$BaseQuery — Property in class BaseQuery
$BaseQuery — Property in class BaseQuery

W

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

_

BaseClient::__construct() — Method in class BaseClient: Client constructor.
DateTimeImmutable::__toString() — Method in class DateTimeImmutable: Returns a string representation of the current object.
Exception::__construct() — Method in class Exception: Exception constructor.
Exception::__serialize() — Method in class Exception
Exception::__unserialize() — Method in class Exception
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
Message::__serialize() — Method in class Message
Message::__unserialize() — Method in class Message
RequestBuilder::__construct() — Method in class RequestBuilder
Requester::__construct() — Method in class Requester: ApiRequester constructor.
UserAgentGenerator::__construct() — Method in class UserAgentGenerator: UserAgentGenerator constructor.
RateLimitExceededException::__construct() — Method in class RateLimitExceededException: Exception 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: RemoteUploadFile constructor.
BaseResourceBuilder::__construct() — Method in class BaseResourceBuilder: ResourceBuilder constructor.
ArraySystemProperties::__construct() — Method in class ArraySystemProperties
ResourceArray::__construct() — Method in class ResourceArray: ResourceArray constructor.
SystemPropertiesInterface::__construct() — Method in class SystemPropertiesInterface