Overview

Namespaces

  • None
  • OpenCloud
    • Autoscale
      • Resource
    • CloudMonitoring
      • Exception
      • Resource
    • Common
      • Exceptions
      • Log
      • Request
        • Response
    • Compute
    • Database
    • DNS
    • LoadBalancer
      • Resources
    • ObjectStore
      • Resource
    • Orchestration
    • Volume
  • PHP

Classes

  • AbstractStorageObject
  • CDNContainer
  • Container
  • DataObject
  • Overview
  • Namespace
  • Class
  • Tree
  • Download

Class AbstractStorageObject

Abstract base class which implements shared functionality of ObjectStore resources. Provides support, for example, for metadata-handling and other features that are common to the ObjectStore components.

OpenCloud\Common\Base
Extended by OpenCloud\ObjectStore\Resource\AbstractStorageObject

Direct known subclasses

OpenCloud\ObjectStore\Resource\CDNContainer, OpenCloud\ObjectStore\Resource\DataObject

Indirect known subclasses

OpenCloud\ObjectStore\Resource\Container
Abstract
Namespace: OpenCloud\ObjectStore\Resource
Located at OpenCloud/ObjectStore/Resource/AbstractStorageObject.php
Methods summary
public
# __construct( )

Initializes the metadata component

Initializes the metadata component

public
# getMetadata( OpenCloud\Common\Request\Response\Http $response )

Given an Http response object, converts the appropriate headers to metadata

Given an Http response object, converts the appropriate headers to metadata

Parameters

$response
OpenCloud\Common\Request\Response\Http
public array
# metadataHeaders( )

If object has metadata, return an associative array of headers.

If object has metadata, return an associative array of headers.

For example, if a DataObject has a metadata item named 'FOO', then this would return array('X-Object-Meta-FOO'=>$value);

Returns

array
public
# name( )

Returns the displayable name of the object

Returns the displayable name of the object

Can be overridden by child objects; must be overridden by child objects if the object does not have a name attribute defined.

Throws

OpenCloud\Common\Exceptions\NameError
if attribute 'name' is not defined

Api

public static null
# jsonName( )

Override parent method.

Override parent method.

Returns

null
public static null
# jsonCollectionName( )

Override parent method.

Override parent method.

Returns

null
public static null
# jsonCollectionElement( )

Override parent method.

Override parent method.

Returns

null
Methods inherited from OpenCloud\Common\Base
__set(), checkJsonError(), getHttpRequestObject(), getLogger(), makeQueryString(), populate(), setLogger(), setProperty(), url()
Constants summary
string ACCOUNT_META_PREFIX 'X-Account-'
#
string CONTAINER_META_PREFIX 'X-Container-Meta-'
#
string OBJECT_META_PREFIX 'X-Object-Meta-'
#
string CDNCONTAINER_META_PREFIX 'X-Cdn-'
#
Properties summary
public OpenCloud\Common\Metadata $metadata
#

Metadata belonging to a resource.

Metadata belonging to a resource.

PHP OpenCloud API API documentation generated by ApiGen 2.8.0