commercetools-sdk-php-v2
The commercetools platform, import-api and PHP sdks generated from our api reference.
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Protected Attributes | List of all members
Commercetools\Api\Models\Common\CentPrecisionMoneyModel Class Reference

Inherits Commercetools\Base\JsonObjectModel, and Commercetools\Api\Models\Common\CentPrecisionMoney.

Public Member Functions

 __construct (?int $centAmount=null, ?string $currencyCode=null, ?int $fractionDigits=null, ?string $type=null)
 
 getCentAmount ()
 
 getCurrencyCode ()
 
 getType ()
 
 getFractionDigits ()
 
 setCentAmount (?int $centAmount)
 
 setCurrencyCode (?string $currencyCode)
 
 setFractionDigits (?int $fractionDigits)
 
- Public Member Functions inherited from Commercetools\Base\JsonObjectModel
 get (string $field)
 
 with (?callable $callable=null)
 
- Public Member Functions inherited from Commercetools\Base\BaseJsonObject
 jsonSerialize ()
 

Public Attributes

const DISCRIMINATOR_VALUE = 'centPrecision'
 
- Public Attributes inherited from Commercetools\Api\Models\Common\TypedMoney
const DISCRIMINATOR_FIELD = 'type'
 
const FIELD_TYPE = 'type'
 
const FIELD_FRACTION_DIGITS = 'fractionDigits'
 
- Public Attributes inherited from Commercetools\Api\Models\Common\Money
const FIELD_CENT_AMOUNT = 'centAmount'
 
const FIELD_CURRENCY_CODE = 'currencyCode'
 

Protected Attributes

 $centAmount
 
 $currencyCode
 
 $type
 
 $fractionDigits
 

Additional Inherited Members

- Static Public Member Functions inherited from Commercetools\Base\BaseJsonObject
static of ($data=null)
 
static fromStdClass (?stdClass $data=null)
 
static fromArray (array $data=[])
 
- Protected Member Functions inherited from Commercetools\Base\JsonObjectModel
 toArray ()
 
- Protected Member Functions inherited from Commercetools\Base\BaseJsonObject
 raw (string $field)
 
 getRawDataArray ()
 

Detailed Description

Definition at line 20 of file CentPrecisionMoneyModel.php.

Constructor & Destructor Documentation

◆ __construct()

Commercetools\Api\Models\Common\CentPrecisionMoneyModel::__construct ( ?int  $centAmount = null,
?string  $currencyCode = null,
?int  $fractionDigits = null,
?string  $type = null 
)

@psalm-suppress MissingParamType

Definition at line 51 of file CentPrecisionMoneyModel.php.

Member Function Documentation

◆ getCentAmount()

Commercetools\Api\Models\Common\CentPrecisionMoneyModel::getCentAmount ( )

Amount in the smallest indivisible unit of a currency, such as:

  • Cents for EUR and USD, pence for GBP, or centime for CHF (5 CHF is specified as 500).
  • The value in the major unit for currencies without minor units, like JPY (5 JPY is specified as 5).
Returns
null|int

@psalm-var ?int $data

Implements Commercetools\Api\Models\Common\Money.

Definition at line 73 of file CentPrecisionMoneyModel.php.

◆ getCurrencyCode()

Commercetools\Api\Models\Common\CentPrecisionMoneyModel::getCurrencyCode ( )

Currency code compliant to ISO 4217.

Returns
null|string

@psalm-var ?string $data

Implements Commercetools\Api\Models\Common\Money.

Definition at line 93 of file CentPrecisionMoneyModel.php.

◆ getFractionDigits()

Commercetools\Api\Models\Common\CentPrecisionMoneyModel::getFractionDigits ( )

The number of default fraction digits for the given currency, like 2 for EUR or 0 for JPY.

Returns
null|int

@psalm-var ?int $data

Implements Commercetools\Api\Models\Common\CentPrecisionMoney.

Definition at line 133 of file CentPrecisionMoneyModel.php.

◆ getType()

Commercetools\Api\Models\Common\CentPrecisionMoneyModel::getType ( )

Type of money used.

Returns
null|string

@psalm-var ?string $data

Implements Commercetools\Api\Models\Common\TypedMoney.

Definition at line 113 of file CentPrecisionMoneyModel.php.

◆ setCentAmount()

Commercetools\Api\Models\Common\CentPrecisionMoneyModel::setCentAmount ( ?int  $centAmount)
Parameters
?int$centAmount

Implements Commercetools\Api\Models\Common\Money.

Definition at line 151 of file CentPrecisionMoneyModel.php.

◆ setCurrencyCode()

Commercetools\Api\Models\Common\CentPrecisionMoneyModel::setCurrencyCode ( ?string  $currencyCode)
Parameters
?string$currencyCode

Implements Commercetools\Api\Models\Common\Money.

Definition at line 159 of file CentPrecisionMoneyModel.php.

◆ setFractionDigits()

Commercetools\Api\Models\Common\CentPrecisionMoneyModel::setFractionDigits ( ?int  $fractionDigits)
Parameters
?int$fractionDigits

Implements Commercetools\Api\Models\Common\CentPrecisionMoney.

Definition at line 167 of file CentPrecisionMoneyModel.php.

Member Data Documentation

◆ $centAmount

Commercetools\Api\Models\Common\CentPrecisionMoneyModel::$centAmount
protected

Definition at line 27 of file CentPrecisionMoneyModel.php.

◆ $currencyCode

Commercetools\Api\Models\Common\CentPrecisionMoneyModel::$currencyCode
protected

Definition at line 33 of file CentPrecisionMoneyModel.php.

◆ $fractionDigits

Commercetools\Api\Models\Common\CentPrecisionMoneyModel::$fractionDigits
protected

Definition at line 45 of file CentPrecisionMoneyModel.php.

◆ $type

Commercetools\Api\Models\Common\CentPrecisionMoneyModel::$type
protected

Definition at line 39 of file CentPrecisionMoneyModel.php.

◆ DISCRIMINATOR_VALUE

const Commercetools\Api\Models\Common\CentPrecisionMoneyModel::DISCRIMINATOR_VALUE = 'centPrecision'

Definition at line 22 of file CentPrecisionMoneyModel.php.


The documentation for this class was generated from the following file: