Открытые члены | |
| getPopupData (array $excludedList=[]) | |
| getUnique () | |
| getIds () | |
| getById (int $id) | |
| toRestFormat (array $option=[]) | |
| offsetSet ($offset, $value) | |
| Открытые члены унаследованные от Registry | |
| unsetByKeys (array $keys) | |
| mergeRegistry (Registry $registry) | |
| filter (callable $predicate) | |
| getAny () | |
| isEmpty () | |
Открытые статические члены | |
| static | initByArray (array $entities) |
| Открытые статические члены унаследованные от RestConvertible | |
| static | getRestEntityName () |
Защищенные данные | |
| array | $entitiesWithId = [] |
Подробное описание
@template T <T>
См. определение в файле EntityCollection.php строка 16
Методы
◆ getById()
| getById | ( | int | $id | ) |
См. определение в файле EntityCollection.php строка 54
◆ getIds()
| getIds | ( | ) |
См. определение в файле EntityCollection.php строка 42
◆ getPopupData()
| getPopupData | ( | array | $excludedList = [] | ) |
Returns the data to be raised to the top of the REST response. Works on the principle of the composite pattern.
- См. также
- RestAdapter::toRestFormat()
- Аргументы
-
string[] $excludedList
- Возвращает
- PopupData
Замещает PopupDataAggregatable.
Переопределяется в FileCollection.
См. определение в файле EntityCollection.php строка 22
◆ getUnique()
| getUnique | ( | ) |
- Возвращает
- static
См. определение в файле EntityCollection.php строка 37
◆ initByArray()
|
static |
- Аргументы
-
RestEntity[] $entities
- Возвращает
- static
См. определение в файле EntityCollection.php строка 83
◆ offsetSet()
| offsetSet | ( | $offset, | |
| $value ) |
См. определение в файле EntityCollection.php строка 97
◆ toRestFormat()
| toRestFormat | ( | array | $option = [] | ) |
Returns an array in JSON like format to return the entity as a rest response.
- Аргументы
-
array $option
- Возвращает
- array|null
Замещает RestConvertible.
Переопределяется в UserCollection.
См. определение в файле EntityCollection.php строка 59
Поля
◆ $entitiesWithId
|
protected |
См. определение в файле EntityCollection.php строка 20
Объявления и описания членов класса находятся в файле:
- C:/bitrix/modules/im/lib/V2/Entity/EntityCollection.php
