Overview

Namespaces

  • OpenCloud
    • Autoscale
      • Resource
    • CloudMonitoring
      • Exception
      • Resource
    • Common
      • Collection
      • Constants
      • Exceptions
      • Http
        • Message
      • Identity
      • Log
      • Service
    • Compute
      • Constants
      • Exception
      • Resource
    • Database
      • Resource
    • DNS
      • Resource
    • LoadBalancer
      • 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\AbstractService $service, mixed $data = null )

Overrides

OpenCloud\ObjectStore\Resource\AbstractResource::__construct()
public
# getTransId( )
public
# isCdnEnabled( )
public
# hasLogRetention( )
public
# primaryKeyField( )
public
# getUrl( mixed $path = null, array $params = array() )

Returns the individual URL of the service/object.

Returns the individual URL of the service/object.

Throws

UrlError

Overrides

OpenCloud\Common\Base::getUrl()
protected
# createRefreshRequest( )
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(), 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
PHP OpenCloud API API documentation generated by ApiGen 2.8.0