FooGallery_Thumbnails::run_thumbnail_generation_tests() - Code Metrics - Inspection of "version bump" - fooplugins/foogallery - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — develop ( d52e42...8a7368 )

by Brad

created 2018-12-13 14:47 UTC

run_thumbnail_generation_tests() A

↳ Parent: FooGallery_Thumbnails

Complexity

Conditions	2
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	2
nc	2
nop	0
dl	0
loc	31
rs	9.424
c	0
b	0
f	0

<?php
/*
 * FooGallery Thumbnail Resizing class
 */

if ( !class_exists( 'FooGallery_Thumbnails' ) ) {

	class FooGallery_Thumbnails {
namespace YourVendor;

class YourClass { }

		function __construct() {
			//generate thumbs using WPThumb
			add_filter( 'foogallery_attachment_resize_thumbnail', array( $this, 'resize' ), 10, 3 );

			add_filter( 'foogallery_test_thumb_url', array( $this, 'find_first_image_in_media_library' ) );

			add_filter( 'foogallery_thumbnail_resize_args', array( $this, 'check_for_force_original_thumb') );
		}

		function check_for_force_original_thumb( $args ){

			global $current_foogallery;
function myFunction($a, $b) {
    // Do something
}

			if ( isset( $current_foogallery ) ) {
				$args['force_use_original_thumb'] = $current_foogallery->force_use_original_thumbs;
			}

			return $args;
		}

		function resize( $original_image_src, $args, $thumbnail_object ) {
			global $current_foogallery;
function myFunction($a, $b) {
    // Do something
}
		    global $foogallery_last_generated_thumb_url;
function myFunction($a, $b) {
    // Do something
}

			$arg_defaults = array(
				'width'                   => 0,
				'height'                  => 0,
				'crop'                    => true,
				'jpeg_quality'            => foogallery_thumbnail_jpeg_quality(),
				'thumb_resize_animations' => foogallery_get_setting( 'thumb_resize_animations' ),
				'foogallery_attachment_id'=> $thumbnail_object->ID
			);

			if ( isset( $current_foogallery ) ) {
				$arg_defaults['foogallery_id'] = $current_foogallery->ID;
			}

			$args = wp_parse_args( $args, $arg_defaults );

			//allow for plugins to change the thumbnail creation args
			$args = apply_filters( 'foogallery_thumbnail_resize_args', $args, $original_image_src, $thumbnail_object );

			//check the current arguments passed in by the shortcode
			global $current_foogallery_arguments;
			if ( isset( $current_foogallery_arguments ) && isset( $current_foogallery_arguments['template'] ) ) {
				$thumbnail_args = apply_filters( 'foogallery_calculate_thumbnail_dimensions-' . $current_foogallery_arguments['template'], $args, $current_foogallery_arguments );
				$args = wp_parse_args( $thumbnail_args, $args );
			}

			$width  = (int)$args['width'];
			$height = (int)$args['height'];
			$crop   = (bool)$args['crop'];

			if ( 0 === $width && 0 === $height ) {
				return $original_image_src;
			}

			//we can force the use of the originally uploaded full-size image
			$force_use_original_image = isset( $args['force_use_original_image'] ) && true === $args['force_use_original_image'];

			if ( $force_use_original_image ) {
				$fullsize = wp_get_attachment_image_src( $thumbnail_object->ID, 'fullsize' );

				return $fullsize[0];
			}

			//we can force the use of the original WP icon or WP-generated thumb by passing through args individually
			$force_use_original_thumb = isset( $args['force_use_original_thumb'] ) && true === $args['force_use_original_thumb'];

			if ( $force_use_original_thumb ) {
				$thumbnail_icon = wp_get_attachment_image_src( $thumbnail_object->ID, array( $width, $height ) );

				return $thumbnail_icon[0];
			}

			//we can force the use of original WP thumbs by passing through args individually, or by saved settings
			$use_original_thumbs = ( isset( $args['use_original_thumbs'] ) && true === $args['use_original_thumbs'] ) || 'on' === foogallery_get_setting( 'use_original_thumbs' );

			if ( $use_original_thumbs ) {

				$option_thumbnail_size_w = get_option( 'thumbnail_size_w' );
				$option_thumbnail_size_h = get_option( 'thumbnail_size_h' );
				$option_thumbnail_crop = get_option( 'thumbnail_crop' );

				//check if we are trying to get back the default thumbnail that we already have
				if ( $thumbnail_object->ID > 0 && $width == $option_thumbnail_size_w && $height == $option_thumbnail_size_h && $crop == $option_thumbnail_crop ) {
					$thumbnail_attributes = wp_get_attachment_image_src( $thumbnail_object->ID );

					return $thumbnail_attributes[0];
				}
			}

			if ( $thumbnail_object->ID > 0 ) {
				$crop_from_position = get_post_meta( $thumbnail_object->ID, 'wpthumb_crop_pos', true );

				if ( !empty( $crop_from_position ) ) {
					$args['crop_from_position'] = $crop_from_position;
				}
			}

			//remove invalid resize args
			if ( array_key_exists( 'height', $args ) && 0 === $args['height'] ) {
				unset( $args['height'] );
			}

			//do some checks to see if the image is smaller
			if ( $this->should_resize( $thumbnail_object, $args ) ) {
				//save the generated thumb url to a global so that we can use it later if needed
				$foogallery_last_generated_thumb_url = wpthumb( $original_image_src, $args );
			} else {
				$foogallery_last_generated_thumb_url = $original_image_src;
			}

            return $foogallery_last_generated_thumb_url;
		}

		function should_resize($thumbnail_object, $args) {

			$original_width = $thumbnail_object->width;
			$original_height = $thumbnail_object->height;
			$new_width = isset( $args['width'] ) ? $args['width'] : 0;
			$new_height = isset( $args['height'] ) ? $args['height'] : 0;

			if ( $new_width > 0 && $new_height > 0 ) {
				return $original_width > $new_width || $original_height > $new_height;
			} else if ( $new_width > 0 ) {
				return $original_width > $new_width;
			}
			return $original_height > $new_height;
		}

		function run_thumbnail_generation_tests() {

            $test_image_url = foogallery_test_thumb_url();

			//next, generate a thumbnail
			$test_args = array(
				'width'                   => 20,
				'height'                  => 20,
				'crop'                    => true,
				'jpeg_quality'            => foogallery_thumbnail_jpeg_quality()
			);

            //first, clear any previous cached files
            $thumb = new WP_Thumb( $test_image_url, $test_args );
            wpthumb_rmdir_recursive( $thumb->getCacheFileDirectory() );

			$test_thumb = new WP_Thumb( $test_image_url, $test_args );
            $generated_thumb = $test_thumb->returnImage();
            $success = $test_image_url !== $generated_thumb;
			$file_info = wp_check_filetype( $test_image_url );

			$test_results = array(
			    'success' => $success,
				'thumb' => $generated_thumb,
				'error' => $test_thumb->errored() ? $test_thumb->error : '',
				'file_info' => $file_info
			);

            do_action( 'foogallery_thumbnail_generation_test', $test_results );

            return $test_results;
		}

		function find_first_image_in_media_library( $test_thumb_url ) {

			$args = array(
				'post_type' => 'attachment',
				'post_mime_type' =>'image',
				'post_status' => 'inherit',
				'posts_per_page' => 1
			);
			$query_images = new WP_Query( $args );
			foreach ( $query_images->posts as $image) {
				return $image->guid;
			}
			return $test_thumb_url;
		}
	}
}


1			<?php
2			/*
3			* FooGallery Thumbnail Resizing class
4			*/
5
6			if ( !class_exists( 'FooGallery_Thumbnails' ) ) {
7
8			class FooGallery_Thumbnails {
			0 ignored issues – show Coding Style Compatibility introduced 2017-09-12 19:27 UTC by Report Bug Copy Issue Report PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions. You can fix this by adding a namespace to your class: namespace YourVendor; class YourClass { } When choosing a vendor namespace, try to pick something that is not too generic to avoid conflicts with other libraries. Loading history...
9
10			function __construct() {
11			//generate thumbs using WPThumb
12			add_filter( 'foogallery_attachment_resize_thumbnail', array( $this, 'resize' ), 10, 3 );
13
14			add_filter( 'foogallery_test_thumb_url', array( $this, 'find_first_image_in_media_library' ) );
15
16			add_filter( 'foogallery_thumbnail_resize_args', array( $this, 'check_for_force_original_thumb') );
17			}
18
19			function check_for_force_original_thumb( $args ){
			0 ignored issues – show Best Practice introduced 2017-05-07 14:56 UTC by Report Bug Copy Issue Report 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...
20			global $current_foogallery;
			0 ignored issues – show Compatibility Best Practice introduced 2017-05-07 14:56 UTC by Report Bug Copy Issue Report Use of `global` functionality is not recommended; it makes your code harder to test, and less reusable. Instead of relying on `global` state, we recommend one of these alternatives: 1. Pass all data via parameters function myFunction($a, $b) { // Do something } 2. Create a class that maintains your state class MyClass { private $a; private $b; public function __construct($a, $b) { $this->a = $a; $this->b = $b; } public function myFunction() { // Do something } } Loading history...
21
22			if ( isset( $current_foogallery ) ) {
23			$args['force_use_original_thumb'] = $current_foogallery->force_use_original_thumbs;
24			}
25
26			return $args;
27			}
28
29			function resize( $original_image_src, $args, $thumbnail_object ) {
30			global $current_foogallery;
			0 ignored issues – show Compatibility Best Practice introduced 2017-03-21 17:22 UTC by Report Bug Copy Issue Report Use of `global` functionality is not recommended; it makes your code harder to test, and less reusable. Instead of relying on `global` state, we recommend one of these alternatives: 1. Pass all data via parameters function myFunction($a, $b) { // Do something } 2. Create a class that maintains your state class MyClass { private $a; private $b; public function __construct($a, $b) { $this->a = $a; $this->b = $b; } public function myFunction() { // Do something } } Loading history...
31			global $foogallery_last_generated_thumb_url;
			0 ignored issues – show Compatibility Best Practice introduced 2016-07-24 16:18 UTC by Report Bug Copy Issue Report Use of `global` functionality is not recommended; it makes your code harder to test, and less reusable. Instead of relying on `global` state, we recommend one of these alternatives: 1. Pass all data via parameters function myFunction($a, $b) { // Do something } 2. Create a class that maintains your state class MyClass { private $a; private $b; public function __construct($a, $b) { $this->a = $a; $this->b = $b; } public function myFunction() { // Do something } } Loading history...
32
33			$arg_defaults = array(
34			'width' => 0,
35			'height' => 0,
36			'crop' => true,
37			'jpeg_quality' => foogallery_thumbnail_jpeg_quality(),
38			'thumb_resize_animations' => foogallery_get_setting( 'thumb_resize_animations' ),
39			'foogallery_attachment_id'=> $thumbnail_object->ID
40			);
41
42			if ( isset( $current_foogallery ) ) {
43			$arg_defaults['foogallery_id'] = $current_foogallery->ID;
44			}
45
46			$args = wp_parse_args( $args, $arg_defaults );
47
48			//allow for plugins to change the thumbnail creation args
49			$args = apply_filters( 'foogallery_thumbnail_resize_args', $args, $original_image_src, $thumbnail_object );
50
51			//check the current arguments passed in by the shortcode
52			global $current_foogallery_arguments;
53			if ( isset( $current_foogallery_arguments ) && isset( $current_foogallery_arguments['template'] ) ) {
54			$thumbnail_args = apply_filters( 'foogallery_calculate_thumbnail_dimensions-' . $current_foogallery_arguments['template'], $args, $current_foogallery_arguments );
55			$args = wp_parse_args( $thumbnail_args, $args );
56			}
57
58			$width = (int)$args['width'];
59			$height = (int)$args['height'];
60			$crop = (bool)$args['crop'];
61
62			if ( 0 === $width && 0 === $height ) {
63			return $original_image_src;
64			}
65
66			//we can force the use of the originally uploaded full-size image
67			$force_use_original_image = isset( $args['force_use_original_image'] ) && true === $args['force_use_original_image'];
68
69			if ( $force_use_original_image ) {
70			$fullsize = wp_get_attachment_image_src( $thumbnail_object->ID, 'fullsize' );
71
72			return $fullsize[0];
73			}
74
75			//we can force the use of the original WP icon or WP-generated thumb by passing through args individually
76			$force_use_original_thumb = isset( $args['force_use_original_thumb'] ) && true === $args['force_use_original_thumb'];
77
78			if ( $force_use_original_thumb ) {
79			$thumbnail_icon = wp_get_attachment_image_src( $thumbnail_object->ID, array( $width, $height ) );
80
81			return $thumbnail_icon[0];
82			}
83
84			//we can force the use of original WP thumbs by passing through args individually, or by saved settings
85			$use_original_thumbs = ( isset( $args['use_original_thumbs'] ) && true === $args['use_original_thumbs'] ) \|\| 'on' === foogallery_get_setting( 'use_original_thumbs' );
86
87			if ( $use_original_thumbs ) {
88
89			$option_thumbnail_size_w = get_option( 'thumbnail_size_w' );
90			$option_thumbnail_size_h = get_option( 'thumbnail_size_h' );
91			$option_thumbnail_crop = get_option( 'thumbnail_crop' );
92
93			//check if we are trying to get back the default thumbnail that we already have
94			if ( $thumbnail_object->ID > 0 && $width == $option_thumbnail_size_w && $height == $option_thumbnail_size_h && $crop == $option_thumbnail_crop ) {
95			$thumbnail_attributes = wp_get_attachment_image_src( $thumbnail_object->ID );
96
97			return $thumbnail_attributes[0];
98			}
99			}
100
101			if ( $thumbnail_object->ID > 0 ) {
102			$crop_from_position = get_post_meta( $thumbnail_object->ID, 'wpthumb_crop_pos', true );
103
104			if ( !empty( $crop_from_position ) ) {
105			$args['crop_from_position'] = $crop_from_position;
106			}
107			}
108
109			//remove invalid resize args
110			if ( array_key_exists( 'height', $args ) && 0 === $args['height'] ) {
111			unset( $args['height'] );
112			}
113
114			//do some checks to see if the image is smaller
115			if ( $this->should_resize( $thumbnail_object, $args ) ) {
116			//save the generated thumb url to a global so that we can use it later if needed
117			$foogallery_last_generated_thumb_url = wpthumb( $original_image_src, $args );
118			} else {
119			$foogallery_last_generated_thumb_url = $original_image_src;
120			}
121
122			return $foogallery_last_generated_thumb_url;
123			}
124
125			function should_resize($thumbnail_object, $args) {
			0 ignored issues – show Best Practice introduced 2018-05-01 18:26 UTC by Report Bug Copy Issue Report 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...
126			$original_width = $thumbnail_object->width;
127			$original_height = $thumbnail_object->height;
128			$new_width = isset( $args['width'] ) ? $args['width'] : 0;
129			$new_height = isset( $args['height'] ) ? $args['height'] : 0;
130
131			if ( $new_width > 0 && $new_height > 0 ) {
132			return $original_width > $new_width \|\| $original_height > $new_height;
133			} else if ( $new_width > 0 ) {
134			return $original_width > $new_width;
135			}
136			return $original_height > $new_height;
137			}
138
139			function run_thumbnail_generation_tests() {
			0 ignored issues – show Best Practice introduced 2016-07-24 16:18 UTC by Report Bug Copy Issue Report 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...
140			$test_image_url = foogallery_test_thumb_url();
141
142			//next, generate a thumbnail
143			$test_args = array(
144			'width' => 20,
145			'height' => 20,
146			'crop' => true,
147			'jpeg_quality' => foogallery_thumbnail_jpeg_quality()
148			);
149
150			//first, clear any previous cached files
151			$thumb = new WP_Thumb( $test_image_url, $test_args );
152			wpthumb_rmdir_recursive( $thumb->getCacheFileDirectory() );
153
154			$test_thumb = new WP_Thumb( $test_image_url, $test_args );
155			$generated_thumb = $test_thumb->returnImage();
156			$success = $test_image_url !== $generated_thumb;
157			$file_info = wp_check_filetype( $test_image_url );
158
159			$test_results = array(
160			'success' => $success,
161			'thumb' => $generated_thumb,
162			'error' => $test_thumb->errored() ? $test_thumb->error : '',
163			'file_info' => $file_info
164			);
165
166			do_action( 'foogallery_thumbnail_generation_test', $test_results );
167
168			return $test_results;
169			}
170
171			function find_first_image_in_media_library( $test_thumb_url ) {
			0 ignored issues – show Best Practice introduced 2018-12-13 14:49 UTC by Report Bug Copy Issue Report 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...
172			$args = array(
173			'post_type' => 'attachment',
174			'post_mime_type' =>'image',
175			'post_status' => 'inherit',
176			'posts_per_page' => 1
177			);
178			$query_images = new WP_Query( $args );
179			foreach ( $query_images->posts as $image) {
180			return $image->guid;
181			}
182			return $test_thumb_url;
183			}
184			}
185			}
186

fooplugins / foogallery

GitHub Access Token became invalid

Push — develop ( d52e42...8a7368 )

run_thumbnail_generation_tests() A

Complexity

Size

Duplication

Importance

1. Pass all data via parameters

2. Create a class that maintains your state

1. Pass all data via parameters

2. Create a class that maintains your state

1. Pass all data via parameters

2. Create a class that maintains your state

Duplication Side-by-Side

Filter issues like