class SelectionPluginBase

Same name and namespace in other branches
  1. 9 core/lib/Drupal/Core/Entity/EntityReferenceSelection/SelectionPluginBase.php \Drupal\Core\Entity\EntityReferenceSelection\SelectionPluginBase
  2. 8.9.x core/lib/Drupal/Core/Entity/EntityReferenceSelection/SelectionPluginBase.php \Drupal\Core\Entity\EntityReferenceSelection\SelectionPluginBase
  3. 11.x core/lib/Drupal/Core/Entity/EntityReferenceSelection/SelectionPluginBase.php \Drupal\Core\Entity\EntityReferenceSelection\SelectionPluginBase

Provides a base class for configurable selection handlers.

Hierarchy

Expanded class hierarchy of SelectionPluginBase

3 files declare their use of SelectionPluginBase
Broken.php in core/lib/Drupal/Core/Entity/Plugin/EntityReferenceSelection/Broken.php
DefaultSelection.php in core/lib/Drupal/Core/Entity/Plugin/EntityReferenceSelection/DefaultSelection.php
ViewsSelection.php in core/modules/views/src/Plugin/EntityReferenceSelection/ViewsSelection.php

File

core/lib/Drupal/Core/Entity/EntityReferenceSelection/SelectionPluginBase.php, line 15

Namespace

Drupal\Core\Entity\EntityReferenceSelection
View source
abstract class SelectionPluginBase extends PluginBase implements SelectionInterface, ConfigurableInterface, DependentPluginInterface {
  
  /**
   * Constructs a new selection 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.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->setConfiguration($configuration);
  }
  
  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return [
      'target_type' => NULL,
      'entity' => NULL,
    ];
  }
  
  /**
   * {@inheritdoc}
   */
  public function getConfiguration() {
    return $this->configuration;
  }
  
  /**
   * {@inheritdoc}
   */
  public function setConfiguration(array $configuration) {
    // Merge in defaults.
    $this->configuration = NestedArray::mergeDeep($this->defaultConfiguration(), $configuration);
  }
  
  /**
   * {@inheritdoc}
   */
  public function calculateDependencies() {
    return [];
  }
  
  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    return $form;
  }
  
  /**
   * {@inheritdoc}
   */
  public function validateConfigurationForm(array &$form, FormStateInterface $form_state) {
  }
  
  /**
   * {@inheritdoc}
   */
  public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
  }
  
  /**
   * {@inheritdoc}
   */
  public function entityQueryAlter(SelectInterface $query) {
  }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
SelectionInterface::countReferenceableEntities public function Counts entities that are referenceable. 3
SelectionInterface::getReferenceableEntities public function Gets the list of referenceable entities. 3
SelectionInterface::validateReferenceableEntities public function Validates which existing entities can be referenced. 3
SelectionPluginBase::buildConfigurationForm public function Form constructor. Overrides PluginFormInterface::buildConfigurationForm 3
SelectionPluginBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
SelectionPluginBase::defaultConfiguration public function Gets default configuration for this plugin. Overrides ConfigurableInterface::defaultConfiguration 2
SelectionPluginBase::entityQueryAlter public function Allows the selection to alter the SelectQuery generated by EntityFieldQuery. Overrides SelectionInterface::entityQueryAlter 2
SelectionPluginBase::getConfiguration public function Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
SelectionPluginBase::setConfiguration public function Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
SelectionPluginBase::submitConfigurationForm public function Form submission handler. Overrides PluginFormInterface::submitConfigurationForm
SelectionPluginBase::validateConfigurationForm public function Form validation handler. Overrides PluginFormInterface::validateConfigurationForm 1
SelectionPluginBase::__construct public function Constructs a new selection object. 2

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.