class ImageStyles in Consumer Image Styles 4.x

Perform additional manipulations to timestamp fields.

Plugin annotation

@ResourceFieldEnhancer(
  id = "image_styles",
  label = @Translation("Image Styles (Image field)"),
  description = @Translation("Adds links for images with image styles
  applied to them.")
)

Hierarchy

• class \Drupal\consumer_image_styles\Plugin\jsonapi\FieldEnhancer\ImageStyles extends \Drupal\jsonapi_extras\Plugin\ResourceFieldEnhancerBase implements ContainerFactoryPluginInterface

File

src/Plugin/jsonapi/FieldEnhancer/ImageStyles.php, line 26

Namespace

Drupal\consumer_image_styles\Plugin\jsonapi\FieldEnhancer

class ImageStyles extends ResourceFieldEnhancerBase implements ContainerFactoryPluginInterface {

  /**
   * @var \Drupal\consumer_image_styles\ImageStylesProviderInterface
   */
  protected $imageStylesProvider;

  /**
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * {@inheritdoc}
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, ImageStylesProviderInterface $image_styles_provider, EntityTypeManagerInterface $entity_type_manager) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->imageStylesProvider = $image_styles_provider;
    $this->entityTypeManager = $entity_type_manager;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    $image_styles_provider = $container
      ->get('consumer_image_styles.image_styles_provider');
    $entity_type_manager = $container
      ->get('entity_type.manager');
    $configuration['consumer_image_style_ids'] = [];
    $request = $container
      ->get('request_stack')
      ->getCurrentRequest();
    $consumer = $container
      ->get('consumer.negotiator')
      ->negotiateFromRequest($request);
    if ($consumer) {
      $styles = $image_styles_provider
        ->loadStyles($consumer);
      $configuration['consumer_image_style_ids'] = array_keys($styles);
    }
    return new static($configuration, $plugin_id, $plugin_definition, $image_styles_provider, $entity_type_manager);
  }

  /**
   * {@inheritdoc}
   */
  protected function doUndoTransform($data, Context $context) {
    $image_style_ids = $this
      ->imageStylesForField();
    if (empty($image_style_ids)) {
      return $data;
    }

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

    /** @var \Drupal\Core\Entity\Entity $entity */
    $uuid_key = $this->entityTypeManager
      ->getDefinition('file')
      ->getKey('uuid');
    $entities = $this->entityTypeManager
      ->getStorage('file')
      ->loadByProperties([
      $uuid_key => $data['id'],
    ]);
    $entity = reset($entities);

    // If the entity cannot be loaded or it's not an image, do not enhance it.
    if (!$entity || !$this->imageStylesProvider
      ->entityIsImage($entity)) {
      return $data;
    }

    /** @var \Drupal\file\Entity\File $entity */

    // If the entity is not viewable.
    $access = $entity
      ->access('view', NULL, TRUE);
    if (!$access
      ->isAllowed()) {
      return $data;
    }

    // @TODO: When enhanced transformations carry cacheable meta, add the access info.
    $uri = $entity
      ->getFileUri();
    $links = array_map(function (ImageStyleInterface $image_style) use ($uri) {
      return $this->imageStylesProvider
        ->buildDerivativeLink($uri, $image_style);
    }, $image_styles);

    // @TODO: When enhanced transformations carry cacheable meta, add the image styles entities.
    $meta = [
      'imageDerivatives' => [
        'links' => $links,
      ],
    ];
    return array_merge_recursive($data, [
      'meta' => $meta,
    ]);
  }

  /**
   * Gets the list of image style IDs for the current field.
   *
   * Intersects the field enhancer configuration with the consumer's config to
   * calculate the list of image styles to apply to the field.
   *
   * @return string[]
   *   The list of IDs.
   */
  protected function imageStylesForField() {
    $configuration = $this
      ->getConfiguration();
    $image_style_ids = $configuration['consumer_image_style_ids'];

    // By default make all the image styles for the consumer available, but
    // allow further refinement.
    if (!empty($configuration['styles']['refine']) && !empty($configuration['styles']['custom_selection'])) {
      $refined_style_ids = $configuration['styles']['custom_selection'];
      $image_style_ids = array_intersect($refined_style_ids, $image_style_ids);
    }
    return $image_style_ids;
  }

  /**
   * {@inheritdoc}
   */
  protected function doTransform($value, Context $context) {
    return $value;
  }

  /**
   * {@inheritdoc}
   */
  public function getOutputJsonSchema() {
    return [
      'type' => 'object',
      'properties' => [
        'type' => [
          'type' => 'string',
        ],
        'id' => [
          'type' => 'string',
        ],
        'meta' => [
          'type' => 'object',
          'properties' => [
            'height' => [
              'type' => 'integer',
            ],
            'width' => [
              'type' => 'integer',
            ],
            'alt' => [
              'anyOf' => [
                [
                  'type' => 'string',
                ],
                [
                  'type' => 'null',
                ],
              ],
            ],
            'title' => [
              'anyOf' => [
                [
                  'type' => 'string',
                ],
                [
                  'type' => 'null',
                ],
              ],
            ],
            'links' => [
              'type' => 'object',
              'patternProperties' => [
                '.*' => [
                  'type' => 'object',
                  'properties' => [
                    'href' => [
                      'type' => 'string',
                      'format' => 'uri',
                    ],
                    'meta' => [
                      'type' => 'object',
                      'properties' => [
                        'rel' => [
                          'type' => 'array',
                          'items' => [
                            'type' => 'string',
                            'format' => 'uri',
                          ],
                        ],
                      ],
                    ],
                  ],
                ],
              ],
            ],
          ],
        ],
      ],
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function getSettingsForm(array $resource_field_info) {
    $options = [];
    $settings = empty($resource_field_info['enhancer']['settings']) ? $this
      ->getConfiguration() : $resource_field_info['enhancer']['settings'];
    foreach (ImageStyle::loadMultiple() as $style) {
      $options[$style
        ->id()] = $style
        ->label();
    }
    $refine_ref = 'resourceFields[' . $resource_field_info['fieldName'] . '][enhancer][settings][styles][refine]';
    return [
      'styles' => [
        '#type' => 'details',
        '#open' => TRUE,
        '#title' => $this
          ->t('Image Styles options'),
        '#tree' => TRUE,
        'refine' => [
          '#type' => 'checkbox',
          '#element_validate' => [
            [
              static::class,
              'stringToBool',
            ],
          ],
          '#title' => $this
            ->t('Refine selection?'),
          '#description' => $this
            ->t('Reduces the list of image styles in the output calculated from the Consumer configuration.'),
          '#default_value' => empty($settings['styles']['refine']) ? FALSE : $settings['styles']['refine'],
        ],
        'custom_selection' => [
          '#type' => 'checkboxes',
          '#element_validate' => [
            [
              static::class,
              'mappingToSequence',
            ],
          ],
          '#title' => $this
            ->t('Image Styles'),
          '#description' => $this
            ->t('Narrow down the image styles to display on this field. Note that any image styles selected here that are not allowed in the consumer making the HTTP request will not appear in the output.'),
          '#default_value' => empty($settings['styles']['custom_selection']) ? array_keys($options) : $settings['styles']['custom_selection'],
          '#options' => $options,
          '#states' => [
            'disabled' => [
              ':input[name="' . $refine_ref . '"]' => [
                'checked' => FALSE,
              ],
            ],
            'invisible' => [
              ':input[name="' . $refine_ref . '"]' => [
                'checked' => FALSE,
              ],
            ],
          ],
        ],
      ],
    ];
  }

  /**
   * Transforms the string from the checkbox into an actual boolean.
   */
  public static function stringToBool(array &$element, FormStateInterface $form_state) {
    $new_value = (bool) $form_state
      ->getValue($element['#parents']);
    $form_state
      ->setValue($element['#parents'], $new_value);
  }

  /**
   * Transforms the mapping into a sequence.
   */
  public static function mappingToSequence(array &$element, FormStateInterface $form_state) {
    $new_value = array_keys(array_filter($form_state
      ->getValue($element['#parents'])));
    $form_state
      ->setValue($element['#parents'], $new_value);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ImageStyles::$entityTypeManager	protected	property
ImageStyles::$imageStylesProvider	protected	property
ImageStyles::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
ImageStyles::doTransform	protected	function
ImageStyles::doUndoTransform	protected	function
ImageStyles::getOutputJsonSchema	public	function
ImageStyles::getSettingsForm	public	function
ImageStyles::imageStylesForField	protected	function	Gets the list of image style IDs for the current field.
ImageStyles::mappingToSequence	public static	function	Transforms the mapping into a sequence.
ImageStyles::stringToBool	public static	function	Transforms the string from the checkbox into an actual boolean.
ImageStyles::__construct	public	function