Thinktomorrow\AssetLibrary\Traits\AssetTrait

Complexity

Total Complexity

25

Size/Duplication

Total Lines	200
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	4

Test Coverage

Coverage

100%

Importance

Changes

0

12 Methods

Rating	Name	Duplication	Size	Complexity
A	assets()	0	4	1
A	hasFile()	0	6	2
A	getFilename()	0	4	1
B	getFileUrl()	0	19	5
B	addFile()	0	21	5
A	addFiles()	0	18	4
A	getAllImages()	0	8	1
A	deleteAsset()	0	4	1
A	replaceAsset()	0	7	1
A	getAllFiles()	0	8	1
A	sortFiles()	0	11	2
A	normalizeLocale()	0	6	1

<?php

namespace Thinktomorrow\AssetLibrary\Traits;

use Spatie\MediaLibrary\HasMedia\HasMediaTrait;
use Thinktomorrow\AssetLibrary\Models\Asset;
use Thinktomorrow\AssetLibrary\Models\AssetUploader;
use Thinktomorrow\Locale\Locale;
use Traversable;

trait AssetTrait
{
    use HasMediaTrait;

    /**
     * @return mixed
     */
    public function assets()
    {
        return $this->morphToMany(Asset::class, 'entity', 'asset_pivots')->withPivot('type', 'locale', 'order')->orderBy('order');

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

This line exceeds maximum limit of 120 characters; contains 130 characters

    }

    /**
     * @param string $type
     * @param string|null $locale
     * @return bool
     */
    public function hasFile($type = '', $locale = null): bool
    {
        $filename = $this->getFilename($type, $locale);

        return (bool) $filename && basename($filename) != 'other.png';
    }

    /**
     * @param string $type
     * @param string|null $locale
     * @return string
     */
    public function getFilename($type = '', $locale = null): string
    {
        return basename($this->getFileUrl($type, '', $locale));
    }

    /**
     * @param string $type
     * @param string $size
     * @param string|null $locale
     * @return string
     */
    public function getFileUrl($type = '', $size = '', $locale = null): ?string
    {
        if ($this->assets->first() === null || $this->assets->first()->pivot === null) {

The property assets does not exist. Did you maybe forget to declare it?

            return null;
        }

        $locale = $this->normalizeLocale($locale);

        $assets = $this->assets->where('pivot.type', $type);
        if ($assets->count() > 1) {
            $assets = $assets->where('pivot.locale', $locale);
        }

        if ($assets->isEmpty()) {
            return null;
        }

        return $assets->first()->getFileUrl($size);
    }

    /**
     * Adds a file to this model, accepts a type and locale to be saved with the file.
     *
     * @param $file
     * @param string $type
     * @param string|null $locale
     * @param null $filename
     * @param bool $keepOriginal
     * @throws \Spatie\MediaLibrary\Exceptions\FileCannotBeAdded
     * @throws \Thinktomorrow\AssetLibrary\Exceptions\AssetUploadException
     */
    public function addFile($file, $type = '', $locale = null, $filename = null, $keepOriginal = false): void
    {
        if($file instanceof Traversable || is_array($file))
        {
            $this->addFiles($file, $type, $locale, $keepOriginal);
        }else{
            $locale = $this->normalizeLocale($locale);

            if(is_string($file))
            {
                $asset = AssetUploader::uploadFromBase64($file, $filename, $keepOriginal);
            }else{
                $asset = AssetUploader::upload($file, $filename, $keepOriginal);
            }

            if($asset instanceof Asset){
                $asset->attachToModel($this, $type, $locale);
            }
        }

    }

    /**
     * Adds multiple files to this model, accepts a type and locale to be saved with the file.
     *
     * @param $files
     * @param string $type
     * @param string|null $locale
     * @param bool $keepOriginal
     * @throws \Spatie\MediaLibrary\Exceptions\FileCannotBeAdded
     * @throws \Thinktomorrow\AssetLibrary\Exceptions\AssetUploadException
     */
    public function addFiles($files, $type = '', $locale = null, $keepOriginal = false): void
    {
        $files = (array) $files;
        $locale = $this->normalizeLocale($locale);

        if(is_string(array_values($files)[0]))
        {
            foreach($files as $filename => $file)
            {
                $this->addFile($file, $type, $locale, $filename, $keepOriginal);
            }
        }else{
            foreach($files as $filename => $file)
            {
                $this->addFile($file, $type, $locale, null, $keepOriginal);
            }
        }
    }

    /**
     * @return mixed
     */
    public function getAllImages()
    {
        $images = $this->assets->filter(function ($asset) {
            return $asset->getExtensionForFilter() === 'image';
        });

        return $images->sortBy('pivot.order');
    }

    /**
     * Removes an asset completely.
     *
     * @param $ids
     */
    public function deleteAsset($ids): void
    {
        Asset::remove($ids);
    }

    /**
     * Remove the asset and attaches a new one.
     *
     * @param $replace
     * @param $with
     * @throws \Spatie\MediaLibrary\Exceptions\FileCannotBeAdded
     */
    public function replaceAsset($replace, $with): void
    {
        $asset = Asset::findOrFail($replace);
        Asset::remove($replace);

        $this->addFile(Asset::findOrFail($with), $asset->type, $asset->locale);
    }

    /**
     * @param null $type
     * @param string|null $locale
     * @return mixed
     */
    public function getAllFiles($type = null, $locale = null)
    {
        $locale = $this->normalizeLocale($locale);

        $files = $this->assets->where('pivot.type', $type)->where('pivot.locale', $locale);

        return $files->sortBy('pivot.order');
    }

    /**
     * @param $callback
     */
    public function sortFiles($type = null, $sorting)

Parameters which have default values should be placed at the end.

    {
        $files = $this->getAllFiles($type);

        $files->each(function($file) use($sorting){
            if(in_array($file->id, $sorting)){
                $this->assets()->updateExistingPivot($file->id, ['order' => array_search(3, $sorting)]);
            }
        });

    }


    /**
     * @param string|null $locale
     * @return string
     */
    private function normalizeLocale($locale = null): string
    {
        $locale = $locale ?? Locale::getDefault();

        return $locale;
    }
}