8.4 KiB
YooKassa API SDK
Class: \YooKassa\Helpers\Random
Namespace: \YooKassa\Helpers
Summary:
Класс хэлпера для генерации случайных значений, используется в тестах
Constants
- No constants found
Methods
| Visibility | Name | Flag | Summary |
|---|---|---|---|
| public | bool() | Возвращает рандомное буллево значение | |
| public | bytes() | Возвращает рандомную последовательность байт | |
| public | float() | Возвращает рандомное число с плавающей точкой. По умолчанию возвращает значение в промежутке от нуля до едениы. | |
| public | hex() | Возвращает строку, состоящую из символов '0123456789abcdef' | |
| public | int() | Возвращает рандомное целое число. По умолчанию возвращает число от нуля до PHP_INT_MAX. | |
| public | str() | Возвращает строку из рандомных символов | |
| public | value() | Возвращает рандомное значение из переданного массива |
Details
- File: lib/Helpers/Random.php
- Package: YooKassa
- Class Hierarchy:
- \YooKassa\Helpers\Random
Methods
public bool() : bool
Static public bool() : bool
Summary
Возвращает рандомное буллево значение
Details:
- Inherited From: \YooKassa\Helpers\Random
Throws:
| Type | Description |
|---|---|
| \Exception |
Returns: bool - Либо true либо false, одно из двух
public bytes() : string
Static public bytes(int $length, bool $useBest = true) : string
Summary
Возвращает рандомную последовательность байт
Details:
- Inherited From: \YooKassa\Helpers\Random
Parameters:
| Type | Name | Description |
|---|---|---|
int |
length | Длина возвращаемой строки |
bool |
useBest | Использовать ли функцию random_int если она доступна |
Throws:
| Type | Description |
|---|---|
| \Exception |
Returns: string - Строка, состоящая из рандомных символов
public float() : float
Static public float(float|null $min = null, float|null $max = null, bool $useBest = true) : float
Summary
Возвращает рандомное число с плавающей точкой. По умолчанию возвращает значение в промежутке от нуля до едениы.
Details:
- Inherited From: \YooKassa\Helpers\Random
Parameters:
| Type | Name | Description |
|---|---|---|
float OR null |
min | Минимально возможное значение |
float OR null |
max | Максимально возможное значение |
bool |
useBest | Использовать ли функцию random_int если она доступна |
Throws:
| Type | Description |
|---|---|
| \Exception |
Returns: float - Рандомное число с плавающей точкой
public hex() : string
Static public hex(int $length, bool $useBest = true) : string
Summary
Возвращает строку, состоящую из символов '0123456789abcdef'
Details:
- Inherited From: \YooKassa\Helpers\Random
Parameters:
| Type | Name | Description |
|---|---|---|
int |
length | Длина возвращаемой строки |
bool |
useBest | Использовать ли функцию random_int если она доступна |
Throws:
| Type | Description |
|---|---|
| \Exception |
Returns: string - Строка, состоящая из рандомных символов
public int() : int
Static public int(int|null $min = null, int|null $max = null, bool $useBest = true) : int
Summary
Возвращает рандомное целое число. По умолчанию возвращает число от нуля до PHP_INT_MAX.
Details:
- Inherited From: \YooKassa\Helpers\Random
Parameters:
| Type | Name | Description |
|---|---|---|
int OR null |
min | Минимально возможное значение |
int OR null |
max | Максимально возможное значение |
bool |
useBest | Использовать ли функцию random_int если она доступна |
Throws:
| Type | Description |
|---|---|
| \Exception |
Returns: int - Рандомное целое число
public str() : string
Static public str(int $length, int|null $maxLength = null, string|array|null $characters = null, bool $useBest = true) : string
Summary
Возвращает строку из рандомных символов
Details:
- Inherited From: \YooKassa\Helpers\Random
Parameters:
| Type | Name | Description |
|---|---|---|
int |
length | Длина возвращаемой строки, или минимальная длина, если передан парамтр $maxLength |
int OR null |
maxLength | Если параметр не равен null, возвращает сроку длиной от $length до $maxLength |
string OR array OR null |
characters | Строка или массив используемых в строке символов |
bool |
useBest | Использовать ли функцию random_int если она доступна |
Throws:
| Type | Description |
|---|---|
| \Exception |
Returns: string - Строка, состоящая из рандомных символов
public value() : mixed
Static public value(array $values, bool $useBest = true) : mixed
Summary
Возвращает рандомное значение из переданного массива
Details:
- Inherited From: \YooKassa\Helpers\Random
Parameters:
| Type | Name | Description |
|---|---|---|
array |
values | Массив источник данных |
bool |
useBest | Использовать ли функцию random_int если она доступна |
Throws:
| Type | Description |
|---|---|
| \Exception |
Returns: mixed - Случайное значение из переданного массива
Top Namespaces
Reports
This document was automatically generated from source code comments on 2023-04-06 using phpDocumentor
© 2023 YooMoney