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

YooKassa API SDK

Class: \YooKassa\Request\Deals\CreateDealRequest

Namespace: \YooKassa\Request\Deals

---

Summary:

Класс объекта запроса к API на проведение новой сделки

---

Constants

• No constants found

---

Properties

Visibility	Name	Flag	Summary
public	$description		Описание сделки
public	$fee_moment		Момент перечисления вам вознаграждения платформы
public	$feeMoment		Момент перечисления вам вознаграждения платформы
public	$metadata		Метаданные привязанные к сделке
public	$type		Тип сделки

---

Methods

Visibility	Name	Flag	Summary
public	__construct()		AbstractObject constructor.
public	__get()		Возвращает значение свойства
public	__isset()		Проверяет наличие свойства
public	__set()		Устанавливает значение свойства
public	__unset()		Удаляет свойство
public	builder()		Возвращает билдер объектов запросов создания сделки
public	clearValidationError()		Очищает статус валидации текущего запроса
public	fromArray()		Устанавливает значения свойств текущего объекта из массива
public	getDescription()		Возвращает описание сделки
public	getFeeMoment()		Возвращает момент перечисления вам вознаграждения платформы
public	getLastValidationError()		Возвращает последнюю ошибку валидации
public	getMetadata()		Возвращает данные оплаты установленные мерчантом
public	getType()		Возвращает тип сделки
public	hasDescription()		Проверяет наличие описания в создаваемой сделке
public	hasFeeMoment()		Проверяет, был ли установлен момент перечисления вознаграждения
public	hasMetadata()		Проверяет, были ли установлены метаданные заказа
public	hasType()		Проверяет наличие типа в создаваемой сделке
public	jsonSerialize()
public	offsetExists()
public	offsetGet()
public	offsetSet()
public	offsetUnset()
public	setDescription()		Устанавливает описание сделки
public	setFeeMoment()		Устанавливает момент перечисления вам вознаграждения платформы
public	setMetadata()		Устанавливает метаданные, привязанные к платежу
public	setType()		Устанавливает тип сделки
public	toArray()		Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize()
public	validate()		Проверяет на валидность текущий объект
protected	getUnknownProperties()		Возвращает массив свойств которые не существуют, но были заданы у объекта
protected	setValidationError()		Устанавливает ошибку валидации

---

Details

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

---

Tags

Tag	Version	Description
todo:		@example 02-builder.php 11 78 Пример использования билдера

---

Properties

public $description : string

---

Description

Описание сделки

Type: string

Details:

public $fee_moment : string

---

Description

Момент перечисления вам вознаграждения платформы

Type: string

Details:

public $feeMoment : string

---

Description

Момент перечисления вам вознаграждения платформы

Type: string

Details:

public $metadata : \YooKassa\Model\Metadata

---

Description

Метаданные привязанные к сделке

Type: Metadata

Details:

public $type : string

---

Description

Тип сделки

Type: string

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\CreateDealRequestBuilder

Static public builder() : \YooKassa\Request\Deals\CreateDealRequestBuilder

Summary

Возвращает билдер объектов запросов создания сделки

Details:

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

Returns: \YooKassa\Request\Deals\CreateDealRequestBuilder - Инстанс билдера объектов запросов

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 getDescription() : string

public getDescription() : string

Summary

Возвращает описание сделки

Details:

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

Returns: string -

public getFeeMoment() : string

public getFeeMoment() : string

Summary

Возвращает момент перечисления вам вознаграждения платформы

Details:

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

Returns: string - Момент перечисления вам вознаграждения платформы

public getLastValidationError() : string

public getLastValidationError() : string

Summary

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

Details:

• Inherited From: \YooKassa\Common\AbstractRequest

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

public getMetadata() : \YooKassa\Model\Metadata

public getMetadata() : \YooKassa\Model\Metadata

Summary

Возвращает данные оплаты установленные мерчантом

Details:

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

Returns: \YooKassa\Model\Metadata - Метаданные, привязанные к платежу

public getType() : string

public getType() : string

Summary

Возвращает тип сделки

Details:

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

Returns: string - Тип сделки

public hasDescription() : bool

public hasDescription() : bool

Summary

Проверяет наличие описания в создаваемой сделке

Details:

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

Returns: bool - True если описание сделки есть, false если нет

public hasFeeMoment() : bool

public hasFeeMoment() : bool

Summary

Проверяет, был ли установлен момент перечисления вознаграждения

Details:

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

Returns: bool - True если момент перечисления был установлен, false если нет

public hasMetadata() : bool

public hasMetadata() : bool

Summary

Проверяет, были ли установлены метаданные заказа

Details:

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

Returns: bool - True если метаданные были установлены, false если нет

public hasType() : bool

public hasType() : bool

Summary

Проверяет наличие типа в создаваемой сделке

Details:

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

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

public setDescription(string $value) : mixed

Summary

Устанавливает описание сделки

Details:

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

Parameters:

Type	Name	Description
string	value

Throws:

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

Returns: mixed -

public setFeeMoment() : mixed

public setFeeMoment(string $value) : mixed

Summary

Устанавливает момент перечисления вам вознаграждения платформы

Details:

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

Parameters:

Type	Name	Description
string	value	Момент перечисления вам вознаграждения платформы

Throws:

Type	Description
\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException	Генерируется если переданный аргумент не является строкой
\YooKassa\Common\Exceptions\InvalidPropertyValueException	Генерируется если переданный аргумент не из списка FeeMoment

Returns: mixed -

public setMetadata() : mixed

public setMetadata(\YooKassa\Model\Metadata|array|null $value) : mixed

Summary

Устанавливает метаданные, привязанные к платежу

Details:

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

Parameters:

Type	Name	Description
\YooKassa\Model\Metadata OR array OR null	value	Метаданные платежа, устанавливаемые мерчантом

Throws:

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

Returns: mixed -

public setType() : mixed

public setType(string $value) : mixed

Summary

Устанавливает тип сделки

Details:

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

Parameters:

Type	Name	Description
string	value	Тип сделки

Throws:

Type	Description
\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException	Генерируется если переданный аргумент не является строкой
\YooKassa\Common\Exceptions\InvalidPropertyValueException	Генерируется если переданный аргумент не из списка DealType

Returns: mixed -

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\CreateDealRequest

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