class TestSelection in Drupal 9

Test EntityReferenceSelection with conditions on the 'reusable' field.

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\Core\Entity\EntityReferenceSelection\SelectionPluginBase implements ConfigurableInterface, DependentPluginInterface, SelectionInterface
      • class \Drupal\Core\Entity\Plugin\EntityReferenceSelection\DefaultSelection implements SelectionWithAutocreateInterface, ContainerFactoryPluginInterface
        • class \Drupal\block_content_test\Plugin\EntityReferenceSelection\TestSelection

1 file declares its use of TestSelection

BlockContentEntityReferenceSelectionTest.php in core/modules/block_content/tests/src/Kernel/BlockContentEntityReferenceSelectionTest.php

File

core/modules/block_content/tests/modules/block_content_test/src/Plugin/EntityReferenceSelection/TestSelection.php, line 10

Namespace

Drupal\block_content_test\Plugin\EntityReferenceSelection

class TestSelection extends DefaultSelection {

  /**
   * The condition type.
   *
   * @var string
   */
  protected $conditionType;

  /**
   * Whether to set the condition for reusable or non-reusable blocks.
   *
   * @var bool
   */
  protected $isReusable;

  /**
   * Sets the test mode.
   *
   * @param string $condition_type
   *   The condition type.
   * @param bool $is_reusable
   *   Whether to set the condition for reusable or non-reusable blocks.
   */
  public function setTestMode($condition_type = NULL, $is_reusable = NULL) {
    $this->conditionType = $condition_type;
    $this->isReusable = $is_reusable;
  }

  /**
   * {@inheritdoc}
   */
  protected function buildEntityQuery($match = NULL, $match_operator = 'CONTAINS') {
    $query = parent::buildEntityQuery($match, $match_operator);
    if ($this->conditionType) {

      /** @var \Drupal\Core\Database\Query\ConditionInterface $add_condition */
      $add_condition = NULL;
      switch ($this->conditionType) {
        case 'base':
          $add_condition = $query;
          break;
        case 'group':
          $group = $query
            ->andConditionGroup()
            ->exists('type');
          $add_condition = $group;
          $query
            ->condition($group);
          break;
        case "nested_group":
          $query
            ->exists('type');
          $sub_group = $query
            ->andConditionGroup()
            ->exists('type');
          $add_condition = $sub_group;
          $group = $query
            ->andConditionGroup()
            ->exists('type')
            ->condition($sub_group);
          $query
            ->condition($group);
          break;
      }
      if ($this->isReusable) {
        $add_condition
          ->condition('reusable', 1);
      }
      else {
        $add_condition
          ->condition('reusable', 0);
      }
    }
    return $query;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DefaultSelection::$currentUser	protected	property	The current user.
DefaultSelection::$entityFieldManager	protected	property	The entity field manager service.
DefaultSelection::$entityRepository	protected	property	The entity repository.
DefaultSelection::$entityTypeBundleInfo	public	property	Entity type bundle info service.
DefaultSelection::$entityTypeManager	protected	property	The entity type manager service.
DefaultSelection::$moduleHandler	protected	property	The module handler service.
DefaultSelection::buildConfigurationForm	public	function	Form constructor. Overrides SelectionPluginBase::buildConfigurationForm	3
DefaultSelection::countReferenceableEntities	public	function	Counts entities that are referenceable. Overrides SelectionInterface::countReferenceableEntities	2
DefaultSelection::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create	2
DefaultSelection::createNewEntity	public	function	Creates a new entity object that can be used as a valid reference. Overrides SelectionWithAutocreateInterface::createNewEntity	6
DefaultSelection::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides SelectionPluginBase::defaultConfiguration	3
DefaultSelection::elementValidateFilter	public static	function	Form element validation handler; Filters the #value property of an element.
DefaultSelection::getReferenceableEntities	public	function	Gets the list of referenceable entities. Overrides SelectionInterface::getReferenceableEntities	3
DefaultSelection::reAlterQuery	protected	function	Helper method: Passes a query to the alteration system again.
DefaultSelection::validateConfigurationForm	public	function	Form validation handler. Overrides SelectionPluginBase::validateConfigurationForm
DefaultSelection::validateReferenceableEntities	public	function	Validates which existing entities can be referenced. Overrides SelectionInterface::validateReferenceableEntities
DefaultSelection::validateReferenceableNewEntities	public	function	Validates which newly created entities can be referenced. Overrides SelectionWithAutocreateInterface::validateReferenceableNewEntities	6
DefaultSelection::__construct	public	function	Constructs a new DefaultSelection object. Overrides SelectionPluginBase::__construct	1
DependencySerializationTrait::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function		2
DependencySerializationTrait::__wakeup	public	function		2
MessengerTrait::$messenger	protected	property	The messenger.	27
MessengerTrait::messenger	public	function	Gets the messenger.	27
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	2
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.
SelectionPluginBase::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
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
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	4
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.
TestSelection::$conditionType	protected	property	The condition type.
TestSelection::$isReusable	protected	property	Whether to set the condition for reusable or non-reusable blocks.
TestSelection::buildEntityQuery	protected	function	Builds an EntityQuery to get referenceable entities. Overrides DefaultSelection::buildEntityQuery
TestSelection::setTestMode	public	function	Sets the test mode.