Skip to content

Commit 4cab560

Browse files
GrahamCampbellGrahamCampbell
committed
Backport phpdoc fixes (#518)
1 parent a0a39dc commit 4cab560

File tree

11 files changed

+65
-69
lines changed

11 files changed

+65
-69
lines changed

‎.travis.yml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,15 +9,14 @@ php:
99
- 7.4
1010

1111
matrix:
12-
# test latest PHP stable version with lowest dependencies and phpstan static analysis
1312
include:
1413
- php: 7.3
1514
env: STATIC_ANALYSIS=yes
1615

1716
before_script:
1817
- travis_retry composer self-update
1918
- travis_retry composer update --no-interaction ${COMPOSER_FLAGS}
20-
- if [ "$STATIC_ANALYSIS" != "" ]; then curl -L https://github.com/phpstan/phpstan/releases/download/0.8/phpstan.phar -o phpstan.phar; fi;
19+
- if [ "$STATIC_ANALYSIS" != "" ]; then curl -L https://github.com/phpstan/phpstan/releases/download/0.10.8/phpstan.phar -o phpstan.phar; fi;
2120

2221
script:
2322
- vendor/bin/phpunit --verbose --coverage-text

‎lib/Gitlab/Api/AbstractApi.php

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,13 +21,15 @@
2121
abstract class AbstractApi implements ApiInterface
2222
{
2323
/**
24-
* The client
24+
* The client instance.
2525
*
2626
* @var Client
2727
*/
2828
protected $client;
2929

3030
/**
31+
* The HTTP stream factory.
32+
*
3133
* @var StreamFactory
3234
*/
3335
private $streamFactory;
@@ -44,7 +46,6 @@ public function __construct(Client $client, StreamFactory $streamFactory = null)
4446

4547
/**
4648
* @return $this
47-
* @codeCoverageIgnore
4849
*/
4950
public function configure()
5051
{
@@ -248,7 +249,7 @@ private function preparePath($path, array $parameters = [])
248249
}
249250

250251
/**
251-
* @param $file
252+
* @param string $file
252253
*
253254
* @return string
254255
*/

‎lib/Gitlab/Api/Groups.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -157,7 +157,7 @@ public function removeMember($group_id, $user_id)
157157
}
158158

159159
/**
160-
* @param $id
160+
* @param int $id
161161
* @param array $parameters (
162162
*
163163
* @var bool $archived Limit by archived status.

‎lib/Gitlab/Api/MergeRequests.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,7 @@ public function update($project_id, $mr_id, array $params)
146146
/**
147147
* @param int $project_id
148148
* @param int $mr_id
149-
* @param string $message
149+
* @param string|array|null $message
150150
* @return mixed
151151
*/
152152
public function merge($project_id, $mr_id, $message = null)

‎lib/Gitlab/Api/Projects.php

Lines changed: 41 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -115,37 +115,37 @@ public function show($project_id, array $parameters = [])
115115

116116
/**
117117
* @param string $name
118-
* @param array $params
118+
* @param array $parameters
119119
* @return mixed
120120
*/
121-
public function create($name, array $params = array())
121+
public function create($name, array $parameters = array())
122122
{
123-
$params['name'] = $name;
123+
$parameters['name'] = $name;
124124

125-
return $this->post('projects', $params);
125+
return $this->post('projects', $parameters);
126126
}
127127

128128
/**
129129
* @param int $user_id
130130
* @param string $name
131-
* @param array $params
131+
* @param array $parameters
132132
* @return mixed
133133
*/
134-
public function createForUser($user_id, $name, array $params = array())
134+
public function createForUser($user_id, $name, array $parameters = array())
135135
{
136-
$params['name'] = $name;
136+
$parameters['name'] = $name;
137137

138-
return $this->post('projects/user/'.$this->encodePath($user_id), $params);
138+
return $this->post('projects/user/'.$this->encodePath($user_id), $parameters);
139139
}
140140

141141
/**
142142
* @param int $project_id
143-
* @param array $params
143+
* @param array $parameters
144144
* @return mixed
145145
*/
146-
public function update($project_id, array $params)
146+
public function update($project_id, array $parameters)
147147
{
148-
return $this->put('projects/'.$this->encodePath($project_id), $params);
148+
return $this->put('projects/'.$this->encodePath($project_id), $parameters);
149149
}
150150

151151
/**
@@ -278,8 +278,8 @@ public function cancelPipeline($project_id, $pipeline_id)
278278
}
279279

280280
/**
281-
* @param $project_id
282-
* @param $pipeline_id
281+
* @param int $project_id
282+
* @param int $pipeline_id
283283
* @return mixed
284284
*/
285285
public function deletePipeline($project_id, $pipeline_id)
@@ -307,8 +307,6 @@ public function allMembers($project_id, $parameters = [])
307307
* @var string $query The query you want to search members for.
308308
* )
309309
*
310-
* @throws MissingOptionsException If a required option is not provided
311-
*
312310
* @return mixed
313311
*/
314312
public function members($project_id, $parameters = [])
@@ -455,29 +453,29 @@ public function boards($project_id)
455453
/**
456454
* @param int $project_id
457455
* @param string $url
458-
* @param array $params
456+
* @param array $parameters
459457
* @return mixed
460458
*/
461-
public function addHook($project_id, $url, array $params = array())
459+
public function addHook($project_id, $url, array $parameters = array())
462460
{
463-
if (empty($params)) {
464-
$params = array('push_events' => true);
461+
if (empty($parameters)) {
462+
$parameters = array('push_events' => true);
465463
}
466464

467-
$params['url'] = $url;
465+
$parameters['url'] = $url;
468466

469-
return $this->post($this->getProjectPath($project_id, 'hooks'), $params);
467+
return $this->post($this->getProjectPath($project_id, 'hooks'), $parameters);
470468
}
471469

472470
/**
473471
* @param int $project_id
474472
* @param int $hook_id
475-
* @param array $params
473+
* @param array $parameters
476474
* @return mixed
477475
*/
478-
public function updateHook($project_id, $hook_id, array $params)
476+
public function updateHook($project_id, $hook_id, array $parameters)
479477
{
480-
return $this->put($this->getProjectPath($project_id, 'hooks/'.$this->encodePath($hook_id)), $params);
478+
return $this->put($this->getProjectPath($project_id, 'hooks/'.$this->encodePath($hook_id)), $parameters);
481479
}
482480

483481
/**
@@ -609,22 +607,22 @@ public function labels($project_id, array $parameters = [])
609607

610608
/**
611609
* @param int $project_id
612-
* @param array $params
610+
* @param array $parameters
613611
* @return mixed
614612
*/
615-
public function addLabel($project_id, array $params)
613+
public function addLabel($project_id, array $parameters)
616614
{
617-
return $this->post($this->getProjectPath($project_id, 'labels'), $params);
615+
return $this->post($this->getProjectPath($project_id, 'labels'), $parameters);
618616
}
619617

620618
/**
621619
* @param int $project_id
622-
* @param array $params
620+
* @param array $parameters
623621
* @return mixed
624622
*/
625-
public function updateLabel($project_id, array $params)
623+
public function updateLabel($project_id, array $parameters)
626624
{
627-
return $this->put($this->getProjectPath($project_id, 'labels'), $params);
625+
return $this->put($this->getProjectPath($project_id, 'labels'), $parameters);
628626
}
629627

630628
/**
@@ -664,7 +662,7 @@ public function forks($project_id, array $parameters = [])
664662

665663
/**
666664
* @param int $project_id
667-
* @param array $params (
665+
* @param array $parameters (
668666
*
669667
* @var string $namespace The ID or path of the namespace that the project will be forked to
670668
* @var string $path The path of the forked project (optional)
@@ -704,12 +702,12 @@ public function removeForkRelation($project_id)
704702
/**
705703
* @param int $project_id
706704
* @param string $service_name
707-
* @param array $params
705+
* @param array $parameters
708706
* @return mixed
709707
*/
710-
public function setService($project_id, $service_name, array $params = array())
708+
public function setService($project_id, $service_name, array $parameters = array())
711709
{
712-
return $this->put($this->getProjectPath($project_id, 'services/'.$this->encodePath($service_name)), $params);
710+
return $this->put($this->getProjectPath($project_id, 'services/'.$this->encodePath($service_name)), $parameters);
713711
}
714712

715713
/**
@@ -896,12 +894,12 @@ public function badge($project_id, $badge_id)
896894

897895
/**
898896
* @param int $project_id
899-
* @param array $params
897+
* @param array $parameters
900898
* @return mixed
901899
*/
902-
public function addBadge($project_id, array $params = array())
900+
public function addBadge($project_id, array $parameters = array())
903901
{
904-
return $this->post($this->getProjectPath($project_id, 'badges'), $params);
902+
return $this->post($this->getProjectPath($project_id, 'badges'), $parameters);
905903
}
906904

907905
/**
@@ -917,22 +915,22 @@ public function removeBadge($project_id, $badge_id)
917915
/**
918916
* @param int $project_id
919917
* @param string $badge_id
920-
* @param array $params
918+
* @param array $parameters
921919
* @return mixed
922920
*/
923-
public function updateBadge($project_id, $badge_id, array $params = array())
921+
public function updateBadge($project_id, $badge_id, array $parameters = array())
924922
{
925-
return $this->put($this->getProjectPath($project_id, 'badges/' . $this->encodePath($badge_id)), $params);
923+
return $this->put($this->getProjectPath($project_id, 'badges/' . $this->encodePath($badge_id)), $parameters);
926924
}
927925

928926

929927
/**
930928
* @param int $project_id
931-
* @param array $params
929+
* @param array $parameters
932930
* @return mixed
933931
*/
934-
public function addProtectedBranch($project_id, array $params = [])
932+
public function addProtectedBranch($project_id, array $parameters = [])
935933
{
936-
return $this->post($this->getProjectPath($project_id, 'protected_branches'), $params);
934+
return $this->post($this->getProjectPath($project_id, 'protected_branches'), $parameters);
937935
}
938936
}

‎lib/Gitlab/Api/Repositories.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -188,7 +188,7 @@ public function commits($project_id, array $parameters = [])
188188

189189
/**
190190
* @param int $project_id
191-
* @param $sha
191+
* @param string $sha
192192
* @return mixed
193193
*/
194194
public function commit($project_id, $sha)
@@ -198,7 +198,7 @@ public function commit($project_id, $sha)
198198

199199
/**
200200
* @param int $project_id
201-
* @param $sha
201+
* @param string $sha
202202
* @param array $parameters
203203
* @return mixed
204204
*/

‎lib/Gitlab/Api/Users.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -323,7 +323,7 @@ public function emails()
323323
}
324324

325325
/**
326-
* @param $id
326+
* @param int $id
327327
* @return mixed
328328
*/
329329
public function email($id)

‎lib/Gitlab/HttpClient/Plugin/History.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ class History implements Journal
1616
use HistoryTrait;
1717

1818
/**
19-
* @var ResponseInterface
19+
* @var ResponseInterface|null
2020
*/
2121
private $lastResponse;
2222

‎lib/Gitlab/Model/GroupMilestone.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ public static function fromArray(Client $client, Group $group, array $data)
5454
/**
5555
* GroupMilestone constructor.
5656
* @param Group $group
57-
* @param $id
57+
* @param int $id
5858
* @param Client|null $client
5959
*/
6060
public function __construct(Group $group, $id, Client $client = null)

‎lib/Gitlab/Model/Project.php

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -530,7 +530,7 @@ public function commit($sha)
530530
* @param string $ref
531531
* @param array $parameters
532532
*
533-
* @return Commit[]
533+
* @return CommitNote[]
534534
* @see Repositories::commitComments() for available parameters.
535535
*
536536
*/
@@ -607,8 +607,8 @@ public function blob($sha, $filepath)
607607
}
608608

609609
/**
610-
* @param $sha
611-
* @param $filepath
610+
* @param string $sha
611+
* @param string $filepath
612612
*
613613
* @return array
614614
*/
@@ -622,8 +622,8 @@ public function getFile($sha, $filepath)
622622
* @param string $content
623623
* @param string $branch_name
624624
* @param string $commit_message
625-
* @param string $author_email
626-
* @param string $author_name
625+
* @param string|null $author_email
626+
* @param string|null $author_name
627627
* @return File
628628
*/
629629
public function createFile(
@@ -1257,8 +1257,7 @@ public function badges()
12571257
}
12581258

12591259
/**
1260-
* @param string $link_url
1261-
* @param string $color
1260+
* @param array $params
12621261
* @return Badge
12631262
*/
12641263
public function addBadge(array $params)
@@ -1269,7 +1268,7 @@ public function addBadge(array $params)
12691268
}
12701269

12711270
/**
1272-
* @param string $name
1271+
* @param int $badge_id
12731272
* @param array $params
12741273
* @return Badge
12751274
*/
@@ -1283,7 +1282,7 @@ public function updateBadge($badge_id, array $params)
12831282
}
12841283

12851284
/**
1286-
* @param string $name
1285+
* @param int $badge_id
12871286
* @return bool
12881287
*/
12891288
public function removeBadge($badge_id)
@@ -1300,6 +1299,7 @@ public function removeBadge($badge_id)
13001299
public function addProtectedBranch(array $params = [])
13011300
{
13021301
$data = $this->client->projects()->addProtectedBranch($this->id, $params);
1302+
13031303
return Branch::fromArray($this->getClient(), $this, $data);
13041304
}
13051305
}

0 commit comments

Comments
 (0)