class EntityReferenceRevisionsExportFormatter in REST Views 8

Bridge plugin integrating entity_reference_revisions with rest_views.

Plugin annotation

@FieldFormatter(
  id = "entity_reference_revisions_export",
  label = @Translation("Export rendered entity"),
  description = @Translation("Export the entity rendered by entity_view()."),
  field_types = {
    "entity_reference_revisions"
  }
)

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\Core\Field\Plugin\Field\FieldFormatter\EntityReferenceEntityFormatter implements ContainerFactoryPluginInterface
            • class \Drupal\rest_views\Plugin\Field\FieldFormatter\EntityReferenceExportFormatter
              • class \Drupal\rest_views_revisions\Plugin\Field\FieldFormatter\EntityReferenceRevisionsExportFormatter

File

modules/rest_views_revisions/src/Plugin/Field/FieldFormatter/EntityReferenceRevisionsExportFormatter.php, line 25

Namespace

Drupal\rest_views_revisions\Plugin\Field\FieldFormatter

class EntityReferenceRevisionsExportFormatter extends EntityReferenceExportFormatter {

  /**
   * Instance of the adapted class.
   *
   * @var \Drupal\entity_reference_revisions\Plugin\Field\FieldFormatter\EntityReferenceRevisionsEntityFormatter
   */
  protected $entityFormatter;

  /**
   * EntityReferenceRevisionsExportFormatter constructor.
   *
   * @param string $plugin_id
   *   The plugin_id for the formatter.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
   *   The definition of the field to which the formatter is associated.
   * @param array $settings
   *   The formatter settings.
   * @param string $label
   *   The formatter label display setting.
   * @param string $view_mode
   *   The view mode.
   * @param array $third_party_settings
   *   Any third party settings settings.
   * @param \Drupal\Core\Logger\LoggerChannelFactoryInterface $logger_factory
   *   The logger factory.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager.
   * @param \Drupal\Core\Entity\EntityDisplayRepositoryInterface $entity_display_repository
   *   The entity display repository.
   * @param \Drupal\entity_reference_revisions\Plugin\Field\FieldFormatter\EntityReferenceRevisionsEntityFormatter $entityFormatter
   *   The entity_reference_revisions formatter.
   */
  public function __construct($plugin_id, $plugin_definition, FieldDefinitionInterface $field_definition, array $settings, $label, $view_mode, array $third_party_settings, LoggerChannelFactoryInterface $logger_factory, EntityTypeManagerInterface $entity_type_manager, EntityDisplayRepositoryInterface $entity_display_repository, ERFEntityFormatter $entityFormatter) {
    parent::__construct($plugin_id, $plugin_definition, $field_definition, $settings, $label, $view_mode, $third_party_settings, $logger_factory, $entity_type_manager, $entity_display_repository);
    $this->entityFormatter = $entityFormatter;
  }

  /**
   * {@inheritdoc}
   *
   * @throws \Symfony\Component\DependencyInjection\Exception\ServiceCircularReferenceException
   * @throws \Symfony\Component\DependencyInjection\Exception\ServiceNotFoundException
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {

    // Instantiate the entity_reference_revisions formatter.
    $entityFormatter = ERFEntityFormatter::create($container, $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('entity_type.manager'), $container
      ->get('entity_display.repository'), $entityFormatter);
  }

  /**
   * {@inheritdoc}
   */
  public function prepareView(array $entities_items) {

    // Delegate this method to entity_reference_revisions.
    $this->entityFormatter
      ->prepareView($entities_items);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
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
EntityReferenceEntityFormatter::$entityDisplayRepository	protected	property	The entity display repository.
EntityReferenceEntityFormatter::$entityTypeManager	protected	property	The entity type manager.
EntityReferenceEntityFormatter::$loggerFactory	protected	property	The logger factory.
EntityReferenceEntityFormatter::$recursiveRenderDepth	protected static	property	An array of counters for the recursive rendering protection.
EntityReferenceEntityFormatter::isApplicable	public static	function	Returns if the formatter can be used for the provided field. Overrides FormatterBase::isApplicable
EntityReferenceEntityFormatter::RECURSIVE_RENDER_LIMIT		constant	The number of times this formatter allows rendering the same entity.
EntityReferenceEntityFormatter::viewElements	public	function	Builds a renderable array for a field value. Overrides FormatterInterface::viewElements
EntityReferenceExportFormatter::defaultSettings	public static	function	Defines the default settings for this plugin. Overrides EntityReferenceEntityFormatter::defaultSettings
EntityReferenceExportFormatter::settingsForm	public	function	Returns a form to configure settings for the formatter. Overrides EntityReferenceEntityFormatter::settingsForm
EntityReferenceExportFormatter::settingsSummary	public	function	Returns a short summary for the current formatter settings. Overrides EntityReferenceEntityFormatter::settingsSummary
EntityReferenceExportFormatter::view	public	function	Builds a renderable array for a fully themed field. Overrides EntityReferenceFormatterBase::view
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
EntityReferenceRevisionsExportFormatter::$entityFormatter	protected	property	Instance of the adapted class.
EntityReferenceRevisionsExportFormatter::create	public static	function	Overrides EntityReferenceEntityFormatter::create
EntityReferenceRevisionsExportFormatter::prepareView	public	function	Loads the entities referenced in that field across all the entities being viewed. Overrides EntityReferenceFormatterBase::prepareView
EntityReferenceRevisionsExportFormatter::__construct	public	function	EntityReferenceRevisionsExportFormatter constructor. Overrides EntityReferenceEntityFormatter::__construct
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.
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.