Получить строку по маске наборов Random::getStringByAlphabet

Модуль: main — подключать отдельно не нужно

Метод Random::getStringByAlphabet возвращает случайную строку из наборов символов, которые задает маска констант ALPHABET_*. Флаг requireAll требует, чтобы в строке были символы из каждого набора.

Сигнатура метода в классе Bitrix\Main\Security\Random:

public static function getStringByAlphabet($length, $alphabet, $requireAll = false)

Параметры

Обязательные параметры обозначены *

Параметр Тип Описание
length* int Задает длину строки
alphabet* int Задает маску наборов символов, например Random::ALPHABET_NUM | Random::ALPHABET_SPECIAL. Константы перечислены на странице класса. Маска 0 вызывает ошибку PHP DivisionByZeroError
requireAll bool Требует символ из каждого набора, если равен true и наборов больше одного. По умолчанию — false

Типы в таблице описывают назначение аргументов. Сигнатура PHP не объявляет их.

Возвращаемое значение

Метод возвращает строку string длиной length.

Без requireAll метод склеивает наборы и вызывает getStringByCharsets, поэтому какой-то набор может не попасть в строку. С requireAll метод вызывает getStringByArray.

Примеры

Пример. Код генерирует пароль из 12 символов, в котором есть цифры, буквы обоих регистров и специальные символы:

<?php
use Bitrix\Main\Security\Random;

require $_SERVER['DOCUMENT_ROOT'] . '/bitrix/modules/main/include/prolog_before.php';

echo Random::getStringByAlphabet(12, Random::ALPHABET_ALL, true);

Смотрите также