class ImageStylesProvider in Consumer Image Styles 8.3

Class ImageStylesProvider.

@package Drupal\consumer_image_styles

Hierarchy

• class \Drupal\consumer_image_styles\ImageStylesProvider

3 files declare their use of ImageStylesProvider

ConsumerImageSylesFunctionalTest.php in tests/src/Functional/ConsumerImageSylesFunctionalTest.php

ImageStyles.php in src/Plugin/jsonapi/FieldEnhancer/ImageStyles.php

LinkCollectionNormalizer.php in src/Normalizer/LinkCollectionNormalizer.php

1 string reference to 'ImageStylesProvider'

consumer_image_styles.services.yml in ./consumer_image_styles.services.yml

consumer_image_styles.services.yml

1 service uses ImageStylesProvider

consumer_image_styles.image_styles_provider in ./consumer_image_styles.services.yml

Drupal\consumer_image_styles\ImageStylesProvider

File

src/ImageStylesProvider.php, line 18

Namespace

Drupal\consumer_image_styles

class ImageStylesProvider {
  const DERIVATIVE_LINK_REL = 'drupal://jsonapi/extensions/consumer_image_styles/links/relation-types/#derivative';

  /**
   * The entity type manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  private $entityTypeManager;

  /**
   * The image factory.
   *
   * @var \Drupal\Core\Image\ImageFactory
   */
  private $imageFactory;
  public function __construct(EntityTypeManagerInterface $entity_type_manager, ImageFactory $image_factory) {
    $this->entityTypeManager = $entity_type_manager;
    $this->imageFactory = $image_factory;
  }

  /**
   * Load the image styles for a given consumer.
   *
   * @param \Drupal\consumers\Entity\Consumer $consumer
   *   Consumer entity to load image styles for.
   *
   * @return \Drupal\image\Entity\ImageStyle[]
   *   List of image styles keyed by image style id.
   */
  public function loadStyles(Consumer $consumer) {
    $consumer_config = $consumer
      ->get('image_styles')
      ->getValue();
    $image_style_ids = array_map(function ($field_value) {
      return $field_value['target_id'];
    }, $consumer_config);

    // Load image style entities in bulk.
    try {
      $image_styles = $this->entityTypeManager
        ->getStorage('image_style')
        ->loadMultiple($image_style_ids);
    } catch (PluginException $e) {
      $image_styles = [];
    }
    return $image_styles;
  }

  /**
   * Builds a derivative link based on the image URI and the image style.
   *
   * @param string $uri
   *   The file URI.
   * @param \Drupal\image\ImageStyleInterface $image_style
   *   The image style to apply.
   *
   * @return array
   *   A structured array that complies with the JSON:API spec for links.
   *
   * @see https://jsonapi.org/format/#document-links
   */
  public function buildDerivativeLink($uri, ImageStyleInterface $image_style) {
    return [
      'href' => file_create_url($image_style
        ->buildUrl($uri)),
      'meta' => [
        'rel' => [
          static::DERIVATIVE_LINK_REL,
        ],
      ],
    ];
  }

  /**
   * Checks if an entity is an image.
   *
   * @param \Drupal\Core\Entity\EntityInterface $entity
   *   The entity.
   *
   * @return bool
   *   TRUE if the entity is an image.
   */
  public function entityIsImage(EntityInterface $entity) {
    if (!$entity instanceof File) {
      return FALSE;
    }
    return $this->imageFactory
      ->get($entity
      ->getFileUri())
      ->isValid();
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ImageStylesProvider::$entityTypeManager	private	property	The entity type manager.
ImageStylesProvider::$imageFactory	private	property	The image factory.
ImageStylesProvider::buildDerivativeLink	public	function	Builds a derivative link based on the image URI and the image style.
ImageStylesProvider::DERIVATIVE_LINK_REL		constant
ImageStylesProvider::entityIsImage	public	function	Checks if an entity is an image.
ImageStylesProvider::loadStyles	public	function	Load the image styles for a given consumer.
ImageStylesProvider::__construct	public	function