Класс NumberGenerator

Граф наследования:NumberGenerator:

Открытые члены
	parseTemplate ($template)
	parseTemplateForPreview ($template)

Открытые статические члены
static	getAvailableForType ()
static	getTemplateWordsForParse ()
static	getTemplateWordsSettings ()
static	onGeneratorClassesCollect ()
static	getType ()

Поля данных
const	USER_DEFINED_SYMBOL_START = '{USER_DEFINED:'
const	USER_DEFINED_SYMBOL_END = '}'
const	SYMBOL_START = '{'
const	SYMBOL_END = '}'

Защищенные члены
	setFromArrayOrDefault ($value, $config, $default=null, $type=null)

Защищенные статические члены
static	getPatternFor ($word)

Подробное описание

См. определение в файле numbergenerator.php строка 11

Методы

getAvailableForType()

getAvailableForType ( )

static

return type of numerator that this generator can work with

Исключения

NotImplementedException

Переопределяется в DateNumberGenerator, PrefixNumberGenerator, RandomNumberGenerator, SequentNumberGenerator, OrderIdNumberGenerator и OrderUserOrdersNumberGenerator.

См. определение в файле numbergenerator.php строка 39

getPatternFor()

getPatternFor ( $word )

staticprotected

Аргументы

$word

Возвращает

string

См. определение в файле numbergenerator.php строка 124

getTemplateWordsForParse()

getTemplateWordsForParse ( )

static

return array of words that can be parsed by generator

Исключения

NotImplementedException

Переопределяется в DateNumberGenerator, PrefixNumberGenerator, RandomNumberGenerator, SequentNumberGenerator, OrderIdNumberGenerator и OrderUserOrdersNumberGenerator.

См. определение в файле numbergenerator.php строка 48

getTemplateWordsSettings()

getTemplateWordsSettings ( )

static

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'

Исключения

NotImplementedException

Переопределяется в DateNumberGenerator, PrefixNumberGenerator, RandomNumberGenerator, SequentNumberGenerator, OrderIdNumberGenerator и OrderUserOrdersNumberGenerator.

См. определение в файле numbergenerator.php строка 59

getType()

getType ( )

static

Возвращает

string

См. определение в файле numbergenerator.php строка 79

onGeneratorClassesCollect()

onGeneratorClassesCollect ( )

static

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

См. также

NumberGeneratorFactory::EVENT_GENERATOR_CLASSES_COLLECT

Возвращает

string - static class name

См. определение в файле numbergenerator.php строка 71

parseTemplate()

parseTemplate ( $template )

abstract

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

Аргументы

$template

Возвращает

string after parse

Переопределяется в DateNumberGenerator, PrefixNumberGenerator, RandomNumberGenerator, SequentNumberGenerator и OrderIdNumberGenerator.

parseTemplateForPreview()

parseTemplateForPreview

(

$template

)

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

Аргументы

$template

Возвращает

string

Переопределяется в SequentNumberGenerator.

См. определение в файле numbergenerator.php строка 30

setFromArrayOrDefault()

setFromArrayOrDefault ( $value, $config, $default = null, $type = null )

protected

Аргументы

	$value
	$config
null	$default
null	$type

См. определение в файле numbergenerator.php строка 90

Поля

SYMBOL_END

const SYMBOL_END = '}'

См. определение в файле numbergenerator.php строка 16

SYMBOL_START

const SYMBOL_START = '{'

См. определение в файле numbergenerator.php строка 15

USER_DEFINED_SYMBOL_END

const USER_DEFINED_SYMBOL_END = '}'

См. определение в файле numbergenerator.php строка 14

USER_DEFINED_SYMBOL_START

const USER_DEFINED_SYMBOL_START = '{USER_DEFINED:'

См. определение в файле numbergenerator.php строка 13

---

Объявления и описания членов класса находятся в файле:

• C:/bitrix/modules/main/lib/numerator/generator/numbergenerator.php