Images_Via_Imgix - Code Metrics - Inspection of "Move code into classes" - imgix-wordpress/images-via-imgix - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#16)

by Rasmus

created 2017-01-31 16:13 UTC

Images_Via_Imgix A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	237
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	0

Importance

Changes

Metric	Value
dl	0
loc	237
rs	10
c	0
b	0
f	0
wmc	29
lcom	2
cbo	0

12 Methods

Rating	Name	Size	Complexity
A	__construct()	13	1
A	instance()	7	2
A	set_options()	3	1
A	add_retina()	8	1
A	replace_host_in_srcset()	7	2
A	replace_images_in_content()	10	2
A	prefetch_cdn()	10	2
A	buffer_start_for_retina()	6	2
A	buffer_end_for_retina()	5	2
A	get_global_params()	19	4
A	convert_filename_to_size_args()	14	1
D	replace_image_url()	33	9

<?php

class Images_Via_Imgix {

	/**
	 * The instance of the class.
	 *
	 * @var Images_Via_Imgix
	 */
	protected static $instance;

	/**
	 * Plugin options
	 *
	 * @var array
	 */
	protected $options = [];

	/**
	 * Buffer is started by plugin and should be ended on shutdown.
	 *
	 * @var bool
	 */
	protected $buffer_started = false;

	/**
	 * ImagesViaImgix constructor.
	 */
	public function __construct() {
		$this->options = get_option( 'imgix_settings', [] );

		add_filter( 'wp_get_attachment_url', [ $this, 'replace_image_url' ] );
		add_filter( 'imgix/add-image-url', [ $this, 'replace_image_url' ] );

		add_filter( 'wp_calculate_image_srcset', [ $this, 'replace_host_in_srcset' ], 10 );
		add_filter( 'the_content', [ $this, 'replace_images_in_content' ] );
		add_action( 'wp_head', [ $this, 'prefetch_cdn' ], 1 );

		add_action( 'after_setup_theme', [ $this, 'buffer_start_for_retina' ] );
		add_action( 'shutdown', [ $this, 'buffer_end_for_retina' ] );
	}

	/**
	 * Plugin loader instance.
	 *
	 * @return Images_Via_Imgix
	 */
	public static function instance() {
		if ( ! isset( self::$instance ) ) {
			self::$instance = new self;
		}

		return self::$instance;
	}

	/**
	 * Override options from settings.
	 * Used in unit tests.
	 *
	 * @param array $options
	 */
	public function set_options( $options ) {
		$this->options = $options;
	}

	/**
	 * Find all img tags with sources matching "imgix.net" without the parameter
	 * "srcset" and add the "srcset" parameter to all those images, appending a new
	 * source using the "dpr=2" modifier.
	 *
	 * @param $content
	 *
	 * @return string Content with retina-enriched image tags.
	 */
	public function add_retina( $content ) {
		$pattern = '/<img((?![^>]+srcset )([^>]*)';
		$pattern .= 'src=[\'"]([^\'"]*imgix.net[^\'"]*\?[^\'"]*w=[^\'"]*)[\'"]([^>]*)*?)>/i';
		$repl    = '<img$2src="$3" srcset="${3}, ${3}&amp;dpr=2 2x, ${3}&amp;dpr=3 3x,"$4>';
		$content = preg_replace( $pattern, $repl, $content );

		return preg_replace( $pattern, $repl, $content );
	}

	/**
	 * Modify image urls for attachments to use imgix host.
	 *
	 * @param string $url
	 *
	 * @return string
	 */
	public function replace_image_url( $url ) {
		if ( ! empty ( $this->options['cdn_link'] ) ) {
			$pathinfo = pathinfo( $url );

			if ( in_array( $pathinfo['extension'], [ 'jpg', 'gif', 'png', 'jpeg' ] ) ) {
				$parsed_url = parse_url( $url );
				if ( isset( $parsed_url['host'] ) && $parsed_url['host'] === parse_url( home_url( '/' ), PHP_URL_HOST ) ) {
					$cdn = parse_url( $this->options['cdn_link'] );
					foreach ( [ 'scheme', 'host', 'port' ] as $url_part ) {
						if ( isset( $cdn[ $url_part ] ) ) {
							$parsed_url[ $url_part ] = $cdn[ $url_part ];
						} else {
							unset( $parsed_url[ $url_part ] );
						}
					}

					list( $filename, $arguments ) = $this->convert_filename_to_size_args( $pathinfo['basename'] );

					$arguments = array_merge( $arguments, $this->get_global_params() );

					$parsed_url['path'] = trailingslashit( dirname( $parsed_url['path'] ) ) . $filename;

					if ( ! empty( $arguments ) ) {
						$parsed_url['query'] = empty( $parsed_url['query'] ) ? build_query( $arguments ) : $parsed_url['query'] . '&' . build_query( $arguments );
					}

					$url = http_build_url( $parsed_url );
<?php

function getDate($date)
{
    if ($date !== null) {
        return new DateTime($date);
    }

    return false;
}
				}
			}
		}

		return $url;
	}

	/**
	 * Modify image urls in srcset to use imgix host.
	 *
	 * @param array $sources
	 *
	 * @return array $sources
	 */
	public function replace_host_in_srcset( $sources ) {
		foreach ( $sources as $source ) {
			$sources[ $source['value'] ]['url'] = apply_filters( 'imgix/add-image-url', $sources[ $source['value'] ]['url'] );
		}

		return $sources;
	}

	/**
	 * Modify image urls in content to use imgix host.
	 *
	 * @param $content
	 *
	 * @return string
	 */
	public function replace_images_in_content( $content ) {
		if ( ! empty ( $this->options['cdn_link'] ) ) {
			$content = preg_replace_callback( '/(?<=\shref="|\ssrc="|\shref=\'|\ssrc=\').*(?=\'|")/', function ( $match ) {
				return esc_url( apply_filters( 'imgix/add-image-url', $match[0] ) );
			}, $content );

		}

		return $content;
	}

	/**
	 * Add tag to dns prefetch cdn host
	 */
	public function prefetch_cdn() {
		if ( ! empty ( $this->options['cdn_link'] ) ) {
			$host = parse_url( $this->options['cdn_link'], PHP_URL_HOST );

			printf(
				'<link rel="dns-prefetch" href="%s"/>',
				esc_attr( '//' . $host )
			);
		}
	}

	/**
	 * Start output buffer if auto retina is enabled
	 */
	public function buffer_start_for_retina() {
		if ( ! empty ( $this->options['add_dpi2_srcset'] ) ) {
			$this->buffer_started = true;
			ob_start( [ $this, 'add_retina' ] );
		}
	}

	/**
	 * Stop output buffer if it was enabled by the plugin
	 */
	public function buffer_end_for_retina() {
		if ( $this->buffer_started === true ) {
			ob_end_flush();
		}
	}

	/**
	 * Returns a array of global parameters to be applied in all images,
	 * according to plugin's settings.
	 *
	 * @return array Global parameters to be appened at the end of each img URL.
	 */
	protected function get_global_params() {
		$params = [];

		// For now, only "auto" is supported.
		$auto = [];
		if ( ! empty ( $this->options['auto_format'] ) ) {
			array_push( $auto, 'format' );
		}

		if ( ! empty ( $this->options['auto_enhance'] ) ) {
			array_push( $auto, 'enhance' );
		}

		if ( ! empty( $auto ) ) {
			$params['auto'] = implode( ',', $auto );
		}

		return $params;
	}

	/**
	 * Convert sizes in filename to parameters and returns origina filename without sizes.
	 * If no size is found the original filename is returned.
	 *
	 * @param string $filename
	 *
	 * @return array with filename and size arguments.
	 */
	protected function convert_filename_to_size_args( $filename ) {
		$arguments = [];

		$filename = preg_replace_callback( '/-(?<width>\d+)x(?<height>\d+)(?<extension>\.\w{3,4}$)/', function ( $match ) use ( &$arguments ) {
			$arguments = [
				'w' => $match['width'],
				'h' => $match['height']
			];

			return $match['extension'];
		}, $filename );

		return [ $filename, $arguments ];
	}
}

Images_Via_Imgix::instance();


1			<?php
2
3			class Images_Via_Imgix {
4
5			/**
6			* The instance of the class.
7			*
8			* @var Images_Via_Imgix
9			*/
10			protected static $instance;
11
12			/**
13			* Plugin options
14			*
15			* @var array
16			*/
17			protected $options = [];
18
19			/**
20			* Buffer is started by plugin and should be ended on shutdown.
21			*
22			* @var bool
23			*/
24			protected $buffer_started = false;
25
26			/**
27			* ImagesViaImgix constructor.
28			*/
29			public function __construct() {
30			$this->options = get_option( 'imgix_settings', [] );
31
32			add_filter( 'wp_get_attachment_url', [ $this, 'replace_image_url' ] );
33			add_filter( 'imgix/add-image-url', [ $this, 'replace_image_url' ] );
34
35			add_filter( 'wp_calculate_image_srcset', [ $this, 'replace_host_in_srcset' ], 10 );
36			add_filter( 'the_content', [ $this, 'replace_images_in_content' ] );
37			add_action( 'wp_head', [ $this, 'prefetch_cdn' ], 1 );
38
39			add_action( 'after_setup_theme', [ $this, 'buffer_start_for_retina' ] );
40			add_action( 'shutdown', [ $this, 'buffer_end_for_retina' ] );
41			}
42
43			/**
44			* Plugin loader instance.
45			*
46			* @return Images_Via_Imgix
47			*/
48			public static function instance() {
49			if ( ! isset( self::$instance ) ) {
50			self::$instance = new self;
51			}
52
53			return self::$instance;
54			}
55
56			/**
57			* Override options from settings.
58			* Used in unit tests.
59			*
60			* @param array $options
61			*/
62			public function set_options( $options ) {
63			$this->options = $options;
64			}
65
66			/**
67			* Find all img tags with sources matching "imgix.net" without the parameter
68			* "srcset" and add the "srcset" parameter to all those images, appending a new
69			* source using the "dpr=2" modifier.
70			*
71			* @param $content
72			*
73			* @return string Content with retina-enriched image tags.
74			*/
75			public function add_retina( $content ) {
76			$pattern = '/<img((?![^>]+srcset )([^>]*)';
77			$pattern .= 'src=[\'"]([^\'"]imgix.net[^\'"]\?[^\'"]w=[^\'"])[\'"]([^>])?)>/i';
78			$repl = '<img$2src="$3" srcset="${3}, ${3}&dpr=2 2x, ${3}&dpr=3 3x,"$4>';
79			$content = preg_replace( $pattern, $repl, $content );
80
81			return preg_replace( $pattern, $repl, $content );
82			}
83
84			/**
85			* Modify image urls for attachments to use imgix host.
86			*
87			* @param string $url
88			*
89			* @return string
90			*/
91			public function replace_image_url( $url ) {
92			if ( ! empty ( $this->options['cdn_link'] ) ) {
93			$pathinfo = pathinfo( $url );
94
95			if ( in_array( $pathinfo['extension'], [ 'jpg', 'gif', 'png', 'jpeg' ] ) ) {
96			$parsed_url = parse_url( $url );
97			if ( isset( $parsed_url['host'] ) && $parsed_url['host'] === parse_url( home_url( '/' ), PHP_URL_HOST ) ) {
98			$cdn = parse_url( $this->options['cdn_link'] );
99			foreach ( [ 'scheme', 'host', 'port' ] as $url_part ) {
100			if ( isset( $cdn[ $url_part ] ) ) {
101			$parsed_url[ $url_part ] = $cdn[ $url_part ];
102			} else {
103			unset( $parsed_url[ $url_part ] );
104			}
105			}
106
107			list( $filename, $arguments ) = $this->convert_filename_to_size_args( $pathinfo['basename'] );
108
109			$arguments = array_merge( $arguments, $this->get_global_params() );
110
111			$parsed_url['path'] = trailingslashit( dirname( $parsed_url['path'] ) ) . $filename;
112
113			if ( ! empty( $arguments ) ) {
114			$parsed_url['query'] = empty( $parsed_url['query'] ) ? build_query( $arguments ) : $parsed_url['query'] . '&' . build_query( $arguments );
115			}
116
117			$url = http_build_url( $parsed_url );
			0 ignored issues – show Security Bug introduced 2017-01-31 16:08 UTC by Report Bug Copy Issue Report It seems like `$parsed_url` defined by `parse_url($url)` on line `96` can also be of type `false`; however, `http_build_url()` does only seem to accept `array`, did you maybe forget to handle an error condition? This check looks for type mismatches where the missing type is `false`. This is usually indicative of an error condtion. Consider the follow example <?php function getDate($date) { if ($date !== null) { return new DateTime($date); } return false; } This function either returns a new `DateTime` object or false, if there was an error. This is a typical pattern in PHP programming to show that an error has occurred without raising an exception. The calling code should check for this returned `false` before passing on the value to another function or method that may not be able to handle a `false`. Loading history...
118			}
119			}
120			}
121
122			return $url;
123			}
124
125			/**
126			* Modify image urls in srcset to use imgix host.
127			*
128			* @param array $sources
129			*
130			* @return array $sources
131			*/
132			public function replace_host_in_srcset( $sources ) {
133			foreach ( $sources as $source ) {
134			$sources[ $source['value'] ]['url'] = apply_filters( 'imgix/add-image-url', $sources[ $source['value'] ]['url'] );
135			}
136
137			return $sources;
138			}
139
140			/**
141			* Modify image urls in content to use imgix host.
142			*
143			* @param $content
144			*
145			* @return string
146			*/
147			public function replace_images_in_content( $content ) {
148			if ( ! empty ( $this->options['cdn_link'] ) ) {
149			$content = preg_replace_callback( '/(?<=\shref="\|\ssrc="\|\shref=\'\|\ssrc=\').*(?=\'\|")/', function ( $match ) {
150			return esc_url( apply_filters( 'imgix/add-image-url', $match[0] ) );
151			}, $content );
152
153			}
154
155			return $content;
156			}
157
158			/**
159			* Add tag to dns prefetch cdn host
160			*/
161			public function prefetch_cdn() {
162			if ( ! empty ( $this->options['cdn_link'] ) ) {
163			$host = parse_url( $this->options['cdn_link'], PHP_URL_HOST );
164
165			printf(
166			'<link rel="dns-prefetch" href="%s"/>',
167			esc_attr( '//' . $host )
168			);
169			}
170			}
171
172			/**
173			* Start output buffer if auto retina is enabled
174			*/
175			public function buffer_start_for_retina() {
176			if ( ! empty ( $this->options['add_dpi2_srcset'] ) ) {
177			$this->buffer_started = true;
178			ob_start( [ $this, 'add_retina' ] );
179			}
180			}
181
182			/**
183			* Stop output buffer if it was enabled by the plugin
184			*/
185			public function buffer_end_for_retina() {
186			if ( $this->buffer_started === true ) {
187			ob_end_flush();
188			}
189			}
190
191			/**
192			* Returns a array of global parameters to be applied in all images,
193			* according to plugin's settings.
194			*
195			* @return array Global parameters to be appened at the end of each img URL.
196			*/
197			protected function get_global_params() {
198			$params = [];
199
200			// For now, only "auto" is supported.
201			$auto = [];
202			if ( ! empty ( $this->options['auto_format'] ) ) {
203			array_push( $auto, 'format' );
204			}
205
206			if ( ! empty ( $this->options['auto_enhance'] ) ) {
207			array_push( $auto, 'enhance' );
208			}
209
210			if ( ! empty( $auto ) ) {
211			$params['auto'] = implode( ',', $auto );
212			}
213
214			return $params;
215			}
216
217			/**
218			* Convert sizes in filename to parameters and returns origina filename without sizes.
219			* If no size is found the original filename is returned.
220			*
221			* @param string $filename
222			*
223			* @return array with filename and size arguments.
224			*/
225			protected function convert_filename_to_size_args( $filename ) {
226			$arguments = [];
227
228			$filename = preg_replace_callback( '/-(?<width>\d+)x(?<height>\d+)(?<extension>\.\w{3,4}$)/', function ( $match ) use ( &$arguments ) {
229			$arguments = [
230			'w' => $match['width'],
231			'h' => $match['height']
232			];
233
234			return $match['extension'];
235			}, $filename );
236
237			return [ $filename, $arguments ];
238			}
239			}
240
241			Images_Via_Imgix::instance();
242

imgix-wordpress / images-via-imgix

Pull Request — master (#16)

Images_Via_Imgix A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

12 Methods

Duplication Side-by-Side

Filter issues like