Bitrix API

OrderIdNumberGenerator extends NumberGenerator implements DynamicConfigurable

Class OrderIdNumberGenerator

Table of Contents

Interfaces

DynamicConfigurable

Interface DynamicConfigurable - for generators that can not use static values or user specified settings for template parse generators receive values for parsing from outside on every run from where they can get values for replace template words

Constants

SYMBOL_END  = '}'

SYMBOL_START  = '{'

TEMPLATE_WORD_ORDER_ID  = "ORDER_ID"

USER_DEFINED_SYMBOL_END  = '}'

USER_DEFINED_SYMBOL_START  = '{USER_DEFINED:'

Methods

getAvailableForType()  : string

return type of numerator that this generator can work with

getTemplateWordsForParse()  : mixed

return array of words that can be parsed by generator

getTemplateWordsSettings()  : mixed

return array, where keys are words of generator and values are corresponding titles for showing to end user for each word e.g. {PREFIX} => 'prefix'

getType()  : string

onGeneratorClassesCollect()  : string

in case of inheritance (adding new custom generator) you should register this function of your class as module Dependency for module 'main' and event NumberGeneratorFactory::EVENT_GENERATOR_CLASSES_COLLECT

parseTemplate()  : string

replace specific symbol (that generator is responsible for) with some string by internal logic

parseTemplateForPreview()  : string

Must not affect internal counters and keep storage value unchanged, by default - same logic as in parseTemplate

setDynamicConfig()  : mixed