meraproject/vendor/yoomoney/yookassa-sdk-php/docs/classes/YooKassa-Request-PersonalData-CreatePersonalDataRequest.md

YooKassa API SDK

Class: \YooKassa\Request\PersonalData\CreatePersonalDataRequest

Namespace: \YooKassa\Request\PersonalData

---

Summary:

Класс, представляющий модель CreatePersonalDataRequest.

---

Constants

Visibility	Name	Flag	Summary
public	MAX_LENGTH_LAST_NAME		Максимальная длина строки фамилии или отчества
public	MAX_LENGTH_FIRST_NAME		Максимальная длина строки имени

---

Properties

Visibility	Name	Flag	Summary
public	$first_name		Имя пользователя
public	$firstName		Имя пользователя
public	$last_name		Фамилия пользователя
public	$lastName		Фамилия пользователя
public	$metadata		Метаданные персональных данных указанные мерчантом
public	$middle_name		Отчество пользователя
public	$middleName		Отчество пользователя
public	$type		Тип персональных данных

---

Methods

Visibility	Name	Flag	Summary
public	__construct()		AbstractObject constructor.
public	__get()		Возвращает значение свойства
public	__isset()		Проверяет наличие свойства
public	__set()		Устанавливает значение свойства
public	__unset()		Удаляет свойство
public	builder()		Возвращает билдер объектов запросов создания платежа
public	clearValidationError()		Очищает статус валидации текущего запроса
public	fromArray()		Устанавливает значения свойств текущего объекта из массива
public	getFirstName()		Возвращает имя пользователя.
public	getLastName()		Возвращает фамилию пользователя.
public	getLastValidationError()		Возвращает последнюю ошибку валидации
public	getMetadata()		Возвращает метаданные.
public	getMiddleName()		Возвращает отчество пользователя.
public	getType()		Возвращает тип персональных данных.
public	hasFirstName()		Проверяет наличие имени пользователя в запросе
public	hasLastName()		Проверяет наличие фамилии пользователя в запросе
public	hasMetadata()		Проверяет, были ли установлены метаданные
public	hasMiddleName()		Проверяет наличие отчества пользователя в запросе
public	hasType()		Проверяет наличие типа персональных данных в запросе
public	jsonSerialize()
public	offsetExists()
public	offsetGet()
public	offsetSet()
public	offsetUnset()
public	setFirstName()		Устанавливает имя пользователя.
public	setLastName()		Устанавливает фамилию пользователя.
public	setMetadata()		Устанавливает метаданные.
public	setMiddleName()		Устанавливает отчество пользователя.
public	setType()		Устанавливает тип персональных данных.
public	toArray()		Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize()
public	validate()		Проверяет на валидность текущий объект
protected	getUnknownProperties()		Возвращает массив свойств которые не существуют, но были заданы у объекта
protected	setValidationError()		Устанавливает ошибку валидации

---

Details

• File: lib/Request/PersonalData/CreatePersonalDataRequest.php
• Package: YooKassa\Model
• Class Hierarchy:
  • \YooKassa\Common\AbstractObject
  • \YooKassa\Common\AbstractRequest
  • \YooKassa\Request\PersonalData\CreatePersonalDataRequest
• Implements:
  • \YooKassa\Request\PersonalData\CreatePersonalDataRequestInterface

---

Tags

Tag	Version	Description
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 $first_name : string

---

Description

Имя пользователя

Type: string

Details:

public $firstName : string

---

Description

Имя пользователя

Type: string

Details:

public $last_name : string

---

Description

Фамилия пользователя

Type: string

Details:

public $lastName : string

---

Description

Фамилия пользователя

Type: string

Details:

public $metadata : \YooKassa\Model\Metadata

---

Description

Метаданные персональных данных указанные мерчантом

Type: Metadata

Details:

public $middle_name : string

---

Description

Отчество пользователя

Type: string

Details:

public $middleName : string

---

Description

Отчество пользователя

Type: string

Details:

public $type : string

---

Description

Тип персональных данных

Type: string

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 builder() : \YooKassa\Request\PersonalData\CreatePersonalDataRequestBuilder

Static public builder() : \YooKassa\Request\PersonalData\CreatePersonalDataRequestBuilder

Summary

Возвращает билдер объектов запросов создания платежа

Details:

• Inherited From: \YooKassa\Request\PersonalData\CreatePersonalDataRequest

Returns: \YooKassa\Request\PersonalData\CreatePersonalDataRequestBuilder - Инстанс билдера объектов запросов

public clearValidationError() : mixed

public clearValidationError() : mixed

Summary

Очищает статус валидации текущего запроса

Details:

• Inherited From: \YooKassa\Common\AbstractRequest

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 getFirstName() : string

public getFirstName() : string

Summary

Возвращает имя пользователя.

Details:

• Inherited From: \YooKassa\Request\PersonalData\CreatePersonalDataRequest

Returns: string - Имя пользователя

public getLastName() : string

public getLastName() : string

Summary

Возвращает фамилию пользователя.

Details:

• Inherited From: \YooKassa\Request\PersonalData\CreatePersonalDataRequest

Returns: string - Фамилия пользователя

public getLastValidationError() : string

public getLastValidationError() : string

Summary

Возвращает последнюю ошибку валидации

Details:

• Inherited From: \YooKassa\Common\AbstractRequest

Returns: string - Последняя произошедшая ошибка валидации

public getMetadata() : \YooKassa\Model\Metadata

public getMetadata() : \YooKassa\Model\Metadata

Summary

Возвращает метаданные.

Details:

• Inherited From: \YooKassa\Request\PersonalData\CreatePersonalDataRequest

Returns: \YooKassa\Model\Metadata - Метаданные

public getMiddleName() : string|null

public getMiddleName() : string|null

Summary

Возвращает отчество пользователя.

Details:

• Inherited From: \YooKassa\Request\PersonalData\CreatePersonalDataRequest

Returns: string|null - Отчество пользователя

public getType() : string

public getType() : string

Summary

Возвращает тип персональных данных.

Details:

• Inherited From: \YooKassa\Request\PersonalData\CreatePersonalDataRequest

Returns: string - Тип персональных данных

public hasFirstName() : bool

public hasFirstName() : bool

Summary

Проверяет наличие имени пользователя в запросе

Details:

• Inherited From: \YooKassa\Request\PersonalData\CreatePersonalDataRequest

Returns: bool - True если имя пользователя задано, false если нет

public hasLastName() : bool

public hasLastName() : bool

Summary

Проверяет наличие фамилии пользователя в запросе

Details:

• Inherited From: \YooKassa\Request\PersonalData\CreatePersonalDataRequest

Returns: bool - True если фамилия пользователя задана, false если нет

public hasMetadata() : bool

public hasMetadata() : bool

Summary

Проверяет, были ли установлены метаданные

Details:

• Inherited From: \YooKassa\Request\PersonalData\CreatePersonalDataRequest

Returns: bool - True если метаданные были установлены, false если нет

public hasMiddleName() : bool

public hasMiddleName() : bool

Summary

Проверяет наличие отчества пользователя в запросе

Details:

• Inherited From: \YooKassa\Request\PersonalData\CreatePersonalDataRequest

Returns: bool - True если отчество пользователя задано, false если нет

public hasType() : bool

public hasType() : bool

Summary

Проверяет наличие типа персональных данных в запросе

Details:

• Inherited From: \YooKassa\Request\PersonalData\CreatePersonalDataRequest

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 setFirstName() : $this

public setFirstName(string $first_name) : $this

Summary

Устанавливает имя пользователя.

Details:

• Inherited From: \YooKassa\Request\PersonalData\CreatePersonalDataRequest

Parameters:

Type	Name	Description
string	first_name	Имя пользователя.

Returns: $this -

public setLastName() : $this

public setLastName(string $last_name) : $this

Summary

Устанавливает фамилию пользователя.

Details:

• Inherited From: \YooKassa\Request\PersonalData\CreatePersonalDataRequest

Parameters:

Type	Name	Description
string	last_name	Фамилия пользователя.

Returns: $this -

public setMetadata() : $this

public setMetadata(\YooKassa\Model\Metadata|array|null $metadata = null) : $this

Summary

Устанавливает метаданные.

Details:

• Inherited From: \YooKassa\Request\PersonalData\CreatePersonalDataRequest

Parameters:

Type	Name	Description
\YooKassa\Model\Metadata OR array OR null	metadata	Метаданные

Returns: $this -

public setMiddleName() : $this

public setMiddleName(string|null $middle_name = null) : $this

Summary

Устанавливает отчество пользователя.

Details:

• Inherited From: \YooKassa\Request\PersonalData\CreatePersonalDataRequest

Parameters:

Type	Name	Description
string OR null	middle_name	Отчество пользователя

Returns: $this -

public setType() : $this

public setType(string $type) : $this

Summary

Устанавливает тип персональных данных.

Details:

• Inherited From: \YooKassa\Request\PersonalData\CreatePersonalDataRequest

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 - Ассоциативный массив со свойствами текущего объекта

public validate() : bool

public validate() : bool

Summary

Проверяет на валидность текущий объект

Details:

• Inherited From: \YooKassa\Request\PersonalData\CreatePersonalDataRequest

Returns: bool - True если объект запроса валиден, false если нет

protected getUnknownProperties() : array

protected getUnknownProperties() : array

Summary

Возвращает массив свойств которые не существуют, но были заданы у объекта

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Returns: array - Ассоциативный массив с не существующими у текущего объекта свойствами

protected setValidationError() : mixed

protected setValidationError(string $value) : mixed

Summary

Устанавливает ошибку валидации

Details:

• Inherited From: \YooKassa\Common\AbstractRequest

Parameters:

Type	Name	Description
string	value	Ошибка, произошедшая при валидации объекта

Returns: mixed -

---

Top Namespaces

• \YooKassa

---

Reports

• Errors - 0
• Markers - 1
• Deprecated - 25

---

This document was automatically generated from source code comments on 2023-04-06 using phpDocumentor

© 2023 YooMoney