1. interface
  2. Contentful
  3. \
  4. Core
  5. \
  6. Resource
  7. \
  8. ResourcePoolInterface

ResourcePoolInterface

interface ResourcePoolInterface

ResourcePoolInterface.

Classes implementing this interface represent a pool which contains ResourceInterface objects. This can be used for local storage and to simplify dependency handling between resources.

Methods

bool
save(ResourceInterface $resource)

Saves the given resource into the pool.

ResourceInterface
get(string $type, string $id, array $options = [])

Returns the resource for the given key.

bool
has(string $type, string $id, array $options = [])

Returns whether the pool contains the given resource.

string
generateKey(string $type, string $id, array $options = [])

Generates a unique key for the given data.

Details

at line 32
bool save(ResourceInterface $resource)

Saves the given resource into the pool.

Parameters

ResourceInterface $resource

Return Value

bool True is the resource was successfully added, false if it was already present

Exceptions

RuntimeException If the saving process fails

at line 45
ResourceInterface get(string $type, string $id, array $options = [])

Returns the resource for the given key.

Parameters

string $type
string $id
array $options

Return Value

ResourceInterface

Exceptions

OutOfBoundsException If the given key does not represent any stored resource

at line 56
bool has(string $type, string $id, array $options = [])

Returns whether the pool contains the given resource.

Parameters

string $type
string $id
array $options

Return Value

bool

at line 67
string generateKey(string $type, string $id, array $options = [])

Generates a unique key for the given data.

Parameters

string $type
string $id
array $options

Return Value

string