Skip to content

Commit

Permalink
phpdoc
Browse files Browse the repository at this point in the history
Change @param/@return to FQCN
  • Loading branch information
pakomp committed Nov 23, 2017
1 parent b6e859a commit 8d742f8
Show file tree
Hide file tree
Showing 5 changed files with 31 additions and 31 deletions.
8 changes: 4 additions & 4 deletions src/Collections/FutureCollection.php
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ class FutureCollection extends EloquentCollection
/**
* Get the original model state
*
* @return Dixie\EloquentModelFuture\Contracts\ModelFuture
* @return \Dixie\EloquentModelFuture\Contracts\ModelFuture
*/
public function original()
{
Expand All @@ -19,7 +19,7 @@ public function original()

/**
* Get the models for each change.
* @return Dixie\EloquentModelFuture\Contracts\ModelFuture
* @return \Dixie\EloquentModelFuture\Contracts\ModelFuture
*/
public function models($include_org=false)
{
Expand All @@ -36,7 +36,7 @@ public function models($include_org=false)
/**
* Gets the model back with all the future data filled.
*
* @return Dixie\EloquentModelFuture\Contracts\ModelFuture
* @return \Dixie\EloquentModelFuture\Contracts\ModelFuture
*/
public function result()
{
Expand All @@ -50,7 +50,7 @@ public function result()
/**
* Gets a list of all fields that would change, with both before and after.
*
* @return Illuminate\Support\Collection
* @return \Illuminate\Support\Collection
*/
public function resultDiff()
{
Expand Down
2 changes: 1 addition & 1 deletion src/Contracts/ModelFuture.php
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ interface ModelFuture
/**
* Defines the relationship between the model and its futures
*
* @return Illuminate\Database\Eloquent\Relations\MorphMany
* @return \Illuminate\Database\Eloquent\Relations\MorphMany
*/
public function futures();
}
20 changes: 10 additions & 10 deletions src/FuturePlanner.php
Original file line number Diff line number Diff line change
Expand Up @@ -12,21 +12,21 @@ class FuturePlanner
/**
* The model under action.
*
* @var Dixie\EloquentModelFuture\Contracts\ModelFuture
* @var \Dixie\EloquentModelFuture\Contracts\ModelFuture
*/
protected $model;

/**
* A new future instance that is about to get planned.
*
* @var Dixie\EloquentModelFuture\Models\Future
* @var \Dixie\EloquentModelFuture\Models\Future
*/
protected $newFuture;

/**
* The base query for getting futures.
*
* @var Illuminate\Database\Eloquent\Relations\MorphMany
* @var \Illuminate\Database\Eloquent\Relations\MorphMany
*/
protected $futures;

Expand All @@ -51,7 +51,7 @@ public function __construct(ModelFuture $model, string $newFuture = null)
*
* @param array $attributes
*
* @return Dixie\EloquentModelFuture\FuturePlanner
* @return \Dixie\EloquentModelFuture\FuturePlanner
*/
public function plan(array $attributes)
{
Expand All @@ -66,7 +66,7 @@ public function plan(array $attributes)
* @param boolean $needed
* Set to false to remove the approval need from the future
*
* @return Dixie\EloquentModelFuture\Models\Future
* @return \Dixie\EloquentModelFuture\Models\Future
*/
public function needsApproval($needed=true)
{
Expand All @@ -86,7 +86,7 @@ public function needsApproval($needed=true)
*
* @param Carbon $futureDate
*
* @return Dixie\EloquentModelFuture\Models\Future
* @return \Dixie\EloquentModelFuture\Models\Future
*/
public function at(Carbon $futureDate)
{
Expand All @@ -107,7 +107,7 @@ public function at(Carbon $futureDate)
*
* @param Carbon $futureDate
*
* @return Dixie\EloquentModelFuture\Contracts\ModelFuture
* @return \Dixie\EloquentModelFuture\Contracts\ModelFuture
*/
public function see(Carbon $futureDate)
{
Expand All @@ -117,7 +117,7 @@ public function see(Carbon $futureDate)
/**
* Get all future plans for a model.
*
* @return Dixie\EloquentModelFuture\Collections\FutureCollection
* @return \Dixie\EloquentModelFuture\Collections\FutureCollection
*/
public function getPlans()
{
Expand All @@ -129,7 +129,7 @@ public function getPlans()
*
* @param Carbon $futureDate
*
* @return Dixie\EloquentModelFuture\Collections\FutureCollection
* @return \Dixie\EloquentModelFuture\Collections\FutureCollection
*/
public function getPlansFor(Carbon $futureDate)
{
Expand All @@ -141,7 +141,7 @@ public function getPlansFor(Carbon $futureDate)
*
* @param Carbon $futureDate
*
* @return Dixie\EloquentModelFuture\Collections\FutureCollection
* @return \Dixie\EloquentModelFuture\Collections\FutureCollection
*/
public function getPlansUntil(Carbon $futureDate)
{
Expand Down
24 changes: 12 additions & 12 deletions src/Models/Future.php
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ class Future extends Model
/**
* Override the original Eloquent collection.
*
* @param Dixie\EloquentModelFuture\Collections\FutureCollection
* @param \Dixie\EloquentModelFuture\Collections\FutureCollection
*/
public function newCollection(array $models = [])
{
Expand All @@ -59,7 +59,7 @@ public function newCollection(array $models = [])
* Get the relationship to the associated model,
* for which the future has been planned.
*
* @return Illuminate\Database\Eloquent\Relations\MorphTo
* @return \Illuminate\Database\Eloquent\Relations\MorphTo
*/
public function futureable()
{
Expand All @@ -70,7 +70,7 @@ public function futureable()
/**
* Get the relationship to user who created the future plan.
*
* @return Illuminate\Database\Eloquent\Relations\BelongsTo
* @return \Illuminate\Database\Eloquent\Relations\BelongsTo
*/
public function creator()
{
Expand All @@ -83,7 +83,7 @@ public function creator()
/**
* Get the relationship to user who created the future plan.
*
* @return Illuminate\Database\Eloquent\Relations\BelongsTo
* @return \Illuminate\Database\Eloquent\Relations\BelongsTo
*/
public function approver()
{
Expand All @@ -96,10 +96,10 @@ public function approver()
/**
* Narrow the scope of a query to only include futures for given date.
*
* @param Illuminate\Database\Eloquent\Builder $query
* @param Carbon\Carbon $date
* @param \Illuminate\Database\Eloquent\Builder $query
* @param \Carbon\Carbon $date
*
* @return Illuminate\Database\Eloquent\Builder
* @return \Illuminate\Database\Eloquent\Builder
*/
public function scopeForDate(Builder $query, Carbon $date)
{
Expand All @@ -113,7 +113,7 @@ public function scopeForDate(Builder $query, Carbon $date)
* @param Builder $query
* @param Carbon $date
*
* @return Illuminate\Database\Eloquent\Builder
* @return \Illuminate\Database\Eloquent\Builder
*/
public function scopeUntilDate(Builder $query, Carbon $date)
{
Expand All @@ -125,7 +125,7 @@ public function scopeUntilDate(Builder $query, Carbon $date)
*
* @param Builder $query
*
* @return Illuminate\Database\Eloquent\Builder
* @return \Illuminate\Database\Eloquent\Builder
*/
public function scopeUncommitted(Builder $query)
{
Expand All @@ -137,7 +137,7 @@ public function scopeUncommitted(Builder $query)
*
* @param Builder $query
*
* @return Illuminate\Database\Eloquent\Builder
* @return \Illuminate\Database\Eloquent\Builder
*/
public function scopeCommitted(Builder $query)
{
Expand All @@ -149,7 +149,7 @@ public function scopeCommitted(Builder $query)
*
* @param Builder $query
*
* @return Illuminate\Database\Eloquent\Builder
* @return \Illuminate\Database\Eloquent\Builder
*/
public function scopeUnapproved(Builder $query)
{
Expand All @@ -161,7 +161,7 @@ public function scopeUnapproved(Builder $query)
*
* @param Builder $query
*
* @return Illuminate\Database\Eloquent\Builder
* @return \Illuminate\Database\Eloquent\Builder
*/
public function scopeApproved(Builder $query)
{
Expand Down
8 changes: 4 additions & 4 deletions src/Traits/HasFuture.php
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ trait HasFuture
/**
* Defines the relationship between the model and its futures.
*
* @return Illuminate\Database\Eloquent\Relations\MorphMany
* @return \Illuminate\Database\Eloquent\Relations\MorphMany
*/
public function futures()
{
Expand All @@ -28,7 +28,7 @@ public function futures()
/**
* Defines the relationship between the model and its uncommitted futures.
*
* @return Illuminate\Database\Eloquent\Relations\MorphMany
* @return \Illuminate\Database\Eloquent\Relations\MorphMany
*/
public function uncommittedFutures()
{
Expand All @@ -38,7 +38,7 @@ public function uncommittedFutures()
/**
* Defines the relationship between the model and its unapproved futures.
*
* @return Illuminate\Database\Eloquent\Relations\MorphMany
* @return \Illuminate\Database\Eloquent\Relations\MorphMany
*/
public function unapprovedFutures()
{
Expand All @@ -48,7 +48,7 @@ public function unapprovedFutures()
/**
* Start planning the future of a model
*
* @return Dixie\EloquentModelFuture\FuturePlanner
* @return \Dixie\EloquentModelFuture\FuturePlanner
*/
public function future()
{
Expand Down

0 comments on commit 8d742f8

Please sign in to comment.