Класс FavoriteCollection

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

Открытые члены
	getMessageCollection ()
	getPopupData (array $excludedList=[])
	toRestFormat (array $option=[])
Открытые члены унаследованные от BaseLinkCollection
	filterByDate (DateTime $date)
	getRelatedChatId ()
	toRestFormatIdOnly ()
	setMessageInfo (Message $message)
	getEntityIds ()
Открытые члены унаследованные от Collection
	__construct (Entity $entity=null)
	__clone ()
	add (EntityObject $object)
	has (EntityObject $object)
	hasByPrimary ($primary)
	getByPrimary ($primary)
	getAll ()
	remove (EntityObject $object)
	removeByPrimary ($primary)
	sysRemove ($srPrimary)
	fill ($fields=FieldTypeMask::ALL)
	collectValues (int $valuesType=Values::ALL, int $fieldsMask=FieldTypeMask::ALL, bool $recursive=false)
	__get ($name)
	__set ($name, $value)
	__call ($name, $arguments)
	sysAddActual (EntityObject $object)
	sysOnObjectPrimarySet ($object)
	sysIsFilled ()
	sysIsChanged ()
	sysGetChanges ()
	sysResetChanges ($rollback=false)
	sysReviseDeletedObjects ()
	sysSetFilled ($value=true)
	offsetSet ($offset, $value)
	offsetExists ($offset)
	offsetUnset ($offset)
	offsetGet ($offset)
	rewind ()
	current ()
	key ()
	next ()
	valid ()
	count ()
	merge (?self $collection)
	isEmpty ()

Открытые статические члены
static	getCollectionElementClass ()
static	find (array $filter=[], array $order=['ID'=> 'DESC'], ?int $limit=null, ?Context $context=null)
static	initByEntityCollection (EO_LinkFavorite_Collection $entityCollection)
static	getByMessage (Message $message)
static	getByMessages (MessageCollection $messages)
Открытые статические члены унаследованные от BaseLinkCollection
static	getRestEntityName ()
Открытые статические члены унаследованные от Collection
static	wakeUp ($rows)

Защищенные статические члены
static	processFilters (Query $query, array $filter, array $order)

Дополнительные унаследованные члены
Поля данных унаследованные от Collection
const	OBJECT_ADDED = 1
const	OBJECT_REMOVED = 2
Статические открытые данные унаследованные от Collection
static	$dataClass
Защищенные члены унаследованные от Collection
	sysGetList ($fieldName)
	sysGetPrimaryKey (EntityObject $object)
	sysSerializePrimaryKey ($primary)
Защищенные данные унаследованные от Collection
	$_entity
	$_objectClass
	$_objects = []
	$_isFilled = false
	$_isSinglePrimary
	$_objectsChanges
	$_objectsRemoved
	$_iterableObjects

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

<int,FavoriteItem> @method FavoriteItem offsetGet($key)

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

Методы

find()

find ( array $filter = [], array $order = ['ID' => 'DESC'], ?int $limit = null, ?Context $context = null )

static

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

getByMessage()

getByMessage ( Message $message )

static

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

getByMessages()

getByMessages ( MessageCollection $messages )

static

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

getCollectionElementClass()

getCollectionElementClass ( )

static

Возвращает

string|LinkItem

Переопределяет метод предка BaseLinkCollection.

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

getMessageCollection()

getMessageCollection

(

)

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

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

Переопределяет метод предка BaseLinkCollection.

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

initByEntityCollection()

initByEntityCollection ( EO_LinkFavorite_Collection $entityCollection )

static

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

processFilters()

processFilters ( Query $query, array $filter, array $order )

staticprotected

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

toRestFormat()

toRestFormat

(

array

$option = []

)

Returns an array in JSON like format to return the entity as a rest response.

Аргументы

array

$option

Возвращает

array|null

Переопределяет метод предка BaseLinkCollection.

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

---

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

• C:/bitrix/modules/im/lib/V2/Link/Favorite/FavoriteCollection.php