Spatie\MediaLibrary\MediaRepository

Complexity

Total Complexity

17

Size/Duplication

Total Lines	181
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	3

Importance

Changes	4
Bugs	1	Features	1

10 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	mediaIsPreloaded()	0	4	1
A	all()	0	4	1
A	getByModelType()	0	4	1
A	getCollection()	0	8	1
B	loadMedia()	0	32	4
A	applyFilterToMediaCollection()	0	8	2
A	getByModelTypeAndCollectionName()	0	7	1
A	getByCollectionName()	0	6	1
A	getDefaultFilterFunction()	0	18	4

<?php

namespace Spatie\MediaLibrary;

use Illuminate\Support\Collection;
use Spatie\MediaLibrary\HasMedia\Interfaces\HasMedia;

class MediaRepository
{
    /**
     * @var \Spatie\MediaLibrary\Media
     */
    protected $model;

    /**
     * @param \Spatie\MediaLibrary\Media $model
     */
    public function __construct(Media $model)
    {
        $this->model = $model;
    }

    /**
     * Get all media in the collection.
     *
     * @param HasMedia       $model
     * @param string         $collectionName
     * @param array|\Closure $filter
     *
     * @return Collection
     */
    public function getCollection(HasMedia $model, $collectionName, $filter = [])
    {
        $mediaCollection = $this->loadMedia($model, $collectionName);

        $mediaCollection = $this->applyFilterToMediaCollection($mediaCollection, $filter);

        return Collection::make($mediaCollection);
    }

    /**
     * Load media by collectionName.
     *
     * @param HasMedia $model
     * @param string   $collectionName
     *
     * @return mixed
     */
    protected function loadMedia(HasMedia $model, $collectionName)
    {
        if ($this->mediaIsPreloaded($model)) {
            $media = $model->media->filter(function (Media $mediaItem) use ($collectionName) {

                if ($collectionName == '') {
                    return true;
                }

                return $mediaItem->collection_name == $collectionName;

            })->sortBy(function (Media $media) {

                return $media->order_column;

            })->values();

            return $media;
        }

        $query = $model->media();

        if ($collectionName != '') {
            $query = $query->where('collection_name', $collectionName);
        }

        $media = $query
            ->orderBy('order_column')
            ->get();

        return $media;
    }

    /**
     * Determine if media is already preloaded on this model.
     *
     * @param HasMedia $model
     *
     * @return bool
     */
    protected function mediaIsPreloaded(HasMedia $model)
    {
        return isset($model->media);
    }

    /**
     * Apply given filters on media.
     *
     * @param \Illuminate\Support\Collection $media
     * @param array|\Closure                 $filter
     *
     * @return Collection
     */
    protected function applyFilterToMediaCollection(Collection $media, $filter)
    {
        if (is_array($filter)) {
            $filter = $this->getDefaultFilterFunction($filter);
        }

        return $media->filter($filter);
    }

    /**
     * Get all media.
     *
     * @return \Illuminate\Database\Eloquent\Collection
     */
    public function all()
    {
        return $this->model->all();
    }

    /**
     * Get all media for the given type.
     *
     * @param string $modelType
     *
     * @return \Illuminate\Database\Eloquent\Collection
     */
    public function getByModelType($modelType)
    {
        return $this->model->where('model_type', $modelType)->get();
    }

    /**
     * Get all media for the given type and collection name.
     *
     * @param string $modelType
     * @param string $collectionName
     *
     * @return \Illuminate\Database\Eloquent\Collection
     */
    public function getByModelTypeAndCollectionName($modelType, $collectionName)
    {
        return $this->model

The method where does not exist on object<Spatie\MediaLibrary\Media>? Since you implemented __call, maybe consider adding a @method annotation.

            ->where('model_type', $modelType)
            ->where('collection_name', $collectionName)
            ->get();
    }

    /**
     * Get all media for the given type and collection name.
     *
     * @param string $collectionName
     *
     * @return \Illuminate\Database\Eloquent\Collection
     */
    public function getByCollectionName($collectionName)
    {
        return $this->model

The method where does not exist on object<Spatie\MediaLibrary\Media>? Since you implemented __call, maybe consider adding a @method annotation.

            ->where('collection_name', $collectionName)
            ->get();
    }

    /**
     * Convert the given array to a filter function.
     *
     * @param $filters
     *
     * @return \Closure
     */
    protected function getDefaultFilterFunction($filters)
    {
        return function (Media $media) use ($filters) {

            $customProperties = $media->custom_properties;

            foreach ($filters as $property => $value) {
                if (!isset($customProperties[$property])) {
                    return false;
                }
                if ($customProperties[$property] != $value) {
                    return false;
                }
            }

            return true;
        };
    }
}