25 KiB
YooKassa API SDK
Class: \YooKassa\Request\Deals\DealsRequestBuilder
Namespace: \YooKassa\Request\Deals
Summary:
Класс билдера запросов к API для получения списка сделок магазина
Constants
- No constants found
Properties
| Visibility | Name | Flag | Summary |
|---|---|---|---|
| protected | $currentObject | Инстанс собираемого запроса |
Methods
| Visibility | Name | Flag | Summary |
|---|---|---|---|
| public | __construct() | Конструктор, инициализирует пустой запрос, который в будущем начнём собирать | |
| public | build() | Собирает и возвращает объект запроса списка сделок магазина | |
| public | setCreatedAtGt() | Устанавливает дату создания от которой выбираются платежи | |
| public | setCreatedAtGte() | Устанавливает дату создания от которой выбираются платежи | |
| public | setCreatedAtLt() | Устанавливает дату создания до которой выбираются платежи | |
| public | setCreatedAtLte() | Устанавливает дату создания до которой выбираются платежи | |
| public | setCursor() | Устанавливает страница выдачи результатов | |
| public | setExpiresAtGt() | Устанавливает дату автоматического закрытия от которой выбираются платежи | |
| public | setExpiresAtGte() | Устанавливает дату автоматического закрытия от которой выбираются платежи | |
| public | setExpiresAtLt() | Устанавливает дату автоматического закрытия до которой выбираются платежи | |
| public | setExpiresAtLte() | Устанавливает дату автоматического закрытия до которой выбираются платежи | |
| public | setFullTextSearch() | Устанавливает фильтр по описанию выбираемых сделок | |
| public | setLimit() | Устанавливает ограничение количества объектов сделки | |
| public | setOptions() | Устанавливает свойства запроса из массива | |
| public | setStatus() | Устанавливает статус выбираемых сделок | |
| protected | initCurrentObject() | Возвращает новый объект запроса для получения списка сделок, который в дальнейшем будет собираться в билдере |
Details
- File: lib/Request/Deals/DealsRequestBuilder.php
- Package: YooKassa
- Class Hierarchy:
- \YooKassa\Common\AbstractRequestBuilder
- \YooKassa\Request\Deals\DealsRequestBuilder
Properties
protected $currentObject : \YooKassa\Request\Deals\DealsRequest
Summary
Инстанс собираемого запроса
Type: DealsRequest Собираемый объект запроса списка сделок магазина Details:
Methods
public __construct() : mixed
public __construct() : mixed
Summary
Конструктор, инициализирует пустой запрос, который в будущем начнём собирать
Details:
- Inherited From: \YooKassa\Common\AbstractRequestBuilder
Returns: mixed -
public build() : \YooKassa\Common\AbstractRequest|\YooKassa\Request\Deals\DealsRequest
public build(array|null $options = null) : \YooKassa\Common\AbstractRequest|\YooKassa\Request\Deals\DealsRequest
Summary
Собирает и возвращает объект запроса списка сделок магазина
Details:
- Inherited From: \YooKassa\Request\Deals\DealsRequestBuilder
Parameters:
| Type | Name | Description |
|---|---|---|
array OR null |
options | Массив с настройками запроса |
Returns: \YooKassa\Common\AbstractRequest|\YooKassa\Request\Deals\DealsRequest - Инстанс объекта запроса к API для получения списка сделок магазина
public setCreatedAtGt() : \YooKassa\Request\Deals\DealsRequestBuilder
public setCreatedAtGt(\DateTime|string|int|null $value) : \YooKassa\Request\Deals\DealsRequestBuilder
Summary
Устанавливает дату создания от которой выбираются платежи
Details:
- Inherited From: \YooKassa\Request\Deals\DealsRequestBuilder
Parameters:
| Type | Name | Description |
|---|---|---|
\DateTime OR string OR int OR null |
value | Время создания, от (не включая) или null, чтобы удалить значение |
Throws:
| Type | Description |
|---|---|
| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Генерируется если была передана дата в невалидном формате (была передана строка или число, которые не удалось преобразовать в валидную дату) |
| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | \Exception |
Returns: \YooKassa\Request\Deals\DealsRequestBuilder - Инстанс текущего билдера
public setCreatedAtGte() : \YooKassa\Request\Deals\DealsRequestBuilder
public setCreatedAtGte(\DateTime|string|int|null $value) : \YooKassa\Request\Deals\DealsRequestBuilder
Summary
Устанавливает дату создания от которой выбираются платежи
Details:
- Inherited From: \YooKassa\Request\Deals\DealsRequestBuilder
Parameters:
| Type | Name | Description |
|---|---|---|
\DateTime OR string OR int OR null |
value | Время создания, от (включительно) или null, чтобы удалить значение |
Throws:
| Type | Description |
|---|---|
| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Генерируется если была передана дата в невалидном формате (была передана строка или число, которые не удалось преобразовать в валидную дату) |
| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | \Exception |
Returns: \YooKassa\Request\Deals\DealsRequestBuilder - Инстанс текущего билдера
public setCreatedAtLt() : \YooKassa\Request\Deals\DealsRequestBuilder
public setCreatedAtLt(\DateTime|string|int|null $value) : \YooKassa\Request\Deals\DealsRequestBuilder
Summary
Устанавливает дату создания до которой выбираются платежи
Details:
- Inherited From: \YooKassa\Request\Deals\DealsRequestBuilder
Parameters:
| Type | Name | Description |
|---|---|---|
\DateTime OR string OR int OR null |
value | Время создания, до (не включая) или null, чтобы удалить значение |
Throws:
| Type | Description |
|---|---|
| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Генерируется если была передана дата в невалидном формате (была передана строка или число, которые не удалось преобразовать в валидную дату) |
| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | \Exception |
Returns: \YooKassa\Request\Deals\DealsRequestBuilder - Инстанс текущего билдера
public setCreatedAtLte() : \YooKassa\Request\Deals\DealsRequestBuilder
public setCreatedAtLte(\DateTime|string|int|null $value) : \YooKassa\Request\Deals\DealsRequestBuilder
Summary
Устанавливает дату создания до которой выбираются платежи
Details:
- Inherited From: \YooKassa\Request\Deals\DealsRequestBuilder
Parameters:
| Type | Name | Description |
|---|---|---|
\DateTime OR string OR int OR null |
value | Время создания, до (включительно) или null, чтобы удалить значение |
Throws:
| Type | Description |
|---|---|
| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Генерируется если была передана дата в невалидном формате (была передана строка или число, которые не удалось преобразовать в валидную дату) |
| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | \Exception |
Returns: \YooKassa\Request\Deals\DealsRequestBuilder - Инстанс текущего билдера
public setCursor() : \YooKassa\Request\Deals\DealsRequestBuilder
public setCursor(string|null $value) : \YooKassa\Request\Deals\DealsRequestBuilder
Summary
Устанавливает страница выдачи результатов
Details:
- Inherited From: \YooKassa\Request\Deals\DealsRequestBuilder
Parameters:
| Type | Name | Description |
|---|---|---|
string OR null |
value | Страница выдачи результатов или null, чтобы удалить значение |
Throws:
| Type | Description |
|---|---|
| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если в метод была передана не строка |
Returns: \YooKassa\Request\Deals\DealsRequestBuilder - Инстанс текущего билдера
public setExpiresAtGt() : \YooKassa\Request\Deals\DealsRequestBuilder
public setExpiresAtGt(\DateTime|string|int|null $value) : \YooKassa\Request\Deals\DealsRequestBuilder
Summary
Устанавливает дату автоматического закрытия от которой выбираются платежи
Details:
- Inherited From: \YooKassa\Request\Deals\DealsRequestBuilder
Parameters:
| Type | Name | Description |
|---|---|---|
\DateTime OR string OR int OR null |
value | Время автоматического закрытия, до (включительно) или null, чтобы удалить значение |
Throws:
| Type | Description |
|---|---|
| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Генерируется если была передана дата в невалидном формате (была передана строка или число, которые не удалось преобразовать в валидную дату) |
| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | \Exception |
Returns: \YooKassa\Request\Deals\DealsRequestBuilder - Инстанс текущего билдера
public setExpiresAtGte() : \YooKassa\Request\Deals\DealsRequestBuilder
public setExpiresAtGte(\DateTime|string|int|null $value) : \YooKassa\Request\Deals\DealsRequestBuilder
Summary
Устанавливает дату автоматического закрытия от которой выбираются платежи
Details:
- Inherited From: \YooKassa\Request\Deals\DealsRequestBuilder
Parameters:
| Type | Name | Description |
|---|---|---|
\DateTime OR string OR int OR null |
value | Время автоматического закрытия, от (включительно) или null, чтобы удалить значение |
Throws:
| Type | Description |
|---|---|
| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Генерируется если была передана дата в невалидном формате (была передана строка или число, которые не удалось преобразовать в валидную дату) |
| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | \Exception |
Returns: \YooKassa\Request\Deals\DealsRequestBuilder - Инстанс текущего билдера
public setExpiresAtLt() : \YooKassa\Request\Deals\DealsRequestBuilder
public setExpiresAtLt(\DateTime|string|int|null $value) : \YooKassa\Request\Deals\DealsRequestBuilder
Summary
Устанавливает дату автоматического закрытия до которой выбираются платежи
Details:
- Inherited From: \YooKassa\Request\Deals\DealsRequestBuilder
Parameters:
| Type | Name | Description |
|---|---|---|
\DateTime OR string OR int OR null |
value | Время автоматического закрытия, до (включительно) или null, чтобы удалить значение |
Throws:
| Type | Description |
|---|---|
| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Генерируется если была передана дата в невалидном формате (была передана строка или число, которые не удалось преобразовать в валидную дату) |
| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | \Exception |
Returns: \YooKassa\Request\Deals\DealsRequestBuilder - Инстанс текущего билдера
public setExpiresAtLte() : \YooKassa\Request\Deals\DealsRequestBuilder
public setExpiresAtLte(\DateTime|string|int|null $value) : \YooKassa\Request\Deals\DealsRequestBuilder
Summary
Устанавливает дату автоматического закрытия до которой выбираются платежи
Details:
- Inherited From: \YooKassa\Request\Deals\DealsRequestBuilder
Parameters:
| Type | Name | Description |
|---|---|---|
\DateTime OR string OR int OR null |
value | Время автоматического закрытия, до (включительно) или null, чтобы удалить значение |
Throws:
| Type | Description |
|---|---|
| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Генерируется если была передана дата в невалидном формате (была передана строка или число, которые не удалось преобразовать в валидную дату) |
| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | \Exception |
Returns: \YooKassa\Request\Deals\DealsRequestBuilder - Инстанс текущего билдера
public setFullTextSearch() : \YooKassa\Request\Deals\DealsRequestBuilder
public setFullTextSearch(string $value) : \YooKassa\Request\Deals\DealsRequestBuilder
Summary
Устанавливает фильтр по описанию выбираемых сделок
Details:
- Inherited From: \YooKassa\Request\Deals\DealsRequestBuilder
Parameters:
| Type | Name | Description |
|---|---|---|
string |
value | Фильтр по описанию выбираемых сделок или null, чтобы удалить значение |
Throws:
| Type | Description |
|---|---|
| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если переданное значение не является валидным |
| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если в метод была передана не строка |
Returns: \YooKassa\Request\Deals\DealsRequestBuilder - Инстанс текущего билдера
public setLimit() : \YooKassa\Request\Deals\DealsRequestBuilder
public setLimit(string $value) : \YooKassa\Request\Deals\DealsRequestBuilder
Summary
Устанавливает ограничение количества объектов сделки
Details:
- Inherited From: \YooKassa\Request\Deals\DealsRequestBuilder
Parameters:
| Type | Name | Description |
|---|---|---|
string |
value | Ограничение количества объектов сделки или null, чтобы удалить значение |
Throws:
| Type | Description |
|---|---|
| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если в метод было передана не целое число |
Returns: \YooKassa\Request\Deals\DealsRequestBuilder - Инстанс текущего билдера
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 - Инстанс текущего билдера запросов
public setStatus() : \YooKassa\Request\Deals\DealsRequestBuilder
public setStatus(string $value) : \YooKassa\Request\Deals\DealsRequestBuilder
Summary
Устанавливает статус выбираемых сделок
Details:
- Inherited From: \YooKassa\Request\Deals\DealsRequestBuilder
Parameters:
| Type | Name | Description |
|---|---|---|
string |
value | Статус выбираемых сделок или null, чтобы удалить значение |
Throws:
| Type | Description |
|---|---|
| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если переданное значение не является валидным статусом |
| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если в метод была передана не строка |
Returns: \YooKassa\Request\Deals\DealsRequestBuilder - Инстанс текущего билдера
protected initCurrentObject() : \YooKassa\Request\Deals\DealsRequest
protected initCurrentObject() : \YooKassa\Request\Deals\DealsRequest
Summary
Возвращает новый объект запроса для получения списка сделок, который в дальнейшем будет собираться в билдере
Details:
- Inherited From: \YooKassa\Request\Deals\DealsRequestBuilder
Returns: \YooKassa\Request\Deals\DealsRequest - Объект запроса списка сделок магазина
Top Namespaces
Reports
This document was automatically generated from source code comments on 2023-04-06 using phpDocumentor
© 2023 YooMoney