ByTIC\MediaLibrary\Collections\Traits\LoadMediaTrait

Complexity

Total Complexity

15

Size/Duplication

Total Lines	131
Duplicated Lines	0 %

Test Coverage

Coverage

70.83%

Importance

Changes	2
Bugs	1	Features	1

11 Methods

Rating	Name	Duplication	Size	Complexity
A	doLoad()	0	3	1
A	setMediaType()	0	3	1
A	loadMedia()	0	9	2
A	setMediaLoaded()	0	3	1
A	appendMedia()	0	3	1
A	appendMediaFromLoader()	0	14	3
A	isMediaLoaded()	0	3	1
A	getMediaType()	0	3	1
A	hydrateLoader()	0	6	1
A	newMedia()	0	7	1
A	getLoaderClass()	0	7	2

<?php

namespace ByTIC\MediaLibrary\Collections\Traits;

use ByTIC\MediaLibrary\Loaders\AbstractLoader;
use ByTIC\MediaLibrary\Loaders\Database;
use ByTIC\MediaLibrary\Loaders\Fallback;

The type ByTIC\MediaLibrary\Loaders\Fallback was not found. Maybe you did not declare it correctly or list all dependencies?

use ByTIC\MediaLibrary\Loaders\Filesystem;
use ByTIC\MediaLibrary\Loaders\HasLoaderTrait;
use ByTIC\MediaLibrary\Media\Media;
use ByTIC\MediaLibrary\MediaRepository\HasMediaRepositoryTrait;

/**
 * Trait LoadMediaTrait.
 */
trait LoadMediaTrait
{
    use HasLoaderTrait;
    use HasMediaRepositoryTrait;

    /**
     * @var string
     */
    protected $mediaType = 'files';

    /**
     * @var bool
     */
    protected $mediaLoaded = false;

    protected function doLoad(): void
    {
        $this->loadMedia();
    }

    public function loadMedia()
    {
        if ($this->isMediaLoaded()) {
            return;
        }

        $this->getLoader()->loadMedia();

        $this->setMediaLoaded(true);
    }

    /**
     * @return bool
     */
    public function isMediaLoaded(): bool
    {
        return $this->mediaLoaded;
    }

    /**
     * @param bool $mediaLoaded
     */
    public function setMediaLoaded(bool $mediaLoaded)
    {
        $this->mediaLoaded = $mediaLoaded;
    }

    /**
     * @return Media
     */
    public function newMedia()
    {
        $mediaFile = new Media();
        $mediaFile->setCollection($this);
        $mediaFile->setModel($this->getMediaRepository()->getRecord());

        return $mediaFile;
    }

    /**
     * Append a media object inside the collection.
     *
     * @param Media          $media
     * @param AbstractLoader $loader
     */
    public function appendMediaFromLoader(Media $media, $loader)
    {
        $method = 'validateMediaFromLoader';
        $manager = $this->getRecord()->getManager();

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

        if (!method_exists($manager, $method)) {
            $this->appendMedia($media);

            return;
        }

        if ($manager->$method($media, $loader)) {
            $this->appendMedia($media);

            return;
        }
    }

    /**
     * Append a media object inside the collection.
     *
     * @param Media $media
     */
    public function appendMedia(Media $media)
    {
        $this->items[$media->getName()] = $media;

The property items does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

    }

    /**
     * @return mixed
     */
    public function getMediaType()
    {
        return $this->mediaType;
    }

    /**
     * @param mixed $mediaType
     */
    public function setMediaType($mediaType)
    {
        $this->mediaType = $mediaType;
    }

    /**
     * @param AbstractLoader $loader
     *
     * @return AbstractLoader
     */
    protected function hydrateLoader($loader)
    {
        $loader->setCollection($this);
        $loader->setFilesystem($this->getFilesystem());

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

        return $loader;
    }

    /**
     * @return mixed
     */
    protected function getLoaderClass()
    {
        $mediaLoader = config()->get('media-library.media_loader');
        if (class_exists($mediaLoader)) {
            return $mediaLoader;
        }
        return Database::class;
    }
}