56 KiB
YooKassa API SDK
Class: \YooKassa\Request\Deals\DealsRequest
Namespace: \YooKassa\Request\Deals
Summary:
Класс, представляющий модель DealsRequest.
Description:
Класс объекта запроса к API для получения списка сделок магазина.
Constants
| Visibility | Name | Flag | Summary |
|---|---|---|---|
| public | MAX_LIMIT_VALUE | ||
| public | MAX_LENGTH_DESCRIPTION | ||
| public | MIN_LENGTH_DESCRIPTION |
Properties
| Visibility | Name | Flag | Summary |
|---|---|---|---|
| public | $created_at_gt | Время создания, от (не включая) | |
| public | $created_at_gte | Время создания, от (включительно) | |
| public | $created_at_lt | Время создания, до (не включая) | |
| public | $created_at_lte | Время создания, до (включительно) | |
| public | $createdAtGt | Время создания, от (не включая) | |
| public | $createdAtGte | Время создания, от (включительно) | |
| public | $createdAtLt | Время создания, до (не включая) | |
| public | $createdAtLte | Время создания, до (включительно) | |
| public | $cursor | Страница выдачи результатов, которую необходимо отобразить | |
| public | $expires_at_gt | Время автоматического закрытия, от (не включая) | |
| public | $expires_at_gte | Время автоматического закрытия, от (включительно) | |
| public | $expires_at_lt | Время автоматического закрытия, до (не включая) | |
| public | $expires_at_lte | Время автоматического закрытия, до (включительно) | |
| public | $expiresAtGt | Время автоматического закрытия, от (не включая) | |
| public | $expiresAtGte | Время автоматического закрытия, от (включительно) | |
| public | $expiresAtLt | Время автоматического закрытия, до (не включая) | |
| public | $expiresAtLte | Время автоматического закрытия, до (включительно) | |
| public | $full_text_search | Фильтр по описанию сделки — параметру description | |
| public | $fullTextSearch | Фильтр по описанию сделки — параметру description | |
| public | $limit | Ограничение количества объектов платежа, отображаемых на одной странице выдачи | |
| public | $status | Статус платежа |
Methods
| Visibility | Name | Flag | Summary |
|---|---|---|---|
| public | __construct() | AbstractObject constructor. | |
| public | __get() | Возвращает значение свойства. | |
| public | __isset() | Проверяет наличие свойства. | |
| public | __set() | Устанавливает значение свойства. | |
| public | __unset() | Удаляет свойство. | |
| public | builder() | Возвращает инстанс билдера объектов запросов списка сделок магазина. | |
| public | clearValidationError() | Очищает статус валидации текущего запроса. | |
| public | fromArray() | Устанавливает значения свойств текущего объекта из массива. | |
| public | getCreatedAtGt() | Возвращает дату создания от которой будут возвращены платежи или null, если дата не была установлена. | |
| public | getCreatedAtGte() | Возвращает дату создания от которой будут возвращены платежи или null, если дата не была установлена. | |
| public | getCreatedAtLt() | Возвращает дату создания до которой будут возвращены платежи или null, если дата не была установлена. | |
| public | getCreatedAtLte() | Возвращает дату создания до которой будут возвращены платежи или null, если дата не была установлена. | |
| public | getCursor() | Страница выдачи результатов, которую необходимо отобразить. | |
| public | getExpiresAtGt() | Возвращает дату автоматического закрытия от которой будут возвращены платежи или null, если дата не была установлена. | |
| public | getExpiresAtGte() | Возвращает дату автоматического закрытия от которой будут возвращены платежи или null, если дата не была установлена. | |
| public | getExpiresAtLt() | Возвращает дату автоматического закрытия до которой будут возвращены платежи или null, если дата не была установлена. | |
| public | getExpiresAtLte() | Возвращает дату автоматического закрытия до которой будут возвращены платежи или null, если дата не была установлена. | |
| public | getFullTextSearch() | Возвращает фильтр по описанию выбираемых сделок или null, если он до этого не был установлен. | |
| public | getLastValidationError() | Возвращает последнюю ошибку валидации. | |
| public | getLimit() | Ограничение количества объектов платежа. | |
| public | getStatus() | Возвращает статус выбираемых сделок или null, если он до этого не был установлен. | |
| public | getValidator() | ||
| 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 | jsonSerialize() | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации. | |
| public | offsetExists() | Проверяет наличие свойства. | |
| public | offsetGet() | Возвращает значение свойства. | |
| public | offsetSet() | Устанавливает значение свойства. | |
| public | offsetUnset() | Удаляет свойство. | |
| public | setCreatedAtGt() | Устанавливает дату создания от которой выбираются платежи. | |
| public | setCreatedAtGte() | Устанавливает дату создания от которой выбираются платежи. | |
| public | setCreatedAtLt() | Устанавливает дату создания до которой выбираются платежи. | |
| public | setCreatedAtLte() | Устанавливает дату создания до которой выбираются платежи. | |
| public | setCursor() | Устанавливает страницу выдачи результатов, которую необходимо отобразить. | |
| public | setExpiresAtGt() | Устанавливает дату автоматического закрытия от которой выбираются платежи. | |
| public | setExpiresAtGte() | Устанавливает дату автоматического закрытия от которой выбираются платежи. | |
| public | setExpiresAtLt() | Устанавливает дату автоматического закрытия до которой выбираются платежи. | |
| public | setExpiresAtLte() | Устанавливает дату автоматического закрытия до которой выбираются платежи. | |
| public | setFullTextSearch() | Устанавливает фильтр по описанию выбираемых сделок. | |
| public | setLimit() | Устанавливает ограничение количества объектов платежа. | |
| public | setStatus() | Устанавливает статус выбираемых сделок. | |
| public | toArray() | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize(). | |
| public | validate() | Проверяет валидность текущего объекта запроса. | |
| protected | getUnknownProperties() | Возвращает массив свойств которые не существуют, но были заданы у объекта. | |
| protected | setValidationError() | Устанавливает ошибку валидации. | |
| protected | validatePropertyValue() |
Details
-
Package: YooKassa\Request
-
Class Hierarchy:
- \YooKassa\Common\AbstractObject
- \YooKassa\Common\AbstractRequest
- \YooKassa\Request\Deals\DealsRequest
-
Implements:
-
See Also:
Tags
| Tag | Version | Description |
|---|---|---|
| category | Class | |
| author | cms@yoomoney.ru |
Constants
MAX_LIMIT_VALUE
MAX_LIMIT_VALUE = 100 : int
MAX_LENGTH_DESCRIPTION
MAX_LENGTH_DESCRIPTION = 128 : int
MIN_LENGTH_DESCRIPTION
MIN_LENGTH_DESCRIPTION = 4 : int
Properties
public $created_at_gt : null|\DateTime
Description
Время создания, от (не включая)
Type: DateTime
Details:
public $created_at_gte : null|\DateTime
Description
Время создания, от (включительно)
Type: DateTime
Details:
public $created_at_lt : null|\DateTime
Description
Время создания, до (не включая)
Type: DateTime
Details:
public $created_at_lte : null|\DateTime
Description
Время создания, до (включительно)
Type: DateTime
Details:
public $createdAtGt : null|\DateTime
Description
Время создания, от (не включая)
Type: DateTime
Details:
public $createdAtGte : null|\DateTime
Description
Время создания, от (включительно)
Type: DateTime
Details:
public $createdAtLt : null|\DateTime
Description
Время создания, до (не включая)
Type: DateTime
Details:
public $createdAtLte : null|\DateTime
Description
Время создания, до (включительно)
Type: DateTime
Details:
public $cursor : null|string
Description
Страница выдачи результатов, которую необходимо отобразить
Type: null|string
Details:
public $expires_at_gt : null|\DateTime
Description
Время автоматического закрытия, от (не включая)
Type: DateTime
Details:
public $expires_at_gte : null|\DateTime
Description
Время автоматического закрытия, от (включительно)
Type: DateTime
Details:
public $expires_at_lt : null|\DateTime
Description
Время автоматического закрытия, до (не включая)
Type: DateTime
Details:
public $expires_at_lte : null|\DateTime
Description
Время автоматического закрытия, до (включительно)
Type: DateTime
Details:
public $expiresAtGt : null|\DateTime
Description
Время автоматического закрытия, от (не включая)
Type: DateTime
Details:
public $expiresAtGte : null|\DateTime
Description
Время автоматического закрытия, от (включительно)
Type: DateTime
Details:
public $expiresAtLt : null|\DateTime
Description
Время автоматического закрытия, до (не включая)
Type: DateTime
Details:
public $expiresAtLte : null|\DateTime
Description
Время автоматического закрытия, до (включительно)
Type: DateTime
Details:
public $full_text_search : null|string
Description
Фильтр по описанию сделки — параметру description
Type: null|string
Details:
public $fullTextSearch : null|string
Description
Фильтр по описанию сделки — параметру description
Type: null|string
Details:
public $limit : null|int
Description
Ограничение количества объектов платежа, отображаемых на одной странице выдачи
Type: null|int
Details:
public $status : null|string
Description
Статус платежа
Type: null|string
Details:
Methods
public __construct() : mixed
public __construct(array|null $data = []) : mixed
Summary
AbstractObject constructor.
Details:
- Inherited From: \YooKassa\Common\AbstractObject
Parameters:
| Type | Name | Description |
|---|---|---|
array OR null |
data |
Returns: mixed -
public __get() : mixed
public __get(string $propertyName) : mixed
Summary
Возвращает значение свойства.
Details:
- Inherited From: \YooKassa\Common\AbstractObject
Parameters:
| Type | Name | Description |
|---|---|---|
string |
propertyName | Имя свойства |
Returns: mixed - Значение свойства
public __isset() : bool
public __isset(string $propertyName) : bool
Summary
Проверяет наличие свойства.
Details:
- Inherited From: \YooKassa\Common\AbstractObject
Parameters:
| Type | Name | Description |
|---|---|---|
string |
propertyName | Имя проверяемого свойства |
Returns: bool - True если свойство имеется, false если нет
public __set() : void
public __set(string $propertyName, mixed $value) : void
Summary
Устанавливает значение свойства.
Details:
- Inherited From: \YooKassa\Common\AbstractObject
Parameters:
| Type | Name | Description |
|---|---|---|
string |
propertyName | Имя свойства |
mixed |
value | Значение свойства |
Returns: void -
public __unset() : void
public __unset(string $propertyName) : void
Summary
Удаляет свойство.
Details:
- Inherited From: \YooKassa\Common\AbstractObject
Parameters:
| Type | Name | Description |
|---|---|---|
string |
propertyName | Имя удаляемого свойства |
Returns: void -
public builder() : \YooKassa\Request\Deals\DealsRequestBuilder
Static public builder() : \YooKassa\Request\Deals\DealsRequestBuilder
Summary
Возвращает инстанс билдера объектов запросов списка сделок магазина.
Details:
- Inherited From: \YooKassa\Request\Deals\DealsRequest
Returns: \YooKassa\Request\Deals\DealsRequestBuilder - Билдер объектов запросов списка сделок
public clearValidationError() : void
public clearValidationError() : void
Summary
Очищает статус валидации текущего запроса.
Details:
- Inherited From: \YooKassa\Common\AbstractRequest
Returns: void -
public fromArray() : void
public fromArray(array|\Traversable $sourceArray) : void
Summary
Устанавливает значения свойств текущего объекта из массива.
Details:
- Inherited From: \YooKassa\Common\AbstractObject
Parameters:
| Type | Name | Description |
|---|---|---|
array OR \Traversable |
sourceArray | Ассоциативный массив с настройками |
Returns: void -
public getCreatedAtGt() : null|\DateTime
public getCreatedAtGt() : null|\DateTime
Summary
Возвращает дату создания от которой будут возвращены платежи или null, если дата не была установлена.
Details:
- Inherited From: \YooKassa\Request\Deals\DealsRequest
Returns: null|\DateTime - Время создания, от (не включая)
public getCreatedAtGte() : null|\DateTime
public getCreatedAtGte() : null|\DateTime
Summary
Возвращает дату создания от которой будут возвращены платежи или null, если дата не была установлена.
Details:
- Inherited From: \YooKassa\Request\Deals\DealsRequest
Returns: null|\DateTime - Время создания, от (включительно)
public getCreatedAtLt() : null|\DateTime
public getCreatedAtLt() : null|\DateTime
Summary
Возвращает дату создания до которой будут возвращены платежи или null, если дата не была установлена.
Details:
- Inherited From: \YooKassa\Request\Deals\DealsRequest
Returns: null|\DateTime - Время создания, до (не включая)
public getCreatedAtLte() : null|\DateTime
public getCreatedAtLte() : null|\DateTime
Summary
Возвращает дату создания до которой будут возвращены платежи или null, если дата не была установлена.
Details:
- Inherited From: \YooKassa\Request\Deals\DealsRequest
Returns: null|\DateTime - Время создания, до (включительно)
public getCursor() : string|null
public getCursor() : string|null
Summary
Страница выдачи результатов, которую необходимо отобразить.
Details:
- Inherited From: \YooKassa\Request\Deals\DealsRequest
Returns: string|null -
public getExpiresAtGt() : null|\DateTime
public getExpiresAtGt() : null|\DateTime
Summary
Возвращает дату автоматического закрытия от которой будут возвращены платежи или null, если дата не была установлена.
Details:
- Inherited From: \YooKassa\Request\Deals\DealsRequest
Returns: null|\DateTime - Время автоматического закрытия, от (не включая)
public getExpiresAtGte() : null|\DateTime
public getExpiresAtGte() : null|\DateTime
Summary
Возвращает дату автоматического закрытия от которой будут возвращены платежи или null, если дата не была установлена.
Details:
- Inherited From: \YooKassa\Request\Deals\DealsRequest
Returns: null|\DateTime - Время автоматического закрытия, от (включительно)
public getExpiresAtLt() : null|\DateTime
public getExpiresAtLt() : null|\DateTime
Summary
Возвращает дату автоматического закрытия до которой будут возвращены платежи или null, если дата не была установлена.
Details:
- Inherited From: \YooKassa\Request\Deals\DealsRequest
Returns: null|\DateTime - Время автоматического закрытия, до (не включая)
public getExpiresAtLte() : null|\DateTime
public getExpiresAtLte() : null|\DateTime
Summary
Возвращает дату автоматического закрытия до которой будут возвращены платежи или null, если дата не была установлена.
Details:
- Inherited From: \YooKassa\Request\Deals\DealsRequest
Returns: null|\DateTime - Время автоматического закрытия, до (включительно)
public getFullTextSearch() : null|string
public getFullTextSearch() : null|string
Summary
Возвращает фильтр по описанию выбираемых сделок или null, если он до этого не был установлен.
Details:
- Inherited From: \YooKassa\Request\Deals\DealsRequest
Returns: null|string - Фильтр по описанию выбираемых сделок
public getLastValidationError() : string|null
public getLastValidationError() : string|null
Summary
Возвращает последнюю ошибку валидации.
Details:
- Inherited From: \YooKassa\Common\AbstractRequest
Returns: string|null - Последняя произошедшая ошибка валидации
public getLimit() : null|int
public getLimit() : null|int
Summary
Ограничение количества объектов платежа.
Details:
- Inherited From: \YooKassa\Request\Deals\DealsRequest
Returns: null|int - Ограничение количества объектов платежа
public getStatus() : null|string
public getStatus() : null|string
Summary
Возвращает статус выбираемых сделок или null, если он до этого не был установлен.
Details:
- Inherited From: \YooKassa\Request\Deals\DealsRequest
Returns: null|string - Статус выбираемых сделок
public getValidator() : \YooKassa\Validator\Validator
public getValidator() : \YooKassa\Validator\Validator
Details:
- Inherited From: \YooKassa\Common\AbstractObject
Returns: \YooKassa\Validator\Validator -
public hasCreatedAtGt() : bool
public hasCreatedAtGt() : bool
Summary
Проверяет, была ли установлена дата создания от которой выбираются платежи.
Details:
- Inherited From: \YooKassa\Request\Deals\DealsRequest
Returns: bool - True если дата была установлена, false если нет
public hasCreatedAtGte() : bool
public hasCreatedAtGte() : bool
Summary
Проверяет, была ли установлена дата создания от которой выбираются платежи.
Details:
- Inherited From: \YooKassa\Request\Deals\DealsRequest
Returns: bool - True если дата была установлена, false если нет
public hasCreatedAtLt() : bool
public hasCreatedAtLt() : bool
Summary
Проверяет, была ли установлена дата создания до которой выбираются платежи.
Details:
- Inherited From: \YooKassa\Request\Deals\DealsRequest
Returns: bool - True если дата была установлена, false если нет
public hasCreatedAtLte() : bool
public hasCreatedAtLte() : bool
Summary
Проверяет, была ли установлена дата создания до которой выбираются платежи.
Details:
- Inherited From: \YooKassa\Request\Deals\DealsRequest
Returns: bool - True если дата была установлена, false если нет
public hasCursor() : bool
public hasCursor() : bool
Summary
Проверяет, была ли установлена страница выдачи результатов, которую необходимо отобразить.
Details:
- Inherited From: \YooKassa\Request\Deals\DealsRequest
Returns: bool - True если была установлена, false если нет
public hasExpiresAtGt() : bool
public hasExpiresAtGt() : bool
Summary
Проверяет, была ли установлена дата автоматического закрытия от которой выбираются платежи.
Details:
- Inherited From: \YooKassa\Request\Deals\DealsRequest
Returns: bool - True если дата была установлена, false если нет
public hasExpiresAtGte() : bool
public hasExpiresAtGte() : bool
Summary
Проверяет, была ли установлена дата автоматического закрытия от которой выбираются платежи.
Details:
- Inherited From: \YooKassa\Request\Deals\DealsRequest
Returns: bool - True если дата была установлена, false если нет
public hasExpiresAtLt() : bool
public hasExpiresAtLt() : bool
Summary
Проверяет, была ли установлена дата автоматического закрытия до которой выбираются платежи.
Details:
- Inherited From: \YooKassa\Request\Deals\DealsRequest
Returns: bool - True если дата была установлена, false если нет
public hasExpiresAtLte() : bool
public hasExpiresAtLte() : bool
Summary
Проверяет, была ли установлена дата автоматического закрытия до которой выбираются платежи.
Details:
- Inherited From: \YooKassa\Request\Deals\DealsRequest
Returns: bool - True если дата была установлена, false если нет
public hasFullTextSearch() : bool
public hasFullTextSearch() : bool
Summary
Проверяет, был ли установлен фильтр по описанию выбираемых сделок.
Details:
- Inherited From: \YooKassa\Request\Deals\DealsRequest
Returns: bool - True если фильтр по описанию был установлен, false если нет
public hasLimit() : bool
public hasLimit() : bool
Summary
Проверяет, было ли установлено ограничение количества объектов платежа.
Details:
- Inherited From: \YooKassa\Request\Deals\DealsRequest
Returns: bool - True если было установлено, false если нет
public hasStatus() : bool
public hasStatus() : bool
Summary
Проверяет, был ли установлен статус выбираемых сделок.
Details:
- Inherited From: \YooKassa\Request\Deals\DealsRequest
Returns: bool - True если статус был установлен, false если нет
public jsonSerialize() : array
public jsonSerialize() : array
Summary
Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации.
Details:
- Inherited From: \YooKassa\Common\AbstractObject
Returns: array - Ассоциативный массив со свойствами текущего объекта
public offsetExists() : bool
public offsetExists(string $offset) : bool
Summary
Проверяет наличие свойства.
Details:
- Inherited From: \YooKassa\Common\AbstractObject
Parameters:
| Type | Name | Description |
|---|---|---|
string |
offset | Имя проверяемого свойства |
Returns: bool - True если свойство имеется, false если нет
public offsetGet() : mixed
public offsetGet(string $offset) : mixed
Summary
Возвращает значение свойства.
Details:
- Inherited From: \YooKassa\Common\AbstractObject
Parameters:
| Type | Name | Description |
|---|---|---|
string |
offset | Имя свойства |
Returns: mixed - Значение свойства
public offsetSet() : void
public offsetSet(string $offset, mixed $value) : void
Summary
Устанавливает значение свойства.
Details:
- Inherited From: \YooKassa\Common\AbstractObject
Parameters:
| Type | Name | Description |
|---|---|---|
string |
offset | Имя свойства |
mixed |
value | Значение свойства |
Returns: void -
public offsetUnset() : void
public offsetUnset(string $offset) : void
Summary
Удаляет свойство.
Details:
- Inherited From: \YooKassa\Common\AbstractObject
Parameters:
| Type | Name | Description |
|---|---|---|
string |
offset | Имя удаляемого свойства |
Returns: void -
public setCreatedAtGt() : self
public setCreatedAtGt(\DateTime|string|null $created_at_gt) : self
Summary
Устанавливает дату создания от которой выбираются платежи.
Details:
- Inherited From: \YooKassa\Request\Deals\DealsRequest
Parameters:
| Type | Name | Description |
|---|---|---|
\DateTime OR string OR null |
created_at_gt | Время создания, от (не включая) или null, чтобы удалить значение |
Returns: self -
public setCreatedAtGte() : self
public setCreatedAtGte(\DateTime|string|null $created_at_gte) : self
Summary
Устанавливает дату создания от которой выбираются платежи.
Details:
- Inherited From: \YooKassa\Request\Deals\DealsRequest
Parameters:
| Type | Name | Description |
|---|---|---|
\DateTime OR string OR null |
created_at_gte | Время создания, от (включительно) или null, чтобы удалить значение |
Returns: self -
public setCreatedAtLt() : self
public setCreatedAtLt(\DateTime|string|null $created_at_lt) : self
Summary
Устанавливает дату создания до которой выбираются платежи.
Details:
- Inherited From: \YooKassa\Request\Deals\DealsRequest
Parameters:
| Type | Name | Description |
|---|---|---|
\DateTime OR string OR null |
created_at_lt | Время создания, до (не включая) или null, чтобы удалить значение |
Returns: self -
public setCreatedAtLte() : self
public setCreatedAtLte(\DateTime|string|null $created_at_lte) : self
Summary
Устанавливает дату создания до которой выбираются платежи.
Details:
- Inherited From: \YooKassa\Request\Deals\DealsRequest
Parameters:
| Type | Name | Description |
|---|---|---|
\DateTime OR string OR null |
created_at_lte | Время создания, до (включительно) или null, чтобы удалить значение |
Returns: self -
public setCursor() : self
public setCursor(string|null $cursor) : self
Summary
Устанавливает страницу выдачи результатов, которую необходимо отобразить.
Details:
- Inherited From: \YooKassa\Request\Deals\DealsRequest
Parameters:
| Type | Name | Description |
|---|---|---|
string OR null |
cursor | Страница выдачи результатов или null, чтобы удалить значение |
Returns: self -
public setExpiresAtGt() : self
public setExpiresAtGt(\DateTime|string|null $expires_at_lt) : self
Summary
Устанавливает дату автоматического закрытия от которой выбираются платежи.
Details:
- Inherited From: \YooKassa\Request\Deals\DealsRequest
Parameters:
| Type | Name | Description |
|---|---|---|
\DateTime OR string OR null |
expires_at_lt | Время автоматического закрытия, от (не включая) или null, чтобы удалить значение |
Returns: self -
public setExpiresAtGte() : self
public setExpiresAtGte(\DateTime|string|null $expires_at_gte) : self
Summary
Устанавливает дату автоматического закрытия от которой выбираются платежи.
Details:
- Inherited From: \YooKassa\Request\Deals\DealsRequest
Parameters:
| Type | Name | Description |
|---|---|---|
\DateTime OR string OR null |
expires_at_gte | Время автоматического закрытия, от (включительно) или null, чтобы удалить значение |
Returns: self -
public setExpiresAtLt() : self
public setExpiresAtLt(\DateTime|string|null $expires_at_lt) : self
Summary
Устанавливает дату автоматического закрытия до которой выбираются платежи.
Details:
- Inherited From: \YooKassa\Request\Deals\DealsRequest
Parameters:
| Type | Name | Description |
|---|---|---|
\DateTime OR string OR null |
expires_at_lt | Время автоматического закрытия, до (не включая) или null, чтобы удалить значение |
Returns: self -
public setExpiresAtLte() : self
public setExpiresAtLte(\DateTime|string|null $expires_at_lte) : self
Summary
Устанавливает дату автоматического закрытия до которой выбираются платежи.
Details:
- Inherited From: \YooKassa\Request\Deals\DealsRequest
Parameters:
| Type | Name | Description |
|---|---|---|
\DateTime OR string OR null |
expires_at_lte | Время автоматического закрытия, до (включительно) или null, чтобы удалить значение |
Returns: self -
public setFullTextSearch() : self
public setFullTextSearch(string|null $full_text_search) : self
Summary
Устанавливает фильтр по описанию выбираемых сделок.
Details:
- Inherited From: \YooKassa\Request\Deals\DealsRequest
Parameters:
| Type | Name | Description |
|---|---|---|
string OR null |
full_text_search | Фильтр по описанию выбираемых сделок или null, чтобы удалить значение |
Returns: self -
public setLimit() : self
public setLimit(null|int $limit) : self
Summary
Устанавливает ограничение количества объектов платежа.
Details:
- Inherited From: \YooKassa\Request\Deals\DealsRequest
Parameters:
| Type | Name | Description |
|---|---|---|
null OR int |
limit | Ограничение количества объектов платежа или null, чтобы удалить значение |
Returns: self -
public setStatus() : self
public setStatus(string|null $status) : self
Summary
Устанавливает статус выбираемых сделок.
Details:
- Inherited From: \YooKassa\Request\Deals\DealsRequest
Parameters:
| Type | Name | Description |
|---|---|---|
string OR null |
status | Статус выбираемых сделок или null, чтобы удалить значение |
Returns: self -
public toArray() : array
public toArray() : array
Summary
Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize().
Details:
- Inherited From: \YooKassa\Common\AbstractObject
Returns: array - Ассоциативный массив со свойствами текущего объекта
public validate() : bool
public validate() : bool
Summary
Проверяет валидность текущего объекта запроса.
Details:
- Inherited From: \YooKassa\Request\Deals\DealsRequest
Returns: bool - True если объект валиден, false если нет
protected getUnknownProperties() : array
protected getUnknownProperties() : array
Summary
Возвращает массив свойств которые не существуют, но были заданы у объекта.
Details:
- Inherited From: \YooKassa\Common\AbstractObject
Returns: array - Ассоциативный массив с не существующими у текущего объекта свойствами
protected setValidationError() : void
protected setValidationError(string $value) : void
Summary
Устанавливает ошибку валидации.
Details:
- Inherited From: \YooKassa\Common\AbstractRequest
Parameters:
| Type | Name | Description |
|---|---|---|
string |
value | Ошибка, произошедшая при валидации объекта |
Returns: void -
protected validatePropertyValue() : mixed
protected validatePropertyValue(string $propertyName, mixed $propertyValue) : mixed
Details:
- Inherited From: \YooKassa\Common\AbstractObject
Parameters:
| Type | Name | Description |
|---|---|---|
string |
propertyName | |
mixed |
propertyValue |
Returns: mixed -
Top Namespaces
Reports
This document was automatically generated from source code comments on 2025-07-01 using phpDocumentor
© 2025 YooMoney