?iť?
Your IP : 18.191.240.127
<?php
/**
* Copyright 2012-2014 Rackspace US, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
namespace OpenCloud\ObjectStore\Resource;
use OpenCloud\Common\Exceptions;
use OpenCloud\Common\Service\ServiceInterface;
use OpenCloud\ObjectStore\Constants\Header as HeaderConst;
/**
* Abstract class holding shared functionality for containers.
*/
abstract class AbstractContainer extends AbstractResource
{
protected $metadataClass = 'OpenCloud\\ObjectStore\\Resource\\ContainerMetadata';
/**
* 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.
*
* @var string
*/
public $name;
public function __construct(ServiceInterface $service, $data = null)
{
$this->service = $service;
$this->metadata = new $this->metadataClass;
// Populate data if set
$this->populate($data);
}
/**
* Return the transaction ID for an HTTP API operation. Useful for debugging.
*
* @return string Transaction ID
*/
public function getTransId()
{
return $this->metadata->getProperty(HeaderConst::TRANS_ID);
}
/**
* Returns whether this container is CDN-enabled or not.
*
* @return boolean true if this container is CDN-enabled; false, otherwise.
*/
abstract public function isCdnEnabled();
/**
* Returns whether this container has log retention enabled or not.
*
* @return boolean true if this container has log retention enabled; false, otherwise.
*/
public function hasLogRetention()
{
if ($this instanceof CDNContainer) {
return $this->metadata->getProperty(HeaderConst::LOG_RETENTION) == 'True';
} else {
return $this->metadata->propertyExists(HeaderConst::ACCESS_LOGS);
}
}
/**
* For internal use only
*
* @return string Name of the primary key field for this resource
*/
public function primaryKeyField()
{
return 'name';
}
/**
* For internal use only
*
* @param string $path Path to add to URL. Optional.
* @param array $params Query parameters to add to URL. Optional.
* @return Url URL of this container + path + query parameters.
*/
public function getUrl($path = null, array $params = array())
{
if (strlen($this->getName()) == 0) {
throw new Exceptions\NoNameError('Container does not have a name');
}
$url = $this->getService()->getUrl();
return $url->addPath((string) $this->getName())->addPath((string) $path)->setQuery($params);
}
protected function createRefreshRequest()
{
return $this->getClient()->head($this->getUrl(), array('Accept' => '*/*'));
}
/**
* This method will enable your CDN-enabled container to serve out HTML content like a website.
*
* @param $indexPage The data object name (i.e. a .html file) that will serve as the main index page.
* @return \Guzzle\Http\Message\Response The HTTP response for this API operation.
*/
public function setStaticIndexPage($page)
{
if ($this instanceof CDNContainer) {
$this->getLogger()->warning(
'This method cannot be called on the CDN object - please execute it on the normal Container'
);
}
$headers = array('X-Container-Meta-Web-Index' => $page);
return $this->getClient()->post($this->getUrl(), $headers)->send();
}
/**
* Set the default error page for your static site.
*
* @param $name The data object name (i.e. a .html file) that will serve as the main error page.
* @return \Guzzle\Http\Message\Response The HTTP response for this operation.
*/
public function setStaticErrorPage($page)
{
if ($this instanceof CDNContainer) {
$this->getLogger()->warning(
'This method cannot be called on the CDN object - please execute it on the normal Container'
);
}
$headers = array('X-Container-Meta-Web-Error' => $page);
return $this->getClient()->post($this->getUrl(), $headers)->send();
}
}