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

Открытые члены
	setCollection (EntityCollection $collection)

	getCollection ()

	delete ()

	setInternalIndex ($index)

	getInternalIndex ()

	isStartField ($isMeaningfulField=false)

	clearStartField ()

	hasMeaningfulField ()

	doFinalAction ($hasMeaningfulField=false)

	setMathActionOnly ($value=false)

	isMathActionOnly ()

	isClone ()

	createClone (\SplObjectStorage $cloneEntity)

Открытые члены унаследованные от Entity
	initializeField ($fieldName, $fieldInfo)
	Fields factory. Подробнее...

	initialize ($className)

	postInitialize ()

	getObjectClass ()
	Returns class of Object for current entity. Подробнее...

	getObjectClassName ()
	Returns class name of Object for current entity. Подробнее...

	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)

	hasUField ($name)

	getName ()

	getFullName ()

	getNamespace ()

	getModule ()

	getDataClass ()

	getConnection ()

	getDBTableName ()

	getPrimary ()

	getPrimaryArray ()

	getAutoIncrement ()

	isUts ()

	isUtm ()

	getUfId ()

	setDefaultScope ($query)

	getCode ()

	getLangCode ()

	getTitle ()

	__clone ()

	compileDbTableStructureDump ()

	createDbTable ()
	Creates table according to Fields collection. Подробнее...

	readFromCache ($ttl, $cacheId, $countTotal=false)
	Reads data from cache. Подробнее...

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

	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. Подробнее...

	cleanCache ()
	Cleans all cache entries for the entity. Подробнее...

	enableFullTextIndex ($field, $mode=true)
	Sets a flag indicating full text index support for a field. Подробнее...

	fullTextIndexEnabled ($field)
	Returns true if full text index is enabled for a field. Подробнее...

Защищенные члены
	onFieldModify ($name, $oldValue, $value)

Защищенные члены унаследованные от Entity
	appendField (Field $field)

	getCacheDir ()

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

	$internalIndex = null

	$isClone = false

Защищенные данные унаследованные от Entity
	$className

	$module

	$uf_id

	$fields

	$fieldsMap

	$u_fields

	$code

	$references

	$isClone = false

Дополнительные унаследованные члены
Открытые статические члены унаследованные от Entity
static	get ($entityName)
	Returns entity object. Подробнее...

static	has ($entityName)
	Checks if entity exists. Подробнее...

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	getInstanceByQuery (Query $query, &$entity_name=null)

static	compileEntity ($entityName, $fields=null, $parameters=array())

static	compileObjectClass ($dataClass)

static	compileCollectionClass ($dataClass)

static	destroy ($entity)

Поля данных унаследованные от Entity
	$name

	$connectionName

	$dbTableName

	$primary

	$autoIncrement

	$isUts

	$isUtm

const	DEFAULT_OBJECT_PREFIX = 'EO_'

Защищенные статические члены унаследованные от Entity
static	getInstanceDirect ($className)

Статические защищенные данные унаследованные от Entity
static	$instances

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

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

Методы

◆ clearStartField()

clearStartField ( )

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

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

     {
         $parent = $this->getCollection();
         if ($parent == null)
             return false;
  
         return $parent->clearStartField();
     }

◆ createClone()

createClone ( \SplObjectStorage $cloneEntity )

Переопределяется в Shipment, Payment, ShipmentItem и BasketItem.

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

     {
         if ($this->isClone() && $cloneEntity->contains($this))
         {
             return $cloneEntity[$this];
         }
  
         $collectableEntity = clone $this;
         $collectableEntity->isClone = true;
  
         /** @var Internals\Fields $fields */
         if ($fields = $this->fields)
         {
             $collectableEntity->fields = $fields->createClone($cloneEntity);
         }
  
         if (!$cloneEntity->contains($this))
         {
             $cloneEntity[$this] = $collectableEntity;
         }
  
         if ($collection = $this->getCollection())
         {
             if (!$cloneEntity->contains($collection))
             {
                 $cloneEntity[$collection] = $collection->createClone($cloneEntity);
             }
  
             if ($cloneEntity->contains($collection))
             {
                 $collectableEntity->collection = $cloneEntity[$collection];
             }
         }
  
         return $collectableEntity;
     }

◆ delete()

delete ( )

Исключения

Main

Переопределяется в Shipment, BasketItem, Payment, BasketItemBase, ShipmentItemStore и ShipmentItem.

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

     {
         $collection = $this->getCollection();
         if (!$collection)
         {
             throw new Main\ObjectNotFoundException('Entity "CollectableEntity" not found');
         }
  
         /** @var Result $r */
         $collection->deleteItem($this->getInternalIndex());
  
         return new Result();
     }

◆ doFinalAction()

doFinalAction ( $hasMeaningfulField = false )

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

     {
         $parent = $this->getCollection();
         if ($parent == null)
         {
             return false;
         }
  
         return $parent->doFinalAction($hasMeaningfulField);
     }

◆ getCollection()

getCollection ( )

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

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

     {
         return $this->collection;
     }

◆ getInternalIndex()

getInternalIndex ( )

Возвращает: null|int

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

     {
         return $this->internalIndex;
     }

◆ hasMeaningfulField()

hasMeaningfulField ( )

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

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

     {
         $parent = $this->getCollection();
         if ($parent == null)
             return false;
  
         return $parent->hasMeaningfulField();
     }

◆ isClone()

isClone ( )

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

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

     {
         return $this->isClone;
     }

◆ isMathActionOnly()

isMathActionOnly ( )

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

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

     {
         $parent = $this->getCollection();
         if ($parent == null)
             return false;
  
         return $parent->isMathActionOnly();
     }

◆ isStartField()

isStartField ( $isMeaningfulField = false )

Аргументы

bool $isMeaningfulField

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

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

     {
         $parent = $this->getCollection();
         if ($parent == null)
             return false;
  
         return $parent->isStartField($isMeaningfulField);
     }

◆ onFieldModify()

onFieldModify	(	$name,
		$oldValue,
		$value
	)

protected

Аргументы

string	$name
mixed	$oldValue
mixed	$value

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

Переопределяется в Shipment, BasketItem, BasketItemBase, Payment, ShipmentItem и ShipmentItemStore.

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

     {
         $collection = $this->getCollection();
         return $collection->onItemModify($this, $name, $oldValue, $value);
     }

◆ setCollection()

setCollection ( EntityCollection $collection )

Аргументы

EntityCollection $collection

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

     {
         $this->collection = $collection;
     }

◆ setInternalIndex()

setInternalIndex ( $index )

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

     {
         $this->internalIndex = $index;
     }

◆ setMathActionOnly()

setMathActionOnly ( $value = false )

Аргументы

bool | false $value

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

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

     {
         $parent = $this->getCollection();
         if ($parent == null)
         {
             return false;
         }
  
         return $parent->setMathActionOnly($value);
     }

Поля

◆ $collection

$collection

protected

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

◆ $internalIndex

$internalIndex = null

protected

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

◆ $isClone

$isClone = false

protected

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

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

collectableentity.php

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

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

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

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

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

Методы

◆ clearStartField()

◆ createClone()

◆ delete()

◆ doFinalAction()

◆ getCollection()

◆ getInternalIndex()

◆ hasMeaningfulField()

◆ isClone()

◆ isMathActionOnly()

◆ isStartField()

◆ onFieldModify()

◆ setCollection()

◆ setInternalIndex()

◆ setMathActionOnly()

Поля

◆ $collection

◆ $internalIndex

◆ $isClone