Bitrix-D7  20.0.0
Класс CollectableEntity
Граф наследования:CollectableEntity:
Entity BasketItemBase BasketPropertyItemBase Payment PropertyValueBase Shipment ShipmentItem ShipmentItemStore TradeBindingEntity

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

 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

105  {
106  $parent = $this->getCollection();
107  if ($parent == null)
108  return false;
109 
110  return $parent->clearStartField();
111  }

◆ createClone()

createClone ( \SplObjectStorage  $cloneEntity)

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

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

178  {
179  if ($this->isClone() && $cloneEntity->contains($this))
180  {
181  return $cloneEntity[$this];
182  }
183 
184  $collectableEntity = clone $this;
185  $collectableEntity->isClone = true;
186 
187  /** @var Internals\Fields $fields */
188  if ($fields = $this->fields)
189  {
190  $collectableEntity->fields = $fields->createClone($cloneEntity);
191  }
192 
193  if (!$cloneEntity->contains($this))
194  {
195  $cloneEntity[$this] = $collectableEntity;
196  }
197 
198  if ($collection = $this->getCollection())
199  {
200  if (!$cloneEntity->contains($collection))
201  {
202  $cloneEntity[$collection] = $collection->createClone($cloneEntity);
203  }
204 
205  if ($cloneEntity->contains($collection))
206  {
207  $collectableEntity->collection = $cloneEntity[$collection];
208  }
209  }
210 
211  return $collectableEntity;
212  }

◆ delete()

delete ( )
Исключения
Main

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

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

56  {
57  $collection = $this->getCollection();
58  if (!$collection)
59  {
60  throw new Main\ObjectNotFoundException('Entity "CollectableEntity" not found');
61  }
62 
63  /** @var Result $r */
64  $collection->deleteItem($this->getInternalIndex());
65 
66  return new Result();
67  }

◆ doFinalAction()

doFinalAction (   $hasMeaningfulField = false)

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

126  {
127  $parent = $this->getCollection();
128  if ($parent == null)
129  {
130  return false;
131  }
132 
133  return $parent->doFinalAction($hasMeaningfulField);
134  }

◆ getCollection()

getCollection ( )
Возвращает
EntityCollection

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

47  {
48  return $this->collection;
49  }

◆ getInternalIndex()

getInternalIndex ( )
Возвращает
null|int

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

84  {
85  return $this->internalIndex;
86  }

◆ hasMeaningfulField()

hasMeaningfulField ( )
Возвращает
bool

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

117  {
118  $parent = $this->getCollection();
119  if ($parent == null)
120  return false;
121 
122  return $parent->hasMeaningfulField();
123  }

◆ isClone()

isClone ( )
Возвращает
bool

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

167  {
168  return $this->isClone;
169  }

◆ isMathActionOnly()

isMathActionOnly ( )
Возвращает
bool

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

155  {
156  $parent = $this->getCollection();
157  if ($parent == null)
158  return false;
159 
160  return $parent->isMathActionOnly();
161  }

◆ isStartField()

isStartField (   $isMeaningfulField = false)
Аргументы
bool$isMeaningfulField
Возвращает
bool

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

93  {
94  $parent = $this->getCollection();
95  if ($parent == null)
96  return false;
97 
98  return $parent->isStartField($isMeaningfulField);
99  }

◆ onFieldModify()

onFieldModify (   $name,
  $oldValue,
  $value 
)
protected
Аргументы
string$name
mixed$oldValue
mixed$value
Возвращает
Result

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

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

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

◆ setCollection()

setCollection ( EntityCollection  $collection)
Аргументы
EntityCollection$collection

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

39  {
40  $this->collection = $collection;
41  }

◆ setInternalIndex()

setInternalIndex (   $index)

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

76  {
77  $this->internalIndex = $index;
78  }

◆ setMathActionOnly()

setMathActionOnly (   $value = false)
Аргументы
bool | false$value
Возвращает
bool

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

141  {
142  $parent = $this->getCollection();
143  if ($parent == null)
144  {
145  return false;
146  }
147 
148  return $parent->setMathActionOnly($value);
149  }

Поля

◆ $collection

$collection
protected

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

◆ $internalIndex

$internalIndex = null
protected

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

◆ $isClone

$isClone = false
protected

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


Объявления и описания членов класса находятся в файле:
Bitrix\Sale\Internals\CollectableEntity\getInternalIndex
getInternalIndex()
Definition: collectableentity.php:83
Bitrix\Main\ORM\Entity\$fields
$fields
Definition: main/lib/orm/entity.php:44
Bitrix\Sale\Internals\CollectableEntity\getCollection
getCollection()
Definition: collectableentity.php:46
Bitrix\Sale\Internals\CollectableEntity\isClone
isClone()
Definition: collectableentity.php:166
Bitrix\Sale\Internals\CollectableEntity\$internalIndex
$internalIndex
Definition: collectableentity.php:18
Bitrix\Sale\Internals\CollectableEntity\$isClone
$isClone
Definition: collectableentity.php:20
Bitrix\Sale\Internals\CollectableEntity\$collection
$collection
Definition: collectableentity.php:16
Bitrix\Main\ORM\Entity\$name
$name
Definition: main/lib/orm/entity.php:32