Bitrix API

PaymentStage extends BaseStage

FinalYes

Base class for simple constant-based stage enums

Table of Contents

Constants

CANCEL  = 'CANCEL'
Payment was canceled
NOT_PAID  = 'NOT_PAID'
Initial payment stage
PAID  = 'PAID'
Payment successfully paid
REFUND  = 'REFUND'
Payment was refunded
SENT_NO_VIEWED  = 'SENT_NO_VIEWED'
Payment sent to customer, but no viewed yet
VIEWED_NO_PAID  = 'VIEWED_NO_PAID'
Customer receive payment, but not pay yet

Methods

getMessage()  : string
Returns localyzed message for specific enum value
getMessages()  : array<string, string>
Returns enum with localyzed descriptions
getValues()  : array<string|int, string>
Returns available enum codes
isValid()  : bool
Makes strict check that $enumValue exists in current enum

Constants

CANCEL

Payment was canceled

public mixed CANCEL = 'CANCEL'

NOT_PAID

Initial payment stage

public mixed NOT_PAID = 'NOT_PAID'

PAID

Payment successfully paid

public mixed PAID = 'PAID'

REFUND

Payment was refunded

public mixed REFUND = 'REFUND'

SENT_NO_VIEWED

Payment sent to customer, but no viewed yet

public mixed SENT_NO_VIEWED = 'SENT_NO_VIEWED'

VIEWED_NO_PAID

Customer receive payment, but not pay yet

public mixed VIEWED_NO_PAID = 'VIEWED_NO_PAID'

Methods

getMessage()

Returns localyzed message for specific enum value

public static getMessage(string $enumValue) : string
Parameters
$enumValue : string
Return values
string

getMessages()

Returns enum with localyzed descriptions

public static getMessages() : array<string, string>
Tags
psalm-suppress

RedundantCastGivenDocblockType

Return values
array<string, string>

enum code => public description

getValues()

Returns available enum codes

public static getValues() : array<string|int, string>
Return values
array<string|int, string>

isValid()

Makes strict check that $enumValue exists in current enum

public static isValid(string $enumValue) : bool
Parameters
$enumValue : string
Return values
bool

        
On this page

Search results