1. class
  2. Contentful
  3. \
  4. Delivery
  5. \
  6. ClientOptions

ClientOptions

class ClientOptions

Methods

__construct()

ClientOptions constructor.

static 
create()

No description

ClientOptions
withDefaultLocale(string $locale)

No description

string|null
getDefaultLocale()

No description

usingDeliveryApi()

No description

usingPreviewApi()

No description

withHost(string $host)

No description

getHost()

No description

withCache(CacheItemPoolInterface $cacheItemPool, bool $autoWarmup = false, bool $cacheContent = false)

No description

getCacheItemPool()

No description

hasCacheAutoWarmup()

No description

hasCacheContent()

No description

withLogger(LoggerInterface $logger)

Configure the Client to use any PSR-3 compatible logger.

getLogger()

No description

withHttpClient(Client $client)

No description

getHttpClient()

No description

withNormalResourcePool()

Configures the client to use the default resource pool implementation, which may use more memory in extreme scenarios (tens of thousands of resources).

withLowMemoryResourcePool()

Configures the client to use a resource pool which will not cache entries and assets, which is useful when handling tens of thousand of resources, but it may cause extra API calls in normal scenarios.

usesLowMemoryResourcePool()

No description

withoutMessageLogging()

No description

usesMessageLogging()

No description

withQueryCache(CacheItemPoolInterface $queryCacheItemPool, int $queryCacheLifetime)

No description

getQueryCacheItemPool()

No description

getQueryCacheLifetime()

No description

Details

at line 80
__construct()

ClientOptions constructor.

at line 88
static create()

at line 96
ClientOptions withDefaultLocale(string $locale)

Parameters

string $locale

Return Value

ClientOptions

at line 106
string|null getDefaultLocale()

Return Value

string|null

at line 111
usingDeliveryApi()

at line 118
usingPreviewApi()

at line 125
withHost(string $host)

Parameters

string $host

at line 136
getHost()

at line 141
withCache(CacheItemPoolInterface $cacheItemPool, bool $autoWarmup = false, bool $cacheContent = false)

Parameters

CacheItemPoolInterface $cacheItemPool
bool $autoWarmup
bool $cacheContent

at line 153
getCacheItemPool()

at line 158
hasCacheAutoWarmup()

at line 163
hasCacheContent()

at line 171
withLogger(LoggerInterface $logger)

Configure the Client to use any PSR-3 compatible logger.

Parameters

LoggerInterface $logger

at line 178
getLogger()

at line 183
withHttpClient(Client $client)

Parameters

Client $client

at line 190
getHttpClient()

at line 199
withNormalResourcePool()

Configures the client to use the default resource pool implementation, which may use more memory in extreme scenarios (tens of thousands of resources).

at line 212
withLowMemoryResourcePool()

Configures the client to use a resource pool which will not cache entries and assets, which is useful when handling tens of thousand of resources, but it may cause extra API calls in normal scenarios.

Use this option only if the default resource pool is causing you memory errors.

at line 219
usesLowMemoryResourcePool()

at line 224
withoutMessageLogging()

at line 231
usesMessageLogging()

at line 236
withQueryCache(CacheItemPoolInterface $queryCacheItemPool, int $queryCacheLifetime)

Parameters

CacheItemPoolInterface $queryCacheItemPool
int $queryCacheLifetime

at line 244
getQueryCacheItemPool()

at line 249
getQueryCacheLifetime()