You are here

Home » API reference » Blazy 8.2 » BlazyTestEntityReferenceFormatterTest.php

class BlazyTestEntityReferenceFormatterTest in Blazy 8.2

Same name and namespace in other branches
  1. 8 tests/modules/blazy_test/src/Plugin/Field/FieldFormatter/BlazyTestEntityReferenceFormatterTest.php \Drupal\blazy_test\Plugin\Field\FieldFormatter\BlazyTestEntityReferenceFormatterTest

Plugin implementation of the 'Blazy Entity Reference' formatter.

Plugin annotation


@FieldFormatter(
  id = "blazy_entity_test",
  label = @Translation("Blazy Entity Reference Test"),
  field_types = {"entity_reference", "file"}
)

Hierarchy

Expanded class hierarchy of BlazyTestEntityReferenceFormatterTest

File

tests/modules/blazy_test/src/Plugin/Field/FieldFormatter/BlazyTestEntityReferenceFormatterTest.php, line 21

Namespace

Drupal\blazy_test\Plugin\Field\FieldFormatter
View source 
class BlazyTestEntityReferenceFormatterTest extends BlazyEntityReferenceBase implements ContainerFactoryPluginInterface {
  use BlazyFormatterTrait;

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    $instance = parent::create($container, $configuration, $plugin_id, $plugin_definition);
    return self::injectServices($instance, $container, 'entity');
  }

  /**
   * Returns the blazy_test admin service shortcut.
   */
  public function admin() {
    return \Drupal::service('blazy_test.admin');
  }

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

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

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    $entities = $this
      ->getEntitiesToView($items, $langcode);

    // Early opt-out if the field is empty.
    if (empty($entities)) {
      return [];
    }

    // Collects specific settings to this formatter.
    $settings = $this
      ->buildSettings();
    $build = [
      'settings' => $settings,
    ];
    $this
      ->formatter()
      ->buildSettings($build, $items);

    // Build the elements.
    $this
      ->buildElements($build, $entities, $langcode);

    // Pass to manager for easy updates to all Blazy formatters.
    return $this->formatter
      ->build($build);
  }

  /**
   * Builds the settings.
   */
  public function buildSettings() {
    $settings = $this
      ->getSettings();
    $settings['blazy'] = TRUE;
    $settings['lazy'] = 'blazy';
    $settings['item_id'] = 'box';
    $settings['plugin_id'] = $this
      ->getPluginId();
    return $settings;
  }

  /**
   * {@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'];
    $node = $admin
      ->getFieldOptions($bundles, [
      'entity_reference',
    ], $target_type, 'node');
    $stages = $admin
      ->getFieldOptions($bundles, [
      'image',
    ], $target_type);
    return [
      'namespace' => 'blazy_test',
      'images' => $stages,
      'overlays' => $stages + $node,
      'thumbnails' => $stages,
      'optionsets' => [
        'default' => 'Default',
      ],
    ] + parent::getScopedFormElements();
  }

}

Members

Namesort descending Modifiers Type Description Overrides
BlazyDependenciesTrait::calculateDependencies public function
BlazyDependenciesTrait::onDependencyRemoval public function
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::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::settingsForm public function Returns a form to configure settings for the formatter. Overrides BlazyEntityMediaBase::settingsForm
BlazyFormatterTrait::$blazyManager protected property The blazy manager service.
BlazyFormatterTrait::$formatter protected property The blazy manager service.
BlazyFormatterTrait::blazyManager public function Returns the blazy manager.
BlazyFormatterTrait::formatter public function Returns the blazy formatter manager.
BlazyFormatterTrait::getCommonFieldDefinition public function Defines the common scope for both front and admin.
BlazyFormatterTrait::getCommonScopedFormElements public function Defines the common scope for the form elements.
BlazyFormatterTrait::injectServices protected static function Injects DI services.
BlazyFormatterTrait::settingsSummary public function
BlazyTestEntityReferenceFormatterTest::admin public function Returns the blazy_test admin service shortcut. Overrides BlazyFormatterTrait::admin
BlazyTestEntityReferenceFormatterTest::blazyEntity public function Returns the slick service. Overrides BlazyEntityMediaBase::blazyEntity
BlazyTestEntityReferenceFormatterTest::buildSettings public function Builds the settings. Overrides BlazyFormatterTrait::buildSettings
BlazyTestEntityReferenceFormatterTest::create public static function Creates an instance of the plugin. Overrides FormatterBase::create
BlazyTestEntityReferenceFormatterTest::defaultSettings public static function Defines the default settings for this plugin. Overrides BlazyEntityReferenceBase::defaultSettings
BlazyTestEntityReferenceFormatterTest::getScopedFormElements public function Defines the scope for the form elements. Overrides BlazyEntityReferenceBase::getScopedFormElements
BlazyTestEntityReferenceFormatterTest::viewElements public function Builds a renderable array for a field value. Overrides FormatterInterface::viewElements
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::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::__construct public function Constructs a FormatterBase object. Overrides PluginBase::__construct 11
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.