5.7 KiB
5.7 KiB
YooKassa API SDK
Abstract Class: \YooKassa\Common\AbstractRequestBuilder
Namespace: \YooKassa\Common
Summary:
Базовый класс билдера запросов
Constants
- No constants found
Properties
| Visibility | Name | Flag | Summary |
|---|---|---|---|
| protected | $currentObject | Инстанс собираемого запроса |
Methods
| Visibility | Name | Flag | Summary |
|---|---|---|---|
| public | __construct() | Конструктор, инициализирует пустой запрос, который в будущем начнём собирать | |
| public | build() | Строит запрос, валидирует его и возвращает, если все прошло нормально | |
| public | setOptions() | Устанавливает свойства запроса из массива | |
| protected | initCurrentObject() | Инициализирует пустой запрос |
Details
- File: lib/Common/AbstractRequestBuilder.php
- Package: YooKassa
- Class Hierarchy:
- \YooKassa\Common\AbstractRequestBuilder
Properties
protected $currentObject : \YooKassa\Common\AbstractRequest
Summary
Инстанс собираемого запроса
Type: AbstractRequest
Details:
Methods
public __construct() : mixed
public __construct() : mixed
Summary
Конструктор, инициализирует пустой запрос, который в будущем начнём собирать
Details:
- Inherited From: \YooKassa\Common\AbstractRequestBuilder
Returns: mixed -
public build() : \YooKassa\Common\AbstractRequest
public build(array $options = null) : \YooKassa\Common\AbstractRequest
Summary
Строит запрос, валидирует его и возвращает, если все прошло нормально
Details:
- Inherited From: \YooKassa\Common\AbstractRequestBuilder
Parameters:
| Type | Name | Description |
|---|---|---|
array |
options | Массив свойств запроса, если нужно их установить перед сборкой |
Throws:
| Type | Description |
|---|---|
| \YooKassa\Common\Exceptions\InvalidRequestException | Выбрасывается если при валидации запроса произошла ошибка |
| \YooKassa\Common\Exceptions\InvalidPropertyException | Выбрасывается если не удалось установить один из параметров, переданных в массиве настроек |
Returns: \YooKassa\Common\AbstractRequest - Инстанс собранного запроса
public setOptions() : \YooKassa\Common\AbstractRequestBuilder
public setOptions(array|\Traversable $options) : \YooKassa\Common\AbstractRequestBuilder
Summary
Устанавливает свойства запроса из массива
Details:
- Inherited From: \YooKassa\Common\AbstractRequestBuilder
Parameters:
| Type | Name | Description |
|---|---|---|
array OR \Traversable |
options | Массив свойств запроса |
Throws:
| Type | Description |
|---|---|
| \InvalidArgumentException | Выбрасывается если аргумент не массив и не итерируемый объект |
| \YooKassa\Common\Exceptions\InvalidPropertyException | Выбрасывается если не удалось установить один из параметров, переданныч в массиве настроек |
Returns: \YooKassa\Common\AbstractRequestBuilder - Инстанс текущего билдера запросов
protected initCurrentObject() : \YooKassa\Common\AbstractRequest
Abstract protected initCurrentObject() : \YooKassa\Common\AbstractRequest
Summary
Инициализирует пустой запрос
Details:
- Inherited From: \YooKassa\Common\AbstractRequestBuilder
Returns: \YooKassa\Common\AbstractRequest - Инстанс запроса, который будем собирать
Top Namespaces
Reports
This document was automatically generated from source code comments on 2023-04-06 using phpDocumentor
© 2023 YooMoney