Commit 0844f7c5 authored by Dries's avatar Dries
Browse files

- Patch #1672764 by xjm: improve documetation of randomString() and randomName().

parent df07e0d2
...@@ -763,14 +763,21 @@ protected function exceptionHandler($exception) { ...@@ -763,14 +763,21 @@ protected function exceptionHandler($exception) {
/** /**
* Generates a random string of ASCII characters of codes 32 to 126. * Generates a random string of ASCII characters of codes 32 to 126.
* *
* The generated string includes alpha-numeric characters and common misc * The generated string includes alpha-numeric characters and common
* characters. Use this method when testing general input where the content * miscellaneous characters. Use this method when testing general input
* is not restricted. * where the content is not restricted.
*
* Do not use this method when special characters are not allowed (e.g., in
* machine or file names); instead, use
* Drupal\simpletest\TestBase::randomName().
* *
* @param $length * @param $length
* Length of random string to generate. * Length of random string to generate.
*
* @return * @return
* Randomly generated string. * Randomly generated string.
*
* @see Drupal\simpletest\TestBase::randomName()
*/ */
public static function randomString($length = 8) { public static function randomString($length = 8) {
$str = ''; $str = '';
...@@ -789,10 +796,16 @@ public static function randomString($length = 8) { ...@@ -789,10 +796,16 @@ public static function randomString($length = 8) {
* require machine readable values (i.e. without spaces and non-standard * require machine readable values (i.e. without spaces and non-standard
* characters) this method is best. * characters) this method is best.
* *
* Do not use this method when testing unvalidated user input. Instead, use
* Drupal\simpletest\TestBase::randomString().
*
* @param $length * @param $length
* Length of random string to generate. * Length of random string to generate.
*
* @return * @return
* Randomly generated string. * Randomly generated string.
*
* @see Drupal\simpletest\TestBase::randomString()
*/ */
public static function randomName($length = 8) { public static function randomName($length = 8) {
$values = array_merge(range(65, 90), range(97, 122), range(48, 57)); $values = array_merge(range(65, 90), range(97, 122), range(48, 57));
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment