media_avportal-8.x-1.0-beta10/src/AvPortalResource.php

<?php

declare(strict_types=1);

namespace Drupal\media_avportal;

use Drupal\Component\Utility\Html;
use Drupal\Component\Utility\UrlHelper;

/**
 * Value object representing an AvPortal resource.
 */
class AvPortalResource {

  /**
   * The data coming from the AV portal service for this resource.
   *
   * @var array
   */
  protected $data;

  /**
   * AvPortalResource constructor.
   *
   * @param array $data
   *   The resource data.
   */
  public function __construct(array $data) {
    if (!isset($data['ref'])) {
      throw new \InvalidArgumentException('Invalid resource data.');
    }

    $this->data = $data;
  }

  /**
   * Get the reference.
   *
   * @return string
   *   The reference.
   */
  public function getRef(): string {
    return $this->data['ref'];
  }

  /**
   * Get the reference.
   *
   * @return string
   *   The reference.
   */
  public function getType(): string {
    return $this->data['type'];
  }

  /**
   * Get the Photo URI (for PHOTOS).
   *
   * @return string
   *   The photo Uri
   */
  public function getPhotoUri(): string {
    return $this->data['media_json']['HIGH']['PATH'] ?? '';
  }

  /**
   * Returns the title of the resource.
   *
   * @param string $langcode
   *   The language in which to return the title.
   *
   * @return string
   *   The title.
   */
  public function getTitle(string $langcode = 'EN'): ?string {
    if (!isset($this->data['titles_json']) || !is_array($this->data['titles_json'])) {
      return NULL;
    }

    // Filter out any NULL, TRUE, FALSE and non-scalar titles.
    $titles = array_filter($this->data['titles_json'], function ($value): bool {
      return is_string($value) || is_numeric($value);
    });
    if (empty($titles)) {
      return NULL;
    }

    // The first available title will be used as fallback in case the specified
    // langcode is not present.
    $title = reset($titles);

    $title = $this->getTranslatedValue($titles, $langcode) ?? $title;

    return $this->truncateString(strip_tags(Html::decodeEntities($title)));
  }

  /**
   * Returns the thumbnail URL.
   *
   * @return null|string
   *   The thumbnail URL if it exists, NULL otherwise.
   */
  public function getThumbnailUrl(): ?string {
    if (!isset($this->data['media_json']) || !is_array($this->data['media_json'])) {
      return NULL;
    }

    if ($this->getType() == 'VIDEO') {
      return $this->getVideoThumbnailUrl();
    }
    elseif (in_array($this->getType(), ['PHOTO', 'REPORTAGE'])) {
      return $this->getPhotoThumbnailUrl();
    }

    return NULL;
  }

  /**
   * Returns a caption for photo.
   *
   * @param string $langcode
   *   The language in which to return the caption.
   *
   * @return string|null
   *   Caption of the photo.
   */
  public function getCaption(string $langcode = 'EN'): ?string {
    $caption_element = NULL;
    // Determine caption element by resource type.
    if ($this->getType() === 'PHOTO') {
      $caption_element = 'summary_json';
    }
    elseif ($this->getType() === 'REPORTAGE') {
      $caption_element = 'legend_json';
    }

    // Return NULL if we don't know the caption element or if
    // the caption element does not exist or is not an array.
    if (!$caption_element || !isset($this->data[$caption_element]) || !is_array($this->data[$caption_element])) {
      return NULL;
    }

    // Filter out any NULL, TRUE, FALSE and non-scalar captions.
    $captions = array_filter($this->data[$caption_element], function ($value): bool {
      return is_string($value) || is_numeric($value);
    });
    if (empty($captions)) {
      return NULL;
    }

    // The first available caption will be used as fallback in case
    // the specified langcode is not present.
    $caption = reset($captions);

    $caption = $this->getTranslatedValue($captions, $langcode) ?? $caption;

    return !is_null($caption) ? strip_tags(Html::decodeEntities($caption)) : NULL;
  }

  /**
   * Get translated value.
   *
   * @param array $values
   *   An array of values.
   * @param string|null $langcode
   *   The language code.
   *
   * @return string|null
   *   Return localised value if exists.
   */
  protected function getTranslatedValue(array $values, string $langcode = 'EN'): ?string {
    // English is used as fallback in case the specified langcode is not
    // available.
    $langcodes = array_unique([$langcode, 'EN']);
    foreach ($langcodes as $langcode) {
      if (isset($values[$langcode])) {
        return $values[$langcode];
      }
    }
    return NULL;
  }

  /**
   * Truncates a string when longer than 255 characters, preserving full words.
   *
   * If the string is truncated, an ellipsis is added at the end.
   *
   * @param string $value
   *   The string to truncate.
   *
   * @return string
   *   The truncated string.
   *
   * @see \Drupal\views\Plugin\views\field\FieldPluginBase::trimText
   */
  protected function truncateString(string $value): string {
    // The maximum length for simple string columns in tables is 255.
    if (mb_strlen($value) <= 255) {
      return $value;
    }

    // Cut one extra character to leave space for the ellipsis.
    $value = mb_substr($value, 0, 254);
    $regex = "(.*)\b.+";
    if (function_exists('mb_ereg')) {
      mb_regex_encoding('UTF-8');
      $found = mb_ereg($regex, $value, $matches);
    }
    else {
      $found = preg_match("/$regex/us", $value, $matches);
    }
    if ($found) {
      $value = $matches[1];
    }
    // Remove scraps of HTML entities from the end of a strings.
    $value = rtrim(preg_replace('/(?:<(?!.+>)|&(?!.+;)).*$/us', '', $value));
    $value .= '…';

    return $value;
  }

  /**
   * Returns a thumbnail for video.
   *
   * @return string|null
   *   URL of the thumbnail.
   */
  protected function getVideoThumbnailUrl(): ?string {
    $first_media_json = reset($this->data['media_json']);

    $languages = [
      'INT',
      // @phpstan-ignore-next-line
      mb_strtoupper(\Drupal::languageManager()->getDefaultLanguage()->getId()),
      'EN',
    ];
    $languages = array_merge($languages, $this->data['languages'] ?? []);
    $languages = array_unique(array_filter($languages));

    foreach ($languages as $langcode) {
      if (isset($first_media_json[$langcode]['THUMB'])) {
        return UrlHelper::parse($first_media_json[$langcode]['THUMB'])['path'] ?? NULL;
      }
    }

    return NULL;
  }

  /**
   * Returns a thumbnail for photo.
   *
   * @return string|null
   *   URL of the thumbnail.
   */
  protected function getPhotoThumbnailUrl(): ?string {
    // We default to the first aspect ratio.
    $media_json = $this->data['media_json'];

    $resolutions = ['MED', 'LOW', 'HIGH'];
    foreach ($resolutions as $resolution) {
      if (isset($media_json[$resolution]['PATH'])) {
        return $media_json[$resolution]['PATH'];
      }
    }

    return NULL;
  }

  /**
   * Returns resource data.
   *
   * @return array
   *   The resource data.
   */
  public function getData(): array {
    return $this->data;
  }

}