11 KiB
YooKassa API SDK
Class: \YooKassa\Request\PersonalData\CreatePersonalDataRequestBuilder
Namespace: \YooKassa\Request\PersonalData
Summary:
Класс билдера объектов запросов к API на создание платежа
Examples
02-builder.php 11 78 Пример использования билдера
Constants
- No constants found
Properties
| Visibility | Name | Flag | Summary |
|---|---|---|---|
| protected | $currentObject | Собираемый объект запроса |
Methods
| Visibility | Name | Flag | Summary |
|---|---|---|---|
| public | __construct() | Конструктор, инициализирует пустой запрос, который в будущем начнём собирать | |
| public | build() | Строит и возвращает объект запроса для отправки в API ЮKassa | |
| public | setFirstName() | Устанавливает имя пользователя. | |
| public | setLastName() | Устанавливает фамилию пользователя. | |
| public | setMetadata() | Устанавливает метаданные, привязанные к платежу | |
| public | setMiddleName() | Устанавливает отчество пользователя. | |
| public | setOptions() | Устанавливает свойства запроса из массива | |
| public | setType() | Устанавливает тип персональных данных. | |
| protected | initCurrentObject() | Инициализирует объект запроса, который в дальнейшем будет собираться билдером |
Details
- File: lib/Request/PersonalData/CreatePersonalDataRequestBuilder.php
- Package: YooKassa
- Class Hierarchy:
- \YooKassa\Common\AbstractRequestBuilder
- \YooKassa\Request\PersonalData\CreatePersonalDataRequestBuilder
Properties
protected $currentObject : \YooKassa\Request\PersonalData\CreatePersonalDataRequest
Summary
Собираемый объект запроса
Type: CreatePersonalDataRequest
Details:
Methods
public __construct() : mixed
public __construct() : mixed
Summary
Конструктор, инициализирует пустой запрос, который в будущем начнём собирать
Details:
- Inherited From: \YooKassa\Common\AbstractRequestBuilder
Returns: mixed -
public build() : \YooKassa\Request\PersonalData\CreatePersonalDataRequestInterface|\YooKassa\Request\PersonalData\CreatePersonalDataRequest|\YooKassa\Common\AbstractRequest
public build(array|null $options = null) : \YooKassa\Request\PersonalData\CreatePersonalDataRequestInterface|\YooKassa\Request\PersonalData\CreatePersonalDataRequest|\YooKassa\Common\AbstractRequest
Summary
Строит и возвращает объект запроса для отправки в API ЮKassa
Details:
- Inherited From: \YooKassa\Request\PersonalData\CreatePersonalDataRequestBuilder
Parameters:
| Type | Name | Description |
|---|---|---|
array OR null |
options | Массив параметров для установки в объект запроса |
Throws:
| Type | Description |
|---|---|
| \YooKassa\Common\Exceptions\InvalidRequestException | Выбрасывается если собрать объект запроса не удалось |
Returns: \YooKassa\Request\PersonalData\CreatePersonalDataRequestInterface|\YooKassa\Request\PersonalData\CreatePersonalDataRequest|\YooKassa\Common\AbstractRequest - Инстанс объекта запроса
public setFirstName() : self
public setFirstName(string $value) : self
Summary
Устанавливает имя пользователя.
Details:
- Inherited From: \YooKassa\Request\PersonalData\CreatePersonalDataRequestBuilder
Parameters:
| Type | Name | Description |
|---|---|---|
string |
value | Имя пользователя. |
Returns: self -
public setLastName() : self
public setLastName(string $value) : self
Summary
Устанавливает фамилию пользователя.
Details:
- Inherited From: \YooKassa\Request\PersonalData\CreatePersonalDataRequestBuilder
Parameters:
| Type | Name | Description |
|---|---|---|
string |
value | Фамилия пользователя. |
Returns: self -
public setMetadata() : \YooKassa\Request\PersonalData\CreatePersonalDataRequestBuilder
public setMetadata(\YooKassa\Model\Metadata|array|null $value) : \YooKassa\Request\PersonalData\CreatePersonalDataRequestBuilder
Summary
Устанавливает метаданные, привязанные к платежу
Details:
- Inherited From: \YooKassa\Request\PersonalData\CreatePersonalDataRequestBuilder
Parameters:
| Type | Name | Description |
|---|---|---|
\YooKassa\Model\Metadata OR array OR null |
value | Метаданные платежа, устанавливаемые мерчантом |
Throws:
| Type | Description |
|---|---|
| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если переданные данные не удалось интерпретировать как метаданные платежа |
Returns: \YooKassa\Request\PersonalData\CreatePersonalDataRequestBuilder - Инстанс текущего билдера
public setMiddleName() : self
public setMiddleName(string $value) : self
Summary
Устанавливает отчество пользователя.
Details:
- Inherited From: \YooKassa\Request\PersonalData\CreatePersonalDataRequestBuilder
Parameters:
| Type | Name | Description |
|---|---|---|
string |
value | Отчество пользователя. |
Returns: self -
public setOptions() : \YooKassa\Common\AbstractRequestBuilder
public setOptions(array|\Traversable $options) : \YooKassa\Common\AbstractRequestBuilder
Summary
Устанавливает свойства запроса из массива
Details:
- Inherited From: \YooKassa\Common\AbstractRequestBuilder
Parameters:
| Type | Name | Description |
|---|---|---|
array OR \Traversable |
options | Массив свойств запроса |
Throws:
| Type | Description |
|---|---|
| \InvalidArgumentException | Выбрасывается если аргумент не массив и не итерируемый объект |
| \YooKassa\Common\Exceptions\InvalidPropertyException | Выбрасывается если не удалось установить один из параметров, переданныч в массиве настроек |
Returns: \YooKassa\Common\AbstractRequestBuilder - Инстанс текущего билдера запросов
public setType() : self
public setType(string $value) : self
Summary
Устанавливает тип персональных данных.
Details:
- Inherited From: \YooKassa\Request\PersonalData\CreatePersonalDataRequestBuilder
Parameters:
| Type | Name | Description |
|---|---|---|
string |
value | Тип персональных данных |
Returns: self - Инстанс билдера запросов
protected initCurrentObject() : \YooKassa\Request\PersonalData\CreatePersonalDataRequest
protected initCurrentObject() : \YooKassa\Request\PersonalData\CreatePersonalDataRequest
Summary
Инициализирует объект запроса, который в дальнейшем будет собираться билдером
Details:
- Inherited From: \YooKassa\Request\PersonalData\CreatePersonalDataRequestBuilder
Returns: \YooKassa\Request\PersonalData\CreatePersonalDataRequest - Инстанс собираемого объекта запроса к API
Top Namespaces
Reports
This document was automatically generated from source code comments on 2023-04-06 using phpDocumentor
© 2023 YooMoney