406 lines
13 KiB
Markdown
406 lines
13 KiB
Markdown
|
|
# [YooKassa API SDK](../home.md)
|
|||
|
|
|
|||
|
|
# Class: \YooKassa\Model\PersonalData\PersonalDataCancellationDetails
|
|||
|
|
### Namespace: [\YooKassa\Model\PersonalData](../namespaces/yookassa-model-personaldata.md)
|
|||
|
|
---
|
|||
|
|
**Summary:**
|
|||
|
|
|
|||
|
|
Класс, представляющий модель PersonalDataCancellationDetails.
|
|||
|
|
|
|||
|
|
**Description:**
|
|||
|
|
|
|||
|
|
Комментарий к статусу ~`canceled`: кто и по какой причине аннулировал хранение данных.
|
|||
|
|
|
|||
|
|
---
|
|||
|
|
### Constants
|
|||
|
|
* No constants found
|
|||
|
|
|
|||
|
|
---
|
|||
|
|
### Methods
|
|||
|
|
| Visibility | Name | Flag | Summary |
|
|||
|
|
| ----------:| ---- | ---- | ------- |
|
|||
|
|
| public | [__construct()](../classes/YooKassa-Common-AbstractObject.md#method___construct) | | AbstractObject constructor. |
|
|||
|
|
| public | [__get()](../classes/YooKassa-Common-AbstractObject.md#method___get) | | Возвращает значение свойства |
|
|||
|
|
| public | [__isset()](../classes/YooKassa-Common-AbstractObject.md#method___isset) | | Проверяет наличие свойства |
|
|||
|
|
| public | [__set()](../classes/YooKassa-Common-AbstractObject.md#method___set) | | Устанавливает значение свойства |
|
|||
|
|
| public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство |
|
|||
|
|
| public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива |
|
|||
|
|
| public | [getParty()](../classes/YooKassa-Model-PersonalData-PersonalDataCancellationDetails.md#method_getParty) | | Возвращает party. |
|
|||
|
|
| public | [getReason()](../classes/YooKassa-Model-PersonalData-PersonalDataCancellationDetails.md#method_getReason) | | Возвращает reason. |
|
|||
|
|
| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | |
|
|||
|
|
| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | |
|
|||
|
|
| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | |
|
|||
|
|
| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | |
|
|||
|
|
| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | |
|
|||
|
|
| public | [setParty()](../classes/YooKassa-Model-PersonalData-PersonalDataCancellationDetails.md#method_setParty) | | Устанавливает участника процесса, который принял решение о прекращении хранения персональных данных. |
|
|||
|
|
| public | [setReason()](../classes/YooKassa-Model-PersonalData-PersonalDataCancellationDetails.md#method_setReason) | | Устанавливает причину прекращения хранения персональных данных. |
|
|||
|
|
| public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() |
|
|||
|
|
| protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта |
|
|||
|
|
|
|||
|
|
---
|
|||
|
|
### Details
|
|||
|
|
* File: [lib/Model/PersonalData/PersonalDataCancellationDetails.php](../../lib/Model/PersonalData/PersonalDataCancellationDetails.php)
|
|||
|
|
* Package: YooKassa\Model
|
|||
|
|
* Class Hierarchy:
|
|||
|
|
* [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md)
|
|||
|
|
* \YooKassa\Model\PersonalData\PersonalDataCancellationDetails
|
|||
|
|
|
|||
|
|
---
|
|||
|
|
### Tags
|
|||
|
|
| Tag | Version | Description |
|
|||
|
|
| --- | ------- | ----------- |
|
|||
|
|
| author | | cms@yoomoney.ru |
|
|||
|
|
|
|||
|
|
---
|
|||
|
|
## Methods
|
|||
|
|
<a name="method___construct" class="anchor"></a>
|
|||
|
|
#### public __construct() : mixed
|
|||
|
|
|
|||
|
|
```php
|
|||
|
|
public __construct(array $data = array()) : mixed
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
**Summary**
|
|||
|
|
|
|||
|
|
AbstractObject constructor.
|
|||
|
|
|
|||
|
|
**Details:**
|
|||
|
|
* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md)
|
|||
|
|
|
|||
|
|
##### Parameters:
|
|||
|
|
| Type | Name | Description |
|
|||
|
|
| ---- | ---- | ----------- |
|
|||
|
|
| <code lang="php">array</code> | data | |
|
|||
|
|
|
|||
|
|
**Returns:** mixed -
|
|||
|
|
|
|||
|
|
|
|||
|
|
<a name="method___get" class="anchor"></a>
|
|||
|
|
#### public __get() : mixed
|
|||
|
|
|
|||
|
|
```php
|
|||
|
|
public __get(string $propertyName) : mixed
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
**Summary**
|
|||
|
|
|
|||
|
|
Возвращает значение свойства
|
|||
|
|
|
|||
|
|
**Details:**
|
|||
|
|
* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md)
|
|||
|
|
|
|||
|
|
##### Parameters:
|
|||
|
|
| Type | Name | Description |
|
|||
|
|
| ---- | ---- | ----------- |
|
|||
|
|
| <code lang="php">string</code> | propertyName | Имя свойства |
|
|||
|
|
|
|||
|
|
**Returns:** mixed - Значение свойства
|
|||
|
|
|
|||
|
|
|
|||
|
|
<a name="method___isset" class="anchor"></a>
|
|||
|
|
#### public __isset() : bool
|
|||
|
|
|
|||
|
|
```php
|
|||
|
|
public __isset(string $propertyName) : bool
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
**Summary**
|
|||
|
|
|
|||
|
|
Проверяет наличие свойства
|
|||
|
|
|
|||
|
|
**Details:**
|
|||
|
|
* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md)
|
|||
|
|
|
|||
|
|
##### Parameters:
|
|||
|
|
| Type | Name | Description |
|
|||
|
|
| ---- | ---- | ----------- |
|
|||
|
|
| <code lang="php">string</code> | propertyName | Имя проверяемого свойства |
|
|||
|
|
|
|||
|
|
**Returns:** bool - True если свойство имеется, false если нет
|
|||
|
|
|
|||
|
|
|
|||
|
|
<a name="method___set" class="anchor"></a>
|
|||
|
|
#### public __set() : mixed
|
|||
|
|
|
|||
|
|
```php
|
|||
|
|
public __set(string $propertyName, mixed $value) : mixed
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
**Summary**
|
|||
|
|
|
|||
|
|
Устанавливает значение свойства
|
|||
|
|
|
|||
|
|
**Details:**
|
|||
|
|
* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md)
|
|||
|
|
|
|||
|
|
##### Parameters:
|
|||
|
|
| Type | Name | Description |
|
|||
|
|
| ---- | ---- | ----------- |
|
|||
|
|
| <code lang="php">string</code> | propertyName | Имя свойства |
|
|||
|
|
| <code lang="php">mixed</code> | value | Значение свойства |
|
|||
|
|
|
|||
|
|
**Returns:** mixed -
|
|||
|
|
|
|||
|
|
|
|||
|
|
<a name="method___unset" class="anchor"></a>
|
|||
|
|
#### public __unset() : mixed
|
|||
|
|
|
|||
|
|
```php
|
|||
|
|
public __unset(string $propertyName) : mixed
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
**Summary**
|
|||
|
|
|
|||
|
|
Удаляет свойство
|
|||
|
|
|
|||
|
|
**Details:**
|
|||
|
|
* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md)
|
|||
|
|
|
|||
|
|
##### Parameters:
|
|||
|
|
| Type | Name | Description |
|
|||
|
|
| ---- | ---- | ----------- |
|
|||
|
|
| <code lang="php">string</code> | propertyName | Имя удаляемого свойства |
|
|||
|
|
|
|||
|
|
**Returns:** mixed -
|
|||
|
|
|
|||
|
|
|
|||
|
|
<a name="method_fromArray" class="anchor"></a>
|
|||
|
|
#### public fromArray() : mixed
|
|||
|
|
|
|||
|
|
```php
|
|||
|
|
public fromArray(array|\Traversable $sourceArray) : mixed
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
**Summary**
|
|||
|
|
|
|||
|
|
Устанавливает значения свойств текущего объекта из массива
|
|||
|
|
|
|||
|
|
**Details:**
|
|||
|
|
* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md)
|
|||
|
|
|
|||
|
|
##### Parameters:
|
|||
|
|
| Type | Name | Description |
|
|||
|
|
| ---- | ---- | ----------- |
|
|||
|
|
| <code lang="php">array OR \Traversable</code> | sourceArray | Ассоциативный массив с настройками |
|
|||
|
|
|
|||
|
|
**Returns:** mixed -
|
|||
|
|
|
|||
|
|
|
|||
|
|
<a name="method_getParty" class="anchor"></a>
|
|||
|
|
#### public getParty() : string
|
|||
|
|
|
|||
|
|
```php
|
|||
|
|
public getParty() : string
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
**Summary**
|
|||
|
|
|
|||
|
|
Возвращает party.
|
|||
|
|
|
|||
|
|
**Details:**
|
|||
|
|
* Inherited From: [\YooKassa\Model\PersonalData\PersonalDataCancellationDetails](../classes/YooKassa-Model-PersonalData-PersonalDataCancellationDetails.md)
|
|||
|
|
|
|||
|
|
**Returns:** string -
|
|||
|
|
|
|||
|
|
|
|||
|
|
<a name="method_getReason" class="anchor"></a>
|
|||
|
|
#### public getReason() : string
|
|||
|
|
|
|||
|
|
```php
|
|||
|
|
public getReason() : string
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
**Summary**
|
|||
|
|
|
|||
|
|
Возвращает reason.
|
|||
|
|
|
|||
|
|
**Details:**
|
|||
|
|
* Inherited From: [\YooKassa\Model\PersonalData\PersonalDataCancellationDetails](../classes/YooKassa-Model-PersonalData-PersonalDataCancellationDetails.md)
|
|||
|
|
|
|||
|
|
**Returns:** string -
|
|||
|
|
|
|||
|
|
|
|||
|
|
<a name="method_jsonSerialize" class="anchor"></a>
|
|||
|
|
#### public jsonSerialize() : mixed
|
|||
|
|
|
|||
|
|
```php
|
|||
|
|
public jsonSerialize() : mixed
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
**Details:**
|
|||
|
|
* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md)
|
|||
|
|
|
|||
|
|
**Returns:** mixed -
|
|||
|
|
|
|||
|
|
|
|||
|
|
<a name="method_offsetExists" class="anchor"></a>
|
|||
|
|
#### public offsetExists() : mixed
|
|||
|
|
|
|||
|
|
```php
|
|||
|
|
public offsetExists(mixed $offset) : mixed
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
**Details:**
|
|||
|
|
* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md)
|
|||
|
|
|
|||
|
|
##### Parameters:
|
|||
|
|
| Type | Name | Description |
|
|||
|
|
| ---- | ---- | ----------- |
|
|||
|
|
| <code lang="php">mixed</code> | offset | |
|
|||
|
|
|
|||
|
|
**Returns:** mixed -
|
|||
|
|
|
|||
|
|
|
|||
|
|
<a name="method_offsetGet" class="anchor"></a>
|
|||
|
|
#### public offsetGet() : mixed
|
|||
|
|
|
|||
|
|
```php
|
|||
|
|
public offsetGet(mixed $offset) : mixed
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
**Details:**
|
|||
|
|
* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md)
|
|||
|
|
|
|||
|
|
##### Parameters:
|
|||
|
|
| Type | Name | Description |
|
|||
|
|
| ---- | ---- | ----------- |
|
|||
|
|
| <code lang="php">mixed</code> | offset | |
|
|||
|
|
|
|||
|
|
**Returns:** mixed -
|
|||
|
|
|
|||
|
|
|
|||
|
|
<a name="method_offsetSet" class="anchor"></a>
|
|||
|
|
#### public offsetSet() : mixed
|
|||
|
|
|
|||
|
|
```php
|
|||
|
|
public offsetSet(mixed $offset, mixed $value) : mixed
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
**Details:**
|
|||
|
|
* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md)
|
|||
|
|
|
|||
|
|
##### Parameters:
|
|||
|
|
| Type | Name | Description |
|
|||
|
|
| ---- | ---- | ----------- |
|
|||
|
|
| <code lang="php">mixed</code> | offset | |
|
|||
|
|
| <code lang="php">mixed</code> | value | |
|
|||
|
|
|
|||
|
|
**Returns:** mixed -
|
|||
|
|
|
|||
|
|
|
|||
|
|
<a name="method_offsetUnset" class="anchor"></a>
|
|||
|
|
#### public offsetUnset() : mixed
|
|||
|
|
|
|||
|
|
```php
|
|||
|
|
public offsetUnset(mixed $offset) : mixed
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
**Details:**
|
|||
|
|
* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md)
|
|||
|
|
|
|||
|
|
##### Parameters:
|
|||
|
|
| Type | Name | Description |
|
|||
|
|
| ---- | ---- | ----------- |
|
|||
|
|
| <code lang="php">mixed</code> | offset | |
|
|||
|
|
|
|||
|
|
**Returns:** mixed -
|
|||
|
|
|
|||
|
|
|
|||
|
|
<a name="method_setParty" class="anchor"></a>
|
|||
|
|
#### public setParty() : self
|
|||
|
|
|
|||
|
|
```php
|
|||
|
|
public setParty(string $value) : self
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
**Summary**
|
|||
|
|
|
|||
|
|
Устанавливает участника процесса, который принял решение о прекращении хранения персональных данных.
|
|||
|
|
|
|||
|
|
**Details:**
|
|||
|
|
* Inherited From: [\YooKassa\Model\PersonalData\PersonalDataCancellationDetails](../classes/YooKassa-Model-PersonalData-PersonalDataCancellationDetails.md)
|
|||
|
|
|
|||
|
|
##### Parameters:
|
|||
|
|
| Type | Name | Description |
|
|||
|
|
| ---- | ---- | ----------- |
|
|||
|
|
| <code lang="php">string</code> | value | Участник процесса, который принял решение о прекращении хранения персональных данных |
|
|||
|
|
|
|||
|
|
**Returns:** self -
|
|||
|
|
|
|||
|
|
|
|||
|
|
<a name="method_setReason" class="anchor"></a>
|
|||
|
|
#### public setReason() : self
|
|||
|
|
|
|||
|
|
```php
|
|||
|
|
public setReason(string $value) : self
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
**Summary**
|
|||
|
|
|
|||
|
|
Устанавливает причину прекращения хранения персональных данных.
|
|||
|
|
|
|||
|
|
**Details:**
|
|||
|
|
* Inherited From: [\YooKassa\Model\PersonalData\PersonalDataCancellationDetails](../classes/YooKassa-Model-PersonalData-PersonalDataCancellationDetails.md)
|
|||
|
|
|
|||
|
|
##### Parameters:
|
|||
|
|
| Type | Name | Description |
|
|||
|
|
| ---- | ---- | ----------- |
|
|||
|
|
| <code lang="php">string</code> | value | Причина прекращения хранения персональных данных |
|
|||
|
|
|
|||
|
|
**Returns:** self -
|
|||
|
|
|
|||
|
|
|
|||
|
|
<a name="method_toArray" class="anchor"></a>
|
|||
|
|
#### public toArray() : array
|
|||
|
|
|
|||
|
|
```php
|
|||
|
|
public toArray() : array
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
**Summary**
|
|||
|
|
|
|||
|
|
Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации
|
|||
|
|
Является алиасом метода AbstractObject::jsonSerialize()
|
|||
|
|
|
|||
|
|
**Details:**
|
|||
|
|
* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md)
|
|||
|
|
|
|||
|
|
**Returns:** array - Ассоциативный массив со свойствами текущего объекта
|
|||
|
|
|
|||
|
|
|
|||
|
|
<a name="method_getUnknownProperties" class="anchor"></a>
|
|||
|
|
#### protected getUnknownProperties() : array
|
|||
|
|
|
|||
|
|
```php
|
|||
|
|
protected getUnknownProperties() : array
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
**Summary**
|
|||
|
|
|
|||
|
|
Возвращает массив свойств которые не существуют, но были заданы у объекта
|
|||
|
|
|
|||
|
|
**Details:**
|
|||
|
|
* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md)
|
|||
|
|
|
|||
|
|
**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
---
|
|||
|
|
|
|||
|
|
### Top Namespaces
|
|||
|
|
|
|||
|
|
* [\YooKassa](../namespaces/yookassa.md)
|
|||
|
|
|
|||
|
|
---
|
|||
|
|
|
|||
|
|
### Reports
|
|||
|
|
* [Errors - 0](../reports/errors.md)
|
|||
|
|
* [Markers - 1](../reports/markers.md)
|
|||
|
|
* [Deprecated - 25](../reports/deprecated.md)
|
|||
|
|
|
|||
|
|
---
|
|||
|
|
|
|||
|
|
This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/)
|
|||
|
|
|
|||
|
|
© 2023 YooMoney
|