Overview
  • Namespace
  • Class

Namespaces

  • OpenCloud
    • Autoscale
      • Resource
    • CloudMonitoring
      • Collection
      • Exception
      • Resource
    • Common
      • Collection
      • Constants
      • Exceptions
      • Http
        • Message
      • Log
      • Resource
      • Service
    • Compute
      • Constants
      • Exception
      • Resource
    • Database
      • Resource
    • DNS
      • Collection
      • Resource
    • Identity
      • Constants
      • Resource
    • Image
      • Enum
      • Resource
        • JsonPatch
        • Schema
    • LoadBalancer
      • Collection
      • Enum
      • Resource
    • Networking
      • Resource
    • ObjectStore
      • Constants
      • Exception
      • Resource
      • Upload
    • Orchestration
      • Resource
    • Queues
      • Collection
      • Exception
      • Resource
    • Volume
      • Resource

Classes

  • AbstractContainer
  • AbstractResource
  • Account
  • CDNContainer
  • Container
  • ContainerMetadata
  • DataObject

Class AbstractContainer

Abstract class holding shared functionality for containers.

OpenCloud\Common\Base
Extended by OpenCloud\ObjectStore\Resource\AbstractResource
Extended by OpenCloud\ObjectStore\Resource\AbstractContainer

Direct known subclasses

OpenCloud\ObjectStore\Resource\CDNContainer, OpenCloud\ObjectStore\Resource\Container

Abstract
Namespace: OpenCloud\ObjectStore\Resource
Located at OpenCloud/ObjectStore/Resource/AbstractContainer.php

Methods summary

public
# __construct( OpenCloud\Common\Service\ServiceInterface $service, $data = null )

Overrides

OpenCloud\ObjectStore\Resource\AbstractResource::__construct
public
# getTransId( )
abstract public
# isCdnEnabled( )
public
# hasLogRetention( )
public
# primaryKeyField( )
public
# getUrl( $path = null, array $params = array() )
public Guzzle\Http\Message\Response
# setStaticIndexPage( $page )

This method will enable your CDN-enabled container to serve out HTML content like a website.

This method will enable your CDN-enabled container to serve out HTML content like a website.

Parameters

$page
data object name (i.e. a .html file) that will serve as the main index page.

Returns

Guzzle\Http\Message\Response
public Guzzle\Http\Message\Response
# setStaticErrorPage( $page )

Set the default error page for your static site.

Set the default error page for your static site.

Parameters

$page
data object name (i.e. a .html file) that will serve as the main error page.

Returns

Guzzle\Http\Message\Response

Methods inherited from OpenCloud\ObjectStore\Resource\AbstractResource

appendToMetadata(), fromResponse(), getCdnService(), getClient(), getMetadata(), getService(), retrieveMetadata(), saveMetadata(), setMetadata(), stockHeaders(), trimHeaders(), unsetMetadataItem()

Methods inherited from OpenCloud\Common\Base

__call(), checkJsonError(), generateUuid(), getInstance(), getLogger(), hasLogger(), makeResourceIteratorOptions(), populate(), setLogger(), stripNamespace(), toCamel(), toUnderscores()

Magic methods summary

Constants summary

Constants inherited from OpenCloud\ObjectStore\Resource\AbstractResource

GLOBAL_METADATA_PREFIX

Properties summary

public string $name

The name of the container.

The name of the container.

The only restrictions on container names is that they cannot contain a forward slash (/) and must be less than 256 bytes in length. Please note that the length restriction applies to the name after it has been URL encoded. For example, a container named Course Docs would be URL encoded as Course%20Docs - which is 13 bytes in length rather than the expected 11.

#
API documentation generated by ApiGen