meraproject/vendor/yoomoney/yookassa-sdk-php/docs/classes/YooKassa-Model-MonetaryAmount.md

YooKassa API SDK

Class: \YooKassa\Model\MonetaryAmount

Namespace: \YooKassa\Model

---

Summary:

MonetaryAmount - Сумма определенная в валюте

---

Constants

• No constants found

---

Properties

Visibility	Name	Flag	Summary
public	$currency		Код валюты
public	$value		Сумма

---

Methods

Visibility	Name	Flag	Summary
public	__construct()		MonetaryAmount constructor.
public	__get()		Возвращает значение свойства
public	__isset()		Проверяет наличие свойства
public	__set()		Устанавливает значение свойства
public	__unset()		Удаляет свойство
public	fromArray()		Устанавливает значения свойств текущего объекта из массива
public	getCurrency()		Возвращает валюту
public	getIntegerValue()		Возвращает сумму в копейках в виде целого числа
public	getValue()		Возвращает значение суммы
public	increase()		Увеличивает сумму на указанное значение
public	jsonSerialize()
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/MonetaryAmount.php
• Package: YooKassa
• Class Hierarchy:
  • \YooKassa\Common\AbstractObject
  • \YooKassa\Model\MonetaryAmount
• Implements:
  • \YooKassa\Model\AmountInterface

---

Properties

public $currency : string

---

Description

Код валюты

Type: string

Details:

public $value : int

---

Description

Сумма

Type: int

Details:

---

Methods

public __construct() : mixed

public __construct(array|numeric-string|int|float|null $value = null, string|null $currency = null) : mixed

Summary

MonetaryAmount constructor.

Details:

• Inherited From: \YooKassa\Model\MonetaryAmount

Parameters:

Type	Name	Description
array OR numeric-string OR int OR float 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 getCurrency() : string

public getCurrency() : string

Summary

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

Details:

• Inherited From: \YooKassa\Model\MonetaryAmount

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

public getIntegerValue() : int

public getIntegerValue() : int

Summary

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

Details:

• Inherited From: \YooKassa\Model\MonetaryAmount

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

public getValue() : string

public getValue() : string

Summary

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

Details:

• Inherited From: \YooKassa\Model\MonetaryAmount

Returns: string - Сумма

public increase() : mixed

public increase(int $value) : mixed

Summary

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

Details:

• Inherited From: \YooKassa\Model\MonetaryAmount

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

Details:

• Inherited From: \YooKassa\Model\MonetaryAmount

Returns: array -

public multiply() : mixed

public multiply(float $coefficient) : mixed

Summary

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

Details:

• Inherited From: \YooKassa\Model\MonetaryAmount

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

public setCurrency(string $value) : mixed

Summary

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

Details:

• Inherited From: \YooKassa\Model\MonetaryAmount

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(string $value) : mixed

Summary

Устанавливает сумму

Details:

• Inherited From: \YooKassa\Model\MonetaryAmount

Parameters:

Type	Name	Description
string	value	Сумма

Throws:

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

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

• \YooKassa

---

Reports

• Errors - 0
• Markers - 1
• Deprecated - 25

---

This document was automatically generated from source code comments on 2023-04-06 using phpDocumentor

© 2023 YooMoney