21 KiB
YooKassa API SDK
Class: \YooKassa\Request\SelfEmployed\SelfEmployedRequest
Namespace: \YooKassa\Request\SelfEmployed
Summary:
Класс, представляющий модель SelfEmployedRequest.
Description:
Запрос на создание объекта самозанятого.
Constants
- No constants found
Properties
| Visibility | Name | Flag | Summary |
|---|---|---|---|
| public | $confirmation | Сценарий подтверждения пользователем заявки ЮMoney на получение прав для регистрации чеков в сервисе Мой налог. | |
| public | $itn | ИНН самозанятого. | |
| public | $phone | Телефон самозанятого, который привязан к личному кабинету в сервисе Мой налог. |
Methods
| Visibility | Name | Flag | Summary |
|---|---|---|---|
| public | __construct() | AbstractObject constructor. | |
| public | __get() | Возвращает значение свойства | |
| public | __isset() | Проверяет наличие свойства | |
| public | __set() | Устанавливает значение свойства | |
| public | __unset() | Удаляет свойство | |
| public | builder() | Возвращает билдер объектов запросов создания платежа | |
| public | clearValidationError() | Очищает статус валидации текущего запроса | |
| public | fromArray() | Устанавливает значения свойств текущего объекта из массива | |
| public | getConfirmation() | Возвращает сценарий подтверждения. | |
| public | getItn() | Возвращает ИНН самозанятого | |
| public | getLastValidationError() | Возвращает последнюю ошибку валидации | |
| public | getPhone() | Возвращает телефон самозанятого. | |
| public | hasConfirmation() | Проверяет наличие сценария подтверждения самозанятого в запросе | |
| public | hasItn() | Проверяет наличие ИНН самозанятого в запросе | |
| public | hasPhone() | Проверяет наличие телефона самозанятого в запросе | |
| public | jsonSerialize() | ||
| public | offsetExists() | ||
| public | offsetGet() | ||
| public | offsetSet() | ||
| public | offsetUnset() | ||
| public | setConfirmation() | Устанавливает сценарий подтверждения. | |
| public | setItn() | Устанавливает ИНН самозанятого | |
| public | setPhone() | Устанавливает телефон самозанятого. | |
| public | toArray() | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | |
| public | validate() | Проверяет на валидность текущий объект | |
| protected | getUnknownProperties() | Возвращает массив свойств которые не существуют, но были заданы у объекта | |
| protected | setValidationError() | Устанавливает ошибку валидации |
Details
- File: lib/Request/SelfEmployed/SelfEmployedRequest.php
- Package: YooKassa\Model
- Class Hierarchy:
- \YooKassa\Common\AbstractObject
- \YooKassa\Common\AbstractRequest
- \YooKassa\Request\SelfEmployed\SelfEmployedRequest
Tags
| Tag | Version | Description |
|---|---|---|
| author | cms@yoomoney.ru |
Properties
public $confirmation : \YooKassa\Request\SelfEmployed\SelfEmployedRequestConfirmation|null
Description
Сценарий подтверждения пользователем заявки ЮMoney на получение прав для регистрации чеков в сервисе Мой налог.
Type: SelfEmployedRequestConfirmation|null
Details:
public $itn : string|null
Description
ИНН самозанятого.
Type: string|null
Details:
public $phone : string|null
Description
Телефон самозанятого, который привязан к личному кабинету в сервисе Мой налог.
Type: string|null
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\SelfEmployed\SelfEmployedRequestBuilder
Static public builder() : \YooKassa\Request\SelfEmployed\SelfEmployedRequestBuilder
Summary
Возвращает билдер объектов запросов создания платежа
Details:
- Inherited From: \YooKassa\Request\SelfEmployed\SelfEmployedRequest
Returns: \YooKassa\Request\SelfEmployed\SelfEmployedRequestBuilder - Инстанс билдера объектов запросов
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 getConfirmation() : \YooKassa\Request\SelfEmployed\SelfEmployedRequestConfirmation|null
public getConfirmation() : \YooKassa\Request\SelfEmployed\SelfEmployedRequestConfirmation|null
Summary
Возвращает сценарий подтверждения.
Details:
- Inherited From: \YooKassa\Request\SelfEmployed\SelfEmployedRequest
Returns: \YooKassa\Request\SelfEmployed\SelfEmployedRequestConfirmation|null - Сценарий подтверждения
public getItn() : string|null
public getItn() : string|null
Summary
Возвращает ИНН самозанятого
Details:
- Inherited From: \YooKassa\Request\SelfEmployed\SelfEmployedRequest
Returns: string|null - ИНН самозанятого
public getLastValidationError() : string
public getLastValidationError() : string
Summary
Возвращает последнюю ошибку валидации
Details:
- Inherited From: \YooKassa\Common\AbstractRequest
Returns: string - Последняя произошедшая ошибка валидации
public getPhone() : string|null
public getPhone() : string|null
Summary
Возвращает телефон самозанятого.
Details:
- Inherited From: \YooKassa\Request\SelfEmployed\SelfEmployedRequest
Returns: string|null - Телефон самозанятого
public hasConfirmation() : bool
public hasConfirmation() : bool
Summary
Проверяет наличие сценария подтверждения самозанятого в запросе
Details:
- Inherited From: \YooKassa\Request\SelfEmployed\SelfEmployedRequest
Returns: bool - True если сценарий подтверждения самозанятого задан, false если нет
public hasItn() : bool
public hasItn() : bool
Summary
Проверяет наличие ИНН самозанятого в запросе
Details:
- Inherited From: \YooKassa\Request\SelfEmployed\SelfEmployedRequest
Returns: bool - True если ИНН самозанятого задан, false если нет
public hasPhone() : bool
public hasPhone() : bool
Summary
Проверяет наличие телефона самозанятого в запросе
Details:
- Inherited From: \YooKassa\Request\SelfEmployed\SelfEmployedRequest
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 setConfirmation() : $this
public setConfirmation(\YooKassa\Model\SelfEmployed\SelfEmployedConfirmation|array|null $confirmation = null) : $this
Summary
Устанавливает сценарий подтверждения.
Details:
- Inherited From: \YooKassa\Request\SelfEmployed\SelfEmployedRequest
Parameters:
| Type | Name | Description |
|---|---|---|
\YooKassa\Model\SelfEmployed\SelfEmployedConfirmation OR array OR null |
confirmation | Сценарий подтверждения |
Returns: $this -
public setItn() : $this
public setItn(string|null $itn = null) : $this
Summary
Устанавливает ИНН самозанятого
Details:
- Inherited From: \YooKassa\Request\SelfEmployed\SelfEmployedRequest
Parameters:
| Type | Name | Description |
|---|---|---|
string OR null |
itn | ИНН самозанятого |
Returns: $this -
public setPhone() : $this
public setPhone(string|null $phone = null) : $this
Summary
Устанавливает телефон самозанятого.
Details:
- Inherited From: \YooKassa\Request\SelfEmployed\SelfEmployedRequest
Parameters:
| Type | Name | Description |
|---|---|---|
string OR null |
phone | Телефон самозанятого |
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\SelfEmployed\SelfEmployedRequest
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
Reports
This document was automatically generated from source code comments on 2023-04-06 using phpDocumentor
© 2023 YooMoney