31 KiB
YooKassa API SDK
Interface: DealsRequestInterface
Namespace: \YooKassa\Request\Deals
Summary:
Interface DealsRequestInterface
Constants
- No constants found
Methods
| Visibility | Name | Flag | Summary |
|---|---|---|---|
| public | getCreatedAtGt() | Возвращает дату создания от которой будут возвращены сделки или null, если дата не была установлена | |
| public | getCreatedAtGte() | Возвращает дату создания от которой будут возвращены сделки или null, если дата не была установлена | |
| public | getCreatedAtLt() | Возвращает дату создания до которой будут возвращены сделки или null, если дата не была установлена | |
| public | getCreatedAtLte() | Возвращает дату создания до которой будут возвращены сделки или null, если дата не была установлена | |
| public | getCursor() | Возвращает страницу выдачи результатов или null, если она до этого не была установлена | |
| public | getExpiresAtGt() | Возвращает дату автоматического закрытия от которой будут возвращены сделки или null, если дата не была установлена | |
| public | getExpiresAtGte() | Возвращает дату автоматического закрытия от которой будут возвращены сделки или null, если дата не была установлена | |
| public | getExpiresAtLt() | Возвращает дату автоматического закрытия до которой будут возвращены сделки или null, если дата не была установлена | |
| public | getExpiresAtLte() | Возвращает дату автоматического закрытия до которой будут возвращены сделки или null, если дата не была установлена | |
| public | getFullTextSearch() | Возвращает фильтр по описанию сделки или null, если он до этого не был установлен | |
| public | getLimit() | Возвращает ограничение количества объектов сделок или null, если оно до этого не было установлено | |
| public | getStatus() | Возвращает статус выбираемых сделок или null, если он до этого не был установлен | |
| public | hasCreatedAtGt() | Проверяет, была ли установлена дата создания от которой выбираются сделки | |
| public | hasCreatedAtGte() | Проверяет, была ли установлена дата создания от которой выбираются сделки | |
| public | hasCreatedAtLt() | Проверяет, была ли установлена дата создания до которой выбираются сделки | |
| public | hasCreatedAtLte() | Проверяет, была ли установлена дата создания до которой выбираются сделки | |
| public | hasCursor() | Проверяет, была ли установлена страница выдачи результатов | |
| public | hasExpiresAtGt() | Проверяет, была ли установлена дата автоматического закрытия от которой выбираются сделки | |
| public | hasExpiresAtGte() | Проверяет, была ли установлена дата автоматического закрытия от которой выбираются сделки | |
| public | hasExpiresAtLt() | Проверяет, была ли установлена автоматического закрытия до которой выбираются сделки | |
| public | hasExpiresAtLte() | Проверяет, была ли установлена дата автоматического закрытия до которой выбираются сделки | |
| public | hasFullTextSearch() | Проверяет, был ли установлен фильтр по описанию сделки | |
| public | hasLimit() | Проверяет, было ли установлено ограничение количества объектов сделок | |
| public | hasStatus() | Проверяет, был ли установлен статус выбираемых сделок | |
| public | setCreatedAtGt() | Устанавливает дату создания от которой выбираются сделки | |
| public | setCreatedAtGte() | Устанавливает дату создания от которой выбираются сделки | |
| public | setCreatedAtLt() | Устанавливает дату создания до которой выбираются сделки | |
| public | setCreatedAtLte() | Устанавливает дату создания до которой выбираются сделки | |
| public | setCursor() | Устанавливает страницу выдачи результатов | |
| public | setExpiresAtGt() | Устанавливает дату автоматического закрытия от которой выбираются сделки | |
| public | setExpiresAtGte() | Устанавливает дату автоматического закрытия от которой выбираются сделки | |
| public | setExpiresAtLt() | Устанавливает дату автоматического закрытия до которой выбираются сделки | |
| public | setExpiresAtLte() | Устанавливает дату автоматического закрытия до которой выбираются сделки | |
| public | setFullTextSearch() | Устанавливает фильтр по описанию сделки | |
| public | setLimit() | Устанавливает ограничение количества объектов сделок | |
| public | setStatus() | Устанавливает статус выбираемых сделок |
Details
- File: lib/Request/Deals/DealsRequestInterface.php
- Package: \YooKassa
Tags
| Tag | Version | Description |
|---|---|---|
| property | Страница выдачи результатов, которую необходимо отобразить | |
| property | Ограничение количества объектов платежа, отображаемых на одной странице выдачи | |
| property | Время создания, от (включительно) | |
| property | Время создания, от (не включая) | |
| property | Время создания, до (включительно) | |
| property | Время создания, до (не включая) | |
| property | Время автоматического закрытия, от (включительно) | |
| property | Время автоматического закрытия, от (не включая) | |
| property | Время автоматического закрытия, до (включительно) | |
| property | Время автоматического закрытия, до (не включая) | |
| property | Фильтр по описанию сделки — параметру description | |
| property | Статус платежа |
Methods
public getCursor() : string|null
public getCursor() : string|null
Summary
Возвращает страницу выдачи результатов или null, если она до этого не была установлена
Details:
- Inherited From: \YooKassa\Request\Deals\DealsRequestInterface
Returns: string|null - Страница выдачи результатов
public hasCursor() : bool
public hasCursor() : bool
Summary
Проверяет, была ли установлена страница выдачи результатов
Details:
- Inherited From: \YooKassa\Request\Deals\DealsRequestInterface
Returns: bool - True если страница выдачи результатов была установлена, false если нет
public setCursor() : void
public setCursor(string $value) : void
Summary
Устанавливает страницу выдачи результатов
Details:
- Inherited From: \YooKassa\Request\Deals\DealsRequestInterface
Parameters:
| Type | Name | Description |
|---|---|---|
string |
value | Страница |
Returns: void -
public getCreatedAtGte() : \DateTime|null
public getCreatedAtGte() : \DateTime|null
Summary
Возвращает дату создания от которой будут возвращены сделки или null, если дата не была установлена
Details:
- Inherited From: \YooKassa\Request\Deals\DealsRequestInterface
Returns: \DateTime|null - Время создания, от (включительно)
public hasCreatedAtGte() : bool
public hasCreatedAtGte() : bool
Summary
Проверяет, была ли установлена дата создания от которой выбираются сделки
Details:
- Inherited From: \YooKassa\Request\Deals\DealsRequestInterface
Returns: bool - True если дата была установлена, false если нет
public setCreatedAtGte() : void
public setCreatedAtGte(\DateTime $value) : void
Summary
Устанавливает дату создания от которой выбираются сделки
Details:
- Inherited From: \YooKassa\Request\Deals\DealsRequestInterface
Parameters:
| Type | Name | Description |
|---|---|---|
\DateTime |
value | Дата |
Returns: void -
public getCreatedAtGt() : \DateTime|null
public getCreatedAtGt() : \DateTime|null
Summary
Возвращает дату создания от которой будут возвращены сделки или null, если дата не была установлена
Details:
- Inherited From: \YooKassa\Request\Deals\DealsRequestInterface
Returns: \DateTime|null - Время создания, от (не включая)
public hasCreatedAtGt() : bool
public hasCreatedAtGt() : bool
Summary
Проверяет, была ли установлена дата создания от которой выбираются сделки
Details:
- Inherited From: \YooKassa\Request\Deals\DealsRequestInterface
Returns: bool - True если дата была установлена, false если нет
public setCreatedAtGt() : void
public setCreatedAtGt(\DateTime $value) : void
Summary
Устанавливает дату создания от которой выбираются сделки
Details:
- Inherited From: \YooKassa\Request\Deals\DealsRequestInterface
Parameters:
| Type | Name | Description |
|---|---|---|
\DateTime |
value | Дата |
Returns: void -
public getCreatedAtLte() : \DateTime|null
public getCreatedAtLte() : \DateTime|null
Summary
Возвращает дату создания до которой будут возвращены сделки или null, если дата не была установлена
Details:
- Inherited From: \YooKassa\Request\Deals\DealsRequestInterface
Returns: \DateTime|null - Время создания, до (включительно)
public hasCreatedAtLte() : bool
public hasCreatedAtLte() : bool
Summary
Проверяет, была ли установлена дата создания до которой выбираются сделки
Details:
- Inherited From: \YooKassa\Request\Deals\DealsRequestInterface
Returns: bool - True если дата была установлена, false если нет
public setCreatedAtLte() : void
public setCreatedAtLte(\DateTime $value) : void
Summary
Устанавливает дату создания до которой выбираются сделки
Details:
- Inherited From: \YooKassa\Request\Deals\DealsRequestInterface
Parameters:
| Type | Name | Description |
|---|---|---|
\DateTime |
value | Дата |
Returns: void -
public getCreatedAtLt() : \DateTime|null
public getCreatedAtLt() : \DateTime|null
Summary
Возвращает дату создания до которой будут возвращены сделки или null, если дата не была установлена
Details:
- Inherited From: \YooKassa\Request\Deals\DealsRequestInterface
Returns: \DateTime|null - Время создания, до (не включая)
public hasCreatedAtLt() : bool
public hasCreatedAtLt() : bool
Summary
Проверяет, была ли установлена дата создания до которой выбираются сделки
Details:
- Inherited From: \YooKassa\Request\Deals\DealsRequestInterface
Returns: bool - True если дата была установлена, false если нет
public setCreatedAtLt() : void
public setCreatedAtLt(\DateTime $value) : void
Summary
Устанавливает дату создания до которой выбираются сделки
Details:
- Inherited From: \YooKassa\Request\Deals\DealsRequestInterface
Parameters:
| Type | Name | Description |
|---|---|---|
\DateTime |
value | Дата |
Returns: void -
public getExpiresAtGte() : \DateTime|null
public getExpiresAtGte() : \DateTime|null
Summary
Возвращает дату автоматического закрытия от которой будут возвращены сделки или null, если дата не была установлена
Details:
- Inherited From: \YooKassa\Request\Deals\DealsRequestInterface
Returns: \DateTime|null - Время автоматического закрытия, от (включительно)
public hasExpiresAtGte() : bool
public hasExpiresAtGte() : bool
Summary
Проверяет, была ли установлена дата автоматического закрытия от которой выбираются сделки
Details:
- Inherited From: \YooKassa\Request\Deals\DealsRequestInterface
Returns: bool - True если дата была установлена, false если нет
public setExpiresAtGte() : void
public setExpiresAtGte(\DateTime $value) : void
Summary
Устанавливает дату автоматического закрытия от которой выбираются сделки
Details:
- Inherited From: \YooKassa\Request\Deals\DealsRequestInterface
Parameters:
| Type | Name | Description |
|---|---|---|
\DateTime |
value | Дата |
Returns: void -
public getExpiresAtGt() : \DateTime|null
public getExpiresAtGt() : \DateTime|null
Summary
Возвращает дату автоматического закрытия от которой будут возвращены сделки или null, если дата не была установлена
Details:
- Inherited From: \YooKassa\Request\Deals\DealsRequestInterface
Returns: \DateTime|null - Время автоматического закрытия, от (не включая)
public hasExpiresAtGt() : bool
public hasExpiresAtGt() : bool
Summary
Проверяет, была ли установлена дата автоматического закрытия от которой выбираются сделки
Details:
- Inherited From: \YooKassa\Request\Deals\DealsRequestInterface
Returns: bool - True если дата была установлена, false если нет
public setExpiresAtGt() : void
public setExpiresAtGt(\DateTime $value) : void
Summary
Устанавливает дату автоматического закрытия от которой выбираются сделки
Details:
- Inherited From: \YooKassa\Request\Deals\DealsRequestInterface
Parameters:
| Type | Name | Description |
|---|---|---|
\DateTime |
value | Дата автоматического закрытия |
Returns: void -
public getExpiresAtLte() : \DateTime|null
public getExpiresAtLte() : \DateTime|null
Summary
Возвращает дату автоматического закрытия до которой будут возвращены сделки или null, если дата не была установлена
Details:
- Inherited From: \YooKassa\Request\Deals\DealsRequestInterface
Returns: \DateTime|null - Время автоматического закрытия, до (включительно)
public hasExpiresAtLte() : bool
public hasExpiresAtLte() : bool
Summary
Проверяет, была ли установлена дата автоматического закрытия до которой выбираются сделки
Details:
- Inherited From: \YooKassa\Request\Deals\DealsRequestInterface
Returns: bool - True если дата была установлена, false если нет
public setExpiresAtLte() : void
public setExpiresAtLte(\DateTime $value) : void
Summary
Устанавливает дату автоматического закрытия до которой выбираются сделки
Details:
- Inherited From: \YooKassa\Request\Deals\DealsRequestInterface
Parameters:
| Type | Name | Description |
|---|---|---|
\DateTime |
value | Дата автоматического закрытия |
Returns: void -
public getExpiresAtLt() : \DateTime|null
public getExpiresAtLt() : \DateTime|null
Summary
Возвращает дату автоматического закрытия до которой будут возвращены сделки или null, если дата не была установлена
Details:
- Inherited From: \YooKassa\Request\Deals\DealsRequestInterface
Returns: \DateTime|null - Время автоматического закрытия, до (не включая)
public hasExpiresAtLt() : bool
public hasExpiresAtLt() : bool
Summary
Проверяет, была ли установлена автоматического закрытия до которой выбираются сделки
Details:
- Inherited From: \YooKassa\Request\Deals\DealsRequestInterface
Returns: bool - True если дата была установлена, false если нет
public setExpiresAtLt() : void
public setExpiresAtLt(\DateTime $value) : void
Summary
Устанавливает дату автоматического закрытия до которой выбираются сделки
Details:
- Inherited From: \YooKassa\Request\Deals\DealsRequestInterface
Parameters:
| Type | Name | Description |
|---|---|---|
\DateTime |
value | Дата автоматического закрытия |
Returns: void -
public getLimit() : string|null
public getLimit() : string|null
Summary
Возвращает ограничение количества объектов сделок или null, если оно до этого не было установлено
Details:
- Inherited From: \YooKassa\Request\Deals\DealsRequestInterface
Returns: string|null - Ограничение количества объектов сделок
public hasLimit() : bool
public hasLimit() : bool
Summary
Проверяет, было ли установлено ограничение количества объектов сделок
Details:
- Inherited From: \YooKassa\Request\Deals\DealsRequestInterface
Returns: bool - True если ограничение количества объектов сделок было установлено, false если нет
public setLimit() : void
public setLimit(int $value) : void
Summary
Устанавливает ограничение количества объектов сделок
Details:
- Inherited From: \YooKassa\Request\Deals\DealsRequestInterface
Parameters:
| Type | Name | Description |
|---|---|---|
int |
value | Количества объектов сделок на странице |
Returns: void -
public getStatus() : string|null
public getStatus() : string|null
Summary
Возвращает статус выбираемых сделок или null, если он до этого не был установлен
Details:
- Inherited From: \YooKassa\Request\Deals\DealsRequestInterface
Returns: string|null - Статус выбираемых сделок
public hasStatus() : bool
public hasStatus() : bool
Summary
Проверяет, был ли установлен статус выбираемых сделок
Details:
- Inherited From: \YooKassa\Request\Deals\DealsRequestInterface
Returns: bool - True если статус был установлен, false если нет
public setStatus() : void
public setStatus(string $value) : void
Summary
Устанавливает статус выбираемых сделок
Details:
- Inherited From: \YooKassa\Request\Deals\DealsRequestInterface
Parameters:
| Type | Name | Description |
|---|---|---|
string |
value | Статус сделок |
Returns: void -
public getFullTextSearch() : string|null
public getFullTextSearch() : string|null
Summary
Возвращает фильтр по описанию сделки или null, если он до этого не был установлен
Details:
- Inherited From: \YooKassa\Request\Deals\DealsRequestInterface
Returns: string|null - Фильтр по описанию сделки
public hasFullTextSearch() : bool
public hasFullTextSearch() : bool
Summary
Проверяет, был ли установлен фильтр по описанию сделки
Details:
- Inherited From: \YooKassa\Request\Deals\DealsRequestInterface
Returns: bool - True если фильтр по описанию сделки был установлен, false если нет
public setFullTextSearch() : void
public setFullTextSearch(string $value) : void
Summary
Устанавливает фильтр по описанию сделки
Details:
- Inherited From: \YooKassa\Request\Deals\DealsRequestInterface
Parameters:
| Type | Name | Description |
|---|---|---|
string |
value | Фильтр по описанию сделки |
Returns: void -
Top Namespaces
Reports
This document was automatically generated from source code comments on 2023-04-06 using phpDocumentor
© 2023 YooMoney