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

Открытые члены
	toRestFormatIdOnly ()
	getPopupData (array $excludedList=[])
	getId ()
	setId (int $id)
	getPrimaryId ()
	setPrimaryId (int $primaryId)
	getAuthorId ()
	setAuthorId (int $authorId)
	getMessageId ()
	setMessageId (?int $messageId)
	getChatId ()
	setChatId (int $chatId)
	getEntityId ()
	setEntityId (?int $entityId)
	getDateCreate ()
	setDateCreate (DateTime $dateCreate)
	getEntity ()
	setEntity (RestEntity $entity)
	setMessageInfo (Message $message)
	toRestFormat (array $option=[])
Открытые члены унаследованные от ActiveRecord
	load ($source)
	prepareFields ()
	getDataEntity ()
	save ()
	delete ()
	markChanged ()
	isChanged ()
	markDrop ()
	isDeleted ()
	fill (array $source)
	toArray (bool $recursive)
Открытые члены унаследованные от RegistryEntry
	setRegistry (Registry $registry)
	getRegistry ()

Открытые статические члены
static	getEntityClassName ()
static	linkEntityToMessage (RestEntity $entity, Message $message)
Открытые статические члены унаследованные от RestConvertible
static	getRestEntityName ()
Открытые статические члены унаследованные от ActiveRecord
static	getDataClass ()

Защищенные статические члены
static	getEntityIdFieldName ()
static	mirrorDataEntityFields ()

Защищенные данные
int	$id = null
int	$authorId
int	$messageId = null
int	$chatId
int	$entityId
DateTime	$dateCreate
RestEntity	$entity

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

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

Методы

◆ getAuthorId()

getAuthorId ( )

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

◆ getChatId()

getChatId ( )

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

◆ getDateCreate()

getDateCreate ( )

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

◆ getEntity()

getEntity ( )

Возвращает: RestEntity

Переопределяется в CalendarItem, FileItem, TaskItem и UrlItem.

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

◆ getEntityClassName()

getEntityClassName ( )

staticabstract

Возвращает: string|RestEntity

Замещает LinkItem.

Переопределяется в CalendarItem, FavoriteItem, FileItem, PinItem, ReminderItem, TaskItem и UrlItem.

◆ getEntityId()

getEntityId ( )

Returns the ID of the entity that the link contains.

Возвращает: int|null

Замещает LinkItem.

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

◆ getEntityIdFieldName()

getEntityIdFieldName ( )

staticabstractprotected

Переопределяется в CalendarItem, FavoriteItem, FileItem, PinItem, ReminderItem, TaskItem и UrlItem.

◆ getId()

getId ( )

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

◆ getMessageId()

getMessageId ( )

Переопределяется в FavoriteItem, PinItem и ReminderItem.

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

◆ 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.

Переопределяется в FavoriteItem, FileItem, PinItem и ReminderItem.

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

◆ getPrimaryId()

getPrimaryId ( )

Возвращает: int|null

Замещает ActiveRecord.

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

◆ linkEntityToMessage()

linkEntityToMessage	(	RestEntity	$entity,
		Message	$message )

static

Аргументы

RestEntity	$entity
Message	$message

Возвращает: static

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

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

◆ mirrorDataEntityFields()

mirrorDataEntityFields ( )

staticprotected

См. также: BaseLinkItem::setId; BaseLinkItem::getId; BaseLinkItem::setMessageId; BaseLinkItem::getMessageId; BaseLinkItem::setChatId; BaseLinkItem::getChatId; BaseLinkItem::setDateCreate; BaseLinkItem::getDateCreate; BaseLinkItem::setAuthorId; BaseLinkItem::getAuthorId; BaseLinkItem::setEntityId; BaseLinkItem::getEntityId

Переопределяется в CalendarItem, FileItem, ReminderItem и UrlItem.

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

◆ setAuthorId()

setAuthorId ( int $authorId )

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

◆ setChatId()

setChatId ( int $chatId )

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

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

◆ setDateCreate()

setDateCreate ( DateTime $dateCreate )

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

◆ setEntity()

setEntity ( RestEntity $entity )

Аргументы

RestEntity $entity

Возвращает: static

Переопределяется в CalendarItem, FileItem и UrlItem.

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

◆ setEntityId()

setEntityId ( ?int $entityId )

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

◆ setId()

setId ( int $id )

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

◆ setMessageId()

setMessageId ( ?int $messageId )

Переопределяется в FavoriteItem, PinItem и ReminderItem.

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

◆ setMessageInfo()

setMessageInfo ( Message $message )

Associates the entity with the passed message by filling in the messageId, chatId and authorId

Аргументы

Message $message

Возвращает: static

Замещает Link.

Переопределяется в FavoriteItem, PinItem и ReminderItem.

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

◆ setPrimaryId()

setPrimaryId ( int $primaryId )

Аргументы

int $primaryId

Возвращает: self

Замещает ActiveRecord.

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

◆ toRestFormat()

toRestFormat ( array $option = [] )

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

Аргументы

array $option

Возвращает: array|null

Замещает RestConvertible.

Переопределяется в FavoriteItem, FileItem, PinItem и ReminderItem.

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

◆ toRestFormatIdOnly()

toRestFormatIdOnly ( )

Returns an array containing the id of the link and the id of the linked entity, or an array of such arrays

Возвращает: array

Замещает LinkRestConvertible.

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

Поля

◆ $authorId

int $authorId

protected

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

◆ $chatId

int $chatId

protected

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

◆ $dateCreate

DateTime $dateCreate

protected

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

◆ $entity

RestEntity $entity

protected

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

◆ $entityId

int $entityId

protected

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

◆ $id

int $id = null

protected

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

◆ $messageId

int $messageId = null

protected

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

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

C:/bitrix/modules/im/lib/V2/Link/BaseLinkItem.php

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

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

Защищенные статические члены

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

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

Методы

◆ getAuthorId()

◆ getChatId()

◆ getDateCreate()

◆ getEntity()

◆ getEntityClassName()

◆ getEntityId()

◆ getEntityIdFieldName()

◆ getId()

◆ getMessageId()

◆ getPopupData()

◆ getPrimaryId()

◆ linkEntityToMessage()

◆ mirrorDataEntityFields()

◆ setAuthorId()

◆ setChatId()

◆ setDateCreate()

◆ setEntity()

◆ setEntityId()

◆ setId()

◆ setMessageId()

◆ setMessageInfo()

◆ setPrimaryId()

◆ toRestFormat()

◆ toRestFormatIdOnly()

Поля

◆ $authorId

◆ $chatId

◆ $dateCreate

◆ $entity

◆ $entityId

◆ $id

◆ $messageId