You are here

Home » API reference » Blazy 8.2 » BlazyEntityMediaBase.php

abstract class BlazyEntityMediaBase in Blazy 8.2

Base class for Media entity reference formatters with field details.

Hierarchy

Expanded class hierarchy of BlazyEntityMediaBase

See also

\Drupal\blazy\Dejavu\BlazyEntityReferenceBase

1 file declares its use of BlazyEntityMediaBase
BlazyMediaFormatterBase.php in src/Plugin/Field/FieldFormatter/BlazyMediaFormatterBase.php

File

src/Dejavu/BlazyEntityMediaBase.php, line 15

Namespace

Drupal\blazy\Dejavu
View source 
abstract class BlazyEntityMediaBase extends BlazyEntityBase {
  use BlazyDependenciesTrait;

  /**
   * Returns the slick service.
   */
  public function blazyEntity() {
    return $this->blazyEntity;
  }

  /**
   * Returns the slick service.
   */
  public function blazyOembed() {
    return $this->blazyOembed;
  }

  /**
   * Returns media contents.
   */
  public function buildElements(array &$build, $entities, $langcode) {
    parent::buildElements($build, $entities, $langcode);
    $settings =& $build['settings'];
    $item_id = $settings['item_id'];

    // Some formatter has a toggle Vanilla.
    if (empty($settings['vanilla'])) {
      $settings['check_blazy'] = TRUE;

      // Supports Blazy formatter multi-breakpoint images if available.
      if (isset($build['items'][0]) && ($item = $build['items'][0])) {
        $fallback = isset($item[$item_id]['#build']) ? $item[$item_id]['#build'] : [];
        $settings['first_image'] = isset($item['#build']) ? $item['#build'] : $fallback;
      }
    }
  }

  /**
   * {@inheritdoc}
   */
  public function buildElement(array &$build, $entity, $langcode) {
    $settings =& $build['settings'];
    $item_id = $settings['item_id'];
    $view_mode = $settings['view_mode'] = empty($settings['view_mode']) ? 'full' : $settings['view_mode'];

    // Bail out if vanilla (rendered entity) is required.
    if (!empty($settings['vanilla'])) {
      return parent::buildElement($build, $entity, $langcode);
    }

    // Otherwise hard work which is meant to reduce custom code at theme level.
    $delta = $settings['delta'];
    $element = [
      'settings' => $settings,
    ];

    // Built media item including custom highres video thumbnail.
    $this
      ->blazyOembed()
      ->getMediaItem($element, $entity);

    // Build the main stage with image options from highres video thumbnail.
    if (!empty($settings['image'])) {

      // If Image rendered is picked, render image as is.
      if (!empty($settings['media_switch']) && $settings['media_switch'] == 'rendered') {
        $element['content'][] = $this
          ->blazyEntity()
          ->getFieldRenderable($entity, $settings['image'], $view_mode);
      }
      elseif (empty($element['item']) && empty($settings['uri'])) {
        BlazyMedia::imageItem($element, $entity);
      }
    }

    // Captions if so configured, including Blazy formatters.
    $this
      ->getCaption($element, $entity, $langcode);

    // Optional image with responsive image, lazyLoad, and lightbox supports.
    // Including potential rich Media contents: local video, Facebook, etc.
    $blazy = $this
      ->formatter()
      ->getBlazy($element);

    // If the caller is Blazy, provides simple index elements.
    if ($settings['namespace'] == 'blazy') {
      $build['items'][$delta] = $blazy;
    }
    else {

      // Otherwise Slick, GridStack, Mason, etc. may need more elements.
      $element[$item_id] = $blazy;

      // Provides extra elements.
      $this
        ->buildElementExtra($element, $entity, $langcode);

      // Build the main item.
      $build['items'][$delta] = $element;

      // Build the thumbnail item.
      if (!empty($settings['nav'])) {
        $this
          ->buildElementThumbnail($build, $element, $entity, $delta);
      }
    }
  }

  /**
   * Build extra elements.
   */
  public function buildElementExtra(array &$element, $entity, $langcode) {

    // Do nothing, let extenders do their jobs.
  }

  /**
   * Build thumbnail navigation such as for Slick asnavfor.
   */
  public function buildElementThumbnail(array &$build, $element, $entity, $delta) {

    // Do nothing, let extenders do their jobs.
  }

  /**
   * Builds captions with possible multi-value fields.
   */
  public function getCaption(array &$element, $entity, $langcode) {
    $settings = $element['settings'];
    $view_mode = $settings['view_mode'];

    // The caption fields common to all entity formatters, if so configured.
    if (!empty($settings['caption'])) {
      $caption_items = $weights = [];
      foreach ($settings['caption'] as $name => $field_caption) {

        /** @var Drupal\image\Plugin\Field\FieldType\ImageItem $item */
        if (isset($element['item']) && ($item = $element['item'])) {

          // Provides basic captions based on image attributes (Alt, Title).
          foreach ([
            'title',
            'alt',
          ] as $key => $attribute) {
            if ($name == $attribute && ($caption = trim($item
              ->get($attribute)
              ->getString()))) {
              $markup = Xss::filter($caption, BlazyDefault::TAGS);
              $caption_items[$name] = [
                '#markup' => $markup,
              ];
              $weights[] = $key;
            }
          }
        }
        if ($caption = $this
          ->blazyEntity()
          ->getFieldRenderable($entity, $field_caption, $view_mode)) {
          if (isset($caption['#weight'])) {
            $weights[] = $caption['#weight'];
          }
          $caption_items[$name] = $caption;
        }
      }
      if ($caption_items) {
        if ($weights) {
          array_multisort($weights, SORT_ASC, $caption_items);
        }

        // Differenciate Blazy from Slick, GridStack, etc. to avoid collisions.
        if ($settings['namespace'] == 'blazy') {
          $element['captions'] = $caption_items;
        }
        else {
          $element['caption']['data'] = $caption_items;
        }
      }
    }
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $element = parent::settingsForm($form, $form_state);
    if (isset($element['media_switch'])) {
      $element['media_switch']['#options']['rendered'] = $this
        ->t('Image rendered by its formatter');
      $element['media_switch']['#description'] .= ' ' . $this
        ->t('<b>Image rendered</b> requires <b>Image</b> option filled out and is useful if the formmater offers awesomeness that Blazy does not have but still wants Blazy for a Grid, etc. Be sure the enabled fields here are not hidden/ disabled at its view mode.');
    }
    if (isset($element['caption'])) {
      $element['caption']['#description'] = $this
        ->t('Check fields to be treated as captions, even if not caption texts.');
    }
    if (isset($element['image']['#description'])) {
      $element['image']['#description'] .= ' ' . $this
        ->t('For (remote|local) video, this allows separate high-res or poster image. Be sure this exact same field is also used for bundle <b>Image</b> to have a mix of videos and images if this entity is Media. Leaving it empty will fallback to the video provider thumbnails, or no poster for local video. The formatter/renderer is managed by <strong>@plugin_id</strong> formatter. Meaning original formatter ignored.', [
        '@plugin_id' => $this
          ->getPluginId(),
      ]);
    }
    return $element;
  }

  /**
   * {@inheritdoc}
   */
  public function getScopedFormElements() {
    $target_type = $this
      ->getFieldSetting('target_type');
    $views_ui = $this
      ->getFieldSetting('handler') == 'default';
    $bundles = $views_ui ? [] : $this
      ->getFieldSetting('handler_settings')['target_bundles'];
    $captions = $this
      ->admin()
      ->getFieldOptions($bundles, [], $target_type);
    $images = [];
    if ($bundles) {

      // @todo figure out to not hard-code stock bundle image.
      if (in_array('image', $bundles)) {
        $captions['title'] = $this
          ->t('Image Title');
        $captions['alt'] = $this
          ->t('Image Alt');
      }

      // Only provides poster if media contains rich media.
      $media = [
        'audio',
        'remote_video',
        'video',
        'instagram',
        'soundcloud',
      ];
      if (count(array_intersect($bundles, $media)) > 0) {
        $images['images'] = $this
          ->admin()
          ->getFieldOptions($bundles, [
          'image',
        ], $target_type);
      }
    }

    // @todo better way than hard-coding field name.
    unset($captions['field_image'], $captions['field_media_image']);
    return [
      'background' => TRUE,
      'box_captions' => TRUE,
      'captions' => $captions,
      'fieldable_form' => TRUE,
      'image_style_form' => TRUE,
      'media_switch_form' => TRUE,
      'multimedia' => TRUE,
    ] + parent::getScopedFormElements() + $images;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
BlazyDependenciesTrait::calculateDependencies public function
BlazyDependenciesTrait::onDependencyRemoval public function
BlazyEntityBase::buildSettings public function Builds the settings.
BlazyEntityBase::getCommonFieldDefinition public function Defines the common scope for both front and admin.
BlazyEntityMediaBase::blazyEntity public function Returns the slick service. 1
BlazyEntityMediaBase::blazyOembed public function Returns the slick service.
BlazyEntityMediaBase::buildElement public function Returns item contents. Overrides BlazyEntityBase::buildElement
BlazyEntityMediaBase::buildElementExtra public function Build extra elements. 1
BlazyEntityMediaBase::buildElements public function Returns media contents. Overrides BlazyEntityBase::buildElements
BlazyEntityMediaBase::buildElementThumbnail public function Build thumbnail navigation such as for Slick asnavfor.
BlazyEntityMediaBase::getCaption public function Builds captions with possible multi-value fields. 1
BlazyEntityMediaBase::getScopedFormElements public function Defines the scope for the form elements. Overrides BlazyEntityBase::getScopedFormElements 2
BlazyEntityMediaBase::settingsForm public function Returns a form to configure settings for the formatter. Overrides BlazyEntityBase::settingsForm 1
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
EntityReferenceFormatterBase::checkAccess protected function Checks access to the given entity. 3
EntityReferenceFormatterBase::getEntitiesToView protected function Returns the referenced entities for display. 1
EntityReferenceFormatterBase::needsEntityLoad protected function Returns whether the entity referenced by an item needs to be loaded. 1
EntityReferenceFormatterBase::prepareView public function Loads the entities referenced in that field across all the entities being viewed. Overrides FormatterBase::prepareView
EntityReferenceFormatterBase::view public function Overrides FormatterBase::view
FormatterBase::$fieldDefinition protected property The field definition.
FormatterBase::$label protected property The label display setting.
FormatterBase::$settings protected property The formatter settings. Overrides PluginSettingsBase::$settings
FormatterBase::$viewMode protected property The view mode.
FormatterBase::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create 11
FormatterBase::getFieldSetting protected function Returns the value of a field setting.
FormatterBase::getFieldSettings protected function Returns the array of field settings.
FormatterBase::isApplicable public static function Returns if the formatter can be used for the provided field. Overrides FormatterInterface::isApplicable 14
FormatterBase::settingsSummary public function Returns a short summary for the current formatter settings. Overrides FormatterInterface::settingsSummary 22
FormatterBase::__construct public function Constructs a FormatterBase object. Overrides PluginBase::__construct 11
FormatterInterface::viewElements public function Builds a renderable array for a field value. 47
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$pluginDefinition protected property The plugin implementation definition. 1
PluginBase::$pluginId protected property The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId public function Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId public function Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition 3
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable public function Determines if the plugin is configurable.
PluginSettingsBase::$defaultSettingsMerged protected property Whether default settings have been merged into the current $settings.
PluginSettingsBase::$thirdPartySettings protected property The plugin settings injected by third party modules.
PluginSettingsBase::defaultSettings public static function Defines the default settings for this plugin. Overrides PluginSettingsInterface::defaultSettings 42
PluginSettingsBase::getSetting public function Returns the value of a setting, or its default value if absent. Overrides PluginSettingsInterface::getSetting
PluginSettingsBase::getSettings public function Returns the array of settings, including defaults for missing settings. Overrides PluginSettingsInterface::getSettings
PluginSettingsBase::getThirdPartyProviders public function Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface::getThirdPartyProviders
PluginSettingsBase::getThirdPartySetting public function Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface::getThirdPartySetting
PluginSettingsBase::getThirdPartySettings public function Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface::getThirdPartySettings
PluginSettingsBase::mergeDefaults protected function Merges default settings values into $settings.
PluginSettingsBase::setSetting public function Sets the value of a setting for the plugin. Overrides PluginSettingsInterface::setSetting
PluginSettingsBase::setSettings public function Sets the settings for the plugin. Overrides PluginSettingsInterface::setSettings
PluginSettingsBase::setThirdPartySetting public function Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface::setThirdPartySetting
PluginSettingsBase::unsetThirdPartySetting public function Unsets a third-party setting. Overrides ThirdPartySettingsInterface::unsetThirdPartySetting
StringTranslationTrait::$stringTranslation protected property The string translation service. 1
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.