You are here

class HandlerTest in Drupal 8

Same name in this branch
  1. 8 core/modules/views_ui/tests/src/Functional/HandlerTest.php \Drupal\Tests\views_ui\Functional\HandlerTest
  2. 8 core/modules/views/tests/src/Functional/Handler/HandlerTest.php \Drupal\Tests\views\Functional\Handler\HandlerTest
Same name and namespace in other branches
  1. 9 core/modules/views/tests/src/Functional/Handler/HandlerTest.php \Drupal\Tests\views\Functional\Handler\HandlerTest

Tests abstract handler definitions.

@group views

Hierarchy

Expanded class hierarchy of HandlerTest

File

core/modules/views/tests/src/Functional/Handler/HandlerTest.php, line 17

Namespace

Drupal\Tests\views\Functional\Handler
View source
class HandlerTest extends ViewTestBase {
  use CommentTestTrait;

  /**
   * Views used by this test.
   *
   * @var array
   */
  public static $testViews = [
    'test_view',
    'test_view_handler_weight',
    'test_handler_relationships',
    'test_handler_test_access',
    'test_filter_in_operator_ui',
  ];

  /**
   * Modules to enable.
   *
   * @var array
   */
  public static $modules = [
    'views_ui',
    'comment',
    'node',
  ];

  /**
   * {@inheritdoc}
   */
  protected $defaultTheme = 'stark';
  protected function setUp($import_test_views = TRUE) {
    parent::setUp($import_test_views);
    $this
      ->drupalCreateContentType([
      'type' => 'page',
    ]);
    $this
      ->addDefaultCommentField('node', 'page');
    $this
      ->enableViewsTestModule();
  }

  /**
   * {@inheritdoc}
   */
  protected function viewsData() {
    $data = parent::viewsData();

    // Override the name handler to be able to call placeholder() from outside.
    $data['views_test_data']['name']['field']['id'] = 'test_field';

    // Setup one field with an access callback and one with an access callback
    // and arguments.
    $data['views_test_data']['access_callback'] = $data['views_test_data']['id'];
    $data['views_test_data']['access_callback_arguments'] = $data['views_test_data']['id'];
    foreach (ViewExecutable::getHandlerTypes() as $type => $info) {
      if (isset($data['views_test_data']['access_callback'][$type]['id'])) {
        $data['views_test_data']['access_callback'][$type]['access callback'] = 'views_test_data_handler_test_access_callback';
        $data['views_test_data']['access_callback_arguments'][$type]['access callback'] = 'views_test_data_handler_test_access_callback_argument';
        $data['views_test_data']['access_callback_arguments'][$type]['access arguments'] = [
          TRUE,
        ];
      }
    }
    return $data;
  }

  /**
   * Tests the breakString method.
   */
  public function testBreakString() {

    // Check defaults.
    $this
      ->assertEqual((object) [
      'value' => [],
      'operator' => NULL,
    ], HandlerBase::breakString(''));

    // Test ors
    $handler = HandlerBase::breakString('word1 word2+word');
    $this
      ->assertEqualValue([
      'word1',
      'word2',
      'word',
    ], $handler);
    $this
      ->assertEqual('or', $handler->operator);
    $handler = HandlerBase::breakString('word1+word2+word');
    $this
      ->assertEqualValue([
      'word1',
      'word2',
      'word',
    ], $handler);
    $this
      ->assertEqual('or', $handler->operator);
    $handler = HandlerBase::breakString('word1 word2 word');
    $this
      ->assertEqualValue([
      'word1',
      'word2',
      'word',
    ], $handler);
    $this
      ->assertEqual('or', $handler->operator);
    $handler = HandlerBase::breakString('word-1+word-2+word');
    $this
      ->assertEqualValue([
      'word-1',
      'word-2',
      'word',
    ], $handler);
    $this
      ->assertEqual('or', $handler->operator);
    $handler = HandlerBase::breakString('wõrd1+wõrd2+wõrd');
    $this
      ->assertEqualValue([
      'wõrd1',
      'wõrd2',
      'wõrd',
    ], $handler);
    $this
      ->assertEqual('or', $handler->operator);

    // Test ands.
    $handler = HandlerBase::breakString('word1,word2,word');
    $this
      ->assertEqualValue([
      'word1',
      'word2',
      'word',
    ], $handler);
    $this
      ->assertEqual('and', $handler->operator);
    $handler = HandlerBase::breakString('word1 word2,word');
    $this
      ->assertEqualValue([
      'word1 word2',
      'word',
    ], $handler);
    $this
      ->assertEqual('and', $handler->operator);
    $handler = HandlerBase::breakString('word1,word2 word');
    $this
      ->assertEqualValue([
      'word1',
      'word2 word',
    ], $handler);
    $this
      ->assertEqual('and', $handler->operator);
    $handler = HandlerBase::breakString('word-1,word-2,word');
    $this
      ->assertEqualValue([
      'word-1',
      'word-2',
      'word',
    ], $handler);
    $this
      ->assertEqual('and', $handler->operator);
    $handler = HandlerBase::breakString('wõrd1,wõrd2,wõrd');
    $this
      ->assertEqualValue([
      'wõrd1',
      'wõrd2',
      'wõrd',
    ], $handler);
    $this
      ->assertEqual('and', $handler->operator);

    // Test a single word
    $handler = HandlerBase::breakString('word');
    $this
      ->assertEqualValue([
      'word',
    ], $handler);
    $this
      ->assertEqual('and', $handler->operator);
    $s1 = $this
      ->randomMachineName();

    // Generate three random numbers which can be used below;
    $n1 = rand(0, 100);
    $n2 = rand(0, 100);
    $n3 = rand(0, 100);

    // Test "or"s.
    $handlerBase = HandlerBase::breakString("{$s1} {$n2}+{$n3}");
    $this
      ->assertEqualValue([
      $s1,
      $n2,
      $n3,
    ], $handlerBase);
    $this
      ->assertEqual('or', $handlerBase->operator);
    $handlerBase = HandlerBase::breakString("{$s1}+{$n2}+{$n3}");
    $this
      ->assertEqualValue([
      $s1,
      $n2,
      $n3,
    ], $handlerBase);
    $this
      ->assertEqual('or', $handlerBase->operator);
    $handlerBase = HandlerBase::breakString("{$s1} {$n2} {$n3}");
    $this
      ->assertEqualValue([
      $s1,
      $n2,
      $n3,
    ], $handlerBase);
    $this
      ->assertEqual('or', $handlerBase->operator);
    $handlerBase = HandlerBase::breakString("{$s1} {$n2}++{$n3}");
    $this
      ->assertEqualValue([
      $s1,
      $n2,
      $n3,
    ], $handlerBase);
    $this
      ->assertEqual('or', $handlerBase->operator);

    // Test "and"s.
    $handlerBase = HandlerBase::breakString("{$s1},{$n2},{$n3}");
    $this
      ->assertEqualValue([
      $s1,
      $n2,
      $n3,
    ], $handlerBase);
    $this
      ->assertEqual('and', $handlerBase->operator);
    $handlerBase = HandlerBase::breakString("{$s1},,{$n2},{$n3}");
    $this
      ->assertEqualValue([
      $s1,
      $n2,
      $n3,
    ], $handlerBase);
    $this
      ->assertEqual('and', $handlerBase->operator);

    // Enforce int values.
    $handlerBase = HandlerBase::breakString("{$n1},{$n2},{$n3}", TRUE);
    $this
      ->assertEqualValue([
      $n1,
      $n2,
      $n3,
    ], $handlerBase);
    $this
      ->assertEqual('and', $handlerBase->operator);
    $handlerBase = HandlerBase::breakString("{$n1}+{$n2}+{$n3}", TRUE);
    $this
      ->assertEqualValue([
      $n1,
      $n2,
      $n3,
    ], $handlerBase);
    $this
      ->assertEqual('or', $handlerBase->operator);
    $handlerBase = HandlerBase::breakString("{$s1},{$n2},{$n3}", TRUE);
    $this
      ->assertEqualValue([
      (int) $s1,
      $n2,
      $n3,
    ], $handlerBase);
    $this
      ->assertEqual('and', $handlerBase->operator);
    $handlerBase = HandlerBase::breakString("{$s1}+{$n2}+{$n3}", TRUE);
    $this
      ->assertEqualValue([
      (int) $s1,
      $n2,
      $n3,
    ], $handlerBase);
    $this
      ->assertEqual('or', $handlerBase->operator);

    // Generate three random decimals which can be used below;
    $d1 = rand(0, 10) / 10;
    $d2 = rand(0, 10) / 10;
    $d3 = rand(0, 10) / 10;

    // Test "or"s.
    $handlerBase = HandlerBase::breakString("{$s1} {$d1}+{$d2}");
    $this
      ->assertEqualValue([
      $s1,
      $d1,
      $d2,
    ], $handlerBase);
    $this
      ->assertEqual('or', $handlerBase->operator);
    $handlerBase = HandlerBase::breakString("{$s1}+{$d1}+{$d3}");
    $this
      ->assertEqualValue([
      $s1,
      $d1,
      $d3,
    ], $handlerBase);
    $this
      ->assertEqual('or', $handlerBase->operator);
    $handlerBase = HandlerBase::breakString("{$s1} {$d2} {$d3}");
    $this
      ->assertEqualValue([
      $s1,
      $d2,
      $d3,
    ], $handlerBase);
    $this
      ->assertEqual('or', $handlerBase->operator);
    $handlerBase = HandlerBase::breakString("{$s1} {$d2}++{$d3}");
    $this
      ->assertEqualValue([
      $s1,
      $d2,
      $d3,
    ], $handlerBase);
    $this
      ->assertEqual('or', $handlerBase->operator);

    // Test "and"s.
    $handlerBase = HandlerBase::breakString("{$s1},{$d2},{$d3}");
    $this
      ->assertEqualValue([
      $s1,
      $d2,
      $d3,
    ], $handlerBase);
    $this
      ->assertEqual('and', $handlerBase->operator);
    $handlerBase = HandlerBase::breakString("{$s1},,{$d2},{$d3}");
    $this
      ->assertEqualValue([
      $s1,
      $d2,
      $d3,
    ], $handlerBase);
    $this
      ->assertEqual('and', $handlerBase->operator);
  }

  /**
   * Tests the order of handlers is the same before and after saving.
   */
  public function testHandlerWeights() {
    $handler_types = [
      'fields',
      'filters',
      'sorts',
    ];
    $view = Views::getView('test_view_handler_weight');
    $view
      ->initDisplay();

    // Store the order of handlers before saving the view.
    $original_order = [];
    foreach ($handler_types as $type) {
      $original_order[$type] = array_keys($view->display_handler
        ->getOption($type));
    }

    // Save the view and see if our filters are in the same order.
    $view
      ->save();
    $view = views::getView('test_view_handler_weight');
    $view
      ->initDisplay();
    foreach ($handler_types as $type) {
      $loaded_order = array_keys($view->display_handler
        ->getOption($type));
      $this
        ->assertIdentical($original_order[$type], $loaded_order);
    }
  }

  /**
   * Check to see if a value is the same as the value on a certain handler.
   *
   * @param $expected
   *   The expected value to check.
   * @param \Drupal\views\Plugin\views\ViewsHandlerInterface $handler
   *   The handler that has the $handler->value property to compare with first.
   * @param string $message
   *   The message to display along with the assertion.
   * @param string $group
   *   The type of assertion - examples are "Browser", "PHP".
   *
   * @return bool
   *   TRUE if the assertion succeeded, FALSE otherwise.
   */
  protected function assertEqualValue($expected, $handler, $message = '', $group = 'Other') {
    if (empty($message)) {
      $message = t('Comparing @first and @second', [
        '@first' => implode(',', $expected),
        '@second' => implode(',', $handler->value),
      ]);
    }
    return $this
      ->assert($expected == $handler->value, $message, $group);
  }

  /**
   * Tests the relationship ui for field/filter/argument/relationship.
   */
  public function testRelationshipUI() {
    $views_admin = $this
      ->drupalCreateUser([
      'administer views',
    ]);
    $this
      ->drupalLogin($views_admin);

    // Make sure the link to the field options exists.
    $handler_options_path = 'admin/structure/views/nojs/handler/test_handler_relationships/default/field/title';
    $view_edit_path = 'admin/structure/views/view/test_handler_relationships/edit';
    $this
      ->drupalGet($view_edit_path);
    $this
      ->assertLinkByHref($handler_options_path);

    // The test view has a relationship to node_revision so the field should
    // show a relationship selection.
    $this
      ->drupalGet($handler_options_path);
    $relationship_name = 'options[relationship]';
    $this
      ->assertFieldByName($relationship_name);

    // Check for available options.
    $fields = $this
      ->getSession()
      ->getPage()
      ->findAll('named_exact', [
      'field',
      $relationship_name,
    ]);
    $options = [];
    foreach ($fields as $field) {
      $items = $field
        ->findAll('css', 'option');
      foreach ($items as $item) {
        $options[] = $item
          ->getAttribute('value');
      }
    }
    $expected_options = [
      'none',
      'nid',
    ];
    $this
      ->assertEqual($options, $expected_options);

    // Remove the relationship and make sure no relationship option appears.
    $this
      ->drupalPostForm('admin/structure/views/nojs/handler/test_handler_relationships/default/relationship/nid', [], t('Remove'));
    $this
      ->drupalGet($handler_options_path);
    $this
      ->assertNoFieldByName($relationship_name, NULL, 'Make sure that no relationship option is available');

    // Create a view of comments with node relationship.
    View::create([
      'base_table' => 'comment_field_data',
      'id' => 'test_get_entity_type',
    ])
      ->save();
    $this
      ->drupalPostForm('admin/structure/views/nojs/add-handler/test_get_entity_type/default/relationship', [
      'name[comment_field_data.node]' => 'comment_field_data.node',
    ], t('Add and configure relationships'));
    $this
      ->drupalPostForm(NULL, [], t('Apply'));

    // Add a content type filter.
    $this
      ->drupalPostForm('admin/structure/views/nojs/add-handler/test_get_entity_type/default/filter', [
      'name[node_field_data.type]' => 'node_field_data.type',
    ], t('Add and configure filter criteria'));
    $this
      ->assertOptionSelected('edit-options-relationship', 'node');
    $this
      ->drupalPostForm(NULL, [
      'options[value][page]' => 'page',
    ], t('Apply'));

    // Check content type filter options.
    $this
      ->drupalGet('admin/structure/views/nojs/handler/test_get_entity_type/default/filter/type');
    $this
      ->assertOptionSelected('edit-options-relationship', 'node');
    $this
      ->assertFieldChecked('edit-options-value-page');
  }

  /**
   * Tests the relationship method on the base class.
   */
  public function testSetRelationship() {
    $view = Views::getView('test_handler_relationships');
    $view
      ->setDisplay();

    // Setup a broken relationship.
    $view
      ->addHandler('default', 'relationship', $this
      ->randomMachineName(), $this
      ->randomMachineName(), [], 'broken_relationship');

    // Setup a valid relationship.
    $view
      ->addHandler('default', 'relationship', 'comment_field_data', 'node', [
      'relationship' => 'cid',
    ], 'valid_relationship');
    $view
      ->initHandlers();
    $field = $view->field['title'];
    $field->options['relationship'] = NULL;
    $field
      ->setRelationship();
    $this
      ->assertNull($field->relationship, 'Make sure that an empty relationship does not create a relationship on the field.');
    $field->options['relationship'] = $this
      ->randomMachineName();
    $field
      ->setRelationship();
    $this
      ->assertNull($field->relationship, 'Make sure that a random relationship does not create a relationship on the field.');
    $field->options['relationship'] = 'broken_relationship';
    $field
      ->setRelationship();
    $this
      ->assertNull($field->relationship, 'Make sure that a broken relationship does not create a relationship on the field.');
    $field->options['relationship'] = 'valid_relationship';
    $field
      ->setRelationship();
    $this
      ->assertFalse(!empty($field->relationship), 'Make sure that the relationship alias was not set without building a views query before.');

    // Remove the invalid relationship.
    unset($view->relationship['broken_relationship']);
    $view
      ->build();
    $field
      ->setRelationship();
    $this
      ->assertEqual($field->relationship, $view->relationship['valid_relationship']->alias, 'Make sure that a valid relationship does create the right relationship query alias.');
  }

  /**
   * Tests the placeholder function.
   *
   * @see \Drupal\views\Plugin\views\HandlerBase::placeholder()
   */
  public function testPlaceholder() {
    $view = Views::getView('test_view');
    $view
      ->initHandlers();
    $view
      ->initQuery();
    $handler = $view->field['name'];
    $table = $handler->table;
    $field = $handler->field;
    $string = ':' . $table . '_' . $field;

    // Make sure the placeholder variables are like expected.
    $this
      ->assertEqual($handler
      ->getPlaceholder(), $string);
    $this
      ->assertEqual($handler
      ->getPlaceholder(), $string . 1);
    $this
      ->assertEqual($handler
      ->getPlaceholder(), $string . 2);

    // Set another table/field combination and make sure there are new
    // placeholders.
    $table = $handler->table = $this
      ->randomMachineName();
    $field = $handler->field = $this
      ->randomMachineName();
    $string = ':' . $table . '_' . $field;

    // Make sure the placeholder variables are like expected.
    $this
      ->assertEqual($handler
      ->getPlaceholder(), $string);
    $this
      ->assertEqual($handler
      ->getPlaceholder(), $string . 1);
    $this
      ->assertEqual($handler
      ->getPlaceholder(), $string . 2);
  }

  /**
   * Tests access to a handler.
   *
   * @see views_test_data_handler_test_access_callback
   */
  public function testAccess() {
    $view = Views::getView('test_handler_test_access');
    $views_data = $this
      ->viewsData();
    $views_data = $views_data['views_test_data'];

    // Enable access to callback only field and deny for callback + arguments.
    $this
      ->config('views_test_data.tests')
      ->set('handler_access_callback', TRUE)
      ->save();
    $this
      ->config('views_test_data.tests')
      ->set('handler_access_callback_argument', FALSE)
      ->save();
    $view
      ->initDisplay();
    $view
      ->initHandlers();
    foreach ($views_data['access_callback'] as $type => $info) {
      if (!in_array($type, [
        'title',
        'help',
      ])) {
        $this
          ->assertInstanceOf(HandlerBase::class, $view->field['access_callback']);
        $this
          ->assertFalse(isset($view->field['access_callback_arguments']), 'Make sure the user got no access to the access_callback_arguments field ');
      }
    }

    // Enable access to the callback + argument handlers and deny for callback.
    $this
      ->config('views_test_data.tests')
      ->set('handler_access_callback', FALSE)
      ->save();
    $this
      ->config('views_test_data.tests')
      ->set('handler_access_callback_argument', TRUE)
      ->save();
    $view
      ->destroy();
    $view
      ->initDisplay();
    $view
      ->initHandlers();
    foreach ($views_data['access_callback'] as $type => $info) {
      if (!in_array($type, [
        'title',
        'help',
      ])) {
        $this
          ->assertFalse(isset($view->field['access_callback']), 'Make sure the user got no access to the access_callback field ');
        $this
          ->assertInstanceOf(HandlerBase::class, $view->field['access_callback_arguments']);
      }
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AssertHelperTrait::castSafeStrings protected static function Casts MarkupInterface objects into strings.
AssertLegacyTrait::assert protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::assertCacheTag protected function Asserts whether an expected cache tag was present in the last response.
AssertLegacyTrait::assertElementNotPresent protected function Asserts that the element with the given CSS selector is not present.
AssertLegacyTrait::assertElementPresent protected function Asserts that the element with the given CSS selector is present.
AssertLegacyTrait::assertEqual protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
AssertLegacyTrait::assertEscaped protected function Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertLegacyTrait::assertField protected function Asserts that a field exists with the given name or ID.
AssertLegacyTrait::assertFieldById protected function Asserts that a field exists with the given ID and value.
AssertLegacyTrait::assertFieldByName protected function Asserts that a field exists with the given name and value.
AssertLegacyTrait::assertFieldByXPath protected function Asserts that a field exists in the current page by the given XPath.
AssertLegacyTrait::assertFieldChecked protected function Asserts that a checkbox field in the current page is checked.
AssertLegacyTrait::assertFieldsByValue protected function Asserts that a field exists in the current page with a given Xpath result.
AssertLegacyTrait::assertHeader protected function Checks that current response header equals value.
AssertLegacyTrait::assertIdentical protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertSame() instead.
AssertLegacyTrait::assertIdenticalObject protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
AssertLegacyTrait::assertLink protected function Passes if a link with the specified label is found.
AssertLegacyTrait::assertLinkByHref protected function Passes if a link containing a given href (part) is found.
AssertLegacyTrait::assertNoCacheTag protected function Asserts whether an expected cache tag was absent in the last response.
AssertLegacyTrait::assertNoEscaped protected function Passes if the raw text is not found escaped on the loaded page.
AssertLegacyTrait::assertNoField protected function Asserts that a field does NOT exist with the given name or ID.
AssertLegacyTrait::assertNoFieldById protected function Asserts that a field does not exist with the given ID and value.
AssertLegacyTrait::assertNoFieldByName protected function Asserts that a field does not exist with the given name and value.
AssertLegacyTrait::assertNoFieldByXPath protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertLegacyTrait::assertNoFieldChecked protected function Asserts that a checkbox field in the current page is not checked.
AssertLegacyTrait::assertNoLink protected function Passes if a link with the specified label is not found.
AssertLegacyTrait::assertNoLinkByHref protected function Passes if a link containing a given href (part) is not found.
AssertLegacyTrait::assertNoOption protected function Asserts that a select option does NOT exist in the current page.
AssertLegacyTrait::assertNoPattern protected function Triggers a pass if the Perl regex pattern is not found in the raw content.
AssertLegacyTrait::assertNoRaw protected function Passes if the raw text IS not found on the loaded page, fail otherwise. 1
AssertLegacyTrait::assertNotEqual protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotEquals() instead.
AssertLegacyTrait::assertNoText protected function Passes if the page (with HTML stripped) does not contains the text. 1
AssertLegacyTrait::assertNotIdentical protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotSame() instead.
AssertLegacyTrait::assertNoUniqueText protected function Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertLegacyTrait::assertOption protected function Asserts that a select option in the current page exists.
AssertLegacyTrait::assertOptionByText protected function Asserts that a select option with the visible text exists.
AssertLegacyTrait::assertOptionSelected protected function Asserts that a select option in the current page is checked.
AssertLegacyTrait::assertPattern protected function Triggers a pass if the Perl regex pattern is found in the raw content.
AssertLegacyTrait::assertRaw protected function Passes if the raw text IS found on the loaded page, fail otherwise. 1
AssertLegacyTrait::assertResponse protected function Asserts the page responds with the specified response code. 1
AssertLegacyTrait::assertText protected function Passes if the page (with HTML stripped) contains the text. 1
AssertLegacyTrait::assertTextHelper protected function Helper for assertText and assertNoText.
AssertLegacyTrait::assertTitle protected function Pass if the page title is the given string.
AssertLegacyTrait::assertUniqueText protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertLegacyTrait::assertUrl protected function Passes if the internal browser's URL matches the given path.
AssertLegacyTrait::buildXPathQuery protected function Builds an XPath query.
AssertLegacyTrait::constructFieldXpath protected function Helper: Constructs an XPath for the given set of attributes and value.
AssertLegacyTrait::getAllOptions protected function Get all option elements, including nested options, in a select.
AssertLegacyTrait::getRawContent protected function Gets the current raw content.
AssertLegacyTrait::pass protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::verbose protected function
BlockCreationTrait::placeBlock protected function Creates a block instance based on default settings. Aliased as: drupalPlaceBlock
BrowserHtmlDebugTrait::$htmlOutputBaseUrl protected property The Base URI to use for links to the output files.
BrowserHtmlDebugTrait::$htmlOutputClassName protected property Class name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounter protected property Counter for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounterStorage protected property Counter storage for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputDirectory protected property Directory name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputEnabled protected property HTML output output enabled.
BrowserHtmlDebugTrait::$htmlOutputFile protected property The file name to write the list of URLs to.
BrowserHtmlDebugTrait::$htmlOutputTestId protected property HTML output test ID.
BrowserHtmlDebugTrait::formatHtmlOutputHeaders protected function Formats HTTP headers as string for HTML output logging.
BrowserHtmlDebugTrait::getHtmlOutputHeaders protected function Returns headers in HTML output format. 1
BrowserHtmlDebugTrait::htmlOutput protected function Logs a HTML output message in a text file.
BrowserHtmlDebugTrait::initBrowserOutputFile protected function Creates the directory to store browser output.
BrowserTestBase::$baseUrl protected property The base URL.
BrowserTestBase::$configImporter protected property The config importer that can be used in a test.
BrowserTestBase::$customTranslations protected property An array of custom translations suitable for drupal_rewrite_settings().
BrowserTestBase::$databasePrefix protected property The database prefix of this test run.
BrowserTestBase::$mink protected property Mink session manager.
BrowserTestBase::$minkDefaultDriverArgs protected property
BrowserTestBase::$minkDefaultDriverClass protected property 1
BrowserTestBase::$originalContainer protected property The original container.
BrowserTestBase::$originalShutdownCallbacks protected property The original array of shutdown function callbacks.
BrowserTestBase::$preserveGlobalState protected property
BrowserTestBase::$profile protected property The profile to install as a basis for testing. 39
BrowserTestBase::$root protected property The app root.
BrowserTestBase::$runTestInSeparateProcess protected property Browser tests are run in separate processes to prevent collisions between code that may be loaded by tests.
BrowserTestBase::$timeLimit protected property Time limit in seconds for the test.
BrowserTestBase::$translationFilesDirectory protected property The translation file directory for the test environment.
BrowserTestBase::cleanupEnvironment protected function Clean up the Simpletest environment.
BrowserTestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
BrowserTestBase::cssSelectToXpath protected function Translates a CSS expression to its XPath equivalent.
BrowserTestBase::drupalGetHeader protected function Gets the value of an HTTP response header.
BrowserTestBase::drupalGetHeaders Deprecated protected function Returns all response headers.
BrowserTestBase::filePreDeleteCallback public static function Ensures test files are deletable.
BrowserTestBase::getDefaultDriverInstance protected function Gets an instance of the default Mink driver.
BrowserTestBase::getDrupalSettings protected function Gets the JavaScript drupalSettings variable for the currently-loaded page. 1
BrowserTestBase::getHttpClient protected function Obtain the HTTP client for the system under test.
BrowserTestBase::getMinkDriverArgs protected function Get the Mink driver args from an environment variable, if it is set. Can be overridden in a derived class so it is possible to use a different value for a subset of tests, e.g. the JavaScript tests. 1
BrowserTestBase::getOptions protected function Helper function to get the options of select field.
BrowserTestBase::getResponseLogHandler protected function Provides a Guzzle middleware handler to log every response received. Overrides BrowserHtmlDebugTrait::getResponseLogHandler
BrowserTestBase::getSession public function Returns Mink session.
BrowserTestBase::getSessionCookies protected function Get session cookies from current session.
BrowserTestBase::getTestMethodCaller protected function Retrieves the current calling line in the class under test. Overrides BrowserHtmlDebugTrait::getTestMethodCaller
BrowserTestBase::initFrontPage protected function Visits the front page when initializing Mink. 3
BrowserTestBase::initMink protected function Initializes Mink sessions. 1
BrowserTestBase::installDrupal public function Installs Drupal into the Simpletest site. 1
BrowserTestBase::registerSessions protected function Registers additional Mink sessions.
BrowserTestBase::tearDown protected function 3
BrowserTestBase::translatePostValues protected function Transforms a nested array into a flat array suitable for drupalPostForm().
BrowserTestBase::xpath protected function Performs an xpath search on the contents of the internal browser.
BrowserTestBase::__construct public function 1
BrowserTestBase::__sleep public function Prevents serializing any properties.
CommentTestTrait::addDefaultCommentField public function Adds the default comment field to an entity.
ConfigTestTrait::configImporter protected function Returns a ConfigImporter object to import test configuration.
ConfigTestTrait::copyConfig protected function Copies configuration objects from source storage to target storage.
ContentTypeCreationTrait::createContentType protected function Creates a custom content type based on default settings. Aliased as: drupalCreateContentType 1
FunctionalTestSetupTrait::$apcuEnsureUniquePrefix protected property The flag to set 'apcu_ensure_unique_prefix' setting. 1
FunctionalTestSetupTrait::$classLoader protected property The class loader to use for installation and initialization of setup.
FunctionalTestSetupTrait::$configDirectories Deprecated protected property The config directories used in this test.
FunctionalTestSetupTrait::$rootUser protected property The "#1" admin user.
FunctionalTestSetupTrait::doInstall protected function Execute the non-interactive installer. 1
FunctionalTestSetupTrait::getDatabaseTypes protected function Returns all supported database driver installer objects.
FunctionalTestSetupTrait::initConfig protected function Initialize various configurations post-installation. 2
FunctionalTestSetupTrait::initKernel protected function Initializes the kernel after installation.
FunctionalTestSetupTrait::initSettings protected function Initialize settings created during install.
FunctionalTestSetupTrait::initUserSession protected function Initializes user 1 for the site to be installed.
FunctionalTestSetupTrait::installDefaultThemeFromClassProperty protected function Installs the default theme defined by `static::$defaultTheme` when needed.
FunctionalTestSetupTrait::installModulesFromClassProperty protected function Install modules defined by `static::$modules`. 1
FunctionalTestSetupTrait::installParameters protected function Returns the parameters that will be used when Simpletest installs Drupal. 9
FunctionalTestSetupTrait::prepareEnvironment protected function Prepares the current environment for running the test. 23
FunctionalTestSetupTrait::prepareRequestForGenerator protected function Creates a mock request and sets it on the generator.
FunctionalTestSetupTrait::prepareSettings protected function Prepares site settings and services before installation. 2
FunctionalTestSetupTrait::rebuildAll protected function Resets and rebuilds the environment after setup.
FunctionalTestSetupTrait::rebuildContainer protected function Rebuilds \Drupal::getContainer().
FunctionalTestSetupTrait::resetAll protected function Resets all data structures after having enabled new modules.
FunctionalTestSetupTrait::setContainerParameter protected function Changes parameters in the services.yml file.
FunctionalTestSetupTrait::setupBaseUrl protected function Sets up the base URL based upon the environment variable.
FunctionalTestSetupTrait::writeSettings protected function Rewrites the settings.php file of the test site.
HandlerTest::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
HandlerTest::$modules public static property Modules to enable. Overrides ViewTestBase::$modules
HandlerTest::$testViews public static property Views used by this test.
HandlerTest::assertEqualValue protected function Check to see if a value is the same as the value on a certain handler.
HandlerTest::setUp protected function Overrides ViewTestBase::setUp
HandlerTest::testAccess public function Tests access to a handler.
HandlerTest::testBreakString public function Tests the breakString method.
HandlerTest::testHandlerWeights public function Tests the order of handlers is the same before and after saving.
HandlerTest::testPlaceholder public function Tests the placeholder function.
HandlerTest::testRelationshipUI public function Tests the relationship ui for field/filter/argument/relationship.
HandlerTest::testSetRelationship public function Tests the relationship method on the base class.
HandlerTest::viewsData protected function Returns the views data definition. Overrides ViewTestBase::viewsData
NodeCreationTrait::createNode protected function Creates a node based on default settings. Aliased as: drupalCreateNode
NodeCreationTrait::getNodeByTitle public function Get a node from the database based on its title. Aliased as: drupalGetNodeByTitle
PhpunitCompatibilityTrait::getMock Deprecated public function Returns a mock object for the specified class using the available method.
PhpunitCompatibilityTrait::setExpectedException Deprecated public function Compatibility layer for PHPUnit 6 to support PHPUnit 4 code.
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. 1
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.
RefreshVariablesTrait::refreshVariables protected function Refreshes in-memory configuration and state information. 3
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.
StorageCopyTrait::replaceStorageContents protected static function Copy the configuration from one storage to another and remove stale items.
TestRequirementsTrait::checkModuleRequirements private function Checks missing module requirements.
TestRequirementsTrait::checkRequirements protected function Check module requirements for the Drupal use case. 1
TestRequirementsTrait::getDrupalRoot protected static function Returns the Drupal root directory.
TestSetupTrait::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking.
TestSetupTrait::$container protected property The dependency injection container used in the test.
TestSetupTrait::$kernel protected property The DrupalKernel instance used in the test.
TestSetupTrait::$originalSite protected property The site directory of the original parent site.
TestSetupTrait::$privateFilesDirectory protected property The private file directory for the test environment.
TestSetupTrait::$publicFilesDirectory protected property The public file directory for the test environment.
TestSetupTrait::$siteDirectory protected property The site directory of this test run.
TestSetupTrait::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 2
TestSetupTrait::$tempFilesDirectory protected property The temporary file directory for the test environment.
TestSetupTrait::$testId protected property The test run ID.
TestSetupTrait::changeDatabasePrefix protected function Changes the database connection to the prefixed one.
TestSetupTrait::getConfigSchemaExclusions protected function Gets the config schema exclusions for this test.
TestSetupTrait::getDatabaseConnection public static function Returns the database connection to the site running Simpletest.
TestSetupTrait::prepareDatabasePrefix protected function Generates a database prefix for running tests. 2
UiHelperTrait::$loggedInUser protected property The current user logged in using the Mink controlled browser.
UiHelperTrait::$maximumMetaRefreshCount protected property The number of meta refresh redirects to follow, or NULL if unlimited.
UiHelperTrait::$metaRefreshCount protected property The number of meta refresh redirects followed during ::drupalGet().
UiHelperTrait::assertSession public function Returns WebAssert object. 1
UiHelperTrait::buildUrl protected function Builds an a absolute URL from a system path or a URL object.
UiHelperTrait::checkForMetaRefresh protected function Checks for meta refresh tag and if found call drupalGet() recursively.
UiHelperTrait::click protected function Clicks the element with the given CSS selector.
UiHelperTrait::clickLink protected function Follows a link by complete name.
UiHelperTrait::cssSelect protected function Searches elements using a CSS selector in the raw content.
UiHelperTrait::drupalGet protected function Retrieves a Drupal path or an absolute path. 3
UiHelperTrait::drupalLogin protected function Logs in a user using the Mink controlled browser.
UiHelperTrait::drupalLogout protected function Logs a user out of the Mink controlled browser and confirms.
UiHelperTrait::drupalPostForm protected function Executes a form submission.
UiHelperTrait::drupalUserIsLoggedIn protected function Returns whether a given user account is logged in.
UiHelperTrait::getAbsoluteUrl protected function Takes a path and returns an absolute path.
UiHelperTrait::getTextContent protected function Retrieves the plain-text content from the current page.
UiHelperTrait::getUrl protected function Get the current URL from the browser.
UiHelperTrait::prepareRequest protected function Prepare for a request to testing site. 1
UiHelperTrait::submitForm protected function Fills and submits a form.
UserCreationTrait::checkPermissions protected function Checks whether a given list of permission names is valid.
UserCreationTrait::createAdminRole protected function Creates an administrative role.
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.
UserCreationTrait::setUpCurrentUser protected function Creates a random user account and sets it as current 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
XdebugRequestTrait::extractCookiesFromRequest protected function Adds xdebug cookies, from request setup.