public function RandomGeneratorTrait::randomString in Drupal 9

Same name and namespace in other branches

1. 8 core/tests/Drupal/Tests/RandomGeneratorTrait.php \Drupal\Tests\RandomGeneratorTrait::randomString()

Generates a pseudo-random string of ASCII characters of codes 32 to 126.

Do not use this method when special characters are not possible (e.g., in machine or file names that have already been validated); instead, use \Drupal\simpletest\TestBase::randomMachineName(). If $length is greater than 3 the random string will include at least one ampersand ('&') and at least one greater than ('>') character to ensure coverage for special characters and avoid the introduction of random test failures.

Parameters

int $length: Length of random string to generate.

Return value

string Pseudo-randomly generated unique string including special characters.

See also

\Drupal\Component\Utility\Random::string()

272 calls to RandomGeneratorTrait::randomString()

AreaTextTest::testAreaText in core/modules/views/tests/src/Kernel/Handler/AreaTextTest.php

ArgumentValidatorTest::testArgumentValidateNumeric in core/modules/views/tests/src/Kernel/Plugin/ArgumentValidatorTest.php

AssertMailTraitTest::testAssertMailTrait in core/tests/Drupal/KernelTests/Core/Test/AssertMailTraitTest.php

Tests that the maintenance theme initializes the theme and its base themes.

BlockLanguageCacheTest::setUp in core/modules/block/tests/src/Functional/BlockLanguageCacheTest.php

BlockTest::testBlockUserRoleDelete in core/modules/block/tests/src/Functional/BlockTest.php

Tests block_user_role_delete.

... See full list

File

core/tests/Drupal/Tests/RandomGeneratorTrait.php, line 37

Class

RandomGeneratorTrait

Provides random generator utility methods.

Namespace

Drupal\Tests

Code

public function randomString($length = 8) {
  if ($length < 4) {
    return $this
      ->getRandomGenerator()
      ->string($length, TRUE, [
      $this,
      'randomStringValidate',
    ]);
  }

  // To prevent the introduction of random test failures, ensure that the
  // returned string contains a character that needs to be escaped in HTML by
  // injecting an ampersand into it.
  $replacement_pos = floor($length / 2);

  // Remove 2 from the length to account for the ampersand and greater than
  // characters.
  $string = $this
    ->getRandomGenerator()
    ->string($length - 2, TRUE, [
    $this,
    'randomStringValidate',
  ]);
  return substr_replace($string, '>&', $replacement_pos, 0);
}