function WebAssert::linkExists

Same name in other branches
  1. 9 core/tests/Drupal/Tests/WebAssert.php \Drupal\Tests\WebAssert::linkExists()
  2. 8.9.x core/tests/Drupal/Tests/WebAssert.php \Drupal\Tests\WebAssert::linkExists()
  3. 11.x core/tests/Drupal/Tests/WebAssert.php \Drupal\Tests\WebAssert::linkExists()

Passes if a link with the specified label is found.

An optional link index may be passed.

Parameters

string $label: Text between the anchor tags.

int $index: Link position counting from zero.

string $message: (optional) A message to display with the assertion. Do not translate messages: use strtr() to embed variables in the message text, not t(). If left blank, a default message will be displayed.

Throws

\Behat\Mink\Exception\ExpectationException Thrown when element doesn't exist, or the link label is a different one.

File

core/tests/Drupal/Tests/WebAssert.php, line 310

Class

WebAssert
Defines a class with methods for asserting presence of elements during tests.

Namespace

Drupal\Tests

Code

public function linkExists($label, $index = 0, $message = '') {
    $message = $message ? $message : strtr('Link with label %label not found.', [
        '%label' => $label,
    ]);
    $links = $this->session
        ->getPage()
        ->findAll('named', [
        'link',
        $label,
    ]);
    $this->assert(!empty($links[$index]), $message);
}

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.