Класс RelationCollection

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

Открытые члены
	toRestFormat (array $option=[])
	getPopupData (array $excludedList=[])
	getByUserId (int $userId, int $chatId)
	filterActive ()
	filterNotifySubscribed ()
	hasUser (int $userId, int $chatId)
	getUserIds ()
	getUsers ()
	onAfterRelationDelete (int $chatId, int $userId)
Открытые члены унаследованные от Registry
	unsetByKeys (array $keys)
	mergeRegistry (Registry $registry)
	filter (callable $predicate)
	getAny ()
	isEmpty ()
Открытые члены унаследованные от 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=[], ?int $limit=null, ?Context $context=null, array $select=self::COMMON_FIELDS)
static	getRestEntityName ()
static	createFake (array $userIds, Chat $chat)
static	getStartId (int $userId, int $chatId)
Открытые статические члены унаследованные от Collection
static	wakeUp ($rows)

Поля данных
const	COMMON_FIELDS
Поля данных унаследованные от Collection
const	OBJECT_ADDED = 1
const	OBJECT_REMOVED = 2

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

Защищенные данные
array	$relationsByUserId = []
self	$activeOnly = null
self	$notifyOnly = null
Защищенные данные унаследованные от Collection
	$_entity
	$_objectClass
	$_objects = []
	$_isFilled = false
	$_isSinglePrimary
	$_objectsChanges
	$_objectsRemoved
	$_iterableObjects

Статические защищенные данные
static array	$startIdStaticCache = []

Дополнительные унаследованные члены
Статические открытые данные унаследованные от Collection
static	$dataClass
Защищенные члены унаследованные от Collection
	sysGetList ($fieldName)
	sysGetPrimaryKey (EntityObject $object)
	sysSerializePrimaryKey ($primary)

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

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

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

Методы

createFake()

createFake ( array $userIds, Chat $chat )

static

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

filterActive()

filterActive

(

)

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

filterNotifySubscribed()

filterNotifySubscribed

(

)

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

find()

find ( array $filter, array $order = [], ?int $limit = null, ?Context $context = null, array $select = self::COMMON_FIELDS )

static

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

getByUserId()

getByUserId	(	int	$userId,
		int	$chatId )

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

getCollectionElementClass()

getCollectionElementClass ( )

static

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

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.

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

getRestEntityName()

getRestEntityName ( )

static

Returns the name of the entity that will be used in the rest response

Возвращает

string

Замещает RestConvertible.

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

getStartId()

getStartId ( int $userId, int $chatId )

static

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

getUserIds()

getUserIds

(

)

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

getUsers()

getUsers

(

)

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

hasUser()

hasUser	(	int	$userId,
		int	$chatId )

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

onAfterRelationDelete()

onAfterRelationDelete	(	int	$chatId,
		int	$userId )

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

processFilters()

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

staticprotected

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

toRestFormat()

toRestFormat

(

array

$option = []

)

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

Аргументы

array

$option

Возвращает

array|null

Замещает RestConvertible.

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

Поля

$activeOnly

self $activeOnly = null

protected

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

$notifyOnly

self $notifyOnly = null

protected

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

$relationsByUserId

array $relationsByUserId = []

protected

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

$startIdStaticCache

array $startIdStaticCache = []

staticprotected

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

COMMON_FIELDS

const COMMON_FIELDS

Инициализатор

= [
        'ID',
        'MESSAGE_TYPE',
        'CHAT_ID',
        'USER_ID',
        'START_ID',
        'LAST_FILE_ID',
        'LAST_ID',
        'LAST_SEND_MESSAGE_ID',
        'UNREAD_ID',
        'NOTIFY_BLOCK',
        'MANAGER',
        'REASON',
        'IS_HIDDEN',
    ]

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

---

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

• C:/bitrix/modules/im/lib/V2/RelationCollection.php