1. interface
  2. OpenStack
  3. Common
  4. Resource
  5. HasMetadata

HasMetadata

interface HasMetadata

Methods

getMetadata () : array

Retrieves the metadata for the resource in the form of an associative array or hash. Each key represents the metadata item's name, and each value represents the metadata item's remote value.

mergeMetadata (array $metadata) : void

Merges a set of new values with those which already exist (on the remote API) for a resource. For example, if the resource has this metadata already set:

resetMetadata (array $metadata) : void

Replaces all of the existing metadata items for a resource with a new set of values. Any metadata items which are not provided in the call are removed from the resource. For example, if the resource has this metadata already set:

parseMetadata (ResponseInterface $response) : array

Extracts metadata from a response object and returns it in the form of an associative array.

Details

View source
getMetadata()

Retrieves the metadata for the resource in the form of an associative array or hash. Each key represents the metadata item's name, and each value represents the metadata item's remote value.

Return value

array

Example code

$array = $hasMetadata->getMetadata();

View source
mergeMetadata(array $metadata)

Merges a set of new values with those which already exist (on the remote API) for a resource. For example, if the resource has this metadata already set:

Foo: val1 Bar: val2

and mergeMetadata(['Foo' => 'val3', 'Baz' => 'val4']); is called, then the resource will have the following metadata:

Foo: val3 Bar: val2 Baz: val4

You will notice that any metadata items which are not specified in the call are preserved.

Parameters

$metadata array The new metadata items

Return value

void

Example code

$hasMetadata->mergeMetadata($metadata);

View source
resetMetadata(array $metadata)

Replaces all of the existing metadata items for a resource with a new set of values. Any metadata items which are not provided in the call are removed from the resource. For example, if the resource has this metadata already set:

Foo: val1 Bar: val2

and resetMetadata(['Foo' => 'val3', 'Baz' => 'val4']); is called, then the resource will have the following metadata:

Foo: val3 Baz: val4

Parameters

$metadata array The new metadata items

Return value

void

Example code

$hasMetadata->resetMetadata($metadata);

View source
parseMetadata(ResponseInterface $response)

Extracts metadata from a response object and returns it in the form of an associative array.

Parameters

$response ResponseInterface

Return value

array

Example code

$array = $hasMetadata->parseMetadata($response);