Bitrix API

BasePreset

AbstractYes

Table of Contents

Constants

ACTION_TYPE_DISCOUNT  = 'Discount'
ACTION_TYPE_EXTRA  = 'Extra'
AVAILABLE_STATE_ALLOW  = 0x1
AVAILABLE_STATE_DISALLOW  = 0x2
AVAILABLE_STATE_TARIFF  = 0x4
FINAL_STEP  = 'FINALSTEP'
MODE_SAVE  = 3
MODE_SHOW  = 2
RUN_PREV_STEP_NAME_VAR  = '__run_prev_step'
STEP_NAME_VAR  = '__next_step'

Methods

__construct()  : mixed
beginForm()  : mixed
className()  : string
classShortName()  : string
enableRestrictedGroupsMode()  : mixed
endForm()  : mixed
exec()  : mixed
executeAjaxAction()  : mixed
generateDiscount()  : array<string|int, mixed>
generateState()  : State
getAvailableHelpLink()  : array<string|int, mixed>|null
getAvailableState()  : int
getCategory()  : int
getDescription()  : string
getDiscount()  : array<string|int, mixed>
getErrors()  : array<string|int, Error>
getExtendedDescription()  : mixed
getFirstStepName()  : string
getNextStep()  : string
getPossible()  : bool
getSort()  : int
Returns sort to sorting presets in category row.
getStepDescription()  : string
getStepNumber()  : mixed
getStepTitle()  : string
getTitle()  : string
getView()  : mixed
hasErrors()  : mixed
hasPrevStep()  : mixed
isAvailable()  : bool
isLastStep()  : mixed
isRestrictedGroupsModeEnabled()  : mixed
processAjaxActionGetProductDetails()  : mixed
processShowFinalStep()  : mixed
setDiscount()  : $this
setNextStep()  : $this
setStepDescription()  : $this
setStepTitle()  : mixed

Constants

ACTION_TYPE_DISCOUNT

public mixed ACTION_TYPE_DISCOUNT = 'Discount'

ACTION_TYPE_EXTRA

public mixed ACTION_TYPE_EXTRA = 'Extra'

AVAILABLE_STATE_ALLOW

public mixed AVAILABLE_STATE_ALLOW = 0x1

AVAILABLE_STATE_DISALLOW

public mixed AVAILABLE_STATE_DISALLOW = 0x2

AVAILABLE_STATE_TARIFF

public mixed AVAILABLE_STATE_TARIFF = 0x4

FINAL_STEP

public mixed FINAL_STEP = 'FINALSTEP'

RUN_PREV_STEP_NAME_VAR

public mixed RUN_PREV_STEP_NAME_VAR = '__run_prev_step'

STEP_NAME_VAR

public mixed STEP_NAME_VAR = '__next_step'

Methods

className()

public static className() : string
Return values
string —

the fully qualified name of this class.

classShortName()

public static classShortName(BasePreset $classObject) : string
Parameters
$classObject : BasePreset
Return values
string —

the short qualified name of this class.

enableRestrictedGroupsMode()

public enableRestrictedGroupsMode(mixed $state) : mixed
Parameters
$state : mixed

executeAjaxAction()

public executeAjaxAction(mixed $actionName) : mixed
Parameters
$actionName : mixed

generateDiscount()

public generateDiscount(State $state) : array<string|int, mixed>
Parameters
$state : State
Return values
array<string|int, mixed> —

Discount fields.

generateState()

public generateState(array<string|int, mixed> $discountFields) : State
Parameters
$discountFields : array<string|int, mixed>
Return values
State —

$state

getAvailableHelpLink()

public getAvailableHelpLink() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null

getAvailableState()

public getAvailableState() : int
Return values
int

getCategory()

public getCategory() : int
Return values
int

getDescription()

public abstract getDescription() : string
Return values
string

getDiscount()

public getDiscount() : array<string|int, mixed>
Return values
array<string|int, mixed>

getErrors()

public getErrors() : array<string|int, Error>
Return values
array<string|int, Error>

getExtendedDescription()

public getExtendedDescription() : mixed

getFirstStepName()

public abstract getFirstStepName() : string
Return values
string

getNextStep()

public getNextStep() : string
Return values
string

getPossible()

public getPossible() : bool
Return values
bool

getSort()

Returns sort to sorting presets in category row.

public getSort() : int
Return values
int

getStepDescription()

public getStepDescription() : string
Return values
string

getStepTitle()

public getStepTitle() : string
Return values
string

getTitle()

public abstract getTitle() : string
Return values
string

isAvailable()

public isAvailable() : bool
Tags
see
BasePreset::getAvailableState

Tells if preset is available or not. It's possible that preset can't work in some license.

Return values
bool

isRestrictedGroupsModeEnabled()

public isRestrictedGroupsModeEnabled() : mixed

processAjaxActionGetProductDetails()

public processAjaxActionGetProductDetails([array<string|int, mixed> $params = [] ]) : mixed
Parameters
$params : array<string|int, mixed> = []

processShowFinalStep()

public processShowFinalStep(State $state) : mixed
Parameters
$state : State

setDiscount()

public setDiscount(array<string|int, mixed> $discount) : $this
Parameters
$discount : array<string|int, mixed>
Return values
$this

setNextStep()

public setNextStep(string $nextStep) : $this
Parameters
$nextStep : string
Return values
$this

setStepDescription()

public setStepDescription(string $stepDescription) : $this
Parameters
$stepDescription : string
Return values
$this

setStepTitle()

public setStepTitle(string $stepTitle) : mixed
Parameters
$stepTitle : string 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results