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
|
<?php
/**
* PHP OpenCloud library.
*
* @copyright 2014 Rackspace Hosting, Inc. See LICENSE for information.
* @license https://www.apache.org/licenses/LICENSE-2.0
* @author Glen Campbell <glen.campbell@rackspace.com>
* @author Jamie Hannaford <jamie.hannaford@rackspace.com>
*/
namespace OpenCloud\Common\Service;
/**
* This object represents an individual service catalog item - in other words an API Service. Each service has
* particular information which form the basis of how it distinguishes itself, and how it executes API operations.
*/
class CatalogItem
{
/**
* @var string
*/
private $name;
/**
* @var string
*/
private $type;
/**
* @var array
*/
private $endpoints = array();
/**
* Construct a CatalogItem from a mixed input.
*
* @param $object
* @return CatalogItem
*/
public static function factory($object)
{
$item = new self();
$item->setName($object->name)
->setType($object->type)
->setEndpoints($object->endpoints);
return $item;
}
/**
* @param $name
* @return $this
*/
public function setName($name)
{
$this->name = $name;
return $this;
}
/**
* @return string
*/
public function getName()
{
return $this->name;
}
/**
* A basic string check.
*
* @param $string
* @return bool
*/
public function hasName($string)
{
return !strnatcasecmp($this->name, $string);
}
/**
* @param $type
* @return $this
*/
public function setType($type)
{
$this->type = $type;
return $this;
}
/**
* @return string
*/
public function getType()
{
return $this->type;
}
/**
* @param $string
* @return bool
*/
public function hasType($string)
{
return !strnatcasecmp($this->type, $string);
}
/**
* @param array $endpoints
* @return $this
*/
public function setEndpoints(array $endpoints)
{
$this->endpoints = $endpoints;
return $this;
}
/**
* @return array
*/
public function getEndpoints()
{
return $this->endpoints;
}
/**
* Using a standard data object, extract its endpoint.
*
* @param $region
* @return mixed
* @throws \OpenCloud\Common\Exceptions\EndpointError
*/
public function getEndpointFromRegion($region)
{
foreach ($this->endpoints as $endpoint) {
if (!isset($endpoint->region) || $endpoint->region == $region) {
return $endpoint;
}
}
throw new \OpenCloud\Common\Exceptions\EndpointError(sprintf(
'This service [%s] does not have access to the [%s] endpoint.',
$this->name,
$region
));
}
}
|
