keboss/meraproject
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
main
meraproject/vendor/yoomoney/yookassa-sdk-php/docs/classes/YooKassa-Helpers-Random.md

248 lines
8.4 KiB
Markdown
Raw Permalink Normal View History

Initial commit: Merakomis portal, Docker stack and user-reader API. Co-authored-by: Cursor <cursoragent@cursor.com>
2026-06-24 08:04:05 +00:00
# [YooKassa API SDK](../home.md)
# Class: \YooKassa\Helpers\Random
### Namespace: [\YooKassa\Helpers](../namespaces/yookassa-helpers.md)
---
**Summary:**
Класс хэлпера для генерации случайных значений, используется в тестах
---
### Constants
* No constants found
---
### Methods
| Visibility | Name | Flag | Summary |
| ----------:| ---- | ---- | ------- |
| public | [bool()](../classes/YooKassa-Helpers-Random.md#method_bool) | | Возвращает рандомное буллево значение |
| public | [bytes()](../classes/YooKassa-Helpers-Random.md#method_bytes) | | Возвращает рандомную последовательность байт |
| public | [float()](../classes/YooKassa-Helpers-Random.md#method_float) | | Возвращает рандомное число с плавающей точкой. По умолчанию возвращает значение в промежутке от нуля до едениы. |
| public | [hex()](../classes/YooKassa-Helpers-Random.md#method_hex) | | Возвращает строку, состоящую из символов '0123456789abcdef' |
| public | [int()](../classes/YooKassa-Helpers-Random.md#method_int) | | Возвращает рандомное целое число. По умолчанию возвращает число от нуля до PHP_INT_MAX. |
| public | [str()](../classes/YooKassa-Helpers-Random.md#method_str) | | Возвращает строку из рандомных символов |
| public | [value()](../classes/YooKassa-Helpers-Random.md#method_value) | | Возвращает рандомное значение из переданного массива |
---
### Details
* File: [lib/Helpers/Random.php](../../lib/Helpers/Random.php)
* Package: YooKassa
* Class Hierarchy:
* \YooKassa\Helpers\Random
---
## Methods
<a name="method_bool" class="anchor"></a>
#### public bool() : bool
```php
Static public bool() : bool
```
**Summary**
Возвращает рандомное буллево значение
**Details:**
* Inherited From: [\YooKassa\Helpers\Random](../classes/YooKassa-Helpers-Random.md)
##### Throws:
| Type | Description |
| ---- | ----------- |
| \Exception | |
**Returns:** bool - Либо true либо false, одно из двух
<a name="method_bytes" class="anchor"></a>
#### public bytes() : string
```php
Static public bytes(int $length, bool $useBest = true) : string
```
**Summary**
Возвращает рандомную последовательность байт
**Details:**
* Inherited From: [\YooKassa\Helpers\Random](../classes/YooKassa-Helpers-Random.md)
##### Parameters:
| Type | Name | Description |
| ---- | ---- | ----------- |
| <code lang="php">int</code> | length | Длина возвращаемой строки |
| <code lang="php">bool</code> | useBest | Использовать ли функцию random_int если она доступна |
##### Throws:
| Type | Description |
| ---- | ----------- |
| \Exception | |
**Returns:** string - Строка, состоящая из рандомных символов
<a name="method_float" class="anchor"></a>
#### public float() : float
```php
Static public float(float|null $min = null, float|null $max = null, bool $useBest = true) : float
```
**Summary**
Возвращает рандомное число с плавающей точкой. По умолчанию возвращает значение в промежутке от нуля до едениы.
**Details:**
* Inherited From: [\YooKassa\Helpers\Random](../classes/YooKassa-Helpers-Random.md)
##### Parameters:
| Type | Name | Description |
| ---- | ---- | ----------- |
| <code lang="php">float OR null</code> | min | Минимально возможное значение |
| <code lang="php">float OR null</code> | max | Максимально возможное значение |
| <code lang="php">bool</code> | useBest | Использовать ли функцию random_int если она доступна |
##### Throws:
| Type | Description |
| ---- | ----------- |
| \Exception | |
**Returns:** float - Рандомное число с плавающей точкой
<a name="method_hex" class="anchor"></a>
#### public hex() : string
```php
Static public hex(int $length, bool $useBest = true) : string
```
**Summary**
Возвращает строку, состоящую из символов '0123456789abcdef'
**Details:**
* Inherited From: [\YooKassa\Helpers\Random](../classes/YooKassa-Helpers-Random.md)
##### Parameters:
| Type | Name | Description |
| ---- | ---- | ----------- |
| <code lang="php">int</code> | length | Длина возвращаемой строки |
| <code lang="php">bool</code> | useBest | Использовать ли функцию random_int если она доступна |
##### Throws:
| Type | Description |
| ---- | ----------- |
| \Exception | |
**Returns:** string - Строка, состоящая из рандомных символов
<a name="method_int" class="anchor"></a>
#### public int() : int
```php
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](../classes/YooKassa-Helpers-Random.md)
##### Parameters:
| Type | Name | Description |
| ---- | ---- | ----------- |
| <code lang="php">int OR null</code> | min | Минимально возможное значение |
| <code lang="php">int OR null</code> | max | Максимально возможное значение |
| <code lang="php">bool</code> | useBest | Использовать ли функцию random_int если она доступна |
##### Throws:
| Type | Description |
| ---- | ----------- |
| \Exception | |
**Returns:** int - Рандомное целое число
<a name="method_str" class="anchor"></a>
#### public str() : string
```php
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](../classes/YooKassa-Helpers-Random.md)
##### Parameters:
| Type | Name | Description |
| ---- | ---- | ----------- |
| <code lang="php">int</code> | length | Длина возвращаемой строки, или минимальная длина, если передан парамтр $maxLength |
| <code lang="php">int OR null</code> | maxLength | Если параметр не равен null, возвращает сроку длиной от $length до $maxLength |
| <code lang="php">string OR array OR null</code> | characters | Строка или массив используемых в строке символов |
| <code lang="php">bool</code> | useBest | Использовать ли функцию random_int если она доступна |
##### Throws:
| Type | Description |
| ---- | ----------- |
| \Exception | |
**Returns:** string - Строка, состоящая из рандомных символов
<a name="method_value" class="anchor"></a>
#### public value() : mixed
```php
Static public value(array $values, bool $useBest = true) : mixed
```
**Summary**
Возвращает рандомное значение из переданного массива
**Details:**
* Inherited From: [\YooKassa\Helpers\Random](../classes/YooKassa-Helpers-Random.md)
##### Parameters:
| Type | Name | Description |
| ---- | ---- | ----------- |
| <code lang="php">array</code> | values | Массив источник данных |
| <code lang="php">bool</code> | useBest | Использовать ли функцию random_int если она доступна |
##### Throws:
| Type | Description |
| ---- | ----------- |
| \Exception | |
**Returns:** mixed - Случайное значение из переданного массива
---
### Top Namespaces
* [\YooKassa](../namespaces/yookassa.md)
---
### Reports
* [Errors - 0](../reports/errors.md)
* [Markers - 1](../reports/markers.md)
* [Deprecated - 25](../reports/deprecated.md)
---
This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/)
&copy; 2023 YooMoney
Reference in New Issue Copy Permalink