abstract class SelectionDisplayBase in Entity Browser 8

Base implementation for selection display plugins.

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\entity_browser\SelectionDisplayBase implements ContainerFactoryPluginInterface, SelectionDisplayInterface uses PluginConfigurationFormTrait

3 files declare their use of SelectionDisplayBase

MultiStepDisplay.php in src/Plugin/EntityBrowser/SelectionDisplay/MultiStepDisplay.php

NoDisplay.php in src/Plugin/EntityBrowser/SelectionDisplay/NoDisplay.php

View.php in src/Plugin/EntityBrowser/SelectionDisplay/View.php

File

src/SelectionDisplayBase.php, line 19

Namespace

Drupal\entity_browser

abstract class SelectionDisplayBase extends PluginBase implements SelectionDisplayInterface, ContainerFactoryPluginInterface {
  use PluginConfigurationFormTrait;

  /**
   * Plugin label.
   *
   * @var string
   */
  protected $label;

  /**
   * Event dispatcher service.
   *
   * @var \Symfony\Component\EventDispatcher\EventDispatcherInterface
   */
  protected $eventDispatcher;

  /**
   * Entity manager service.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * Constructs widget plugin.
   *
   * @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 \Symfony\Component\EventDispatcher\EventDispatcherInterface $event_dispatcher
   *   Event dispatcher service.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity manager type service.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, EventDispatcherInterface $event_dispatcher, EntityTypeManagerInterface $entity_type_manager) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->eventDispatcher = $event_dispatcher;
    $this->entityTypeManager = $entity_type_manager;
    $this
      ->setConfiguration($configuration);
  }

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

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return [];
  }

  /**
   * {@inheritdoc}
   */
  public function getConfiguration() {
    return array_diff_key($this->configuration, [
      'entity_browser_id' => 0,
    ]);
  }

  /**
   * {@inheritdoc}
   */
  public function setConfiguration(array $configuration) {
    $this->configuration = NestedArray::mergeDeep($this
      ->defaultConfiguration(), $configuration);
  }

  /**
   * {@inheritdoc}
   */
  public function calculateDependencies() {
    return [];
  }

  /**
   * {@inheritdoc}
   */
  public function label() {
    $this->label;
  }

  /**
   * {@inheritdoc}
   */
  public function validate(array &$form, FormStateInterface $form_state) {
  }

  /**
   * {@inheritdoc}
   */
  public function submit(array &$form, FormStateInterface $form_state) {
  }

  /**
   * {@inheritdoc}
   */
  public function checkPreselectionSupport() {
    @trigger_error('checkPreselectionSupport method is deprecated. Use supportsPreselection instead.', E_USER_DEPRECATED);
    if (!$this
      ->getPluginDefinition()['acceptPreselection']) {
      throw new ConfigException('Used entity browser selection display does not support preselection.');
    }
  }

  /**
   * {@inheritdoc}
   */
  public function supportsPreselection() {
    return $this
      ->getPluginDefinition()['acceptPreselection'];
  }

  /**
   * {@inheritdoc}
   */
  public function supportsJsCommands() {
    return $this
      ->getPluginDefinition()['js_commands'];
  }

  /**
   * Marks selection as done - sets value in form state and dispatches event.
   */
  protected function selectionDone(FormStateInterface $form_state) {
    $form_state
      ->set([
      'entity_browser',
      'selection_completed',
    ], TRUE);
    $this->eventDispatcher
      ->dispatch(Events::DONE, new SelectionDoneEvent($this->configuration['entity_browser_id'], $form_state
      ->get([
      'entity_browser',
      'instance_uuid',
    ])));
  }

}

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
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.
PluginConfigurationFormTrait::buildConfigurationForm	public	function	Implements PluginFormInterface::buildConfigurationForm().	5
PluginConfigurationFormTrait::submitConfigurationForm	public	function	Implements PluginFormInterface::submitConfigurationForm().	3
PluginConfigurationFormTrait::validateConfigurationForm	public	function	Implements PluginFormInterface::validateConfigurationForm().	2
SelectionDisplayBase::$entityTypeManager	protected	property	Entity manager service.
SelectionDisplayBase::$eventDispatcher	protected	property	Event dispatcher service.
SelectionDisplayBase::$label	protected	property	Plugin label.
SelectionDisplayBase::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies	1
SelectionDisplayBase::checkPreselectionSupport	public	function	Check does selection display support preselection. Overrides SelectionDisplayInterface::checkPreselectionSupport
SelectionDisplayBase::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create	1
SelectionDisplayBase::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides ConfigurableInterface::defaultConfiguration	2
SelectionDisplayBase::getConfiguration	public	function	Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
SelectionDisplayBase::label	public	function	Returns the selection display label. Overrides SelectionDisplayInterface::label
SelectionDisplayBase::selectionDone	protected	function	Marks selection as done - sets value in form state and dispatches event.
SelectionDisplayBase::setConfiguration	public	function	Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
SelectionDisplayBase::submit	public	function	Submits form. Overrides SelectionDisplayInterface::submit	3
SelectionDisplayBase::supportsJsCommands	public	function	Returns true if selection display supports selection over javascript. Overrides SelectionDisplayInterface::supportsJsCommands
SelectionDisplayBase::supportsPreselection	public	function	Check if the plugin supports preselection. Overrides SelectionDisplayInterface::supportsPreselection
SelectionDisplayBase::validate	public	function	Validates form. Overrides SelectionDisplayInterface::validate
SelectionDisplayBase::__construct	public	function	Constructs widget plugin. Overrides PluginBase::__construct	1
SelectionDisplayInterface::getForm	public	function	Returns selection display form.	3
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.