You are here

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

class DisplayTest in Zircon Profile 8

Same name in this branch
  1. 8 core/modules/views_ui/src/Tests/DisplayTest.php \Drupal\views_ui\Tests\DisplayTest
  2. 8 core/modules/views/src/Tests/Plugin/DisplayTest.php \Drupal\views\Tests\Plugin\DisplayTest
  3. 8 core/modules/views/tests/modules/views_test_data/src/Plugin/views/display/DisplayTest.php \Drupal\views_test_data\Plugin\views\display\DisplayTest
Same name and namespace in other branches
  1. 8.0 core/modules/views/src/Tests/Plugin/DisplayTest.php \Drupal\views\Tests\Plugin\DisplayTest

Tests the basic display plugin.

@group views

Hierarchy

Expanded class hierarchy of DisplayTest

1 string reference to 'DisplayTest'
DisplayTest::calculateDependencies in core/modules/views/tests/modules/views_test_data/src/Plugin/views/display/DisplayTest.php
Calculates dependencies for the configured plugin.

File

core/modules/views/src/Tests/Plugin/DisplayTest.php, line 19
Contains \Drupal\views\Tests\Plugin\DisplayTest.

Namespace

Drupal\views\Tests\Plugin
View source 
class DisplayTest extends PluginTestBase {

  /**
   * Views used by this test.
   *
   * @var array
   */
  public static $testViews = array(
    'test_filter_groups',
    'test_get_attach_displays',
    'test_view',
    'test_display_more',
    'test_display_invalid',
    'test_display_empty',
  );

  /**
   * Modules to enable.
   *
   * @var array
   */
  public static $modules = array(
    'views_ui',
    'node',
    'block',
  );
  protected function setUp() {
    parent::setUp();
    $this
      ->enableViewsTestModule();
    $this->adminUser = $this
      ->drupalCreateUser(array(
      'administer views',
    ));
    $this
      ->drupalLogin($this->adminUser);

    // Create 10 nodes.
    for ($i = 0; $i <= 10; $i++) {
      $this
        ->drupalCreateNode(array(
        'promote' => TRUE,
      ));
    }
  }

  /**
   * Tests the display test plugin.
   *
   * @see \Drupal\views_test_data\Plugin\views\display\DisplayTest
   */
  public function testDisplayPlugin() {

    /** @var \Drupal\Core\Render\RendererInterface $renderer */
    $renderer = $this->container
      ->get('renderer');
    $view = Views::getView('test_view');

    // Add a new 'display_test' display and test it's there.
    $view->storage
      ->addDisplay('display_test');
    $displays = $view->storage
      ->get('display');
    $this
      ->assertTrue(isset($displays['display_test_1']), 'Added display has been assigned to "display_test_1"');

    // Check the display options are like expected.
    $options = array(
      'display_options' => array(),
      'display_plugin' => 'display_test',
      'id' => 'display_test_1',
      'display_title' => 'Display test',
      'position' => 1,
    );
    $this
      ->assertEqual($displays['display_test_1'], $options);

    // Add another one to ensure that position is counted up.
    $view->storage
      ->addDisplay('display_test');
    $displays = $view->storage
      ->get('display');
    $options = array(
      'display_options' => array(),
      'display_plugin' => 'display_test',
      'id' => 'display_test_2',
      'display_title' => 'Display test 2',
      'position' => 2,
    );
    $this
      ->assertEqual($displays['display_test_2'], $options);

    // Move the second display before the first one in order to test custom
    // sorting.
    $displays['display_test_1']['position'] = 2;
    $displays['display_test_2']['position'] = 1;
    $view->storage
      ->set('display', $displays);
    $view
      ->save();
    $view
      ->setDisplay('display_test_1');
    $this
      ->assertTrue($view->display_handler instanceof DisplayTestPlugin, 'The correct display handler instance is on the view object.');

    // Check the test option.
    $this
      ->assertIdentical($view->display_handler
      ->getOption('test_option'), '');
    $output = $view
      ->preview();
    $output = $renderer
      ->renderRoot($output);
    $this
      ->assertTrue(strpos($output, '<h1></h1>') !== FALSE, 'An empty value for test_option found in output.');

    // Change this option and check the title of out output.
    $view->display_handler
      ->overrideOption('test_option', 'Test option title');
    $view
      ->save();
    $output = $view
      ->preview();
    $output = $renderer
      ->renderRoot($output);

    // Test we have our custom <h1> tag in the output of the view.
    $this
      ->assertTrue(strpos($output, '<h1>Test option title</h1>') !== FALSE, 'The test_option value found in display output title.');

    // Test that the display category/summary is in the UI.
    $this
      ->drupalGet('admin/structure/views/view/test_view/edit/display_test_1');
    $this
      ->assertText('Display test settings');

    // Ensure that the order is as expected.
    $result = $this
      ->xpath('//ul[@id="views-display-menu-tabs"]/li');
    $this
      ->assertEqual((string) $result[0]->a, 'Display test 2');
    $this
      ->assertEqual((string) $result[1]->a, 'Display test');
    $this
      ->clickLink('Test option title');
    $test_option = $this
      ->randomString();
    $this
      ->drupalPostForm(NULL, array(
      'test_option' => $test_option,
    ), t('Apply'));

    // Check the new value has been saved by checking the UI summary text.
    $this
      ->drupalGet('admin/structure/views/view/test_view/edit/display_test_1');
    $this
      ->assertLink($test_option);

    // Test the enable/disable status of a display.
    $view->display_handler
      ->setOption('enabled', FALSE);
    $this
      ->assertFalse($view->display_handler
      ->isEnabled(), 'Make sure that isEnabled returns FALSE on a disabled display.');
    $view->display_handler
      ->setOption('enabled', TRUE);
    $this
      ->assertTrue($view->display_handler
      ->isEnabled(), 'Make sure that isEnabled returns TRUE on a disabled display.');
  }

  /**
   * Tests the overriding of filter_groups.
   */
  public function testFilterGroupsOverriding() {
    $view = Views::getView('test_filter_groups');
    $view
      ->initDisplay();

    // mark is as overridden, yes FALSE, means overridden.
    $view->displayHandlers
      ->get('page')
      ->setOverride('filter_groups', FALSE);
    $this
      ->assertFalse($view->displayHandlers
      ->get('page')
      ->isDefaulted('filter_groups'), "Make sure that 'filter_groups' is marked as overridden.");
    $this
      ->assertFalse($view->displayHandlers
      ->get('page')
      ->isDefaulted('filters'), "Make sure that 'filters'' is marked as overridden.");
  }

  /**
   * Tests the getAttachedDisplays method.
   */
  public function testGetAttachedDisplays() {
    $view = Views::getView('test_get_attach_displays');

    // Both the feed_1 and the feed_2 display are attached to the page display.
    $view
      ->setDisplay('page_1');
    $this
      ->assertEqual($view->display_handler
      ->getAttachedDisplays(), array(
      'feed_1',
      'feed_2',
    ));
    $view
      ->setDisplay('feed_1');
    $this
      ->assertEqual($view->display_handler
      ->getAttachedDisplays(), array());
  }

  /**
   * Tests the readmore functionality.
   */
  public function testReadMore() {

    /** @var \Drupal\Core\Render\RendererInterface $renderer */
    $renderer = $this->container
      ->get('renderer');
    if (!isset($this->options['validate']['type'])) {
      return;
    }
    $expected_more_text = 'custom more text';
    $view = Views::getView('test_display_more');
    $this
      ->executeView($view);
    $output = $view
      ->preview();
    $output = $renderer
      ->renderRoot($output);
    $this
      ->setRawContent($output);
    $result = $this
      ->xpath('//a[@class=:class]', array(
      ':class' => 'more-link',
    ));
    $this
      ->assertEqual($result[0]
      ->attributes()->href, \Drupal::url('view.test_display_more.page_1'), 'The right more link is shown.');
    $this
      ->assertEqual(trim($result[0][0]), $expected_more_text, 'The right link text is shown.');

    // Test the renderMoreLink method directly. This could be directly unit
    // tested.
    $more_link = $view->display_handler
      ->renderMoreLink();
    $more_link = $renderer
      ->renderRoot($more_link);
    $this
      ->setRawContent($more_link);
    $result = $this
      ->xpath('//a[@class=:class]', array(
      ':class' => 'more-link',
    ));
    $this
      ->assertEqual($result[0]
      ->attributes()->href, \Drupal::url('view.test_display_more.page_1'), 'The right more link is shown.');
    $this
      ->assertEqual(trim($result[0][0]), $expected_more_text, 'The right link text is shown.');

    // Test the useMoreText method directly. This could be directly unit
    // tested.
    $more_text = $view->display_handler
      ->useMoreText();
    $this
      ->assertEqual($more_text, $expected_more_text, 'The right more text is chosen.');
    $view = Views::getView('test_display_more');
    $view
      ->setDisplay();
    $view->display_handler
      ->setOption('use_more', 0);
    $this
      ->executeView($view);
    $output = $view
      ->preview();
    $output = $renderer
      ->renderRoot($output);
    $this
      ->setRawContent($output);
    $result = $this
      ->xpath('//a[@class=:class]', array(
      ':class' => 'more-link',
    ));
    $this
      ->assertTrue(empty($result), 'The more link is not shown.');
    $view = Views::getView('test_display_more');
    $view
      ->setDisplay();
    $view->display_handler
      ->setOption('use_more', 0);
    $view->display_handler
      ->setOption('use_more_always', 0);
    $view->display_handler
      ->setOption('pager', array(
      'type' => 'some',
      'options' => array(
        'items_per_page' => 1,
        'offset' => 0,
      ),
    ));
    $this
      ->executeView($view);
    $output = $view
      ->preview();
    $output = $renderer
      ->renderRoot($output);
    $this
      ->setRawContent($output);
    $result = $this
      ->xpath('//a[@class=:class]', array(
      ':class' => 'more-link',
    ));
    $this
      ->assertTrue(empty($result), 'The more link is not shown when view has more records.');

    // Test the default value of use_more_always.
    $view = entity_create('view')
      ->getExecutable();
    $this
      ->assertTrue($view
      ->getDisplay()
      ->getOption('use_more_always'), 'Always display the more link by default.');
  }

  /**
   * Tests the readmore validation.
   */
  public function testReadMoreNoDisplay() {
    $view = Views::getView('test_display_more');

    // Confirm that the view validates when there is a page display.
    $errors = $view
      ->validate();
    $this
      ->assertTrue(empty($errors), 'More link validation has no errors.');

    // Confirm that the view does not validate when the page display is disabled.
    $view
      ->setDisplay('page_1');
    $view->display_handler
      ->setOption('enabled', FALSE);
    $view
      ->setDisplay('default');
    $errors = $view
      ->validate();
    $this
      ->assertTrue(!empty($errors), 'More link validation has some errors.');
    $this
      ->assertEqual($errors['default'][0], 'Display "Master" uses a "more" link but there are no displays it can link to. You need to specify a custom URL.', 'More link validation has the right error.');

    // Confirm that the view does not validate when the page display does not exist.
    $view = Views::getView('test_view');
    $view
      ->setDisplay('default');
    $view->display_handler
      ->setOption('use_more', 1);
    $errors = $view
      ->validate();
    $this
      ->assertTrue(!empty($errors), 'More link validation has some errors.');
    $this
      ->assertEqual($errors['default'][0], 'Display "Master" uses a "more" link but there are no displays it can link to. You need to specify a custom URL.', 'More link validation has the right error.');
  }

  /**
   * Tests invalid display plugins.
   */
  public function testInvalidDisplayPlugins() {
    $this
      ->drupalGet('test_display_invalid');
    $this
      ->assertResponse(200);

    // Change the page plugin id to an invalid one. Bypass the entity system
    // so no menu rebuild was executed (so the path is still available).
    $config = $this
      ->config('views.view.test_display_invalid');
    $config
      ->set('display.page_1.display_plugin', 'invalid');
    $config
      ->save();
    $this
      ->drupalGet('test_display_invalid');
    $this
      ->assertResponse(200);
    $this
      ->assertText('The &quot;invalid&quot; plugin does not exist.');

    // Rebuild the router, and ensure that the path is not accessible anymore.
    views_invalidate_cache();
    \Drupal::service('router.builder')
      ->rebuildIfNeeded();
    $this
      ->drupalGet('test_display_invalid');
    $this
      ->assertResponse(404);

    // Change the display plugin ID back to the correct ID.
    $config = $this
      ->config('views.view.test_display_invalid');
    $config
      ->set('display.page_1.display_plugin', 'page');
    $config
      ->save();

    // Place the block display.
    $block = $this
      ->drupalPlaceBlock('views_block:test_display_invalid-block_1', array(), array(
      'title' => 'Invalid display',
    ));
    $this
      ->drupalGet('<front>');
    $this
      ->assertResponse(200);
    $this
      ->assertBlockAppears($block);

    // Change the block plugin ID to an invalid one.
    $config = $this
      ->config('views.view.test_display_invalid');
    $config
      ->set('display.block_1.display_plugin', 'invalid');
    $config
      ->save();

    // Test the page is still displayed, the block not present, and has the
    // plugin warning message.
    $this
      ->drupalGet('<front>');
    $this
      ->assertResponse(200);
    $this
      ->assertText('The &quot;invalid&quot; plugin does not exist.');
    $this
      ->assertNoBlockAppears($block);
  }

  /**
   * Tests the outputIsEmpty method on the display.
   */
  public function testOutputIsEmpty() {
    $view = Views::getView('test_display_empty');
    $this
      ->executeView($view);
    $this
      ->assertTrue(count($view->result) > 0, 'Ensure the result of the view is not empty.');
    $this
      ->assertFalse($view->display_handler
      ->outputIsEmpty(), 'Ensure the view output is marked as not empty.');
    $view
      ->destroy();

    // Add a filter, so the view result is empty.
    $view
      ->setDisplay('default');
    $item = array(
      'table' => 'views_test_data',
      'field' => 'id',
      'id' => 'id',
      'value' => array(
        'value' => 7297,
      ),
    );
    $view
      ->setHandler('default', 'filter', 'id', $item);
    $this
      ->executeView($view);
    $this
      ->assertFalse(count($view->result), 'Ensure the result of the view is empty.');
    $this
      ->assertFalse($view->display_handler
      ->outputIsEmpty(), 'Ensure the view output is marked as not empty, because the empty text still appears.');
    $view
      ->destroy();

    // Remove the empty area, but mark the header area to still appear.
    $view
      ->removeHandler('default', 'empty', 'area');
    $item = $view
      ->getHandler('default', 'header', 'area');
    $item['empty'] = TRUE;
    $view
      ->setHandler('default', 'header', 'area', $item);
    $this
      ->executeView($view);
    $this
      ->assertFalse(count($view->result), 'Ensure the result of the view is empty.');
    $this
      ->assertFalse($view->display_handler
      ->outputIsEmpty(), 'Ensure the view output is marked as not empty, because the header text still appears.');
    $view
      ->destroy();

    // Hide the header on empty results.
    $item = $view
      ->getHandler('default', 'header', 'area');
    $item['empty'] = FALSE;
    $view
      ->setHandler('default', 'header', 'area', $item);
    $this
      ->executeView($view);
    $this
      ->assertFalse(count($view->result), 'Ensure the result of the view is empty.');
    $this
      ->assertTrue($view->display_handler
      ->outputIsEmpty(), 'Ensure the view output is marked as empty.');
  }

  /**
   * Test translation rendering settings based on entity translatability.
   */
  public function testTranslationSetting() {
    \Drupal::service('module_installer')
      ->install([
      'file',
    ]);
    \Drupal::service('router.builder')
      ->rebuild();

    // By default there should be no language settings.
    $this
      ->checkTranslationSetting();
    \Drupal::service('module_installer')
      ->install([
      'language',
    ]);

    // Enabling the language module should not make a difference.
    $this
      ->checkTranslationSetting();

    // Making the site multilingual should let translatable entity types support
    // translation rendering.
    ConfigurableLanguage::createFromLangcode('it')
      ->save();
    $this
      ->checkTranslationSetting(TRUE);
  }

  /**
   * Asserts a node and a file based view for the translation setting.
   *
   * The file based view should never expose that setting. The node based view
   * should if the site is multilingual.
   *
   * @param bool $expected_node_translatability
   *   Whether the node based view should be expected to support translation
   *   settings.
   */
  protected function checkTranslationSetting($expected_node_translatability = FALSE) {
    $not_supported_text = 'The view is not based on a translatable entity type or the site is not multilingual.';
    $supported_text = 'All content that supports translations will be displayed in the selected language.';
    $this
      ->drupalGet('admin/structure/views/nojs/display/content/page_1/rendering_language');
    if ($expected_node_translatability) {
      $this
        ->assertNoText($not_supported_text);
      $this
        ->assertText($supported_text);
    }
    else {
      $this
        ->assertText($not_supported_text);
      $this
        ->assertNoText($supported_text);
    }
    $this
      ->drupalGet('admin/structure/views/nojs/display/files/page_1/rendering_language');
    $this
      ->assertText($not_supported_text);
    $this
      ->assertNoText($supported_text);
  }

}

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.
DisplayTest::$modules public static property Modules to enable. Overrides ViewTestBase::$modules
DisplayTest::$testViews public static property Views used by this test.
DisplayTest::checkTranslationSetting protected function Asserts a node and a file based view for the translation setting.
DisplayTest::setUp protected function Sets up a Drupal site for running functional and integration tests. Overrides ViewTestBase::setUp
DisplayTest::testDisplayPlugin public function Tests the display test plugin.
DisplayTest::testFilterGroupsOverriding public function Tests the overriding of filter_groups.
DisplayTest::testGetAttachedDisplays public function Tests the getAttachedDisplays method.
DisplayTest::testInvalidDisplayPlugins public function Tests invalid display plugins.
DisplayTest::testOutputIsEmpty public function Tests the outputIsEmpty method on the display.
DisplayTest::testReadMore public function Tests the readmore functionality.
DisplayTest::testReadMoreNoDisplay public function Tests the readmore validation.
DisplayTest::testTranslationSetting public function Test translation rendering settings based on entity translatability.
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::$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::$originalSite protected property The site directory of the original parent site.
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::beforePrepareEnvironment protected function Act on global state information before the environment is altered for a test. 1
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.
UserCreationTrait::checkPermissions protected function Checks whether a given list of permission names is valid.
UserCreationTrait::createAdminRole protected function Creates an administrative role. Aliased as: drupalCreateAdminRole
UserCreationTrait::createRole protected function Creates a role with specified permissions. Aliased as: drupalCreateRole
UserCreationTrait::createUser protected function Create a user with a given set of permissions. Aliased as: drupalCreateUser
UserCreationTrait::grantPermissions protected function Grant permissions to a user role.
UserCreationTrait::setCurrentUser protected function Switch the current logged in user.
ViewResultAssertionTrait::assertIdenticalResultset protected function Verifies that a result set returned by a View matches expected values.
ViewResultAssertionTrait::assertIdenticalResultsetHelper protected function Performs View result assertions.
ViewResultAssertionTrait::assertNotIdenticalResultset protected function Verifies that a result set returned by a View differs from certain values.
ViewTestBase::dataSet protected function Returns a very simple test dataset. 1
ViewTestBase::enableViewsTestModule protected function Sets up the views_test_data.module.
ViewTestBase::executeView protected function Executes a view with debugging.
ViewTestBase::helperButtonHasLabel protected function Asserts the existence of a button with a certain ID and label.
ViewTestBase::orderResultSet protected function Orders a nested array containing a result set based on a given column.
ViewTestBase::schemaDefinition protected function Returns the schema definition. 1
ViewTestBase::viewsData protected function Returns the views data definition. 8
WebTestBase::$additionalCurlOptions protected property Additional cURL options.
WebTestBase::$assertAjaxHeader protected property Whether or not to assert the presence of the X-Drupal-Ajax-Token.
WebTestBase::$classLoader protected property The class loader to use for installation and initialization of setup.
WebTestBase::$configDirectories protected property The config directories used in this test.
WebTestBase::$cookieFile protected property The current cookie file used by cURL.
WebTestBase::$cookies protected property The cookies of the page currently loaded in the internal browser.
WebTestBase::$curlCookies protected property Cookies to set on curl requests.
WebTestBase::$curlHandle protected property The handle of the current cURL connection.
WebTestBase::$customTranslations protected property An array of custom translations suitable for drupal_rewrite_settings().
WebTestBase::$dumpHeaders protected property Indicates that headers should be dumped if verbose output is enabled. 12
WebTestBase::$generatedTestFiles protected property Whether the files were copied to the test files directory.
WebTestBase::$headers protected property The headers of the page currently loaded in the internal browser.
WebTestBase::$kernel protected property The kernel used in this test. Overrides TestBase::$kernel
WebTestBase::$loggedInUser protected property The current user logged in using the internal browser.
WebTestBase::$maximumMetaRefreshCount protected property The number of meta refresh redirects to follow, or NULL if unlimited.
WebTestBase::$maximumRedirects protected property The maximum number of redirects to follow when handling responses.
WebTestBase::$metaRefreshCount protected property The number of meta refresh redirects followed during ::drupalGet().
WebTestBase::$originalBatch protected property The original batch, before it was changed for testing purposes.
WebTestBase::$originalShutdownCallbacks protected property The original shutdown handlers array, before it was cleaned for testing. Overrides TestBase::$originalShutdownCallbacks
WebTestBase::$originalUser protected property The original user, before it was changed to a clean uid = 1 for testing. Overrides TestBase::$originalUser
WebTestBase::$profile protected property The profile to install as a basis for testing. 30
WebTestBase::$redirectCount protected property The number of redirects followed during the handling of a request.
WebTestBase::$rootUser protected property The "#1" admin user.
WebTestBase::$sessionId protected property The current session ID, if available.
WebTestBase::$url protected property The URL currently loaded in the internal browser.
WebTestBase::addCustomTranslations protected function Queues custom translations to be written to settings.php.
WebTestBase::assertBlockAppears protected function Checks to see whether a block appears on the page.
WebTestBase::assertCacheContext protected function Asserts whether an expected cache context was present in the last response.
WebTestBase::assertCacheTag protected function Asserts whether an expected cache tag was present in the last response.
WebTestBase::assertHeader protected function Check if a HTTP response header exists and has the expected value.
WebTestBase::assertMail protected function Asserts that the most recently sent email message has the given value.
WebTestBase::assertMailPattern protected function Asserts that the most recently sent email message has the pattern in it.
WebTestBase::assertMailString protected function Asserts that the most recently sent email message has the string in it.
WebTestBase::assertNoBlockAppears protected function Checks to see whether a block does not appears on the page.
WebTestBase::assertNoCacheContext protected function Asserts that a cache context was not present in the last response.
WebTestBase::assertNoCacheTag protected function Asserts whether an expected cache tag was absent in the last response.
WebTestBase::assertNoResponse protected function Asserts the page did not return the specified response code.
WebTestBase::assertResponse protected function Asserts the page responds with the specified response code.
WebTestBase::assertUrl protected function Passes if the internal browser's URL matches the given path.
WebTestBase::buildUrl protected function Builds an a absolute URL from a system path or a URL object.
WebTestBase::checkForMetaRefresh protected function Checks for meta refresh tag and if found call drupalGet() recursively.
WebTestBase::clickLink protected function Follows a link by complete name.
WebTestBase::clickLinkHelper protected function Provides a helper for ::clickLink() and ::clickLinkPartialName().
WebTestBase::clickLinkPartialName protected function Follows a link by partial name.
WebTestBase::cronRun protected function Runs cron in the Drupal installed by Simpletest.
WebTestBase::curlClose protected function Close the cURL handler and unset the handler.
WebTestBase::curlExec protected function Initializes and executes a cURL request. 2
WebTestBase::curlHeaderCallback protected function Reads headers and registers errors received from the tested site.
WebTestBase::curlInitialize protected function Initializes the cURL connection.
WebTestBase::doInstall protected function Execute the non-interactive installer.
WebTestBase::drupalBuildEntityView protected function Builds the renderable view of an entity.
WebTestBase::drupalCompareFiles protected function Compare two files based on size and file name.
WebTestBase::drupalCreateContentType protected function Creates a custom content type based on default settings.
WebTestBase::drupalCreateNode protected function Creates a node based on default settings.
WebTestBase::drupalGet protected function Retrieves a Drupal path or an absolute path. 1
WebTestBase::drupalGetAjax protected function Requests a path or URL in drupal_ajax format and JSON-decodes the response.
WebTestBase::drupalGetHeader protected function Gets the value of an HTTP response header.
WebTestBase::drupalGetHeaders protected function Gets the HTTP response headers of the requested page.
WebTestBase::drupalGetJSON protected function Retrieves a Drupal path or an absolute path and JSON decodes the result.
WebTestBase::drupalGetMails protected function Gets an array containing all emails sent during this test case.
WebTestBase::drupalGetNodeByTitle function Get a node from the database based on its title.
WebTestBase::drupalGetTestFiles protected function Gets a list of files that can be used in tests.
WebTestBase::drupalGetWithFormat protected function Retrieves a Drupal path or an absolute path for a given format.
WebTestBase::drupalGetXHR protected function Requests a Drupal path or an absolute path as if it is a XMLHttpRequest.
WebTestBase::drupalHead protected function Retrieves only the headers for a Drupal path or an absolute path.
WebTestBase::drupalLogin protected function Log in a user with the internal browser.
WebTestBase::drupalLogout protected function Logs a user out of the internal browser and confirms.
WebTestBase::drupalPlaceBlock protected function Creates a block instance based on default settings.
WebTestBase::drupalPost protected function Perform a POST HTTP request.
WebTestBase::drupalPostAjaxForm protected function Executes an Ajax form submission.
WebTestBase::drupalPostForm protected function Executes a form submission.
WebTestBase::drupalPostWithFormat protected function Performs a POST HTTP request with a specific format.
WebTestBase::drupalProcessAjaxResponse protected function Processes an AJAX response into current content.
WebTestBase::drupalUserIsLoggedIn protected function Returns whether a given user account is logged in.
WebTestBase::findBlockInstance protected function Find a block instance on the page.
WebTestBase::getAbsoluteUrl protected function Takes a path and returns an absolute path.
WebTestBase::getAjaxPageStatePostData protected function Get the Ajax page state from drupalSettings and prepare it for POSTing.
WebTestBase::getDatabaseTypes protected function Returns all supported database driver installer objects.
WebTestBase::handleForm protected function Handles form input related to drupalPostForm().
WebTestBase::initConfig protected function Initialize various configurations post-installation.
WebTestBase::initKernel protected function Initializes the kernel after installation.
WebTestBase::initSettings protected function Initialize settings created during install.
WebTestBase::initUserSession protected function Initializes user 1 for the site to be installed.
WebTestBase::installModulesFromClassProperty protected function Install modules defined by `static::$modules`.
WebTestBase::installParameters protected function Returns the parameters that will be used when Simpletest installs Drupal. 2
WebTestBase::isInChildSite protected function Returns whether the test is being executed from within a test site.
WebTestBase::prepareRequestForGenerator protected function Creates a mock request and sets it on the generator.
WebTestBase::prepareSettings protected function Prepares site settings and services before installation. 1
WebTestBase::rebuildAll protected function Reset and rebuild the environment after setup.
WebTestBase::rebuildContainer protected function Rebuilds \Drupal::getContainer().
WebTestBase::refreshVariables protected function Refreshes in-memory configuration and state information. 1
WebTestBase::resetAll protected function Resets all data structures after having enabled new modules.
WebTestBase::restoreBatch protected function Restore the original batch.
WebTestBase::serializePostValues protected function Serialize POST HTTP request values.
WebTestBase::setBatch protected function Preserve the original batch, and instantiate the test batch.
WebTestBase::setContainerParameter protected function Changes parameters in the services.yml file.
WebTestBase::setHttpResponseDebugCacheabilityHeaders protected function Enables/disables the cacheability headers.
WebTestBase::tearDown protected function Cleans up after testing. Overrides TestBase::tearDown 2
WebTestBase::translatePostValues protected function Transforms a nested array into a flat array suitable for WebTestBase::drupalPostForm().
WebTestBase::verboseEmail protected function Outputs to verbose the most recent $count emails sent.
WebTestBase::writeCustomTranslations protected function Writes custom translations to the test site's settings.php.
WebTestBase::writeSettings protected function Rewrites the settings.php file of the test site.
WebTestBase::__construct function Constructor for \Drupal\simpletest\WebTestBase. Overrides TestBase::__construct 1