meraproject/vendor/yoomoney/yookassa-sdk-php/docs/classes/YooKassa-Request-Deals-DealsRequest.md

YooKassa API SDK

Class: \YooKassa\Request\Deals\DealsRequest

Namespace: \YooKassa\Request\Deals

---

Summary:

Класс объекта запроса к API для получения списка сделок магазина

---

Constants

Visibility	Name	Flag	Summary
public	MAX_LIMIT_VALUE		Максимальное количество объектов платежа в выборке
public	MIN_LENGTH_DESCRIPTION		Минимальное количество символов для поиска

---

Properties

Visibility	Name	Flag	Summary
public	$createdAtGt		Время создания, от (не включая)
public	$createdAtGte		Время создания, от (включительно)
public	$createdAtLt		Время создания, до (не включая)
public	$createdAtLte		Время создания, до (включительно)
public	$cursor		Страница выдачи результатов, которую необходимо отобразить
public	$expiresAtGt		Время автоматического закрытия, от (не включая)
public	$expiresAtGte		Время автоматического закрытия, от (включительно)
public	$expiresAtLt		Время автоматического закрытия, до (не включая)
public	$expiresAtLte		Время автоматического закрытия, до (включительно)
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	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()
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()		Устанавливает ошибку валидации

---

Details

• File: lib/Request/Deals/DealsRequest.php
• Package: YooKassa
• Class Hierarchy:
  • \YooKassa\Common\AbstractObject
  • \YooKassa\Common\AbstractRequest
  • \YooKassa\Request\Deals\DealsRequest
• Implements:
  • \YooKassa\Request\Deals\DealsRequestInterface

---

Constants

MAX_LIMIT_VALUE

Максимальное количество объектов платежа в выборке

MAX_LIMIT_VALUE = 100

MIN_LENGTH_DESCRIPTION

Минимальное количество символов для поиска

MIN_LENGTH_DESCRIPTION = 4

---

Properties

public $createdAtGt : \DateTime|null

---

Description

Время создания, от (не включая)

Type: DateTime|null

Details:

public $createdAtGte : \DateTime|null

---

Description

Время создания, от (включительно)

Type: DateTime|null

Details:

public $createdAtLt : \DateTime|null

---

Description

Время создания, до (не включая)

Type: DateTime|null

Details:

public $createdAtLte : \DateTime|null

---

Description

Время создания, до (включительно)

Type: DateTime|null

Details:

public $cursor : string|null

---

Description

Страница выдачи результатов, которую необходимо отобразить

Type: string|null

Details:

public $expiresAtGt : \DateTime|null

---

Description

Время автоматического закрытия, от (не включая)

Type: DateTime|null

Details:

public $expiresAtGte : \DateTime|null

---

Description

Время автоматического закрытия, от (включительно)

Type: DateTime|null

Details:

public $expiresAtLt : \DateTime|null

---

Description

Время автоматического закрытия, до (не включая)

Type: DateTime|null

Details:

public $expiresAtLte : \DateTime|null

---

Description

Время автоматического закрытия, до (включительно)

Type: DateTime|null

Details:

public $fullTextSearch : string|null

---

Description

Фильтр по описанию сделки — параметру description

Type: string|null

Details:

public $limit : int|null

---

Description

Ограничение количества объектов платежа, отображаемых на одной странице выдачи

Type: int|null

Details:

public $status : string|null

---

Description

Статус платежа

Type: string|null

Details:

---

Methods

public __construct() : mixed

public __construct(array $data = array()) : mixed

Summary

AbstractObject constructor.

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

Type	Name	Description
array	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() : mixed

public __set(string $propertyName, mixed $value) : mixed

Summary

Устанавливает значение свойства

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

Type	Name	Description
string	propertyName	Имя свойства
mixed	value	Значение свойства

Returns: mixed -

public __unset() : mixed

public __unset(string $propertyName) : mixed

Summary

Удаляет свойство

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

Type	Name	Description
string	propertyName	Имя удаляемого свойства

Returns: mixed -

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() : mixed

public clearValidationError() : mixed

Summary

Очищает статус валидации текущего запроса

Details:

• Inherited From: \YooKassa\Common\AbstractRequest

Returns: mixed -

public fromArray() : mixed

public fromArray(array|\Traversable $sourceArray) : mixed

Summary

Устанавливает значения свойств текущего объекта из массива

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

Type	Name	Description
array OR \Traversable	sourceArray	Ассоциативный массив с настройками

Returns: mixed -

public getCreatedAtGt() : \DateTime|null

public getCreatedAtGt() : \DateTime|null

Summary

Возвращает дату создания от которой будут возвращены платежи или null, если дата не была установлена

Details:

• Inherited From: \YooKassa\Request\Deals\DealsRequest

Returns: \DateTime|null - Время создания, от (не включая)

public getCreatedAtGte() : \DateTime|null

public getCreatedAtGte() : \DateTime|null

Summary

Возвращает дату создания от которой будут возвращены платежи или null, если дата не была установлена

Details:

• Inherited From: \YooKassa\Request\Deals\DealsRequest

Returns: \DateTime|null - Время создания, от (включительно)

public getCreatedAtLt() : \DateTime|null

public getCreatedAtLt() : \DateTime|null

Summary

Возвращает дату создания до которой будут возвращены платежи или null, если дата не была установлена

Details:

• Inherited From: \YooKassa\Request\Deals\DealsRequest

Returns: \DateTime|null - Время создания, до (не включая)

public getCreatedAtLte() : \DateTime|null

public getCreatedAtLte() : \DateTime|null

Summary

Возвращает дату создания до которой будут возвращены платежи или null, если дата не была установлена

Details:

• Inherited From: \YooKassa\Request\Deals\DealsRequest

Returns: \DateTime|null - Время создания, до (включительно)

public getCursor() : string|null

public getCursor() : string|null

Summary

Страница выдачи результатов, которую необходимо отобразить

Details:

• Inherited From: \YooKassa\Request\Deals\DealsRequest

Returns: string|null -

public getExpiresAtGt() : \DateTime|null

public getExpiresAtGt() : \DateTime|null

Summary

Возвращает дату автоматического закрытия от которой будут возвращены платежи или null, если дата не была установлена

Details:

• Inherited From: \YooKassa\Request\Deals\DealsRequest

Returns: \DateTime|null - Время автоматического закрытия, от (не включая)

public getExpiresAtGte() : \DateTime|null

public getExpiresAtGte() : \DateTime|null

Summary

Возвращает дату автоматического закрытия от которой будут возвращены платежи или null, если дата не была установлена

Details:

• Inherited From: \YooKassa\Request\Deals\DealsRequest

Returns: \DateTime|null - Время автоматического закрытия, от (включительно)

public getExpiresAtLt() : \DateTime|null

public getExpiresAtLt() : \DateTime|null

Summary

Возвращает дату автоматического закрытия до которой будут возвращены платежи или null, если дата не была установлена

Details:

• Inherited From: \YooKassa\Request\Deals\DealsRequest

Returns: \DateTime|null - Время автоматического закрытия, до (не включая)

public getExpiresAtLte() : \DateTime|null

public getExpiresAtLte() : \DateTime|null

Summary

Возвращает дату автоматического закрытия до которой будут возвращены платежи или null, если дата не была установлена

Details:

• Inherited From: \YooKassa\Request\Deals\DealsRequest

Returns: \DateTime|null - Время автоматического закрытия, до (включительно)

public getFullTextSearch() : string|null

public getFullTextSearch() : string|null

Summary

Возвращает фильтр по описанию выбираемых сделок или null, если он до этого не был установлен

Details:

• Inherited From: \YooKassa\Request\Deals\DealsRequest

Returns: string|null - Фильтр по описанию выбираемых сделок

public getLastValidationError() : string

public getLastValidationError() : string

Summary

Возвращает последнюю ошибку валидации

Details:

• Inherited From: \YooKassa\Common\AbstractRequest

Returns: string - Последняя произошедшая ошибка валидации

public getLimit() : int|null

public getLimit() : int|null

Summary

Ограничение количества объектов платежа

Details:

• Inherited From: \YooKassa\Request\Deals\DealsRequest

Returns: int|null - Ограничение количества объектов платежа

public getStatus() : string|null

public getStatus() : string|null

Summary

Возвращает статус выбираемых сделок или null, если он до этого не был установлен

Details:

• Inherited From: \YooKassa\Request\Deals\DealsRequest

Returns: string|null - Статус выбираемых сделок

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() : mixed

public jsonSerialize() : mixed

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Returns: mixed -

public offsetExists() : mixed

public offsetExists(mixed $offset) : mixed

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

Type	Name	Description
mixed	offset

Returns: mixed -

public offsetGet() : mixed

public offsetGet(mixed $offset) : mixed

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

Type	Name	Description
mixed	offset

Returns: mixed -

public offsetSet() : mixed

public offsetSet(mixed $offset, mixed $value) : mixed

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

Type	Name	Description
mixed	offset
mixed	value

Returns: mixed -

public offsetUnset() : mixed

public offsetUnset(mixed $offset) : mixed

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

Type	Name	Description
mixed	offset

Returns: mixed -

public setCreatedAtGt() : void

public setCreatedAtGt(\DateTime|string|int|null $value) : void

Summary

Устанавливает дату создания от которой выбираются платежи

Details:

• Inherited From: \YooKassa\Request\Deals\DealsRequest

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: void -

public setCreatedAtGte() : void

public setCreatedAtGte(\DateTime|string|int|null $value) : void

Summary

Устанавливает дату создания от которой выбираются платежи

Details:

• Inherited From: \YooKassa\Request\Deals\DealsRequest

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: void -

public setCreatedAtLt() : void

public setCreatedAtLt(\DateTime|string|int|null $value) : void

Summary

Устанавливает дату создания до которой выбираются платежи

Details:

• Inherited From: \YooKassa\Request\Deals\DealsRequest

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: void -

public setCreatedAtLte() : void

public setCreatedAtLte(\DateTime|string|int|null $value) : void

Summary

Устанавливает дату создания до которой выбираются платежи

Details:

• Inherited From: \YooKassa\Request\Deals\DealsRequest

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: void -

public setCursor() : void

public setCursor(string $value) : void

Summary

Устанавливает страницу выдачи результатов, которую необходимо отобразить

Details:

• Inherited From: \YooKassa\Request\Deals\DealsRequest

Parameters:

Type	Name	Description
string	value	Страница выдачи результатов или null, чтобы удалить значение

Throws:

Type	Description
\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException	Выбрасывается если в метод была передана не строка

Returns: void -

public setExpiresAtGt() : void

public setExpiresAtGt(\DateTime|string|int|null $value) : void

Summary

Устанавливает дату автоматического закрытия от которой выбираются платежи

Details:

• Inherited From: \YooKassa\Request\Deals\DealsRequest

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: void -

public setExpiresAtGte() : void

public setExpiresAtGte(\DateTime|string|int|null $value) : void

Summary

Устанавливает дату автоматического закрытия от которой выбираются платежи

Details:

• Inherited From: \YooKassa\Request\Deals\DealsRequest

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: void -

public setExpiresAtLt() : void

public setExpiresAtLt(\DateTime|string|int|null $value) : void

Summary

Устанавливает дату автоматического закрытия до которой выбираются платежи

Details:

• Inherited From: \YooKassa\Request\Deals\DealsRequest

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: void -

public setExpiresAtLte() : void

public setExpiresAtLte(\DateTime|string|int|null $value) : void

Summary

Устанавливает дату автоматического закрытия до которой выбираются платежи

Details:

• Inherited From: \YooKassa\Request\Deals\DealsRequest

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: void -

public setFullTextSearch() : void

public setFullTextSearch(string $value) : void

Summary

Устанавливает фильтр по описанию выбираемых сделок

Details:

• Inherited From: \YooKassa\Request\Deals\DealsRequest

Parameters:

Type	Name	Description
string	value	Фильтр по описанию выбираемых сделок или null, чтобы удалить значение

Throws:

Type	Description
\YooKassa\Common\Exceptions\InvalidPropertyValueException	Выбрасывается если переданное значение не является валидным
\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException	Выбрасывается если в метод была передана не строка

Returns: void -

public setLimit() : void

public setLimit(int|null $value) : void

Summary

Устанавливает ограничение количества объектов платежа

Details:

• Inherited From: \YooKassa\Request\Deals\DealsRequest

Parameters:

Type	Name	Description
int OR null	value	Ограничение количества объектов платежа или null, чтобы удалить значение

Throws:

Type	Description
\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException	Выбрасывается, если в метод было передано не целое число

Returns: void -

public setStatus() : void

public setStatus(string $value) : void

Summary

Устанавливает статус выбираемых сделок

Details:

• Inherited From: \YooKassa\Request\Deals\DealsRequest

Parameters:

Type	Name	Description
string	value	Статус выбираемых сделок или null, чтобы удалить значение

Throws:

Type	Description
\YooKassa\Common\Exceptions\InvalidPropertyValueException	Выбрасывается если переданное значение не является валидным статусом
\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException	Выбрасывается если в метод была передана не строка

Returns: void -

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() : mixed

protected setValidationError(string $value) : mixed

Summary

Устанавливает ошибку валидации

Details:

• Inherited From: \YooKassa\Common\AbstractRequest

Parameters:

Type	Name	Description
string	value	Ошибка, произошедшая при валидации объекта

Returns: mixed -

---

Top Namespaces

• \YooKassa

---

Reports

• Errors - 0
• Markers - 1
• Deprecated - 25

---

This document was automatically generated from source code comments on 2023-04-06 using phpDocumentor

© 2023 YooMoney