Bitrix API

UrlItem extends BaseLinkItem uses MigrationStatusCheckerTrait

Table of Contents

Methods

__construct()  : mixed
delete()  : Result
Drops object from database.
fill()  : static
Fills object's fields with provided values.
fillActual()  : self
getAuthorId()  : int
getChatId()  : int
getDataClass()  : string
Returns ORM tablet class name.
getDataEntity()  : EntityObject
getDateCreate()  : DateTime
getEntity()  : Entity|UrlItem
getEntityClassName()  : string|RestEntity
Returns the class name of the entity that the link contains.
getEntityId()  : int|null
Returns the ID of the entity that the link contains.
getId()  : int|null
getMessageId()  : int|null
getPopupData()  : PopupData
Returns the data to be raised to the top of the REST response. Works on the principle of the composite pattern.
getPrimaryId()  : int|null
getRegistry()  : Registry|null
Return link of the object's registry.
getRestEntityName()  : string
Returns the name of the entity that will be used in the rest response
getUrl()  : string
isChanged()  : bool
Tells true if object has been changed.
isDeleted()  : bool
Tells true if object marked to drop.
linkEntityToMessage()  : static
load()  : Result
markChanged()  : static
Marks object changed.
markDrop()  : static
Marks object to drop on save.
offsetExists()  : bool
offsetGet()  : mixed
offsetSet()  : void
offsetUnset()  : void
onAfterOrmUpdate()  : self
prepareFields()  : Result
save()  : Result
Saves object state into database.
setAuthorId()  : BaseLinkItem
setChatId()  : BaseLinkItem
setDateCreate()  : BaseLinkItem
setEntity()  : static
setEntityId()  : BaseLinkItem
setId()  : BaseLinkItem
setMessageId()  : BaseLinkItem
setMessageInfo()  : static
Associates the entity with the passed message by filling in the messageId, chatId and authorId
setPrimaryId()  : self
setRegistry()  : self
setUrl()  : self
toArray()  : array<string|int, mixed>
Returns object state as array.
toRestFormat()  : array<string|int, mixed>|null
Returns an array in JSON like format to return the entity as a rest response.
toRestFormatIdOnly()  : array<string|int, mixed>
Returns an array containing the id of the link and the id of the linked entity, or an array of such arrays

Methods

__construct()

public __construct([int|array<string|int, mixed>|EO_LinkUrl|null $source = null ]) : mixed
Parameters
$source : int|array<string|int, mixed>|EO_LinkUrl|null = null

fill()

Fills object's fields with provided values.

public fill(array<string|int, mixed> $source) : static
Parameters
$source : array<string|int, mixed>
Return values
static

fillActual()

public fillActual(array<string|int, mixed> $fieldsToFill) : self
Parameters
$fieldsToFill : array<string|int, mixed>
Return values
self

getAuthorId()

public getAuthorId() : int
Return values
int

getDataClass()

Returns ORM tablet class name.

public static getDataClass() : string
Return values
string

getEntityClassName()

Returns the class name of the entity that the link contains.

public static getEntityClassName() : string|RestEntity
Return values
string|RestEntity

getEntityId()

Returns the ID of the entity that the link contains.

public getEntityId() : int|null
Return values
int|null

getId()

public getId() : int|null
Return values
int|null

getMessageId()

public getMessageId() : int|null
Return values
int|null

getPopupData()

Returns the data to be raised to the top of the REST response. Works on the principle of the composite pattern.

public getPopupData([array<string|int, mixed> $excludedList = [] ]) : PopupData
Parameters
$excludedList : array<string|int, mixed> = []
Return values
PopupData

getPrimaryId()

public getPrimaryId() : int|null
Return values
int|null

getRestEntityName()

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

public static getRestEntityName() : string
Return values
string

getUrl()

public getUrl() : string
Return values
string

markChanged()

Marks object changed.

public markChanged([bool|null $state = null ]) : static
Parameters
$state : bool|null = null
Return values
static

offsetSet()

public offsetSet(mixed $offset, mixed $value) : void
Parameters
$offset : mixed
$value : mixed

onAfterOrmUpdate()

public onAfterOrmUpdate(array<string|int, mixed> $fields) : self
Parameters
$fields : array<string|int, mixed>
Return values
self

setMessageInfo()

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

public setMessageInfo(Message $message) : static
Parameters
$message : Message
Return values
static

setPrimaryId()

public setPrimaryId(int $primaryId) : self
Parameters
$primaryId : int
Return values
self

setUrl()

public setUrl(string $url) : self
Parameters
$url : string
Return values
self

toArray()

Returns object state as array.

public toArray() : array<string|int, mixed>
Return values
array<string|int, mixed>

toRestFormat()

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

public toRestFormat([array<string|int, mixed> $option = [] ]) : array<string|int, mixed>|null
Parameters
$option : array<string|int, mixed> = []
Return values
array<string|int, mixed>|null

toRestFormatIdOnly()

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

public toRestFormatIdOnly() : array<string|int, mixed>
Return values
array<string|int, mixed> 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results