mirror of
https://github.com/barryvdh/laravel-ide-helper.git
synced 2026-08-18 18:13:11 +00:00
* add comment with @method & @property-read & property-write in models * add readme comment * add readme comment * add comment tag unit-test * add comment tag unit-test * both a getter and a setter has a @comment test * Update README.md improve README Co-authored-by: Markus Podar <[email protected]> * Update CHANGELOG.md Co-authored-by: Markus Podar <[email protected]>
137 lines
2.5 KiB
PHP
137 lines
2.5 KiB
PHP
<?php
|
|
|
|
declare(strict_types=1);
|
|
|
|
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Comment\Models;
|
|
|
|
use Illuminate\Database\Eloquent\Model;
|
|
use Illuminate\Database\Eloquent\Relations\HasMany;
|
|
use Illuminate\Database\Eloquent\Relations\HasOne;
|
|
use Illuminate\Database\Eloquent\Relations\MorphTo;
|
|
|
|
class Simple extends Model
|
|
{
|
|
/**
|
|
* There is not comment.
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getNotCommentAttribute(): string
|
|
{
|
|
}
|
|
|
|
/**
|
|
* comment There is not format comment, invalid.
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getFakerCommentAttribute(): string
|
|
{
|
|
}
|
|
|
|
/**
|
|
* @comment There is format comment, success.
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getFormatCommentAttribute(): string
|
|
{
|
|
}
|
|
|
|
/**
|
|
* @comment There is format comment, success.
|
|
* This is second line, success too.
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getFormatCommentLineTwoAttribute(): string
|
|
{
|
|
}
|
|
|
|
/**
|
|
* @comment There is format comment, success.
|
|
* @comment This is others format comment, invalid.
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getManyFormatCommentAttribute(): string
|
|
{
|
|
}
|
|
|
|
/**
|
|
* @comment Set the user's first name.
|
|
* @param $value
|
|
*/
|
|
public function setFirstNameAttribute($value)
|
|
{
|
|
}
|
|
|
|
/**
|
|
* @comment Scope a query to only include active users.
|
|
*
|
|
* @param $query
|
|
* @return mixed
|
|
*/
|
|
public function scopeActive($query)
|
|
{
|
|
return $query;
|
|
}
|
|
|
|
/**
|
|
* @comment HasMany relations.
|
|
*
|
|
* @return HasMany
|
|
*/
|
|
public function relationHasMany(): HasMany
|
|
{
|
|
return $this->hasMany(Simple::class);
|
|
}
|
|
|
|
/**
|
|
* @comment MorphTo relations.
|
|
* @return MorphTo
|
|
*/
|
|
public function relationMorphTo(): MorphTo
|
|
{
|
|
return $this->morphTo();
|
|
}
|
|
|
|
/**
|
|
* @comment Others relations.
|
|
* @return HasOne
|
|
*/
|
|
public function relationHasOne(): HasOne
|
|
{
|
|
return $this->hasOne(Simple::class);
|
|
}
|
|
|
|
/**
|
|
* @comment I'm a setter
|
|
*/
|
|
public function setBothSameNameAttribute(): void
|
|
{
|
|
}
|
|
|
|
/**
|
|
* @comment I'm a getter
|
|
* @return string
|
|
*/
|
|
public function getBothSameNameAttribute(): string
|
|
{
|
|
}
|
|
|
|
/**
|
|
* @comment I'm a setter
|
|
*/
|
|
public function setBothWithoutGetterCommentAttribute(): void
|
|
{
|
|
}
|
|
|
|
/**
|
|
* @return string
|
|
*/
|
|
public function getBothWithoutGetterCommentAttribute(): string
|
|
{
|
|
}
|
|
}
|