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

Открытые члены
	setConfig ($config)
	getConfig ()
	parseTemplate ($template)
	parseTemplateForPreview ($template)
	getNextNumber ($numeratorId)
	setNextNumber ($numeratorId, $newNumber, $whereNumber)
	validateConfig ($config)
	setNumberHash ($numberHash)

Открытые статические члены
static	getSettingsFields ()
static	getTemplateWordsSettings ()
static	getTemplateWordsForParse ()
static	getAvailableForType ()
Открытые статические члены унаследованные от NumberGenerator
static	onGeneratorClassesCollect ()
static	getType ()

Поля данных
const	DAY = 'day'
const	MONTH = 'month'
const	YEAR = 'year'
const	TEMPLATE_WORD_NUMBER = 'NUMBER'
const	ERROR_SEQUENCE_NOT_SET = 'ERROR_SEQUENCE_NOT_SET'
Поля данных унаследованные от NumberGenerator
const	USER_DEFINED_SYMBOL_START = '{USER_DEFINED:'
const	USER_DEFINED_SYMBOL_END = '}'
const	SYMBOL_START = '{'
const	SYMBOL_END = '}'

Защищенные члены
	getSettings ($numeratorId=null, $createIfEmpty=true)
	saveNumeratorSequenceSettings ($numeratorId, $numberHash, $fields, $whereNextNumber=null)
Защищенные члены унаследованные от NumberGenerator
	setFromArrayOrDefault ($value, $config, $default=null, $type=null)

Защищенные данные
	$start
	$step
	$length = 0
	$padString = '0'
	$periodicBy
	$timezone
	$isDirectNumeration
	$nowTime
	$nextNumber
	$currentNumber
	$lastInvocationTime
	$numeratorId
	$numberHash

Дополнительные унаследованные члены
Защищенные статические члены унаследованные от NumberGenerator
static	getPatternFor ($word)

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

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

Методы

◆ getAvailableForType()

getAvailableForType ( )

static

Возвращает: string

Переопределяет метод предка NumberGenerator.

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

◆ getConfig()

getConfig ( )

Возвращает: array of configuration fields and their values

Замещает UserConfigurable.

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

◆ getNextNumber()

getNextNumber ( $numeratorId )

Аргументы

$numeratorId

Возвращает: mixed

Замещает Sequenceable.

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

◆ getSettings()

getSettings	(		$numeratorId = null,
			$createIfEmpty = true )

protected

Аргументы

null	$numeratorId
bool	$createIfEmpty

Возвращает: array

Исключения

Bitrix\Main\ArgumentException

Исключения

Bitrix\Main\DB\SqlQueryException

Исключения

Bitrix\Main\ObjectPropertyException

Исключения

Bitrix\Main\SystemException

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

◆ getSettingsFields()

getSettingsFields ( )

static

Возвращает: array of configuration fields that can be edited by user

Замещает UserConfigurable.

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

◆ getTemplateWordsForParse()

getTemplateWordsForParse ( )

static

return array of words that can be parsed by generator

Исключения

NotImplementedException

Переопределяет метод предка NumberGenerator.

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

◆ 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

Переопределяет метод предка NumberGenerator.

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

◆ parseTemplate()

parseTemplate ( $template )

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

Аргументы

$template

Возвращает: string after parse

Переопределяет метод предка NumberGenerator.

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

◆ parseTemplateForPreview()

parseTemplateForPreview ( $template )

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

Аргументы

$template

Возвращает: string

Переопределяет метод предка NumberGenerator.

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

◆ saveNumeratorSequenceSettings()

saveNumeratorSequenceSettings	(	$numeratorId,
		$numberHash,
		$fields,
		$whereNextNumber = null )

protected

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

◆ setConfig()

setConfig ( $config )

Аргументы

array | null $config

Замещает UserConfigurable.

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

◆ setNextNumber()

setNextNumber	(	$numeratorId,
		$newNumber,
		$whereNumber )

Аргументы

	$numeratorId
int	$newNumber
	$whereNumber

Возвращает: Result

Замещает Sequenceable.

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

◆ setNumberHash()

setNumberHash ( $numberHash )

Аргументы

$numberHash

Возвращает: mixed

Замещает Sequenceable.

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

◆ validateConfig()

validateConfig ( $config )

Аргументы

array $config

Возвращает: Result

Замещает UserConfigurable.

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

Поля

◆ $currentNumber

$currentNumber

protected

calculated value that used for template parsing

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

◆ $isDirectNumeration

$isDirectNumeration

protected

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

◆ $lastInvocationTime

$lastInvocationTime

protected

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

◆ $length

$length = 0

protected

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

◆ $nextNumber

$nextNumber

protected

value stored in database

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

◆ $nowTime

$nowTime

protected

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

◆ $numberHash

$numberHash

protected

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

◆ $numeratorId

$numeratorId

protected

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

◆ $padString

$padString = '0'

protected

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

◆ $periodicBy

$periodicBy

protected

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

◆ $start

$start

protected

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

◆ $step

$step

protected

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

◆ $timezone

$timezone

protected

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

◆ DAY

const DAY = 'day'

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

◆ ERROR_SEQUENCE_NOT_SET

const ERROR_SEQUENCE_NOT_SET = 'ERROR_SEQUENCE_NOT_SET'

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

◆ MONTH

const MONTH = 'month'

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

◆ TEMPLATE_WORD_NUMBER

const TEMPLATE_WORD_NUMBER = 'NUMBER'

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

◆ YEAR

const YEAR = 'year'

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

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

C:/bitrix/modules/main/lib/numerator/generator/sequentnumbergenerator.php

Открытые члены

Открытые статические члены

Поля данных

Защищенные члены

Защищенные данные

Дополнительные унаследованные члены

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

Методы

◆ getAvailableForType()

◆ getConfig()

◆ getNextNumber()

◆ getSettings()

◆ getSettingsFields()

◆ getTemplateWordsForParse()

◆ getTemplateWordsSettings()

◆ parseTemplate()

◆ parseTemplateForPreview()

◆ saveNumeratorSequenceSettings()

◆ setConfig()

◆ setNextNumber()

◆ setNumberHash()

◆ validateConfig()

Поля

◆ $currentNumber

◆ $isDirectNumeration

◆ $lastInvocationTime

◆ $length

◆ $nextNumber

◆ $nowTime

◆ $numberHash

◆ $numeratorId

◆ $padString

◆ $periodicBy

◆ $start

◆ $step

◆ $timezone

◆ DAY

◆ ERROR_SEQUENCE_NOT_SET

◆ MONTH

◆ TEMPLATE_WORD_NUMBER

◆ YEAR