mirror of https://git.yoomoney.ru/scm/sdk/yookassa-sdk-php.git synced 2026-08-17 14:51:19 +00:00

Files

T

Антон Н. Николаев b5e17ed221 В объект выплаты добавлен параметр succeeded_at (время перехода выплаты в статус succeeded)

2025-07-31 16:17:04 +03:00

19 KiB

Raw Blame History

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	Summary
public	__construct()	MonetaryAmount constructor.
public	__get()	Возвращает значение свойства.
public	__isset()	Проверяет наличие свойства.
public	__set()	Устанавливает значение свойства.
public	__unset()	Удаляет свойство.
public	fromArray()	Устанавливает значения свойств текущего объекта из массива.
public	getCurrency()	Возвращает валюту.
public	getIntegerValue()	Возвращает сумму в копейках в виде целого числа.
public	getValidator()
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()	Возвращает массив свойств которые не существуют, но были заданы у объекта.
protected	validatePropertyValue()

Details

File: lib/Model/MonetaryAmount.php
Package: Default
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(null|array|\YooKassa\Model\numeric $value = null, null|string $currency = null) : mixed

Summary

MonetaryAmount constructor.

Details:

Inherited From: \YooKassa\Model\MonetaryAmount

Parameters:

Type	Name	Description
`null OR array OR \YooKassa\Model\numeric`	value	Сумма
`null OR string`	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() : 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 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 getValidator() : \YooKassa\Validator\Validator

public getValidator() : \YooKassa\Validator\Validator

Details:

Inherited From: \YooKassa\Common\AbstractObject

Returns: \YooKassa\Validator\Validator -

public getValue() : string

public getValue() : string

Summary

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

Details:

Inherited From: \YooKassa\Model\MonetaryAmount

Returns: string - Сумма

public increase() : void

public increase(float $value) : void

Summary

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

Details:

Inherited From: \YooKassa\Model\MonetaryAmount

Parameters:

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

Throws:

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

Returns: void -

public jsonSerialize() : array

public jsonSerialize() : array

Summary

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

Details:

Inherited From: \YooKassa\Model\MonetaryAmount

Returns: array - Ассоциативный массив со свойствами текущего объекта

public multiply() : void

public multiply(float $coefficient) : void

Summary

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

Details:

Inherited From: \YooKassa\Model\MonetaryAmount

Parameters:

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

Throws:

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

Returns: void -

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

public setCurrency(string $currency) : self

Summary

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

Details:

Inherited From: \YooKassa\Model\MonetaryAmount

Parameters:

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

Throws:

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

Returns: self -

public setValue() : self

public setValue(\YooKassa\Model\numeric|string|null $value) : self

Summary

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

Details:

Inherited From: \YooKassa\Model\MonetaryAmount

Parameters:

Type	Name	Description
`\YooKassa\Model\numeric OR string OR null`	value	Сумма

Throws:

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

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

\YooKassa

Reports

This document was automatically generated from source code comments on 2025-07-31 using phpDocumentor

19 KiB Raw Blame History

YooKassa API SDK

Class: \YooKassa\Model\MonetaryAmount

Namespace: \YooKassa\Model

Constants

Properties

Methods

Details

Properties

public $currency : string

public $value : int

Methods

public __construct() : mixed

Parameters:

public __get() : mixed

Parameters:

public __isset() : bool

Parameters:

public __set() : void

Parameters:

public __unset() : void

Parameters:

public fromArray() : void

Parameters:

public getCurrency() : string

public getIntegerValue() : int

public getValidator() : \YooKassa\Validator\Validator

public getValue() : string

public increase() : void

Parameters:

Throws:

public jsonSerialize() : array

public multiply() : void

Parameters:

Throws:

public offsetExists() : bool

Parameters:

public offsetGet() : mixed

Parameters:

public offsetSet() : void

Parameters:

public offsetUnset() : void

Parameters:

public setCurrency() : self

Parameters:

Throws:

public setValue() : self

Parameters:

Throws:

public toArray() : array

protected getUnknownProperties() : array

protected validatePropertyValue() : mixed

Parameters:

Top Namespaces

Reports

19 KiB

Raw Blame History