Asset::getDimensions() - Code Metrics - Inspection of "clean up code" - thinktomorrow/assetlibrary - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — 0.6 ( 2a9301...913fb9 )

by Philippe

created 2019-10-12 14:02 UTC

Asset::getDimensions() A

↳ Parent: Asset

Complexity

Conditions	3
Paths	3

Size

Total Lines	14
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	7
CRAP Score	3

Importance

Changes	1
Bugs	1	Features	0

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

<?php

namespace Thinktomorrow\AssetLibrary\Models;

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

class Asset extends Model implements HasAsset
{
    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));
    }

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

        if ($media == null) {
            throw CorruptMediaException::corrupt($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::corrupt($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('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
     * @throws \Spatie\Image\Exceptions\InvalidManipulation
     */
    public function registerMediaConversions(Media $media = null)
    {
        $conversions = config('assetlibrary.conversions');

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

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


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

thinktomorrow / assetlibrary

Push — 0.6 ( 2a9301...913fb9 )

Asset::getDimensions() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like