EntityReferenceAutocompleteTest.php

<?php

/**
 * @file
 * Contains \Drupal\entity_reference\Tests\EntityReferenceAutocompleteTest.
 */
namespace Drupal\entity_reference\Tests;

use Drupal\entity_reference\EntityReferenceController;
use Drupal\system\Tests\Entity\EntityUnitTestBase;
use Symfony\Component\HttpFoundation\Request;

/**
 * Tests the autocomplete functionality of Entity Reference.
 */
class EntityReferenceAutocompleteTest extends EntityUnitTestBase {

  /**
   * The entity type used in this test.
   *
   * @var string
   */
  protected $entityType = 'entity_test_label';

  /**
   * The bundle used in this test.
   *
   * @var string
   */
  protected $bundle = 'entity_test_label';

  /**
   * The name of the field used in this test.
   *
   * @var string
   */
  protected $fieldName = 'field_test';

  /**
   * Modules to enable.
   *
   * @var array
   */
  public static $modules = array(
    'entity_reference',
  );
  public static function getInfo() {
    return array(
      'name' => 'Autocomplete',
      'description' => 'Tests the autocomplete functionality.',
      'group' => 'Entity Reference',
    );
  }
  function setUp() {
    parent::setUp();
    entity_reference_create_instance($this->entityType, $this->bundle, $this->fieldName, 'Field test', $this->entityType);
  }

  /**
   * Tests autocompletion edge cases with slashes in the names.
   */
  function testEntityReferenceAutocompletion() {

    // Add an entity with a slash in its name.
    $entity_1 = entity_create($this->entityType, array(
      'name' => '10/16/2011',
      $this->fieldName => NULL,
    ));
    $entity_1
      ->save();

    // Add another entity that differs after the slash character.
    $entity_2 = entity_create($this->entityType, array(
      'name' => '10/17/2011',
      $this->fieldName => NULL,
    ));
    $entity_2
      ->save();

    // Add another entity that has both a comma and a slash character.
    $entity_3 = entity_create($this->entityType, array(
      'name' => 'label with, and / test',
      $this->fieldName => NULL,
    ));
    $entity_3
      ->save();

    // Try to autocomplete a entity label that matches both entities.
    // We should get both entities in a JSON encoded string.
    $input = '10/';
    $data = $this
      ->getAutocompleteResult('single', $input);
    $this
      ->assertIdentical($data[$entity_1->name->value . ' (1)'], check_plain($entity_1->name->value), 'Autocomplete returned the first matching entity');
    $this
      ->assertIdentical($data[$entity_2->name->value . ' (2)'], check_plain($entity_2->name->value), 'Autocomplete returned the second matching entity');

    // Try to autocomplete a entity label that matches the first entity.
    // We should only get the first entity in a JSON encoded string.
    $input = '10/16';
    $data = $this
      ->getAutocompleteResult('single', $input);
    $target = array(
      $entity_1->name->value . ' (1)' => check_plain($entity_1->name->value),
    );
    $this
      ->assertIdentical($data, $target, 'Autocomplete returns only the expected matching entity.');

    // Try to autocomplete a entity label that matches the second entity, and
    // the first entity  is already typed in the autocomplete (tags) widget.
    $input = $entity_1->name->value . ' (1), 10/17';
    $data = $this
      ->getAutocompleteResult('tags', $input);
    $this
      ->assertIdentical($data[$entity_1->name->value . ' (1), ' . $entity_2->name->value . ' (2)'], check_plain($entity_2->name->value), 'Autocomplete returned the second matching entity');

    // Try to autocomplete a entity label with both a comma and a slash.
    $input = '"label with, and / t';
    $data = $this
      ->getAutocompleteResult('single', $input);
    $n = $entity_3->name->value;

    // Entity labels containing commas or quotes must be wrapped in quotes.
    if (strpos($entity_3->name->value, ',') !== FALSE || strpos($entity_3->name->value, '"') !== FALSE) {
      $n = '"' . str_replace('"', '""', $entity_3->name->value) . ' (3)"';
    }
    $target = array(
      $n => check_plain($entity_3->name->value),
    );
    $this
      ->assertIdentical($data, $target, 'Autocomplete returns an entity label containing a comma and a slash.');
  }

  /**
   * Returns the result of an Entity reference autocomplete request.
   *
   * @param string $type
   *   The Entity reference autocomplete type (e.g. 'single', 'tags').
   * @param string $input
   *   The label of the entity to query by.
   *
   * @return mixed
   *  The JSON value encoded in its appropriate PHP type.
   */
  protected function getAutocompleteResult($type, $input) {
    $request = Request::create('entity_reference/autocomplete/' . $type . '/' . $this->fieldName . '/node/article/NULL');
    $request->query
      ->set('q', $input);
    $entity_reference_controller = EntityReferenceController::create($this->container);
    $result = $entity_reference_controller
      ->handleAutocomplete($request, $type, $this->fieldName, $this->entityType, $this->bundle, 'NULL')
      ->getContent();
    return drupal_json_decode($result);
  }

}