Bitrix API

UrlItem implements RestEntity

Table of Contents

Interfaces

RestEntity

Methods

__construct()  : mixed
getByMessage()  : self|null
getFirstUrlFromText()  : string|null
getId()  : int|null
Returns the id of the entity
getMetadata()  : array<string|int, mixed>
getRestEntityName()  : string
Returns the name of the entity that will be used in the rest response
getRichData()  : RichData
getUrl()  : string
getUrlAttach()  : CIMMessageParamAttach|null
getUrlsFromText()  : array<string|int, string>
initByMetadata()  : self
initByPreviewUrlId()  : self|null
isDynamicUrl()  : bool
isRich()  : bool
isStaticUrl()  : bool
setMetadata()  : self
setRichData()  : self
setUrl()  : self
setUrlAttach()  : self
toRestFormat()  : array<string|int, mixed>|null
Returns an array in JSON like format to return the entity as a rest response.

Methods

__construct()

public __construct([string|null $url = null ][, bool $withFetchMetadata = true ]) : mixed
Parameters
$url : string|null = null
$withFetchMetadata : bool = true

getByMessage()

public static getByMessage(Message $message) : self|null
Parameters
$message : Message
Return values
self|null

getFirstUrlFromText()

public static getFirstUrlFromText(string|null $text) : string|null
Parameters
$text : string|null
Return values
string|null

getId()

Returns the id of the entity

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

getMetadata()

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

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

getUrlAttach()

public getUrlAttach() : CIMMessageParamAttach|null
Return values
CIMMessageParamAttach|null

getUrlsFromText()

public static getUrlsFromText(string|null $text) : array<string|int, string>
Parameters
$text : string|null
Return values
array<string|int, string>

initByMetadata()

public static initByMetadata(array<string|int, mixed> $metadata) : self
Parameters
$metadata : array<string|int, mixed>
Return values
self

initByPreviewUrlId()

public static initByPreviewUrlId(int $previewUrlId[, bool $withHtml = true ]) : self|null
Parameters
$previewUrlId : int
$withHtml : bool = true
Return values
self|null

isDynamicUrl()

public isDynamicUrl() : bool
Return values
bool

isRich()

public isRich() : bool
Return values
bool

isStaticUrl()

public isStaticUrl() : bool
Return values
bool

setMetadata()

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

setRichData()

public setRichData(RichData|null $richData) : self
Parameters
$richData : RichData|null
Return values
self

setUrl()

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

setUrlAttach()

public setUrlAttach(CIMMessageParamAttach|null $urlAttach) : self
Parameters
$urlAttach : CIMMessageParamAttach|null
Return values
self

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 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results