11 KiB
YooKassa API SDK
Class: \YooKassa\Request\Payments\PaymentsResponse
Namespace: \YooKassa\Request\Payments
Summary:
Класс объекта ответа от API со списком платежей магазина
Constants
- No constants found
Methods
| Visibility | Name | Flag | Summary |
|---|---|---|---|
| public | __construct() | AbstractObject constructor. | |
| public | __get() | Возвращает значение свойства | |
| public | __isset() | Проверяет наличие свойства | |
| public | __set() | Устанавливает значение свойства | |
| public | __unset() | Удаляет свойство | |
| public | fromArray() | Конструктор, устанавливает свойства объекта из пришедшего из API ассоциативного массива | |
| public | getItems() | Возвращает список платежей | |
| public | getNextCursor() | Возвращает токен следующей страницы, если он задан, или null | |
| public | hasNextCursor() | Проверяет, имеется ли в ответе токен следующей страницы | |
| public | jsonSerialize() | ||
| public | offsetExists() | ||
| public | offsetGet() | ||
| public | offsetSet() | ||
| public | offsetUnset() | ||
| public | toArray() | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | |
| protected | getUnknownProperties() | Возвращает массив свойств которые не существуют, но были заданы у объекта |
Details
- File: lib/Request/Payments/PaymentsResponse.php
- Package: YooKassa
- Class Hierarchy:
- \YooKassa\Common\AbstractObject
- \YooKassa\Request\Payments\PaymentsResponse
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 fromArray() : mixed
public fromArray(array $sourceArray) : mixed
Summary
Конструктор, устанавливает свойства объекта из пришедшего из API ассоциативного массива
Details:
- Inherited From: \YooKassa\Request\Payments\PaymentsResponse
Parameters:
| Type | Name | Description |
|---|---|---|
array |
sourceArray | Массив настроек, пришедший от API |
Throws:
| Type | Description |
|---|---|
| \Exception |
Returns: mixed -
public getItems() : \YooKassa\Model\PaymentInterface[]
public getItems() : \YooKassa\Model\PaymentInterface[]
Summary
Возвращает список платежей
Details:
- Inherited From: \YooKassa\Request\Payments\PaymentsResponse
Returns: \YooKassa\Model\PaymentInterface[] - Список платежей
public getNextCursor() : string|null
public getNextCursor() : string|null
Summary
Возвращает токен следующей страницы, если он задан, или null
Details:
- Inherited From: \YooKassa\Request\Payments\PaymentsResponse
Returns: string|null - Токен следующей страницы
public hasNextCursor() : bool
public hasNextCursor() : bool
Summary
Проверяет, имеется ли в ответе токен следующей страницы
Details:
- Inherited From: \YooKassa\Request\Payments\PaymentsResponse
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 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 2023-04-06 using phpDocumentor
© 2023 YooMoney