Skip to content

Commit 787f3ff

Browse files
committed
🚸 Improve usability
Provide @method properties on Model class for proper IDE autocompletion
1 parent 71127d5 commit 787f3ff

File tree

1 file changed

+54
-1
lines changed

1 file changed

+54
-1
lines changed

src/Models/Model.php

+54-1
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
use BadMethodCallException;
99
use GuzzleHttp\Client;
1010
use GuzzleHttp\Exception\GuzzleException;
11+
use Illuminate\Pagination\Paginator;
1112
use Illuminate\Support\Str;
1213
use MarcReichel\IGDBLaravel\ApiHelper;
1314
use MarcReichel\IGDBLaravel\Builder;
@@ -23,7 +24,59 @@
2324
/**
2425
* Class Model
2526
*
26-
* @method limit(int $limit)
27+
* @method static Builder select(mixed $fields)
28+
* @method static Builder limit(int $limit)
29+
* @method static Builder take(int $limit)
30+
* @method static Builder offset(int $limit)
31+
* @method static Builder skip(int $limit)
32+
* @method static Builder forPage(int $page, int $perPage = 10)
33+
* @method static Builder search(string $query)
34+
* @method static Builder where(mixed $key, mixed|null $operator = null, mixed|null $value = null, string $boolean = '&')
35+
* @method static Builder orWhere(mixed $key, mixed|null $operator = null, mixed|null $value = null, string $boolean = '|')
36+
* @method static Builder whereLike(string $key, string $value, bool $caseSensitive = true, string $boolean = '&')
37+
* @method static Builder orWhereLike(string $key, string $value, bool $caseSensitive = true, string $boolean = '|')
38+
* @method static Builder whereNotLike(string $key, string $value, bool $caseSensitive = true, string $boolean = '&')
39+
* @method static Builder orWhereNotLike(string $key, string $value, bool $caseSensitive = true, string $boolean = '|')
40+
* @method static Builder whereIn(string $key, array $values, string $boolean = '&', string $operator = '=', string $prefix = '(', string $suffix = ')')
41+
* @method static Builder orWhereIn(string $key, array $values, string $boolean = '|', string $operator = '=', string $prefix = '(', string $suffix = ')')
42+
* @method static Builder whereInAll(string $key, array $values, string $boolean = '&', string $operator = '=', string $prefix = '[', string $suffix = ']')
43+
* @method static Builder orWhereInAll(string $key, array $values, string $boolean = '|', string $operator = '=', string $prefix = '[', string $suffix = ']')
44+
* @method static Builder whereInExact(string $key, array $values, string $boolean = '&', string $operator = '=', string $prefix = '{', string $suffix = '}')
45+
* @method static Builder orWhereInExact(string $key, array $values, string $boolean = '|', string $operator = '=', string $prefix = '{', string $suffix = '}')
46+
* @method static Builder whereNotIn(string $key, array $values, string $boolean = '&', string $operator = '!=', string $prefix = '(', string $suffix = ')')
47+
* @method static Builder orWhereNotIn(string $key, array $values, string $boolean = '|', string $operator = '!=', string $prefix = '(', string $suffix = ')')
48+
* @method static Builder whereNotInAll(string $key, array $values, string $boolean = '&', string $operator = '!=', string $prefix = '[', string $suffix = ']')
49+
* @method static Builder orWhereNotInAll(string $key, array $values, string $boolean = '|', string $operator = '!=', string $prefix = '[', string $suffix = ']')
50+
* @method static Builder whereNotInExact(string $key, array $values, string $boolean = '&', string $operator = '!=', string $prefix = '{', string $suffix = '}')
51+
* @method static Builder orWhereNotInExact(string $key, array $values, string $boolean = '|', string $operator = '!=', string $prefix = '{', string $suffix = '}')
52+
* @method static Builder whereBetween(string $key, mixed $first, mixed $second, bool $withBoundaries = true, string $boolean = '&')
53+
* @method static Builder orWhereBetween(string $key, mixed $first, mixed $second, bool $withBoundaries = true, string $boolean = '|')
54+
* @method static Builder whereNotBetween(string $key, mixed $first, mixed $second, bool $withBoundaries = false, string $boolean = '&')
55+
* @method static Builder orWhereNotBetween(string $key, mixed $first, mixed $second, bool $withBoundaries = false, string $boolean = '|')
56+
* @method static Builder whereHas(string $key, string $boolean = '&')
57+
* @method static Builder orWhereHas(string $key, string $boolean = '|')
58+
* @method static Builder whereHasNot(string $key, string $boolean = '&')
59+
* @method static Builder orWhereHasNot(string $key, string $boolean = '|')
60+
* @method static Builder whereNull(string $key, string $boolean = '&')
61+
* @method static Builder orWhereNull(string $key, string $boolean = '|')
62+
* @method static Builder whereNotNull(string $key, string $boolean = '&')
63+
* @method static Builder orWhereNotNull(string $key, string $boolean = '|')
64+
* @method static Builder whereDate(string $key, mixed $operator, mixed|null $value, string $boolean = '&')
65+
* @method static Builder orWhereDate(string $key, mixed $operator, mixed|null $value, string $boolean = '|')
66+
* @method static Builder whereYear(string $key, mixed $operator, mixed|null $value, string $boolean = '&')
67+
* @method static Builder orWhereYear(string $key, mixed $operator, mixed|null $value, string $boolean = '|')
68+
* @method static Builder orderBy(string $key, string $direction = 'asc')
69+
* @method static Builder orderByDesc(string $key)
70+
* @method static Builder with(array $relationships)
71+
* @method static Builder cache(int $seconds)
72+
* @method static mixed|string get()
73+
* @method static mixed find(int $id)
74+
* @method static mixed findOrFail(int $id)
75+
* @method static mixed first()
76+
* @method static mixed firstOrFail()
77+
* @method static int|null count()
78+
* @method static \Illuminate\Support\Collection all()
79+
* @method static Paginator paginate(int $limit = 10)
2780
*
2881
* @package MarcReichel\IGDBLaravel\Models
2982
*/

0 commit comments

Comments
 (0)