162 lines
5.7 KiB
Markdown
162 lines
5.7 KiB
Markdown
# [YooKassa API SDK](../home.md)
|
||
|
||
# Abstract Class: \YooKassa\Common\AbstractRequestBuilder
|
||
### Namespace: [\YooKassa\Common](../namespaces/yookassa-common.md)
|
||
---
|
||
**Summary:**
|
||
|
||
Базовый класс билдера запросов
|
||
|
||
|
||
---
|
||
### 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
|
||
|
||
---
|
||
## Properties
|
||
<a name="property_currentObject"></a>
|
||
#### protected $currentObject : \YooKassa\Common\AbstractRequest
|
||
---
|
||
**Summary**
|
||
|
||
Инстанс собираемого запроса
|
||
|
||
**Type:** <a href="classes/YooKassa-Common-AbstractRequest.html"><abbr title="\YooKassa\Common\AbstractRequest">AbstractRequest</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\AbstractRequest
|
||
|
||
```php
|
||
public build(array $options = null) : \YooKassa\Common\AbstractRequest
|
||
```
|
||
|
||
**Summary**
|
||
|
||
Строит запрос, валидирует его и возвращает, если все прошло нормально
|
||
|
||
**Details:**
|
||
* Inherited From: [\YooKassa\Common\AbstractRequestBuilder](../classes/YooKassa-Common-AbstractRequestBuilder.md)
|
||
|
||
##### Parameters:
|
||
| Type | Name | Description |
|
||
| ---- | ---- | ----------- |
|
||
| <code lang="php">array</code> | options | Массив свойств запроса, если нужно их установить перед сборкой |
|
||
|
||
##### Throws:
|
||
| Type | Description |
|
||
| ---- | ----------- |
|
||
| \YooKassa\Common\Exceptions\InvalidRequestException | Выбрасывается если при валидации запроса произошла ошибка |
|
||
| \YooKassa\Common\Exceptions\InvalidPropertyException | Выбрасывается если не удалось установить один из параметров, переданных в массиве настроек |
|
||
|
||
**Returns:** \YooKassa\Common\AbstractRequest - Инстанс собранного запроса
|
||
|
||
|
||
<a name="method_setOptions" class="anchor"></a>
|
||
#### public setOptions() : \YooKassa\Common\AbstractRequestBuilder
|
||
|
||
```php
|
||
public setOptions(array|\Traversable $options) : \YooKassa\Common\AbstractRequestBuilder
|
||
```
|
||
|
||
**Summary**
|
||
|
||
Устанавливает свойства запроса из массива
|
||
|
||
**Details:**
|
||
* Inherited From: [\YooKassa\Common\AbstractRequestBuilder](../classes/YooKassa-Common-AbstractRequestBuilder.md)
|
||
|
||
##### Parameters:
|
||
| Type | Name | Description |
|
||
| ---- | ---- | ----------- |
|
||
| <code lang="php">array OR \Traversable</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\AbstractRequest
|
||
|
||
```php
|
||
Abstract protected initCurrentObject() : \YooKassa\Common\AbstractRequest
|
||
```
|
||
|
||
**Summary**
|
||
|
||
Инициализирует пустой запрос
|
||
|
||
**Details:**
|
||
* Inherited From: [\YooKassa\Common\AbstractRequestBuilder](../classes/YooKassa-Common-AbstractRequestBuilder.md)
|
||
|
||
**Returns:** \YooKassa\Common\AbstractRequest - Инстанс запроса, который будем собирать
|
||
|
||
|
||
|
||
---
|
||
|
||
### 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/)
|
||
|
||
© 2023 YooMoney |