Bitrix API

Helper

Table of Contents

Constants

END_OF_TIME  = "01.01.2038"
ICAL_DATE_FORMAT  = 'Ymd'
ICAL_DATETIME_FORMAT  = 'Ymd\THis'
ICAL_DATETIME_FORMAT_SHORT  = 'Ymd\THis'
ICAL_DATETIME_FORMAT_UTC  = 'Ymd\THis\Z'

Methods

getAttendee()  : Attendee|null
getAttendeesByEventParentId()  : AttendeesCollection
getDateByParserProperty()  : Date|null
getDateObject()  : Date
getEventById()  : array<string|int, mixed>|null
getEventByUId()  : array<string|int, mixed>|null
getEventDescriptionById()  : string|null
getExternalUserByEmail()  : int|null
Returns id of the 'external' user by email. Creates user if it not exists.
getIcalDate()  : Date
getIcalDateTime()  : DateTime
getIcalDateTimeShort()  : DateTime
getIcalTemplateDate()  : string
getIcalTemplateRRule()  : string
getIndexUsersByIds()  : array<string|int, mixed>
getMailAttaches()  : AttachCollection
getServerName()  : false|string|null
getShortMonthName()  : string
getTimezoneObject()  : DateTimeZone
getUniqId()  : string
getUserById()  : array<string|int, mixed>|null
getUserIdByEmail()  : int|null

Constants

END_OF_TIME

public mixed END_OF_TIME = "01.01.2038"

ICAL_DATE_FORMAT

public mixed ICAL_DATE_FORMAT = 'Ymd'

ICAL_DATETIME_FORMAT

public mixed ICAL_DATETIME_FORMAT = 'Ymd\THis'

ICAL_DATETIME_FORMAT_SHORT

public mixed ICAL_DATETIME_FORMAT_SHORT = 'Ymd\THis'

ICAL_DATETIME_FORMAT_UTC

public mixed ICAL_DATETIME_FORMAT_UTC = 'Ymd\THis\Z'

Methods

getAttendee()

public static getAttendee(int $userId, int $eventParentId[, mixed $isRsvp = true ]) : Attendee|null
Parameters
$userId : int
$eventParentId : int
$isRsvp : mixed = true
Tags
throws
ObjectPropertyException
throws
ArgumentException
throws
SystemException
Return values
Attendee|null

getDateObject()

public static getDateObject([string|null $date = null ][, bool $fullDay = true ][, string $tz = 'UTC' ]) : Date
Parameters
$date : string|null = null
$fullDay : bool = true
$tz : string = 'UTC'
Tags
throws
ObjectException
Return values
Date

getEventById()

public static getEventById(int|null $eventId) : array<string|int, mixed>|null
Parameters
$eventId : int|null
Tags
throws
ObjectPropertyException
throws
SystemException
throws
ArgumentException
Return values
array<string|int, mixed>|null

getEventByUId()

public static getEventByUId(mixed $uid) : array<string|int, mixed>|null
Parameters
$uid : mixed
Tags
throws
ArgumentException
throws
ObjectPropertyException
throws
SystemException
Return values
array<string|int, mixed>|null

getEventDescriptionById()

public static getEventDescriptionById(int|null $eventId) : string|null
Parameters
$eventId : int|null
Tags
throws
ArgumentException
throws
ObjectPropertyException
throws
SystemException
Return values
string|null

getExternalUserByEmail()

Returns id of the 'external' user by email. Creates user if it not exists.

public static getExternalUserByEmail(array<string|int, mixed> $params, mixed &$errorText) : int|null
Parameters
$params : array<string|int, mixed>
  • incoming params: $params['EMAIL'] - (required) email of the user $params['NAME'] - user's name $params['LAST_NAME'] - user's last name
$errorText : mixed
Return values
int|null

getIcalDate()

public static getIcalDate([string|null $date = null ]) : Date
Parameters
$date : string|null = null
Tags
throws
ObjectException
Return values
Date

getIcalDateTime()

public static getIcalDateTime([string|null $dateTime = null ][, string|null $tz = null ]) : DateTime
Parameters
$dateTime : string|null = null
$tz : string|null = null
Tags
throws
ObjectException
Return values
DateTime

getIcalDateTimeShort()

public static getIcalDateTimeShort([string|null $dateTime = null ][, string $tz = 'UTC' ]) : DateTime
Parameters
$dateTime : string|null = null
$tz : string = 'UTC'
Tags
throws
ObjectException
Return values
DateTime

getIcalTemplateDate()

public static getIcalTemplateDate([array<string|int, mixed>|null $params = null ]) : string
Parameters
$params : array<string|int, mixed>|null = null
Tags
throws
ObjectException
Return values
string

getIcalTemplateRRule()

public static getIcalTemplateRRule([array<string|int, mixed>|null $rrule = null ][, array<string|int, mixed>|null $params = null ]) : string
Parameters
$rrule : array<string|int, mixed>|null = null
$params : array<string|int, mixed>|null = null
Return values
string

getIndexUsersByIds()

public static getIndexUsersByIds(array<string|int, mixed>|null $idList) : array<string|int, mixed>
Parameters
$idList : array<string|int, mixed>|null
Tags
throws
ArgumentException
throws
ObjectPropertyException
throws
SystemException
Return values
array<string|int, mixed>

getMailAttaches()

public static getMailAttaches(mixed $fields, mixed $userId, mixed $parentId[, false &$isChangeFiles = false ]) : AttachCollection
Parameters
$fields : mixed
$userId : mixed
$parentId : mixed
$isChangeFiles : false = false
Tags
throws
ArgumentException
throws
LoaderException
throws
NotImplementedException
Return values
AttachCollection

getServerName()

public static getServerName() : false|string|null
Return values
false|string|null

getShortMonthName()

public static getShortMonthName(Date|null $date) : string
Parameters
$date : Date|null
Return values
string

getTimezoneObject()

public static getTimezoneObject([string|null $tz = null ]) : DateTimeZone
Parameters
$tz : string|null = null
Return values
DateTimeZone

getUniqId()

public static getUniqId() : string
Return values
string

getUserById()

public static getUserById(int|null $id) : array<string|int, mixed>|null
Parameters
$id : int|null
Tags
throws
ArgumentException
throws
ObjectPropertyException
throws
SystemException
Return values
array<string|int, mixed>|null

getUserIdByEmail()

public static getUserIdByEmail(array<string|int, mixed> $userInfo) : int|null
Parameters
$userInfo : array<string|int, mixed>
Tags
throws
ArgumentException
throws
ObjectPropertyException
throws
SystemException
Return values
int|null 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results