Добавлены нулевые привязки по СБП Добавлена причина отмены возвратов `payment_expired`
23 KiB
YooKassa API SDK
Abstract Class: \YooKassa\Request\PersonalData\PersonalDataType\AbstractPersonalDataRequest
Namespace: \YooKassa\Request\PersonalData\PersonalDataType
Summary:
Класс, представляющий модель PersonalDataRequest.
Description:
Данные для запроса сохранения персональных данных.
Constants
| Visibility | Name | Flag | Summary |
|---|---|---|---|
| public | MAX_LENGTH_LAST_NAME | Максимальная длина строки фамилии или отчества | |
| public | MAX_LENGTH_FIRST_NAME | Максимальная длина строки имени |
Properties
| Visibility | Name | Flag | Summary |
|---|---|---|---|
| public | $metadata | Любые дополнительные данные, которые нужны вам для работы (например, ваш внутренний идентификатор заказа). | |
| public | $type | Тип персональных данных. | |
| protected | $_metadata | Любые дополнительные данные, которые нужны вам для работы (например, ваш внутренний идентификатор заказа). | |
| protected | $_type | Тип персональных данных — цель, для которой вы будете использовать данные |
Methods
| Visibility | Name | Flag | Summary |
|---|---|---|---|
| public | __construct() | AbstractObject constructor. | |
| public | __get() | Возвращает значение свойства. | |
| public | __isset() | Проверяет наличие свойства. | |
| public | __set() | Устанавливает значение свойства. | |
| public | __unset() | Удаляет свойство. | |
| public | clearValidationError() | Очищает статус валидации текущего запроса. | |
| public | fromArray() | Устанавливает значения свойств текущего объекта из массива. | |
| public | getLastValidationError() | Возвращает последнюю ошибку валидации. | |
| public | getMetadata() | Возвращает metadata. | |
| public | getType() | Возвращает type. | |
| public | getValidator() | ||
| public | hasMetadata() | Проверяет, были ли установлены метаданные. | |
| public | hasType() | Проверяет наличие типа персональных данных в запросе. | |
| public | jsonSerialize() | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации. | |
| public | offsetExists() | Проверяет наличие свойства. | |
| public | offsetGet() | Возвращает значение свойства. | |
| public | offsetSet() | Устанавливает значение свойства. | |
| public | offsetUnset() | Удаляет свойство. | |
| public | setMetadata() | Устанавливает metadata. | |
| public | setType() | Устанавливает type. | |
| public | toArray() | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize(). | |
| public | validate() | Валидирует текущий запрос, проверяет все ли нужные свойства установлены. | |
| protected | getUnknownProperties() | Возвращает массив свойств которые не существуют, но были заданы у объекта. | |
| protected | setValidationError() | Устанавливает ошибку валидации. | |
| protected | validatePropertyValue() |
Details
-
File: lib/Request/PersonalData/PersonalDataType/AbstractPersonalDataRequest.php
-
Package: YooKassa\Model
-
Class Hierarchy:
- \YooKassa\Common\AbstractObject
- \YooKassa\Common\AbstractRequest
- \YooKassa\Request\PersonalData\PersonalDataType\AbstractPersonalDataRequest
-
See Also:
Tags
| Tag | Version | Description |
|---|---|---|
| category | Class | |
| author | cms@yoomoney.ru |
Constants
MAX_LENGTH_LAST_NAME
Максимальная длина строки фамилии или отчества
MAX_LENGTH_LAST_NAME = 200
MAX_LENGTH_FIRST_NAME
Максимальная длина строки имени
MAX_LENGTH_FIRST_NAME = 100
Properties
public $metadata : \YooKassa\Model\Metadata
Description
Любые дополнительные данные, которые нужны вам для работы (например, ваш внутренний идентификатор заказа).
Type: Metadata
Details:
public $type : string
Description
Тип персональных данных.
Type: string
Details:
protected $_metadata : ?\YooKassa\Model\Metadata
Summary
Любые дополнительные данные, которые нужны вам для работы (например, ваш внутренний идентификатор заказа).
Description
Передаются в виде набора пар «ключ-значение» и возвращаются в ответе от ЮKassa. Ограничения: максимум 16 ключей, имя ключа не больше 32 символов, значение ключа не больше 512 символов, тип данных — строка в формате UTF-8.
Type: Metadata
Details:
protected $_type : ?string
Summary
Тип персональных данных — цель, для которой вы будете использовать данные
Type: ?string
Details:
Methods
public __construct() : mixed
public __construct(array|null $data = []) : mixed
Summary
AbstractObject constructor.
Details:
- Inherited From: \YooKassa\Common\AbstractObject
Parameters:
| Type | Name | Description |
|---|---|---|
array OR null |
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() : void
public __set(string $propertyName, mixed $value) : void
Summary
Устанавливает значение свойства.
Details:
- Inherited From: \YooKassa\Common\AbstractObject
Parameters:
| Type | Name | Description |
|---|---|---|
string |
propertyName | Имя свойства |
mixed |
value | Значение свойства |
Returns: void -
public __unset() : void
public __unset(string $propertyName) : void
Summary
Удаляет свойство.
Details:
- Inherited From: \YooKassa\Common\AbstractObject
Parameters:
| Type | Name | Description |
|---|---|---|
string |
propertyName | Имя удаляемого свойства |
Returns: void -
public clearValidationError() : void
public clearValidationError() : void
Summary
Очищает статус валидации текущего запроса.
Details:
- Inherited From: \YooKassa\Common\AbstractRequest
Returns: void -
public fromArray() : void
public fromArray(array|\Traversable $sourceArray) : void
Summary
Устанавливает значения свойств текущего объекта из массива.
Details:
- Inherited From: \YooKassa\Common\AbstractObject
Parameters:
| Type | Name | Description |
|---|---|---|
array OR \Traversable |
sourceArray | Ассоциативный массив с настройками |
Returns: void -
public getLastValidationError() : string|null
public getLastValidationError() : string|null
Summary
Возвращает последнюю ошибку валидации.
Details:
- Inherited From: \YooKassa\Common\AbstractRequest
Returns: string|null - Последняя произошедшая ошибка валидации
public getMetadata() : \YooKassa\Model\Metadata|null
public getMetadata() : \YooKassa\Model\Metadata|null
Summary
Возвращает metadata.
Details:
Returns: \YooKassa\Model\Metadata|null -
public getType() : string|null
public getType() : string|null
Summary
Возвращает type.
Details:
Returns: string|null -
public getValidator() : \YooKassa\Validator\Validator
public getValidator() : \YooKassa\Validator\Validator
Details:
- Inherited From: \YooKassa\Common\AbstractObject
Returns: \YooKassa\Validator\Validator -
public hasMetadata() : bool
public hasMetadata() : bool
Summary
Проверяет, были ли установлены метаданные.
Details:
Returns: bool - True если метаданные были установлены, false если нет
public hasType() : bool
public hasType() : bool
Summary
Проверяет наличие типа персональных данных в запросе.
Details:
Returns: bool - True если тип персональных данных задан, false если нет
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 setMetadata() : self
public setMetadata(\YooKassa\Model\Metadata|array|null $value = null) : self
Summary
Устанавливает metadata.
Details:
Parameters:
| Type | Name | Description |
|---|---|---|
\YooKassa\Model\Metadata OR array OR null |
value | Любые дополнительные данные, которые нужны вам для работы (например, ваш внутренний идентификатор заказа). Передаются в виде набора пар «ключ-значение» и возвращаются в ответе от ЮKassa. Ограничения: максимум 16 ключей, имя ключа не больше 32 символов, значение ключа не больше 512 символов, тип данных — строка в формате UTF-8. |
Returns: self -
public setType() : self
public setType(string|null $type = null) : self
Summary
Устанавливает type.
Details:
Parameters:
| Type | Name | Description |
|---|---|---|
string OR null |
type |
Returns: self -
public toArray() : array
public toArray() : array
Summary
Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize().
Details:
- Inherited From: \YooKassa\Common\AbstractObject
Returns: array - Ассоциативный массив со свойствами текущего объекта
public validate() : bool
Abstract public validate() : bool
Summary
Валидирует текущий запрос, проверяет все ли нужные свойства установлены.
Details:
- Inherited From: \YooKassa\Common\AbstractRequest
Returns: bool - True если запрос валиден, false если нет
protected getUnknownProperties() : array
protected getUnknownProperties() : array
Summary
Возвращает массив свойств которые не существуют, но были заданы у объекта.
Details:
- Inherited From: \YooKassa\Common\AbstractObject
Returns: array - Ассоциативный массив с не существующими у текущего объекта свойствами
protected setValidationError() : void
protected setValidationError(string $value) : void
Summary
Устанавливает ошибку валидации.
Details:
- Inherited From: \YooKassa\Common\AbstractRequest
Parameters:
| Type | Name | Description |
|---|---|---|
string |
value | Ошибка, произошедшая при валидации объекта |
Returns: void -
protected validatePropertyValue() : mixed
protected validatePropertyValue(string $propertyName, mixed $propertyValue) : mixed
Details:
- Inherited From: \YooKassa\Common\AbstractObject
Parameters:
| Type | Name | Description |
|---|---|---|
string |
propertyName | |
mixed |
propertyValue |
Returns: mixed -
Top Namespaces
Reports
This document was automatically generated from source code comments on 2026-06-29 using phpDocumentor
© 2026 YooMoney