Класс Entity

Граф наследования: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 строка 26

Методы

__clone()

__clone

(

)

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

addField()

addField	(		$fieldInfo,
			$fieldName = null )

Аргументы

array | Field	$fieldInfo
null | string	$fieldName

Возвращает

Field|false

Исключения

Main

ArgumentException

Исключения

Main

SystemException

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

appendField()

appendField ( Field $field )

protected

Аргументы

Field

$field

Возвращает

bool

Исключения

Main

ArgumentException

Исключения

Main

SystemException

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

camel2snake()

camel2snake ( $str )

static

Аргументы

$str

Возвращает

string

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

cleanCache()

cleanCache

(

)

Cleans all cache entries for the entity.

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

compileCollectionClass()

compileCollectionClass ( $dataClass )

static

Аргументы

$dataClass

Возвращает

Collection|string

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

compileObjectClass()

compileObjectClass ( $dataClass )

static

Аргументы

$dataClass

Возвращает

EntityObject|string

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

createCollection()

createCollection

(

)

Возвращает

null Actual type should be annotated by orm:annotate

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

createDbTable()

createDbTable

(

)

Creates table according to Fields collection

Возвращает

void

Исключения

Main

SystemException

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

createObject()

createObject

(

$setDefaultValues = true

)

Аргументы

bool

$setDefaultValues

Возвращает

null Actual type should be annotated by orm:annotate

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

destroy()

destroy ( $entity )

static

Аргументы

Entity | string

$entity

Возвращает

bool

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

enableFullTextIndex()

enableFullTextIndex	(		$field,
			$mode = true )

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

Аргументы

string	$field
bool	$mode

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

fullTextIndexEnabled()

fullTextIndexEnabled

(

$field

)

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

Аргументы

string

$field

Возвращает

bool

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

get()

get ( $entityName )

static

Returns entity object

Аргументы

$entityName

Возвращает

Entity

Исключения

Main

ArgumentException

Исключения

Main

SystemException

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

getAutoIncrement()

getAutoIncrement

(

)

Возвращает

string|null - null if entity has no autoincrement

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

getCacheDir()

getCacheDir ( )

protected

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

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 строка 1382

getCode()

getCode

(

)

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

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

getCollectionClass()

getCollectionClass

(

)

Возвращает

Collection|string

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

getCollectionClassName()

getCollectionClassName

(

)

Возвращает

Collection|string

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

getDataClass()

getDataClass

(

)

Возвращает

DataManager|string

Переопределяется в Chat, Message и Relation.

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

getDBTableName()

getDBTableName

(

)

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

getDefaultCollectionClassName()

getDefaultCollectionClassName ( $entityName )

static

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

getDefaultObjectClassName()

getDefaultObjectClassName ( $entityName )

static

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

getEntityClassParts()

getEntityClassParts ( $class )

static

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

getField()

getField

(

$name

)

Аргументы

$name

Возвращает

Field|ScalarField

Исключения

Main

ArgumentException

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

getFields()

getFields

(

)

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

getFullName()

getFullName

(

)

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

getInstance()

getInstance ( $entityName )

static

Аргументы

string

$entityName

Возвращает

Entity

Исключения

Main

ArgumentException

Исключения

Main

SystemException

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

getLangCode()

getLangCode

(

)

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

getModule()

getModule

(

)

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

getName()

getName

(

)

Переопределяется в Department, NullUser и User.

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

getNamespace()

getNamespace

(

)

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

getObjectClass()

getObjectClass

(

)

Returns class of Object for current entity.

Возвращает

EntityObject|string

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

getObjectClassName()

getObjectClassName

(

)

Returns class name of Object for current entity.

Возвращает

EntityObject|string

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

getPrimary()

getPrimary

(

)

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

getPrimaryArray()

getPrimaryArray

(

)

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

getReferencesCountTo()

getReferencesCountTo

(

$refEntityName

)

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

getReferencesTo()

getReferencesTo

(

$refEntityName

)

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

getScalarFields()

getScalarFields

(

)

Возвращает

ScalarField[]

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

getTitle()

getTitle

(

)

Переопределяется в Chat, CalendarItem, TaskItem и Entity.

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

getUfId()

getUfId

(

)

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

getUField()

getUField

(

$name

)

Аргументы

$name

Возвращает

UField

Исключения

Main

ArgumentException

Исключения

Main

SystemException

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

has()

has ( $entityName )

static

Checks if entity exists

Аргументы

$entityName

Возвращает

bool

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

hasField()

hasField

(

$name

)

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

initializeField()

initializeField	(		$fieldName,
			$fieldInfo )

Fields factory

Аргументы

string	$fieldName
array | Field	$fieldInfo

Возвращает

Field

Исключения

Main

ArgumentException

Исключения

Main

SystemException

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

isExists()

isExists ( $name )

static

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

isUtm()

isUtm

(

)

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

isUts()

isUts

(

)

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

normalizeEntityClass()

normalizeEntityClass ( $entityName )

static

Аргументы

$entityName

Возвращает

string|DataManager

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

normalizeName()

normalizeName ( $entityName )

static

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

onUserTypeChange()

onUserTypeChange ( $userfield, $id = null )

static

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

postInitialize()

postInitialize

(

)

Исключения

Main

ArgumentException

Исключения

Main

SystemException

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

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

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

reinitialize()

reinitialize

(

$className

)

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

Аргументы

$className

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

setDefaultScope()

setDefaultScope

(

$query

)

Аргументы

Query

$query

Возвращает

Query

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

snake2camel()

snake2camel ( $str )

static

Аргументы

$str

Возвращает

mixed

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

wakeUpCollection()

wakeUpCollection

(

$rows

)

См. также

Collection::wakeUp()

Аргументы

$rows

Возвращает

null Actual type should be annotated by orm:annotate

Исключения

Main

ArgumentException

Исключения

Main

SystemException

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

wakeUpObject()

wakeUpObject

(

$row

)

См. также

EntityObject::wakeUp()

Аргументы

$row

Возвращает

null Actual type should be annotated by orm:annotate

Исключения

Main

ArgumentException

Исключения

Main

SystemException

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

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 строка 1355

Поля

$autoIncrement

$autoIncrement

protected

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

$className

$className

protected

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

$code

$code

protected

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

$connectionName

$connectionName

protected

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

$dbTableName

$dbTableName

protected

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

$fields

$fields

protected

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

$fieldsMap

$fieldsMap

protected

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

$instances

$instances

staticprotected

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

$isClone

$isClone = false

protected

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

$isUtm

$isUtm

protected

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

$isUts

$isUts

protected

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

$module

$module

protected

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

$name

$name

protected

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

$primary

$primary

protected

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

$references

$references

protected

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

$u_fields

$u_fields

protected

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

$uf_id

$uf_id

protected

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

$ufIdIndex

$ufIdIndex = []

staticprotected

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

DEFAULT_OBJECT_PREFIX

const DEFAULT_OBJECT_PREFIX = 'EO_'

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

---

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

• C:/bitrix/modules/main/lib/orm/entity.php