Bitrix API

Helper

Table of Contents

Constants

ACTION  = 'action'
ACTION_CANCEL  = '?' . self::ACTION . '=' . self::CANCEL
ACTION_CONFERENCE  = '?' . self::ACTION . '=' . self::CONFERENCE
ACTION_ICS  = '?' . self::ACTION . '=' . self::ICS
ACTION_OPENED  = '?' . self::ACTION . '=' . self::OPENED
CANCEL  = 'cancel'
CONFERENCE  = 'videoconference'
ICS  = 'ics'
OPENED  = 'opened'
OWNER_CREATED  = 'ownerCreated'

Methods

createSharingJointLinkExpireDate()  : DateTime|null
returns the expiration date of sharing multi link
createSharingLinkExpireDate()  : DateTime|null
returns the expiration date of sharing link according to the date of need and the type of link
disableOptionPayAttentionToNewSharingFeature()  : void
disabling sharing tour in calendar for user
formatDate()  : string
examples: DAY_MONTH_FORMAT "December 31" SHORT_TIME_FORMAT "2:05 pm"
formatDateShort()  : string
example: FORMAT_DATE "12/31/2019"
formatDateWithoutTime()  : string
examples: DAY_MONTH_FORMAT "December 31"
formatTimeInterval()  : string
formatTimezone()  : string
getBitrix24Link()  : string|null
getEmailAbuseLink()  : string|null
getEventTimestampUTC()  : int
getGroupOwnerInfo()  : array<string|int, mixed>
getLinkOwnerInfo()  : array<string|int, mixed>
getOwnerInfo()  : array<string|int, mixed>
getPageAbuseLink()  : string|null
getPersonFullNameLoc()  : string
getShortUrl()  : string
generates short url
getUserDateTimestamp()  : int
isMailFeatureEnabled()  : bool
returns true if we can send calendar sharing messages using email, false otherwise
isPhoneFeatureEnabled()  : bool
returns true if we can send calendar sharing messages using phone number, false otherwise
payAttentionToNewSharingFeature()  : string|null
setSiteLanguage()  : void

Constants

ACTION

public mixed ACTION = 'action'

ACTION_CANCEL

public mixed ACTION_CANCEL = '?' . self::ACTION . '=' . self::CANCEL

ACTION_CONFERENCE

public mixed ACTION_CONFERENCE = '?' . self::ACTION . '=' . self::CONFERENCE

ACTION_ICS

public mixed ACTION_ICS = '?' . self::ACTION . '=' . self::ICS

ACTION_OPENED

public mixed ACTION_OPENED = '?' . self::ACTION . '=' . self::OPENED

CANCEL

public mixed CANCEL = 'cancel'

CONFERENCE

public mixed CONFERENCE = 'videoconference'

OPENED

public mixed OPENED = 'opened'

OWNER_CREATED

public mixed OWNER_CREATED = 'ownerCreated'

Methods

createSharingJointLinkExpireDate()

returns the expiration date of sharing multi link

public static createSharingJointLinkExpireDate(DateTime|null $dateTime) : DateTime|null
Parameters
$dateTime : DateTime|null
Return values
DateTime|null

createSharingLinkExpireDate()

returns the expiration date of sharing link according to the date of need and the type of link

public static createSharingLinkExpireDate(DateTime|null $dateTime, string $linkType) : DateTime|null
Parameters
$dateTime : DateTime|null
$linkType : string
Return values
DateTime|null

disableOptionPayAttentionToNewSharingFeature()

disabling sharing tour in calendar for user

public static disableOptionPayAttentionToNewSharingFeature() : void

formatDate()

examples: DAY_MONTH_FORMAT "December 31" SHORT_TIME_FORMAT "2:05 pm"

public static formatDate(Date $date) : string
Parameters
$date : Date
Return values
string

formatDateShort()

example: FORMAT_DATE "12/31/2019"

public static formatDateShort(Date $date) : string
Parameters
$date : Date
Return values
string

formatDateWithoutTime()

examples: DAY_MONTH_FORMAT "December 31"

public static formatDateWithoutTime(Date $date) : string
Parameters
$date : Date
Return values
string

formatTimeInterval()

public static formatTimeInterval(Date $from, Date $to, bool $isFullDay) : string
Parameters
$from : Date
$to : Date
$isFullDay : bool
Return values
string

formatTimezone()

public static formatTimezone(DateTimeZone $timezone) : string
Parameters
$timezone : DateTimeZone
Tags
throws
Exception
Return values
string

getBitrix24Link()

public static getBitrix24Link() : string|null
Return values
string|null

getEmailAbuseLink()

public static getEmailAbuseLink(int $ownerId, string $calendarLink) : string|null
Parameters
$ownerId : int
$calendarLink : string
Return values
string|null

getEventTimestampUTC()

public static getEventTimestampUTC(DateTime $date[, string|null $eventTimezone = null ]) : int
Parameters
$date : DateTime
$eventTimezone : string|null = null
Return values
int

getGroupOwnerInfo()

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

getLinkOwnerInfo()

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

getOwnerInfo()

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

getPageAbuseLink()

public static getPageAbuseLink(int $ownerId, string $calendarLink) : string|null
Parameters
$ownerId : int
$calendarLink : string
Return values
string|null

getPersonFullNameLoc()

public static getPersonFullNameLoc(string $name, string $lastName) : string
Parameters
$name : string
$lastName : string
Return values
string

getShortUrl()

generates short url

public static getShortUrl(string $url) : string
Parameters
$url : string
Return values
string

getUserDateTimestamp()

public static getUserDateTimestamp(Date $date) : int
Parameters
$date : Date
Return values
int

isMailFeatureEnabled()

returns true if we can send calendar sharing messages using email, false otherwise

public static isMailFeatureEnabled() : bool
Tags
throws
LoaderException
Return values
bool

isPhoneFeatureEnabled()

returns true if we can send calendar sharing messages using phone number, false otherwise

public static isPhoneFeatureEnabled() : bool
Return values
bool

payAttentionToNewSharingFeature()

public static payAttentionToNewSharingFeature() : string|null
Return values
string|null

setSiteLanguage()

public static setSiteLanguage() : void 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results