Bitrix-D7 23.9
 
Загрузка...
Поиск...
Не найдено
Открытые члены | Открытые статические члены | Открытые атрибуты | Защищенные члены | Защищенные статические члены | Статические защищенные данные | Полный список членов класса
Класс Numerator

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

 setHash ($hashable)
 
 setDynamicConfig ($dynamicConfig)
 
 save ()
 
 previewNextSequentialNumber ($hash=null)
 
 hasSequentialNumber ()
 
 setNextSequentialNumber ($nextNumber, $whereNumber=null, $hash=null)
 
 getConfig ()
 
 setConfig ($config)
 
 getId ()
 

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

static create ()
 
static getListByType ($type=null, $sort=null)
 
static getOneByType ($type=null)
 
static update ($numId, $config)
 
static load ($numeratorId, $source=null)
 
static loadByCode ($code, $source=null)
 
static delete ($id)
 
static getType ()
 

Открытые атрибуты

const NUMERATOR_DEFAULT_TYPE = 'DEFAULT'
 
const NUMERATOR_ALL_GENERATORS_TYPE = 'ALL'
 

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

 setTemplate ($template)
 

Защищенные статические члены

static getNumberGeneratorFactory ()
 
static getUserDefinedTemplateWords ($numeratorType)
 

Статические защищенные данные

static $numberGeneratorFactory
 

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

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

Методы

◆ create()

static create ( )
static

return empty numerator object with no configuration

Возвращает
static

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

◆ delete()

static delete ( $id)
static
Аргументы
$id
Возвращает
$this|\Bitrix\Main\Entity\DeleteResult|Result
Исключения

Exception

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

◆ getConfig()

getConfig ( )

return numerator's configuration with filled in values for every setting

Возвращает
array

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

◆ getId()

getId ( )

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

◆ getListByType()

static getListByType ( $type = null,
$sort = null )
static
Аргументы
string$type
null$sort
Возвращает
array
Исключения

Bitrix\Main\ArgumentException

Исключения

Bitrix\Main\ObjectPropertyException

Исключения

Bitrix\Main\SystemException

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

◆ getNumberGeneratorFactory()

static getNumberGeneratorFactory ( )
staticprotected
Возвращает
NumberGeneratorFactory

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

◆ getOneByType()

static getOneByType ( $type = null)
static

Returns numerator related fields from db by its type (use it in case of only single one exists for the type)

Аргументы
string$type
Возвращает
array|null
Исключения

Bitrix\Main\ArgumentException

Исключения

Bitrix\Main\ObjectPropertyException

Исключения

Bitrix\Main\SystemException

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

◆ getType()

static getType ( )
static

type string used as key in configuration arrays

Возвращает
string

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

◆ getUserDefinedTemplateWords()

static getUserDefinedTemplateWords ( $numeratorType)
staticprotected

For compatibility - users can defined their own type of template generation

Аргументы
$numeratorType
Возвращает
array

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

◆ hasSequentialNumber()

hasSequentialNumber ( )

check if numerator has {NUMBER} in template

Возвращает
bool

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

◆ load()

static load ( $numeratorId,
$source = null )
static

Load numerator by id

Аргументы
$numeratorId
$source- optional, numerator dynamicConfig for generating next number, also can be Hashable ancestor for set up hash for numerator
Возвращает
null|static
Исключения

Bitrix\Main\ArgumentException

Исключения

Bitrix\Main\ObjectPropertyException

Исключения

Bitrix\Main\SystemException

См. также
Numerator::getNext()

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

◆ loadByCode()

static loadByCode ( $code,
$source = null )
static
Аргументы
$code
$source
Возвращает
static|null

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

◆ previewNextSequentialNumber()

previewNextSequentialNumber ( $hash = null)

returns next sequential number, if numerator has sequence, null if it hasn't not increases the sequent number

Аргументы
string$hash
Возвращает
int|null

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

◆ save()

save ( )
Возвращает
\Bitrix\Main\Entity\AddResult|\Bitrix\Main\Entity\UpdateResult
Исключения

Bitrix\Main\ArgumentException

Исключения

Bitrix\Main\ObjectException

Исключения

Bitrix\Main\ObjectPropertyException

Исключения

Bitrix\Main\SystemException

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

◆ setConfig()

setConfig ( $config)

sets configuration for numerator and validates settings

Аргументы
$config
Возвращает
Result - message that can be shown to an end user
Исключения

Bitrix\Main\NotImplementedException

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

◆ setDynamicConfig()

setDynamicConfig ( $dynamicConfig)
Аргументы
$dynamicConfig- anything (array|object|..) that will be used by DynamicConfigurable generators of Numerator for parsing template and creating number

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

◆ setHash()

setHash ( $hashable)
Аргументы
$hashable- object that returns hash string Used for Numerators containing Sequential number Hash can be set once, will be ignored here, if it was already set Typically hash is a string like COMPANY_64, or USER_42

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

◆ setNextSequentialNumber()

setNextSequentialNumber ( $nextNumber,
$whereNumber = null,
$hash = null )

The only way to affect the NEXT number

  • function forces the numerator to start counting with a given number
    Аргументы
    int$nextNumber
    $whereNumber- old value of next number
    string$hash
    Возвращает
    Result

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

◆ setTemplate()

setTemplate ( $template)
protected
Аргументы
$template

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

◆ update()

static update ( $numId,
$config )
static
Аргументы
$numId
$config- same configuration structure as using via setConfig method
Возвращает
\Bitrix\Main\Entity\AddResult|\Bitrix\Main\Entity\UpdateResult|Result
Исключения

Bitrix\Main\ArgumentException

Исключения

Bitrix\Main\NotImplementedException

Исключения

Bitrix\Main\ObjectException

Исключения

Bitrix\Main\ObjectPropertyException

Исключения

Bitrix\Main\SystemException

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

Данные класса

◆ $numberGeneratorFactory

$numberGeneratorFactory
staticprotected

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

◆ NUMERATOR_ALL_GENERATORS_TYPE

const NUMERATOR_ALL_GENERATORS_TYPE = 'ALL'

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

◆ NUMERATOR_DEFAULT_TYPE

const NUMERATOR_DEFAULT_TYPE = 'DEFAULT'

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