Vetor\Laravel\Collect\Collectable\Models\Traits\Collectable

Complexity

Total Complexity

7

Size/Duplication

Total Lines	61
Duplicated Lines	0 %

Test Coverage

Coverage

90%

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	collections()	0	3	1
A	collect()	0	3	1
A	scopeOrderByCollectionsCount()	0	14	1
A	cancelCollect()	0	3	1
A	getCollectionsCountAttribute()	0	3	2
A	isCollection()	0	3	1

<?php

namespace Vetor\Laravel\Collect\Collectable\Models\Traits;

use DB;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Query\JoinClause;
use Vetor\Contracts\Collect\Collection\Models\Collection as CollectionContract;
use Vetor\Contracts\Collect\Collectable\Services\CollectableService as CollectableServiceContract;

trait Collectable
{
    /**
     * @return mixed
     */
    public function collections()
    {
        return $this->morphMany(app(CollectionContract::class), 'collectable');

It seems like morphMany() must be provided by classes using this trait. How about adding it as abstract method to this trait?

    }

    /**
     * @param null $userId

Are you sure the doc-type for parameter $userId is correct as it would always require null to be passed?

     */
    public function collect($userId = null)
    {
        return app(CollectableServiceContract::class)->addCollectionTo($this, $userId);

$this of type Vetor\Laravel\Collect\Collectable\Models\Traits\Collectable is incompatible with the type Vetor\Contracts\Collect\Collectable\Models\Collectable expected by parameter $collectable of Vetor\Contracts\Collect\Collectable\Services\CollectableService::addCollectionTo().

    }

    /**
     * @param null $userId

Are you sure the doc-type for parameter $userId is correct as it would always require null to be passed?

     */
    public function isCollection($userId = null)
    {
        return app(CollectableServiceContract::class)->isCollection($this, $userId);

The method isCollection() does not exist on Vetor\Contracts\Collect\Collectable\Services\CollectableService. Since it exists in all sub-types, consider adding an abstract or default implementation to Vetor\Contracts\Collect\Collectable\Services\CollectableService.

    }

    /**
     * @param null $userId

Are you sure the doc-type for parameter $userId is correct as it would always require null to be passed?

     */
    public function cancelCollect($userId = null)
    {
        return app(CollectableServiceContract::class)->removeCollectionFrom($this, $userId);

$this of type Vetor\Laravel\Collect\Collectable\Models\Traits\Collectable is incompatible with the type Vetor\Contracts\Collect\Collectable\Models\Collectable expected by parameter $collectable of Vetor\Contracts\Collect\Collectable\Services\CollectableService::removeCollectionFrom().

    }

    /**
     * @return int
     */
    public function getCollectionsCountAttribute()
    {
        return $this->collections ? $this->collections->count() : 0;
    }

    /**
     * @param \Illuminate\Database\Eloquent\Builder $query
     * @param string $direction
     * @return mixed
     */
    public function scopeOrderByCollectionsCount(Builder $query, $direction = 'asc')
    {
        $collectable = $query->getModel();

        return $query
            ->select("{$collectable->getTable()}.*")
            ->leftJoin('collections', function (JoinClause $join) use ($collectable) {
                $join
                    ->on('collections.collectable_id', '=', "{$collectable->getTable()}.{$collectable->getKeyName()}")
                    ->where('collections.collectable_type', '=', $collectable->getMorphClass());
            })
            ->groupBy("{$collectable->getTable()}.{$collectable->getKeyName()}")
            ->orderBy(DB::raw("count(collections.id)"), $direction)
            ->orderBy("{$collectable->getTable()}.{$collectable->getKeyName()}");
    }
}