Overview

Namespaces

  • OpenCloud
    • Autoscale
      • Resource
    • CloudMonitoring
      • 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
      • Enum
      • Resource
    • ObjectStore
      • Constants
      • Exception
      • Resource
      • Upload
    • Orchestration
    • Queues
      • Exception
      • Resource
    • Volume
      • Resource
  • PHP

Classes

  • AbstractContainer
  • AbstractResource
  • Account
  • CDNContainer
  • Container
  • ContainerMetadata
  • DataObject
  • Overview
  • Namespace
  • Class
  • Tree
  • Download

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, mixed $data = null )

Overrides

OpenCloud\ObjectStore\Resource\AbstractResource::__construct()
public
# getTransId( )
abstract public
# isCdnEnabled( )
public
# hasLogRetention( )
public
# primaryKeyField( )
public
# getUrl( mixed $path = null, array $params = array() )
protected
# createRefreshRequest( )
public Guzzle\Http\Message\Response
# setStaticIndexPage( mixed $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
mixed
$indexPage The 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( mixed $page )

Set the default error page for your static site.

Set the default error page for your static site.

Parameters

$page
mixed
$name The 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(), headerIsValidMetadata(), retrieveMetadata(), saveMetadata(), setMetadata(), stockHeaders(), stripPrefix(), trimHeaders(), unsetMetadataItem()
Methods inherited from OpenCloud\Common\Base
__call(), checkJsonError(), generateUuid(), getInstance(), getJsonHeader(), getLogger(), getProperty(), makeResourceIteratorOptions(), populate(), propertyExists(), setLogger(), setProperty(), stripNamespace(), toCamel(), toUnderscores()
Constants inherited from OpenCloud\ObjectStore\Resource\AbstractResource
GLOBAL_METADATA_PREFIX
Properties summary
protected string $metadataClass 'OpenCloud\\ObjectStore\\Resource\\ContainerMetadata'
#

The FQCN of the metadata object used for the container.

The FQCN of the metadata object used for the container.

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.

Properties inherited from OpenCloud\ObjectStore\Resource\AbstractResource
$metadata, $service
Properties inherited from OpenCloud\Common\Base
$aliases
PHP OpenCloud API API documentation generated by ApiGen 2.8.0