abstract class DiffGeneratorPluginBase in Entity Share 8.3

Base class for Diff plugins.

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\entity_share_diff\DiffGenerator\DiffGeneratorPluginBase implements ContainerFactoryPluginInterface, DiffGeneratorInterface uses StringTranslationTrait

8 files declare their use of DiffGeneratorPluginBase

CommentFieldDiffParser.php in modules/entity_share_diff/src/Plugin/DiffGenerator/CommentFieldDiffParser.php

CoreFieldDiffParser.php in modules/entity_share_diff/src/Plugin/DiffGenerator/CoreFieldDiffParser.php

EntityReferenceFieldDiffParser.php in modules/entity_share_diff/src/Plugin/DiffGenerator/EntityReferenceFieldDiffParser.php

FileFieldDiffParser.php in modules/entity_share_diff/src/Plugin/DiffGenerator/FileFieldDiffParser.php

LinkFieldDiffParser.php in modules/entity_share_diff/src/Plugin/DiffGenerator/LinkFieldDiffParser.php

... See full list

File

modules/entity_share_diff/src/DiffGenerator/DiffGeneratorPluginBase.php, line 19

Namespace

Drupal\entity_share_diff\DiffGenerator

abstract class DiffGeneratorPluginBase extends PluginBase implements DiffGeneratorInterface, ContainerFactoryPluginInterface {
  use StringTranslationTrait;

  /**
   * The remote manager service.
   *
   * @var \Drupal\entity_share_client\Service\RemoteManagerInterface
   */
  protected $remoteManager;

  /**
   * The entity type manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * The entity parser service.
   *
   * @var \Drupal\entity_share_diff\Service\EntityParserInterface
   */
  protected $entityParser;

  /**
   * The 'Remote' entity.
   *
   * @var \Drupal\entity_share_client\Entity\RemoteInterface
   */
  protected $remote;

  /**
   * Constructs a DiffManagerBase object.
   *
   * @param array $configuration
   *   A configuration array containing information about the plugin instance.
   * @param string $plugin_id
   *   The plugin_id for the plugin instance.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\entity_share_client\Service\RemoteManagerInterface $remoteManager
   *   The remote manager service.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager.
   * @param \Drupal\entity_share_diff\Service\EntityParserInterface $entity_parser
   *   The entity parser service.
   */
  public function __construct(array $configuration, string $plugin_id, $plugin_definition, RemoteManagerInterface $remoteManager, EntityTypeManagerInterface $entity_type_manager, EntityParserInterface $entity_parser) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->remoteManager = $remoteManager;
    $this->entityTypeManager = $entity_type_manager;
    $this->entityParser = $entity_parser;
    $this->remote = NULL;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('entity_share_client.remote_manager'), $container
      ->get('entity_type.manager'), $container
      ->get('entity_share_diff.entity_parser'));
  }

  /**
   * Returns Remote entity.
   */
  public function getRemote() {
    return $this->remote;
  }

  /**
   * Sets Remote entity.
   */
  public function setRemote($remote) {
    $this->remote = $remote;
  }

  /**
   * {@inheritdoc}
   */
  public static function isApplicable(FieldStorageDefinitionInterface $field_definition) {
    return TRUE;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DiffGeneratorInterface::build	public	function	Builds an array of strings.	8
DiffGeneratorPluginBase::$entityParser	protected	property	The entity parser service.
DiffGeneratorPluginBase::$entityTypeManager	protected	property	The entity type manager.
DiffGeneratorPluginBase::$remote	protected	property	The 'Remote' entity.
DiffGeneratorPluginBase::$remoteManager	protected	property	The remote manager service.
DiffGeneratorPluginBase::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
DiffGeneratorPluginBase::getRemote	public	function	Returns Remote entity.
DiffGeneratorPluginBase::isApplicable	public static	function	Returns if the plugin can be used for the provided field. Overrides DiffGeneratorInterface::isApplicable
DiffGeneratorPluginBase::setRemote	public	function	Sets Remote entity.
DiffGeneratorPluginBase::__construct	public	function	Constructs a DiffManagerBase object. Overrides PluginBase::__construct
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.
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.