|
1
|
|
|
<?php declare(strict_types=1); |
|
2
|
|
|
|
|
3
|
|
|
namespace OpenStack\Identity\v3\Models; |
|
4
|
|
|
|
|
5
|
|
|
use OpenStack\Common\Resource\Alias; |
|
6
|
|
|
use Psr\Http\Message\ResponseInterface; |
|
7
|
|
|
use OpenStack\Common\Resource\OperatorResource; |
|
8
|
|
|
use OpenStack\Common\Resource\Creatable; |
|
9
|
|
|
use OpenStack\Common\Resource\Retrievable; |
|
10
|
|
|
|
|
11
|
|
|
/** |
|
12
|
|
|
* @property \OpenStack\Identity\v3\Api $api |
|
13
|
|
|
*/ |
|
14
|
|
|
class Token extends OperatorResource implements Creatable, Retrievable, \OpenStack\Common\Auth\Token |
|
15
|
|
|
{ |
|
16
|
|
|
/** @var array */ |
|
17
|
|
|
public $methods; |
|
18
|
|
|
|
|
19
|
|
|
/** @var []Role */ |
|
20
|
|
|
public $roles; |
|
21
|
|
|
|
|
22
|
|
|
/** @var \DateTimeImmutable */ |
|
23
|
|
|
public $expires; |
|
24
|
|
|
|
|
25
|
|
|
/** @var Project */ |
|
26
|
|
|
public $project; |
|
27
|
|
|
|
|
28
|
|
|
/** @var Catalog */ |
|
29
|
|
|
public $catalog; |
|
30
|
|
|
|
|
31
|
|
|
/** @var mixed */ |
|
32
|
|
|
public $extras; |
|
33
|
|
|
|
|
34
|
|
|
/** @var User */ |
|
35
|
|
|
public $user; |
|
36
|
|
|
|
|
37
|
|
|
/** @var \DateTimeImmutable */ |
|
38
|
|
|
public $issued; |
|
39
|
|
|
|
|
40
|
|
|
/** @var string */ |
|
41
|
|
|
public $id; |
|
42
|
|
|
|
|
43
|
|
|
protected $resourceKey = 'token'; |
|
44
|
|
|
protected $resourcesKey = 'tokens'; |
|
45
|
|
|
|
|
46
|
|
|
protected $aliases = []; |
|
47
|
|
|
|
|
48
|
|
|
/** |
|
49
|
|
|
* @inheritdoc |
|
50
|
|
|
*/ |
|
51
|
|
|
protected function getAliases() |
|
52
|
|
|
{ |
|
53
|
5 |
|
$aliases = parent::getAliases(); |
|
54
|
|
|
$aliases['roles'] = new Alias('roles', Role::class, true); |
|
55
|
5 |
|
$aliases['expires_at'] = new Alias('expires', \DateTimeImmutable::class); |
|
56
|
|
|
$aliases['project'] = new Alias('project', Project::class); |
|
57
|
5 |
|
$aliases['catalog'] = new Alias('catalog', Catalog::class); |
|
58
|
|
|
$aliases['user'] = new Alias('user', User::class); |
|
59
|
5 |
|
$aliases['issued_at'] = new Alias('issued', \DateTimeImmutable::class); |
|
60
|
|
|
return $aliases; |
|
|
|
|
|
|
61
|
|
|
} |
|
62
|
|
|
|
|
63
|
|
|
/** |
|
64
|
|
|
* {@inheritDoc} |
|
65
|
1 |
|
*/ |
|
66
|
|
|
public function populateFromResponse(ResponseInterface $response) |
|
67
|
1 |
|
{ |
|
68
|
|
|
parent::populateFromResponse($response); |
|
69
|
|
|
$this->id = $response->getHeaderLine('X-Subject-Token'); |
|
70
|
|
|
return $this; |
|
71
|
|
|
} |
|
72
|
|
|
|
|
73
|
1 |
|
/** |
|
74
|
|
|
* @return string |
|
75
|
1 |
|
*/ |
|
76
|
|
|
public function getId(): string |
|
77
|
|
|
{ |
|
78
|
|
|
return $this->id; |
|
79
|
|
|
} |
|
80
|
|
|
|
|
81
|
1 |
|
/** |
|
82
|
|
|
* @return bool TRUE if the token has expired (and is invalid); FALSE otherwise. |
|
83
|
1 |
|
*/ |
|
84
|
|
|
public function hasExpired(): bool |
|
85
|
1 |
|
{ |
|
86
|
1 |
|
return $this->expires <= new \DateTimeImmutable('now', $this->expires->getTimezone()); |
|
87
|
|
|
} |
|
88
|
|
|
|
|
89
|
|
|
/** |
|
90
|
|
|
* {@inheritDoc} |
|
91
|
|
|
*/ |
|
92
|
|
|
public function retrieve() |
|
93
|
10 |
|
{ |
|
94
|
|
|
$response = $this->execute($this->api->getTokens(), ['tokenId' => $this->id]); |
|
95
|
10 |
|
$this->populateFromResponse($response); |
|
96
|
4 |
|
} |
|
97
|
4 |
|
|
|
98
|
1 |
|
/** |
|
99
|
|
|
* {@inheritDoc} |
|
100
|
|
|
* |
|
101
|
1 |
|
* @param array $data {@see \OpenStack\Identity\v3\Api::postTokens} |
|
102
|
1 |
|
*/ |
|
103
|
|
|
public function create(array $data): Creatable |
|
104
|
9 |
|
{ |
|
105
|
1 |
|
if (isset($data['user'])) { |
|
106
|
1 |
|
$data['methods'] = ['password']; |
|
107
|
5 |
|
if (!isset($data['user']['id']) && empty($data['user']['domain'])) { |
|
108
|
|
|
throw new \InvalidArgumentException( |
|
109
|
|
|
'When authenticating with a username, you must also provide either the domain name or domain ID to ' |
|
110
|
4 |
|
. 'which the user belongs to. Alternatively, if you provide a user ID instead, you do not need to ' |
|
111
|
4 |
|
. 'provide domain information.' |
|
112
|
|
|
); |
|
113
|
|
|
} |
|
114
|
|
|
} elseif (isset($data['tokenId'])) { |
|
115
|
|
|
$data['methods'] = ['token']; |
|
116
|
|
|
} else { |
|
117
|
|
|
throw new \InvalidArgumentException('Either a user or token must be provided.'); |
|
118
|
|
|
} |
|
119
|
|
|
|
|
120
|
|
|
$response = $this->execute($this->api->postTokens(), $data); |
|
121
|
|
|
return $this->populateFromResponse($response); |
|
122
|
|
|
} |
|
123
|
|
|
} |
|
124
|
|
|
|
php-opencloud /
openstack
If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design.
Let’s take a look at an example:
Our function
my_functionexpects aPostobject, and outputs the author of the post. The base classPostreturns a simple string and outputting a simple string will work just fine. However, the child classBlogPostwhich is a sub-type ofPostinstead decided to return anobject, and is therefore violating the SOLID principles. If aBlogPostwere passed tomy_function, PHP would not complain, but ultimately fail when executing thestrtouppercall in its body.