You are here

Home » API reference » Zircon Profile 8 » EntityQueryTest.php

class EntityQueryTest in Zircon Profile 8

Same name and namespace in other branches
  1. 8.0 core/modules/system/src/Tests/Entity/EntityQueryTest.php \Drupal\system\Tests\Entity\EntityQueryTest

Tests Entity Query functionality.

@group Entity

Hierarchy

Expanded class hierarchy of EntityQueryTest

File

core/modules/system/src/Tests/Entity/EntityQueryTest.php, line 24
Contains \Drupal\system\Tests\Entity\EntityQueryTest.

Namespace

Drupal\system\Tests\Entity
View source 
class EntityQueryTest extends EntityUnitTestBase {

  /**
   * Modules to enable.
   *
   * @var array
   */
  public static $modules = array(
    'field_test',
    'language',
  );

  /**
   * @var array
   */
  protected $queryResults;

  /**
   * @var \Drupal\Core\Entity\Query\QueryFactory
   */
  protected $factory;

  /**
   * A list of bundle machine names created for this test.
   *
   * @var string[]
   */
  protected $bundles;

  /**
   * Field name for the greetings field.
   *
   * @var string
   */
  public $greetings;

  /**
   * Field name for the figures field.
   *
   * @var string
   */
  public $figures;
  protected function setUp() {
    parent::setUp();
    $this
      ->installEntitySchema('entity_test_mulrev');
    $this
      ->installConfig(array(
      'language',
    ));
    $figures = Unicode::strtolower($this
      ->randomMachineName());
    $greetings = Unicode::strtolower($this
      ->randomMachineName());
    foreach (array(
      $figures => 'shape',
      $greetings => 'text',
    ) as $field_name => $field_type) {
      $field_storage = entity_create('field_storage_config', array(
        'field_name' => $field_name,
        'entity_type' => 'entity_test_mulrev',
        'type' => $field_type,
        'cardinality' => 2,
      ));
      $field_storage
        ->save();
      $field_storages[] = $field_storage;
    }
    $bundles = array();
    for ($i = 0; $i < 2; $i++) {

      // For the sake of tablesort, make sure the second bundle is higher than
      // the first one. Beware: MySQL is not case sensitive.
      do {
        $bundle = $this
          ->randomMachineName();
      } while ($bundles && strtolower($bundles[0]) >= strtolower($bundle));
      entity_test_create_bundle($bundle);
      foreach ($field_storages as $field_storage) {
        entity_create('field_config', array(
          'field_storage' => $field_storage,
          'bundle' => $bundle,
        ))
          ->save();
      }
      $bundles[] = $bundle;
    }

    // Each unit is a list of field name, langcode and a column-value array.
    $units[] = array(
      $figures,
      'en',
      array(
        'color' => 'red',
        'shape' => 'triangle',
      ),
    );
    $units[] = array(
      $figures,
      'en',
      array(
        'color' => 'blue',
        'shape' => 'circle',
      ),
    );

    // To make it easier to test sorting, the greetings get formats according
    // to their langcode.
    $units[] = array(
      $greetings,
      'tr',
      array(
        'value' => 'merhaba',
        'format' => 'format-tr',
      ),
    );
    $units[] = array(
      $greetings,
      'pl',
      array(
        'value' => 'siema',
        'format' => 'format-pl',
      ),
    );

    // Make these languages available to the greetings field.
    ConfigurableLanguage::createFromLangcode('tr')
      ->save();
    ConfigurableLanguage::createFromLangcode('pl')
      ->save();

    // Calculate the cartesian product of the unit array by looking at the
    // bits of $i and add the unit at the bits that are 1. For example,
    // decimal 13 is binary 1101 so unit 3,2 and 0 will be added to the
    // entity.
    for ($i = 1; $i <= 15; $i++) {
      $entity = entity_create('entity_test_mulrev', array(
        'type' => $bundles[$i & 1],
        'name' => $this
          ->randomMachineName(),
        'langcode' => 'en',
      ));

      // Make sure the name is set for every language that we might create.
      foreach (array(
        'tr',
        'pl',
      ) as $langcode) {
        $entity
          ->addTranslation($langcode)->name = $this
          ->randomMachineName();
      }
      foreach (array_reverse(str_split(decbin($i))) as $key => $bit) {
        if ($bit) {
          list($field_name, $langcode, $values) = $units[$key];
          $entity
            ->getTranslation($langcode)->{$field_name}[] = $values;
        }
      }
      $entity
        ->save();
    }
    $this->bundles = $bundles;
    $this->figures = $figures;
    $this->greetings = $greetings;
    $this->factory = \Drupal::service('entity.query');
  }

  /**
   * Test basic functionality.
   */
  function testEntityQuery() {
    $greetings = $this->greetings;
    $figures = $this->figures;
    $this->queryResults = $this->factory
      ->get('entity_test_mulrev')
      ->exists($greetings, 'tr')
      ->condition("{$figures}.color", 'red')
      ->sort('id')
      ->execute();

    // As unit 0 was the red triangle and unit 2 was the turkish greeting,
    // bit 0 and bit 2 needs to be set.
    $this
      ->assertResult(5, 7, 13, 15);
    $query = $this->factory
      ->get('entity_test_mulrev', 'OR')
      ->exists($greetings, 'tr')
      ->condition("{$figures}.color", 'red')
      ->sort('id');
    $count_query = clone $query;
    $this
      ->assertEqual(12, $count_query
      ->count()
      ->execute());
    $this->queryResults = $query
      ->execute();

    // Now bit 0 (1, 3, 5, 7, 9, 11, 13, 15) or bit 2 (4, 5, 6, 7, 12, 13, 14,
    // 15) needs to be set.
    $this
      ->assertResult(1, 3, 4, 5, 6, 7, 9, 11, 12, 13, 14, 15);

    // Test cloning of query conditions.
    $query = $this->factory
      ->get('entity_test_mulrev')
      ->condition("{$figures}.color", 'red')
      ->sort('id');
    $cloned_query = clone $query;
    $cloned_query
      ->condition("{$figures}.shape", 'circle');

    // Bit 0 (1, 3, 5, 7, 9, 11, 13, 15) needs to be set.
    $this->queryResults = $query
      ->execute();
    $this
      ->assertResult(1, 3, 5, 7, 9, 11, 13, 15);

    // No red color has a circle shape.
    $this->queryResults = $cloned_query
      ->execute();
    $this
      ->assertResult();
    $query = $this->factory
      ->get('entity_test_mulrev');
    $group = $query
      ->orConditionGroup()
      ->exists($greetings, 'tr')
      ->condition("{$figures}.color", 'red');
    $this->queryResults = $query
      ->condition($group)
      ->condition("{$greetings}.value", 'sie', 'STARTS_WITH')
      ->sort('revision_id')
      ->execute();

    // Bit 3 and (bit 0 or 2) -- the above 8 part of the above.
    $this
      ->assertResult(9, 11, 12, 13, 14, 15);

    // No figure has both the colors blue and red at the same time.
    $this->queryResults = $this->factory
      ->get('entity_test_mulrev')
      ->condition("{$figures}.color", 'blue')
      ->condition("{$figures}.color", 'red')
      ->sort('id')
      ->execute();
    $this
      ->assertResult();

    // But an entity might have a red and a blue figure both.
    $query = $this->factory
      ->get('entity_test_mulrev');
    $group_blue = $query
      ->andConditionGroup()
      ->condition("{$figures}.color", 'blue');
    $group_red = $query
      ->andConditionGroup()
      ->condition("{$figures}.color", 'red');
    $this->queryResults = $query
      ->condition($group_blue)
      ->condition($group_red)
      ->sort('revision_id')
      ->execute();

    // Unit 0 and unit 1, so bits 0 1.
    $this
      ->assertResult(3, 7, 11, 15);

    // Do the same test but with IN operator.
    $query = $this->factory
      ->get('entity_test_mulrev');
    $group_blue = $query
      ->andConditionGroup()
      ->condition("{$figures}.color", array(
      'blue',
    ), 'IN');
    $group_red = $query
      ->andConditionGroup()
      ->condition("{$figures}.color", array(
      'red',
    ), 'IN');
    $this->queryResults = $query
      ->condition($group_blue)
      ->condition($group_red)
      ->sort('id')
      ->execute();

    // Unit 0 and unit 1, so bits 0 1.
    $this
      ->assertResult(3, 7, 11, 15);

    // An entity might have either red or blue figure.
    $this->queryResults = $this->factory
      ->get('entity_test_mulrev')
      ->condition("{$figures}.color", array(
      'blue',
      'red',
    ), 'IN')
      ->sort('id')
      ->execute();

    // Bit 0 or 1 is on.
    $this
      ->assertResult(1, 2, 3, 5, 6, 7, 9, 10, 11, 13, 14, 15);
    $this->queryResults = $this->factory
      ->get('entity_test_mulrev')
      ->exists("{$figures}.color")
      ->notExists("{$greetings}.value")
      ->sort('id')
      ->execute();

    // Bit 0 or 1 is on but 2 and 3 are not.
    $this
      ->assertResult(1, 2, 3);

    // Now update the 'merhaba' string to xsiemax which is not a meaningful
    // word but allows us to test revisions and string operations.
    $ids = $this->factory
      ->get('entity_test_mulrev')
      ->condition("{$greetings}.value", 'merhaba')
      ->sort('id')
      ->execute();
    $entities = entity_load_multiple('entity_test_mulrev', $ids);
    $first_entity = reset($entities);
    $old_name = $first_entity->name->value;
    foreach ($entities as $entity) {
      $entity
        ->setNewRevision();
      $entity
        ->getTranslation('tr')->{$greetings}->value = 'xsiemax';
      $entity->name->value .= 'x';
      $entity
        ->save();
    }

    // We changed the entity names, so the current revision should not match.
    $this->queryResults = $this->factory
      ->get('entity_test_mulrev')
      ->condition('name.value', $old_name)
      ->execute();
    $this
      ->assertResult();

    // Only if all revisions are queried, we find the old revision.
    $this->queryResults = $this->factory
      ->get('entity_test_mulrev')
      ->condition('name.value', $old_name)
      ->allRevisions()
      ->sort('revision_id')
      ->execute();
    $this
      ->assertRevisionResult(array(
      $first_entity
        ->id(),
    ), array(
      $first_entity
        ->id(),
    ));

    // When querying current revisions, this string is no longer found.
    $this->queryResults = $this->factory
      ->get('entity_test_mulrev')
      ->condition("{$greetings}.value", 'merhaba')
      ->execute();
    $this
      ->assertResult();
    $this->queryResults = $this->factory
      ->get('entity_test_mulrev')
      ->condition("{$greetings}.value", 'merhaba')
      ->allRevisions()
      ->sort('revision_id')
      ->execute();

    // The query only matches the original revisions.
    $this
      ->assertRevisionResult(array(
      4,
      5,
      6,
      7,
      12,
      13,
      14,
      15,
    ), array(
      4,
      5,
      6,
      7,
      12,
      13,
      14,
      15,
    ));
    $results = $this->factory
      ->get('entity_test_mulrev')
      ->condition("{$greetings}.value", 'siema', 'CONTAINS')
      ->sort('id')
      ->execute();

    // This matches both the original and new current revisions, multiple
    // revisions are returned for some entities.
    $assert = array(
      16 => '4',
      17 => '5',
      18 => '6',
      19 => '7',
      8 => '8',
      9 => '9',
      10 => '10',
      11 => '11',
      20 => '12',
      21 => '13',
      22 => '14',
      23 => '15',
    );
    $this
      ->assertIdentical($results, $assert);
    $results = $this->factory
      ->get('entity_test_mulrev')
      ->condition("{$greetings}.value", 'siema', 'STARTS_WITH')
      ->sort('revision_id')
      ->execute();

    // Now we only get the ones that originally were siema, entity id 8 and
    // above.
    $this
      ->assertIdentical($results, array_slice($assert, 4, 8, TRUE));
    $results = $this->factory
      ->get('entity_test_mulrev')
      ->condition("{$greetings}.value", 'a', 'ENDS_WITH')
      ->sort('revision_id')
      ->execute();

    // It is very important that we do not get the ones which only have
    // xsiemax despite originally they were merhaba, ie. ended with a.
    $this
      ->assertIdentical($results, array_slice($assert, 4, 8, TRUE));
    $results = $this->factory
      ->get('entity_test_mulrev')
      ->condition("{$greetings}.value", 'a', 'ENDS_WITH')
      ->allRevisions()
      ->sort('id')
      ->sort('revision_id')
      ->execute();

    // Now we get everything.
    $assert = array(
      4 => '4',
      5 => '5',
      6 => '6',
      7 => '7',
      8 => '8',
      9 => '9',
      10 => '10',
      11 => '11',
      12 => '12',
      20 => '12',
      13 => '13',
      21 => '13',
      14 => '14',
      22 => '14',
      15 => '15',
      23 => '15',
    );
    $this
      ->assertIdentical($results, $assert);
  }

  /**
   * Test sort().
   *
   * Warning: this is complicated.
   */
  function testSort() {
    $greetings = $this->greetings;
    $figures = $this->figures;

    // Order up and down on a number.
    $this->queryResults = $this->factory
      ->get('entity_test_mulrev')
      ->sort('id')
      ->execute();
    $this
      ->assertResult(range(1, 15));
    $this->queryResults = $this->factory
      ->get('entity_test_mulrev')
      ->sort('id', 'DESC')
      ->execute();
    $this
      ->assertResult(range(15, 1));
    $query = $this->factory
      ->get('entity_test_mulrev')
      ->sort("{$figures}.color")
      ->sort("{$greetings}.format")
      ->sort('id');

    // As we do not have any conditions, here are the possible colors and
    // language codes, already in order, with the first occurrence of the
    // entity id marked with *:
    // 8  NULL pl *
    // 12 NULL pl *
    // 4  NULL tr *
    // 12 NULL tr
    // 2  blue NULL *
    // 3  blue NULL *
    // 10 blue pl *
    // 11 blue pl *
    // 14 blue pl *
    // 15 blue pl *
    // 6  blue tr *
    // 7  blue tr *
    // 14 blue tr
    // 15 blue tr
    // 1  red  NULL
    // 3  red  NULL
    // 9  red  pl *
    // 11 red  pl
    // 13 red  pl *
    // 15 red  pl
    // 5  red  tr *
    // 7  red  tr
    // 13 red  tr
    // 15 red  tr
    $count_query = clone $query;
    $this
      ->assertEqual(15, $count_query
      ->count()
      ->execute());
    $this->queryResults = $query
      ->execute();
    $this
      ->assertResult(8, 12, 4, 2, 3, 10, 11, 14, 15, 6, 7, 1, 9, 13, 5);

    // Test the pager by setting element #1 to page 2 with a page size of 4.
    // Results will be #8-12 from above.
    $request = Request::createFromGlobals();
    $request->query
      ->replace(array(
      'page' => '0,2',
    ));
    \Drupal::getContainer()
      ->get('request_stack')
      ->push($request);
    $this->queryResults = $this->factory
      ->get('entity_test_mulrev')
      ->sort("{$figures}.color")
      ->sort("{$greetings}.format")
      ->sort('id')
      ->pager(4, 1)
      ->execute();
    $this
      ->assertResult(15, 6, 7, 1);

    // Now test the reversed order.
    $query = $this->factory
      ->get('entity_test_mulrev')
      ->sort("{$figures}.color", 'DESC')
      ->sort("{$greetings}.format", 'DESC')
      ->sort('id', 'DESC');
    $count_query = clone $query;
    $this
      ->assertEqual(15, $count_query
      ->count()
      ->execute());
    $this->queryResults = $query
      ->execute();
    $this
      ->assertResult(15, 13, 7, 5, 11, 9, 3, 1, 14, 6, 10, 2, 12, 4, 8);
  }

  /**
   * Test tablesort().
   */
  public function testTableSort() {

    // While ordering on bundles do not give us a definite order, we can still
    // assert that all entities from one bundle are after the other as the
    // order dictates.
    $request = Request::createFromGlobals();
    $request->query
      ->replace(array(
      'sort' => 'asc',
      'order' => 'Type',
    ));
    \Drupal::getContainer()
      ->get('request_stack')
      ->push($request);
    $header = array(
      'id' => array(
        'data' => 'Id',
        'specifier' => 'id',
      ),
      'type' => array(
        'data' => 'Type',
        'specifier' => 'type',
      ),
    );
    $this->queryResults = array_values($this->factory
      ->get('entity_test_mulrev')
      ->tableSort($header)
      ->execute());
    $this
      ->assertBundleOrder('asc');
    $request->query
      ->add(array(
      'sort' => 'desc',
    ));
    \Drupal::getContainer()
      ->get('request_stack')
      ->push($request);
    $header = array(
      'id' => array(
        'data' => 'Id',
        'specifier' => 'id',
      ),
      'type' => array(
        'data' => 'Type',
        'specifier' => 'type',
      ),
    );
    $this->queryResults = array_values($this->factory
      ->get('entity_test_mulrev')
      ->tableSort($header)
      ->execute());
    $this
      ->assertBundleOrder('desc');

    // Ordering on ID is definite, however.
    $request->query
      ->add(array(
      'order' => 'Id',
    ));
    \Drupal::getContainer()
      ->get('request_stack')
      ->push($request);
    $this->queryResults = $this->factory
      ->get('entity_test_mulrev')
      ->tableSort($header)
      ->execute();
    $this
      ->assertResult(range(15, 1));
  }

  /**
   * Test that count queries are separated across entity types.
   */
  public function testCount() {

    // Create a field with the same name in a different entity type.
    $field_name = $this->figures;
    $field_storage = entity_create('field_storage_config', array(
      'field_name' => $field_name,
      'entity_type' => 'entity_test',
      'type' => 'shape',
      'cardinality' => 2,
      'translatable' => TRUE,
    ));
    $field_storage
      ->save();
    $bundle = $this
      ->randomMachineName();
    entity_create('field_config', array(
      'field_storage' => $field_storage,
      'bundle' => $bundle,
    ))
      ->save();
    $entity = entity_create('entity_test', array(
      'id' => 1,
      'type' => $bundle,
    ));
    $entity
      ->enforceIsNew();
    $entity
      ->save();

    // As the single entity of this type we just saved does not have a value
    // in the color field, the result should be 0.
    $count = $this->factory
      ->get('entity_test')
      ->exists("{$field_name}.color")
      ->count()
      ->execute();
    $this
      ->assertFalse($count);
  }

  /**
   * Tests that nested condition groups work as expected.
   */
  public function testNestedConditionGroups() {

    // Query for all entities of the first bundle that have either a red
    // triangle as a figure or the Turkish greeting as a greeting.
    $query = $this->factory
      ->get('entity_test_mulrev');
    $first_and = $query
      ->andConditionGroup()
      ->condition($this->figures . '.color', 'red')
      ->condition($this->figures . '.shape', 'triangle');
    $second_and = $query
      ->andConditionGroup()
      ->condition($this->greetings . '.value', 'merhaba')
      ->condition($this->greetings . '.format', 'format-tr');
    $or = $query
      ->orConditionGroup()
      ->condition($first_and)
      ->condition($second_and);
    $this->queryResults = $query
      ->condition($or)
      ->condition('type', reset($this->bundles))
      ->sort('id')
      ->execute();
    $this
      ->assertResult(6, 14);
  }
  protected function assertResult() {
    $assert = array();
    $expected = func_get_args();
    if ($expected && is_array($expected[0])) {
      $expected = $expected[0];
    }
    foreach ($expected as $binary) {
      $assert[$binary] = strval($binary);
    }
    $this
      ->assertIdentical($this->queryResults, $assert);
  }
  protected function assertRevisionResult($keys, $expected) {
    $assert = array();
    foreach ($expected as $key => $binary) {
      $assert[$keys[$key]] = strval($binary);
    }
    $this
      ->assertIdentical($this->queryResults, $assert);
    return $assert;
  }
  protected function assertBundleOrder($order) {

    // This loop is for bundle1 entities.
    for ($i = 1; $i <= 15; $i += 2) {
      $ok = TRUE;
      $index1 = array_search($i, $this->queryResults);
      $this
        ->assertNotIdentical($index1, FALSE, "{$i} found at {$index1}.");

      // This loop is for bundle2 entities.
      for ($j = 2; $j <= 15; $j += 2) {
        if ($ok) {
          if ($order == 'asc') {
            $ok = $index1 > array_search($j, $this->queryResults);
          }
          else {
            $ok = $index1 < array_search($j, $this->queryResults);
          }
        }
      }
      $this
        ->assertTrue($ok, "{$i} is after all entities in bundle2");
    }
  }

  /**
   * Test adding a tag and metadata to the Entity query object.
   *
   * The tags and metadata should propagate to the SQL query object.
   */
  public function testMetaData() {
    $query = \Drupal::entityQuery('entity_test_mulrev');
    $query
      ->addTag('efq_metadata_test')
      ->addMetaData('foo', 'bar')
      ->execute();
    global $efq_test_metadata;
    $this
      ->assertEqual($efq_test_metadata, 'bar', 'Tag and metadata propagated to the SQL query object.');
  }

  /**
   * Test case sensitive and in-sensitive query conditions.
   */
  public function testCaseSensitivity() {
    $bundle = $this
      ->randomMachineName();
    $field_storage = FieldStorageConfig::create(array(
      'field_name' => 'field_ci',
      'entity_type' => 'entity_test_mulrev',
      'type' => 'string',
      'cardinality' => 1,
      'translatable' => FALSE,
      'settings' => array(
        'case_sensitive' => FALSE,
      ),
    ));
    $field_storage
      ->save();
    FieldConfig::create(array(
      'field_storage' => $field_storage,
      'bundle' => $bundle,
    ))
      ->save();
    $field_storage = FieldStorageConfig::create(array(
      'field_name' => 'field_cs',
      'entity_type' => 'entity_test_mulrev',
      'type' => 'string',
      'cardinality' => 1,
      'translatable' => FALSE,
      'settings' => array(
        'case_sensitive' => TRUE,
      ),
    ));
    $field_storage
      ->save();
    FieldConfig::create(array(
      'field_storage' => $field_storage,
      'bundle' => $bundle,
    ))
      ->save();
    $fixtures = array();
    for ($i = 0; $i < 2; $i++) {

      // If the last 4 of the string are all numbers, then there is no
      // difference between upper and lowercase and the case sensitive CONTAINS
      // test will fail. Ensure that can not happen by appending a non-numeric
      // character. See https://www.drupal.org/node/2397297.
      $string = $this
        ->randomMachineName(7) . 'a';
      $fixtures[] = array(
        'original' => $string,
        'uppercase' => Unicode::strtoupper($string),
        'lowercase' => Unicode::strtolower($string),
      );
    }
    EntityTestMulRev::create(array(
      'type' => $bundle,
      'name' => $this
        ->randomMachineName(),
      'langcode' => 'en',
      'field_ci' => $fixtures[0]['uppercase'] . $fixtures[1]['lowercase'],
      'field_cs' => $fixtures[0]['uppercase'] . $fixtures[1]['lowercase'],
    ))
      ->save();

    // Check the case insensitive field, = operator.
    $result = \Drupal::entityQuery('entity_test_mulrev')
      ->condition('field_ci', $fixtures[0]['lowercase'] . $fixtures[1]['lowercase'])
      ->execute();
    $this
      ->assertIdentical(count($result), 1, 'Case insensitive, lowercase');
    $result = \Drupal::entityQuery('entity_test_mulrev')
      ->condition('field_ci', $fixtures[0]['uppercase'] . $fixtures[1]['uppercase'])
      ->execute();
    $this
      ->assertIdentical(count($result), 1, 'Case insensitive, uppercase');
    $result = \Drupal::entityQuery('entity_test_mulrev')
      ->condition('field_ci', $fixtures[0]['uppercase'] . $fixtures[1]['lowercase'])
      ->execute();
    $this
      ->assertIdentical(count($result), 1, 'Case insensitive, mixed.');

    // Check the case sensitive field, = operator.
    $result = \Drupal::entityQuery('entity_test_mulrev')
      ->condition('field_cs', $fixtures[0]['lowercase'] . $fixtures[1]['lowercase'])
      ->execute();
    $this
      ->assertIdentical(count($result), 0, 'Case sensitive, lowercase.');
    $result = \Drupal::entityQuery('entity_test_mulrev')
      ->condition('field_cs', $fixtures[0]['uppercase'] . $fixtures[1]['uppercase'])
      ->execute();
    $this
      ->assertIdentical(count($result), 0, 'Case sensitive, uppercase.');
    $result = \Drupal::entityQuery('entity_test_mulrev')
      ->condition('field_cs', $fixtures[0]['uppercase'] . $fixtures[1]['lowercase'])
      ->execute();
    $this
      ->assertIdentical(count($result), 1, 'Case sensitive, exact match.');

    // Check the case insensitive field, IN operator.
    $result = \Drupal::entityQuery('entity_test_mulrev')
      ->condition('field_ci', array(
      $fixtures[0]['lowercase'] . $fixtures[1]['lowercase'],
    ), 'IN')
      ->execute();
    $this
      ->assertIdentical(count($result), 1, 'Case insensitive, lowercase');
    $result = \Drupal::entityQuery('entity_test_mulrev')
      ->condition('field_ci', array(
      $fixtures[0]['uppercase'] . $fixtures[1]['uppercase'],
    ), 'IN')
      ->execute();
    $this
      ->assertIdentical(count($result), 1, 'Case insensitive, uppercase');
    $result = \Drupal::entityQuery('entity_test_mulrev')
      ->condition('field_ci', array(
      $fixtures[0]['uppercase'] . $fixtures[1]['lowercase'],
    ), 'IN')
      ->execute();
    $this
      ->assertIdentical(count($result), 1, 'Case insensitive, mixed');

    // Check the case sensitive field, IN operator.
    $result = \Drupal::entityQuery('entity_test_mulrev')
      ->condition('field_cs', array(
      $fixtures[0]['lowercase'] . $fixtures[1]['lowercase'],
    ), 'IN')
      ->execute();
    $this
      ->assertIdentical(count($result), 0, 'Case sensitive, lowercase');
    $result = \Drupal::entityQuery('entity_test_mulrev')
      ->condition('field_cs', array(
      $fixtures[0]['uppercase'] . $fixtures[1]['uppercase'],
    ), 'IN')
      ->execute();
    $this
      ->assertIdentical(count($result), 0, 'Case sensitive, uppercase');
    $result = \Drupal::entityQuery('entity_test_mulrev')
      ->condition('field_cs', array(
      $fixtures[0]['uppercase'] . $fixtures[1]['lowercase'],
    ), 'IN')
      ->execute();
    $this
      ->assertIdentical(count($result), 1, 'Case sensitive, mixed');

    // Check the case insensitive field, STARTS_WITH operator.
    $result = \Drupal::entityQuery('entity_test_mulrev')
      ->condition('field_ci', $fixtures[0]['lowercase'], 'STARTS_WITH')
      ->execute();
    $this
      ->assertIdentical(count($result), 1, 'Case sensitive, lowercase.');
    $result = \Drupal::entityQuery('entity_test_mulrev')
      ->condition('field_ci', $fixtures[0]['uppercase'], 'STARTS_WITH')
      ->execute();
    $this
      ->assertIdentical(count($result), 1, 'Case sensitive, exact match.');

    // Check the case sensitive field, STARTS_WITH operator.
    $result = \Drupal::entityQuery('entity_test_mulrev')
      ->condition('field_cs', $fixtures[0]['lowercase'], 'STARTS_WITH')
      ->execute();
    $this
      ->assertIdentical(count($result), 0, 'Case sensitive, lowercase.');
    $result = \Drupal::entityQuery('entity_test_mulrev')
      ->condition('field_cs', $fixtures[0]['uppercase'], 'STARTS_WITH')
      ->execute();
    $this
      ->assertIdentical(count($result), 1, 'Case sensitive, exact match.');

    // Check the case insensitive field, ENDS_WITH operator.
    $result = \Drupal::entityQuery('entity_test_mulrev')
      ->condition('field_ci', $fixtures[1]['lowercase'], 'ENDS_WITH')
      ->execute();
    $this
      ->assertIdentical(count($result), 1, 'Case sensitive, lowercase.');
    $result = \Drupal::entityQuery('entity_test_mulrev')
      ->condition('field_ci', $fixtures[1]['uppercase'], 'ENDS_WITH')
      ->execute();
    $this
      ->assertIdentical(count($result), 1, 'Case sensitive, exact match.');

    // Check the case sensitive field, ENDS_WITH operator.
    $result = \Drupal::entityQuery('entity_test_mulrev')
      ->condition('field_cs', $fixtures[1]['lowercase'], 'ENDS_WITH')
      ->execute();
    $this
      ->assertIdentical(count($result), 1, 'Case sensitive, lowercase.');
    $result = \Drupal::entityQuery('entity_test_mulrev')
      ->condition('field_cs', $fixtures[1]['uppercase'], 'ENDS_WITH')
      ->execute();
    $this
      ->assertIdentical(count($result), 0, 'Case sensitive, exact match.');

    // Check the case insensitive field, CONTAINS operator, use the inner 8
    // characters of the uppercase and lowercase strings.
    $result = \Drupal::entityQuery('entity_test_mulrev')
      ->condition('field_ci', Unicode::substr($fixtures[0]['uppercase'] . $fixtures[1]['lowercase'], 4, 8), 'CONTAINS')
      ->execute();
    $this
      ->assertIdentical(count($result), 1, 'Case sensitive, lowercase.');
    $result = \Drupal::entityQuery('entity_test_mulrev')
      ->condition('field_ci', Unicode::strtolower(Unicode::substr($fixtures[0]['uppercase'] . $fixtures[1]['lowercase'], 4, 8)), 'CONTAINS')
      ->execute();
    $this
      ->assertIdentical(count($result), 1, 'Case sensitive, exact match.');

    // Check the case sensitive field, CONTAINS operator.
    $result = \Drupal::entityQuery('entity_test_mulrev')
      ->condition('field_cs', Unicode::substr($fixtures[0]['uppercase'] . $fixtures[1]['lowercase'], 4, 8), 'CONTAINS')
      ->execute();
    $this
      ->assertIdentical(count($result), 1, 'Case sensitive, lowercase.');
    $result = \Drupal::entityQuery('entity_test_mulrev')
      ->condition('field_cs', Unicode::strtolower(Unicode::substr($fixtures[0]['uppercase'] . $fixtures[1]['lowercase'], 4, 8)), 'CONTAINS')
      ->execute();
    $this
      ->assertIdentical(count($result), 0, 'Case sensitive, exact match.');
  }

  /**
   * Test base fields with multiple columns.
   */
  public function testBaseFieldMultipleColumns() {
    $this
      ->enableModules([
      'taxonomy',
    ]);
    $this
      ->installEntitySchema('taxonomy_term');
    Vocabulary::create([
      'vid' => 'tags',
    ]);
    $term1 = Term::create([
      'name' => $this
        ->randomMachineName(),
      'vid' => 'tags',
      'description' => array(
        'value' => $this
          ->randomString(),
        'format' => 'format1',
      ),
    ]);
    $term1
      ->save();
    $term2 = Term::create([
      'name' => $this
        ->randomMachineName(),
      'vid' => 'tags',
      'description' => array(
        'value' => $this
          ->randomString(),
        'format' => 'format2',
      ),
    ]);
    $term2
      ->save();
    $ids = \Drupal::entityQuery('taxonomy_term')
      ->condition('description.format', 'format1')
      ->execute();
    $this
      ->assertEqual(count($ids), 1);
    $this
      ->assertEqual($term1
      ->id(), reset($ids));
  }

  /**
   * Test forward-revisions.
   */
  public function testForwardRevisions() {

    // Ensure entity 14 is returned.
    $result = \Drupal::entityQuery('entity_test_mulrev')
      ->condition('id', [
      14,
    ], 'IN')
      ->execute();
    $this
      ->assertEqual(count($result), 1);

    // Set a revision on entity 14 that isn't the current default.
    $entity = EntityTestMulRev::load(14);
    $current_values = $entity->{$this->figures}
      ->getValue();
    $entity
      ->setNewRevision(TRUE);
    $entity
      ->isDefaultRevision(FALSE);
    $entity->{$this->figures}
      ->setValue([
      'color' => 'red',
      'shape' => 'square',
    ]);
    $entity
      ->save();

    // Entity query should still return entity 14.
    $result = \Drupal::entityQuery('entity_test_mulrev')
      ->condition('id', [
      14,
    ], 'IN')
      ->execute();
    $this
      ->assertEqual(count($result), 1);

    // Verify that field conditions on the default and forward revision are
    // work as expected.
    $result = \Drupal::entityQuery('entity_test_mulrev')
      ->condition('id', [
      14,
    ], 'IN')
      ->condition("{$this->figures}.color", $current_values[0]['color'])
      ->execute();
    $this
      ->assertEqual($result, [
      14 => '14',
    ]);
    $result = $this->factory
      ->get('entity_test_mulrev')
      ->condition('id', [
      14,
    ], 'IN')
      ->condition("{$this->figures}.color", 'red')
      ->allRevisions()
      ->execute();
    $this
      ->assertEqual($result, [
      16 => '14',
    ]);
  }

  /**
   * Test against SQL inject of condition field. This covers a
   * database driver's EntityQuery\Condition class.
   */
  public function testInjectionInCondition() {
    try {
      $this->queryResults = $this->factory
        ->get('entity_test_mulrev')
        ->condition('1 ; -- ', array(
        0,
        1,
      ), 'IN')
        ->sort('id')
        ->execute();
      $this
        ->fail('SQL Injection attempt in Entity Query condition in operator should result in an exception.');
    } catch (\Exception $e) {
      $this
        ->pass('SQL Injection attempt in Entity Query condition in operator should result in an exception.');
    }
  }

}

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.
EntityQueryTest::$bundles protected property A list of bundle machine names created for this test.
EntityQueryTest::$factory protected property
EntityQueryTest::$figures public property Field name for the figures field.
EntityQueryTest::$greetings public property Field name for the greetings field.
EntityQueryTest::$modules public static property Modules to enable. Overrides EntityUnitTestBase::$modules
EntityQueryTest::$queryResults protected property
EntityQueryTest::assertBundleOrder protected function
EntityQueryTest::assertResult protected function
EntityQueryTest::assertRevisionResult protected function
EntityQueryTest::setUp protected function Performs setup tasks before each individual test method is run. Overrides EntityUnitTestBase::setUp
EntityQueryTest::testBaseFieldMultipleColumns public function Test base fields with multiple columns.
EntityQueryTest::testCaseSensitivity public function Test case sensitive and in-sensitive query conditions.
EntityQueryTest::testCount public function Test that count queries are separated across entity types.
EntityQueryTest::testEntityQuery function Test basic functionality.
EntityQueryTest::testForwardRevisions public function Test forward-revisions.
EntityQueryTest::testInjectionInCondition public function Test against SQL inject of condition field. This covers a database driver's EntityQuery\Condition class.
EntityQueryTest::testMetaData public function Test adding a tag and metadata to the Entity query object.
EntityQueryTest::testNestedConditionGroups public function Tests that nested condition groups work as expected.
EntityQueryTest::testSort function Test sort().
EntityQueryTest::testTableSort public function Test tablesort().
EntityUnitTestBase::$entityManager protected property The entity manager service.
EntityUnitTestBase::$generatedIds protected property A list of generated identifiers.
EntityUnitTestBase::$state protected property The state service.
EntityUnitTestBase::createUser protected function Creates a user.
EntityUnitTestBase::generateRandomEntityId protected function Generates a random ID avoiding collisions.
EntityUnitTestBase::getHooksInfo protected function Returns the entity_test hook invocation info.
EntityUnitTestBase::installModule protected function Installs a module and refreshes services.
EntityUnitTestBase::refreshServices protected function Refresh services. 1
EntityUnitTestBase::reloadEntity protected function Reloads the given entity from the storage and returns it.
EntityUnitTestBase::uninstallModule protected function Uninstalls a module and refreshes services.
KernelTestBase::$configDirectories protected property The configuration directories for this test run.
KernelTestBase::$keyValueFactory protected property A KeyValueMemoryFactory instance to use when building the container.
KernelTestBase::$moduleFiles private property
KernelTestBase::$streamWrappers protected property Array of registered stream wrappers.
KernelTestBase::$themeFiles private property
KernelTestBase::beforePrepareEnvironment protected function Act on global state information before the environment is altered for a test. Overrides TestBase::beforePrepareEnvironment
KernelTestBase::containerBuild public function Sets up the base service container for this test. 12
KernelTestBase::defaultLanguageData protected function Provides the data for setting the default language on the container. 1
KernelTestBase::disableModules protected function Disables modules for this test.
KernelTestBase::enableModules protected function Enables modules for this test.
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 a specific table from a module schema definition.
KernelTestBase::prepareConfigDirectories protected function Create and set new configuration directories. 1
KernelTestBase::registerStreamWrapper protected function Registers a stream wrapper for this test.
KernelTestBase::render protected function Renders a render array.
KernelTestBase::tearDown protected function Performs cleanup tasks after each individual test method has been run. Overrides TestBase::tearDown
KernelTestBase::__construct function Constructor for Test. Overrides TestBase::__construct
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.
SessionTestTrait::$sessionName protected property The name of the session cookie.
SessionTestTrait::generateSessionName protected function Generates a session cookie name.
SessionTestTrait::getSessionName protected function Returns the session name in use on the child site.
TestBase::$assertions protected property Assertions thrown in that test case.
TestBase::$configImporter protected property The config importer that can used in a test. 5
TestBase::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking.
TestBase::$container protected property The dependency injection container used in the test.
TestBase::$databasePrefix protected property The database prefix of this test run.
TestBase::$dieOnFail public property Whether to die in case any test assertion fails.
TestBase::$httpAuthCredentials protected property HTTP authentication credentials (<username>:<password>).
TestBase::$httpAuthMethod protected property HTTP authentication method (specified as a CURLAUTH_* constant).
TestBase::$kernel protected property The DrupalKernel instance used in the test. 1
TestBase::$originalConf protected property The original configuration (variables), if available.
TestBase::$originalConfig protected property The original configuration (variables).
TestBase::$originalConfigDirectories protected property The original configuration directories.
TestBase::$originalContainer protected property The original container.
TestBase::$originalFileDirectory protected property The original file directory, before it was changed for testing purposes.
TestBase::$originalLanguage protected property The original language.
TestBase::$originalPrefix protected property The original database prefix when running inside Simpletest.
TestBase::$originalProfile protected property The original installation profile.
TestBase::$originalSessionName protected property The name of the session cookie of the test-runner.
TestBase::$originalSettings protected property The settings array.
TestBase::$originalShutdownCallbacks protected property The original array of shutdown function callbacks. 1
TestBase::$originalSite protected property The site directory of the original parent site.
TestBase::$originalUser protected property The original user, before testing began. 1
TestBase::$privateFilesDirectory protected property The private file directory for the test environment.
TestBase::$publicFilesDirectory protected property The public file directory for the test environment.
TestBase::$results public property Current results of this test case.
TestBase::$siteDirectory protected property The site directory of this test run.
TestBase::$skipClasses protected property This class is skipped when looking for the source of an assertion.
TestBase::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 4
TestBase::$tempFilesDirectory protected property The temporary file directory for the test environment.
TestBase::$testId protected property The test run ID.
TestBase::$timeLimit protected property Time limit for the test.
TestBase::$translationFilesDirectory protected property The translation file directory for the test environment.
TestBase::$verbose public property TRUE if verbose debugging is enabled.
TestBase::$verboseClassName protected property Safe class name for use in verbose output filenames.
TestBase::$verboseDirectory protected property Directory where verbose output files are put.
TestBase::$verboseDirectoryUrl protected property URL to the verbose output file directory.
TestBase::$verboseId protected property Incrementing identifier for verbose output filenames.
TestBase::assert protected function Internal helper: stores the assert.
TestBase::assertEqual protected function Check to see if two values are equal.
TestBase::assertErrorLogged protected function Asserts that a specific error has been logged to the PHP error log.
TestBase::assertFalse protected function Check to see if a value is false.
TestBase::assertIdentical protected function Check to see if two values are identical.
TestBase::assertIdenticalObject protected function Checks to see if two objects are identical.
TestBase::assertNoErrorsLogged protected function Asserts that no errors have been logged to the PHP error.log thus far.
TestBase::assertNotEqual protected function Check to see if two values are not equal.
TestBase::assertNotIdentical protected function Check to see if two values are not identical.
TestBase::assertNotNull protected function Check to see if a value is not NULL.
TestBase::assertNull protected function Check to see if a value is NULL.
TestBase::assertTrue protected function Check to see if a value is not false.
TestBase::changeDatabasePrefix private function Changes the database connection to the prefixed one.
TestBase::checkRequirements protected function Checks the matching requirements for Test. 2
TestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
TestBase::configImporter public function Returns a ConfigImporter object to import test importing of configuration. 5
TestBase::copyConfig public function Copies configuration objects from source storage to target storage.
TestBase::deleteAssert public static function Delete an assertion record by message ID.
TestBase::error protected function Fire an error assertion. 3
TestBase::errorHandler public function Handle errors during test runs.
TestBase::exceptionHandler protected function Handle exceptions.
TestBase::fail protected function Fire an assertion that is always negative.
TestBase::filePreDeleteCallback public static function Ensures test files are deletable within file_unmanaged_delete_recursive().
TestBase::generatePermutations public static function Converts a list of possible parameters into a stack of permutations.
TestBase::getAssertionCall protected function Cycles through backtrace until the first non-assertion method is found.
TestBase::getConfigSchemaExclusions protected function Gets the config schema exclusions for this test.
TestBase::getDatabaseConnection public static function Returns the database connection to the site running Simpletest.
TestBase::getDatabasePrefix public function Gets the database prefix.
TestBase::getTempFilesDirectory public function Gets the temporary files directory.
TestBase::insertAssert public static function Store an assertion from outside the testing context.
TestBase::pass protected function Fire an assertion that is always positive.
TestBase::prepareDatabasePrefix private function Generates a database prefix for running tests.
TestBase::prepareEnvironment private function Prepares the current environment for running the test.
TestBase::restoreEnvironment private function Cleans up the test environment and restores the original environment.
TestBase::run public function Run all tests in this class. 1
TestBase::settingsSet protected function Changes in memory settings.
TestBase::storeAssertion protected function Helper method to store an assertion record in the configured database.
TestBase::verbose protected function Logs a verbose message in a text file.