Антон Н. Николаев
13 KiB
YooKassa API SDK
Class: \YooKassa\Model\Deal\CaptureDealData
Namespace: \YooKassa\Model\Deal
Summary:
Class CaptureDealData
Constants
- No constants found
Properties
| Visibility | Name | Flag | Summary |
|---|---|---|---|
| public | $settlements | Данные о распределении денег |
Methods
| Visibility | Name | Flag | Summary |
|---|---|---|---|
| public | __construct() | AbstractObject constructor. | |
| public | __get() | Возвращает значение свойства | |
| public | __isset() | Проверяет наличие свойства | |
| public | __set() | Устанавливает значение свойства | |
| public | __unset() | Удаляет свойство | |
| public | addSettlement() | Добавляет оплату в чек | |
| public | fromArray() | Устанавливает значения свойств текущего объекта из массива | |
| public | getSettlements() | Возвращает массив оплат, обеспечивающих выдачу товара | |
| public | jsonSerialize() | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | |
| public | offsetExists() | Проверяет наличие свойства | |
| public | offsetGet() | Возвращает значение свойства | |
| public | offsetSet() | Устанавливает значение свойства | |
| public | offsetUnset() | Удаляет свойство | |
| public | setSettlements() | Возвращает массив оплат, обеспечивающих выдачу товара | |
| public | toArray() | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | |
| protected | getUnknownProperties() | Возвращает массив свойств которые не существуют, но были заданы у объекта |
Details
- File: lib/Model/Deal/CaptureDealData.php
- Package: YooKassa
- Class Hierarchy:
- \YooKassa\Common\AbstractObject
- \YooKassa\Model\Deal\CaptureDealData
Properties
public $settlements : \YooKassa\Model\Deal\SettlementPayoutPayment[]
Description
Данные о распределении денег
Type: SettlementPayoutPayment[]
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 addSettlement() : mixed
public addSettlement(\YooKassa\Model\SettlementInterface $value) : mixed
Summary
Добавляет оплату в чек
Details:
- Inherited From: \YooKassa\Model\Deal\CaptureDealData
Parameters:
| Type | Name | Description |
|---|---|---|
\YooKassa\Model\SettlementInterface |
value | Объект добавляемой в чек позиции |
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 getSettlements() : \YooKassa\Model\SettlementInterface[]
public getSettlements() : \YooKassa\Model\SettlementInterface[]
Summary
Возвращает массив оплат, обеспечивающих выдачу товара
Details:
- Inherited From: \YooKassa\Model\Deal\CaptureDealData
Returns: \YooKassa\Model\SettlementInterface[] - Массив оплат, обеспечивающих выдачу товара.
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 setSettlements() : mixed
public setSettlements(\YooKassa\Model\SettlementInterface[]|array $value) : mixed
Summary
Возвращает массив оплат, обеспечивающих выдачу товара
Details:
- Inherited From: \YooKassa\Model\Deal\CaptureDealData
Parameters:
| Type | Name | Description |
|---|---|---|
\YooKassa\Model\SettlementInterface[] OR array |
value |
Returns: mixed -
public toArray() : array
public toArray() : array
Summary
Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize()
Details:
- Inherited From: \YooKassa\Common\AbstractObject
Returns: array - Ассоциативный массив со свойствами текущего объекта
protected getUnknownProperties() : array
protected getUnknownProperties() : array
Summary
Возвращает массив свойств которые не существуют, но были заданы у объекта
Details:
- Inherited From: \YooKassa\Common\AbstractObject
Returns: array - Ассоциативный массив с не существующими у текущего объекта свойствами
Top Namespaces
Reports
This document was automatically generated from source code comments on 2024-06-05 using phpDocumentor
© 2024 YooMoney