Класс FavoriteItem

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

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

Открытые статические члены
static	getDataClass ()
static	getEntityClassName ()
static	getRestEntityName ()
static	initByEntity (EO_LinkFavorite $entity)
static	createFromMessage (Message $message, ?Context $context=null)
static	getByMessageAndUserId (Message $message, int $userId)
static	linkEntityToMessage (Entity $entity, Message $message)
Открытые статические члены унаследованные от BaseLinkItem
static	linkEntityToMessage (RestEntity $entity, Message $message)

Защищенные статические члены
static	getEntityIdFieldName ()
Защищенные статические члены унаследованные от BaseLinkItem
static	mirrorDataEntityFields ()

Дополнительные унаследованные члены
Защищенные данные унаследованные от BaseLinkItem
int	$id = null
int	$authorId
int	$messageId = null
int	$chatId
int	$entityId
DateTime	$dateCreate
RestEntity	$entity

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

@method Message getEntity()()

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

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

__construct()

__construct

(

$source = null

)

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

Методы

createFromMessage()

createFromMessage ( Message $message, ?Context $context = null )

static

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

getByMessageAndUserId()

getByMessageAndUserId ( Message $message, int $userId )

static

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

getDataClass()

getDataClass ( )

static

Returns ORM tablet class name.

Возвращает

string

Замещает ActiveRecord.

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

getEntityClassName()

getEntityClassName ( )

static

Возвращает

string|RestEntity

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

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

getEntityIdFieldName()

getEntityIdFieldName ( )

staticprotected

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

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

getMessageId()

getMessageId

(

)

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

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

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

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

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

getRestEntityName()

getRestEntityName ( )

static

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

Возвращает

string

Замещает RestConvertible.

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

initByEntity()

initByEntity ( EO_LinkFavorite $entity )

static

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

linkEntityToMessage()

linkEntityToMessage ( Entity $entity, Message $message )

static

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

setMessageId()

setMessageId

(

?int

$messageId

)

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

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

setMessageInfo()

setMessageInfo

(

Message

$message

)

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

Аргументы

Message

$message

Возвращает

static

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

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

toRestFormat()

toRestFormat

(

array

$option = []

)

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

Аргументы

array

$option

Возвращает

array|null

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

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

---

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

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