Models: Added DocBlocks

This commit is contained in:
Igor Scheller 2018-10-28 16:54:15 +01:00 committed by msquare
parent 8a9031fa01
commit 720b46f60f
8 changed files with 47 additions and 22 deletions

View File

@ -4,6 +4,17 @@ namespace Engelsystem\Models;
use Carbon\Carbon; use Carbon\Carbon;
/**
* @property string $name
* @property string $value
* @property \Carbon\Carbon $created_at
* @property \Carbon\Carbon $updated_at
*
* @method static \Illuminate\Database\Query\Builder|\Engelsystem\Models\EventConfig[] whereName($value)
* @method static \Illuminate\Database\Query\Builder|\Engelsystem\Models\EventConfig[] whereValue($value)
* @method static \Illuminate\Database\Query\Builder|\Engelsystem\Models\EventConfig[] whereCreatedAt($value)
* @method static \Illuminate\Database\Query\Builder|\Engelsystem\Models\EventConfig[] whereUpdatedAt($value)
*/
class EventConfig extends BaseModel class EventConfig extends BaseModel
{ {
/** @var string The primary key for the model */ /** @var string The primary key for the model */

View File

@ -5,6 +5,17 @@ namespace Engelsystem\Models;
use Illuminate\Database\Eloquent\Builder; use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Collection; use Illuminate\Database\Eloquent\Collection;
/**
* @property int $id
* @property string $level
* @property string $message
* @property \Carbon\Carbon|null $created_at
*
* @method static \Illuminate\Database\Query\Builder|\Engelsystem\Models\LogEntry[] whereId($value)
* @method static \Illuminate\Database\Query\Builder|\Engelsystem\Models\LogEntry[] whereLevel($value)
* @method static \Illuminate\Database\Query\Builder|\Engelsystem\Models\LogEntry[] whereMessage($value)
* @method static \Illuminate\Database\Query\Builder|\Engelsystem\Models\LogEntry[] whereCreatedAt($value)
*/
class LogEntry extends BaseModel class LogEntry extends BaseModel
{ {
/** @var bool enable timestamps for created_at */ /** @var bool enable timestamps for created_at */

View File

@ -3,9 +3,9 @@
namespace Engelsystem\Models\User; namespace Engelsystem\Models\User;
/** /**
* @property string $dect * @property string|null $dect
* @property string $email * @property string|null $email
* @property string $mobile * @property string|null $mobile
* *
* @method static \Illuminate\Database\Query\Builder|\Engelsystem\Models\User\Contact[] whereDect($value) * @method static \Illuminate\Database\Query\Builder|\Engelsystem\Models\User\Contact[] whereDect($value)
* @method static \Illuminate\Database\Query\Builder|\Engelsystem\Models\User\Contact[] whereEmail($value) * @method static \Illuminate\Database\Query\Builder|\Engelsystem\Models\User\Contact[] whereEmail($value)

View File

@ -22,6 +22,9 @@ abstract class HasUserModel extends BaseModel
'user_id', 'user_id',
]; ];
/** The relationships that should be touched on save */
protected $touches = ['user'];
/** /**
* @return BelongsTo * @return BelongsTo
*/ */

View File

@ -3,8 +3,8 @@
namespace Engelsystem\Models\User; namespace Engelsystem\Models\User;
/** /**
* @property string $token * @property string $token
* @property \Carbon\Carbon $created_at * @property \Carbon\Carbon|null $created_at
* *
* @method static \Illuminate\Database\Query\Builder|\Engelsystem\Models\User\PasswordReset[] whereToken($value) * @method static \Illuminate\Database\Query\Builder|\Engelsystem\Models\User\PasswordReset[] whereToken($value)
* @method static \Illuminate\Database\Query\Builder|\Engelsystem\Models\User\PasswordReset[] whereCreatedAt($value) * @method static \Illuminate\Database\Query\Builder|\Engelsystem\Models\User\PasswordReset[] whereCreatedAt($value)

View File

@ -3,17 +3,17 @@
namespace Engelsystem\Models\User; namespace Engelsystem\Models\User;
/** /**
* @property string $first_name * @property string|null $first_name
* @property string $last_name * @property string|null $last_name
* @property string $shirt_size * @property string|null $shirt_size
* @property \Carbon\Carbon $planned_arrival_date * @property \Carbon\Carbon|null $planned_arrival_date
* @property \Carbon\Carbon $planned_departure_date * @property \Carbon\Carbon|null $planned_departure_date
* *
* @method static \Illuminate\Database\Query\Builder|\Engelsystem\Models\User\PersonalData whereFirstName($value) * @method static \Illuminate\Database\Query\Builder|\Engelsystem\Models\User\PersonalData[] whereFirstName($value)
* @method static \Illuminate\Database\Query\Builder|\Engelsystem\Models\User\PersonalData whereLastName($value) * @method static \Illuminate\Database\Query\Builder|\Engelsystem\Models\User\PersonalData[] whereLastName($value)
* @method static \Illuminate\Database\Query\Builder|\Engelsystem\Models\User\PersonalData whereShirtSize($value) * @method static \Illuminate\Database\Query\Builder|\Engelsystem\Models\User\PersonalData[] whereShirtSize($value)
* @method static \Illuminate\Database\Query\Builder|\Engelsystem\Models\User\PersonalData wherePlannedArrivalDate($value) * @method static \Illuminate\Database\Query\Builder|\Engelsystem\Models\User\PersonalData[] wherePlannedArrivalDate($value)
* @method static \Illuminate\Database\Query\Builder|\Engelsystem\Models\User\PersonalData wherePlannedDepartureDate($value) * @method static \Illuminate\Database\Query\Builder|\Engelsystem\Models\User\PersonalData[] wherePlannedDepartureDate($value)
*/ */
class PersonalData extends HasUserModel class PersonalData extends HasUserModel
{ {

View File

@ -3,12 +3,12 @@
namespace Engelsystem\Models\User; namespace Engelsystem\Models\User;
/** /**
* @property bool $arrived * @property bool $arrived
* @property \Carbon\Carbon $arrival_date * @property \Carbon\Carbon|null $arrival_date
* @property bool $active * @property bool $active
* @property bool $force_active * @property bool $force_active
* @property bool $got_shirt * @property bool $got_shirt
* @property int $got_voucher * @property int $got_voucher
* *
* @method static \Illuminate\Database\Query\Builder|\Engelsystem\Models\User\State[] whereArrived($value) * @method static \Illuminate\Database\Query\Builder|\Engelsystem\Models\User\State[] whereArrived($value)
* @method static \Illuminate\Database\Query\Builder|\Engelsystem\Models\User\State[] whereArrivalDate($value) * @method static \Illuminate\Database\Query\Builder|\Engelsystem\Models\User\State[] whereArrivalDate($value)

View File

@ -11,7 +11,7 @@ use Illuminate\Database\Eloquent\Relations\HasOne;
* @property string $email * @property string $email
* @property string $password * @property string $password
* @property string $api_key * @property string $api_key
* @property \Carbon\Carbon $last_login_at * @property \Carbon\Carbon|null $last_login_at
* @property \Carbon\Carbon $created_at * @property \Carbon\Carbon $created_at
* @property \Carbon\Carbon $updated_at * @property \Carbon\Carbon $updated_at
* *