Bitrix-D7 22.2
Загрузка...
Поиск...
Не найдено
Класс EntityCollection
+ Граф наследования:EntityCollection:

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

 onItemModify (CollectableEntity $item, $name=null, $oldValue=null, $value=null)
 
 getItemById ($id)
 
 isStartField ($isMeaningfulField=false)
 
 clearStartField ()
 
 hasMeaningfulField ()
 
 doFinalAction ($hasMeaningfulField=false)
 
 isMathActionOnly ()
 
 setMathActionOnly ($value=false)
 
 verify ()
 
 isClone ()
 
 isAnyItemDeleted ()
 
 isAnyItemAdded ()
 
 clearChanged ()
 
 getIterator ()
 
 offsetExists ($offset)
 
 offsetGet ($offset)
 
 offsetSet ($offset, $value)
 
 offsetUnset ($offset)
 
 count ()
 
 current ()
 
 next ()
 
 key ()
 
 valid ()
 
 rewind ()
 
 isEmpty ()
 
 toArray ()
 

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

static getRegistryType ()
 

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

 __construct ()
 
 createIndex ()
 
 getDeletableItems ()
 
 getEntityParent ()
 
 setAnyItemDeleted ($value)
 
 setAnyItemAdded ($value)
 

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

 $isClone = false
 
 $anyItemDeleted = false
 
 $anyItemAdded = false
 
 $collection = array()
 

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

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

Конструктор(ы)

◆ __construct()

__construct ( )
protected

EntityCollection constructor.

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

24{}

Методы

◆ clearChanged()

clearChanged ( )

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

407 {
408 if (!empty($this->collection))
409 {
410 foreach ($this->collection as $entityItem)
411 {
412 if ($entityItem instanceof Entity)
413 {
414 $entityItem->clearChanged();
415 }
416 }
417 }
418 }

◆ clearStartField()

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

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

262 {
263 $parent = $this->getEntityParent();
264 if ($parent === null)
265 {
266 return false;
267 }
268
269 return $parent->clearStartField();
270 }

◆ count()

count ( )
inherited

Count elements of an object

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

76 {
77 return count($this->collection);
78 }

◆ createIndex()

createIndex ( )
protected
Возвращает
int

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

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

115 {
116 $this->index++;
117 return $this->index;
118 }

◆ current()

current ( )
inherited

Return the current element

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

84 {
85 return current($this->collection);
86 }

◆ doFinalAction()

doFinalAction (   $hasMeaningfulField = false)
Аргументы
bool$hasMeaningfulField
Возвращает
Sale\Result

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

291 {
292 $parent = $this->getEntityParent();
293 if ($parent === null)
294 {
295 return new Sale\Result();
296 }
297
298 return $parent->doFinalAction($hasMeaningfulField);
299 }

◆ getDeletableItems()

getDeletableItems ( )
protected
Возвращает
array

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

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

◆ getEntityParent()

◆ getItemById()

getItemById (   $id)
Аргументы
$id
Возвращает
CollectableEntity|bool
Исключения
Main

ArgumentNullException

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

169 {
170 if (intval($id) <= 0)
171 {
172 throw new Main\ArgumentNullException('id');
173 }
174
175 $index = $this->getIndexById($id);
176 if ($index === null)
177 {
178 return null;
179 }
180
181 if (isset($this->collection[$index]))
182 {
183 return $this->collection[$index];
184 }
185
186 return null;
187 }

◆ getIterator()

getIterator ( )
inherited
Возвращает
\ArrayIterator

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

23 {
24 return new \ArrayIterator($this->collection);
25 }

◆ getRegistryType()

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

NotImplementedException

Возвращает
string

Переопределяется в Basket, BasketPropertiesCollection, BundleCollection, EntityPropertyValueCollection, PayableItemCollection, PaymentCollection, ReserveQuantityCollection, ShipmentCollection, ShipmentItemCollection, ShipmentItemStoreCollection и TradeBindingCollection.

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

45 {
46 throw new Main\NotImplementedException();
47 }

◆ hasMeaningfulField()

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

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

276 {
277 $parent = $this->getEntityParent();
278 if ($parent === null)
279 {
280 return false;
281 }
282
283 return $parent->hasMeaningfulField();
284 }

◆ isAnyItemAdded()

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

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

◆ isAnyItemDeleted()

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

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

◆ isClone()

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

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

◆ isEmpty()

isEmpty ( )
inherited

Checks if collection is empty.

Возвращает
bool

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

127 {
128 return empty($this->collection);
129 }

◆ isMathActionOnly()

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

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

305 {
306 $parent = $this->getEntityParent();
307 if ($parent === null)
308 {
309 return false;
310 }
311
312 return $parent->isMathActionOnly();
313 }

◆ isStartField()

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

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

248 {
249 $parent = $this->getEntityParent();
250 if ($parent === null)
251 {
252 return false;
253 }
254
255 return $parent->isStartField($isMeaningfulField);
256 }

◆ key()

key ( )
inherited

Return the key of the current element

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

100 {
101 return key($this->collection);
102 }

◆ next()

next ( )
inherited

Move forward to next element

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

92 {
93 return next($this->collection);
94 }

◆ offsetExists()

offsetExists (   $offset)
inherited

Whether a offset exists

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

32 {
33 return isset($this->collection[$offset]) || array_key_exists($offset, $this->collection);
34 }

◆ offsetGet()

offsetGet (   $offset)
inherited

Offset to retrieve

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

40 {
41 if (isset($this->collection[$offset]) || array_key_exists($offset, $this->collection))
42 {
43 return $this->collection[$offset];
44 }
45
46 return null;
47 }

◆ offsetSet()

offsetSet (   $offset,
  $value 
)
inherited

Offset to set

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

53 {
54 if($offset === null)
55 {
56 $this->collection[] = $value;
57 }
58 else
59 {
60 $this->collection[$offset] = $value;
61 }
62 }

◆ offsetUnset()

offsetUnset (   $offset)
inherited

Offset to unset

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

68 {
69 unset($this->collection[$offset]);
70 }

◆ onItemModify()

onItemModify ( CollectableEntity  $item,
  $name = null,
  $oldValue = null,
  $value = null 
)

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

36 {
37 return new Sale\Result();
38 }

◆ rewind()

rewind ( )
inherited

Rewind the Iterator to the first element

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

117 {
118 return reset($this->collection);
119 }

◆ setAnyItemAdded()

setAnyItemAdded (   $value)
protected
Аргументы
$value
Возвращает
bool

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

399 {
400 return $this->anyItemAdded = ($value === true);
401 }

◆ setAnyItemDeleted()

setAnyItemDeleted (   $value)
protected
Аргументы
$value
Возвращает
bool

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

381 {
382 return $this->anyItemDeleted = ($value === true);
383 }

◆ setMathActionOnly()

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

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

320 {
321 $parent = $this->getEntityParent();
322 if ($parent == null)
323 {
324 return false;
325 }
326
327 return $parent->setMathActionOnly($value);
328 }

◆ toArray()

toArray ( )
inherited

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

132 {
133 $result = [];
134
135 foreach ($this->collection as $entity)
136 {
137 $result[] = $entity->toArray();
138 }
139
140 return $result;
141 }

◆ valid()

valid ( )
inherited

Checks if current position is valid

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

108 {
109 $key = $this->key();
110 return $key !== null;
111 }

◆ verify()

verify ( )
Возвращает
Sale\Result

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

354 {
355 return new Sale\Result();
356 }

Поля

◆ $anyItemAdded

$anyItemAdded = false
protected

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

◆ $anyItemDeleted

$anyItemDeleted = false
protected

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

◆ $collection

CollectableEntity[] $collection = array()
protectedinherited

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

◆ $isClone

$isClone = false
protected

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


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