You are here

Home » API reference » Zircon Profile 8.0 » EntityReferenceSelectionReferenceableTest.php

class EntityReferenceSelectionReferenceableTest in Zircon Profile 8.0

Same name and namespace in other branches
  1. 8 core/modules/system/tests/src/Kernel/Entity/EntityReferenceSelectionReferenceableTest.php \Drupal\Tests\system\Kernel\Entity\EntityReferenceSelectionReferenceableTest

Tests entity reference selection plugins.

@group entity_reference

Hierarchy

Expanded class hierarchy of EntityReferenceSelectionReferenceableTest

File

core/modules/system/tests/src/Kernel/Entity/EntityReferenceSelectionReferenceableTest.php, line 22
Contains \Drupal\Tests\system\Kernel\Entity\EntityReferenceSelectionReferenceableTest.

Namespace

Drupal\Tests\system\Kernel\Entity
View source 
class EntityReferenceSelectionReferenceableTest extends KernelTestBase {
  use EntityReferenceTestTrait;

  /**
   * Bundle of 'entity_test_no_label' entity.
   *
   * @var string
   */
  protected $bundle;

  /**
   * Labels to be tested.
   *
   * @var array
   */
  protected static $labels = [
    'abc',
    'Xyz_',
    'xyabz_',
    'foo_',
    'bar_',
    'baz_',
    'șz_',
    NULL,
    '<strong>',
  ];

  /**
   * The selection handler.
   *
   * @var \Drupal\Core\Entity\EntityReferenceSelection\SelectionInterface.
   */
  protected $selectionHandler;

  /**
   * {@inheritdoc}
   */
  public static $modules = [
    'system',
    'user',
    'field',
    'entity_reference',
    'node',
    'entity_test',
  ];

  /**
   * {@inheritdoc}
   */
  protected function setUp() {
    parent::setUp();
    $this
      ->installEntitySchema('entity_test_no_label');

    /** @var \Drupal\Core\Entity\EntityStorageInterface $storage */
    $storage = $this->container
      ->get('entity.manager')
      ->getStorage('entity_test_no_label');

    // Create a new node-type.
    NodeType::create([
      'type' => $node_type = Unicode::strtolower($this
        ->randomMachineName()),
      'name' => $this
        ->randomString(),
    ])
      ->save();

    // Create an entity reference field targeting 'entity_test_no_label'
    // entities.
    $field_name = Unicode::strtolower($this
      ->randomMachineName());
    $this
      ->createEntityReferenceField('node', $node_type, $field_name, $this
      ->randomString(), 'entity_test_no_label');
    $field_config = FieldConfig::loadByName('node', $node_type, $field_name);
    $this->selectionHandler = $this->container
      ->get('plugin.manager.entity_reference_selection')
      ->getSelectionHandler($field_config);

    // Generate a bundle name to be used with 'entity_test_no_label'.
    $this->bundle = Unicode::strtolower($this
      ->randomMachineName());

    // Create 6 entities to be referenced by the field.
    foreach (static::$labels as $name) {
      $storage
        ->create([
        'id' => Unicode::strtolower($this
          ->randomMachineName()),
        'name' => $name,
        'type' => $this->bundle,
      ])
        ->save();
    }
  }

  /**
   * Tests values returned by SelectionInterface::getReferenceableEntities()
   * when the target entity type has no 'label' key.
   *
   * @param mixed $match
   *   The input text to be checked.
   * @param string $match_operator
   *   The matching operator.
   * @param int $limit
   *   The limit of returning records.
   * @param int $count_limited
   *   The expected number of limited entities to be retrieved.
   * @param array $items
   *   Array of entity labels expected to be returned.
   * @param int $count_all
   *   The total number (unlimited) of entities to be retrieved.
   *
   * @dataProvider providerTestCases
   */
  public function testReferenceablesWithNoLabelKey($match, $match_operator, $limit, $count_limited, array $items, $count_all) {

    // Test ::getReferenceableEntities().
    $referenceables = $this->selectionHandler
      ->getReferenceableEntities($match, $match_operator, $limit);

    // Number of returned items.
    if (empty($count_limited)) {
      $this
        ->assertTrue(empty($referenceables[$this->bundle]));
    }
    else {
      $this
        ->assertSame(count($referenceables[$this->bundle]), $count_limited);
    }

    // Test returned items.
    foreach ($items as $item) {

      // SelectionInterface::getReferenceableEntities() always return escaped
      // entity labels.
      // @see \Drupal\Core\Entity\EntityReferenceSelection\SelectionInterface::getReferenceableEntities()
      $item = is_string($item) ? Html::escape($item) : $item;
      $this
        ->assertTrue(array_search($item, $referenceables[$this->bundle]) !== FALSE);
    }

    // Test ::countReferenceableEntities().
    $count_referenceables = $this->selectionHandler
      ->countReferenceableEntities($match, $match_operator);
    $this
      ->assertSame($count_referenceables, $count_all);
  }

  /**
   * Provides test cases for ::testReferenceablesWithNoLabelKey() test.
   *
   * @return array[]
   */
  public function providerTestCases() {
    return [
      // All referenceables, no limit. Expecting 9 items.
      [
        NULL,
        'CONTAINS',
        0,
        9,
        static::$labels,
        9,
      ],
      // Referenceables containing 'w', no limit. Expecting no item.
      [
        'w',
        'CONTAINS',
        0,
        0,
        [],
        0,
      ],
      // Referenceables starting with 'w', no limit. Expecting no item.
      [
        'w',
        'STARTS_WITH',
        0,
        0,
        [],
        0,
      ],
      // Referenceables containing 'ab', no limit. Expecting 2 items ('abc',
      // 'xyabz').
      [
        'ab',
        'CONTAINS',
        0,
        2,
        [
          'abc',
          'xyabz_',
        ],
        2,
      ],
      // Referenceables starting with 'A', no limit. Expecting 1 item ('abc').
      [
        'A',
        'STARTS_WITH',
        0,
        1,
        [
          'abc',
        ],
        1,
      ],
      // Referenceables containing '_', limited to 3. Expecting 3 limited items
      // ('Xyz_', 'xyabz_', 'foo_') and 5 total.
      [
        '_',
        'CONTAINS',
        3,
        3,
        [
          'Xyz_',
          'xyabz_',
          'foo_',
        ],
        6,
      ],
      // Referenceables ending with 'z_', limited to 3. Expecting 3 limited
      // items ('Xyz_', 'xyabz_', 'baz_') and 4 total.
      [
        'z_',
        'ENDS_WITH',
        3,
        3,
        [
          'Xyz_',
          'xyabz_',
          'baz_',
        ],
        4,
      ],
      // Referenceables identical with 'xyabz_', no limit. Expecting 1 item
      // ('xyabz_').
      [
        'xyabz_',
        '=',
        0,
        1,
        [
          'xyabz_',
        ],
        1,
      ],
      // Referenceables greater than 'foo', no limit. Expecting 4 items ('Xyz_',
      // 'xyabz_', 'foo_', 'șz_').
      [
        'foo',
        '>',
        0,
        4,
        [
          'Xyz_',
          'xyabz_',
          'foo_',
          'șz_',
        ],
        4,
      ],
      // Referenceables greater or identical with 'baz_', no limit. Expecting 5
      // items ('Xyz_', 'xyabz_', 'foo_', 'baz_', 'șz_').
      [
        'baz_',
        '>=',
        0,
        5,
        [
          'Xyz_',
          'xyabz_',
          'foo_',
          'baz_',
          'șz_',
        ],
        5,
      ],
      // Referenceables less than 'foo', no limit. Expecting 5 items ('abc',
      // 'bar_', 'baz_', NULL, '<strong>').
      [
        'foo',
        '<',
        0,
        5,
        [
          'abc',
          'bar_',
          'baz_',
          NULL,
          '<strong>',
        ],
        5,
      ],
      // Referenceables less or identical with 'baz_', no limit. Expecting 5
      // items ('abc', 'bar_', 'baz_', NULL, '<strong>').
      [
        'baz_',
        '<=',
        0,
        5,
        [
          'abc',
          'bar_',
          'baz_',
          NULL,
          '<strong>',
        ],
        5,
      ],
      // Referenceables not identical with 'baz_', no limit. Expecting 7 items
      // ('abc', 'Xyz_', 'xyabz_', 'foo_', 'bar_', 'șz_', NULL, '<strong>').
      [
        'baz_',
        '<>',
        0,
        8,
        [
          'abc',
          'Xyz_',
          'xyabz_',
          'foo_',
          'bar_',
          'șz_',
          NULL,
          '<strong>',
        ],
        8,
      ],
      // Referenceables in ('bar_', 'baz_'), no limit. Expecting 2 items
      // ('bar_', 'baz_')
      [
        [
          'bar_',
          'baz_',
        ],
        'IN',
        0,
        2,
        [
          'bar_',
          'baz_',
        ],
        2,
      ],
      // Referenceables not in ('bar_', 'baz_'), no limit. Expecting 6 items
      // ('abc', 'Xyz_', 'xyabz_', 'foo_', 'șz_', NULL, '<strong>')
      [
        [
          'bar_',
          'baz_',
        ],
        'NOT IN',
        0,
        7,
        [
          'abc',
          'Xyz_',
          'xyabz_',
          'foo_',
          'șz_',
          NULL,
          '<strong>',
        ],
        7,
      ],
      // Referenceables not null, no limit. Expecting 9 items ('abc', 'Xyz_',
      // 'xyabz_', 'foo_', 'bar_', 'baz_', 'șz_', NULL, '<strong>').
      //
      // Note: Even we set the name as NULL, when retrieving the label from the
      //   entity we'll get an empty string, meaning that this match operator
      //   will return TRUE every time.
      [
        NULL,
        'IS NOT NULL',
        0,
        9,
        static::$labels,
        9,
      ],
      // Referenceables null, no limit. Expecting 9 items ('abc', 'Xyz_',
      // 'xyabz_', 'foo_', 'bar_', 'baz_', 'șz_', NULL, '<strong>').
      //
      // Note: Even we set the name as NULL, when retrieving the label from the
      //   entity we'll get an empty string, meaning that this match operator
      //   will return FALSE every time.
      [
        NULL,
        'IS NULL',
        0,
        9,
        static::$labels,
        9,
      ],
      // Referenceables containing '<strong>' markup, no limit. Expecting 1 item
      // ('<strong>').
      [
        '<strong>',
        'CONTAINS',
        0,
        1,
        [
          '<strong>',
        ],
        1,
      ],
      // Test an unsupported operator. We expect no items.
      [
        'abc',
        '*unsupported*',
        0,
        0,
        [],
        0,
      ],
    ];
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AssertContentTrait::$content protected property The current raw content.
AssertContentTrait::$drupalSettings protected property The drupalSettings value from the current raw $content.
AssertContentTrait::$elements protected property The XML structure parsed from the current raw $content. 2
AssertContentTrait::$plainTextContent protected property The plain-text content of raw $content (text nodes).
AssertContentTrait::assertEscaped protected function Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertField protected function Asserts that a field exists with the given name or ID.
AssertContentTrait::assertFieldById protected function Asserts that a field exists with the given ID and value.
AssertContentTrait::assertFieldByName protected function Asserts that a field exists with the given name and value.
AssertContentTrait::assertFieldByXPath protected function Asserts that a field exists in the current page by the given XPath.
AssertContentTrait::assertFieldChecked protected function Asserts that a checkbox field in the current page is checked.
AssertContentTrait::assertFieldsByValue protected function Asserts that a field exists in the current page with a given Xpath result.
AssertContentTrait::assertLink protected function Passes if a link with the specified label is found.
AssertContentTrait::assertLinkByHref protected function Passes if a link containing a given href (part) is found.
AssertContentTrait::assertNoDuplicateIds protected function Asserts that each HTML ID is used for just a single element.
AssertContentTrait::assertNoEscaped protected function Passes if the raw text IS NOT found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertNoField protected function Asserts that a field does not exist with the given name or ID.
AssertContentTrait::assertNoFieldById protected function Asserts that a field does not exist with the given ID and value.
AssertContentTrait::assertNoFieldByName protected function Asserts that a field does not exist with the given name and value.
AssertContentTrait::assertNoFieldByXPath protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertContentTrait::assertNoFieldChecked protected function Asserts that a checkbox field in the current page is not checked.
AssertContentTrait::assertNoLink protected function Passes if a link with the specified label is not found.
AssertContentTrait::assertNoLinkByHref protected function Passes if a link containing a given href (part) is not found.
AssertContentTrait::assertNoLinkByHrefInMainRegion protected function Passes if a link containing a given href is not found in the main region.
AssertContentTrait::assertNoOption protected function Asserts that a select option in the current page does not exist.
AssertContentTrait::assertNoOptionSelected protected function Asserts that a select option in the current page is not checked.
AssertContentTrait::assertNoPattern protected function Triggers a pass if the perl regex pattern is not found in raw content.
AssertContentTrait::assertNoRaw protected function Passes if the raw text is NOT found on the loaded page, fail otherwise.
AssertContentTrait::assertNoText protected function Passes if the page (with HTML stripped) does not contains the text.
AssertContentTrait::assertNoTitle protected function Pass if the page title is not the given string.
AssertContentTrait::assertNoUniqueText protected function Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertContentTrait::assertOption protected function Asserts that a select option in the current page exists.
AssertContentTrait::assertOptionSelected protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionSelectedWithDrupalSelector protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionWithDrupalSelector protected function Asserts that a select option in the current page exists.
AssertContentTrait::assertPattern protected function Triggers a pass if the Perl regex pattern is found in the raw content.
AssertContentTrait::assertRaw protected function Passes if the raw text IS found on the loaded page, fail otherwise.
AssertContentTrait::assertText protected function Passes if the page (with HTML stripped) contains the text.
AssertContentTrait::assertTextHelper protected function Helper for assertText and assertNoText.
AssertContentTrait::assertTextPattern protected function Asserts that a Perl regex pattern is found in the plain-text content.
AssertContentTrait::assertThemeOutput protected function Asserts themed output.
AssertContentTrait::assertTitle protected function Pass if the page title is the given string.
AssertContentTrait::assertUniqueText protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertContentTrait::assertUniqueTextHelper protected function Helper for assertUniqueText and assertNoUniqueText.
AssertContentTrait::buildXPathQuery protected function Builds an XPath query.
AssertContentTrait::constructFieldXpath protected function Helper: Constructs an XPath for the given set of attributes and value.
AssertContentTrait::cssSelect protected function Searches elements using a CSS selector in the raw content.
AssertContentTrait::getAllOptions protected function Get all option elements, including nested options, in a select.
AssertContentTrait::getDrupalSettings protected function Gets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::getRawContent protected function Gets the current raw content.
AssertContentTrait::getSelectedItem protected function Get the selected value from a select field.
AssertContentTrait::getTextContent protected function Retrieves the plain-text content from the current raw content.
AssertContentTrait::getUrl protected function Get the current URL from the cURL handler. 1
AssertContentTrait::parse protected function Parse content returned from curlExec using DOM and SimpleXML.
AssertContentTrait::removeWhiteSpace protected function Removes all white-space between HTML tags from the raw content.
AssertContentTrait::setDrupalSettings protected function Sets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::setRawContent protected function Sets the raw content (e.g. HTML).
AssertContentTrait::xpath protected function Performs an xpath search on the contents of the internal browser.
AssertHelperTrait::castSafeStrings protected function Casts MarkupInterface objects into strings.
AssertLegacyTrait::assert Deprecated protected function
AssertLegacyTrait::assertEqual Deprecated protected function
AssertLegacyTrait::assertFalse public static function
AssertLegacyTrait::assertIdentical Deprecated protected function
AssertLegacyTrait::assertIdenticalObject Deprecated protected function
AssertLegacyTrait::assertNotEqual Deprecated protected function
AssertLegacyTrait::assertNotIdentical Deprecated protected function
AssertLegacyTrait::assertTrue public static function
AssertLegacyTrait::pass Deprecated protected function
AssertLegacyTrait::verbose protected function
EntityReferenceSelectionReferenceableTest::$bundle protected property Bundle of 'entity_test_no_label' entity.
EntityReferenceSelectionReferenceableTest::$labels protected static property Labels to be tested.
EntityReferenceSelectionReferenceableTest::$modules public static property Modules to enable. Overrides KernelTestBase::$modules
EntityReferenceSelectionReferenceableTest::$selectionHandler protected property The selection handler.
EntityReferenceSelectionReferenceableTest::providerTestCases public function Provides test cases for ::testReferenceablesWithNoLabelKey() test.
EntityReferenceSelectionReferenceableTest::setUp protected function Overrides KernelTestBase::setUp
EntityReferenceSelectionReferenceableTest::testReferenceablesWithNoLabelKey public function Tests values returned by SelectionInterface::getReferenceableEntities() when the target entity type has no 'label' key.
EntityReferenceTestTrait::createEntityReferenceField protected function Creates a field of an entity reference field storage on the specified bundle.
KernelTestBase::$backupGlobals protected property Back up and restore any global variables that may be changed by tests.
KernelTestBase::$backupStaticAttributes protected property Back up and restore static class properties that may be changed by tests.
KernelTestBase::$backupStaticAttributesBlacklist protected property Contains a few static class properties for performance.
KernelTestBase::$classLoader protected property
KernelTestBase::$configImporter protected property @todo Move into Config test base class.
KernelTestBase::$container protected property
KernelTestBase::$databasePrefix protected property
KernelTestBase::$expectedLogMessage protected property
KernelTestBase::$expectedLogSeverity protected property
KernelTestBase::$initialContainerBuilder private static property
KernelTestBase::$preserveGlobalState protected property Do not forward any global state from the parent process to the processes that run the actual tests.
KernelTestBase::$root protected property The app root.
KernelTestBase::$runTestInSeparateProcess protected property Kernel tests are run in separate processes to prevent collisions between code that may be loaded by tests.
KernelTestBase::$siteDirectory protected property
KernelTestBase::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved.
KernelTestBase::$vfsRoot protected property The virtual filesystem root directory.
KernelTestBase::assertPostConditions protected function
KernelTestBase::bootEnvironment protected function Bootstraps a basic test environment.
KernelTestBase::bootKernel private function Bootstraps a kernel for a test.
KernelTestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
KernelTestBase::configImporter protected function Returns a ConfigImporter object to import test configuration.
KernelTestBase::copyConfig protected function Copies configuration objects from a source storage to a target storage.
KernelTestBase::disableModules protected function Disables modules for this test.
KernelTestBase::enableModules protected function Enables modules for this test.
KernelTestBase::getCompiledContainerBuilder private function Prepares a precompiled ContainerBuilder for all tests of this class.
KernelTestBase::getDatabaseConnectionInfo protected function Returns the Database connection info to be used for this test.
KernelTestBase::getDrupalRoot protected static function Returns the drupal root directory.
KernelTestBase::getExtensionsForModules private function Returns Extension objects for $modules to enable.
KernelTestBase::getModulesToEnable private static function Returns the modules to enable for this test.
KernelTestBase::initFileCache protected function Initializes the FileCache component.
KernelTestBase::installConfig protected function Installs default configuration for a given list of modules.
KernelTestBase::installEntitySchema protected function Installs the storage schema for a specific entity type.
KernelTestBase::installSchema protected function Installs database tables from a module schema definition.
KernelTestBase::isTestInIsolation protected function Returns whether the current test runs in isolation.
KernelTestBase::prepareTemplate protected function
KernelTestBase::register public function Registers test-specific services. Overrides ServiceProviderInterface::register 2
KernelTestBase::render protected function Renders a render array.
KernelTestBase::setSetting protected function Sets an in-memory Settings variable.
KernelTestBase::setUpBeforeClass public static function
KernelTestBase::stop protected function Stops test execution.
KernelTestBase::tearDown protected function 6
KernelTestBase::tearDownAfterClass public static function
KernelTestBase::tearDownCloseDatabaseConnection public function @after
KernelTestBase::vfsDump protected function Dumps the current state of the virtual filesystem to STDOUT.
KernelTestBase::__get Deprecated public function BC: Automatically resolve former KernelTestBase class properties.
RandomGeneratorTrait::$randomGenerator protected property The random generator.
RandomGeneratorTrait::getRandomGenerator protected function Gets the random generator for the utility methods.
RandomGeneratorTrait::randomMachineName protected function Generates a unique random string containing letters and numbers.
RandomGeneratorTrait::randomObject public function Generates a random PHP object.
RandomGeneratorTrait::randomString public function Generates a pseudo-random string of ASCII characters of codes 32 to 126.
RandomGeneratorTrait::randomStringValidate public function Callback for random string validation.