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

Открытые члены
	initializeField ($fieldName, $fieldInfo)

	reinitialize ($className)

	postInitialize ()

	getObjectClass ()

	getObjectClassName ()

	getCollectionClass ()

	getCollectionClassName ()

	createObject ($setDefaultValues=true)

	createCollection ()

	wakeUpObject ($row)

	wakeUpCollection ($rows)

	addField ($fieldInfo, $fieldName=null)

	getReferencesCountTo ($refEntityName)

	getReferencesTo ($refEntityName)

	getFields ()

	getField ($name)

	hasField ($name)

	getScalarFields ()

	getUField ($name)

	getName ()

	getFullName ()

	getNamespace ()

	getModule ()

	getDataClass ()

	getDBTableName ()

	getPrimary ()

	getPrimaryArray ()

	getAutoIncrement ()

	isUts ()

	isUtm ()

	getUfId ()

	setDefaultScope ($query)

	getCode ()

	getLangCode ()

	getTitle ()

	__clone ()

	createDbTable ()

	readFromCache ($ttl, $cacheId, $countTotal=false)

	writeToCache (Main\DB\Result $result, $cacheId, $countTotal=false)

	getCacheTtl ($ttl)

	cleanCache ()

	enableFullTextIndex ($field, $mode=true)

	fullTextIndexEnabled ($field)

Открытые статические члены
static	get ($entityName)

static	has ($entityName)

static	getInstance ($entityName)

static	getDefaultObjectClassName ($entityName)

static	getDefaultCollectionClassName ($entityName)

static	isExists ($name)

static	normalizeEntityClass ($entityName)

static	getEntityClassParts ($class)

static	camel2snake ($str)

static	snake2camel ($str)

static	normalizeName ($entityName)

static	compileObjectClass ($dataClass)

static	compileCollectionClass ($dataClass)

static	destroy ($entity)

static	onUserTypeChange ($userfield, $id=null)

Открытые атрибуты
const	DEFAULT_OBJECT_PREFIX = 'EO_'

Защищенные члены
	appendField (Field $field)

	getCacheDir ()

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

	$module

	$name

	$connectionName

	$dbTableName

	$primary

	$autoIncrement

	$uf_id

	$isUts

	$isUtm

	$fields

	$fieldsMap

	$u_fields

	$code

	$references

	$isClone = false

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

static	$ufIdIndex = []

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

Base entity

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

Методы

◆ __clone()

__clone ( )

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

◆ addField()

addField	(	$fieldInfo,
		$fieldName = `null`
	)

Аргументы

array \| Field	$fieldInfo
null \| string	$fieldName

Возвращает: Field|false

Исключения

Main

ArgumentException

Исключения

Main

SystemException

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

◆ appendField()

appendField ( Field $field )

protected

Аргументы

Field $field

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

Исключения

Main

ArgumentException

Исключения

Main

SystemException

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

◆ camel2snake()

static camel2snake ( $str )

static

Аргументы

$str

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

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

◆ cleanCache()

cleanCache ( )

Cleans all cache entries for the entity.

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

◆ compileCollectionClass()

static compileCollectionClass ( $dataClass )

static

Аргументы

$dataClass

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

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

◆ compileObjectClass()

static compileObjectClass ( $dataClass )

static

Аргументы

$dataClass

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

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

◆ createCollection()

createCollection ( )

Возвращает: null Actual type should be annotated by orm:annotate

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

◆ createDbTable()

createDbTable ( )

Creates table according to Fields collection

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

Исключения

Main

SystemException

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

◆ createObject()

createObject ( $setDefaultValues = true )

Аргументы

bool $setDefaultValues

Возвращает: null Actual type should be annotated by orm:annotate

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

◆ destroy()

static destroy ( $entity )

static

Аргументы

Entity | string $entity

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

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

◆ enableFullTextIndex()

enableFullTextIndex	(	$field,
		$mode = `true`
	)

Sets a flag indicating full text index support for a field.

Аргументы

string	$field
bool	$mode

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

◆ fullTextIndexEnabled()

fullTextIndexEnabled ( $field )

Returns true if full text index is enabled for a field.

Аргументы

string $field

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

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

◆ get()

static get ( $entityName )

static

Returns entity object

Аргументы

$entityName

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

Исключения

Main

ArgumentException

Исключения

Main

SystemException

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

◆ getAutoIncrement()

getAutoIncrement ( )

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

◆ getCacheDir()

getCacheDir ( )

protected

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

◆ getCacheTtl()

getCacheTtl ( $ttl )

Returns cache TTL for the entity, possibly limited by the .settings.php: 'cache_flags' => array('value'=> array( "b_group_max_ttl" => 200, "b_group_min_ttl" => 100, )) Maximum is a higher-priority.

Аргументы

int $ttl Preferable TTL

Возвращает: int Calculated TTL

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

◆ getCode()

getCode ( )

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

◆ getCollectionClass()

getCollectionClass ( )

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

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

◆ getCollectionClassName()

getCollectionClassName ( )

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

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

◆ getDataClass()

getDataClass ( )

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

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

◆ getDBTableName()

getDBTableName ( )

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

◆ getDefaultCollectionClassName()

static getDefaultCollectionClassName ( $entityName )

static

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

◆ getDefaultObjectClassName()

static getDefaultObjectClassName ( $entityName )

static

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

◆ getEntityClassParts()

static getEntityClassParts ( $class )

static

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

◆ getField()

getField ( $name )

Аргументы

$name

Возвращает: Field|ScalarField

Исключения

Main

ArgumentException

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

◆ getFields()

getFields ( )

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

◆ getFullName()

getFullName ( )

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

◆ getInstance()

static getInstance ( $entityName )

static

Аргументы

string $entityName

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

Исключения

Main

ArgumentException

Исключения

Main

SystemException

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

◆ getLangCode()

getLangCode ( )

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

◆ getModule()

getModule ( )

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

◆ getName()

getName ( )

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

◆ getNamespace()

getNamespace ( )

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

◆ getObjectClass()

getObjectClass ( )

Returns class of Object for current entity.

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

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

◆ getObjectClassName()

getObjectClassName ( )

Returns class name of Object for current entity.

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

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

◆ getPrimary()

getPrimary ( )

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

◆ getPrimaryArray()

getPrimaryArray ( )

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

◆ getReferencesCountTo()

getReferencesCountTo ( $refEntityName )

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

◆ getReferencesTo()

getReferencesTo ( $refEntityName )

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

◆ getScalarFields()

getScalarFields ( )

Возвращает: ScalarField[]

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

◆ getTitle()

getTitle ( )

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

◆ getUfId()

getUfId ( )

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

◆ getUField()

getUField ( $name )

Аргументы

$name

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

Исключения

Main

ArgumentException

Исключения

Main

SystemException

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

◆ has()

static has ( $entityName )

static

Checks if entity exists

Аргументы

$entityName

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

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

◆ hasField()

hasField ( $name )

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

◆ initializeField()

initializeField	(	$fieldName,
		$fieldInfo
	)

Fields factory

Аргументы

string	$fieldName
array \| Field	$fieldInfo

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

Исключения

Main

ArgumentException

Исключения

Main

SystemException

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

◆ isExists()

static isExists ( $name )

static

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

◆ isUtm()

isUtm ( )

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

◆ isUts()

isUts ( )

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

◆ normalizeEntityClass()

static normalizeEntityClass ( $entityName )

static

Аргументы

$entityName

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

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

◆ normalizeName()

static normalizeName ( $entityName )

static

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

◆ onUserTypeChange()

static onUserTypeChange	(	$userfield,
		$id = `null`
	)

static

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

◆ postInitialize()

postInitialize ( )

Исключения

Main

ArgumentException

Исключения

Main

SystemException

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

◆ readFromCache()

readFromCache	(	$ttl,
		$cacheId,
		$countTotal = `false`
	)

Reads data from cache.

Аргументы

int	$ttl	TTL.
string	$cacheId	The cache ID.
bool	$countTotal	Whether to read total count from the cache.

Возвращает: Main\DB\ArrayResult|null

Исключения

Main

SystemException

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

◆ reinitialize()

reinitialize ( $className )

Reinitializing entity object for another Table class. Can be useful for complex inheritance with cloning.

Аргументы

$className

Исключения

Main

SystemException

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

◆ setDefaultScope()

setDefaultScope ( $query )

Аргументы

Query $query

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

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

◆ snake2camel()

static snake2camel ( $str )

static

Аргументы

$str

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

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

◆ wakeUpCollection()

wakeUpCollection ( $rows )

См. также: Collection::wakeUp()

Аргументы

$rows

Возвращает: null Actual type should be annotated by orm:annotate

Исключения

Main

ArgumentException

Исключения

Main

SystemException

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

◆ wakeUpObject()

wakeUpObject ( $row )

См. также: EntityObject::wakeUp()

Аргументы

$row

Возвращает: null Actual type should be annotated by orm:annotate

Исключения

Main

ArgumentException

Исключения

Main

SystemException

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

◆ writeToCache()

writeToCache	(	Main\DB\Result	$result,
			$cacheId,
			$countTotal = `false`
	)

Аргументы

Main\DB\Result	$result	A query result to cache.
string	$cacheId	The cache ID.
bool	$countTotal	Whether to write total count to the cache.

Возвращает: Main\DB\ArrayResult

Исключения

Main

ObjectPropertyException

Исключения

Main

SystemException

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

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

◆ $autoIncrement

$autoIncrement

protected

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

◆ $className

$className

protected

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

◆ $code

$code

protected

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

◆ $connectionName

$connectionName

protected

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

◆ $dbTableName

$dbTableName

protected

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

◆ $fields

$fields

protected

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

◆ $fieldsMap

ScalarField[] $fieldsMap

protected

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

◆ $instances

$instances

staticprotected

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

◆ $isClone

$isClone = false

protected

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

◆ $isUtm

$isUtm

protected

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

◆ $isUts

$isUts

protected

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

◆ $module

$module

protected

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

◆ $name

$name

protected

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

◆ $primary

$primary

protected

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

◆ $references

$references

protected

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

◆ $u_fields

$u_fields

protected

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

◆ $uf_id

$uf_id

protected

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

◆ $ufIdIndex

$ufIdIndex = []

staticprotected

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

◆ DEFAULT_OBJECT_PREFIX

const DEFAULT_OBJECT_PREFIX = 'EO_'

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

Bitrix-D7 22.6

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

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

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

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

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

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

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

Методы

◆ __clone()

◆ addField()

◆ appendField()

◆ camel2snake()

◆ cleanCache()

◆ compileCollectionClass()

◆ compileObjectClass()

◆ createCollection()

◆ createDbTable()

◆ createObject()

◆ destroy()

◆ enableFullTextIndex()

◆ fullTextIndexEnabled()

◆ get()

◆ getAutoIncrement()

◆ getCacheDir()

◆ getCacheTtl()

◆ getCode()

◆ getCollectionClass()

◆ getCollectionClassName()

◆ getDataClass()

◆ getDBTableName()

◆ getDefaultCollectionClassName()

◆ getDefaultObjectClassName()

◆ getEntityClassParts()

◆ getField()

◆ getFields()

◆ getFullName()

◆ getInstance()

◆ getLangCode()

◆ getModule()

◆ getName()

◆ getNamespace()

◆ getObjectClass()

◆ getObjectClassName()

◆ getPrimary()

◆ getPrimaryArray()

◆ getReferencesCountTo()

◆ getReferencesTo()

◆ getScalarFields()

◆ getTitle()

◆ getUfId()

◆ getUField()

◆ has()

◆ hasField()

◆ initializeField()

◆ isExists()

◆ isUtm()

◆ isUts()

◆ normalizeEntityClass()

◆ normalizeName()

◆ onUserTypeChange()

◆ postInitialize()

◆ readFromCache()

◆ reinitialize()

◆ setDefaultScope()

◆ snake2camel()

◆ wakeUpCollection()

◆ wakeUpObject()

◆ writeToCache()

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

◆ $autoIncrement

◆ $className

◆ $code

◆ $connectionName

◆ $dbTableName

◆ $fields

◆ $fieldsMap

◆ $instances

◆ $isClone

◆ $isUtm

◆ $isUts