mirror of https://git.yoomoney.ru/scm/sdk/yookassa-sdk-php.git synced 2026-08-30 12:07:43 +00:00

Files

T

Антон Н. Николаев bd2a5b95fd Добавлены новые методы. Изменены некоторые методы

Обновлены описания классов, свойств и методов для документации
Добавлена документация
Добавлены примеры использования SDK

2021-04-21 11:24:28 +03:00

18 KiB

Raw Permalink Blame History

YooKassa API SDK

Class: \YooKassa\Model\Receipt\ReceiptItemAmount

Namespace: \YooKassa\Model\Receipt

Summary:

Class ReceiptItemAmount

Constants

No constants found

Methods

Visibility	Name	Summary
public	__construct()	MonetaryAmount constructor.
public	__get()	Возвращает значение свойства
public	__isset()	Проверяет наличие свойства
public	__set()	Устанавливает значение свойства
public	__unset()	Удаляет свойство
public	fromArray()	Устанавливает значения свойств текущего объекта из массива
public	fromArray()	Устанавливает значения свойств текущего объекта из массива
public	getCurrency()	Возвращает валюту
public	getIntegerValue()	Возвращает сумму в копейках в виде целого числа
public	getValue()	Возвращает значение суммы
public	increase()	Увеличивает сумму на указанное значение
public	jsonSerialize()	Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации
public	multiply()	Умножает текущую сумму на указанный коэффициент
public	offsetExists()	Проверяет наличие свойства
public	offsetGet()	Возвращает значение свойства
public	offsetSet()	Устанавливает значение свойства
public	offsetUnset()	Удаляет свойство
public	setCurrency()	Устанавливает код валюты
public	setValue()	Устанавливает значение суммы
public	toArray()	Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize()
protected	getUnknownProperties()	Возвращает массив свойств которые не существуют, но были заданы у объекта

Details

File: lib/Model/Receipt/ReceiptItemAmount.php
Package: YooKassa
Class Hierarchy:
- \YooKassa\Common\AbstractObject
- \YooKassa\Model\Receipt\ReceiptItemAmount
Implements:
- \YooKassa\Model\AmountInterface

Methods

public __construct() : mixed

public __construct(\YooKassa\Model\Receipt\numeric|null  value = null, string|null  currency = null) : mixed

Summary

MonetaryAmount constructor.

Details:

Inherited From: \YooKassa\Model\Receipt\ReceiptItemAmount

Parameters:

Type	Name	Description
`\YooKassa\Model\Receipt\numeric OR null`	value	Сумма
`string OR null`	currency	Код валюты

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 fromArray()

public fromArray(mixed  sourceArray)

Summary

Устанавливает значения свойств текущего объекта из массива

Details:

Inherited From: \YooKassa\Model\Receipt\ReceiptItemAmount

Parameters:

Type	Name	Description
`mixed`	sourceArray	Ассоциативный массив с настройками

Returns: -

public getCurrency() : string

public getCurrency() : string

Summary

Возвращает валюту

Details:

Inherited From: \YooKassa\Model\Receipt\ReceiptItemAmount

Returns: string - Код валюты

public getIntegerValue() : int

public getIntegerValue() : int

Summary

Возвращает сумму в копейках в виде целого числа

Details:

Inherited From: \YooKassa\Model\Receipt\ReceiptItemAmount

Returns: int - Сумма в копейках/центах

public getValue() : string

public getValue() : string

Summary

Возвращает значение суммы

Details:

Inherited From: \YooKassa\Model\Receipt\ReceiptItemAmount

Returns: string - Сумма

public increase() : mixed

public increase(int  value) : mixed

Summary

Увеличивает сумму на указанное значение

Details:

Inherited From: \YooKassa\Model\Receipt\ReceiptItemAmount

Parameters:

Type	Name	Description
`int`	value	Значение которое будет прибавлено к текущему

Throws:

Type	Description
\YooKassa\Common\Exceptions\EmptyPropertyValueException	Выбрасывается если передано пустое значение
\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException	Выбрасывается если было передано не число
\YooKassa\Common\Exceptions\InvalidPropertyValueException	Выбрасывается если после сложения получилась сумма меньше или равная нулю

Returns: mixed -

public jsonSerialize() : array

public jsonSerialize() : array

Summary

Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации

Details:

Inherited From: \YooKassa\Model\Receipt\ReceiptItemAmount

Returns: array -

public multiply() : mixed

public multiply(float  coefficient) : mixed

Summary

Умножает текущую сумму на указанный коэффициент

Details:

Inherited From: \YooKassa\Model\Receipt\ReceiptItemAmount

Parameters:

Type	Name	Description
`float`	coefficient	Множитель

Throws:

Type	Description
\YooKassa\Common\Exceptions\EmptyPropertyValueException	Выбрасывается если передано пустое значение
\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException	Выбрасывается если было передано не число
\YooKassa\Common\Exceptions\InvalidPropertyValueException	Выбрасывается если переданное значение меньше или равно нулю, либо если после умножения получили значение равное нулю

Returns: mixed -

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 setCurrency() : mixed

public setCurrency(string  value) : mixed

Summary

Устанавливает код валюты

Details:

Inherited From: \YooKassa\Model\Receipt\ReceiptItemAmount

Parameters:

Type	Name	Description
`string`	value	Код валюты

Throws:

Type	Description
\YooKassa\Common\Exceptions\EmptyPropertyValueException	Генерируется если было передано пустое значение
\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException	Генерируется если было передано значение невалидного типа
\YooKassa\Common\Exceptions\InvalidPropertyValueException	Генерируется если был передан неподдерживаемый код валюты

Returns: mixed -

public setValue() : mixed

public setValue(mixed  value) : mixed

Summary

Устанавливает значение суммы

Details:

Inherited From: \YooKassa\Model\Receipt\ReceiptItemAmount

Parameters:

Type	Name	Description
`mixed`	value	Сумма

Returns: mixed -

Tag	Version	Description
inheritdoc

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

\YooKassa

Reports

This document was automatically generated from source code comments on 2021-04-21 using phpDocumentor

18 KiB Raw Permalink Blame History

YooKassa API SDK

Class: \YooKassa\Model\Receipt\ReceiptItemAmount

Namespace: \YooKassa\Model\Receipt

Constants

Methods

Details

Methods

public __construct() : mixed

Parameters:

public __get() : mixed

Parameters:

public __isset() : bool

Parameters:

public __set() : mixed

Parameters:

public __unset() : mixed

Parameters:

public fromArray() : mixed

Parameters:

public fromArray()

Parameters:

public getCurrency() : string

public getIntegerValue() : int

public getValue() : string

public increase() : mixed

Parameters:

Throws:

public jsonSerialize() : array

public multiply() : mixed

Parameters:

Throws:

public offsetExists() : bool

Parameters:

public offsetGet() : mixed

Parameters:

public offsetSet() : mixed

Parameters:

public offsetUnset() : mixed

Parameters:

public setCurrency() : mixed

Parameters:

Throws:

public setValue() : mixed

Parameters:

Tags

public toArray() : array

protected getUnknownProperties() : array

Top Namespaces

Reports

18 KiB

Raw Permalink Blame History