Bitrix API

UserAbsence

Table of Contents

Constants

CACHE_PATH  = '/bx/intranet/absence/'
CACHE_TTL  = 2678400

Properties

$defaultVacationTypes  : mixed

Methods

cleanCache()  : void
getActiveVacationTypes()  : mixed
getCurrentMonth()  : array<string|int, mixed>
getIblockId()  : int
getTypeCaption()  : string
getVacationTypes()  : array<string|int, mixed>
isAbsent()  : bool|mixed
isAbsentOnVacation()  : bool|mixed
isVacation()  : bool
Checks whether the absence type is vacation-related.
onAfterIblockElementModify()  : bool
onUserOnlineStatusGetCustomOfflineStatus()  : array<string|int, mixed>|bool
saveActiveVacationTypes()  : bool

Constants

CACHE_PATH

public mixed CACHE_PATH = '/bx/intranet/absence/'

Properties

$defaultVacationTypes

public static mixed $defaultVacationTypes = ['VACATION', 'LEAVESICK', 'LEAVEMATERINITY', 'LEAVEUNPAYED']

Methods

getActiveVacationTypes()

public static getActiveVacationTypes() : mixed

getCurrentMonth()

public static getCurrentMonth() : array<string|int, mixed>
Tags
throws
ArgumentNullException
throws
ArgumentOutOfRangeException
throws
ObjectException
Return values
array<string|int, mixed>

getIblockId()

public static getIblockId() : int
Tags
throws
ArgumentNullException
throws
ArgumentOutOfRangeException
Return values
int

getTypeCaption()

public static getTypeCaption(mixed $xmlId[, string $default = '' ]) : string
Parameters
$xmlId : mixed
$default : string = ''
Return values
string

getVacationTypes()

public static getVacationTypes() : array<string|int, mixed>
Tags
throws
ArgumentNullException
throws
ArgumentOutOfRangeException
Return values
array<string|int, mixed>

isAbsent()

public static isAbsent(mixed $userId[, bool $returnToDate = false ]) : bool|mixed
Parameters
$userId : mixed
$returnToDate : bool = false
Tags
throws
ArgumentNullException
throws
ArgumentOutOfRangeException
throws
ObjectException
Return values
bool|mixed

isAbsentOnVacation()

public static isAbsentOnVacation(mixed $userId[, bool $returnToDate = false ]) : bool|mixed
Parameters
$userId : mixed
$returnToDate : bool = false
Tags
throws
ArgumentNullException
throws
ArgumentOutOfRangeException
throws
ObjectException
Return values
bool|mixed

isVacation()

Checks whether the absence type is vacation-related.

public static isVacation(mixed $type) : bool
Parameters
$type : mixed
Return values
bool

onAfterIblockElementModify()

public static onAfterIblockElementModify(mixed $fields) : bool
Parameters
$fields : mixed
Tags
throws
ArgumentNullException
throws
ArgumentOutOfRangeException
Return values
bool

onUserOnlineStatusGetCustomOfflineStatus()

public static onUserOnlineStatusGetCustomOfflineStatus(mixed $userId) : array<string|int, mixed>|bool
Parameters
$userId : mixed
Tags
throws
ArgumentNullException
throws
ArgumentOutOfRangeException
throws
ObjectException
Return values
array<string|int, mixed>|bool

saveActiveVacationTypes()

public static saveActiveVacationTypes([array<string|int, mixed> $types = [] ]) : bool
Parameters
$types : array<string|int, mixed> = []
Tags
throws
ArgumentNullException
throws
ArgumentOutOfRangeException
Return values
bool

        
On this page

Search results