8.8 KiB
YooKassa API SDK
Class: \YooKassa\Request\SelfEmployed\SelfEmployedRequestBuilder
Namespace: \YooKassa\Request\SelfEmployed
Summary:
Класс билдера объектов запросов к API на создание самозанятого
Constants
- No constants found
Properties
| Visibility | Name | Flag | Summary |
|---|---|---|---|
| protected | $currentObject | Собираемый объект запроса |
Methods
| Visibility | Name | Flag | Summary |
|---|---|---|---|
| public | __construct() | Конструктор, инициализирует пустой запрос, который в будущем начнём собирать | |
| public | build() | Строит и возвращает объект запроса для отправки в API ЮKassa | |
| public | setConfirmation() | Устанавливает сценарий подтверждения. | |
| public | setItn() | Устанавливает ИНН самозанятого | |
| public | setOptions() | Устанавливает свойства запроса из массива | |
| public | setPhone() | Устанавливает телефон самозанятого. | |
| protected | initCurrentObject() | Инициализирует объект запроса, который в дальнейшем будет собираться билдером |
Details
- File: lib/Request/SelfEmployed/SelfEmployedRequestBuilder.php
- Package: YooKassa
- Class Hierarchy:
- \YooKassa\Common\AbstractRequestBuilder
- \YooKassa\Request\SelfEmployed\SelfEmployedRequestBuilder
Tags
| Tag | Version | Description |
|---|---|---|
| todo | @example 02-builder.php 11 78 Пример использования билдера |
Properties
protected $currentObject : \YooKassa\Request\SelfEmployed\SelfEmployedRequest
Summary
Собираемый объект запроса
Type: SelfEmployedRequest
Details:
Methods
public __construct() : mixed
public __construct() : mixed
Summary
Конструктор, инициализирует пустой запрос, который в будущем начнём собирать
Details:
- Inherited From: \YooKassa\Common\AbstractRequestBuilder
Returns: mixed -
public build() : \YooKassa\Request\SelfEmployed\SelfEmployedRequest|\YooKassa\Common\AbstractRequest
public build(array|null $options = null) : \YooKassa\Request\SelfEmployed\SelfEmployedRequest|\YooKassa\Common\AbstractRequest
Summary
Строит и возвращает объект запроса для отправки в API ЮKassa
Details:
- Inherited From: \YooKassa\Request\SelfEmployed\SelfEmployedRequestBuilder
Parameters:
| Type | Name | Description |
|---|---|---|
array OR null |
options | Массив параметров для установки в объект запроса |
Throws:
| Type | Description |
|---|---|
| \YooKassa\Common\Exceptions\InvalidRequestException | Выбрасывается если собрать объект запроса не удалось |
Returns: \YooKassa\Request\SelfEmployed\SelfEmployedRequest|\YooKassa\Common\AbstractRequest - Инстанс объекта запроса
public setConfirmation() : self
public setConfirmation(\YooKassa\Model\SelfEmployed\SelfEmployedConfirmation|array|null $value) : self
Summary
Устанавливает сценарий подтверждения.
Details:
- Inherited From: \YooKassa\Request\SelfEmployed\SelfEmployedRequestBuilder
Parameters:
| Type | Name | Description |
|---|---|---|
\YooKassa\Model\SelfEmployed\SelfEmployedConfirmation OR array OR null |
value | Сценарий подтверждения. |
Returns: self - Инстанс билдера запросов
public setItn() : self
public setItn(string|null $value) : self
Summary
Устанавливает ИНН самозанятого
Details:
- Inherited From: \YooKassa\Request\SelfEmployed\SelfEmployedRequestBuilder
Parameters:
| Type | Name | Description |
|---|---|---|
string OR null |
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 setPhone() : self
public setPhone(string|null $value) : self
Summary
Устанавливает телефон самозанятого.
Details:
- Inherited From: \YooKassa\Request\SelfEmployed\SelfEmployedRequestBuilder
Parameters:
| Type | Name | Description |
|---|---|---|
string OR null |
value | Телефон самозанятого. |
Returns: self - Инстанс билдера запросов
protected initCurrentObject() : \YooKassa\Request\SelfEmployed\SelfEmployedRequest
protected initCurrentObject() : \YooKassa\Request\SelfEmployed\SelfEmployedRequest
Summary
Инициализирует объект запроса, который в дальнейшем будет собираться билдером
Details:
- Inherited From: \YooKassa\Request\SelfEmployed\SelfEmployedRequestBuilder
Returns: \YooKassa\Request\SelfEmployed\SelfEmployedRequest - Инстанс собираемого объекта запроса к API
Top Namespaces
Reports
This document was automatically generated from source code comments on 2023-04-06 using phpDocumentor
© 2023 YooMoney