comparison core/tests/Drupal/FunctionalTests/AssertLegacyTrait.php @ 5:12f9dff5fda9 tip

Update to Drupal core 8.7.1

 <?php
-
+// @codingStandardsIgnoreFile
 namespace Drupal\FunctionalTests;
 
 use Behat\Mink\Element\NodeElement;
 use Behat\Mink\Exception\ExpectationException;
 use Behat\Mink\Selector\Xpath\Escaper;

 use Drupal\KernelTests\AssertLegacyTrait as BaseAssertLegacyTrait;
 
 /**
  * Provides convenience methods for assertions in browser tests.
  *
- * @deprecated Scheduled for removal in Drupal 9.0.0. Use the methods on
+ * Deprecated Scheduled for removal in Drupal 10.0.0. Use the methods on
  *   \Drupal\Tests\WebAssert instead, for example
  * @code
  *    $this->assertSession()->statusCodeEquals(200);
  * @endcode
+ *
+ * @todo https://www.drupal.org/project/drupal/issues/3031580 Note that
+ *   deprecations in this file do not use the @ symbol in Drupal 8 because this
+ *   will be removed in Drupal 10.0.0. Adding the @ back should re-enable coding
+ *   stanadrds checks.
  */
 trait AssertLegacyTrait {
 
   use BaseAssertLegacyTrait;
 

    * Asserts that the element with the given CSS selector is present.
    *
    * @param string $css_selector
    *   The CSS selector identifying the element to check.
    *
-   * @deprecated Scheduled for removal in Drupal 9.0.0.
+   * Deprecated Scheduled for removal in Drupal 10.0.0.
    *   Use $this->assertSession()->elementExists() instead.
    */
   protected function assertElementPresent($css_selector) {
     $this->assertSession()->elementExists('css', $css_selector);
   }

    * Asserts that the element with the given CSS selector is not present.
    *
    * @param string $css_selector
    *   The CSS selector identifying the element to check.
    *
-   * @deprecated Scheduled for removal in Drupal 9.0.0.
+   * Deprecated Scheduled for removal in Drupal 10.0.0.
    *   Use $this->assertSession()->elementNotExists() instead.
    */
   protected function assertElementNotPresent($css_selector) {
     $this->assertSession()->elementNotExists('css', $css_selector);
   }

    * the values of text fields.
    *
    * @param string $text
    *   Plain text to look for.
    *
-   * @deprecated Scheduled for removal in Drupal 9.0.0.
+   * Deprecated Scheduled for removal in Drupal 10.0.0.
    *   Use instead:
    *     - $this->assertSession()->responseContains() for non-HTML responses,
    *       like XML or Json.
    *     - $this->assertSession()->pageTextContains() for HTML responses. Unlike
    *       the deprecated assertText(), the passed text should be HTML decoded,

    * the values of text fields.
    *
    * @param string $text
    *   Plain text to look for.
    *
-   * @deprecated Scheduled for removal in Drupal 9.0.0.
+   * Deprecated Scheduled for removal in Drupal 10.0.0.
    *   Use instead:
    *     - $this->assertSession()->responseNotContains() for non-HTML responses,
    *       like XML or Json.
    *     - $this->assertSession()->pageTextNotContains() for HTML responses.
    *       Unlike the deprecated assertNoText(), the passed text should be HTML

    *   Plain text to look for.
    * @param string $message
    *   (optional) A message to display with the assertion. Do not translate
    *   messages with t(). If left blank, a default message will be displayed.
    *
-   * @deprecated Scheduled for removal in Drupal 9.0.0.
+   * Deprecated Scheduled for removal in Drupal 10.0.0.
    *   Use $this->getSession()->getPage()->getText() and substr_count() instead.
    */
   protected function assertUniqueText($text, $message = NULL) {
     // Cast MarkupInterface objects to string.
     $text = (string) $text;

    *   Plain text to look for.
    * @param string $message
    *   (optional) A message to display with the assertion. Do not translate
    *   messages with t(). If left blank, a default message will be displayed.
    *
-   * @deprecated Scheduled for removal in Drupal 9.0.0.
+   * Deprecated Scheduled for removal in Drupal 10.0.0.
    *   Use $this->getSession()->getPage()->getText() and substr_count() instead.
    */
   protected function assertNoUniqueText($text, $message = '') {
     // Cast MarkupInterface objects to string.
     $text = (string) $text;

    *
    * @param int $code
    *   Response code. For example 200 is a successful page request. For a list
    *   of all codes see http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html.
    *
-   * @deprecated Scheduled for removal in Drupal 9.0.0.
+   * Deprecated Scheduled for removal in Drupal 10.0.0.
    *   Use $this->assertSession()->statusCodeEquals() instead.
    */
   protected function assertResponse($code) {
     $this->assertSession()->statusCodeEquals($code);
   }

    * @param string $value
    *   (optional) Value of the field to assert. You may pass in NULL (default)
    *   to skip checking the actual value, while still checking that the field
    *   exists.
    *
-   * @deprecated Scheduled for removal in Drupal 9.0.0.
+   * Deprecated Scheduled for removal in Drupal 10.0.0.
    *   Use $this->assertSession()->fieldExists() or
    *   $this->assertSession()->buttonExists() or
    *   $this->assertSession()->fieldValueEquals() instead.
    */
   protected function assertFieldByName($name, $value = NULL) {

    *   (optional) Value for the field, to assert that the field's value on the
    *   page does not match it. You may pass in NULL to skip checking the
    *   value, while still checking that the field does not exist. However, the
    *   default value ('') asserts that the field value is not an empty string.
    *
-   * @deprecated Scheduled for removal in Drupal 9.0.0.
+   * Deprecated Scheduled for removal in Drupal 10.0.0.
    *   Use $this->assertSession()->fieldNotExists() or
    *   $this->assertSession()->buttonNotExists() or
    *   $this->assertSession()->fieldValueNotEquals() instead.
    */
   protected function assertNoFieldByName($name, $value = '') {

    *   However, the default value ('') asserts that the field value is an empty
    *   string.
    *
    * @throws \Behat\Mink\Exception\ElementNotFoundException
    *
-   * @deprecated Scheduled for removal in Drupal 9.0.0.
+   * Deprecated Scheduled for removal in Drupal 10.0.0.
    *   Use $this->assertSession()->fieldExists() or
    *   $this->assertSession()->buttonExists() or
    *   $this->assertSession()->fieldValueEquals() instead.
    */
   protected function assertFieldById($id, $value = '') {

    * Asserts that a field exists with the given name or ID.
    *
    * @param string $field
    *   Name or ID of field to assert.
    *
-   * @deprecated Scheduled for removal in Drupal 9.0.0.
+   * Deprecated Scheduled for removal in Drupal 10.0.0.
    *   Use $this->assertSession()->fieldExists() or
    *   $this->assertSession()->buttonExists() instead.
    */
   protected function assertField($field) {
     $this->assertFieldByXPath($this->constructFieldXpath('name', $field) . '|' . $this->constructFieldXpath('id', $field));

    * Asserts that a field does NOT exist with the given name or ID.
    *
    * @param string $field
    *   Name or ID of field to assert.
    *
-   * @deprecated Scheduled for removal in Drupal 9.0.0.
+   * Deprecated Scheduled for removal in Drupal 10.0.0.
    *   Use $this->assertSession()->fieldNotExists() or
    *   $this->assertSession()->buttonNotExists() instead.
    */
   protected function assertNoField($field) {
     $this->assertNoFieldByXPath($this->constructFieldXpath('name', $field) . '|' . $this->constructFieldXpath('id', $field));

    * Raw text refers to the raw HTML that the page generated.
    *
    * @param string $raw
    *   Raw (HTML) string to look for.
    *
-   * @deprecated Scheduled for removal in Drupal 9.0.0.
+   * Deprecated Scheduled for removal in Drupal 10.0.0.
    *   Use $this->assertSession()->responseContains() instead.
    */
   protected function assertRaw($raw) {
     $this->assertSession()->responseContains($raw);
   }

    * Raw text refers to the raw HTML that the page generated.
    *
    * @param string $raw
    *   Raw (HTML) string to look for.
    *
-   * @deprecated Scheduled for removal in Drupal 9.0.0.
+   * Deprecated Scheduled for removal in Drupal 10.0.0.
    *   Use $this->assertSession()->responseNotContains() instead.
    */
   protected function assertNoRaw($raw) {
     $this->assertSession()->responseNotContains($raw);
   }

    * Pass if the page title is the given string.
    *
    * @param string $expected_title
    *   The string the page title should be.
    *
-   * @deprecated Scheduled for removal in Drupal 9.0.0.
+   * Deprecated Scheduled for removal in Drupal 10.0.0.
    *   Use $this->assertSession()->titleEquals() instead.
    */
   protected function assertTitle($expected_title) {
     // Cast MarkupInterface to string.
     $expected_title = (string) $expected_title;

    * @param string|\Drupal\Component\Render\MarkupInterface $label
    *   Text between the anchor tags.
    * @param int $index
    *   Link position counting from zero.
    *
-   * @deprecated Scheduled for removal in Drupal 9.0.0.
+   * Deprecated Scheduled for removal in Drupal 10.0.0.
    *   Use $this->assertSession()->linkExists() instead.
    */
   protected function assertLink($label, $index = 0) {
     return $this->assertSession()->linkExists($label, $index);
   }

    * Passes if a link with the specified label is not found.
    *
    * @param string|\Drupal\Component\Render\MarkupInterface $label
    *   Text between the anchor tags.
    *
-   * @deprecated Scheduled for removal in Drupal 9.0.0.
+   * Deprecated Scheduled for removal in Drupal 10.0.0.
    *   Use $this->assertSession()->linkNotExists() instead.
    */
   protected function assertNoLink($label) {
     return $this->assertSession()->linkNotExists($label);
   }

    * @param string $href
    *   The full or partial value of the 'href' attribute of the anchor tag.
    * @param int $index
    *   Link position counting from zero.
    *
-   * @deprecated Scheduled for removal in Drupal 9.0.0.
+   * Deprecated Scheduled for removal in Drupal 10.0.0.
    *   Use $this->assertSession()->linkByHrefExists() instead.
    */
   protected function assertLinkByHref($href, $index = 0) {
     $this->assertSession()->linkByHrefExists($href, $index);
   }

    * Passes if a link containing a given href (part) is not found.
    *
    * @param string $href
    *   The full or partial value of the 'href' attribute of the anchor tag.
    *
-   * @deprecated Scheduled for removal in Drupal 9.0.0.
+   * Deprecated Scheduled for removal in Drupal 10.0.0.
    *   Use $this->assertSession()->linkByHrefNotExists() instead.
    */
   protected function assertNoLinkByHref($href) {
     $this->assertSession()->linkByHrefNotExists($href);
   }

    *   while still checking that the field doesn't exist. However, the default
    *   value ('') asserts that the field value is not an empty string.
    *
    * @throws \Behat\Mink\Exception\ExpectationException
    *
-   * @deprecated Scheduled for removal in Drupal 9.0.0.
+   * Deprecated Scheduled for removal in Drupal 10.0.0.
    *   Use $this->assertSession()->fieldNotExists() or
    *   $this->assertSession()->buttonNotExists() or
    *   $this->assertSession()->fieldValueNotEquals() instead.
    */
   protected function assertNoFieldById($id, $value = '') {

    * Passes if the internal browser's URL matches the given path.
    *
    * @param \Drupal\Core\Url|string $path
    *   The expected system path or URL.
    *
-   * @deprecated Scheduled for removal in Drupal 9.0.0.
+   * Deprecated Scheduled for removal in Drupal 10.0.0.
    *   Use $this->assertSession()->addressEquals() instead.
    */
   protected function assertUrl($path) {
     $this->assertSession()->addressEquals($path);
   }

    * @param string $id
    *   ID of select field to assert.
    * @param string $option
    *   Option to assert.
    *
-   * @deprecated Scheduled for removal in Drupal 9.0.0.
+   * Deprecated Scheduled for removal in Drupal 10.0.0.
    *   Use $this->assertSession()->optionExists() instead.
    */
   protected function assertOption($id, $option) {
     return $this->assertSession()->optionExists($id, $option);
   }

    * @param string $id
    *   The ID of the select field to assert.
    * @param string $text
    *   The text for the option tag to assert.
    *
-   * @deprecated Scheduled for removal in Drupal 9.0.0.
+   * Deprecated Scheduled for removal in Drupal 10.0.0.
    *   Use $this->assertSession()->optionExists() instead.
    */
   protected function assertOptionByText($id, $text) {
     return $this->assertSession()->optionExists($id, $text);
   }

    * @param string $id
    *   ID of select field to assert.
    * @param string $option
    *   Option to assert.
    *
-   * @deprecated Scheduled for removal in Drupal 9.0.0.
+   * Deprecated Scheduled for removal in Drupal 10.0.0.
    *   Use $this->assertSession()->optionNotExists() instead.
    */
   protected function assertNoOption($id, $option) {
     return $this->assertSession()->optionNotExists($id, $option);
   }

    *   Option to assert.
    * @param string $message
    *   (optional) A message to display with the assertion. Do not translate
    *   messages with t(). If left blank, a default message will be displayed.
    *
-   * @deprecated Scheduled for removal in Drupal 9.0.0.
+   * Deprecated Scheduled for removal in Drupal 10.0.0.
    *   Use $this->assertSession()->optionExists() instead and check the
    *   "selected" attribute yourself.
    */
   protected function assertOptionSelected($id, $option, $message = NULL) {
     $option_field = $this->assertSession()->optionExists($id, $option);

    * Asserts that a checkbox field in the current page is checked.
    *
    * @param string $id
    *   ID of field to assert.
    *
-   * @deprecated Scheduled for removal in Drupal 9.0.0.
+   * Deprecated Scheduled for removal in Drupal 10.0.0.
    *   Use $this->assertSession()->checkboxChecked() instead.
    */
   protected function assertFieldChecked($id) {
     $this->assertSession()->checkboxChecked($id);
   }

    * Asserts that a checkbox field in the current page is not checked.
    *
    * @param string $id
    *   ID of field to assert.
    *
-   * @deprecated Scheduled for removal in Drupal 9.0.0.
+   * Deprecated Scheduled for removal in Drupal 10.0.0.
    *   Use $this->assertSession()->checkboxNotChecked() instead.
    */
   protected function assertNoFieldChecked($id) {
     $this->assertSession()->checkboxNotChecked($id);
   }

    *   exists.
    * @param string $message
    *   (optional) A message to display with the assertion. Do not translate
    *   messages with t().
    *
-   * @deprecated Scheduled for removal in Drupal 9.0.0.
+   * Deprecated Scheduled for removal in Drupal 10.0.0.
    *   Use $this->xpath() instead and check the values directly in the test.
    */
   protected function assertFieldByXPath($xpath, $value = NULL, $message = '') {
     $fields = $this->xpath($xpath);
 

    *   (optional) A message to display with the assertion. Do not translate
    *   messages with t().
    *
    * @throws \Behat\Mink\Exception\ExpectationException
    *
-   * @deprecated Scheduled for removal in Drupal 9.0.0.
+   * Deprecated Scheduled for removal in Drupal 10.0.0.
    *   Use $this->xpath() instead and assert that the result is empty.
    */
   protected function assertNoFieldByXPath($xpath, $value = NULL, $message = '') {
     $fields = $this->xpath($xpath);
 

    *   checking the actual value, while still checking that the field exists.
    * @param string $message
    *   (optional) A message to display with the assertion. Do not translate
    *   messages with t().
    *
-   * @deprecated Scheduled for removal in Drupal 9.0.0.
+   * Deprecated Scheduled for removal in Drupal 10.0.0.
    *   Iterate over the fields yourself instead and directly check the values in
    *   the test.
    */
   protected function assertFieldsByValue($fields, $value = NULL, $message = '') {
     // If value specified then check array for match.

    * Raw text refers to the raw HTML that the page generated.
    *
    * @param string $raw
    *   Raw (HTML) string to look for.
    *
-   * @deprecated Scheduled for removal in Drupal 9.0.0.
+   * Deprecated Scheduled for removal in Drupal 10.0.0.
    *   Use $this->assertSession()->assertEscaped() instead.
    */
   protected function assertEscaped($raw) {
     $this->assertSession()->assertEscaped($raw);
   }

    * Raw text refers to the raw HTML that the page generated.
    *
    * @param string $raw
    *   Raw (HTML) string to look for.
    *
-   * @deprecated Scheduled for removal in Drupal 9.0.0.
+   * Deprecated Scheduled for removal in Drupal 10.0.0.
    *   Use $this->assertSession()->assertNoEscaped() instead.
    */
   protected function assertNoEscaped($raw) {
     $this->assertSession()->assertNoEscaped($raw);
   }

    * Triggers a pass if the Perl regex pattern is found in the raw content.
    *
    * @param string $pattern
    *   Perl regex to look for including the regex delimiters.
    *
-   * @deprecated Scheduled for removal in Drupal 9.0.0.
+   * Deprecated Scheduled for removal in Drupal 10.0.0.
    *   Use $this->assertSession()->responseMatches() instead.
    */
   protected function assertPattern($pattern) {
     $this->assertSession()->responseMatches($pattern);
   }

    * Triggers a pass if the Perl regex pattern is not found in the raw content.
    *
    * @param string $pattern
    *   Perl regex to look for including the regex delimiters.
    *
-   * @deprecated Scheduled for removal in Drupal 9.0.0.
+   * Deprecated Scheduled for removal in Drupal 10.0.0.
    *   Use $this->assertSession()->responseNotMatches() instead.
    *
    * @see https://www.drupal.org/node/2864262
    */
   protected function assertNoPattern($pattern) {

    * Asserts whether an expected cache tag was present in the last response.
    *
    * @param string $expected_cache_tag
    *   The expected cache tag.
    *
-   * @deprecated Scheduled for removal in Drupal 9.0.0.
+   * Deprecated Scheduled for removal in Drupal 10.0.0.
    *   Use $this->assertSession()->responseHeaderContains() instead.
    */
   protected function assertCacheTag($expected_cache_tag) {
     $this->assertSession()->responseHeaderContains('X-Drupal-Cache-Tags', $expected_cache_tag);
   }

    * Asserts whether an expected cache tag was absent in the last response.
    *
    * @param string $cache_tag
    *   The cache tag to check.
    *
-   * @deprecated Scheduled for removal in Drupal 9.0.0.
+   * Deprecated Scheduled for removal in Drupal 10.0.0.
    *   Use $this->assertSession()->responseHeaderNotContains() instead.
    *
    * @see https://www.drupal.org/node/2864029
    */
   protected function assertNoCacheTag($cache_tag) {

    * @param string $name
    *   Name of header to assert.
    * @param string $value
    *   Value of the header to assert
    *
-   * @deprecated Scheduled for removal in Drupal 9.0.0.
+   * Deprecated Scheduled for removal in Drupal 10.0.0.
    *   Use $this->assertSession()->responseHeaderEquals() instead.
    */
   protected function assertHeader($name, $value) {
     $this->assertSession()->responseHeaderEquals($name, $value);
   }

    *   values.
    *
    * @return string
    *   An XPath query with arguments replaced.
    *
-   * @deprecated Scheduled for removal in Drupal 9.0.0.
+   * Deprecated Scheduled for removal in Drupal 10.0.0.
    *   Use $this->assertSession()->buildXPathQuery() instead.
    */
   protected function buildXPathQuery($xpath, array $args = []) {
     return $this->assertSession()->buildXPathQuery($xpath, $args);
   }

    *   Value of field.
    *
    * @return string
    *   XPath for specified values.
    *
-   * @deprecated Scheduled for removal in Drupal 9.0.0.
+   * Deprecated Scheduled for removal in Drupal 10.0.0.
    *   Use $this->getSession()->getPage()->findField() instead.
    */
   protected function constructFieldXpath($attribute, $value) {
     $xpath = '//textarea[@' . $attribute . '=:value]|//input[@' . $attribute . '=:value]|//select[@' . $attribute . '=:value]';
     return $this->buildXPathQuery($xpath, [':value' => $value]);
   }
 
   /**
    * Gets the current raw content.
    *
-   * @deprecated Scheduled for removal in Drupal 9.0.0.
+   * Deprecated Scheduled for removal in Drupal 10.0.0.
    *   Use $this->getSession()->getPage()->getContent() instead.
    */
   protected function getRawContent() {
     @trigger_error('AssertLegacyTrait::getRawContent() is scheduled for removal in Drupal 9.0.0. Use $this->getSession()->getPage()->getContent() instead.', E_USER_DEPRECATED);
     return $this->getSession()->getPage()->getContent();

    *   The element for which to get the options.
    *
    * @return \Behat\Mink\Element\NodeElement[]
    *   Option elements in select.
    *
-   * @deprecated Scheduled for removal in Drupal 9.0.0.
+   * Deprecated Scheduled for removal in Drupal 10.0.0.
    *   Use $element->findAll('xpath', 'option') instead.
    */
   protected function getAllOptions(NodeElement $element) {
     @trigger_error('AssertLegacyTrait::getAllOptions() is scheduled for removal in Drupal 9.0.0. Use $element->findAll(\'xpath\', \'option\') instead.', E_USER_DEPRECATED);
     return $element->findAll('xpath', '//option');