Chris@0: <?php
Chris@0: 
Chris@0: namespace Drupal\Component\Utility;
Chris@0: 
Chris@0: /**
Chris@0:  * Provides helpers to operate on images.
Chris@0:  *
Chris@0:  * @ingroup utility
Chris@0:  */
Chris@0: class Image {
Chris@0: 
Chris@0:   /**
Chris@0:    * Scales image dimensions while maintaining aspect ratio.
Chris@0:    *
Chris@0:    * The resulting dimensions can be smaller for one or both target dimensions.
Chris@0:    *
Chris@0:    * @param array $dimensions
Chris@0:    *   Dimensions to be modified - an array with components width and height, in
Chris@0:    *   pixels.
Chris@0:    * @param int $width
Chris@0:    *   (optional) The target width, in pixels. If this value is NULL then the
Chris@0:    *   scaling will be based only on the height value.
Chris@0:    * @param int $height
Chris@0:    *   (optional) The target height, in pixels. If this value is NULL then the
Chris@0:    *   scaling will be based only on the width value.
Chris@0:    * @param bool $upscale
Chris@0:    *   (optional) Boolean indicating that images smaller than the target
Chris@0:    *   dimensions will be scaled up. This generally results in a low quality
Chris@0:    *   image.
Chris@0:    *
Chris@0:    * @return bool
Chris@0:    *   TRUE if $dimensions was modified, FALSE otherwise.
Chris@0:    *
Chris@0:    * @see image_scale()
Chris@0:    */
Chris@0:   public static function scaleDimensions(array &$dimensions, $width = NULL, $height = NULL, $upscale = FALSE) {
Chris@0:     $aspect = $dimensions['height'] / $dimensions['width'];
Chris@0: 
Chris@0:     // Calculate one of the dimensions from the other target dimension,
Chris@0:     // ensuring the same aspect ratio as the source dimensions. If one of the
Chris@0:     // target dimensions is missing, that is the one that is calculated. If both
Chris@0:     // are specified then the dimension calculated is the one that would not be
Chris@0:     // calculated to be bigger than its target.
Chris@0:     if (($width && !$height) || ($width && $height && $aspect < $height / $width)) {
Chris@0:       $height = (int) round($width * $aspect);
Chris@0:     }
Chris@0:     else {
Chris@0:       $width = (int) round($height / $aspect);
Chris@0:     }
Chris@0: 
Chris@0:     // Don't upscale if the option isn't enabled.
Chris@0:     if (!$upscale && ($width >= $dimensions['width'] || $height >= $dimensions['height'])) {
Chris@0:       return FALSE;
Chris@0:     }
Chris@0: 
Chris@0:     $dimensions['width'] = $width;
Chris@0:     $dimensions['height'] = $height;
Chris@0:     return TRUE;
Chris@0:   }
Chris@0: 
Chris@0: }