class EditorSelectionTest

Test in-place field editor selection.

Hierarchy

Expanded class hierarchy of EditorSelectionTest

File

drupal/core/modules/edit/lib/Drupal/edit/Tests/EditorSelectionTest.php, line 16
Contains \Drupal\edit\Tests\EditorSelectionTest.

Namespace

Drupal\edit\Tests
View source
class EditorSelectionTest extends EditTestBase {

  /**
   * The manager for editor plugins.
   *
   * @var \Drupal\Component\Plugin\PluginManagerInterface
   */
  protected $editorManager;

  /**
   * The editor selector object to be tested.
   *
   * @var \Drupal\edit\EditorSelectorInterface
   */
  protected $editorSelector;
  public static function getInfo() {
    return array(
      'name' => 'In-place field editor selection',
      'description' => 'Tests in-place field editor selection.',
      'group' => 'Edit',
    );
  }
  function setUp() {
    parent::setUp();
    $this->editorManager = $this->container
      ->get('plugin.manager.edit.editor');
    $this->editorSelector = new EditorSelector($this->editorManager);
  }

  /**
   * Retrieves the FieldInstance object for the given field and returns the
   * editor that Edit selects.
   */
  protected function getSelectedEditor($items, $field_name, $view_mode = 'default') {
    $options = entity_get_display('entity_test', 'entity_test', $view_mode)
      ->getComponent($field_name);
    $field_instance = field_info_instance('entity_test', $field_name, 'entity_test');
    return $this->editorSelector
      ->getEditor($options['type'], $field_instance, $items);
  }

  /**
   * Tests a textual field, without/with text processing, with cardinality 1 and
   * >1, always without a WYSIWYG editor present.
   */
  function testText() {
    $field_name = 'field_text';
    $this
      ->createFieldWithInstance($field_name, 'text', 1, 'Simple text field', array(
      'text_processing' => 0,
    ), 'text_textfield', array(
      'size' => 42,
    ), 'text_default', array());

    // Pretend there is an entity with these items for the field.
    $items = array(
      array(
        'value' => 'Hello, world!',
        'format' => 'full_html',
      ),
    );

    // Editor selection without text processing, with cardinality 1.
    $this
      ->assertEqual('direct', $this
      ->getSelectedEditor($items, $field_name), "Without text processing, cardinality 1, the 'direct' editor is selected.");

    // Editor selection with text processing, cardinality 1.
    $this->field_text_instance['settings']['text_processing'] = 1;
    field_update_instance($this->field_text_instance);
    $this
      ->assertEqual('form', $this
      ->getSelectedEditor($items, $field_name), "With text processing, cardinality 1, the 'form' editor is selected.");

    // Editor selection without text processing, cardinality 1 (again).
    $this->field_text_instance['settings']['text_processing'] = 0;
    field_update_instance($this->field_text_instance);
    $this
      ->assertEqual('direct', $this
      ->getSelectedEditor($items, $field_name), "Without text processing again, cardinality 1, the 'direct' editor is selected.");

    // Editor selection without text processing, cardinality >1
    $this->field_text_field['cardinality'] = 2;
    field_update_field($this->field_text_field);
    $items[] = array(
      'value' => 'Hallo, wereld!',
      'format' => 'full_html',
    );
    $this
      ->assertEqual('form', $this
      ->getSelectedEditor($items, $field_name), "Without text processing, cardinality >1, the 'form' editor is selected.");

    // Editor selection with text processing, cardinality >1
    $this->field_text_instance['settings']['text_processing'] = 1;
    field_update_instance($this->field_text_instance);
    $this
      ->assertEqual('form', $this
      ->getSelectedEditor($items, $field_name), "With text processing, cardinality >1, the 'form' editor is selected.");
  }

  /**
   * Tests a textual field, with text processing, with cardinality 1 and >1,
   * always with an Editor plugin present that supports textual fields with text
   * processing, but with varying text format compatibility.
   */
  function testTextWysiwyg() {

    // Enable edit_test module so that the 'wysiwyg' editor becomes available.
    $this
      ->enableModules(array(
      'edit_test',
    ));
    $field_name = 'field_textarea';
    $this
      ->createFieldWithInstance($field_name, 'text', 1, 'Long text field', array(
      'text_processing' => 1,
    ), 'text_textarea', array(
      'size' => 42,
    ), 'text_default', array());

    // Pretend there is an entity with these items for the field.
    $items = array(
      array(
        'value' => 'Hello, world!',
        'format' => 'filtered_html',
      ),
    );

    // Editor selection w/ cardinality 1, text format w/o associated text editor.
    $this
      ->assertEqual('form', $this
      ->getSelectedEditor($items, $field_name), "With cardinality 1, and the filtered_html text format, the 'form' editor is selected.");

    // Editor selection w/ cardinality 1, text format w/ associated text editor.
    $items[0]['format'] = 'full_html';
    $this
      ->assertEqual('wysiwyg', $this
      ->getSelectedEditor($items, $field_name), "With cardinality 1, and the full_html text format, the 'wysiwyg' editor is selected.");

    // Editor selection with text processing, cardinality >1
    $this->field_textarea_field['cardinality'] = 2;
    field_update_field($this->field_textarea_field);
    $items[] = array(
      'value' => 'Hallo, wereld!',
      'format' => 'full_html',
    );
    $this
      ->assertEqual('form', $this
      ->getSelectedEditor($items, $field_name), "With cardinality >1, and both items using the full_html text format, the 'form' editor is selected.");
  }

  /**
   * Tests a number field, with cardinality 1 and >1.
   */
  function testNumber() {
    $field_name = 'field_nr';
    $this
      ->createFieldWithInstance($field_name, 'number_integer', 1, 'Simple number field', array(), 'number', array(), 'number_integer', array());

    // Pretend there is an entity with these items for the field.
    $items = array(
      42,
      43,
    );

    // Editor selection with cardinality 1.
    $this
      ->assertEqual('form', $this
      ->getSelectedEditor($items, $field_name), "With cardinality 1, the 'form' editor is selected.");

    // Editor selection with cardinality >1.
    $this->field_nr_field['cardinality'] = 2;
    field_update_field($this->field_nr_field);
    $this
      ->assertEqual('form', $this
      ->getSelectedEditor($items, $field_name), "With cardinality >1, the 'form' editor is selected.");
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DrupalUnitTestBase::$keyValueFactory protected property A KeyValueMemoryFactory instance to use when building the container.
DrupalUnitTestBase::$moduleFiles private property
DrupalUnitTestBase::$themeData private property
DrupalUnitTestBase::$themeFiles private property
DrupalUnitTestBase::containerBuild public function Sets up the base service container for this test. 1
DrupalUnitTestBase::disableModules protected function Disables modules for this test.
DrupalUnitTestBase::enableModules protected function Enables modules for this test.
DrupalUnitTestBase::installConfig protected function Installs default configuration for a given list of modules.
DrupalUnitTestBase::installSchema protected function Installs a specific table from a module schema definition.
DrupalUnitTestBase::tearDown protected function Deletes created files, database tables, and reverts all environment changes. Overrides TestBase::tearDown 2
DrupalUnitTestBase::__construct function Overrides \Drupal\simpletest\UnitTestBase::__construct(). Overrides UnitTestBase::__construct
EditorSelectionTest::$editorManager protected property The manager for editor plugins.
EditorSelectionTest::$editorSelector protected property The editor selector object to be tested.
EditorSelectionTest::getInfo public static function
EditorSelectionTest::getSelectedEditor protected function Retrieves the FieldInstance object for the given field and returns the editor that Edit selects.
EditorSelectionTest::setUp function Sets the default field storage backend for fields created during tests. Overrides EditTestBase::setUp
EditorSelectionTest::testNumber function Tests a number field, with cardinality 1 and >1.
EditorSelectionTest::testText function Tests a textual field, without/with text processing, with cardinality 1 and >1, always without a WYSIWYG editor present.
EditorSelectionTest::testTextWysiwyg function Tests a textual field, with text processing, with cardinality 1 and >1, always with an Editor plugin present that supports textual fields with text processing, but with varying text format compatibility.
EditTestBase::$modules public static property Modules to enable. Overrides DrupalUnitTestBase::$modules
EditTestBase::createFieldWithInstance function Creates a field and an instance of it.
TestBase::$assertions protected property Assertions thrown in that test case.
TestBase::$configImporter protected property The config importer that can used in a test. 1
TestBase::$container protected property The dependency injection container used in the test. 1
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::$originalFileDirectory protected property The original file directory, before it was changed for testing purposes.
TestBase::$originalPrefix protected property The original database prefix when running inside Simpletest.
TestBase::$originalSettings protected property The settings array.
TestBase::$public_files_directory protected property The public file directory for the test environment.
TestBase::$results public property Current results of this test case.
TestBase::$setup protected property Flag to indicate whether the test has been set up.
TestBase::$setupDatabasePrefix protected property
TestBase::$setupEnvironment protected property
TestBase::$skipClasses protected property This class is skipped when looking for the source of an assertion.
TestBase::$testId protected property The test run ID.
TestBase::$timeLimit protected property Time limit for the test.
TestBase::$verbose protected 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::assertFalse protected function Check to see if a value is false (an empty string, 0, NULL, or 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::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 (not an empty string, 0, NULL, or FALSE).
TestBase::changeDatabasePrefix protected function Changes the database connection to the prefixed one.
TestBase::checkRequirements protected function Checks the matching requirements for Test. 4
TestBase::configImporter public function Returns a ConfigImporter object to import test importing of configuration. 1
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. 1
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::getDatabaseConnection public static function Returns the database connection to the site running Simpletest.
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::prepareConfigDirectories protected function Create and set new configuration directories. 1
TestBase::prepareDatabasePrefix protected function Generates a database prefix for running tests.
TestBase::prepareEnvironment protected function Prepares the current environment for running the test.
TestBase::randomName public static function Generates a random string containing letters and numbers.
TestBase::randomObject public static function Generates a random PHP object.
TestBase::randomString public static function Generates a random string of ASCII characters of codes 32 to 126.
TestBase::rebuildContainer protected function Rebuild drupal_container(). 1
TestBase::run public function Run all tests in this class.
TestBase::settingsSet protected function Changes in memory settings.
TestBase::verbose protected function Logs verbose message in a text file.
UnitTestBase::$configDirectories protected property