blazy-8.x-2.x-dev/src/Media/Ratio.php

<?php

namespace Drupal\blazy\Media;

use Drupal\blazy\BlazyDefault;
use Drupal\blazy\internals\Internals;

/**
 * Provides aspect ratio insanity.
 *
 * @internal
 *   This is an internal part of the Blazy system and should only be used by
 *   blazy-related code in Blazy module.
 */
class Ratio {

  /**
   * Returns whether aspect ratio padding hack applicable, or not.
   *
   * Prevents double padding hacks with AMP which also uses similar technique.
   */
  public static function hack(array $settings): array {
    $blazies  = $settings['blazies'];
    $disabled = $blazies->is('amp');
    $fluid    = $blazies->is('fluid');
    $_svg     = $blazies->is('svg');
    $_none    = ($settings['svg_attributes'] ?? NULL) == 'none';
    $ratio    = $disabled ? '' : $settings['ratio'] ?? NULL;
    $hack     = $ratio && $fluid;
    $resimage = $blazies->get('resimage.id');
    $provider = $blazies->get('media.provider');
    $noratio  = Internals::irrational($provider);
    $lightbox = $blazies->is('lightbox');

    // Skip padding hacks if fluid is supported by plain CSS, to avoid JS.
    if ($hack) {
      // Do not mess up with responsive image for now, or you'll be sorry.
      if (!$resimage && $check = $blazies->get('image.fluid')) {
        $ratio = $check;
        $hack  = FALSE;
      }
      // If using image_style or defaults, even SVG can be padding-hacked for
      // consistency. If using none, then disable aspect ratio altogether.
      // @todo recheck against responsive image, gif, apng, alike.
      if ($_svg && $_none) {
        $ratio = NULL;
        $hack  = FALSE;
      }
    }

    // Disable problematic instagram, except for lightbox displays.
    if ($noratio && !$lightbox) {
      $ratio = NULL;
      $hack  = FALSE;
    }

    return ['ratio' => $ratio, 'hack' => $hack];
  }

  /**
   * Provides a computed image ratio aka fluid ratio.
   *
   * Addresses multi-image-style Responsive image or, plain old one.
   * A failsafe for BG, else collapsed.
   *
   * @todo decide if to provide NULL or 0 instead.
   * @todo converts to blazies at/by 3.x.
   */
  public static function compute(array $data) {
    $no_dims = empty($data['height']) || empty($data['width']);
    return $no_dims ? 0 : round((($data['height'] / $data['width']) * 100), 2);
  }

  /**
   * Provides a computed image ratio aka fluid ratio.
   */
  public static function fluid(array $data, $force = FALSE): ?string {
    $width  = $data['width'];
    $height = $data['height'];
    $ratios = $data['ratios'] ?? BlazyDefault::RATIO;
    $output = NULL;

    if (empty($width) || empty($height)) {
      return $output;
    }

    $width  = (int) $width;
    $height = (int) $height;

    try {
      $check  = self::toRatio($width, $height);
      $result = ($width / $check) . ':' . ($height / $check);

      if (in_array($result, $ratios) || $force) {
        $output = $result;
      }
    }
    catch (\DivisionByZeroError $e) {
      // Do nothing, optional features should not mess up the rest.
    }
    catch (\Exception $e) {
      // Do nothing also.
    }

    return $output;
  }

  /**
   * Provides a computed image ratio aka fluid ratio.
   */
  private static function toRatio($width, $height) {
    if ($width == 0 || $height == 0) {
      return abs(max(abs($width), abs($height)));
    }

    $result = $width % $height;
    return ($result != 0) ? self::toRatio($height, $result) : abs($height);
  }

}