Skip to content

Commit aee8440

Browse files
GrahamCampbellGrahamCampbell
committed
Deprecated models API
1 parent 3ff8eeb commit aee8440

38 files changed

+405
-0
lines changed

‎CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ CHANGE LOG
88
* Added with_merge_status_recheck option for fetching MRs
99
* Added commit cherry-pick API
1010
* Added support for optional Note parameters
11+
* Deprecated models API
1112

1213

1314
## 10.0.1 (24/10/2020)

‎composer.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@
3434
"psr/http-client-implementation": "^1.0",
3535
"psr/http-factory-implementation": "^1.0",
3636
"psr/http-message": "^1.0",
37+
"symfony/deprecation-contracts": "^2.1",
3738
"symfony/options-resolver": "^3.4 || ^4.0 || ^5.0",
3839
"symfony/polyfill-php80": "^1.17"
3940
},

‎phpstan-baseline.neon

Lines changed: 288 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,123 @@ parameters:
55
count: 1
66
path: src/Api/AbstractApi.php
77

8+
-
9+
message:
10+
"""
11+
#^Class Gitlab\\\\Model\\\\Badge extends deprecated class Gitlab\\\\Model\\\\AbstractModel\\:
12+
since version 10\\.1 and will be removed in 11\\.0\\.$#
13+
"""
14+
count: 1
15+
path: src/Model/Badge.php
16+
17+
-
18+
message:
19+
"""
20+
#^Class Gitlab\\\\Model\\\\Branch extends deprecated class Gitlab\\\\Model\\\\AbstractModel\\:
21+
since version 10\\.1 and will be removed in 11\\.0\\.$#
22+
"""
23+
count: 1
24+
path: src/Model/Branch.php
25+
26+
-
27+
message:
28+
"""
29+
#^Class Gitlab\\\\Model\\\\Commit extends deprecated class Gitlab\\\\Model\\\\AbstractModel\\:
30+
since version 10\\.1 and will be removed in 11\\.0\\.$#
31+
"""
32+
count: 1
33+
path: src/Model/Commit.php
34+
35+
-
36+
message:
37+
"""
38+
#^Class Gitlab\\\\Model\\\\CommitNote extends deprecated class Gitlab\\\\Model\\\\AbstractModel\\:
39+
since version 10\\.1 and will be removed in 11\\.0\\.$#
40+
"""
41+
count: 1
42+
path: src/Model/CommitNote.php
43+
44+
-
45+
message:
46+
"""
47+
#^Class Gitlab\\\\Model\\\\Comparison extends deprecated class Gitlab\\\\Model\\\\AbstractModel\\:
48+
since version 10\\.1 and will be removed in 11\\.0\\.$#
49+
"""
50+
count: 1
51+
path: src/Model/Comparison.php
52+
53+
-
54+
message:
55+
"""
56+
#^Class Gitlab\\\\Model\\\\Contributor extends deprecated class Gitlab\\\\Model\\\\AbstractModel\\:
57+
since version 10\\.1 and will be removed in 11\\.0\\.$#
58+
"""
59+
count: 1
60+
path: src/Model/Contributor.php
61+
62+
-
63+
message:
64+
"""
65+
#^Class Gitlab\\\\Model\\\\Diff extends deprecated class Gitlab\\\\Model\\\\AbstractModel\\:
66+
since version 10\\.1 and will be removed in 11\\.0\\.$#
67+
"""
68+
count: 1
69+
path: src/Model/Diff.php
70+
71+
-
72+
message:
73+
"""
74+
#^Class Gitlab\\\\Model\\\\Event extends deprecated class Gitlab\\\\Model\\\\AbstractModel\\:
75+
since version 10\\.1 and will be removed in 11\\.0\\.$#
76+
"""
77+
count: 1
78+
path: src/Model/Event.php
79+
80+
-
81+
message:
82+
"""
83+
#^Class Gitlab\\\\Model\\\\File extends deprecated class Gitlab\\\\Model\\\\AbstractModel\\:
84+
since version 10\\.1 and will be removed in 11\\.0\\.$#
85+
"""
86+
count: 1
87+
path: src/Model/File.php
88+
89+
-
90+
message:
91+
"""
92+
#^Class Gitlab\\\\Model\\\\Group extends deprecated class Gitlab\\\\Model\\\\AbstractModel\\:
93+
since version 10\\.1 and will be removed in 11\\.0\\.$#
94+
"""
95+
count: 1
96+
path: src/Model/Group.php
97+
98+
-
99+
message:
100+
"""
101+
#^Class Gitlab\\\\Model\\\\GroupMilestone extends deprecated class Gitlab\\\\Model\\\\AbstractModel\\:
102+
since version 10\\.1 and will be removed in 11\\.0\\.$#
103+
"""
104+
count: 1
105+
path: src/Model/GroupMilestone.php
106+
107+
-
108+
message:
109+
"""
110+
#^Class Gitlab\\\\Model\\\\Hook extends deprecated class Gitlab\\\\Model\\\\AbstractModel\\:
111+
since version 10\\.1 and will be removed in 11\\.0\\.$#
112+
"""
113+
count: 1
114+
path: src/Model/Hook.php
115+
116+
-
117+
message:
118+
"""
119+
#^Class Gitlab\\\\Model\\\\Issue extends deprecated class Gitlab\\\\Model\\\\AbstractModel\\:
120+
since version 10\\.1 and will be removed in 11\\.0\\.$#
121+
"""
122+
count: 1
123+
path: src/Model/Issue.php
124+
8125
-
9126
message: "#^Return type \\(Gitlab\\\\Model\\\\Issue\\) of method Gitlab\\\\Model\\\\Issue\\:\\:close\\(\\) should be covariant with return type \\(static\\(Gitlab\\\\Model\\\\Stateful\\)\\) of method Gitlab\\\\Model\\\\Stateful\\:\\:close\\(\\)$#"
10127
count: 1
@@ -20,6 +137,51 @@ parameters:
20137
count: 1
21138
path: src/Model/Issue.php
22139

140+
-
141+
message:
142+
"""
143+
#^Class Gitlab\\\\Model\\\\IssueLink extends deprecated class Gitlab\\\\Model\\\\AbstractModel\\:
144+
since version 10\\.1 and will be removed in 11\\.0\\.$#
145+
"""
146+
count: 1
147+
path: src/Model/IssueLink.php
148+
149+
-
150+
message:
151+
"""
152+
#^Class Gitlab\\\\Model\\\\Job extends deprecated class Gitlab\\\\Model\\\\AbstractModel\\:
153+
since version 10\\.1 and will be removed in 11\\.0\\.$#
154+
"""
155+
count: 1
156+
path: src/Model/Job.php
157+
158+
-
159+
message:
160+
"""
161+
#^Class Gitlab\\\\Model\\\\Key extends deprecated class Gitlab\\\\Model\\\\AbstractModel\\:
162+
since version 10\\.1 and will be removed in 11\\.0\\.$#
163+
"""
164+
count: 1
165+
path: src/Model/Key.php
166+
167+
-
168+
message:
169+
"""
170+
#^Class Gitlab\\\\Model\\\\Label extends deprecated class Gitlab\\\\Model\\\\AbstractModel\\:
171+
since version 10\\.1 and will be removed in 11\\.0\\.$#
172+
"""
173+
count: 1
174+
path: src/Model/Label.php
175+
176+
-
177+
message:
178+
"""
179+
#^Class Gitlab\\\\Model\\\\MergeRequest extends deprecated class Gitlab\\\\Model\\\\AbstractModel\\:
180+
since version 10\\.1 and will be removed in 11\\.0\\.$#
181+
"""
182+
count: 1
183+
path: src/Model/MergeRequest.php
184+
23185
-
24186
message: "#^Return type \\(Gitlab\\\\Model\\\\MergeRequest\\) of method Gitlab\\\\Model\\\\MergeRequest\\:\\:close\\(\\) should be covariant with return type \\(static\\(Gitlab\\\\Model\\\\Stateful\\)\\) of method Gitlab\\\\Model\\\\Stateful\\:\\:close\\(\\)$#"
25187
count: 1
@@ -35,6 +197,132 @@ parameters:
35197
count: 1
36198
path: src/Model/MergeRequest.php
37199

200+
-
201+
message:
202+
"""
203+
#^Class Gitlab\\\\Model\\\\Milestone extends deprecated class Gitlab\\\\Model\\\\AbstractModel\\:
204+
since version 10\\.1 and will be removed in 11\\.0\\.$#
205+
"""
206+
count: 1
207+
path: src/Model/Milestone.php
208+
209+
-
210+
message:
211+
"""
212+
#^Class Gitlab\\\\Model\\\\Node extends deprecated class Gitlab\\\\Model\\\\AbstractModel\\:
213+
since version 10\\.1 and will be removed in 11\\.0\\.$#
214+
"""
215+
count: 1
216+
path: src/Model/Node.php
217+
218+
-
219+
message:
220+
"""
221+
#^Class Gitlab\\\\Model\\\\Note extends deprecated class Gitlab\\\\Model\\\\AbstractModel\\:
222+
since version 10\\.1 and will be removed in 11\\.0\\.$#
223+
"""
224+
count: 1
225+
path: src/Model/Note.php
226+
227+
-
228+
message:
229+
"""
230+
#^Class Gitlab\\\\Model\\\\Pipeline extends deprecated class Gitlab\\\\Model\\\\AbstractModel\\:
231+
since version 10\\.1 and will be removed in 11\\.0\\.$#
232+
"""
233+
count: 1
234+
path: src/Model/Pipeline.php
235+
236+
-
237+
message:
238+
"""
239+
#^Class Gitlab\\\\Model\\\\Project extends deprecated class Gitlab\\\\Model\\\\AbstractModel\\:
240+
since version 10\\.1 and will be removed in 11\\.0\\.$#
241+
"""
242+
count: 1
243+
path: src/Model/Project.php
244+
245+
-
246+
message:
247+
"""
248+
#^Class Gitlab\\\\Model\\\\ProjectHook extends deprecated class Gitlab\\\\Model\\\\AbstractModel\\:
249+
since version 10\\.1 and will be removed in 11\\.0\\.$#
250+
"""
251+
count: 1
252+
path: src/Model/ProjectHook.php
253+
254+
-
255+
message:
256+
"""
257+
#^Class Gitlab\\\\Model\\\\ProjectNamespace extends deprecated class Gitlab\\\\Model\\\\AbstractModel\\:
258+
since version 10\\.1 and will be removed in 11\\.0\\.$#
259+
"""
260+
count: 1
261+
path: src/Model/ProjectNamespace.php
262+
263+
-
264+
message:
265+
"""
266+
#^Class Gitlab\\\\Model\\\\Release extends deprecated class Gitlab\\\\Model\\\\AbstractModel\\:
267+
since version 10\\.1 and will be removed in 11\\.0\\.$#
268+
"""
269+
count: 1
270+
path: src/Model/Release.php
271+
272+
-
273+
message:
274+
"""
275+
#^Class Gitlab\\\\Model\\\\Schedule extends deprecated class Gitlab\\\\Model\\\\AbstractModel\\:
276+
since version 10\\.1 and will be removed in 11\\.0\\.$#
277+
"""
278+
count: 1
279+
path: src/Model/Schedule.php
280+
281+
-
282+
message:
283+
"""
284+
#^Class Gitlab\\\\Model\\\\Snippet extends deprecated class Gitlab\\\\Model\\\\AbstractModel\\:
285+
since version 10\\.1 and will be removed in 11\\.0\\.$#
286+
"""
287+
count: 1
288+
path: src/Model/Snippet.php
289+
290+
-
291+
message:
292+
"""
293+
#^Class Gitlab\\\\Model\\\\Tag extends deprecated class Gitlab\\\\Model\\\\AbstractModel\\:
294+
since version 10\\.1 and will be removed in 11\\.0\\.$#
295+
"""
296+
count: 1
297+
path: src/Model/Tag.php
298+
299+
-
300+
message:
301+
"""
302+
#^Class Gitlab\\\\Model\\\\Trigger extends deprecated class Gitlab\\\\Model\\\\AbstractModel\\:
303+
since version 10\\.1 and will be removed in 11\\.0\\.$#
304+
"""
305+
count: 1
306+
path: src/Model/Trigger.php
307+
308+
-
309+
message:
310+
"""
311+
#^Class Gitlab\\\\Model\\\\User extends deprecated class Gitlab\\\\Model\\\\AbstractModel\\:
312+
since version 10\\.1 and will be removed in 11\\.0\\.$#
313+
"""
314+
count: 1
315+
path: src/Model/User.php
316+
317+
-
318+
message:
319+
"""
320+
#^Class Gitlab\\\\Model\\\\Wiki extends deprecated class Gitlab\\\\Model\\\\AbstractModel\\:
321+
since version 10\\.1 and will be removed in 11\\.0\\.$#
322+
"""
323+
count: 1
324+
path: src/Model/Wiki.php
325+
38326
-
39327
message: "#^Variable method call on Gitlab\\\\Api\\\\ApiInterface\\.$#"
40328
count: 1

‎src/Model/AbstractModel.php

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,9 @@
77
use Gitlab\Client;
88
use Gitlab\Exception\RuntimeException;
99

10+
/**
11+
* @deprecated since version 10.1 and will be removed in 11.0.
12+
*/
1013
abstract class AbstractModel
1114
{
1215
/**
@@ -24,6 +27,15 @@ abstract class AbstractModel
2427
*/
2528
protected $client;
2629

30+
31+
/**
32+
* @return void
33+
*/
34+
public function __construct()
35+
{
36+
\trigger_deprecation('m4tthumphrey/php-gitlab-api', '10.1', 'Use of models is deprecated and %s will be removed in version 11.0.', static::class);
37+
}
38+
2739
/**
2840
* @return Client
2941
*/

‎src/Model/Badge.php

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@
77
use Gitlab\Client;
88

99
/**
10+
* @deprecated since version 10.1 and will be removed in 11.0.
11+
*
1012
* @property int $id
1113
* @property string $link_url
1214
* @property string $image_url
@@ -50,6 +52,7 @@ public static function fromArray(Client $client, Project $project, array $data)
5052
*/
5153
public function __construct(Project $project, Client $client = null)
5254
{
55+
parent::__construct();
5356
$this->setClient($client);
5457
$this->setData('project', $project);
5558
}

‎src/Model/Branch.php

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@
88
use Gitlab\Client;
99

1010
/**
11+
* @deprecated since version 10.1 and will be removed in 11.0.
12+
*
1113
* @property string $name
1214
* @property bool $protected
1315
* @property Commit|null $commit
@@ -52,6 +54,7 @@ public static function fromArray(Client $client, Project $project, array $data)
5254
*/
5355
public function __construct(Project $project, ?string $name = null, Client $client = null)
5456
{
57+
parent::__construct();
5558
$this->setClient($client);
5659
$this->setData('project', $project);
5760
$this->setData('name', $name);

0 commit comments

Comments
 (0)