Skip to content

Commit 88deb21

Browse files
committed
chore: add property annotations to models
Signed-off-by: Sam Poyigi <[email protected]>
1 parent ef316f8 commit 88deb21

File tree

3 files changed

+56
-70
lines changed

3 files changed

+56
-70
lines changed

phpstan-baseline.neon

Lines changed: 0 additions & 70 deletions
Original file line numberDiff line numberDiff line change
@@ -130,21 +130,6 @@ parameters:
130130
count: 1
131131
path: src/ApiResources/Transformers/OrderTransformer.php
132132

133-
-
134-
message: "#^Access to an undefined property Igniter\\\\PayRegister\\\\Models\\\\Payment\\:\\:\\$code\\.$#"
135-
count: 1
136-
path: src/ApiResources/Transformers/PaymentMethodTransformer.php
137-
138-
-
139-
message: "#^Access to an undefined property Igniter\\\\PayRegister\\\\Models\\\\Payment\\:\\:\\$description\\.$#"
140-
count: 1
141-
path: src/ApiResources/Transformers/PaymentMethodTransformer.php
142-
143-
-
144-
message: "#^Access to an undefined property Igniter\\\\PayRegister\\\\Models\\\\Payment\\:\\:\\$name\\.$#"
145-
count: 1
146-
path: src/ApiResources/Transformers/PaymentMethodTransformer.php
147-
148133
-
149134
message: "#^Access to an undefined property Igniter\\\\Reservation\\\\Models\\\\Reservation\\:\\:\\$assignee\\.$#"
150135
count: 1
@@ -185,26 +170,6 @@ parameters:
185170
count: 1
186171
path: src/ApiResources/Transformers/ReviewTransformer.php
187172

188-
-
189-
message: "#^Access to an undefined property Igniter\\\\Api\\\\Models\\\\Resource\\:\\:\\$controller\\.$#"
190-
count: 1
191-
path: src/Classes/ApiManager.php
192-
193-
-
194-
message: "#^Access to an undefined property Igniter\\\\Api\\\\Models\\\\Resource\\:\\:\\$endpoint\\.$#"
195-
count: 2
196-
path: src/Classes/ApiManager.php
197-
198-
-
199-
message: "#^Access to an undefined property Igniter\\\\Api\\\\Models\\\\Resource\\:\\:\\$meta\\.$#"
200-
count: 1
201-
path: src/Classes/ApiManager.php
202-
203-
-
204-
message: "#^Call to an undefined static method Igniter\\\\Flame\\\\Support\\\\Facades\\\\Igniter\\:\\:hasDatabase\\(\\)\\.$#"
205-
count: 1
206-
path: src/Classes/ApiManager.php
207-
208173
-
209174
message: "#^Result of method Illuminate\\\\Console\\\\Command\\:\\:error\\(\\) \\(void\\) is used\\.$#"
210175
count: 1
@@ -285,31 +250,11 @@ parameters:
285250
count: 1
286251
path: src/Http/Controllers/CreateToken.php
287252

288-
-
289-
message: "#^Call to an undefined static method Igniter\\\\Admin\\\\Facades\\\\AdminMenu\\:\\:setContext\\(\\)\\.$#"
290-
count: 1
291-
path: src/Http/Controllers/Resources.php
292-
293-
-
294-
message: "#^Call to an undefined static method Igniter\\\\Admin\\\\Facades\\\\AdminMenu\\:\\:setContext\\(\\)\\.$#"
295-
count: 1
296-
path: src/Http/Controllers/Tokens.php
297-
298253
-
299254
message: "#^Access to an undefined property Illuminate\\\\Support\\\\Optional\\:\\:\\$tokenable\\.$#"
300255
count: 1
301256
path: src/Listeners/TokenEventSubscriber.php
302257

303-
-
304-
message: "#^Access to an undefined property Igniter\\\\Api\\\\Models\\\\Resource\\:\\:\\$endpoint\\.$#"
305-
count: 6
306-
path: src/Models/Resource.php
307-
308-
-
309-
message: "#^Access to an undefined property Igniter\\\\Api\\\\Models\\\\Resource\\:\\:\\$meta\\.$#"
310-
count: 1
311-
path: src/Models/Resource.php
312-
313258
-
314259
message: "#^Access to an undefined property Illuminate\\\\Database\\\\Eloquent\\\\Model\\:\\:\\$description\\.$#"
315260
count: 1
@@ -335,31 +280,16 @@ parameters:
335280
count: 1
336281
path: src/Models/Resource.php
337282

338-
-
339-
message: "#^Call to an undefined static method Igniter\\\\Api\\\\Models\\\\Resource\\:\\:lists\\(\\)\\.$#"
340-
count: 1
341-
path: src/Models/Resource.php
342-
343283
-
344284
message: "#^Call to an undefined static method Igniter\\\\Api\\\\Models\\\\Resource\\:\\:where\\(\\)\\.$#"
345285
count: 1
346286
path: src/Models/Resource.php
347287

348-
-
349-
message: "#^Call to an undefined static method Igniter\\\\Flame\\\\Support\\\\Facades\\\\File\\:\\:existsInsensitive\\(\\)\\.$#"
350-
count: 1
351-
path: src/Models/Resource.php
352-
353288
-
354289
message: "#^Unsafe usage of new static\\(\\)\\.$#"
355290
count: 3
356291
path: src/Models/Resource.php
357292

358-
-
359-
message: "#^Access to an undefined property Igniter\\\\Api\\\\Models\\\\Token\\:\\:\\$tokenable_type\\.$#"
360-
count: 2
361-
path: src/Models/Token.php
362-
363293
-
364294
message: "#^Call to an undefined method Igniter\\\\Flame\\\\Database\\\\Model\\:\\:tokens\\(\\)\\.$#"
365295
count: 1

src/Models/Resource.php

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,37 @@
1111

1212
/**
1313
* Resource Model
14+
*
15+
* @property int $id
16+
* @property string $name
17+
* @property string $endpoint
18+
* @property string|null $description
19+
* @property array|null $meta
20+
* @property bool $is_custom
21+
* @property-read mixed $base_endpoint
22+
* @property-read mixed $controller
23+
* @method static \Igniter\Flame\Database\Builder<static>|Resource applyFilters(array $options = [])
24+
* @method static \Igniter\Flame\Database\Builder<static>|Resource applySorts(array $sorts = [])
25+
* @method static \Igniter\Flame\Database\Builder<static>|Resource dropdown(string $column, string $key = null)
26+
* @method static \Igniter\Flame\Database\Builder<static>|Resource findSimilarSlugs($attribute, array $config, $slug)
27+
* @method static \Igniter\Flame\Database\Builder<static>|Resource like(string $column, string $value, string $side = 'both', string $boolean = 'and')
28+
* @method static \Igniter\Flame\Database\Builder<static>|Resource listFrontEnd(array $options = [])
29+
* @method static \Igniter\Flame\Database\Builder<static>|Resource lists(string $column, string $key = null)
30+
* @method static \Igniter\Flame\Database\Builder<static>|Resource newModelQuery()
31+
* @method static \Igniter\Flame\Database\Builder<static>|Resource newQuery()
32+
* @method static \Igniter\Flame\Database\Builder<static>|Resource orLike(string $column, string $value, string $side = 'both')
33+
* @method static \Igniter\Flame\Database\Builder<static>|Resource orSearch(string $term, string $columns = [], string $mode = 'all')
34+
* @method static \Igniter\Flame\Database\Builder<static>|Resource pluckDates(string $column, string $keyFormat = 'Y-m', string $valueFormat = 'F Y')
35+
* @method static \Igniter\Flame\Database\Builder<static>|Resource query()
36+
* @method static \Igniter\Flame\Database\Builder<static>|Resource search(string $term, string $columns = [], string $mode = 'all')
37+
* @method static \Igniter\Flame\Database\Builder<static>|Resource whereDescription($value)
38+
* @method static \Igniter\Flame\Database\Builder<static>|Resource whereEndpoint($value)
39+
* @method static \Igniter\Flame\Database\Builder<static>|Resource whereId($value)
40+
* @method static \Igniter\Flame\Database\Builder<static>|Resource whereIsCustom($value)
41+
* @method static \Igniter\Flame\Database\Builder<static>|Resource whereMeta($value)
42+
* @method static \Igniter\Flame\Database\Builder<static>|Resource whereName($value)
43+
* @method static \Igniter\Flame\Database\Builder<static>|Resource whereSlug(string $slug)
44+
* @mixin \Igniter\Flame\Database\Model
1445
*/
1546
class Resource extends Model
1647
{
@@ -49,6 +80,7 @@ class Resource extends Model
4980

5081
protected $casts = [
5182
'meta' => 'array',
83+
'is_custom' => 'boolean',
5284
];
5385

5486
protected $permalinkable = [

src/Models/Token.php

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,30 @@
1111

1212
/**
1313
* Token Model
14+
*
15+
* @property int $id
16+
* @property string $tokenable_type
17+
* @property int $tokenable_id
18+
* @property string $name
19+
* @property string $token
20+
* @property array|null $abilities
21+
* @property \Illuminate\Support\Carbon|null $last_used_at
22+
* @property \Illuminate\Support\Carbon|null $created_at
23+
* @property \Illuminate\Support\Carbon|null $updated_at
24+
* @property-read \Illuminate\Database\Eloquent\Model|\Eloquent $tokenable
25+
* @method static \Illuminate\Database\Eloquent\Builder<static>|Token newModelQuery()
26+
* @method static \Illuminate\Database\Eloquent\Builder<static>|Token newQuery()
27+
* @method static \Illuminate\Database\Eloquent\Builder<static>|Token query()
28+
* @method static \Illuminate\Database\Eloquent\Builder<static>|Token whereAbilities($value)
29+
* @method static \Illuminate\Database\Eloquent\Builder<static>|Token whereCreatedAt($value)
30+
* @method static \Illuminate\Database\Eloquent\Builder<static>|Token whereId($value)
31+
* @method static \Illuminate\Database\Eloquent\Builder<static>|Token whereLastUsedAt($value)
32+
* @method static \Illuminate\Database\Eloquent\Builder<static>|Token whereName($value)
33+
* @method static \Illuminate\Database\Eloquent\Builder<static>|Token whereToken($value)
34+
* @method static \Illuminate\Database\Eloquent\Builder<static>|Token whereTokenableId($value)
35+
* @method static \Illuminate\Database\Eloquent\Builder<static>|Token whereTokenableType($value)
36+
* @method static \Illuminate\Database\Eloquent\Builder<static>|Token whereUpdatedAt($value)
37+
* @mixin \Igniter\Flame\Database\Model
1438
*/
1539
class Token extends PersonalAccessToken
1640
{

0 commit comments

Comments
 (0)