19 KiB
YooKassa API SDK
Interface: PaymentsRequestInterface
Namespace: \YooKassa\Request\Payments
Summary:
Interface PaymentsRequestInterface
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 | getLimit() | Возвращает ограничение количества объектов платежа или null если оно до этого не было установлено | |
| public | getStatus() | Возвращает статус выбираемых платежей или null если он до этого не был установлен | |
| public | hasCreatedAtGt() | Проверяет была ли установлена дата создания от которой выбираются платежи | |
| public | hasCreatedAtGte() | Проверяет была ли установлена дата создания от которой выбираются платежи | |
| public | hasCreatedAtLt() | Проверяет была ли установлена дата создания до которой выбираются платежи | |
| public | hasCreatedAtLte() | Проверяет была ли установлена дата создания до которой выбираются платежи | |
| public | hasCursor() | Проверяет была ли установлена страница выдачи результатов | |
| public | hasLimit() | Проверяет было ли установлено ограничение количества объектов платежа | |
| public | hasStatus() | Проверяет был ли установлен статус выбираемых платежей | |
| public | setCreatedAtGt() | Устанавливает дату создания от которой выбираются платежи | |
| public | setCreatedAtGte() | Устанавливает дату создания от которой выбираются платежи | |
| public | setCreatedAtLt() | Устанавливает дату создания до которой выбираются платежи | |
| public | setCreatedAtLte() | Устанавливает дату создания до которой выбираются платежи | |
| public | setCursor() | Устанавливает страницу выдачи результатов | |
| public | setLimit() | Устанавливает ограничение количества объектов платежа | |
| public | setStatus() | Устанавливает статус выбираемых платежей |
Details
- File: lib/Request/Payments/PaymentsRequestInterface.php
- Package: \YooKassa
Tags
| Tag | Version | Description |
|---|---|---|
| property-read | Страница выдачи результатов, которую необходимо отобразить | |
| property-read | Время создания, от (включительно) | |
| property-read | Время создания, от (не включая) | |
| property-read | Время создания, до (включительно) | |
| property-read | Время создания, до (не включая) | |
| property-read | Время подтверждения, от (включительно) | |
| property-read | Время подтверждения, от (не включая) | |
| property-read | Время подтверждения, до (включительно) | |
| property-read | Время подтверждения, до (не включая) | |
| property-read | Ограничение количества объектов платежа, отображаемых на одной странице выдачи | |
| property-read | Идентификатор шлюза. | |
| property-read | Статус платежа |
Methods
public getCursor() : string|null
public getCursor() : string|null
Summary
Возвращает страницу выдачи результатов или null если она до этого не была установлена
Details:
- Inherited From: \YooKassa\Request\Payments\PaymentsRequestInterface
Returns: string|null - Страница выдачи результатов
public hasCursor() : bool
public hasCursor() : bool
Summary
Проверяет была ли установлена страница выдачи результатов
Details:
- Inherited From: \YooKassa\Request\Payments\PaymentsRequestInterface
Returns: bool - True если страница выдачи результатов была установлена, false если нет
public setCursor() : void
public setCursor(string $value) : void
Summary
Устанавливает страницу выдачи результатов
Details:
- Inherited From: \YooKassa\Request\Payments\PaymentsRequestInterface
Parameters:
| Type | Name | Description |
|---|---|---|
string |
value | Страница |
Returns: void -
public getCreatedAtGte() : \DateTime|null
public getCreatedAtGte() : \DateTime|null
Summary
Возвращает дату создания от которой будут возвращены платежи или null если дата не была установлена
Details:
- Inherited From: \YooKassa\Request\Payments\PaymentsRequestInterface
Returns: \DateTime|null - Время создания, от (включительно)
public hasCreatedAtGte() : bool
public hasCreatedAtGte() : bool
Summary
Проверяет была ли установлена дата создания от которой выбираются платежи
Details:
- Inherited From: \YooKassa\Request\Payments\PaymentsRequestInterface
Returns: bool - True если дата была установлена, false если нет
public setCreatedAtGte() : void
public setCreatedAtGte(\DateTime $value) : void
Summary
Устанавливает дату создания от которой выбираются платежи
Details:
- Inherited From: \YooKassa\Request\Payments\PaymentsRequestInterface
Parameters:
| Type | Name | Description |
|---|---|---|
\DateTime |
value | Дата |
Returns: void -
public getCreatedAtGt() : \DateTime|null
public getCreatedAtGt() : \DateTime|null
Summary
Возвращает дату создания от которой будут возвращены платежи или null если дата не была установлена
Details:
- Inherited From: \YooKassa\Request\Payments\PaymentsRequestInterface
Returns: \DateTime|null - Время создания, от (не включая)
public hasCreatedAtGt() : bool
public hasCreatedAtGt() : bool
Summary
Проверяет была ли установлена дата создания от которой выбираются платежи
Details:
- Inherited From: \YooKassa\Request\Payments\PaymentsRequestInterface
Returns: bool - True если дата была установлена, false если нет
public setCreatedAtGt() : void
public setCreatedAtGt(\DateTime $value) : void
Summary
Устанавливает дату создания от которой выбираются платежи
Details:
- Inherited From: \YooKassa\Request\Payments\PaymentsRequestInterface
Parameters:
| Type | Name | Description |
|---|---|---|
\DateTime |
value | Дата |
Returns: void -
public getCreatedAtLte() : \DateTime|null
public getCreatedAtLte() : \DateTime|null
Summary
Возвращает дату создания до которой будут возвращены платежи или null если дата не была установлена
Details:
- Inherited From: \YooKassa\Request\Payments\PaymentsRequestInterface
Returns: \DateTime|null - Время создания, до (включительно)
public hasCreatedAtLte() : bool
public hasCreatedAtLte() : bool
Summary
Проверяет была ли установлена дата создания до которой выбираются платежи
Details:
- Inherited From: \YooKassa\Request\Payments\PaymentsRequestInterface
Returns: bool - True если дата была установлена, false если нет
public setCreatedAtLte() : void
public setCreatedAtLte(\DateTime $value) : void
Summary
Устанавливает дату создания до которой выбираются платежи
Details:
- Inherited From: \YooKassa\Request\Payments\PaymentsRequestInterface
Parameters:
| Type | Name | Description |
|---|---|---|
\DateTime |
value | Дата |
Returns: void -
public getCreatedAtLt() : \DateTime|null
public getCreatedAtLt() : \DateTime|null
Summary
Возвращает дату создания до которой будут возвращены платежи или null если дата не была установлена
Details:
- Inherited From: \YooKassa\Request\Payments\PaymentsRequestInterface
Returns: \DateTime|null - Время создания, до (не включая)
public hasCreatedAtLt() : bool
public hasCreatedAtLt() : bool
Summary
Проверяет была ли установлена дата создания до которой выбираются платежи
Details:
- Inherited From: \YooKassa\Request\Payments\PaymentsRequestInterface
Returns: bool - True если дата была установлена, false если нет
public setCreatedAtLt() : void
public setCreatedAtLt(\DateTime $value) : void
Summary
Устанавливает дату создания до которой выбираются платежи
Details:
- Inherited From: \YooKassa\Request\Payments\PaymentsRequestInterface
Parameters:
| Type | Name | Description |
|---|---|---|
\DateTime |
value | Дата |
Returns: void -
public getLimit() : string|null
public getLimit() : string|null
Summary
Возвращает ограничение количества объектов платежа или null если оно до этого не было установлено
Details:
- Inherited From: \YooKassa\Request\Payments\PaymentsRequestInterface
Returns: string|null - Ограничение количества объектов платежа
public hasLimit() : bool
public hasLimit() : bool
Summary
Проверяет было ли установлено ограничение количества объектов платежа
Details:
- Inherited From: \YooKassa\Request\Payments\PaymentsRequestInterface
Returns: bool - True если ограничение количества объектов платежа было установлено, false если нет
public setLimit() : void
public setLimit(int $value) : void
Summary
Устанавливает ограничение количества объектов платежа
Details:
- Inherited From: \YooKassa\Request\Payments\PaymentsRequestInterface
Parameters:
| Type | Name | Description |
|---|---|---|
int |
value | Количества объектов платежа на странице |
Returns: void -
public getStatus() : string|null
public getStatus() : string|null
Summary
Возвращает статус выбираемых платежей или null если он до этого не был установлен
Details:
- Inherited From: \YooKassa\Request\Payments\PaymentsRequestInterface
Returns: string|null - Статус выбираемых платежей
public hasStatus() : bool
public hasStatus() : bool
Summary
Проверяет был ли установлен статус выбираемых платежей
Details:
- Inherited From: \YooKassa\Request\Payments\PaymentsRequestInterface
Returns: bool - True если статус был установлен, false если нет
public setStatus() : void
public setStatus(string $value) : void
Summary
Устанавливает статус выбираемых платежей
Details:
- Inherited From: \YooKassa\Request\Payments\PaymentsRequestInterface
Parameters:
| Type | Name | Description |
|---|---|---|
string |
value | Статус платежей |
Returns: void -
Top Namespaces
Reports
This document was automatically generated from source code comments on 2021-09-28 using phpDocumentor
© 2021 YooMoney