Add ide-helper files & Update phpdocs

This commit is contained in:
Bubka 2023-03-02 15:24:57 +01:00
parent 4006deb1e0
commit 79bc9020b2
8 changed files with 21933 additions and 6 deletions

1
.gitignore vendored
View File

@ -16,4 +16,3 @@ Homestead.yaml
auth.json
npm-debug.log
yarn-error.log
_ide_helper.php

21774
_ide_helper.php Normal file

File diff suppressed because it is too large Load Diff

95
_ide_helper_models.php Normal file
View File

@ -0,0 +1,95 @@
<?php
// @formatter:off
/**
* A helper file for your Eloquent Models
* Copy the phpDocs from this file to the correct Model,
* And remove them from this file, to prevent double declarations.
*
* @author Barry vd. Heuvel <barryvdh@gmail.com>
*/
namespace App\Models{
/**
* App\Models\Group
*
* @method static \Database\Factories\GroupFactory factory(...$parameters)
* @method static \Illuminate\Database\Eloquent\Builder|Group newModelQuery()
* @method static \Illuminate\Database\Eloquent\Builder|Group newQuery()
* @method static \Illuminate\Database\Eloquent\Builder|Group query()
* @method static \Illuminate\Database\Eloquent\Builder|Group whereCreatedAt($value)
* @method static \Illuminate\Database\Eloquent\Builder|Group whereId($value)
* @method static \Illuminate\Database\Eloquent\Builder|Group whereName($value)
* @method static \Illuminate\Database\Eloquent\Builder|Group whereUpdatedAt($value)
* @method static \Illuminate\Database\Eloquent\Builder|Group whereUserId($value)
*/
class Group extends \Eloquent {}
}
namespace App\Models{
/**
* App\Models\Option
*
* @method static \Illuminate\Database\Eloquent\Builder|Option newModelQuery()
* @method static \Illuminate\Database\Eloquent\Builder|Option newQuery()
* @method static \Illuminate\Database\Eloquent\Builder|Option query()
* @method static \Illuminate\Database\Eloquent\Builder|Option whereId($value)
* @method static \Illuminate\Database\Eloquent\Builder|Option whereKey($value)
* @method static \Illuminate\Database\Eloquent\Builder|Option whereValue($value)
*/
class Option extends \Eloquent {}
}
namespace App\Models{
/**
* App\Models\TwoFAccount
*
* @method static \Database\Factories\TwoFAccountFactory factory(...$parameters)
* @method static \Illuminate\Database\Eloquent\Builder|TwoFAccount newModelQuery()
* @method static \Illuminate\Database\Eloquent\Builder|TwoFAccount newQuery()
* @method static \Illuminate\Database\Eloquent\Builder|TwoFAccount ordered(string $direction = 'asc')
* @method static \Illuminate\Database\Eloquent\Builder|TwoFAccount query()
* @method static \Illuminate\Database\Eloquent\Builder|TwoFAccount whereAccount($value)
* @method static \Illuminate\Database\Eloquent\Builder|TwoFAccount whereAlgorithm($value)
* @method static \Illuminate\Database\Eloquent\Builder|TwoFAccount whereCounter($value)
* @method static \Illuminate\Database\Eloquent\Builder|TwoFAccount whereCreatedAt($value)
* @method static \Illuminate\Database\Eloquent\Builder|TwoFAccount whereDigits($value)
* @method static \Illuminate\Database\Eloquent\Builder|TwoFAccount whereGroupId($value)
* @method static \Illuminate\Database\Eloquent\Builder|TwoFAccount whereIcon($value)
* @method static \Illuminate\Database\Eloquent\Builder|TwoFAccount whereId($value)
* @method static \Illuminate\Database\Eloquent\Builder|TwoFAccount whereLegacyUri($value)
* @method static \Illuminate\Database\Eloquent\Builder|TwoFAccount whereOrderColumn($value)
* @method static \Illuminate\Database\Eloquent\Builder|TwoFAccount whereOtpType($value)
* @method static \Illuminate\Database\Eloquent\Builder|TwoFAccount wherePeriod($value)
* @method static \Illuminate\Database\Eloquent\Builder|TwoFAccount whereSecret($value)
* @method static \Illuminate\Database\Eloquent\Builder|TwoFAccount whereService($value)
* @method static \Illuminate\Database\Eloquent\Builder|TwoFAccount whereUpdatedAt($value)
* @method static \Illuminate\Database\Eloquent\Builder|TwoFAccount whereUserId($value)
*/
class TwoFAccount extends \Eloquent implements \Spatie\EloquentSortable\Sortable {}
}
namespace App\Models{
/**
* App\Models\User
*
* @method static \Database\Factories\UserFactory factory(...$parameters)
* @method static \Illuminate\Database\Eloquent\Builder|User newModelQuery()
* @method static \Illuminate\Database\Eloquent\Builder|User newQuery()
* @method static \Illuminate\Database\Eloquent\Builder|User query()
* @method static \Illuminate\Database\Eloquent\Builder|User whereCreatedAt($value)
* @method static \Illuminate\Database\Eloquent\Builder|User whereEmail($value)
* @method static \Illuminate\Database\Eloquent\Builder|User whereEmailVerifiedAt($value)
* @method static \Illuminate\Database\Eloquent\Builder|User whereId($value)
* @method static \Illuminate\Database\Eloquent\Builder|User whereIsAdmin($value)
* @method static \Illuminate\Database\Eloquent\Builder|User whereLastSeenAt($value)
* @method static \Illuminate\Database\Eloquent\Builder|User whereName($value)
* @method static \Illuminate\Database\Eloquent\Builder|User wherePassword($value)
* @method static \Illuminate\Database\Eloquent\Builder|User wherePreferences($value)
* @method static \Illuminate\Database\Eloquent\Builder|User whereRememberToken($value)
* @method static \Illuminate\Database\Eloquent\Builder|User whereUpdatedAt($value)
*/
class User extends \Eloquent implements \App\Models\WebAuthnAuthenticatable, \Laragear\WebAuthn\Contracts\WebAuthnAuthenticatable {}
}

View File

@ -6,11 +6,6 @@ use App\Services\TwoFAccountService;
use Illuminate\Support\Facades\Facade;
/**
* @method static void withdraw(int|array|string $ids)
* @method \Illuminate\Support\Collection<int|string, \App\Models\TwoFAccount> migrate(string $migrationPayload)
* @method static \Illuminate\Support\Collection<int, \App\Models\TwoFAccount> export(int|array|string $ids)
* @method static int delete(int|array|string $ids)
*
* @see \App\Services\TwoFAccountService
*/
class TwoFAccounts extends Facade

View File

@ -9,7 +9,16 @@ use Illuminate\Database\Eloquent\Model;
use Illuminate\Support\Facades\Log;
/**
* App\Models\Group
*
* @property int $twofaccounts_count
* @property int $id
* @property string $name
* @property \Illuminate\Support\Carbon|null $created_at
* @property \Illuminate\Support\Carbon|null $updated_at
* @property int|null $user_id
* @property-read \Illuminate\Database\Eloquent\Collection|\App\Models\TwoFAccount[] $twofaccounts
* @property-read \App\Models\User|null $user
*/
class Group extends Model
{

View File

@ -4,6 +4,13 @@ namespace App\Models;
use Illuminate\Database\Eloquent\Model;
/**
* App\Models\Option
*
* @property int $id
* @property string $key
* @property string $value
*/
class Option extends Model
{
/**

View File

@ -33,6 +33,27 @@ use Spatie\EloquentSortable\Sortable;
use Spatie\EloquentSortable\SortableTrait;
use SteamTotp\SteamTotp;
/**
* App\Models\TwoFAccount
*
* @property int $id
* @property string|null $service
* @property string $legacy_uri
* @property string $account
* @property string|null $icon
* @property \Illuminate\Support\Carbon|null $created_at
* @property \Illuminate\Support\Carbon|null $updated_at
* @property int|null $order_column
* @property int|null $group_id
* @property string $otp_type
* @property string $secret
* @property string $algorithm
* @property int $digits
* @property int|null $period
* @property int|null $counter
* @property int|null $user_id
* @property-read \App\Models\User|null $user
*/
class TwoFAccount extends Model implements Sortable
{
use SortableTrait, HasFactory;

View File

@ -11,6 +11,33 @@ use Illuminate\Support\Facades\Log;
use Laragear\WebAuthn\WebAuthnAuthentication;
use Laravel\Passport\HasApiTokens;
/**
* App\Models\User
*
* @property int $id
* @property string $name
* @property string $email
* @property \Illuminate\Support\Carbon|null $email_verified_at
* @property string $password
* @property string|null $remember_token
* @property \Illuminate\Support\Carbon|null $created_at
* @property \Illuminate\Support\Carbon|null $updated_at
* @property string|null $last_seen_at
* @property bool $is_admin
* @property \Illuminate\Support\Collection<array-key,array-value> $preferences
* @property-read \Illuminate\Database\Eloquent\Collection|\Laravel\Passport\Client[] $clients
* @property-read int|null $clients_count
* @property-read \Illuminate\Database\Eloquent\Collection|\App\Models\Group[] $groups
* @property-read int|null $groups_count
* @property-read \Illuminate\Notifications\DatabaseNotificationCollection|\Illuminate\Notifications\DatabaseNotification[] $notifications
* @property-read int|null $notifications_count
* @property-read \Illuminate\Database\Eloquent\Collection|\Laravel\Passport\Token[] $tokens
* @property-read int|null $tokens_count
* @property-read \Illuminate\Database\Eloquent\Collection|\App\Models\TwoFAccount[] $twofaccounts
* @property-read int|null $twofaccounts_count
* @property-read \Illuminate\Database\Eloquent\Collection|\Laragear\WebAuthn\Models\WebAuthnCredential[] $webAuthnCredentials
* @property-read int|null $web_authn_credentials_count
*/
class User extends Authenticatable implements WebAuthnAuthenticatable
{
use WebAuthnAuthentication, WebAuthnManageCredentials;