FooGallery_LazyLoad

Complexity

Total Complexity

17

Size/Duplication

Total Lines	113
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	0

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	15	1
A	add_lazyload_fields()	0	18	4
A	determine_lazyload()	0	10	2
C	change_src_attributes()	0	27	7
A	add_lazyload_options()	0	6	3

<?php
/**
 * Class used to handle lazy loading for gallery templates
 * Date: 20/03/2017
 */
if ( ! class_exists( 'FooGallery_LazyLoad' ) ) {

	class FooGallery_LazyLoad {

PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions.

		function __construct() {

It is generally recommended to explicitly declare the visibility for methods.

//			if ( is_admin() ) {

52% of this comment could be valid code. Did you maybe forget this after debugging?

//				//add extra fields to the templates that support lazy loading
//				add_filter( 'foogallery_override_gallery_template_fields', array( $this, 'add_lazyload_fields' ), 10, 2 );
//			}

			//adds the lazyload property to a FooGallery
			add_action( 'foogallery_foogallery_instance_after_load', array( $this, 'determine_lazyload' ), 10, 2 );

			//change the image src attribute to data attributes if lazy loading is enabled
			add_filter( 'foogallery_attachment_html_image_attributes', array($this, 'change_src_attributes'), 99, 3);

			//add the lazy load attributes to the gallery container
			add_filter( 'foogallery_build_container_data_options', array( $this, 'add_lazyload_options' ), 10, 3 );
		}

		/**
		 * Add lazy load fields to the gallery template
		 *
		 * @uses "foogallery_override_gallery_template_fields"
		 * @param $fields
		 * @param $template
		 *
		 * @return array
		 */
		function add_lazyload_fields( $fields, $template ) {

It is generally recommended to explicitly declare the visibility for methods.

			if ( $template && array_key_exists( 'lazyload_support', $template ) && true === $template['lazyload_support'] ) {
				$fields[] = array(
					'id'      => 'lazyload',
					'title'   => __( 'Lazy Loading', 'foogallery' ),
					'desc'    => __( 'Lazy loading means images in your gallery are only loaded when they become visible in the browser. This significantly improves page loading times.', 'foogallery' ),
					'section' => __( 'Thumbnails', 'foogallery' ),
					'spacer'  => '<span class="spacer"></span>',
					'type'    => 'radio',
					'choices' => array(
						'yes'  => __( 'Enabled', 'foogallery' ),
						'no'   => __( 'Disabled', 'foogallery' )
					)
				);
			}

			return $fields;
		}

		/**
		 * Determine if the gallery has lazy loading enabled
		 *
		 * @param $foogallery
		 * @param $post
		 */
		function determine_lazyload( $foogallery, $post ) {

The parameter $post is not used and could be removed.

It is generally recommended to explicitly declare the visibility for methods.

			//always enable lazyload by default
			$lazy_load = true;

			if ( true === foogallery_get_setting( 'disable_lazy_load', false ) ) {
				$lazy_load = false;
			}

			$foogallery->lazyload = apply_filters( 'foogallery_lazy_load', $lazy_load, $foogallery );
		}

		/**
		 * @param array $attr
		 * @param array $args
		 * @param FooGalleryAttachment $attachment
		 * @return mixed
		 */
		function change_src_attributes($attr, $args, $attachment) {

The parameter $args is not used and could be removed.

The parameter $attachment is not used and could be removed.

It is generally recommended to explicitly declare the visibility for methods.

			global $current_foogallery;

Use of global functionality is not recommended; it makes your code harder to test, and less reusable.

			global $current_foogallery_template;

			$lazyload_support = isset($current_foogallery_template['lazyload_support']) &&
                true === $current_foogallery_template['lazyload_support'];

			if ( $lazyload_support &&
                isset( $current_foogallery->lazyload) && true === $current_foogallery->lazyload) {

				if ( isset( $attr['src'] ) ) {
					//rename src => data-src
					$src = $attr['src'];
					unset( $attr['src'] );
					$attr['data-src'] = $src;
				}

				if ( isset( $attr['srcset'] ) ) {
					//rename srcset => data-srcset
					$src = $attr['srcset'];
					unset( $attr['srcset'] );
					$attr['data-srcset'] = $src;
				}
			}

			return $attr;
		}


		/**
		 * Add the required lazy load options if needed
		 *
		 * @param $attributes array
		 * @param $gallery FooGallery
		 *
		 * @return array
		 */
		function add_lazyload_options($options, $gallery, $attributes) {

The parameter $attributes is not used and could be removed.

It is generally recommended to explicitly declare the visibility for methods.

			if ( isset( $gallery->lazyload) && true === $gallery->lazyload) {
				$options['lazy'] = true;
			}
			return $options;
		}
	}
}