TimberImageOperationRetina   A
last analyzed

Complexity

Total Complexity 6

Size/Duplication

Total Lines 63
Duplicated Lines 22.22 %

Coupling/Cohesion

Components 1
Dependencies 2
Metric Value
wmc 6
lcom 1
cbo 2
dl 14
loc 63
rs 10

3 Methods

Rating   Name   Duplication   Size   Complexity  
A __construct() 0 3 1
A filename() 0 5 1
B run() 14 27 4

How to fix   Duplicated Code   

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.

Common duplication problems, and corresponding solutions are:

1
<?php
2
/**
3
 * Contains the class for running image retina-izing operations
4
 */
5
6
/**
7
 * Increases image size by a given factor
8
 * Arguments:
9
 * - factor by which to multiply image dimensions
10
 * @property float $factor the factor (ex: 2, 1.5, 1.75) to multiply dimension by
11
 */
12
class TimberImageOperationRetina extends TimberImageOperation {
13
14
    private $factor;
15
16
    /**
17
     * Construct our operation
18
     * @param float   $factor to multiply original dimensions by
19
     */
20
    function __construct($factor) {
0 ignored issues
show
Best Practice introduced by
It is generally recommended to explicitly declare the visibility for methods.

Adding explicit visibility (private, protected, or public) is generally recommend to communicate to other developers how, and from where this method is intended to be used.

Loading history...
21
        $this->factor = $factor;
22
    }
23
24
    /**
25
     * Generates the final filename based on the source's name and extension
26
     *
27
     * @param   string    $src_filename     the basename of the file (ex: my-awesome-pic)
28
     * @param   string    $src_extension    the extension (ex: .jpg)
29
     * @return  string    the final filename to be used (ex: [email protected])
30
     */
31
    function filename($src_filename, $src_extension) {
0 ignored issues
show
Best Practice introduced by
It is generally recommended to explicitly declare the visibility for methods.

Adding explicit visibility (private, protected, or public) is generally recommend to communicate to other developers how, and from where this method is intended to be used.

Loading history...
32
        $newbase = $src_filename . '@' . $this->factor . 'x'; // add @2x, @3x, @1.5x, etc.
33
        $new_name = $newbase . '.' . $src_extension;
34
        return $new_name;
35
    }
36
37
    /**
38
     * Performs the actual image manipulation,
39
     * including saving the target file.
40
     *
41
     * @param  string $load_filename filepath (not URL) to source file
42
     *                               (ex: /src/var/www/wp-content/uploads/my-pic.jpg)
43
     * @param  string $save_filename filepath (not URL) where result file should be saved
44
     *                               (ex: /src/var/www/wp-content/uploads/[email protected])
45
     * @return bool                  true if everything went fine, false otherwise
46
     */
47
    function run($load_filename, $save_filename){
0 ignored issues
show
Best Practice introduced by
It is generally recommended to explicitly declare the visibility for methods.

Adding explicit visibility (private, protected, or public) is generally recommend to communicate to other developers how, and from where this method is intended to be used.

Loading history...
48
        $image = wp_get_image_editor( $load_filename );
49
        if ( !is_wp_error( $image ) ) {
50
            $current_size = $image->get_size();
51
            $src_w = $current_size['width'];
52
            $src_h = $current_size['height'];
53
            // Get ratios
54
            $w = $src_w * $this->factor;
55
            $h = $src_h * $this->factor;
56
            $image->crop( 0, 0, $src_w, $src_h, $w, $h );
57
            $result = $image->save( $save_filename );
58 View Code Duplication
            if ( is_wp_error( $result ) ) {
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...
59
            	// @codeCoverageIgnoreStart
60
				TimberHelper::error_log( 'Error resizing image' );
61
				TimberHelper::error_log( $result );
62
				return false;
63
				// @codeCoverageIgnoreEnd
64
            } else {
65
                return true;
66
            }
67 View Code Duplication
        } else if ( isset( $image->error_data['error_loading_image'] ) ) {
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...
68
            TimberHelper::error_log( 'Error loading ' . $image->error_data['error_loading_image'] );
69
        } else {
70
            TimberHelper::error_log( $image );
71
        }
72
        return false;
73
    }
74
}
75