CoolCMS API

ExpressTarget
in package

FinalYes

One payable express service for one object, as a module offers it for one payment region.

Built by a module ExpressServiceProviderInterface from its tariff + quick price and the object it found in its own storage — never from the SMS text beyond the service word and the id. The System layer uses it to create the payment; the module gets it back in ExpressServiceProviderInterface::createPaymentItems() to create its own payment items.

Table of Contents

Properties

$callbackKey  : string
`cms_system_payment_callbacks.callback_key` that activates the module items.
$currencyId  : int
$moduleCode  : string
$objectId  : int
$objectLabel  : string
$ownerEmail  : string|null
$ownerUserId  : int|null
$paymentRegionId  : int|null
$price  : float
Quick price of the tariff in `$currencyId`; must equal the price of the shortcode.
$productTypeId  : int|null
$serviceCode  : string
$serviceName  : string
$supplyKindId  : int|null
$tariffId  : int

Methods

__construct()  : mixed

Properties

$callbackKey read-only

`cms_system_payment_callbacks.callback_key` that activates the module items.

public string $callbackKey

$price read-only

Quick price of the tariff in `$currencyId`; must equal the price of the shortcode.

public float $price

$productTypeId read-only

public int|null $productTypeId = null

$supplyKindId read-only

public int|null $supplyKindId = null

Methods

__construct()

public __construct(string $moduleCode, string $serviceCode, int $objectId, int $tariffId, string $serviceName, string $objectLabel, float $price, int $currencyId, int|null $paymentRegionId, string $callbackKey[, int|null $ownerUserId = null ][, string|null $ownerEmail = null ][, int|null $productTypeId = null ][, int|null $supplyKindId = null ]) : mixed
Parameters
$moduleCode : string
$serviceCode : string
$objectId : int
$tariffId : int
$serviceName : string
$objectLabel : string
$price : float
$currencyId : int
$paymentRegionId : int|null
$callbackKey : string
$ownerUserId : int|null = null
$ownerEmail : string|null = null
$productTypeId : int|null = null
$supplyKindId : int|null = null
On this page

Search results