class BlazyTestEntityReferenceFormatterTest in Blazy 8

Same name and namespace in other branches

8.2 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

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
  - class \Drupal\Core\Field\PluginSettingsBase implements DependentPluginInterface, PluginSettingsInterface
    class \Drupal\Core\Field\FormatterBase implements FormatterInterface, ContainerFactoryPluginInterface
    class \Drupal\Core\Field\Plugin\Field\FieldFormatter\EntityReferenceFormatterBase
    class \Drupal\blazy\Dejavu\BlazyEntityBase
    class \Drupal\blazy\Dejavu\BlazyEntityReferenceBase uses BlazyEntityTrait
    class \Drupal\blazy_test\Plugin\Field\FieldFormatter\BlazyTestEntityReferenceFormatterTest implements ContainerFactoryPluginInterface uses BlazyVideoTrait, BlazyFormatterBaseTrait

Expanded class hierarchy of BlazyTestEntityReferenceFormatterTest

File

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

Namespace

Drupal\blazy_test\Plugin\Field\FieldFormatter

View source

class BlazyTestEntityReferenceFormatterTest extends BlazyEntityReferenceBase implements ContainerFactoryPluginInterface {
  use BlazyVideoTrait;
  use BlazyFormatterBaseTrait;

  /**
   * The logger factory.
   *
   * @var \Drupal\Core\Logger\LoggerChannelFactoryInterface
   */
  protected $loggerFactory;

  /**
   * Constructs a SlickMediaFormatter instance.
   */
  public function __construct($plugin_id, $plugin_definition, FieldDefinitionInterface $field_definition, array $settings, $label, $view_mode, array $third_party_settings, LoggerChannelFactoryInterface $logger_factory, BlazyManagerInterface $blazy_manager, BlazyFormatterTestInterface $formatter) {
    parent::__construct($plugin_id, $plugin_definition, $field_definition, $settings, $label, $view_mode, $third_party_settings);
    $this->loggerFactory = $logger_factory;
    $this->blazyManager = $blazy_manager;
    $this->formatter = $formatter;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($plugin_id, $plugin_definition, $configuration['field_definition'], $configuration['settings'], $configuration['label'], $configuration['view_mode'], $configuration['third_party_settings'], $container
      ->get('logger.factory'), $container
      ->get('blazy.manager'), $container
      ->get('blazy_test.formatter'));
  }

  /**
   * Returns the blazy formatter.
   */
  public function formatter() {
    return $this->formatter;
  }

  /**
   * Returns the blazy admin.
   */
  public function manager() {
    return $this->formatter;
  }

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

  /**
   * {@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);

    // Alternatively use grid: BlazyGrid::build($build['items'], $settings).
    $elements = $build['items'];
    $elements['#attached'] = $this->formatter
      ->attach($settings);
    return $elements;
  }

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

}

Members

Name	Modifiers	Type	Description	Overrides
BlazyEntityBase::buildElements	public	function	Returns media contents.
BlazyEntityReferenceBase::buildElement	public	function	Returns item contents. Overrides BlazyEntityBase::buildElement
BlazyEntityReferenceBase::buildStage	public	function	Build the main background/stage, image or video.
BlazyEntityReferenceBase::getCaption	public	function	Builds slide captions with possible multi-value fields.
BlazyEntityReferenceBase::getOverlay	public	function	Builds overlay placed within the caption.
BlazyEntityReferenceBase::settingsForm	public	function	Returns a form to configure settings for the formatter. Overrides BlazyEntityBase::settingsForm
BlazyEntityTrait::buildPreview	public	function	Build image/video preview either using theme_blazy(), or view builder.
BlazyEntityTrait::getFieldRenderable	public	function	Returns the formatted renderable array of the field.
BlazyEntityTrait::getFieldString	public	function	Returns the string value of the fields: link, or text.
BlazyFormatterBaseTrait::$blazyManager	protected	property	The blazy manager service.
BlazyFormatterBaseTrait::blazyManager	public	function	Returns the blazy manager.
BlazyFormatterBaseTrait::settingsSummary	public	function
BlazyTestEntityReferenceFormatterTest::$loggerFactory	protected	property	The logger factory.
BlazyTestEntityReferenceFormatterTest::admin	public	function	Returns the blazy_test admin service shortcut. Overrides BlazyFormatterBaseTrait::admin
BlazyTestEntityReferenceFormatterTest::buildSettings	public	function	Builds the settings. Overrides BlazyFormatterBaseTrait::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::formatter	public	function	Returns the blazy formatter.
BlazyTestEntityReferenceFormatterTest::getScopedFormElements	public	function	Defines the scope for the form elements. Overrides BlazyEntityReferenceBase::getScopedFormElements
BlazyTestEntityReferenceFormatterTest::manager	public	function	Returns the blazy admin.
BlazyTestEntityReferenceFormatterTest::viewElements	public	function	Builds a renderable array for a field value. Overrides FormatterInterface::viewElements
BlazyTestEntityReferenceFormatterTest::__construct	public	function	Constructs a SlickMediaFormatter instance. Overrides FormatterBase::__construct
BlazyVideoTrait::buildVideo	public	function	Builds relevant video embed field settings based on the given media url.
BlazyVideoTrait::getImageItem	public	function	Gets the faked image item out of file entity, or ER, if applicable.
BlazyVideoTrait::getMediaItem	public	function	Gets the Media item thumbnail, or re-associate the file entity to ME.
BlazyVideoTrait::imageFactory	public	function	Returns the image factory.
BlazyVideoTrait::videoEmbedMediaManager	public static	function	Returns the optional VEF service to avoid dependency for optional plugins.
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
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::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies	6
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::onDependencyRemoval	public	function	Informs the plugin that some configuration it depends on will be deleted. Overrides PluginSettingsInterface::onDependencyRemoval	3
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.

You are here

class BlazyTestEntityReferenceFormatterTest in Blazy 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation