Thinktomorrow\AssetLibrary\Models\Asset

Complexity

Total Complexity

38

Size/Duplication

Total Lines	275
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	5

Test Coverage

Coverage

98.92%

Importance

Changes	4
Bugs	1	Features	1

17 Methods

Rating	Name	Duplication	Size	Complexity
A	getFileUrl()	0	16	4
A	getImageUrl()	0	14	4
A	getExtensionForFilter()	0	8	2
A	getMimeType()	0	4	2
A	isMediaEmpty()	0	4	1
A	getSize()	0	4	2
A	getDimensions()	0	13	3
A	getAllAssets()	0	4	1
A	attachToModel()	0	10	1
A	hasFile()	0	4	1
A	getFilename()	0	4	1
A	getExtensionType()	0	17	4
A	remove()	0	10	3
A	typeField()	0	10	2
A	localeField()	0	4	1
A	crop()	0	16	2
B	registerMediaConversions()	0	28	4

<?php

namespace Thinktomorrow\AssetLibrary\Models;

use Illuminate\Database\Eloquent\Model;
use Illuminate\Support\Collection;
use Spatie\MediaLibrary\Exceptions\ConfigException;
use Spatie\MediaLibrary\HasMedia\HasMediaTrait;
use Spatie\MediaLibrary\HasMedia\Interfaces\HasMediaConversions;
use Spatie\MediaLibrary\Media;
use Thinktomorrow\Locale\Locale;

/**
 * @property mixed media
 */
class Asset extends Model implements HasMediaConversions
{
    use HasMediaTrait;

    /**
     * Attaches this asset instance to the given model and
     * sets the type and locale to the given values and
     * returns the model with the asset relationship.
     *
     * @param Model $model
     * @param string $type
     * @param null|string $locale
     * @return Model
     */
    public function attachToModel(Model $model, $type = '', $locale = null): Model
    {
        $model->assets->where('pivot.type', $type)->where('pivot.locale', $locale);

        $locale = $locale ?? Locale::getDefault();

        $model->assets()->attach($this, ['type' => $type, 'locale' => $locale]);

        return $model->load('assets');
    }

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

    /**
     * @param string $size
     * @return string
     */
    public function getFilename($size = ''): string
    {
        return basename($this->getFileUrl($size));
    }

    /**
     * @param string $size
     * @return string
     */
    public function getFileUrl($size = ''): string
    {
        $media = $this->getMedia();

        if ($media->count() < 1) {
            return asset('assets/back/img/other.png');
        }

        if (config('assetlibrary.conversionPrefix') && $size != '') {
            $conversionName = $media->first()->name . '_' . $size;
        } else {
            $conversionName = $size;
        }

        return $media->first()->getUrl($conversionName);
    }

    /**
     * Returns the image url or a fallback specific per filetype.
     *
     * @param string $type
     * @return string
     */
    public function getImageUrl($type = ''): string
    {
        if ($this->getMedia()->isEmpty()) {
            return asset('assets/back/img/other.png');
        }
        $extension = $this->getExtensionType();
        if ($extension === 'image') {
            return $this->getFileUrl($type);
        } elseif ($extension) {

The expression $extension of type string|null is loosely compared to true; this is ambiguous if the string can be empty. You might want to explicitly use !== null instead.

            return asset('assets/back/img/'.$extension.'.png');
        }

        return asset('assets/back/img/other.png');
    }

    /**
     * @return bool|string
     */
    public function getExtensionForFilter()
    {
        if ($extension = $this->getExtensionType()) {
            return $extension;
        }

        return '';
    }

    /**
     * @return string|null
     */
    public function getExtensionType(): ?string
    {
        $extension = explode('.', $this->getMedia()[0]->file_name);
        $extension = end($extension);

        if (in_array($extension, ['xls', 'xlsx', 'numbers', 'sheets'])) {
            return 'xls';
        }
        if (in_array($extension, ['png', 'jpg', 'jpeg', 'gif', 'svg', 'webp'])) {
            return 'image';
        }
        if ($extension === 'pdf') {
            return 'pdf';
        }

        return null;
    }

    /**
     * @return string
     */
    public function getMimeType(): string
    {
        return $this->isMediaEmpty() ? '' : $this->getMedia()[0]->mime_type;
    }

    /**
     * @return bool
     */
    public function isMediaEmpty(): bool
    {
        return $this->getMedia()->isEmpty();
    }

    /**
     * @return string
     */
    public function getSize(): string
    {
        return $this->isMediaEmpty() ? '' : $this->getMedia()[0]->human_readable_size;
    }

    /**
     * @param null $size
     * @return string
     */
    public function getDimensions($size = null): string
    {
        if($this->isMediaEmpty()) return '';

        //TODO Check the other sizes as well
        if($size === 'cropped')
        {
            $dimensions = explode(',', $this->getMedia()[0]->manipulations['cropped']['manualCrop']);
            return $dimensions[0] . ' x' . $dimensions[1];
        }

        return $this->getMedia()[0]->getCustomProperty('dimensions');
    }

    /**
     * Removes one or more assets by their ids.
     * @param $imageIds
     */
    public static function remove($imageIds)
    {
        if (is_array($imageIds)) {
            foreach ($imageIds as $id) {
                self::where('id', $id)->first()->delete();
            }
        } else {
            self::find($imageIds)->first()->delete();
        }
    }

    /**
     * Returns a collection of all the assets in the library.
     * @return \Illuminate\Support\Collection
     */
    public static function getAllAssets(): Collection
    {
        return self::all()->sortByDesc('created_at');
    }

    /**
     * Generates the hidden field that links the file to a specific type.
     *
     * @param string $type
     * @param null $locale
     *
     * @param string $name
     * @return string
     */
    public static function typeField($type = '', $locale = null, $name = 'type'): string
    {
        $result = '<input type="hidden" value="'.$type.'" name="';

        if (! $locale) {
            return $result.$name.'">';
        }

        return $result.'trans['.$locale.'][files][]">';
    }

    /**
     * Generates the hidden field that links the file to translations.
     *
     * @param string $locale
     *
     * @return string
     */
    public static function localeField($locale = ''): string
    {
        return self::typeField($locale, null, 'locale');
    }

    /**
     * @param $width
     * @param $height
     * @param $x
     * @param $y
     *
     * @return $this
     * @throws \Spatie\MediaLibrary\Exceptions\ConfigException
     */
    public function crop($width, $height, $x, $y)
    {
        if(!config('assetlibrary.allowCropping'))
        {
            throw ConfigException::create();
        }
        $this->media[0]->manipulations = [
            'cropped'   => [
                'manualCrop' => $width . ', ' . $height . ', ' . $x . ', ' . $y
            ]
        ];

        $this->media[0]->save();

        return $this;
    }

    /**
     * Register the conversions that should be performed.
     *
     * @param Media|null $media
     */
    public function registerMediaConversions(Media $media = null): void
    {
        $conversions        = config('assetlibrary.conversions');
        $conversionPrefix   = config('assetlibrary.conversionPrefix');

        foreach ($conversions as $key => $value) {
            if ($conversionPrefix) {
                $conversionName = $media->name.'_'.$key;
            } else {
                $conversionName = $key;
            }

            $this->addMediaConversion($conversionName)
                ->width($value['width'])
                ->height($value['height'])
                ->sharpen(15)
                ->keepOriginalImageFormat()
                ->optimize();
        }

        if(config('assetlibrary.allowCropping'))
        {
            $this->addMediaConversion('cropped')
                ->sharpen(15)
                ->keepOriginalImageFormat()
                ->optimize();
        }
    }
}