You are here

class FieldCollectionEntityTranslationTestCase in Field collection 7

Test using field collection with content that gets translated with Entity Translation.

Hierarchy

Expanded class hierarchy of FieldCollectionEntityTranslationTestCase

File

./field_collection.test, line 675
Tests for field_collections.

View source
class FieldCollectionEntityTranslationTestCase extends DrupalWebTestCase {
  const TRANS_FIELD_EN = 'Translatable EN';
  const TRANS_FIELD_DE = 'Translatable DE';
  const TRANS_FIELD_DE_MOD = 'Translatable DE Mod';
  const UNTRANS_FIELD_EN = 'Untranslatable EN';
  const UNTRANS_FIELD_DE = 'Untranslatable DE';
  const UNTRANS_FIELD_DE_MOD = 'Untranslatable DE Mod';
  const NUM_VALUES = 4;

  /**
   *
   */
  public static function getInfo() {
    return array(
      'name' => 'Field collection entity translation',
      'description' => 'Tests using content under translation with Entity Translation.',
      'group' => 'Field types',
      'dependencies' => array(
        'entity_translation',
      ),
    );
  }

  /**
   * Login the given user only if she has not changed.
   */
  public function login($user) {
    if (!isset($this->current_user) || $this->current_user->uid != $user->uid) {
      $this->current_user = $user;
      $this
        ->drupalLogin($user);
    }
  }

  /**
   * Returns a user with administration rights.
   *
   * @param $permissions
   *   Additional permissions for administrative user.
   */
  public function getAdminUser(array $permissions = array()) {
    if (!isset($this->admin_user)) {
      $this->admin_user = $this
        ->drupalCreateUser(array_merge(array(
        'bypass node access',
        'administer nodes',
        'administer languages',
        'administer content types',
        'administer blocks',
        'access administration pages',
        'administer site configuration',
        'administer entity translation',
      ), $permissions));
    }
    return $this->admin_user;
  }

  /**
   * Returns a user with minimal translation rights.
   *
   * @param $permissions
   *   Additional permissions for administrative user.
   */
  public function getTranslatorUser(array $permissions = array()) {
    if (!isset($this->translator_user)) {
      $this->translator_user = $this
        ->drupalCreateUser(array_merge(array(
        'create page content',
        'edit own page content',
        'delete own page content',
        'translate any entity',
      ), $permissions));
    }
    return $this->translator_user;
  }

  /**
   * Install a specified language if it has not been already, otherwise make
   * sure that the language is enabled.
   *
   * @param string $langcode
   *   The language code to check.
   */
  public function addLanguage($langcode) {

    // Check to make sure that language has not already been installed.
    $this
      ->drupalGet('admin/config/regional/language');
    if (strpos($this
      ->drupalGetContent(), 'enabled[' . $langcode . ']') === FALSE) {

      // Doesn't have language installed so add it.
      $edit = array();
      $edit['langcode'] = $langcode;
      $this
        ->drupalPost('admin/config/regional/language/add', $edit, t('Add language'));

      // Make sure we are not using a stale list.
      drupal_static_reset('language_list');
      $languages = language_list();
      $this
        ->assertTrue(array_key_exists($langcode, $languages), t('Language was installed successfully.'));
      if (array_key_exists($langcode, $languages)) {
        $this
          ->assertRaw(t('The language %language has been created and can now be used. More information is available on the <a href="@locale-help">help screen</a>.', array(
          '%language' => $languages[$langcode]->name,
          '@locale-help' => url('admin/help/locale'),
        )), t('Language has been created.'));
      }
    }
    elseif ($this
      ->xpath('//input[@type="checkbox" and @name=:name and @checked="checked"]', array(
      ':name' => 'enabled[' . $langcode . ']',
    ))) {

      // It is installed and enabled. No need to do anything.
      $this
        ->assertTrue(TRUE, 'Language [' . $langcode . '] already installed and enabled.');
    }
    else {

      // It is installed but not enabled. Enable it.
      $this
        ->assertTrue(TRUE, 'Language [' . $langcode . '] already installed.');
      $this
        ->drupalPost(NULL, array(
        'enabled[' . $langcode . ']' => TRUE,
      ), t('Save configuration'));
      $this
        ->assertRaw(t('Configuration saved.'), t('Language successfully enabled.'));
    }
  }

  /**
   *
   */
  public function setUp() {
    parent::setUp(array(
      'field_collection',
      'entity_translation',
    ));
    $language_none = LANGUAGE_NONE;

    // Login with an admin user.
    $this
      ->login($this
      ->getAdminUser());

    // Add English and German languages.
    $this
      ->addLanguage('en');
    $this
      ->addLanguage('de');

    // Set "Article" content type to use multilingual support with translation.
    $edit = array();
    $edit['language_content_type'] = ENTITY_TRANSLATION_ENABLED;
    $this
      ->drupalPost('admin/structure/types/manage/page', $edit, t('Save content type'));
    $this
      ->assertRaw(t('The content type %type has been updated.', array(
      '%type' => 'Basic page',
    )), t('Basic page content type has been updated.'));

    // Create a field collection field to use for the tests.
    $this->field_name = 'field_test_collection';
    $this->field_base = "{$this->field_name}[{$language_none}]";
    $this->field = array(
      'field_name' => $this->field_name,
      'type' => 'field_collection',
      'cardinality' => -1,
      'translatable' => TRUE,
    );
    $this->field = field_create_field($this->field);
    $this->field_id = $this->field['id'];
    $this->instance = array(
      'field_name' => $this->field_name,
      'entity_type' => 'node',
      'bundle' => 'page',
      'label' => self::randomName() . '_label',
      'description' => self::randomName() . '_description',
      'weight' => random_int(0, 127),
      'settings' => array(),
      'widget' => array(
        'type' => 'field_collection_embed',
        'label' => 'Test',
        'settings' => array(),
      ),
    );
    $this->instance = field_create_instance($this->instance);

    // Enable entity translation of field collections.
    $this
      ->drupalGet('admin/config/regional/entity_translation');
    $this
      ->drupalPost('admin/config/regional/entity_translation', array(
      'entity_translation_entity_types[field_collection_item]' => TRUE,
    ), t('Save configuration'));
    $this
      ->assertRaw(t('The configuration options have been saved.'), t('Entity translation of field collections enabled.'));

    // Add an untraslatable field to the collection.
    $this->field_untrans_name = 'field_text_untrans';
    $this->field_untrans_base = "[{$this->field_untrans_name}][{$language_none}][0][value]";
    $field = array(
      'field_name' => $this->field_untrans_name,
      'type' => 'text',
      'cardinality' => 1,
      'translatable' => FALSE,
    );
    field_create_field($field);
    $instance = array(
      'entity_type' => 'field_collection_item',
      'field_name' => $this->field_untrans_name,
      'bundle' => $this->field_name,
      'label' => 'Test untranslatable text field',
      'widget' => array(
        'type' => 'text_textfield',
      ),
    );
    field_create_instance($instance);

    // Add a translatable field to the collection.
    $this->field_trans_name = 'field_text_trans';
    $this->field_trans_base = "[{$this->field_trans_name}][{$language_none}][0][value]";
    $this->field_trans_dest = "[{$this->field_trans_name}][de][0][value]";
    $field = array(
      'field_name' => $this->field_trans_name,
      'type' => 'text',
      'cardinality' => 1,
      'translatable' => TRUE,
    );
    field_create_field($field);
    $instance = array(
      'entity_type' => 'field_collection_item',
      'field_name' => $this->field_trans_name,
      'bundle' => $this->field_name,
      'label' => 'Test translatable text field',
      'widget' => array(
        'type' => 'text_textfield',
      ),
    );
    field_create_instance($instance);
    $this
      ->login($this
      ->getTranslatorUser());
  }

  /**
   * Creates a basic page with a value in the field collection.
   *
   * @param int $num_values
   *   The number of values to include in the field collection.
   * @param string $langcode
   *   Language for the node.
   */
  protected function createPage($num_values, $langcode = 'en') {

    // Check if num_values is greater than the field cardinality.
    if ($num_values > self::NUM_VALUES) {
      $num_values = self::NUM_VALUES;
    }
    $title = self::randomName();
    $this
      ->drupalGet('node/add/page');
    $edit = array();
    $edit['title'] = $title;
    for ($i = 0; $i < $num_values; $i++) {
      if ($i != 0) {
        $this
          ->drupalPost(NULL, array(), t('Add another item'));
      }
      $edit[$this->field_base . '[' . $i . ']' . $this->field_untrans_base] = self::UNTRANS_FIELD_EN . '_' . $i;
      $edit[$this->field_base . '[' . $i . ']' . $this->field_trans_base] = self::TRANS_FIELD_EN . '_' . $i;
    }
    $edit['language'] = $langcode;
    $this
      ->drupalPost(NULL, $edit, t('Save'));
    $this
      ->assertRaw(t('Basic page %title has been created.', array(
      '%title' => $title,
    )), t('Basic page created.'));

    // Check to make sure the node was created.
    $node = $this
      ->drupalGetNodeByTitle($title);
    $this
      ->assertTrue($node, t('Node found in database.'));
    return $node;
  }

  /**
   * Create a translation using the Entity Translation Form.
   *
   * @param mixed $node
   *   Node of the basic page to create translation for.
   * @param string $langcode
   *   The language code of the translation.
   * @param string $source_langcode
   *   The original language code.
   */
  protected function createTranslationForm($node, $langcode, $source_langcode = 'en') {
    $language_none = LANGUAGE_NONE;
    $edit = array();
    $this
      ->drupalGet('node/' . $node->nid . '/edit/add/' . $source_langcode . '/' . $langcode);

    // Get the field collection in the original language.
    $fc_values = $node->{$this->field_name}[$source_langcode];

    // Check if all the fields were populated and fill it with the new value.
    foreach ($fc_values as $delta => $fc_value) {

      // Load the field collection item.
      $fc_item_array = entity_load('field_collection_item', array(
        $fc_value['value'],
      ));
      $fc_item = reset($fc_item_array);
      $fc_untrans_key = "{$this->field_name}[{$langcode}][{$delta}]{$this->field_untrans_base}";
      $fc_trans_key = "{$this->field_name}[{$langcode}][{$delta}]{$this->field_trans_dest}";
      $this
        ->assertFieldByXPath("//input[@name='{$fc_untrans_key}']", $fc_item->{$this->field_untrans_name}[LANGUAGE_NONE][0]['value'], 'Original value of untranslatable field correctly populated');
      $this
        ->assertFieldByXPath("//input[@name='{$fc_trans_key}']", $fc_item->{$this->field_trans_name}['en'][0]['value'], 'Original value of translatable field correctly populated');
      $edit[$fc_untrans_key] = self::UNTRANS_FIELD_DE . '_' . $delta;
      $edit[$fc_trans_key] = self::TRANS_FIELD_DE . '_' . $delta;
    }

    // Save the translation.
    $this
      ->drupalPost(NULL, $edit, t('Save'));
    $this
      ->drupalGet('node/' . $node->nid . '/translate');
    $this
      ->assertLinkByHref('node/' . $node->nid . '/edit/' . $langcode, 0, t('Translation edit link found. Translation created.'));

    // Reload the node.
    $node = node_load($node->nid, NULL, TRUE);

    // Check the values of the translated field.
    $this
      ->checkFieldCollectionContent($node, $langcode);

    // Check the values of the field in the original language.
    $this
      ->checkFieldCollectionContent($node, $source_langcode);
    return $node;
  }

  /**
   * Removes a translation using the entity translation form.
   *
   * @param mixed $node
   *   The node to remove the translation from.
   * @param string $langcode
   *   The language of the translation to remove.
   * @param string $source_langcode
   *   The source language of the node.
   */
  protected function removeTranslationForm($node, $langcode, $source_langcode) {

    // Number of field collection items in the source language.
    $num_original_fc_items = count($node->{$this->field_name}[$source_langcode]);

    // Fetch the translation edit form.
    $this
      ->drupalGet('node/' . $node->nid . '/edit/' . $langcode);

    // Remove the translation.
    $this
      ->drupalPost(NULL, array(), t('Delete translation'));

    // Confirm deletion.
    $this
      ->drupalPost(NULL, array(), t('Delete'));

    // Reload the node.
    $node = node_load($node->nid, NULL, TRUE);

    // Check that the translation is removed.
    $this
      ->drupalGet('node/' . $node->nid . '/translate');
    $this
      ->assertLinkByHref('node/' . $node->nid . '/edit/add/' . $source_langcode . '/' . $langcode, 0, 'The add translation link appears');
    $this
      ->assert(empty($node->{$this->field_name}[$langcode]));

    // Check that the field collection in the original language has not changed.
    $num_fc_items = count($node->{$this->field_name}[$source_langcode]);
    $this
      ->assertEqual($num_original_fc_items, $num_fc_items, 'The number of field collection items in the original language has not changed.');
    $this
      ->checkFieldCollectionContent($node, $source_langcode);
  }

  /**
   * Creates a translation programmatically using Entity Translation.
   *
   * @param mixed $node
   *   Node of the basic page to create translation for.
   * @param string $langcode
   *   The language code of the translation.
   */
  protected function createTranslation($node, $langcode) {
    $source_langcode = $node->language;

    // Get the Entity Translation Handler.
    $handler = entity_translation_get_handler('node', $node, TRUE);

    // Variable to hold the fields values.
    $values = array();

    // Translation settings.
    $translation = array(
      'translate' => 0,
      'status' => 1,
      'language' => $langcode,
      'source' => $source_langcode,
      'uid' => $node->uid,
    );

    // Copy field values.
    foreach (field_info_instances('node', $node->type) as $instance) {
      $field_name = $instance['field_name'];
      $field = field_info_field($field_name);
      $field_value = array();

      // Copy the value of the translated field if it's translatable.
      if ($field['translatable'] && isset($node->{$field_name}[$node->language])) {
        $field_value = $node->{$field_name}[$source_langcode];
        $values[$field_name][$langcode] = $field_value;
        $node->{$field_name}[$langcode] = $field_value;
      }
    }
    $handler
      ->setTranslation($translation, $values);
    $handler
      ->saveTranslations();
    field_attach_update('node', $node);

    // Reload an return the node.
    $node = node_load($node->nid, NULL, TRUE);
    return $node;
  }

  /**
   * Removes a translation programmatically using the entity translation api.
   *
   * @param mixed $node
   *   The node to remove the translation from.
   * @param string $langcode
   *   The language of the translation to remove.
   */
  protected function removeTranslation($node, $langcode) {

    // Get a translation entity handler.
    $handler = entity_translation_get_handler('node', $node, TRUE);

    // Remove the translation.
    $handler
      ->removeTranslation($langcode);
    node_save($node);

    // Reload and return the node.
    $node = node_load($node->nid, NULL, TRUE);
    return $node;
  }

  /**
   * Creates a new revision of the node and checks the result.
   *
   * @param mixed $node
   *   The node to remove the translation from.
   * @param string $langcode
   *   The language of the translation to remove.
   * @param string $source_langcode
   *   The source language of the node.
   *
   * @return mixed
   *   The new revision of the node.
   */
  protected function createRevision($node, $langcode, $source_langcode) {
    $node_original_revision = $node->vid;

    // The original entries of the translated field.
    $original_fc_item_ids = $node->{$this->field_name}[$langcode];

    // Create the revision.
    $node->revision = TRUE;
    node_save($node);

    // The new entries of the translated field.
    $new_fc_item_ids = $node->{$this->field_name}[$langcode];

    // Check that the field collection items are the same and a new revision of
    // each one has been created.
    foreach ($original_fc_item_ids as $delta => $value) {
      $this
        ->assertEqual($value['value'], $new_fc_item_ids[$delta]['value'], t('We have the same field collection item'));
      $this
        ->assertNotEqual($value['revision_id'], $new_fc_item_ids[$delta]['revision_id'], t('We have a new revision of the field collection item'));
    }
    return $node;
  }

  /**
   * Check the content of the field collection for a specified language.
   *
   * @param mixed $node
   *   The node to check.
   * @param string $langcode
   *   The language to check.
   */
  protected function checkFieldCollectionContent($node, $langcode) {
    switch ($langcode) {
      case 'en':
        $untrans_field = self::UNTRANS_FIELD_EN;
        $trans_field = self::TRANS_FIELD_EN;
        break;
      case 'de':
        $untrans_field = self::UNTRANS_FIELD_DE;
        $trans_field = self::TRANS_FIELD_DE;
        break;
    }

    // Get the field collection in the specified language.
    $fc_values = $node->{$this->field_name}[$langcode];
    foreach ($fc_values as $delta => $fc_value) {

      // Load the field collection item.
      $fc_item_array = entity_load('field_collection_item', array(
        $fc_value['value'],
      ));
      $fc_item = reset($fc_item_array);
      $fc_untrans_key = "{$this->field_name}[{$langcode}][{$delta}]{$this->field_untrans_base}";
      $fc_trans_key = "{$this->field_name}[{$langcode}][{$delta}]{$this->field_trans_base}";
      $this
        ->assertEqual($untrans_field . '_' . $delta, $fc_item->{$this->field_untrans_name}[LANGUAGE_NONE][0]['value']);
      $this
        ->assertEqual($trans_field . '_' . $delta, $fc_item->{$this->field_trans_name}[$langcode][0]['value']);
    }
  }

  /**
   * Returns the text field values of an specified node, language and delta.
   *
   * @param mixed $node
   * @param string $langcode
   * @param int $delta
   *
   * @return array
   */
  protected function getFieldValues($node, $langcode, $delta) {
    $return = array();
    if (isset($node->{$this->field_name}[$langcode][$delta]['value'])) {
      $fc_item_id = $node->{$this->field_name}[$langcode][$delta]['value'];

      // Load the field collection.
      $fc_item_array = entity_load('field_collection_item', array(
        $fc_item_id,
      ));
      $fc_item = reset($fc_item_array);
      $return = array(
        'field_untrans' => $fc_item->{$this->field_untrans_name}[LANGUAGE_NONE][0]['value'],
        'field_trans' => $fc_item->{$this->field_trans_name}[$langcode][0]['value'],
      );
    }
    return $return;
  }

  /**
   * Ensures the right behaviour in all Entity Translation use cases.
   */
  public function testEntityTranslation() {
    $source_langcode = 'en';
    $translation_langcode = 'de';

    /*
     * Test with a page with only one value in the field collection
     */

    // Create an article in the original language with only one field collection
    // value.
    $node = $this
      ->createPage(1, $source_langcode);

    // Create a traslation of the page through the entity translation form.
    $node = $this
      ->createTranslationForm($node, $translation_langcode, $source_langcode);

    /*
     * Test with a page with multiple values in the field collection.
     */
    $num_values = 4;

    // Create a page in the original language with multiple field collection
    // values.
    $node = $this
      ->createPage($num_values, $source_langcode);

    // Create a traslation of the page through the entity translation form.
    $node = $this
      ->createTranslationForm($node, $translation_langcode, $source_langcode);

    // Assign a new field collection item to an existing node.
    $values = array();
    $values['field_name'] = $this->field_name;
    $fc_entity = entity_create('field_collection_item', $values);
    $fc_entity
      ->setHostEntity('node', $node, $translation_langcode);
    $fc_entity->{$this->field_untrans_name}[LANGUAGE_NONE][0]['value'] = self::UNTRANS_FIELD_DE_MOD;
    $fc_entity->{$this->field_trans_name}['de'][0]['value'] = self::TRANS_FIELD_DE_MOD;
    $fc_entity
      ->save(TRUE);
    node_save($node);

    // Reload the node to check it.
    $node = node_load($node->nid, NULL, TRUE);

    // Check that there is a new element in the translation.
    $this
      ->assertEqual($num_values + 1, count($node->{$this->field_name}[$translation_langcode]), t('We have one item more in translation.'));

    // Check that the new element is correctly saved.
    $fc_item_values = $this
      ->getFieldValues($node, $translation_langcode, $num_values);
    $this
      ->assertEqual($fc_item_values['field_untrans'], self::UNTRANS_FIELD_DE_MOD);
    $this
      ->assertEqual($fc_item_values['field_trans'], self::TRANS_FIELD_DE_MOD);

    // Check that we have the same items in the original language.
    $this
      ->assertEqual($num_values, count($node->{$this->field_name}[$source_langcode]), t('We have same items in the original language.'));

    // Remove a field collection item from the translation.
    $fc_item_id = $node->{$this->field_name}[$translation_langcode][0]['value'];
    unset($node->{$this->field_name}[$translation_langcode][0]);
    node_save($node);

    // Reload the node.
    $node = node_load($node->nid, NULL, TRUE);

    // Check that we have one item less in the translation.
    // We should take into account that we added a field one step before.
    $this
      ->assertEqual($num_values, count($node->{$this->field_name}[$translation_langcode]), t('We have one item less in translation.'));

    // Check that we have the same items in the original language.
    $this
      ->assertEqual($num_values, count($node->{$this->field_name}[$source_langcode]), t('We have same items in the original language.'));

    // Check that the field collection is removed from the database.
    $fc_items = entity_load('field_collection_item', array(
      $fc_item_id,
    ));
    $this
      ->assert(empty($fc_items), t('The field collection item has been removed from the database.'));

    // Delete the translation.
    $this
      ->removeTranslationForm($node, $translation_langcode, $source_langcode);

    /*
     * Check the revisioning of an entity with translations.
     */
    $num_values = 4;

    // Create a page in the original language with multiple field collection
    // values.
    $node_rev = $this
      ->createPage($num_values, $source_langcode);

    // Create a traslation of the page.
    $node_rev = $this
      ->createTranslationForm($node_rev, $translation_langcode, $source_langcode);
    $original_revision = $node_rev->vid;

    // Create a new revision of the node.
    $node_rev = $this
      ->createRevision($node_rev, $translation_langcode, $source_langcode);

    /*
     * Test creating programmatically.
     */
    $num_values = 4;

    // Create a page in the original language.
    $node_prog = $this
      ->createPage($num_values, $source_langcode);

    // Create programmatically a translation of the page.
    $node_prog = $this
      ->createTranslation($node_prog, $translation_langcode);
    $orig_fc_items = $node_prog->{$this->field_name}[$source_langcode];
    $trans_fc_items = $node_prog->{$this->field_name}[$translation_langcode];
    $orig_fc_item_ids = array();
    $trans_fc_item_ids = array();

    // Check each item.
    foreach ($orig_fc_items as $delta => $value) {
      $orig_fc_item_ids[] = $value['value'];
      $trans_fc_item_ids[] = $trans_fc_items[$delta]['value'];

      // Check if we have new items for the translation.
      $this
        ->assertNotEqual($value['value'], $trans_fc_items[$delta]['value'], t('New item generated for translation.'));
    }

    // Check that the original item still exists in the database.
    $fc_items = entity_load('field_collection_item', $orig_fc_item_ids);
    $this
      ->assert(!empty($fc_items), t('Field Collections in the source language still exist.'));

    // Check that the translated item exists in the database.
    $fc_items = entity_load('field_collection_item', $trans_fc_item_ids);
    $this
      ->assert(!empty($fc_items), t('Translations for the Field Collection exist.'));

    // Remove the translation and check that the original field collection items
    // are still there.
    $node_prog = $this
      ->removeTranslation($node, $translation_langcode);

    // Check the content in the source language.
    $this
      ->checkFieldCollectionContent($node_prog, $source_langcode);

    // Check that the field translated content has been removed.
    $this
      ->assert(empty($node->{$this->field_name}[$translation_langcode]), t('Translated content removed.'));
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DrupalTestCase::$assertions protected property Assertions thrown in that test case.
DrupalTestCase::$databasePrefix protected property The database prefix of this test run.
DrupalTestCase::$originalFileDirectory protected property The original file directory, before it was changed for testing purposes.
DrupalTestCase::$results public property Current results of this test case.
DrupalTestCase::$setup protected property Flag to indicate whether the test has been set up.
DrupalTestCase::$setupDatabasePrefix protected property
DrupalTestCase::$setupEnvironment protected property
DrupalTestCase::$skipClasses protected property This class is skipped when looking for the source of an assertion.
DrupalTestCase::$testId protected property The test run ID.
DrupalTestCase::$timeLimit protected property Time limit for the test.
DrupalTestCase::$useSetupInstallationCache public property Whether to cache the installation part of the setUp() method.
DrupalTestCase::$useSetupModulesCache public property Whether to cache the modules installation part of the setUp() method.
DrupalTestCase::$verboseDirectoryUrl protected property URL to the verbose output file directory.
DrupalTestCase::assert protected function Internal helper: stores the assert.
DrupalTestCase::assertEqual protected function Check to see if two values are equal.
DrupalTestCase::assertFalse protected function Check to see if a value is false (an empty string, 0, NULL, or FALSE).
DrupalTestCase::assertIdentical protected function Check to see if two values are identical.
DrupalTestCase::assertNotEqual protected function Check to see if two values are not equal.
DrupalTestCase::assertNotIdentical protected function Check to see if two values are not identical.
DrupalTestCase::assertNotNull protected function Check to see if a value is not NULL.
DrupalTestCase::assertNull protected function Check to see if a value is NULL.
DrupalTestCase::assertTrue protected function Check to see if a value is not false (not an empty string, 0, NULL, or FALSE).
DrupalTestCase::deleteAssert public static function Delete an assertion record by message ID.
DrupalTestCase::error protected function Fire an error assertion. 1
DrupalTestCase::errorHandler public function Handle errors during test runs. 1
DrupalTestCase::exceptionHandler protected function Handle exceptions.
DrupalTestCase::fail protected function Fire an assertion that is always negative.
DrupalTestCase::generatePermutations public static function Converts a list of possible parameters into a stack of permutations.
DrupalTestCase::getAssertionCall protected function Cycles through backtrace until the first non-assertion method is found.
DrupalTestCase::getDatabaseConnection public static function Returns the database connection to the site running Simpletest.
DrupalTestCase::insertAssert public static function Store an assertion from outside the testing context.
DrupalTestCase::pass protected function Fire an assertion that is always positive.
DrupalTestCase::randomName public static function Generates a random string containing letters and numbers.
DrupalTestCase::randomString public static function Generates a random string of ASCII characters of codes 32 to 126.
DrupalTestCase::run public function Run all tests in this class.
DrupalTestCase::verbose protected function Logs a verbose message in a text file.
DrupalWebTestCase::$additionalCurlOptions protected property Additional cURL options.
DrupalWebTestCase::$content protected property The content of the page currently loaded in the internal browser.
DrupalWebTestCase::$cookieFile protected property The current cookie file used by cURL.
DrupalWebTestCase::$cookies protected property The cookies of the page currently loaded in the internal browser.
DrupalWebTestCase::$curlHandle protected property The handle of the current cURL connection.
DrupalWebTestCase::$drupalSettings protected property The value of the Drupal.settings JavaScript variable for the page currently loaded in the internal browser.
DrupalWebTestCase::$elements protected property The parsed version of the page.
DrupalWebTestCase::$generatedTestFiles protected property Whether the files were copied to the test files directory.
DrupalWebTestCase::$headers protected property The headers of the page currently loaded in the internal browser.
DrupalWebTestCase::$httpauth_credentials protected property HTTP authentication credentials (<username>:<password>).
DrupalWebTestCase::$httpauth_method protected property HTTP authentication method
DrupalWebTestCase::$loggedInUser protected property The current user logged in using the internal browser.
DrupalWebTestCase::$originalShutdownCallbacks protected property The original shutdown handlers array, before it was cleaned for testing purposes.
DrupalWebTestCase::$originalUser protected property The original user, before it was changed to a clean uid = 1 for testing purposes.
DrupalWebTestCase::$plainTextContent protected property The content of the page currently loaded in the internal browser (plain text version).
DrupalWebTestCase::$profile protected property The profile to install as a basis for testing. 20
DrupalWebTestCase::$redirect_count protected property The number of redirects followed during the handling of a request.
DrupalWebTestCase::$session_id protected property The current session ID, if available.
DrupalWebTestCase::$session_name protected property The current session name, if available.
DrupalWebTestCase::$url protected property The URL currently loaded in the internal browser.
DrupalWebTestCase::assertField protected function Asserts that a field exists with the given name or ID.
DrupalWebTestCase::assertFieldById protected function Asserts that a field exists in the current page with the given ID and value.
DrupalWebTestCase::assertFieldByName protected function Asserts that a field exists in the current page with the given name and value.
DrupalWebTestCase::assertFieldByXPath protected function Asserts that a field exists in the current page by the given XPath.
DrupalWebTestCase::assertFieldChecked protected function Asserts that a checkbox field in the current page is checked.
DrupalWebTestCase::assertLink protected function Pass if a link with the specified label is found, and optional with the specified index.
DrupalWebTestCase::assertLinkByHref protected function Pass if a link containing a given href (part) is found.
DrupalWebTestCase::assertMail protected function Asserts that the most recently sent e-mail message has the given value.
DrupalWebTestCase::assertMailPattern protected function Asserts that the most recently sent e-mail message has the pattern in it.
DrupalWebTestCase::assertMailString protected function Asserts that the most recently sent e-mail message has the string in it.
DrupalWebTestCase::assertNoDuplicateIds protected function Asserts that each HTML ID is used for just a single element.
DrupalWebTestCase::assertNoField protected function Asserts that a field does not exist with the given name or ID.
DrupalWebTestCase::assertNoFieldById protected function Asserts that a field does not exist with the given ID and value.
DrupalWebTestCase::assertNoFieldByName protected function Asserts that a field does not exist with the given name and value.
DrupalWebTestCase::assertNoFieldByXPath protected function Asserts that a field doesn't exist or its value doesn't match, by XPath.
DrupalWebTestCase::assertNoFieldChecked protected function Asserts that a checkbox field in the current page is not checked.
DrupalWebTestCase::assertNoLink protected function Pass if a link with the specified label is not found.
DrupalWebTestCase::assertNoLinkByHref protected function Pass if a link containing a given href (part) is not found.
DrupalWebTestCase::assertNoOptionSelected protected function Asserts that a select option in the current page is not checked.
DrupalWebTestCase::assertNoPattern protected function Will trigger a pass if the perl regex pattern is not present in raw content.
DrupalWebTestCase::assertNoRaw protected function Pass if the raw text is NOT found on the loaded page, fail otherwise. Raw text refers to the raw HTML that the page generated.
DrupalWebTestCase::assertNoResponse protected function Asserts the page did not return the specified response code.
DrupalWebTestCase::assertNoText protected function Pass if the text is NOT found on the text version of the page. The text version is the equivalent of what a user would see when viewing through a web browser. In other words the HTML has been filtered out of the contents.
DrupalWebTestCase::assertNoTitle protected function Pass if the page title is not the given string.
DrupalWebTestCase::assertNoUniqueText protected function Pass if the text is found MORE THAN ONCE on the text version of the page.
DrupalWebTestCase::assertOptionSelected protected function Asserts that a select option in the current page is checked.
DrupalWebTestCase::assertPattern protected function Will trigger a pass if the Perl regex pattern is found in the raw content.
DrupalWebTestCase::assertRaw protected function Pass if the raw text IS found on the loaded page, fail otherwise. Raw text refers to the raw HTML that the page generated.
DrupalWebTestCase::assertResponse protected function Asserts the page responds with the specified response code.
DrupalWebTestCase::assertText protected function Pass if the text IS found on the text version of the page. The text version is the equivalent of what a user would see when viewing through a web browser. In other words the HTML has been filtered out of the contents.
DrupalWebTestCase::assertTextHelper protected function Helper for assertText and assertNoText.
DrupalWebTestCase::assertThemeOutput protected function Asserts themed output.
DrupalWebTestCase::assertTitle protected function Pass if the page title is the given string.
DrupalWebTestCase::assertUniqueText protected function Pass if the text is found ONLY ONCE on the text version of the page.
DrupalWebTestCase::assertUniqueTextHelper protected function Helper for assertUniqueText and assertNoUniqueText.
DrupalWebTestCase::assertUrl protected function Pass if the internal browser's URL matches the given path.
DrupalWebTestCase::buildXPathQuery protected function Builds an XPath query.
DrupalWebTestCase::changeDatabasePrefix protected function Changes the database connection to the prefixed one.
DrupalWebTestCase::checkForMetaRefresh protected function Check for meta refresh tag and if found call drupalGet() recursively. This function looks for the http-equiv attribute to be set to "Refresh" and is case-sensitive.
DrupalWebTestCase::checkPermissions protected function Check to make sure that the array of permissions are valid.
DrupalWebTestCase::clickLink protected function Follows a link by name.
DrupalWebTestCase::constructFieldXpath protected function Helper function: construct an XPath for the given set of attributes and value.
DrupalWebTestCase::copySetupCache protected function Copy the setup cache from/to another table and files directory.
DrupalWebTestCase::cronRun protected function Runs cron in the Drupal installed by Simpletest.
DrupalWebTestCase::curlClose protected function Close the cURL handler and unset the handler.
DrupalWebTestCase::curlExec protected function Initializes and executes a cURL request.
DrupalWebTestCase::curlHeaderCallback protected function Reads headers and registers errors received from the tested site.
DrupalWebTestCase::curlInitialize protected function Initializes the cURL connection.
DrupalWebTestCase::drupalCompareFiles protected function Compare two files based on size and file name.
DrupalWebTestCase::drupalCreateContentType protected function Creates a custom content type based on default settings.
DrupalWebTestCase::drupalCreateNode protected function Creates a node based on default settings.
DrupalWebTestCase::drupalCreateRole protected function Creates a role with specified permissions.
DrupalWebTestCase::drupalCreateUser protected function Create a user with a given set of permissions.
DrupalWebTestCase::drupalGet protected function Retrieves a Drupal path or an absolute path.
DrupalWebTestCase::drupalGetAJAX protected function Retrieve a Drupal path or an absolute path and JSON decode the result.
DrupalWebTestCase::drupalGetContent protected function Gets the current raw HTML of requested page.
DrupalWebTestCase::drupalGetHeader protected function Gets the value of an HTTP response header. If multiple requests were required to retrieve the page, only the headers from the last request will be checked by default. However, if TRUE is passed as the second argument, all requests will be processed…
DrupalWebTestCase::drupalGetHeaders protected function Gets the HTTP response headers of the requested page. Normally we are only interested in the headers returned by the last request. However, if a page is redirected or HTTP authentication is in use, multiple requests will be required to retrieve the…
DrupalWebTestCase::drupalGetMails protected function Gets an array containing all e-mails sent during this test case.
DrupalWebTestCase::drupalGetNodeByTitle function Get a node from the database based on its title.
DrupalWebTestCase::drupalGetSettings protected function Gets the value of the Drupal.settings JavaScript variable for the currently loaded page.
DrupalWebTestCase::drupalGetTestFiles protected function Get a list files that can be used in tests.
DrupalWebTestCase::drupalGetToken protected function Generate a token for the currently logged in user.
DrupalWebTestCase::drupalHead protected function Retrieves only the headers for a Drupal path or an absolute path.
DrupalWebTestCase::drupalLogin protected function Log in a user with the internal browser.
DrupalWebTestCase::drupalLogout protected function
DrupalWebTestCase::drupalPost protected function Execute a POST request on a Drupal page. It will be done as usual POST request with SimpleBrowser.
DrupalWebTestCase::drupalPostAJAX protected function Execute an Ajax submission.
DrupalWebTestCase::drupalSetContent protected function Sets the raw HTML content. This can be useful when a page has been fetched outside of the internal browser and assertions need to be made on the returned page.
DrupalWebTestCase::drupalSetSettings protected function Sets the value of the Drupal.settings JavaScript variable for the currently loaded page.
DrupalWebTestCase::getAbsoluteUrl protected function Takes a path and returns an absolute path.
DrupalWebTestCase::getAllOptions protected function Get all option elements, including nested options, in a select.
DrupalWebTestCase::getSelectedItem protected function Get the selected value from a select field.
DrupalWebTestCase::getSetupCacheKey protected function Returns the cache key used for the setup caching.
DrupalWebTestCase::getUrl protected function Get the current URL from the cURL handler.
DrupalWebTestCase::handleForm protected function Handle form input related to drupalPost(). Ensure that the specified fields exist and attempt to create POST data in the correct manner for the particular field type.
DrupalWebTestCase::loadSetupCache protected function Copies the cached tables and files for a cached installation setup.
DrupalWebTestCase::parse protected function Parse content returned from curlExec using DOM and SimpleXML.
DrupalWebTestCase::preloadRegistry protected function Preload the registry from the testing site.
DrupalWebTestCase::prepareDatabasePrefix protected function Generates a database prefix for running tests.
DrupalWebTestCase::prepareEnvironment protected function Prepares the current environment for running the test.
DrupalWebTestCase::recursiveDirectoryCopy protected function Recursively copy one directory to another.
DrupalWebTestCase::refreshVariables protected function Refresh the in-memory set of variables. Useful after a page request is made that changes a variable in a different thread. 1
DrupalWebTestCase::resetAll protected function Reset all data structures after having enabled new modules.
DrupalWebTestCase::storeSetupCache protected function Store the installation setup to a cache.
DrupalWebTestCase::tearDown protected function Delete created files and temporary files directory, delete the tables created by setUp(), and reset the database prefix. 6
DrupalWebTestCase::verboseEmail protected function Outputs to verbose the most recent $count emails sent.
DrupalWebTestCase::xpath protected function Perform an xpath search on the contents of the internal browser. The search is relative to the root element (HTML tag normally) of the page.
DrupalWebTestCase::__construct function Constructor for DrupalWebTestCase. Overrides DrupalTestCase::__construct 1
FieldCollectionEntityTranslationTestCase::addLanguage public function Install a specified language if it has not been already, otherwise make sure that the language is enabled.
FieldCollectionEntityTranslationTestCase::checkFieldCollectionContent protected function Check the content of the field collection for a specified language.
FieldCollectionEntityTranslationTestCase::createPage protected function Creates a basic page with a value in the field collection.
FieldCollectionEntityTranslationTestCase::createRevision protected function Creates a new revision of the node and checks the result.
FieldCollectionEntityTranslationTestCase::createTranslation protected function Creates a translation programmatically using Entity Translation.
FieldCollectionEntityTranslationTestCase::createTranslationForm protected function Create a translation using the Entity Translation Form.
FieldCollectionEntityTranslationTestCase::getAdminUser public function Returns a user with administration rights.
FieldCollectionEntityTranslationTestCase::getFieldValues protected function Returns the text field values of an specified node, language and delta.
FieldCollectionEntityTranslationTestCase::getInfo public static function
FieldCollectionEntityTranslationTestCase::getTranslatorUser public function Returns a user with minimal translation rights.
FieldCollectionEntityTranslationTestCase::login public function Login the given user only if she has not changed.
FieldCollectionEntityTranslationTestCase::NUM_VALUES constant
FieldCollectionEntityTranslationTestCase::removeTranslation protected function Removes a translation programmatically using the entity translation api.
FieldCollectionEntityTranslationTestCase::removeTranslationForm protected function Removes a translation using the entity translation form.
FieldCollectionEntityTranslationTestCase::setUp public function Sets up a Drupal site for running functional and integration tests. Overrides DrupalWebTestCase::setUp
FieldCollectionEntityTranslationTestCase::testEntityTranslation public function Ensures the right behaviour in all Entity Translation use cases.
FieldCollectionEntityTranslationTestCase::TRANS_FIELD_DE constant
FieldCollectionEntityTranslationTestCase::TRANS_FIELD_DE_MOD constant
FieldCollectionEntityTranslationTestCase::TRANS_FIELD_EN constant
FieldCollectionEntityTranslationTestCase::UNTRANS_FIELD_DE constant
FieldCollectionEntityTranslationTestCase::UNTRANS_FIELD_DE_MOD constant
FieldCollectionEntityTranslationTestCase::UNTRANS_FIELD_EN constant