Asset::hasFile() - Code Metrics - Inspection of "Add nullasset to catch errors if an asset doesnt e..." - thinktomorrow/assetlibrary - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( c230fb...1c12b0 )

by Philippe

created 2019-11-05 16:50 UTC

Asset::hasFile() A

↳ Parent: Asset

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

Metric	Value
cc	1
eloc	1
nc	1
nop	0
dl	0
loc	3
ccs	2
cts	2
cp	1
crap	1
rs	10
c	0
b	0
f	0

<?php

namespace Thinktomorrow\AssetLibrary;

use Illuminate\Database\Eloquent\Model;
use Spatie\MediaLibrary\HasMedia\HasMedia;
use Spatie\MediaLibrary\HasMedia\HasMediaTrait;
use Spatie\MediaLibrary\Models\Media;
use Thinktomorrow\AssetLibrary\Exceptions\ConfigException;
use Thinktomorrow\AssetLibrary\Exceptions\CorruptMediaException;

class Asset extends Model implements HasMedia
{
    use HasMediaTrait;


    private $order;


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

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

    public function exists(): bool
    {
        return true;
    }

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

        if ($media == null) {
            throw CorruptMediaException::missingMediaRelation($this->id);
        }

        return $media->getUrl($size);
    }

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

        return '';
    }

    /**
     * @return null|string
     * @throws CorruptMediaException
     */
    public function getExtensionType(): ?string
    {
        $media = $this->getMedia()->first();

        if ($media == null) {
            throw CorruptMediaException::missingMediaRelation($this->id);
        }

        $extension = explode('.', $media->file_name);
        $extension = end($extension);

        if ($extension) {
            if (in_array(strtolower($extension), ['xls', 'xlsx', 'numbers', 'sheets'])) {
                return 'xls';
            }
            if (in_array(strtolower($extension), ['png', 'jpg', 'jpeg', 'gif', 'svg', 'webp'])) {
                return 'image';
            }
            if (strtolower($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 string|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');
    }

    /**
     * @param $width
     * @param $height
     * @param $x
     * @param $y
     * @return $this
     * @throws ConfigException
     */
    public function crop($width, $height, $x, $y)
    {
        if (! config('thinktomorrow.assetlibrary.allowCropping')) {
            throw ConfigException::croppingDisabled();
        }
        $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
     * @throws \Spatie\Image\Exceptions\InvalidManipulation
     */
    public function registerMediaConversions(Media $media = null)
    {
        $conversions = config('thinktomorrow.assetlibrary.conversions');

        foreach ($conversions as $key => $value) {
            $this->addMediaConversion($key)
                ->width($value['width'])
                ->height($value['height'])
                ->keepOriginalImageFormat()
                ->optimize();
        }

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


1		<?php
2
3		namespace Thinktomorrow\AssetLibrary;
4
5		use Illuminate\Database\Eloquent\Model;
6		use Spatie\MediaLibrary\HasMedia\HasMedia;
7		use Spatie\MediaLibrary\HasMedia\HasMediaTrait;
8		use Spatie\MediaLibrary\Models\Media;
9		use Thinktomorrow\AssetLibrary\Exceptions\ConfigException;
10		use Thinktomorrow\AssetLibrary\Exceptions\CorruptMediaException;
11
12		class Asset extends Model implements HasMedia
13		{
14		use HasMediaTrait;
		0 ignored issues – show introduced 2019-10-23 15:01 UTC by Report Bug Copy Issue Report The trait `Spatie\MediaLibrary\HasMedia\HasMediaTrait` requires some properties which are not provided by `Thinktomorrow\AssetLibrary\Asset`: `$fallbackPath`, `$each`, `$mediaConversionRegistrations`, `$forceDeleting`, `$fallbackUrl`, `$media`, `$collection_name` Loading history...
15
16		private $order;
		0 ignored issues – show introduced 2019-10-12 14:09 UTC by Report Bug Copy Issue Report The private property `$order` is not used, and could be removed. Loading history...
17
18		/**
19		* @return bool
20		*/
21	1	public function hasFile(): bool
22		{
23	1	return (bool) $this->url();
24		}
25
26		/**
27		* @param string $size
28		* @return string
29		*/
30	17	public function filename($size = ''): string
31		{
32	17	return basename($this->url($size));
33		}
34
35	1	public function exists(): bool
36		{
37	1	return true;
38		}
39
40		/**
41		* @param string $size
42		* @return string
43		*/
44	46	public function url($size = ''): string
45		{
46	46	$media = $this->getMedia()->first();
47
48	46	if ($media == null) {
49	1	throw CorruptMediaException::missingMediaRelation($this->id);
50		}
51
52	45	return $media->getUrl($size);
53		}
54
55		/**
56		* @return bool\|string
57		*/
58	2	public function getExtensionForFilter()
59		{
60	2	if ($extension = $this->getExtensionType()) {
61	1	return $extension;
62		}
63
64	1	return '';
65		}
66
67		/**
68		* @return null\|string
69		* @throws CorruptMediaException
70		*/
71	2	public function getExtensionType(): ?string
72		{
73	2	$media = $this->getMedia()->first();
74
75	2	if ($media == null) {
76	1	throw CorruptMediaException::missingMediaRelation($this->id);
77		}
78
79	1	$extension = explode('.', $media->file_name);
80	1	$extension = end($extension);
81
82	1	if ($extension) {
83	1	if (in_array(strtolower($extension), ['xls', 'xlsx', 'numbers', 'sheets'])) {
84	1	return 'xls';
85		}
86	1	if (in_array(strtolower($extension), ['png', 'jpg', 'jpeg', 'gif', 'svg', 'webp'])) {
87	1	return 'image';
88		}
89	1	if (strtolower($extension) === 'pdf') {
90	1	return 'pdf';
91		}
92		}
93
94	1	return null;
95		}
96
97		/**
98		* @return string
99		*/
100	2	public function getMimeType(): string
101		{
102	2	return $this->isMediaEmpty() ? '' : $this->getMedia()[0]->mime_type;
103		}
104
105		/**
106		* @return bool
107		*/
108	5	public function isMediaEmpty(): bool
109		{
110	5	return $this->getMedia()->isEmpty();
111		}
112
113		/**
114		* @return string
115		*/
116	2	public function getSize(): string
117		{
118	2	return $this->isMediaEmpty() ? '' : $this->getMedia()[0]->human_readable_size;
119		}
120
121		/**
122		* @param string\|null $size
123		* @return string
124		*/
125	3	public function getDimensions($size = null): string
126		{
127	3	if ($this->isMediaEmpty()) {
128	1	return '';
129		}
130
131		//TODO Check the other sizes as well
132	2	if ($size === 'cropped') {
133	1	$dimensions = explode(',', $this->getMedia()[0]->manipulations['cropped']['manualCrop']);
134
135	1	return $dimensions[0].' x'.$dimensions[1];
136		}
137
138	1	return $this->getMedia()[0]->getCustomProperty('dimensions');
139		}
140
141		/**
142		* @param $width
143		* @param $height
144		* @param $x
145		* @param $y
146		* @return $this
147		* @throws ConfigException
148		*/
149	2	public function crop($width, $height, $x, $y)
150		{
151	2	if (! config('thinktomorrow.assetlibrary.allowCropping')) {
152	1	throw ConfigException::croppingDisabled();
153		}
154	1	$this->media[0]->manipulations = [
		0 ignored issues – show Bug introduced 2019-10-23 15:01 UTC by Report Bug Copy Issue Report The property `media` does not seem to exist on `Thinktomorrow\AssetLibrary\Asset`. Are you sure there is no database migration missing? Checks if undeclared accessed properties appear in database migrations and if the creating migration is correct. Loading history...
155		'cropped' => [
156	1	'manualCrop' => $width.', '.$height.', '.$x.', '.$y,
157		],
158		];
159
160	1	$this->media[0]->save();
161
162	1	return $this;
163		}
164
165		/**
166		* Register the conversions that should be performed.
167		*
168		* @param Media\|null $media
169		* @throws \Spatie\Image\Exceptions\InvalidManipulation
170		*/
171	48	public function registerMediaConversions(Media $media = null)
172		{
173	48	$conversions = config('thinktomorrow.assetlibrary.conversions');
174
175	48	foreach ($conversions as $key => $value) {
176	48	$this->addMediaConversion($key)
177	48	->width($value['width'])
178	48	->height($value['height'])
179	48	->keepOriginalImageFormat()
180	48	->optimize();
181		}
182
183	48	if (config('thinktomorrow.assetlibrary.allowCropping')) {
184	1	$this->addMediaConversion('cropped')
185	1	->keepOriginalImageFormat()
186	1	->optimize();
187		}
188	48	}
189		}
190

thinktomorrow / assetlibrary

Push — master ( c230fb...1c12b0 )

Asset::hasFile() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like