Commit f2e1dcdc authored by catch's avatar catch
Browse files

Issue #3267785 by darvanen, kriboogh, alexpott, ciprian.stavovei, smustgrave:... 

Issue #3267785 by darvanen, kriboogh, alexpott, ciprian.stavovei, smustgrave: Deprecate passing non-string parameters to \Drupal\Core\Utility\Token::scan then implement typehint
parent 7e318cc0

core/lib/Drupal/Core/Utility/Token.php

+5 −0
Original line number Diff line number Diff line
@@ -287,6 +287,11 @@ protected function doReplace(bool $markup, string $text, array $data, array $opt 
   *   An associative array of discovered tokens, grouped by type.

   */

  public function scan($text) {

    if (!is_string($text)) {

      @trigger_error('Calling ' . __METHOD__ . '() with a $text parameter of type other than string is deprecated in drupal:10.1.0, a typehint will be added in drupal:11.0.0. See https://www.drupal.org/node/3334317', E_USER_DEPRECATED);

      $text = (string) $text;

    }



    // Matches tokens with the following pattern: [$type:$name]

    // $type and $name may not contain [ ] characters.

    // $type may not contain : or whitespace characters, but $name may.

core/modules/system/tests/src/Functional/System/TokenScanTest.php

deleted100644 → 0
+0 −42
Original line number Diff line number Diff line 
<?php



namespace Drupal\Tests\system\Functional\System;



use Drupal\Tests\BrowserTestBase;



/**

 * Scan token-like patterns in a dummy text to check token scanning.

 *

 * @group system

 */

class TokenScanTest extends BrowserTestBase {



  /**

   * {@inheritdoc}

   */

  protected $defaultTheme = 'stark';



  /**

   * Scans dummy text, then tests the output.

   */

  public function testTokenScan() {

    // Define text with valid and not valid, fake and existing token-like

    // strings.

    $text = 'First a [valid:simple], but dummy token, and a dummy [valid:token with: spaces].';

    $text .= 'Then a [not valid:token].';

    $text .= 'Then an [:empty token type].';

    $text .= 'Then an [empty token:].';

    $text .= 'Then a totally empty token: [:].';

    $text .= 'Last an existing token: [node:author:name].';

    $token_wannabes = \Drupal::token()->scan($text);



    $this->assertTrue(isset($token_wannabes['valid']['simple']), 'A simple valid token has been matched.');

    $this->assertTrue(isset($token_wannabes['valid']['token with: spaces']), 'A valid token with space characters in the token name has been matched.');

    $this->assertFalse(isset($token_wannabes['not valid']), 'An invalid token with spaces in the token type has not been matched.');

    $this->assertFalse(isset($token_wannabes['empty token']), 'An empty token has not been matched.');

    $this->assertFalse(isset($token_wannabes['']['empty token type']), 'An empty token type has not been matched.');

    $this->assertFalse(isset($token_wannabes['']['']), 'An empty token and type has not been matched.');

    $this->assertTrue(isset($token_wannabes['node']), 'An existing valid token has been matched.');

  }



}

core/tests/Drupal/Tests/Core/Utility/TokenTest.php

+33 −0
Original line number Diff line number Diff line
@@ -304,6 +304,39 @@ public function testReplacePlain() { 
    $this->assertEquals($plain, 'Wow, great "Your <best> buys" has a slogan "We are best"');

  }



  /**

   * Scans dummy text, then tests the output.

   */

  public function testScan() {

    // Define text with valid and not valid, fake and existing token-like

    // strings.

    $text = 'First a [valid:simple], but dummy token, and a dummy [valid:token with: spaces].';

    $text .= 'Then a [not valid:token].';

    $text .= 'Then an [:empty token type].';

    $text .= 'Then an [empty token:].';

    $text .= 'Then a totally empty token: [:].';

    $text .= 'Last an existing token: [node:author:name].';

    $token_wannabes = $this->token->scan($text);



    $this->assertTrue(isset($token_wannabes['valid']['simple']), 'A simple valid token has been matched.');

    $this->assertTrue(isset($token_wannabes['valid']['token with: spaces']), 'A valid token with space characters in the token name has been matched.');

    $this->assertFalse(isset($token_wannabes['not valid']), 'An invalid token with spaces in the token type has not been matched.');

    $this->assertFalse(isset($token_wannabes['empty token']), 'An empty token has not been matched.');

    $this->assertFalse(isset($token_wannabes['']['empty token type']), 'An empty token type has not been matched.');

    $this->assertFalse(isset($token_wannabes['']['']), 'An empty token and type has not been matched.');

    $this->assertTrue(isset($token_wannabes['node']), 'An existing valid token has been matched.');

  }



  /**

   * Tests passing a non-string value to Token::scan().

   *

   * @group legacy

   */

  public function testScanDeprecation() {

    $this->expectDeprecation('Calling Drupal\Core\Utility\Token::scan() with a $text parameter of type other than string is deprecated in drupal:10.1.0, a typehint will be added in drupal:11.0.0. See https://www.drupal.org/node/3334317');

    $this->assertSame([], $this->token->scan(NULL));

  }



  /**

   * Sets up the token library to return site tokens.

   */