169 lines
5.6 KiB
Markdown
169 lines
5.6 KiB
Markdown
# [YooKassa API SDK](../home.md)
|
||
|
||
# Abstract Class: \YooKassa\Common\AbstractRequestBuilder
|
||
### Namespace: [\YooKassa\Common](../namespaces/yookassa-common.md)
|
||
---
|
||
**Summary:**
|
||
|
||
Класс, представляющий модель AbstractRequestBuilder.
|
||
|
||
**Description:**
|
||
|
||
Базовый класс билдера запросов.
|
||
|
||
---
|
||
### Constants
|
||
* No constants found
|
||
|
||
---
|
||
### Properties
|
||
| Visibility | Name | Flag | Summary |
|
||
| ----------:| ---- | ---- | ------- |
|
||
| protected | [$currentObject](../classes/YooKassa-Common-AbstractRequestBuilder.md#property_currentObject) | | Инстанс собираемого запроса. |
|
||
|
||
---
|
||
### Methods
|
||
| Visibility | Name | Flag | Summary |
|
||
| ----------:| ---- | ---- | ------- |
|
||
| public | [__construct()](../classes/YooKassa-Common-AbstractRequestBuilder.md#method___construct) | | Конструктор, инициализирует пустой запрос, который в будущем начнём собирать. |
|
||
| public | [build()](../classes/YooKassa-Common-AbstractRequestBuilder.md#method_build) | | Строит запрос, валидирует его и возвращает, если все прошло нормально. |
|
||
| public | [setOptions()](../classes/YooKassa-Common-AbstractRequestBuilder.md#method_setOptions) | | Устанавливает свойства запроса из массива. |
|
||
| protected | [initCurrentObject()](../classes/YooKassa-Common-AbstractRequestBuilder.md#method_initCurrentObject) | | Инициализирует пустой запрос |
|
||
|
||
---
|
||
### Details
|
||
* File: [lib/Common/AbstractRequestBuilder.php](../../lib/Common/AbstractRequestBuilder.php)
|
||
* Package: YooKassa
|
||
* Class Hierarchy:
|
||
* \YooKassa\Common\AbstractRequestBuilder
|
||
|
||
* See Also:
|
||
* [](https://yookassa.ru/developers/api)
|
||
|
||
---
|
||
### Tags
|
||
| Tag | Version | Description |
|
||
| --- | ------- | ----------- |
|
||
| category | | Class |
|
||
| author | | cms@yoomoney.ru |
|
||
|
||
---
|
||
## Properties
|
||
<a name="property_currentObject"></a>
|
||
#### protected $currentObject : ?\YooKassa\Common\AbstractRequestInterface
|
||
---
|
||
**Summary**
|
||
|
||
Инстанс собираемого запроса.
|
||
|
||
**Type:** <a href="../?\YooKassa\Common\AbstractRequestInterface"><abbr title="?\YooKassa\Common\AbstractRequestInterface">AbstractRequestInterface</abbr></a>
|
||
|
||
**Details:**
|
||
|
||
|
||
|
||
---
|
||
## Methods
|
||
<a name="method___construct" class="anchor"></a>
|
||
#### public __construct() : mixed
|
||
|
||
```php
|
||
public __construct() : mixed
|
||
```
|
||
|
||
**Summary**
|
||
|
||
Конструктор, инициализирует пустой запрос, который в будущем начнём собирать.
|
||
|
||
**Details:**
|
||
* Inherited From: [\YooKassa\Common\AbstractRequestBuilder](../classes/YooKassa-Common-AbstractRequestBuilder.md)
|
||
|
||
**Returns:** mixed -
|
||
|
||
|
||
<a name="method_build" class="anchor"></a>
|
||
#### public build() : \YooKassa\Common\AbstractRequestInterface
|
||
|
||
```php
|
||
public build(null|array $options = null) : \YooKassa\Common\AbstractRequestInterface
|
||
```
|
||
|
||
**Summary**
|
||
|
||
Строит запрос, валидирует его и возвращает, если все прошло нормально.
|
||
|
||
**Details:**
|
||
* Inherited From: [\YooKassa\Common\AbstractRequestBuilder](../classes/YooKassa-Common-AbstractRequestBuilder.md)
|
||
|
||
##### Parameters:
|
||
| Type | Name | Description |
|
||
| ---- | ---- | ----------- |
|
||
| <code lang="php">null OR array</code> | options | Массив свойств запроса, если нужно их установить перед сборкой |
|
||
|
||
**Returns:** \YooKassa\Common\AbstractRequestInterface - Инстанс собранного запроса
|
||
|
||
|
||
<a name="method_setOptions" class="anchor"></a>
|
||
#### public setOptions() : \YooKassa\Common\AbstractRequestBuilder
|
||
|
||
```php
|
||
public setOptions(iterable|null $options) : \YooKassa\Common\AbstractRequestBuilder
|
||
```
|
||
|
||
**Summary**
|
||
|
||
Устанавливает свойства запроса из массива.
|
||
|
||
**Details:**
|
||
* Inherited From: [\YooKassa\Common\AbstractRequestBuilder](../classes/YooKassa-Common-AbstractRequestBuilder.md)
|
||
|
||
##### Parameters:
|
||
| Type | Name | Description |
|
||
| ---- | ---- | ----------- |
|
||
| <code lang="php">iterable OR null</code> | options | Массив свойств запроса |
|
||
|
||
##### Throws:
|
||
| Type | Description |
|
||
| ---- | ----------- |
|
||
| \InvalidArgumentException | Выбрасывается если аргумент не массив и не итерируемый объект |
|
||
| \YooKassa\Common\Exceptions\InvalidPropertyException | Выбрасывается если не удалось установить один из параметров, переданных в массиве настроек |
|
||
|
||
**Returns:** \YooKassa\Common\AbstractRequestBuilder - Инстанс текущего билдера запросов
|
||
|
||
|
||
<a name="method_initCurrentObject" class="anchor"></a>
|
||
#### protected initCurrentObject() : \YooKassa\Common\AbstractRequestInterface|null
|
||
|
||
```php
|
||
Abstract protected initCurrentObject() : \YooKassa\Common\AbstractRequestInterface|null
|
||
```
|
||
|
||
**Summary**
|
||
|
||
Инициализирует пустой запрос
|
||
|
||
**Details:**
|
||
* Inherited From: [\YooKassa\Common\AbstractRequestBuilder](../classes/YooKassa-Common-AbstractRequestBuilder.md)
|
||
|
||
**Returns:** \YooKassa\Common\AbstractRequestInterface|null - Инстанс запроса, который будем собирать
|
||
|
||
|
||
|
||
---
|
||
|
||
### Top Namespaces
|
||
|
||
* [\YooKassa](../namespaces/yookassa.md)
|
||
|
||
---
|
||
|
||
### Reports
|
||
* [Errors - 0](../reports/errors.md)
|
||
* [Markers - 0](../reports/markers.md)
|
||
* [Deprecated - 33](../reports/deprecated.md)
|
||
|
||
---
|
||
|
||
This document was automatically generated from source code comments on 2025-07-01 using [phpDocumentor](http://www.phpdoc.org/)
|
||
|
||
© 2025 YooMoney |