Антон Н. Николаев
17 KiB
YooKassa API SDK
Class: \YooKassa\Model\PaymentData\B2b\Sberbank\VatData
Namespace: \YooKassa\Model\PaymentData\B2b\Sberbank
Summary:
Данные об НДС
Constants
- No constants found
Properties
| Visibility | Name | Flag | Summary |
|---|---|---|---|
| public | $amount | Сумма НДС | |
| public | $rate | Данные об НДС в случае, если сумма НДС включена в сумму платежа | |
| public | $type | Способ расчёта НДС |
Methods
| Visibility | Name | Flag | Summary |
|---|---|---|---|
| public | __construct() | VatData constructor. | |
| public | __get() | Возвращает значение свойства | |
| public | __isset() | Проверяет наличие свойства | |
| public | __set() | Устанавливает значение свойства | |
| public | __unset() | Удаляет свойство | |
| public | fromArray() | Устанавливает значения свойств текущего объекта из массива | |
| public | getAmount() | Возвращает сумму НДС | |
| public | getRate() | Возвращает налоговую ставку НДС | |
| public | getType() | Возвращает способ расчёта НДС | |
| public | jsonSerialize() | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | |
| public | offsetExists() | Проверяет наличие свойства | |
| public | offsetGet() | Возвращает значение свойства | |
| public | offsetSet() | Устанавливает значение свойства | |
| public | offsetUnset() | Удаляет свойство | |
| public | setAmount() | Устанавливает сумму НДС | |
| public | setRate() | Устанавливает налоговую ставку НДС | |
| public | setType() | Устанавливает способ расчёта НДС | |
| public | toArray() | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | |
| protected | getUnknownProperties() | Возвращает массив свойств которые не существуют, но были заданы у объекта |
Details
- File: lib/Model/PaymentData/B2b/Sberbank/VatData.php
- Package: Default
- Class Hierarchy:
- \YooKassa\Common\AbstractObject
- \YooKassa\Model\PaymentData\B2b\Sberbank\VatData
- Implements:
Properties
public $amount : \YooKassa\Model\AmountInterface
Description
Сумма НДС
Type: AmountInterface
Details:
public $rate : string
Description
Данные об НДС в случае, если сумма НДС включена в сумму платежа
Type: string
Details:
public $type : string
Description
Способ расчёта НДС
Type: string
Details:
Methods
public __construct() : mixed
public __construct(string|null $type = null, string|null $rate = null, \YooKassa\Model\AmountInterface|null $amount = null) : mixed
Summary
VatData constructor.
Details:
- Inherited From: \YooKassa\Model\PaymentData\B2b\Sberbank\VatData
Parameters:
| Type | Name | Description |
|---|---|---|
string OR null |
type | Способ расчёта НДС |
string OR null |
rate | Налоговая ставка НДС |
\YooKassa\Model\AmountInterface OR null |
amount | Сумма НДС |
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 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 getAmount() : \YooKassa\Model\AmountInterface
public getAmount() : \YooKassa\Model\AmountInterface
Summary
Возвращает сумму НДС
Details:
- Inherited From: \YooKassa\Model\PaymentData\B2b\Sberbank\VatData
Returns: \YooKassa\Model\AmountInterface - Сумма НДС
public getRate() : string
public getRate() : string
Summary
Возвращает налоговую ставку НДС
Details:
- Inherited From: \YooKassa\Model\PaymentData\B2b\Sberbank\VatData
Returns: string - Налоговая ставка НДС
public getType() : string
public getType() : string
Summary
Возвращает способ расчёта НДС
Details:
- Inherited From: \YooKassa\Model\PaymentData\B2b\Sberbank\VatData
Returns: string - Способ расчёта НДС
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() : mixed
public offsetSet(string $offset, mixed $value) : mixed
Summary
Устанавливает значение свойства
Details:
- Inherited From: \YooKassa\Common\AbstractObject
Parameters:
| Type | Name | Description |
|---|---|---|
string |
offset | Имя свойства |
mixed |
value | Значение свойства |
Returns: mixed -
public offsetUnset() : mixed
public offsetUnset(string $offset) : mixed
Summary
Удаляет свойство
Details:
- Inherited From: \YooKassa\Common\AbstractObject
Parameters:
| Type | Name | Description |
|---|---|---|
string |
offset | Имя удаляемого свойства |
Returns: mixed -
public setAmount() : mixed
public setAmount(\YooKassa\Model\AmountInterface|array|null $value) : mixed
Summary
Устанавливает сумму НДС
Details:
- Inherited From: \YooKassa\Model\PaymentData\B2b\Sberbank\VatData
Parameters:
| Type | Name | Description |
|---|---|---|
\YooKassa\Model\AmountInterface OR array OR null |
value | Сумма НДС |
Returns: mixed -
public setRate() : mixed
public setRate(string $value) : mixed
Summary
Устанавливает налоговую ставку НДС
Details:
- Inherited From: \YooKassa\Model\PaymentData\B2b\Sberbank\VatData
Parameters:
| Type | Name | Description |
|---|---|---|
string |
value | Налоговая ставка НДС |
Throws:
| Type | Description |
|---|---|
| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если переданная строка не является валидной ставкой |
| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если в метод была передана не строка |
Returns: mixed -
public setType() : mixed
public setType(string $value) : mixed
Summary
Устанавливает способ расчёта НДС
Details:
- Inherited From: \YooKassa\Model\PaymentData\B2b\Sberbank\VatData
Parameters:
| Type | Name | Description |
|---|---|---|
string |
value | Способ расчёта НДС |
Throws:
| Type | Description |
|---|---|
| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если переданная строка не является валидным способом |
| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если в метод была передана не строка |
Returns: mixed -
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 - Ассоциативный массив с не существующими у текущего объекта свойствами
Top Namespaces
Reports
This document was automatically generated from source code comments on 2022-08-01 using phpDocumentor
© 2022 YooMoney