1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212
<?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\Common\Service;
use Guzzle\Http\ClientInterface;
use OpenCloud\Common\Base;
use OpenCloud\Common\Collection\PaginatedIterator;
use OpenCloud\Common\Exceptions;
/**
* This class defines a cloud service; a relationship between a specific OpenStack
* and a provided service, represented by a URL in the service catalog.
*
* Because Service is an abstract class, it cannot be called directly. Provider
* services such as Rackspace Cloud Servers or OpenStack Swift are each
* subclassed from Service.
*/
abstract class AbstractService extends Base implements ServiceInterface
{
/**
* @var \OpenCloud\Common\Http\Client The client which interacts with the API.
*/
protected $client;
/**
* @var \OpenCloud\Common\Service\Endpoint The endpoint for this service.
*/
protected $endpoint;
/**
* @var array A collection of resource models that this service has control over.
*/
protected $resources = array();
/**
* @var array Namespaces for this service.
*/
protected $namespaces = array();
/**
* @param ClientInterface $client
*/
public function setClient(ClientInterface $client)
{
$this->client = $client;
}
/**
* @return \OpenCloud\Common\Http\Client
*/
public function getClient()
{
return $this->client;
}
/**
* @param Endpoint $endpoint
*/
public function setEndpoint($endpoint)
{
$this->endpoint = $endpoint;
}
/**
* @return \OpenCloud\Common\Service\Endpoint
*/
public function getEndpoint()
{
return $this->endpoint;
}
/**
* Get all associated resources for this service.
*
* @access public
* @return array
*/
public function getResources()
{
return $this->resources;
}
/**
* Internal method for accessing child namespace from parent scope.
*
* @return type
*/
protected function getCurrentNamespace()
{
$namespace = get_class($this);
return substr($namespace, 0, strrpos($namespace, '\\'));
}
/**
* Resolves FQCN for local resource.
*
* @param $resourceName
* @return string
* @throws \OpenCloud\Common\Exceptions\UnrecognizedServiceError
*/
protected function resolveResourceClass($resourceName)
{
$className = substr_count($resourceName, '\\')
? $resourceName
: $this->getCurrentNamespace() . '\\Resource\\' . ucfirst($resourceName);
if (!class_exists($className)) {
throw new Exceptions\UnrecognizedServiceError(sprintf(
'%s resource does not exist, please try one of the following: %s',
$resourceName,
implode(', ', $this->getResources())
));
}
return $className;
}
/**
* Factory method for instantiating resource objects.
*
* @param string $resourceName
* @param mixed $info (default: null)
* @param mixed $parent The parent object
* @return object
*/
public function resource($resourceName, $info = null, $parent = null)
{
$className = $this->resolveResourceClass($resourceName);
$resource = new $className($this);
if ($parent) {
$resource->setParent($parent);
}
$resource->populate($info);
return $resource;
}
/**
* Factory method for instantiating a resource collection.
*
* @param string $resourceName
* @param string|null $url
* @param string|null $parent
* @return PaginatedIterator
*/
public function resourceList($resourceName, $url = null, $parent = null)
{
$className = $this->resolveResourceClass($resourceName);
return $this->collection($className, $url, $parent);
}
/**
* @codeCoverageIgnore
*/
public function collection($class, $url = null, $parent = null, $data = null)
{
if (!$parent) {
$parent = $this;
}
if (!$url) {
$resource = $this->resolveResourceClass($class);
$url = $parent->getUrl($resource::resourceName());
}
$options = $this->makeResourceIteratorOptions($this->resolveResourceClass($class));
$options['baseUrl'] = $url;
return PaginatedIterator::factory($parent, $options, $data);
}
/**
* @deprecated
*/
public function namespaces()
{
return $this->getNamespaces();
}
/**
* Returns a list of supported namespaces
*
* @return array
*/
public function getNamespaces()
{
return (isset($this->namespaces) && is_array($this->namespaces))
? $this->namespaces
: array();
}
}