Skip to content

Commit 0547039

Browse files
j0k3rj0k3r
authored
Merge pull request #41 from j0k3r/enable-phpstan
Enable PHPStan and type everything
2 parents 1ed3cc7 + b8c5139 commit 0547039

Some content is hidden

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

43 files changed

+865
-841
lines changed

‎.github/workflows/coding-standards.yml‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,3 +37,9 @@ jobs:
3737

3838
- name: "Run PHP CS Fixer"
3939
run: "vendor/bin/php-cs-fixer fix --verbose --dry-run"
40+
41+
- name: "Install PHPUnit for PHPStan"
42+
run: "php vendor/bin/simple-phpunit install"
43+
44+
- name: "Run PHPStan"
45+
run: "php vendor/bin/phpstan analyse --no-progress"

‎.github/workflows/continuous-integration.yml‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,6 @@ jobs:
1919
strategy:
2020
matrix:
2121
php:
22-
- "7.2"
23-
- "7.3"
2422
- "7.4"
2523
- "8.0"
2624
- "8.1"

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Uses [Imgur API v3](https://api.imgur.com/).
1515
* Branch [1.x](https://github.com/j0k3r/php-imgur-api-client/tree/1.x) use Guzzle 3 (but is not maintained)
1616
* Branch [2.x](https://github.com/j0k3r/php-imgur-api-client/tree/2.x) use Guzzle 5 (but is not maintained)
1717
* Branch [3.x](https://github.com/j0k3r/php-imgur-api-client/tree/3.x) use Guzzle 6 and PHP >= 5.6
18-
* Branch [master](https://github.com/j0k3r/php-imgur-api-client/tree/master) use Guzzle 7 and PHP >= 7.2.5
18+
* Branch [master](https://github.com/j0k3r/php-imgur-api-client/tree/master) use Guzzle 7 and PHP >= 7.4
1919

2020
## Composer
2121

‎composer.json‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,12 +34,16 @@
3434
}
3535
},
3636
"require": {
37-
"php": ">=7.2.5",
37+
"php": ">=7.4",
3838
"ext-curl": "*",
3939
"guzzlehttp/guzzle": "^7.0"
4040
},
4141
"require-dev": {
4242
"friendsofphp/php-cs-fixer": "^3.0",
43+
"phpstan/extension-installer": "^1.1",
44+
"phpstan/phpstan": "^1.2",
45+
"phpstan/phpstan-deprecation-rules": "^1.0",
46+
"phpstan/phpstan-phpunit": "^1.0",
4347
"symfony/phpunit-bridge": "^6.0"
4448
},
4549
"config": {

‎lib/Imgur/Api/AbstractApi.php‎

Lines changed: 14 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,12 @@
1414
abstract class AbstractApi
1515
{
1616
/**
17-
* @var \Imgur\Client
17+
* @var Client
1818
*/
1919
protected $client;
2020

2121
/**
22-
* @var \Imgur\Pager\PagerInterface
22+
* @var PagerInterface
2323
*/
2424
protected $pager;
2525

@@ -31,16 +31,12 @@ public function __construct(Client $client, PagerInterface $pager = null)
3131

3232
/**
3333
* Perform a GET request and return the parsed response.
34-
*
35-
* @param string $url
36-
*
37-
* @return array
3834
*/
39-
public function get($url, $parameters = [])
35+
public function get(string $url, array $parameters = []): array
4036
{
4137
$httpClient = $this->client->getHttpClient();
4238

43-
if (!empty($this->pager)) {
39+
if (null !== $this->pager) {
4440
$parameters['page'] = $this->pager->getPage();
4541
$parameters['perPage'] = $this->pager->getResultsPerPage();
4642
}
@@ -52,12 +48,8 @@ public function get($url, $parameters = [])
5248

5349
/**
5450
* Perform a POST request and return the parsed response.
55-
*
56-
* @param string $url
57-
*
58-
* @return array
5951
*/
60-
public function post($url, $parameters = [])
52+
public function post(string $url, array $parameters = []): array
6153
{
6254
$httpClient = $this->client->getHttpClient();
6355

@@ -68,12 +60,8 @@ public function post($url, $parameters = [])
6860

6961
/**
7062
* Perform a PUT request and return the parsed response.
71-
*
72-
* @param string $url
73-
*
74-
* @return array
7563
*/
76-
public function put($url, $parameters = [])
64+
public function put(string $url, array $parameters = []): array
7765
{
7866
$httpClient = $this->client->getHttpClient();
7967

@@ -84,12 +72,8 @@ public function put($url, $parameters = [])
8472

8573
/**
8674
* Perform a DELETE request and return the parsed response.
87-
*
88-
* @param string $url
89-
*
90-
* @return array
9175
*/
92-
public function delete($url, $parameters = [])
76+
public function delete(string $url, array $parameters = []): array
9377
{
9478
$httpClient = $this->client->getHttpClient();
9579

@@ -101,32 +85,29 @@ public function delete($url, $parameters = [])
10185
/**
10286
* Validate "sort" parameter and throw an exception if it's a bad value.
10387
*
104-
* @param string $sort Input value
105-
* @param array $possibleValues
88+
* @param string $sort Input value
10689
*/
107-
protected function validateSortArgument($sort, $possibleValues)
90+
protected function validateSortArgument(string $sort, array $possibleValues): void
10891
{
10992
$this->validateArgument('Sort', $sort, $possibleValues);
11093
}
11194

11295
/**
11396
* Validate "window" parameter and throw an exception if it's a bad value.
11497
*
115-
* @param string $window Input value
116-
* @param array $possibleValues
98+
* @param string $window Input value
11799
*/
118-
protected function validateWindowArgument($window, $possibleValues)
100+
protected function validateWindowArgument(string $window, array $possibleValues): void
119101
{
120102
$this->validateArgument('Window', $window, $possibleValues);
121103
}
122104

123105
/**
124106
* Validate "vote" parameter and throw an exception if it's a bad value.
125107
*
126-
* @param string $vote Input value
127-
* @param array $possibleValues
108+
* @param string $vote Input value
128109
*/
129-
protected function validateVoteArgument($vote, $possibleValues)
110+
protected function validateVoteArgument(string $vote, array $possibleValues): void
130111
{
131112
$this->validateArgument('Vote', $vote, $possibleValues);
132113
}
@@ -138,7 +119,7 @@ protected function validateVoteArgument($vote, $possibleValues)
138119
* @param string $input Input value
139120
* @param array $possibleValues Possible values for this argument
140121
*/
141-
private function validateArgument($type, $input, $possibleValues)
122+
private function validateArgument(string $type, string $input, array $possibleValues): void
142123
{
143124
if (!\in_array($input, $possibleValues, true)) {
144125
throw new InvalidArgumentException($type . ' parameter "' . $input . '" is wrong. Possible values are: ' . implode(', ', $possibleValues));

‎lib/Imgur/Api/Account.php‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ public function base($username = 'me')
3131
*
3232
* @param string $username
3333
*
34-
* @return bool
34+
* @return array (@see https://api.imgur.com/models/basic)
3535
*/
3636
public function deleteAccount($username)
3737
{
@@ -106,7 +106,7 @@ public function settings($username = 'me')
106106
*
107107
* @see https://api.imgur.com/endpoints/account#update-settings
108108
*
109-
* @return bool
109+
* @return array (@see https://api.imgur.com/models/basic)
110110
*/
111111
public function changeAccountSettings($parameters)
112112
{
@@ -147,7 +147,7 @@ public function accountGalleryProfile($username = 'me')
147147
*
148148
* @see https://api.imgur.com/endpoints/account#verify-email
149149
*
150-
* @return bool
150+
* @return array (@see https://api.imgur.com/models/basic)
151151
*/
152152
public function verifyUsersEmail($username = 'me')
153153
{
@@ -161,7 +161,7 @@ public function verifyUsersEmail($username = 'me')
161161
*
162162
* @see https://api.imgur.com/endpoints/account#send-verify-email
163163
*
164-
* @return bool
164+
* @return array (@see https://api.imgur.com/models/basic)
165165
*/
166166
public function sendVerificationEmail($username = 'me')
167167
{
@@ -207,7 +207,7 @@ public function album($albumId, $username = 'me')
207207
*
208208
* @see https://api.imgur.com/endpoints/account#album-ids
209209
*
210-
* @return array<int>
210+
* @return array (@see https://api.imgur.com/models/basic)
211211
*/
212212
public function albumIds($username = 'me', $page = 0)
213213
{
@@ -221,7 +221,7 @@ public function albumIds($username = 'me', $page = 0)
221221
*
222222
* @see https://api.imgur.com/endpoints/account#album-count
223223
*
224-
* @return int
224+
* @return array (@see https://api.imgur.com/models/basic)
225225
*/
226226
public function albumCount($username = 'me')
227227
{
@@ -236,7 +236,7 @@ public function albumCount($username = 'me')
236236
*
237237
* @see https://api.imgur.com/endpoints/account#album-delete
238238
*
239-
* @return bool
239+
* @return array (@see https://api.imgur.com/models/basic)
240240
*/
241241
public function albumDelete($albumId, $username = 'me')
242242
{
@@ -286,7 +286,7 @@ public function comment($commentId, $username = 'me')
286286
*
287287
* @see https://api.imgur.com/endpoints/account#comment-ids
288288
*
289-
* @return array<int>
289+
* @return array (@see https://api.imgur.com/models/basic)
290290
*/
291291
public function commentIds($username = 'me', $page = 0, $sort = 'newest')
292292
{
@@ -302,7 +302,7 @@ public function commentIds($username = 'me', $page = 0, $sort = 'newest')
302302
*
303303
* @see https://api.imgur.com/endpoints/account#comment-count
304304
*
305-
* @return int
305+
* @return array (@see https://api.imgur.com/models/basic)
306306
*/
307307
public function commentCount($username = 'me')
308308
{
@@ -317,7 +317,7 @@ public function commentCount($username = 'me')
317317
*
318318
* @see https://api.imgur.com/endpoints/account#comment-delete
319319
*
320-
* @return bool
320+
* @return array (@see https://api.imgur.com/models/basic)
321321
*/
322322
public function commentDelete($commentId, $username = 'me')
323323
{
@@ -364,7 +364,7 @@ public function image($imageId, $username = 'me')
364364
*
365365
* @see https://api.imgur.com/endpoints/account#image-ids
366366
*
367-
* @return array<int>
367+
* @return array (@see https://api.imgur.com/models/basic)
368368
*/
369369
public function imageIds($username = 'me', $page = 0)
370370
{
@@ -378,7 +378,7 @@ public function imageIds($username = 'me', $page = 0)
378378
*
379379
* @see https://api.imgur.com/endpoints/account#image-count
380380
*
381-
* @return int
381+
* @return array (@see https://api.imgur.com/models/basic)
382382
*/
383383
public function imageCount($username = 'me')
384384
{
@@ -393,7 +393,7 @@ public function imageCount($username = 'me')
393393
*
394394
* @see https://api.imgur.com/endpoints/account#image-delete
395395
*
396-
* @return bool
396+
* @return array (@see https://api.imgur.com/models/basic)
397397
*/
398398
public function imageDelete($deleteHash, $username = 'me')
399399
{

‎lib/Imgur/Api/Album.php‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ public function albumImage($albumId, $imageId)
6464
*
6565
* @see https://api.imgur.com/endpoints/album#album-upload
6666
*
67-
* @return bool
67+
* @return array (@see https://api.imgur.com/models/basic)
6868
*/
6969
public function create($data)
7070
{
@@ -80,7 +80,7 @@ public function create($data)
8080
*
8181
* @see https://api.imgur.com/endpoints/album#album-update
8282
*
83-
* @return bool
83+
* @return array (@see https://api.imgur.com/models/basic)
8484
*/
8585
public function update($deletehashOrAlbumId, $data)
8686
{
@@ -96,7 +96,7 @@ public function update($deletehashOrAlbumId, $data)
9696
*
9797
* @see https://api.imgur.com/endpoints/album#album-delete
9898
*
99-
* @return bool
99+
* @return array (@see https://api.imgur.com/models/basic)
100100
*/
101101
public function deleteAlbum($deletehashOrAlbumId)
102102
{
@@ -110,7 +110,7 @@ public function deleteAlbum($deletehashOrAlbumId)
110110
*
111111
* @see https://api.imgur.com/endpoints/album#album-favorite
112112
*
113-
* @return bool
113+
* @return array (@see https://api.imgur.com/models/basic)
114114
*/
115115
public function favoriteAlbum($albumId)
116116
{
@@ -125,7 +125,7 @@ public function favoriteAlbum($albumId)
125125
*
126126
* @see https://api.imgur.com/endpoints/album#album-set-to
127127
*
128-
* @return bool
128+
* @return array (@see https://api.imgur.com/models/basic)
129129
*/
130130
public function setAlbumImages($albumId, array $imageIds)
131131
{
@@ -140,7 +140,7 @@ public function setAlbumImages($albumId, array $imageIds)
140140
*
141141
* @see https://api.imgur.com/endpoints/album#album-add-to
142142
*
143-
* @return bool
143+
* @return array (@see https://api.imgur.com/models/basic)
144144
*/
145145
public function addImages($albumId, array $imageIds)
146146
{
@@ -155,7 +155,7 @@ public function addImages($albumId, array $imageIds)
155155
*
156156
* @see https://api.imgur.com/endpoints/album#album-remove-from
157157
*
158-
* @return bool
158+
* @return array (@see https://api.imgur.com/models/basic)
159159
*/
160160
public function removeImages($deletehashOrAlbumId, array $imageIds)
161161
{

‎lib/Imgur/Api/Comment.php‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ public function comment($commentId)
3434
*
3535
* @see https://api.imgur.com/endpoints/comment#comment-create
3636
*
37-
* @return bool
37+
* @return array (@see https://api.imgur.com/models/basic)
3838
*/
3939
public function create($data)
4040
{
@@ -52,7 +52,7 @@ public function create($data)
5252
*
5353
* @see https://api.imgur.com/endpoints/comment#comment-delete
5454
*
55-
* @return bool
55+
* @return array (@see https://api.imgur.com/models/basic)
5656
*/
5757
public function deleteComment($commentId)
5858
{
@@ -81,7 +81,7 @@ public function replies($commentId)
8181
*
8282
* @see https://api.imgur.com/endpoints/comment#comment-reply-create
8383
*
84-
* @return bool
84+
* @return array (@see https://api.imgur.com/models/basic)
8585
*/
8686
public function createReply($commentId, $data)
8787
{
@@ -100,7 +100,7 @@ public function createReply($commentId, $data)
100100
*
101101
* @see https://api.imgur.com/endpoints/comment#comment-vote
102102
*
103-
* @return bool
103+
* @return array (@see https://api.imgur.com/models/basic)
104104
*/
105105
public function vote($commentId, $vote)
106106
{
@@ -116,7 +116,7 @@ public function vote($commentId, $vote)
116116
*
117117
* @see https://api.imgur.com/endpoints/comment#comment-report
118118
*
119-
* @return bool
119+
* @return array (@see https://api.imgur.com/models/basic)
120120
*/
121121
public function report($commentId)
122122
{

0 commit comments

Comments
 (0)