fooplugins / foogallery

includes/class-thumbnail-dimensions.php

<?php
/**
 * Class to calculate thumb dimensions for a gallery. The default gallery templates
 *  require width and height attributes on the thumb img tags. In some cases these need to be
 *  calculated based on the aspect ratio of the individual thumbs.
 *
 * Date: 21/03/2017
 */


if ( ! class_exists( 'FooGallery_Thumbnail_Dimensions' ) ) {

    class FooGallery_Thumbnail_Dimensions

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.

        {
            //hook into the filter that build up the img attributes
            // and add the width and height attributes if the gallery requires them
            add_filter( 'foogallery_attachment_html_image_attributes', array( $this, 'include_thumb_dimension_attributes' ), 10, 3 );

            //calculate the thumbnail dimensions for all attachments in the gallery
            // for the specific gallery template that is being used.
            add_action( 'foogallery_located_template', array( $this, 'calculate_all_thumbnail_dimensions' ) );
        }

        /**
         * Helper function to check if the gallery requires thumbnail dimensions
         * @param $gallery_template string
         * @return bool
         */
        function does_gallery_template_use_thumbnail_dimensions( $gallery_template ) {

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

            if ( empty( $gallery_template ) ) return false;

            //first do a check if the template needs thumbnail dimensions calculated
            $template_data = foogallery_get_gallery_template( $gallery_template );

            if ( $template_data && array_key_exists( 'thumbnail_dimensions', $template_data ) && true === $template_data['thumbnail_dimensions'] ) {
                //this template requires thumb dimensions to be provided
                return true;
            }

            return false;
        }

        function empty_dimensions( $thumbnail_dimensions ) {

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

            if ( isset( $thumbnail_dimensions ) && is_array( $thumbnail_dimensions ) ) {
                $thumb_width = (int)$thumbnail_dimensions['width'];
                $thumb_height = (int)$thumbnail_dimensions['height'];

                return $thumb_width === 0 && $thumb_height === 0;
            }
            return true;
        }

        /**
         * Calculates all the thumbnail dimensions for the gallery
         * @param $foogallery FooGallery
         */
        function calculate_all_thumbnail_dimensions( $foogallery ) {

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;

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

            global $current_foogallery_arguments;

            //check if we are dealing with a gallery. This check ensures this is not done for albums
            if ( isset( $current_foogallery ) && isset( $current_foogallery_template ) ) {

                //first do a check if the template needs thumbnail dimensions calculated
                if ($this->does_gallery_template_use_thumbnail_dimensions( $current_foogallery_template ) ) {

                    //load the thumbnail dimensions specific to the gallery, taking preference to arguments
                    $thumbnail_dimensions = apply_filters( 'foogallery_calculate_thumbnail_dimensions-' . $current_foogallery_template, array(), $current_foogallery_arguments );

                    //if we have no dimensions then load them from the gallery settings
                    if ( $this->empty_dimensions( $thumbnail_dimensions ) ) {
                        $thumbnail_dimensions = apply_filters( 'foogallery_template_thumbnail_dimensions-' . $current_foogallery_template, $thumbnail_dimensions, $current_foogallery );
                    }

                    if ( isset( $thumbnail_dimensions ) && is_array( $thumbnail_dimensions ) ) {

                        //$thumbnail_dimensions
                        $thumb_width = (int)$thumbnail_dimensions['width'];
                        $thumb_height = (int)$thumbnail_dimensions['height'];
                        $thumb_crop = (bool)$thumbnail_dimensions['crop'];

                        //set the appropriate arguments on the attachments so that they can be
                        // picked up and used in the 'include_thumb_dimension_attributes' function below
                        foreach ($foogallery->attachments() as $attachment) {
                            if ( $thumb_crop && $thumb_width > 0 && $thumb_height > 0 ) {
                                //we have set width and height and crop = true
                                //we do not need to calculate the dimensions
                                $calculated_thumb_width = $thumb_width;
                                $calculated_thumb_height = $thumb_height;
                            } else {
                                $size_array = image_resize_dimensions( $attachment->width, $attachment->height, $thumb_width, $thumb_height, $thumb_crop );
								if ( false !== $size_array ) {
									$calculated_thumb_width = $size_array[4];
									$calculated_thumb_height = $size_array[5];
								} else {
									$size_array = $this->calculate_dimensions( $attachment->width, $attachment->height, $thumb_width, $thumb_height );
									if ( false !== $size_array ) {
										$calculated_thumb_width = $size_array[0];
										$calculated_thumb_height = $size_array[1];
									} else {
										//fallback for when we cannot calculate dimensions. Use the originals
										$calculated_thumb_width = $attachment->width;
										$calculated_thumb_height = $attachment->height;
									}
								}
                            }

                            $attachment->has_thumbnail_dimensions = true;
                            $attachment->thumb_width = $calculated_thumb_width;
                            $attachment->thumb_height = $calculated_thumb_height;
                        }
                    }
                }
            }
        }

		/**
		 * Returns a resized width and height value given the original dimensions and then either the new width or height value, one can be 0.
		 *
		 * @param {int} $orig_width - The original width of the image.

The doc-type {int} could not be parsed: Unknown type name "{int}" at position 0. (view supported doc-types)

		 * @param {int} $orig_height - The original height of the image.

The doc-type {int} could not be parsed: Unknown type name "{int}" at position 0. (view supported doc-types)

		 * @param {int} $new_width - The new width for the image or 0 to calculate it from the supplied new height and original dimensions.

The doc-type {int} could not be parsed: Unknown type name "{int}" at position 0. (view supported doc-types)

		 * @param {int} $new_height - The new height for the image or 0 to calculate it from the supplied new width and original dimensions.

The doc-type {int} could not be parsed: Unknown type name "{int}" at position 0. (view supported doc-types)

		 *
		 * @return array|false - Returns an array with the width value at index 0 and the height value at index 1.
		 * Returns false if the original dimensions are invalid or if both the new width and height are invalid.
		 *
		 * @example
		 *
		 * $size_1 = calculate_dimensions(800, 600, 0, 300); // => [400, 300]
		 *
		 * $size_2 = calculate_dimensions(800, 600, 400, 0); // => [400, 300]
		 */
		function calculate_dimensions($orig_width, $orig_height, $new_width, $new_height){

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

			// if we have an invalid original size provided exit early and return false
			if (!is_numeric($orig_width) || $orig_width === 0 || !is_numeric($orig_height) || $orig_height === 0){
				return false;
			}
			$needs_width = !is_numeric($new_width) || $new_width === 0;
			$needs_height = !is_numeric($new_height) || $new_height === 0;
			// if we have an invalid new size provided i.e. both new values are not numbers or both are 0 then exit early and return false
			if ($needs_width && $needs_height){
				return false;
			}
			// otherwise get the ratio of the original so we can calculate any missing new values
			$ratio = $orig_width / $orig_height;
			if ($needs_width){
				$new_width = $new_height * $ratio;
			}
			if ($needs_height){
				$new_height = $new_width / $ratio;
			}
			return array($new_width, $new_height);
		}

        /**
         * Include the thumb dimension html attributes in the rendered HTML
         *
         * @param $attr
         * @param $args
         * @param $foogallery_attachment
         *
         * @return array
         */
        function include_thumb_dimension_attributes( $attr, $args, $foogallery_attachment ) {

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.

            //check if we are dealing with a gallery. This check ensures this is not done for albums
            if ( isset( $current_foogallery ) ) {

                //check if we have anything set
                if ( isset( $foogallery_attachment->has_thumbnail_dimensions ) ) {
                    if ( $foogallery_attachment->thumb_width > 0 ) {
                        $attr['width'] = $foogallery_attachment->thumb_width;
                    }
                    if ( $foogallery_attachment->thumb_height > 0 ) {
                        $attr['height'] = $foogallery_attachment->thumb_height;
                    }
                }
            }

            return $attr;
        }

    }
}