Skip to content

Commit 88037a5

Browse files
author
haphan
committed
Applied php-cs-fixer
Mostly removed no_superfluous_phpdoc_tags, phpdoc_trim and no_empty_phpdoc
1 parent c209a19 commit 88037a5

72 files changed

Lines changed: 70 additions & 684 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎src/BlockStorage/v2/Models/Snapshot.php‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,12 @@
55
namespace OpenStack\BlockStorage\v2\Models;
66

77
use OpenStack\Common\Resource\Alias;
8-
use OpenStack\Common\Resource\OperatorResource;
98
use OpenStack\Common\Resource\Creatable;
109
use OpenStack\Common\Resource\Deletable;
1110
use OpenStack\Common\Resource\HasMetadata;
1211
use OpenStack\Common\Resource\HasWaiterTrait;
1312
use OpenStack\Common\Resource\Listable;
13+
use OpenStack\Common\Resource\OperatorResource;
1414
use OpenStack\Common\Resource\Retrievable;
1515
use OpenStack\Common\Resource\Updateable;
1616
use OpenStack\Common\Transport\Utils;
@@ -85,8 +85,6 @@ public function retrieve()
8585

8686
/**
8787
* @param array $userOptions {@see \OpenStack\BlockStorage\v2\Api::postSnapshots}
88-
*
89-
* @return Creatable
9088
*/
9189
public function create(array $userOptions): Creatable
9290
{

‎src/BlockStorage/v2/Models/Volume.php‎

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,12 @@
55
namespace OpenStack\BlockStorage\v2\Models;
66

77
use OpenStack\Common\Resource\Alias;
8-
use OpenStack\Common\Resource\OperatorResource;
98
use OpenStack\Common\Resource\Creatable;
109
use OpenStack\Common\Resource\Deletable;
1110
use OpenStack\Common\Resource\HasMetadata;
1211
use OpenStack\Common\Resource\HasWaiterTrait;
1312
use OpenStack\Common\Resource\Listable;
13+
use OpenStack\Common\Resource\OperatorResource;
1414
use OpenStack\Common\Resource\Retrievable;
1515
use OpenStack\Common\Resource\Updateable;
1616
use OpenStack\Common\Transport\Utils;
@@ -111,8 +111,6 @@ public function retrieve()
111111

112112
/**
113113
* @param array $userOptions {@see \OpenStack\BlockStorage\v2\Api::postVolumes}
114-
*
115-
* @return Creatable
116114
*/
117115
public function create(array $userOptions): Creatable
118116
{
@@ -162,8 +160,6 @@ public function parseMetadata(ResponseInterface $response): array
162160

163161
/**
164162
* Update the bootable status for a volume, mark it as a bootable volume.
165-
*
166-
* @param bool $bootable
167163
*/
168164
public function setBootable(bool $bootable = true)
169165
{
@@ -172,8 +168,6 @@ public function setBootable(bool $bootable = true)
172168

173169
/**
174170
* Sets the image metadata for a volume.
175-
*
176-
* @param array $metadata
177171
*/
178172
public function setImageMetadata(array $metadata)
179173
{

‎src/BlockStorage/v2/Models/VolumeType.php‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@
44

55
namespace OpenStack\BlockStorage\v2\Models;
66

7-
use OpenStack\Common\Resource\OperatorResource;
87
use OpenStack\Common\Resource\Creatable;
98
use OpenStack\Common\Resource\Deletable;
109
use OpenStack\Common\Resource\Listable;
10+
use OpenStack\Common\Resource\OperatorResource;
1111
use OpenStack\Common\Resource\Updateable;
1212

1313
/**
@@ -26,8 +26,6 @@ class VolumeType extends OperatorResource implements Listable, Creatable, Update
2626

2727
/**
2828
* @param array $userOptions {@see \OpenStack\BlockStorage\v2\Api::postTypes}
29-
*
30-
* @return Creatable
3129
*/
3230
public function create(array $userOptions): Creatable
3331
{

‎src/BlockStorage/v2/Service.php‎

Lines changed: 0 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,6 @@ class Service extends AbstractService
2020
* You must have enough volume storage quota remaining to create a volume of size requested.
2121
*
2222
* @param array $userOptions {@see Api::postVolumes}
23-
*
24-
* @return Volume
2523
*/
2624
public function createVolume(array $userOptions): Volume
2725
{
@@ -33,8 +31,6 @@ public function createVolume(array $userOptions): Volume
3331
*
3432
* @param bool $detail if set to TRUE, more information will be returned
3533
* @param array $userOptions {@see Api::getVolumes}
36-
*
37-
* @return \Generator
3834
*/
3935
public function listVolumes(bool $detail = false, array $userOptions = []): \Generator
4036
{
@@ -45,8 +41,6 @@ public function listVolumes(bool $detail = false, array $userOptions = []): \Gen
4541

4642
/**
4743
* @param string $volumeId the UUID of the volume being retrieved
48-
*
49-
* @return Volume
5044
*/
5145
public function getVolume(string $volumeId): Volume
5246
{
@@ -58,27 +52,17 @@ public function getVolume(string $volumeId): Volume
5852

5953
/**
6054
* @param array $userOptions {@see Api::postTypes}
61-
*
62-
* @return VolumeType
6355
*/
6456
public function createVolumeType(array $userOptions): VolumeType
6557
{
6658
return $this->model(VolumeType::class)->create($userOptions);
6759
}
6860

69-
/**
70-
* @return \Generator
71-
*/
7261
public function listVolumeTypes(): \Generator
7362
{
7463
return $this->model(VolumeType::class)->enumerate($this->api->getTypes(), []);
7564
}
7665

77-
/**
78-
* @param string $typeId
79-
*
80-
* @return VolumeType
81-
*/
8266
public function getVolumeType(string $typeId): VolumeType
8367
{
8468
$type = $this->model(VolumeType::class);
@@ -89,29 +73,19 @@ public function getVolumeType(string $typeId): VolumeType
8973

9074
/**
9175
* @param array $userOptions {@see Api::postSnapshots}
92-
*
93-
* @return Snapshot
9476
*/
9577
public function createSnapshot(array $userOptions): Snapshot
9678
{
9779
return $this->model(Snapshot::class)->create($userOptions);
9880
}
9981

100-
/**
101-
* @return \Generator
102-
*/
10382
public function listSnapshots(bool $detail = false, array $userOptions = []): \Generator
10483
{
10584
$def = (true === $detail) ? $this->api->getSnapshotsDetail() : $this->api->getSnapshots();
10685

10786
return $this->model(Snapshot::class)->enumerate($def, $userOptions);
10887
}
10988

110-
/**
111-
* @param string $snapshotId
112-
*
113-
* @return Snapshot
114-
*/
11589
public function getSnapshot(string $snapshotId): Snapshot
11690
{
11791
$snapshot = $this->model(Snapshot::class);
@@ -122,10 +96,6 @@ public function getSnapshot(string $snapshotId): Snapshot
12296

12397
/**
12498
* Shows A Quota for a tenant.
125-
*
126-
* @param string $tenantId
127-
*
128-
* @return QuotaSet
12999
*/
130100
public function getQuotaSet(string $tenantId): QuotaSet
131101
{

‎src/Common/Api/Operation.php‎

Lines changed: 0 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -44,17 +44,11 @@ public function __construct(array $definition)
4444
$this->params = self::toParamArray($definition['params']);
4545
}
4646

47-
/**
48-
* @return string
49-
*/
5047
public function getPath(): string
5148
{
5249
return $this->path;
5350
}
5451

55-
/**
56-
* @return string
57-
*/
5852
public function getMethod(): string
5953
{
6054
return $this->method;
@@ -64,8 +58,6 @@ public function getMethod(): string
6458
* Indicates whether this operation supports a parameter.
6559
*
6660
* @param $key The name of a parameter
67-
*
68-
* @return bool
6961
*/
7062
public function hasParam(string $key): bool
7163
{
@@ -82,9 +74,6 @@ public function getParam(string $name)
8274
return isset($this->params[$name]) ? $this->params[$name] : null;
8375
}
8476

85-
/**
86-
* @return string
87-
*/
8877
public function getJsonKey(): string
8978
{
9079
return $this->jsonKey ?: '';
@@ -95,8 +84,6 @@ public function getJsonKey(): string
9584
* {@see Parameter} objects.
9685
*
9786
* @param array $data A generic data array
98-
*
99-
* @return array
10087
*/
10188
public static function toParamArray(array $data): array
10289
{

‎src/Common/Api/OperatorInterface.php‎

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,6 @@ public function __construct(ClientInterface $client, ApiInterface $api);
2828
*
2929
* @param array $definition The data that dictates how the operation works
3030
* @param array $userValues The user-defined values that populate the request
31-
*
32-
* @return \Psr\Http\Message\ResponseInterface
3331
*/
3432
public function execute(array $definition, array $userValues = []): ResponseInterface;
3533

@@ -38,8 +36,6 @@ public function execute(array $definition, array $userValues = []): ResponseInte
3836
*
3937
* @param array $definition The data that dictates how the operation works
4038
* @param array $userValues The user-defined values that populate the request
41-
*
42-
* @return \GuzzleHttp\Promise\PromiseInterface
4339
*/
4440
public function executeAsync(array $definition, array $userValues = []): PromiseInterface;
4541

@@ -48,17 +44,13 @@ public function executeAsync(array $definition, array $userValues = []): Promise
4844
* HTTP client is also injected into the object to allow it to communicate with the remote API.
4945
*
5046
* @param array $definition The data that dictates how the operation works
51-
*
52-
* @return Operation
5347
*/
5448
public function getOperation(array $definition): Operation;
5549

5650
/**
5751
* @param string $class the name of the model class
5852
* @param mixed $data either a {@see ResponseInterface} or data array that will populate the newly
5953
* created model class
60-
*
61-
* @return \OpenStack\Common\Resource\ResourceInterface
6254
*/
6355
public function model(string $class, $data = null): ResourceInterface;
6456
}

‎src/Common/Api/OperatorTrait.php‎

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@
44

55
namespace OpenStack\Common\Api;
66

7-
use GuzzleHttp\Promise\PromiseInterface;
8-
use function GuzzleHttp\uri_template;
97
use GuzzleHttp\ClientInterface;
108
use GuzzleHttp\Promise\Promise;
9+
use GuzzleHttp\Promise\PromiseInterface;
10+
use function GuzzleHttp\uri_template;
1111
use OpenStack\Common\Resource\ResourceInterface;
1212
use OpenStack\Common\Transport\RequestSerializer;
1313
use Psr\Http\Message\ResponseInterface;
@@ -99,10 +99,6 @@ public function getOperation(array $definition): Operation
9999
}
100100

101101
/**
102-
* @param Operation $operation
103-
* @param array $userValues
104-
* @param bool $async
105-
*
106102
* @return mixed
107103
*
108104
* @throws \Exception

‎src/Common/Api/Parameter.php‎

Lines changed: 3 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -118,9 +118,6 @@ class Parameter
118118
*/
119119
private $enum;
120120

121-
/**
122-
* @param array $data
123-
*/
124121
public function __construct(array $data)
125122
{
126123
$this->hydrate($data);
@@ -163,8 +160,6 @@ private function stockProperties(array $data)
163160

164161
/**
165162
* Retrieve the name that will be used over the wire.
166-
*
167-
* @return string
168163
*/
169164
public function getName(): string
170165
{
@@ -173,8 +168,6 @@ public function getName(): string
173168

174169
/**
175170
* Indicates whether the user must provide a value for this parameter.
176-
*
177-
* @return bool
178171
*/
179172
public function isRequired(): bool
180173
{
@@ -207,24 +200,14 @@ public function validate($userValues): bool
207200
private function validateEnums($userValues)
208201
{
209202
if (!empty($this->enum) && 'string' == $this->type && !in_array($userValues, $this->enum)) {
210-
throw new \Exception(sprintf(
211-
'The only permitted values are %s. You provided %s',
212-
implode(', ', $this->enum),
213-
print_r($userValues, true)
214-
));
203+
throw new \Exception(sprintf('The only permitted values are %s. You provided %s', implode(', ', $this->enum), print_r($userValues, true)));
215204
}
216205
}
217206

218207
private function validateType($userValues)
219208
{
220209
if (!$this->hasCorrectType($userValues)) {
221-
throw new \Exception(sprintf(
222-
'The key provided "%s" has the wrong value type. You provided %s (%s) but was expecting %s',
223-
$this->name,
224-
print_r($userValues, true),
225-
gettype($userValues),
226-
$this->type
227-
));
210+
throw new \Exception(sprintf('The key provided "%s" has the wrong value type. You provided %s (%s) but was expecting %s', $this->name, print_r($userValues, true), gettype($userValues), $this->type));
228211
}
229212
}
230213

@@ -268,8 +251,6 @@ private function getNestedProperty($key): Parameter
268251
* by this parameter.
269252
*
270253
* @param $userValue The value being checked
271-
*
272-
* @return bool
273254
*/
274255
private function hasCorrectType($userValue): bool
275256
{
@@ -302,8 +283,6 @@ private function hasCorrectType($userValue): bool
302283

303284
/**
304285
* Indicates whether this parameter represents an array type.
305-
*
306-
* @return bool
307286
*/
308287
public function isArray(): bool
309288
{
@@ -312,8 +291,6 @@ public function isArray(): bool
312291

313292
/**
314293
* Indicates whether this parameter represents an object type.
315-
*
316-
* @return bool
317294
*/
318295
public function isObject(): bool
319296
{
@@ -329,8 +306,6 @@ public function getLocation(): string
329306
* Verifies whether the given location matches the parameter's location.
330307
*
331308
* @param $value
332-
*
333-
* @return bool
334309
*/
335310
public function hasLocation($value): bool
336311
{
@@ -359,8 +334,6 @@ public function getItemSchema()
359334

360335
/**
361336
* Sets the name of the parameter to a new value.
362-
*
363-
* @param string $name
364337
*/
365338
public function setName(string $name)
366339
{
@@ -372,7 +345,7 @@ public function setName(string $name)
372345
*
373346
* @param string $name The name of the child property
374347
*
375-
* @return null|Parameter
348+
* @return Parameter|null
376349
*/
377350
public function getProperty(string $name)
378351
{

0 commit comments

Comments
 (0)