Исправлены неточности в типах и описаниях
29 KiB
YooKassa API SDK
Class: \YooKassa\Model\SelfEmployed\SelfEmployed
Namespace: \YooKassa\Model\SelfEmployed
Summary:
Класс, представляющий модель SelfEmployed.
Description:
Объект самозанятого.
Constants
- No constants found
Properties
| Visibility | Name | Flag | Summary |
|---|---|---|---|
| public | $confirmation | Сценарий подтверждения пользователем заявки ЮMoney на получение прав для регистрации чеков в сервисе Мой налог. | |
| public | $created_at | Время создания объекта самозанятого. | |
| public | $createdAt | Время создания объекта самозанятого. | |
| public | $id | Идентификатор самозанятого в ЮKassa. | |
| public | $itn | ИНН самозанятого. | |
| public | $phone | Телефон самозанятого, который привязан к личному кабинету в сервисе Мой налог. | |
| public | $status | Статус подключения самозанятого и выдачи ЮMoney прав на регистрацию чеков. | |
| public | $test | Признак тестовой операции. | |
| protected | $_confirmation | Сценарий подтверждения пользователем заявки ЮMoney на получение прав для регистрации чеков в сервисе Мой налог. | |
| protected | $_created_at | Время создания объекта самозанятого. | |
| protected | $_id | Идентификатор самозанятого в ЮKassa. | |
| protected | $_itn | ИНН самозанятого. Формат: 12 цифр без пробелов. | |
| protected | $_phone | Телефон самозанятого, который привязан к личному кабинету в сервисе Мой налог. | |
| protected | $_status | Статус подключения самозанятого и выдачи ЮMoney прав на регистрацию чеков | |
| protected | $_test | Признак тестовой операции |
Methods
| Visibility | Name | Flag | Summary |
|---|---|---|---|
| public | __construct() | AbstractObject constructor. | |
| public | __get() | Возвращает значение свойства. | |
| public | __isset() | Проверяет наличие свойства. | |
| public | __set() | Устанавливает значение свойства. | |
| public | __unset() | Удаляет свойство. | |
| public | fromArray() | Устанавливает значения свойств текущего объекта из массива. | |
| public | getConfirmation() | Возвращает сценарий подтверждения. | |
| public | getCreatedAt() | Возвращает время создания объекта самозанятого. | |
| public | getId() | Возвращает идентификатор самозанятого в ЮKassa. | |
| public | getItn() | Возвращает ИНН самозанятого. | |
| public | getPhone() | Возвращает телефон самозанятого. | |
| public | getStatus() | Возвращает статус подключения самозанятого и выдачи ЮMoney прав на регистрацию чеков. | |
| public | getTest() | Возвращает признак тестовой операции. | |
| public | getValidator() | ||
| public | jsonSerialize() | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации. | |
| public | offsetExists() | Проверяет наличие свойства. | |
| public | offsetGet() | Возвращает значение свойства. | |
| public | offsetSet() | Устанавливает значение свойства. | |
| public | offsetUnset() | Удаляет свойство. | |
| public | setConfirmation() | Устанавливает сценарий подтверждения. | |
| public | setCreatedAt() | Устанавливает время создания объекта самозанятого. | |
| public | setId() | Устанавливает идентификатор самозанятого в ЮKassa. | |
| public | setItn() | Устанавливает ИНН самозанятого. | |
| public | setPhone() | Устанавливает телефон самозанятого. | |
| public | setStatus() | Устанавливает статус подключения самозанятого и выдачи ЮMoney прав на регистрацию чеков. | |
| public | setTest() | Устанавливает признак тестовой операции. | |
| public | toArray() | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize(). | |
| protected | getUnknownProperties() | Возвращает массив свойств которые не существуют, но были заданы у объекта. | |
| protected | validatePropertyValue() |
Details
-
Package: YooKassa\Model
-
Class Hierarchy:
- \YooKassa\Common\AbstractObject
- \YooKassa\Model\SelfEmployed\SelfEmployed
-
Implements:
-
See Also:
Tags
| Tag | Version | Description |
|---|---|---|
| category | Class | |
| author | cms@yoomoney.ru |
Properties
public $confirmation : null|\YooKassa\Model\SelfEmployed\SelfEmployedConfirmation
Description
Сценарий подтверждения пользователем заявки ЮMoney на получение прав для регистрации чеков в сервисе Мой налог.
Type: SelfEmployedConfirmation
Details:
public $created_at : \DateTime
Description
Время создания объекта самозанятого.
Type: \DateTime
Details:
public $createdAt : \DateTime
Description
Время создания объекта самозанятого.
Type: \DateTime
Details:
public $id : string
Description
Идентификатор самозанятого в ЮKassa.
Type: string
Details:
public $itn : null|string
Description
ИНН самозанятого.
Type: null|string
Details:
public $phone : null|string
Description
Телефон самозанятого, который привязан к личному кабинету в сервисе Мой налог.
Type: null|string
Details:
public $status : string
Description
Статус подключения самозанятого и выдачи ЮMoney прав на регистрацию чеков.
Type: string
Details:
public $test : bool
Description
Признак тестовой операции.
Type: bool
Details:
protected $_confirmation : ?\YooKassa\Model\SelfEmployed\SelfEmployedConfirmation
Summary
Сценарий подтверждения пользователем заявки ЮMoney на получение прав для регистрации чеков в сервисе Мой налог.
Type: SelfEmployedConfirmation
Details:
protected $_created_at : ?\DateTime
Summary
Время создания объекта самозанятого.
Description
Указывается по UTC и передается в формате ISO 8601. Пример: ~`2017-11-03T11:52:31.827Z
Type: DateTime
Details:
protected $_id : ?string
Summary
Идентификатор самозанятого в ЮKassa.
Type: ?string
Details:
protected $_itn : ?string
Summary
ИНН самозанятого. Формат: 12 цифр без пробелов.
Type: ?string
Details:
protected $_phone : ?string
Summary
Телефон самозанятого, который привязан к личному кабинету в сервисе Мой налог.
Type: ?string
Details:
protected $_status : ?string
Summary
Статус подключения самозанятого и выдачи ЮMoney прав на регистрацию чеков
Type: ?string
Details:
protected $_test : ?bool
Summary
Признак тестовой операции
Type: ?bool
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 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 getConfirmation() : \YooKassa\Model\SelfEmployed\SelfEmployedConfirmation|null
public getConfirmation() : \YooKassa\Model\SelfEmployed\SelfEmployedConfirmation|null
Summary
Возвращает сценарий подтверждения.
Details:
- Inherited From: \YooKassa\Model\SelfEmployed\SelfEmployed
Returns: \YooKassa\Model\SelfEmployed\SelfEmployedConfirmation|null - Сценарий подтверждения
public getCreatedAt() : \DateTime|null
public getCreatedAt() : \DateTime|null
Summary
Возвращает время создания объекта самозанятого.
Details:
- Inherited From: \YooKassa\Model\SelfEmployed\SelfEmployed
Returns: \DateTime|null - Время создания объекта самозанятого
public getId() : string|null
public getId() : string|null
Summary
Возвращает идентификатор самозанятого в ЮKassa.
Details:
- Inherited From: \YooKassa\Model\SelfEmployed\SelfEmployed
Returns: string|null -
public getItn() : string|null
public getItn() : string|null
Summary
Возвращает ИНН самозанятого.
Details:
- Inherited From: \YooKassa\Model\SelfEmployed\SelfEmployed
Returns: string|null -
public getPhone() : string|null
public getPhone() : string|null
Summary
Возвращает телефон самозанятого.
Details:
- Inherited From: \YooKassa\Model\SelfEmployed\SelfEmployed
Returns: string|null - Телефон самозанятого
public getStatus() : string|null
public getStatus() : string|null
Summary
Возвращает статус подключения самозанятого и выдачи ЮMoney прав на регистрацию чеков.
Details:
- Inherited From: \YooKassa\Model\SelfEmployed\SelfEmployed
Returns: string|null -
public getTest() : bool
public getTest() : bool
Summary
Возвращает признак тестовой операции.
Details:
- Inherited From: \YooKassa\Model\SelfEmployed\SelfEmployed
Returns: bool - Признак тестовой операции
public getValidator() : \YooKassa\Validator\Validator
public getValidator() : \YooKassa\Validator\Validator
Details:
- Inherited From: \YooKassa\Common\AbstractObject
Returns: \YooKassa\Validator\Validator -
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 setConfirmation() : $this
public setConfirmation(\YooKassa\Model\SelfEmployed\SelfEmployedConfirmation|array|null $confirmation = null) : $this
Summary
Устанавливает сценарий подтверждения.
Details:
- Inherited From: \YooKassa\Model\SelfEmployed\SelfEmployed
Parameters:
| Type | Name | Description |
|---|---|---|
\YooKassa\Model\SelfEmployed\SelfEmployedConfirmation OR array OR null |
confirmation | Сценарий подтверждения |
Returns: $this -
public setCreatedAt() : self
public setCreatedAt(\DateTime|string|null $created_at = null) : self
Summary
Устанавливает время создания объекта самозанятого.
Details:
- Inherited From: \YooKassa\Model\SelfEmployed\SelfEmployed
Parameters:
| Type | Name | Description |
|---|---|---|
\DateTime OR string OR null |
created_at | Время создания объекта самозанятого. |
Returns: self -
public setId() : self
public setId(string|null $id = null) : self
Summary
Устанавливает идентификатор самозанятого в ЮKassa.
Details:
- Inherited From: \YooKassa\Model\SelfEmployed\SelfEmployed
Parameters:
| Type | Name | Description |
|---|---|---|
string OR null |
id | Идентификатор самозанятого в ЮKassa. |
Returns: self -
public setItn() : self
public setItn(string|null $itn = null) : self
Summary
Устанавливает ИНН самозанятого.
Details:
- Inherited From: \YooKassa\Model\SelfEmployed\SelfEmployed
Parameters:
| Type | Name | Description |
|---|---|---|
string OR null |
itn | ИНН самозанятого |
Returns: self -
public setPhone() : self
public setPhone(string|null $phone = null) : self
Summary
Устанавливает телефон самозанятого.
Details:
- Inherited From: \YooKassa\Model\SelfEmployed\SelfEmployed
Parameters:
| Type | Name | Description |
|---|---|---|
string OR null |
phone | Телефон самозанятого |
Returns: self -
public setStatus() : self
public setStatus(string|null $status = null) : self
Summary
Устанавливает статус подключения самозанятого и выдачи ЮMoney прав на регистрацию чеков.
Details:
- Inherited From: \YooKassa\Model\SelfEmployed\SelfEmployed
Parameters:
| Type | Name | Description |
|---|---|---|
string OR null |
status | Статус подключения самозанятого |
Returns: self -
public setTest() : self
public setTest(bool|null $test = null) : self
Summary
Устанавливает признак тестовой операции.
Details:
- Inherited From: \YooKassa\Model\SelfEmployed\SelfEmployed
Parameters:
| Type | Name | Description |
|---|---|---|
bool OR null |
test | Признак тестовой операции |
Returns: self -
public toArray() : array
public toArray() : array
Summary
Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize().
Details:
- Inherited From: \YooKassa\Common\AbstractObject
Returns: array - Ассоциативный массив со свойствами текущего объекта
protected getUnknownProperties() : array
protected getUnknownProperties() : array
Summary
Возвращает массив свойств которые не существуют, но были заданы у объекта.
Details:
- Inherited From: \YooKassa\Common\AbstractObject
Returns: array - Ассоциативный массив с не существующими у текущего объекта свойствами
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 2024-06-14 using phpDocumentor
© 2024 YooMoney