Scrutinizer GitHub App not installed

We could not synchronize checks via GitHub's checks API since Scrutinizer's GitHub App is not installed for this repository.

Install GitHub App

Completed
Pull Request — master (#124)
by Owen
04:35
created

CrudTrait::uploadImageToDisk()   F

Complexity

Conditions 34
Paths 2144

Size

Total Lines 149
Code Lines 92

Duplication

Lines 50
Ratio 33.56 %

Importance

Changes 1
Bugs 1 Features 0
Metric Value
cc 34
eloc 92
c 1
b 1
f 0
nc 2144
nop 5
dl 50
loc 149
rs 2

How to fix   Long Method    Complexity   

Long Method

Small methods make your code easier to understand, in particular if combined with a good name. Besides, if your method is small, finding a good name is usually much easier.

For example, if you find yourself adding comments to a method's body, this is usually a good sign to extract the commented part to a new method, and use the comment as a starting point when coming up with a good name for this new method.

Commonly applied refactorings include:

1
<?php
2
3
namespace Backpack\CRUD;
4
5
use DB;
6
use Illuminate\Database\Eloquent\Model;
7
8
trait CrudTrait
9
{
10
    /*
11
    |--------------------------------------------------------------------------
12
    | Methods for ENUM and SELECT crud fields.
13
    |--------------------------------------------------------------------------
14
    */
15
16
    public static function getPossibleEnumValues($field_name)
0 ignored issues
show
Coding Style Naming introduced by
The parameter $field_name is not named in camelCase.

This check marks parameter names that have not been written in camelCase.

In camelCase names are written without any punctuation, the start of each new word being marked by a capital letter. Thus the name database connection string becomes databaseConnectionString.

Loading history...
17
    {
18
        $instance = new static(); // create an instance of the model to be able to get the table name
19
        $type = DB::select(DB::raw('SHOW COLUMNS FROM '.$instance->getTable().' WHERE Field = "'.$field_name.'"'))[0]->Type;
0 ignored issues
show
Bug introduced by
It seems like getTable() must be provided by classes using this trait. How about adding it as abstract method to this trait?

This check looks for methods that are used by a trait but not required by it.

To illustrate, let’s look at the following code example

trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}

The trait Idable provides a method equalsId that in turn relies on the method getId(). If this method does not exist on a class mixing in this trait, the method will fail.

Adding the getId() as an abstract method to the trait will make sure it is available.

Loading history...
Coding Style introduced by
This line exceeds maximum limit of 120 characters; contains 124 characters

Overly long lines are hard to read on any screen. Most code styles therefor impose a maximum limit on the number of characters in a line.

Loading history...
20
        preg_match('/^enum\((.*)\)$/', $type, $matches);
21
        $enum = [];
22
        foreach (explode(',', $matches[1]) as $value) {
23
            $enum[] = trim($value, "'");
24
        }
25
26
        return $enum;
27
    }
28
29
    public static function isColumnNullable($column_name)
0 ignored issues
show
Coding Style Naming introduced by
The parameter $column_name is not named in camelCase.

This check marks parameter names that have not been written in camelCase.

In camelCase names are written without any punctuation, the start of each new word being marked by a capital letter. Thus the name database connection string becomes databaseConnectionString.

Loading history...
30
    {
31
        $instance = new static(); // create an instance of the model to be able to get the table name
32
        $answer = DB::select(DB::raw("SELECT IS_NULLABLE FROM INFORMATION_SCHEMA.COLUMNS WHERE TABLE_NAME='".$instance->getTable()."' AND COLUMN_NAME='".$column_name."' AND table_schema='".env('DB_DATABASE')."'"))[0];
0 ignored issues
show
Bug introduced by
It seems like getTable() must be provided by classes using this trait. How about adding it as abstract method to this trait?

This check looks for methods that are used by a trait but not required by it.

To illustrate, let’s look at the following code example

trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}

The trait Idable provides a method equalsId that in turn relies on the method getId(). If this method does not exist on a class mixing in this trait, the method will fail.

Adding the getId() as an abstract method to the trait will make sure it is available.

Loading history...
Coding Style introduced by
This line exceeds maximum limit of 120 characters; contains 217 characters

Overly long lines are hard to read on any screen. Most code styles therefor impose a maximum limit on the number of characters in a line.

Loading history...
33
34
        return $answer->IS_NULLABLE === 'YES';
35
    }
36
37
    /*
38
    |--------------------------------------------------------------------------
39
    | Methods for Fake Fields functionality (used in PageManager).
40
    |--------------------------------------------------------------------------
41
    */
42
43
    /**
44
     * Add fake fields as regular attributes, even though they are stored as JSON.
45
     *
46
     * @param array $columns - the database columns that contain the JSONs
47
     */
48
    public function addFakes($columns = ['extras'])
49
    {
50
        foreach ($columns as $key => $column) {
51
            $column_contents = $this->{$column};
52
53
            if (! is_object($this->{$column})) {
54
                $column_contents = json_decode($this->{$column});
55
            }
56
57
            if (count($column_contents)) {
58
                foreach ($column_contents as $fake_field_name => $fake_field_value) {
59
                    $this->setAttribute($fake_field_name, $fake_field_value);
0 ignored issues
show
Bug introduced by
It seems like setAttribute() must be provided by classes using this trait. How about adding it as abstract method to this trait?

This check looks for methods that are used by a trait but not required by it.

To illustrate, let’s look at the following code example

trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}

The trait Idable provides a method equalsId that in turn relies on the method getId(). If this method does not exist on a class mixing in this trait, the method will fail.

Adding the getId() as an abstract method to the trait will make sure it is available.

Loading history...
60
                }
61
            }
62
        }
63
    }
64
65
    /**
66
     * Return the entity with fake fields as attributes.
67
     *
68
     * @param array $columns - the database columns that contain the JSONs
69
     *
70
     * @return Model
0 ignored issues
show
Documentation introduced by
Should the return type not be CrudTrait?

This check compares the return type specified in the @return annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch.

Loading history...
71
     */
72
    public function withFakes($columns = [])
73
    {
74
        $model = '\\'.get_class($this);
75
76
        if (! count($columns)) {
77
            $columns = (property_exists($model, 'fakeColumns')) ? $this->fakeColumns : ['extras'];
0 ignored issues
show
Bug introduced by
The property fakeColumns does not exist. Did you maybe forget to declare it?

In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code:

class MyClass { }

$x = new MyClass();
$x->foo = true;

Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion:

class MyClass {
    public $foo;
}

$x = new MyClass();
$x->foo = true;
Loading history...
78
        }
79
80
        $this->addFakes($columns);
81
82
        return $this;
83
    }
84
85
    /*
86
    |--------------------------------------------------------------------------
87
    | Methods for storing uploaded files (used in CRUD).
88
    |--------------------------------------------------------------------------
89
    */
90
91
    /**
92
     * Handle file upload and DB storage for a file:
93
     * - on CREATE
94
     *     - stores the file at the destination path
95
     *     - generates a name
96
     *     - stores the full path in the DB;
97
     * - on UPDATE
98
     *     - if the value is null, deletes the file and sets null in the DB
99
     *     - if the value is different, stores the different file and updates DB value.
100
     *
101
     * @param  [type] $value            Value for that column sent from the input.
0 ignored issues
show
Documentation introduced by
The doc-type [type] could not be parsed: Unknown type name "" at position 0. [(view supported doc-types)

This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types.

Loading history...
102
     * @param  [type] $attribute_name   Model attribute name (and column in the db).
0 ignored issues
show
Documentation introduced by
The doc-type [type] could not be parsed: Unknown type name "" at position 0. [(view supported doc-types)

This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types.

Loading history...
103
     * @param  [type] $disk             Filesystem disk used to store files.
0 ignored issues
show
Documentation introduced by
The doc-type [type] could not be parsed: Unknown type name "" at position 0. [(view supported doc-types)

This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types.

Loading history...
104
     * @param  [type] $destination_path Path in disk where to store the files.
0 ignored issues
show
Documentation introduced by
The doc-type [type] could not be parsed: Unknown type name "" at position 0. [(view supported doc-types)

This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types.

Loading history...
105
     */
106
    public function uploadFileToDisk($value, $attribute_name, $disk, $destination_path)
0 ignored issues
show
Coding Style Naming introduced by
The parameter $attribute_name is not named in camelCase.

This check marks parameter names that have not been written in camelCase.

In camelCase names are written without any punctuation, the start of each new word being marked by a capital letter. Thus the name database connection string becomes databaseConnectionString.

Loading history...
Coding Style Naming introduced by
The parameter $destination_path is not named in camelCase.

This check marks parameter names that have not been written in camelCase.

In camelCase names are written without any punctuation, the start of each new word being marked by a capital letter. Thus the name database connection string becomes databaseConnectionString.

Loading history...
107
    {
108
        $request = \Request::instance();
109
110
        // if a new file is uploaded, delete the file from the disk
111
        if ($request->hasFile($attribute_name) &&
112
            $this->{$attribute_name} &&
113
            $this->{$attribute_name} != null) {
114
            \Storage::disk($disk)->delete($this->{$attribute_name});
115
            $this->attributes[$attribute_name] = null;
0 ignored issues
show
Bug introduced by
The property attributes does not exist. Did you maybe forget to declare it?

In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code:

class MyClass { }

$x = new MyClass();
$x->foo = true;

Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion:

class MyClass {
    public $foo;
}

$x = new MyClass();
$x->foo = true;
Loading history...
116
        }
117
118
        // if the file input is empty, delete the file from the disk
119
        if (is_null($value) && $this->{$attribute_name} != null) {
120
            \Storage::disk($disk)->delete($this->{$attribute_name});
121
            $this->attributes[$attribute_name] = null;
122
        }
123
124
        // if a new file is uploaded, store it on disk and its filename in the database
125 View Code Duplication
        if ($request->hasFile($attribute_name) && $request->file($attribute_name)->isValid()) {
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
126
127
            // 1. Generate a new file name
128
            $file = $request->file($attribute_name);
129
            $new_file_name = md5($file->getClientOriginalName().time()).'.'.$file->getClientOriginalExtension();
130
131
            // 2. Move the new file to the correct path
132
            $file_path = $file->storeAs($destination_path, $new_file_name, $disk);
133
134
            // 3. Save the complete path to the database
135
            $this->attributes[$attribute_name] = $file_path;
136
        }
137
    }
138
139
    /**
140
     * Handle multiple file upload and DB storage:
141
     * - if files are sent
142
     *     - stores the files at the destination path
143
     *     - generates random names
144
     *     - stores the full path in the DB, as JSON array;
145
     * - if a hidden input is sent to clear one or more files
146
     *     - deletes the file
147
     *     - removes that file from the DB.
148
     *
149
     * @param  [type] $value            Value for that column sent from the input.
0 ignored issues
show
Documentation introduced by
The doc-type [type] could not be parsed: Unknown type name "" at position 0. [(view supported doc-types)

This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types.

Loading history...
150
     * @param  [type] $attribute_name   Model attribute name (and column in the db).
0 ignored issues
show
Documentation introduced by
The doc-type [type] could not be parsed: Unknown type name "" at position 0. [(view supported doc-types)

This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types.

Loading history...
151
     * @param  [type] $disk             Filesystem disk used to store files.
0 ignored issues
show
Documentation introduced by
The doc-type [type] could not be parsed: Unknown type name "" at position 0. [(view supported doc-types)

This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types.

Loading history...
152
     * @param  [type] $destination_path Path in disk where to store the files.
0 ignored issues
show
Documentation introduced by
The doc-type [type] could not be parsed: Unknown type name "" at position 0. [(view supported doc-types)

This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types.

Loading history...
153
     */
154
    public function uploadMultipleFilesToDisk($value, $attribute_name, $disk, $destination_path)
0 ignored issues
show
Unused Code introduced by
The parameter $value is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
Coding Style Naming introduced by
The parameter $attribute_name is not named in camelCase.

This check marks parameter names that have not been written in camelCase.

In camelCase names are written without any punctuation, the start of each new word being marked by a capital letter. Thus the name database connection string becomes databaseConnectionString.

Loading history...
Coding Style Naming introduced by
The parameter $destination_path is not named in camelCase.

This check marks parameter names that have not been written in camelCase.

In camelCase names are written without any punctuation, the start of each new word being marked by a capital letter. Thus the name database connection string becomes databaseConnectionString.

Loading history...
155
    {
156
        $request = \Request::instance();
157
        $attribute_value = (array) $this->{$attribute_name};
158
        $files_to_clear = $request->get('clear_'.$attribute_name);
159
160
        // if a file has been marked for removal,
161
        // delete it from the disk and from the db
162
        if ($files_to_clear) {
163
            $attribute_value = (array) $this->{$attribute_name};
164
            foreach ($files_to_clear as $key => $filename) {
165
                \Storage::disk($disk)->delete($filename);
166
                $attribute_value = array_where($attribute_value, function ($value, $key) use ($filename) {
0 ignored issues
show
Unused Code introduced by
The parameter $key is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
167
                    return $value != $filename;
168
                });
169
            }
170
        }
171
172
        // if a new file is uploaded, store it on disk and its filename in the database
173 View Code Duplication
        if ($request->hasFile($attribute_name)) {
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
174
            foreach ($request->file($attribute_name) as $file) {
0 ignored issues
show
Bug introduced by
The expression $request->file($attribute_name) of type object<Illuminate\Http\UploadedFile>|array|null is not guaranteed to be traversable. How about adding an additional type check?

There are different options of fixing this problem.

  1. If you want to be on the safe side, you can add an additional type-check:

    $collection = json_decode($data, true);
    if ( ! is_array($collection)) {
        throw new \RuntimeException('$collection must be an array.');
    }
    
    foreach ($collection as $item) { /** ... */ }
    
  2. If you are sure that the expression is traversable, you might want to add a doc comment cast to improve IDE auto-completion and static analysis:

    /** @var array $collection */
    $collection = json_decode($data, true);
    
    foreach ($collection as $item) { /** .. */ }
    
  3. Mark the issue as a false-positive: Just hover the remove button, in the top-right corner of this issue for more options.

Loading history...
175
                if ($file->isValid()) {
176
                    // 1. Generate a new file name
177
                    $new_file_name = md5($file->getClientOriginalName().time()).'.'.$file->getClientOriginalExtension();
178
179
                    // 2. Move the new file to the correct path
180
                    $file_path = $file->storeAs($destination_path, $new_file_name, $disk);
181
182
                    // 3. Add the public path to the database
183
                    $attribute_value[] = $file_path;
184
                }
185
            }
186
        }
187
188
        $this->attributes[$attribute_name] = json_encode($attribute_value);
189
    }
190
191
    /**
192
     * Handle image upload and DB storage for a image:
193
     * - on CREATE
194
     *     - stores the image at the destination path
195
     *     - generates a name
196
     *     - creates image variations
197
     *     - stores json object into database with variations and paths
198
     * - on UPDATE
199
     *     - if the value is null, deletes the file and sets null in the DB
200
     *     - if the value is different, stores the different file and updates DB value.
201
     *
202
     * @param  [type] $value            Value for that column sent from the input.
0 ignored issues
show
Documentation introduced by
The doc-type [type] could not be parsed: Unknown type name "" at position 0. [(view supported doc-types)

This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types.

Loading history...
203
     * @param  [type] $attribute_name   Model attribute name (and column in the db).
0 ignored issues
show
Documentation introduced by
The doc-type [type] could not be parsed: Unknown type name "" at position 0. [(view supported doc-types)

This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types.

Loading history...
204
     * @param  [type] $disk             Filesystem disk used to store files.
0 ignored issues
show
Documentation introduced by
The doc-type [type] could not be parsed: Unknown type name "" at position 0. [(view supported doc-types)

This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types.

Loading history...
205
     * @param  [type] $destination_path Path in disk where to store the files.
0 ignored issues
show
Documentation introduced by
The doc-type [type] could not be parsed: Unknown type name "" at position 0. [(view supported doc-types)

This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types.

Loading history...
206
     * @param  [type] $variations       Array of variations and their dimensions
0 ignored issues
show
Documentation introduced by
The doc-type [type] could not be parsed: Unknown type name "" at position 0. [(view supported doc-types)

This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types.

Loading history...
207
     */
208
    public function uploadImageToDisk($value, $attribute_name, $disk, $destination_path, $variations = null)
0 ignored issues
show
Coding Style Naming introduced by
The parameter $attribute_name is not named in camelCase.

This check marks parameter names that have not been written in camelCase.

In camelCase names are written without any punctuation, the start of each new word being marked by a capital letter. Thus the name database connection string becomes databaseConnectionString.

Loading history...
Coding Style Naming introduced by
The parameter $destination_path is not named in camelCase.

This check marks parameter names that have not been written in camelCase.

In camelCase names are written without any punctuation, the start of each new word being marked by a capital letter. Thus the name database connection string becomes databaseConnectionString.

Loading history...
209
    {
210
        if (! $variations || ! is_array($variations)) {
211
            $variations = ['original' => null, 'thumb' => [150, 150]];
212
        }
213
214
        //Needed for the original image
215
        if (! array_key_exists('original', $variations)) {
216
            $variations['original'] = null;
217
        }
218
219
        //Needed for admin thumbnails
220
        if (! array_key_exists('thumb', $variations)) {
221
            $variations['thumb'] = [150, 150];
222
        }
223
224
        $request = \Request::instance();
225
226
        //We need to setup the disk paths as they're handled differently
227
        //depending if you need a public path or internal storage
228
        $disk_config = config('filesystems.disks.'.$disk);
229
        $disk_root = $disk_config['root'];
230
231
        //if the disk is public, we need to know the public path
232 View Code Duplication
        if ($disk_config['visibility'] == 'public') {
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
233
            $public_path = str_replace(public_path(), '', $disk_root);
234
        } else {
235
            $public_path = $disk_root;
236
        }
237
238
        // if a new file is uploaded, delete the file from the disk
239
        if (($request->hasFile($attribute_name) || starts_with($value, 'data:image')) && $this->{$attribute_name}) {
240 View Code Duplication
            foreach ($variations as $variant => $dimensions) {
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
241
                $variant_name = str_replace('-original', '-'.$variant, $this->{$attribute_name});
242
                \Storage::disk($disk)->delete($variant_name);
243
            }
244
            $this->attributes[$attribute_name] = null;
245
        }
246
247
        // if the file input is empty, delete the file from the disk
248
        if (empty($value)) {
249 View Code Duplication
            foreach ($variations as $variant => $dimensions) {
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
250
                $variant_name = str_replace('-original', '-'.$variant, $this->{$attribute_name});
251
                \Storage::disk($disk)->delete($variant_name);
252
            }
253
254
            return $this->attributes[$attribute_name] = null;
255
        }
256
257
        // if a new file is uploaded, store it on disk and its filename in the database
258
        if ($request->hasFile($attribute_name) && $request->file($attribute_name)->isValid()) {
259
260
            // 1. Generate a new file name
261
            $file = $request->file($attribute_name);
262
            $new_file_name = md5($file->getClientOriginalName().time());
263
            $new_file = $new_file_name.'.'.$file->getClientOriginalExtension();
264
265
            // 2. Move the new file to the correct path
266
            $file_path = $file->storeAs($destination_path, $new_file, $disk);
267
            $image_variations = [];
268
269
            // 3. but only if they have the ability to crop/handle images
270
            if (class_exists('\Intervention\Image\ImageManagerStatic')) {
271
                $img = \Intervention\Image\ImageManagerStatic::make($file);
272
                foreach ($variations as $variant => $dimensions) {
273
                    $variant_name = $new_file_name.'-'.$variant.'.'.$file->getClientOriginalExtension();
274
                    $variant_file = $destination_path.'/'.$variant_name;
275
276 View Code Duplication
                    if ($dimensions) {
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
277
                        $width = $dimensions[0];
278
                        $height = $dimensions[1];
279
280
                        if ($img->width() > $width || $img->height() > $height) {
281
                            $img->resize($width, $height, function ($constraint) {
282
                                $constraint->aspectRatio();
283
                            })
284
                            ->save($disk_root.'/'.$variant_file);
285
                        } else {
286
                            $img->save($disk_root.'/'.$variant_file);
287
                        }
288
289
                        $image_variations[$variant] = $public_path.'/'.$variant_file;
290
                    } else {
291
                        $image_variations['original'] = $public_path.'/'.$file_path;
292
                    }
293
                }
294
            } else {
295
                $image_variations['original'] = $public_path.'/'.$file_path;
296
                $image_variations['thumb'] = $public_path.'/'.$file_path;
297
            }
298
299
            // 3. Save the complete path to the database
300
            $this->attributes[$attribute_name] = $image_variations['original'];
301
        } elseif (starts_with($value, 'data:image')) {
302
            $img = \Intervention\Image\ImageManagerStatic::make($value);
303
            $new_file_name = md5($value.time());
304
305
            if (! \Illuminate\Support\Facades\File::exists($destination_path)) {
306
                \Illuminate\Support\Facades\File::makeDirectory($destination_path, 0775, true);
307
            }
308
309
            foreach ($variations as $variant => $dimensions) {
310
                switch ($img->mime()) {
311
                    case 'image/bmp':
312
                    case 'image/ief':
313
                    case 'image/jpeg':
314
                    case 'image/pipeg':
315
                    case 'image/tiff':
316
                    case 'image/x-jps':
317
                        $extension = '.jpg';
318
                        break;
319
                    case 'image/gif':
320
                        $extension = '.gif';
321
                        break;
322
                    case 'image/x-icon':
323
                    case 'image/png':
324
                        $extension = '.png';
325
                        break;
326
                    default:
327
                        $extension = '.jpg';
328
                        break;
329
                }
330
331
                $variant_name = $new_file_name.'-'.$variant.$extension;
332
                $variant_file = $destination_path.'/'.$variant_name;
333
334 View Code Duplication
                if ($dimensions) {
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
335
                    $width = $dimensions[0];
336
                    $height = $dimensions[1];
337
338
                    if ($img->width() > $width || $img->height() > $height) {
339
                        $img->resize($width, $height, function ($constraint) {
340
                            $constraint->aspectRatio();
341
                        })
342
                        ->save($disk_root.'/'.$variant_file);
343
                    } else {
344
                        $img->save($disk_root.'/'.$variant_file);
345
                    }
346
347
                    $image_variations[$variant] = $public_path.'/'.$variant_file;
0 ignored issues
show
Coding Style Comprehensibility introduced by
$image_variations was never initialized. Although not strictly required by PHP, it is generally a good practice to add $image_variations = array(); before regardless.

Adding an explicit array definition is generally preferable to implicit array definition as it guarantees a stable state of the code.

Let’s take a look at an example:

foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}

As you can see in this example, the array $myArray is initialized the first time when the foreach loop is entered. You can also see that the value of the bar key is only written conditionally; thus, its value might result from a previous iteration.

This might or might not be intended. To make your intention clear, your code more readible and to avoid accidental bugs, we recommend to add an explicit initialization $myArray = array() either outside or inside the foreach loop.

Loading history...
348
                } else {
349
                    $img->save($disk_root.'/'.$variant_file);
350
                    $image_variations['original'] = $variant_file;
0 ignored issues
show
Bug introduced by
The variable $image_variations does not seem to be defined for all execution paths leading up to this point.

If you define a variable conditionally, it can happen that it is not defined for all execution paths.

Let’s take a look at an example:

function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}

In the above example, the variable $x is defined if you pass “foo” or “bar” as argument for $a. However, since the switch statement has no default case statement, if you pass any other value, the variable $x would be undefined.

Available Fixes

  1. Check for existence of the variable explicitly:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        if (isset($x)) { // Make sure it's always set.
            echo $x;
        }
    }
    
  2. Define a default value for the variable:

    function myFunction($a) {
        $x = ''; // Set a default which gets overridden for certain paths.
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        echo $x;
    }
    
  3. Add a value for the missing path:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
    
            // We add support for the missing case.
            default:
                $x = '';
                break;
        }
    
        echo $x;
    }
    
Loading history...
351
                }
352
            }
353
354
            $this->attributes[$attribute_name] = $image_variations['original'];
355
        }
356
    }
357
358
    /**
359
     * Handles the retrieval of an image by variant:.
360
     *
361
     * @param  [type] $attribute        Name of the attribute within the model that contains the json
0 ignored issues
show
Documentation introduced by
The doc-type [type] could not be parsed: Unknown type name "" at position 0. [(view supported doc-types)

This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types.

Loading history...
362
     * @param  [type] $variant          Name of the variant you want to extract
0 ignored issues
show
Documentation introduced by
The doc-type [type] could not be parsed: Unknown type name "" at position 0. [(view supported doc-types)

This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types.

Loading history...
363
     * @param  [type] $disk             Filesystem disk used to store files.
0 ignored issues
show
Documentation introduced by
The doc-type [type] could not be parsed: Unknown type name "" at position 0. [(view supported doc-types)

This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types.

Loading history...
364
     */
365
    public function getUploadedImageFromDisk($attribute, $variant = 'original', $disk = null)
0 ignored issues
show
Documentation introduced by
The return type could not be reliably inferred; please add a @return annotation.

Our type inference engine in quite powerful, but sometimes the code does not provide enough clues to go by. In these cases we request you to add a @return annotation as described here.

Loading history...
Unused Code introduced by
The parameter $attribute is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
366
    {
367
        $image = $this->attributes['image'];
368
        $url = null;
369
        if (! empty($image)) {
370
            $image_variant = str_replace('-original', '-'.$variant, $image);
371
372
            if ($disk) {
373
                $disk_config = config('filesystems.disks.'.$disk);
374
                $disk_root = $disk_config['root'];
375
376
                //if the disk is public, we need to know the public path
377 View Code Duplication
                if ($disk_config['visibility'] == 'public') {
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
378
                    $public_path = str_replace(public_path(), '', $disk_root);
379
                } else {
380
                    $public_path = $disk_root;
381
                }
382
383
                if (\Storage::disk($disk)->exists($image_variant)) {
384
                    $url = asset($public_path.'/'.$image_variant);
385
                } else {
386
                    $url = asset($public_path.'/'.trim($image, '/'));
387
                }
388
            } else {
389
                if (\Storage::exists($image_variant)) {
0 ignored issues
show
Bug introduced by
The method exists() does not seem to exist on object<Illuminate\Contracts\Filesystem\Factory>.

This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces.

This is most likely a typographical error or the method has been renamed.

Loading history...
390
                    $url = \Storage::url(trim($image_variant, '/'));
0 ignored issues
show
Bug introduced by
The method url() does not seem to exist on object<Illuminate\Contracts\Filesystem\Factory>.

This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces.

This is most likely a typographical error or the method has been renamed.

Loading history...
391
                } else {
392
                    $url = url($image);
393
                }
394
            }
395
        }
396
        return $url;
397
    }
398
}
399