25 KiB
YooKassa API SDK
Class: \YooKassa\Request\PersonalData\PersonalDataResponse
Namespace: \YooKassa\Request\PersonalData
Summary:
Класс, представляющий модель PersonalData.
Description:
Информация о персональных данных
Constants
- No constants found
Properties
| Visibility | Name | Flag | Summary |
|---|---|---|---|
| public | $cancellation_details | Комментарий к отмене выплаты | |
| public | $cancellationDetails | Комментарий к отмене выплаты | |
| public | $created_at | Время создания персональных данных | |
| public | $createdAt | Время создания персональных данных | |
| public | $expires_at | Срок жизни объекта персональных данных | |
| public | $expiresAt | Срок жизни объекта персональных данных | |
| public | $id | Идентификатор персональных данных | |
| public | $metadata | Метаданные выплаты указанные мерчантом | |
| public | $status | Текущий статус персональных данных | |
| public | $type | Тип персональных данных |
Methods
| Visibility | Name | Flag | Summary |
|---|---|---|---|
| public | __construct() | AbstractObject constructor. | |
| public | __get() | Возвращает значение свойства | |
| public | __isset() | Проверяет наличие свойства | |
| public | __set() | Устанавливает значение свойства | |
| public | __unset() | Удаляет свойство | |
| public | fromArray() | Устанавливает значения свойств текущего объекта из массива | |
| public | getCancellationDetails() | Возвращает cancellation_details. | |
| public | getCreatedAt() | Возвращает created_at. | |
| public | getExpiresAt() | Возвращает срок жизни объекта персональных данных. | |
| public | getId() | Возвращает id. | |
| public | getMetadata() | Возвращает любые дополнительные данные. | |
| public | getStatus() | Возвращает статус персональных данных. | |
| public | getType() | Возвращает тип персональных данных. | |
| public | jsonSerialize() | ||
| public | offsetExists() | ||
| public | offsetGet() | ||
| public | offsetSet() | ||
| public | offsetUnset() | ||
| public | setCancellationDetails() | Устанавливает cancellation_details. | |
| public | setCreatedAt() | Устанавливает время создания персональных данных. | |
| public | setExpiresAt() | Устанавливает срок жизни объекта персональных данных. | |
| public | setId() | Устанавливает id. | |
| public | setMetadata() | Устанавливает любые дополнительные данные. | |
| public | setStatus() | Устанавливает статус персональных данных. | |
| public | setType() | Устанавливает тип персональных данных. | |
| public | toArray() | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | |
| protected | getUnknownProperties() | Возвращает массив свойств которые не существуют, но были заданы у объекта |
Details
- File: lib/Request/PersonalData/PersonalDataResponse.php
- Package: YooKassa\Model
- Class Hierarchy:
- \YooKassa\Common\AbstractObject
- \YooKassa\Model\PersonalData\PersonalData
- \YooKassa\Request\PersonalData\PersonalDataResponse
Tags
| Tag | Version | Description |
|---|---|---|
| author | cms@yoomoney.ru |
Properties
public $cancellation_details : \YooKassa\Model\PersonalData\PersonalDataCancellationDetails
Description
Комментарий к отмене выплаты
Type: PersonalDataCancellationDetails
Details:
- Inherited From: \YooKassa\Model\PersonalData\PersonalData
public $cancellationDetails : \YooKassa\Model\PersonalData\PersonalDataCancellationDetails
Description
Комментарий к отмене выплаты
Type: PersonalDataCancellationDetails
Details:
- Inherited From: \YooKassa\Model\PersonalData\PersonalData
public $created_at : \DateTime
Description
Время создания персональных данных
Type: \DateTime
Details:
- Inherited From: \YooKassa\Model\PersonalData\PersonalData
public $createdAt : \DateTime
Description
Время создания персональных данных
Type: \DateTime
Details:
- Inherited From: \YooKassa\Model\PersonalData\PersonalData
public $expires_at : \DateTime|null
Description
Срок жизни объекта персональных данных
Type: DateTime|null
Details:
- Inherited From: \YooKassa\Model\PersonalData\PersonalData
public $expiresAt : \DateTime|null
Description
Срок жизни объекта персональных данных
Type: DateTime|null
Details:
- Inherited From: \YooKassa\Model\PersonalData\PersonalData
public $id : string
Description
Идентификатор персональных данных
Type: string
Details:
- Inherited From: \YooKassa\Model\PersonalData\PersonalData
public $metadata : \YooKassa\Model\Metadata
Description
Метаданные выплаты указанные мерчантом
Type: Metadata
Details:
- Inherited From: \YooKassa\Model\PersonalData\PersonalData
public $status : string
Description
Текущий статус персональных данных
Type: string
Details:
- Inherited From: \YooKassa\Model\PersonalData\PersonalData
public $type : string
Description
Тип персональных данных
Type: string
Details:
- Inherited From: \YooKassa\Model\PersonalData\PersonalData
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|\Traversable $sourceArray) : mixed
Summary
Устанавливает значения свойств текущего объекта из массива
Details:
- Inherited From: \YooKassa\Common\AbstractObject
Parameters:
| Type | Name | Description |
|---|---|---|
array OR \Traversable |
sourceArray | Ассоциативный массив с настройками |
Returns: mixed -
public getCancellationDetails() : \YooKassa\Model\PersonalData\PersonalDataCancellationDetails|null
public getCancellationDetails() : \YooKassa\Model\PersonalData\PersonalDataCancellationDetails|null
Summary
Возвращает cancellation_details.
Details:
- Inherited From: \YooKassa\Model\PersonalData\PersonalData
Returns: \YooKassa\Model\PersonalData\PersonalDataCancellationDetails|null -
public getCreatedAt() : \DateTime
public getCreatedAt() : \DateTime
Summary
Возвращает created_at.
Details:
- Inherited From: \YooKassa\Model\PersonalData\PersonalData
Returns: \DateTime -
public getExpiresAt() : \DateTime|null
public getExpiresAt() : \DateTime|null
Summary
Возвращает срок жизни объекта персональных данных.
Details:
- Inherited From: \YooKassa\Model\PersonalData\PersonalData
Returns: \DateTime|null - Срок жизни объекта персональных данных
public getId() : string
public getId() : string
Summary
Возвращает id.
Details:
- Inherited From: \YooKassa\Model\PersonalData\PersonalData
Returns: string -
public getMetadata() : array|null
public getMetadata() : array|null
Summary
Возвращает любые дополнительные данные.
Details:
- Inherited From: \YooKassa\Model\PersonalData\PersonalData
Returns: array|null - Любые дополнительные данные
public getStatus() : string
public getStatus() : string
Summary
Возвращает статус персональных данных.
Details:
- Inherited From: \YooKassa\Model\PersonalData\PersonalData
Returns: string - Статус персональных данных
public getType() : string
public getType() : string
Summary
Возвращает тип персональных данных.
Details:
- Inherited From: \YooKassa\Model\PersonalData\PersonalData
Returns: string - Тип персональных данных
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 setCancellationDetails() : $this
public setCancellationDetails(\YooKassa\Model\PersonalData\PersonalDataCancellationDetails|array|null $cancellation_details) : $this
Summary
Устанавливает cancellation_details.
Details:
- Inherited From: \YooKassa\Model\PersonalData\PersonalData
Parameters:
| Type | Name | Description |
|---|---|---|
\YooKassa\Model\PersonalData\PersonalDataCancellationDetails OR array OR null |
cancellation_details |
Returns: $this -
public setCreatedAt() : $this
public setCreatedAt(\DateTime|string|int $created_at) : $this
Summary
Устанавливает время создания персональных данных.
Details:
- Inherited From: \YooKassa\Model\PersonalData\PersonalData
Parameters:
| Type | Name | Description |
|---|---|---|
\DateTime OR string OR int |
created_at | Время создания персональных данных |
Throws:
| Type | Description |
|---|---|
| \Exception |
Returns: $this -
public setExpiresAt() : $this
public setExpiresAt(\DateTime|string|int|null $expires_at = null) : $this
Summary
Устанавливает срок жизни объекта персональных данных.
Details:
- Inherited From: \YooKassa\Model\PersonalData\PersonalData
Parameters:
| Type | Name | Description |
|---|---|---|
\DateTime OR string OR int OR null |
expires_at | Срок жизни объекта персональных данных |
Throws:
| Type | Description |
|---|---|
| \Exception |
Returns: $this -
public setId() : $this
public setId(string $id) : $this
Summary
Устанавливает id.
Details:
- Inherited From: \YooKassa\Model\PersonalData\PersonalData
Parameters:
| Type | Name | Description |
|---|---|---|
string |
id | Идентификатор персональных данных, сохраненных в ЮKassa. |
Returns: $this -
public setMetadata() : $this
public setMetadata(\YooKassa\Model\Metadata|array|null $metadata = null) : $this
Summary
Устанавливает любые дополнительные данные.
Details:
- Inherited From: \YooKassa\Model\PersonalData\PersonalData
Parameters:
| Type | Name | Description |
|---|---|---|
\YooKassa\Model\Metadata OR array OR null |
metadata | Любые дополнительные данные |
Returns: $this -
public setStatus() : $this
public setStatus(string $status) : $this
Summary
Устанавливает статус персональных данных.
Details:
- Inherited From: \YooKassa\Model\PersonalData\PersonalData
Parameters:
| Type | Name | Description |
|---|---|---|
string |
status | Статус персональных данных |
Returns: $this -
public setType() : $this
public setType(string $type) : $this
Summary
Устанавливает тип персональных данных.
Details:
- Inherited From: \YooKassa\Model\PersonalData\PersonalData
Parameters:
| Type | Name | Description |
|---|---|---|
string |
type | Тип персональных данных |
Returns: $this -
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