Bitrix API

QuoteIdNumberGenerator extends NumberGenerator implements DynamicConfigurable

Class QuoteIdNumberGenerator

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_QUOTE_ID  = "QUOTE_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

Constants

USER_DEFINED_SYMBOL_START

public mixed USER_DEFINED_SYMBOL_START = '{USER_DEFINED:'

Methods

getAvailableForType()

return type of numerator that this generator can work with

public static getAvailableForType() : string
Return values
string

getTemplateWordsForParse()

return array of words that can be parsed by generator

public static getTemplateWordsForParse() : mixed
Tags
inheritdoc

getTemplateWordsSettings()

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'

public static getTemplateWordsSettings() : mixed
Tags
inheritdoc

onGeneratorClassesCollect()

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

public static onGeneratorClassesCollect() : string
Tags
see
NumberGeneratorFactory::EVENT_GENERATOR_CLASSES_COLLECT
Return values
string
  • static class name

parseTemplate()

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

public parseTemplate(mixed $template) : string
Parameters
$template : mixed
Tags
inheritdoc
Return values
string

after parse

parseTemplateForPreview()

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

public parseTemplateForPreview(mixed $template) : string
Parameters
$template : mixed
Return values
string

setDynamicConfig()

public setDynamicConfig(array<string|int, mixed> $config) : mixed
Parameters
$config : array<string|int, mixed>

        
On this page

Search results