You are here

Home » API reference » Blazy 8.2 » BlazyEntityReferenceBase.php

abstract class BlazyEntityReferenceBase in Blazy 8.2

Same name and namespace in other branches
  1. 8 src/Dejavu/BlazyEntityReferenceBase.php \Drupal\blazy\Dejavu\BlazyEntityReferenceBase

Base class for all entity reference formatters with field details.

Hierarchy

Expanded class hierarchy of BlazyEntityReferenceBase

See also

\Drupal\slick\Plugin\Field\FieldFormatter\SlickEntityReferenceFormatterBase

1 file declares its use of BlazyEntityReferenceBase
BlazyTestEntityReferenceFormatterTest.php in tests/modules/blazy_test/src/Plugin/Field/FieldFormatter/BlazyTestEntityReferenceFormatterTest.php

File

src/Dejavu/BlazyEntityReferenceBase.php, line 14

Namespace

Drupal\blazy\Dejavu
View source 
abstract class BlazyEntityReferenceBase extends BlazyEntityMediaBase {

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return BlazyDefault::extendedSettings() + BlazyDefault::gridSettings();
  }

  /**
   * Build extra elements.
   */
  public function buildElementExtra(array &$element, $entity, $langcode) {
    parent::buildElementExtra($element, $entity, $langcode);
    $settings =& $element['settings'];

    // Layouts can be builtin, or field, if so configured.
    if (!empty($settings['layout'])) {
      $layout = $settings['layout'];
      if (strpos($layout, 'field_') !== FALSE && isset($entity->{$layout})) {
        $layout = $this
          ->blazyEntity()
          ->getFieldString($entity, $layout, $langcode);
      }
      $settings['layout'] = $layout;
    }

    // Classes, if so configured.
    if (!empty($settings['class']) && isset($entity->{$settings['class']})) {
      $settings['class'] = $this
        ->blazyEntity()
        ->getFieldString($entity, $settings['class'], $langcode);
    }
  }

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

    // Title can be plain text, or link field.
    if (!empty($settings['title'])) {
      if (isset($entity->{$settings['title']})) {
        $element['caption']['title'] = $this
          ->blazyEntity()
          ->getFieldTextOrLink($entity, $settings['title'], $settings);
      }
      elseif (isset($element['item']) && ($item = $element['item'])) {
        if ($settings['title'] == 'title' && ($caption = trim($item
          ->get('title')
          ->getString()))) {
          $markup = Xss::filter($caption, BlazyDefault::TAGS);
          $element['caption']['title'] = [
            '#markup' => $markup,
          ];
        }
      }
    }

    // Link, if so configured.
    if (!empty($settings['link']) && isset($entity->{$settings['link']})) {
      $links = $this
        ->blazyEntity()
        ->getFieldRenderable($entity, $settings['link'], $view_mode);

      // Only simplify markups for known formatters registered by link.module.
      if ($links && isset($links['#formatter']) && in_array($links['#formatter'], [
        'link',
      ])) {
        $links = [];
        foreach ($entity->{$settings['link']} as $link) {
          $links[] = $link
            ->view($view_mode);
        }
      }
      $element['caption']['link'] = $links;
    }

    // Overlay, if so configured.
    if (!empty($settings['overlay']) && isset($entity->{$settings['overlay']})) {
      $element['caption']['overlay'] = $this
        ->getOverlay($settings, $entity, $langcode);
    }
  }

  /**
   * Builds overlay placed within the caption.
   */
  public function getOverlay(array $settings, $entity, $langcode) {
    return $entity
      ->get($settings['overlay'])
      ->view($settings['view_mode']);
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $element = parent::settingsForm($form, $form_state);
    if (isset($element['layout'])) {
      $layout_description = $element['layout']['#description'];
      $element['layout']['#description'] = $this
        ->t('Create a dedicated List (text - max number 1) field related to the caption placement to have unique layout per slide with the following supported keys: top, right, bottom, left, center, center-top, etc. Be sure its formatter is Key.') . ' ' . $layout_description;
    }
    if (isset($element['overlay']['#description'])) {
      $element['overlay']['#description'] .= ' ' . $this
        ->t('The formatter/renderer is managed by the child formatter.');
    }
    return $element;
  }

  /**
   * {@inheritdoc}
   */
  public function getScopedFormElements() {
    $admin = $this
      ->admin();
    $target_type = $this
      ->getFieldSetting('target_type');
    $views_ui = $this
      ->getFieldSetting('handler') == 'default';
    $bundles = $views_ui ? [] : $this
      ->getFieldSetting('handler_settings')['target_bundles'];
    $strings = [
      'text',
      'string',
      'list_string',
    ];
    $strings = $admin
      ->getFieldOptions($bundles, $strings, $target_type);
    $texts = [
      'text',
      'text_long',
      'string',
      'string_long',
      'link',
    ];
    $texts = $admin
      ->getFieldOptions($bundles, $texts, $target_type);
    $links = [
      'text',
      'string',
      'link',
    ];
    return [
      'classes' => $strings,
      'images' => $admin
        ->getFieldOptions($bundles, [
        'image',
      ], $target_type),
      'layouts' => $strings,
      'links' => $admin
        ->getFieldOptions($bundles, $links, $target_type),
      'titles' => $texts,
      'vanilla' => TRUE,
    ] + parent::getScopedFormElements();
  }

}

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::buildElements public function Returns media contents. Overrides BlazyEntityBase::buildElements
BlazyEntityMediaBase::buildElementThumbnail public function Build thumbnail navigation such as for Slick asnavfor.
BlazyEntityReferenceBase::buildElementExtra public function Build extra elements. Overrides BlazyEntityMediaBase::buildElementExtra
BlazyEntityReferenceBase::defaultSettings public static function Defines the default settings for this plugin. Overrides PluginSettingsBase::defaultSettings 1
BlazyEntityReferenceBase::getCaption public function Builds slide captions with possible multi-value fields. Overrides BlazyEntityMediaBase::getCaption
BlazyEntityReferenceBase::getOverlay public function Builds overlay placed within the caption.
BlazyEntityReferenceBase::getScopedFormElements public function Defines the scope for the form elements. Overrides BlazyEntityMediaBase::getScopedFormElements 1
BlazyEntityReferenceBase::settingsForm public function Returns a form to configure settings for the formatter. Overrides BlazyEntityMediaBase::settingsForm
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::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.