CoolCMS API

ExpressSmsCommand
in package

FinalYes

Parsed text of an incoming premium SMS — see {@see ExpressSmsParser::parse()}.

Three shapes reach the endpoint:

  • express KEYWORD MODULE SERVICE ID — pay one service of one object, no payment exists yet,
  • form KEYWORD CODE — the payment was created first (payment form), code is its code,
  • invalid anything else (wrong keyword, missing words, non-numeric id).

Nothing here is trusted: the text comes from whoever sent the SMS.

Table of Contents

Constants

KIND_EXPRESS  : string = 'express'
KIND_FORM  : string = 'form'
KIND_INVALID  : string = 'invalid'

Properties

$formCode  : string
$invalidReason  : string
$kind  : string
$moduleCode  : string
$objectId  : int
$serviceCode  : string

Methods

express()  : self
form()  : self
invalid()  : self
isExpress()  : bool
isForm()  : bool
__construct()  : mixed

Constants

Properties

Methods

express()

public static express(string $moduleCode, string $serviceCode, int $objectId) : self
Parameters
$moduleCode : string
$serviceCode : string
$objectId : int
Return values
self

form()

public static form(string $formCode) : self
Parameters
$formCode : string
Return values
self

invalid()

public static invalid(string $reason) : self
Parameters
$reason : string
Return values
self

__construct()

private __construct(string $kind[, string $moduleCode = '' ][, string $serviceCode = '' ][, int $objectId = 0 ][, string $formCode = '' ][, string $invalidReason = '' ]) : mixed
Parameters
$kind : string
$moduleCode : string = ''
$serviceCode : string = ''
$objectId : int = 0
$formCode : string = ''
$invalidReason : string = ''
On this page

Search results