Employee
extends BaseContent
in package
Define system employee object
Tags
Table of Contents
- $ : string|null
- $ : string|null
- $_user : User|null
- The linked user object buffer
- $dbal : CalendarDBAL|null
- DB Abstraction layer
- __construct() : mixed
- Employee constructor.
- DefaultLanguage() : string|null
- The default language of linked user profile
- FormatDate() : DateTime|string
- Format a date based on the settings of the linked profile
- GeneralSearchFields() : array<string|int, mixed>
- Get fields for general search
- GetUser() : User|null
- Get the user, this method is cached
- Save() : Result
- Save instance and clear caches
- SearchFields() : array<string|int, mixed>
- Return search indexer fields Convert instance to search indexer values
- UpdateHolidayIndex() : Result
- Update list of planned holiday/sickness dates
- database() : CalendarDBAL|null
Properties
$
public
string|null
$
name
$
public
string|null
$
description
$_user
The linked user object buffer
private
User|null
$_user
= null
$dbal
DB Abstraction layer
private
CalendarDBAL|null
$dbal
= null
Methods
__construct()
Employee constructor.
public
__construct([string|null $id = null ][, null|string $language = null ]) : mixed
Parameters
- $id : string|null = null
-
The employee id
- $language : null|string = null
-
The local language or null
Return values
mixed —DefaultLanguage()
The default language of linked user profile
public
DefaultLanguage() : string|null
Return values
string|null —FormatDate()
Format a date based on the settings of the linked profile
public
FormatDate( $date) : DateTime|string
Parameters
Return values
DateTime|string —GeneralSearchFields()
Get fields for general search
public
GeneralSearchFields() : array<string|int, mixed>
Return values
array<string|int, mixed> —GetUser()
Get the user, this method is cached
public
GetUser() : User|null
Return values
User|null —Save()
Save instance and clear caches
public
Save([bool $force_new_id = false ]) : Result
Parameters
- $force_new_id : bool = false
Return values
Result —SearchFields()
Return search indexer fields Convert instance to search indexer values
public
SearchFields() : array<string|int, mixed>
Return values
array<string|int, mixed> —The search indexer fields
UpdateHolidayIndex()
Update list of planned holiday/sickness dates
public
UpdateHolidayIndex() : Result
Return values
Result —database()
private
database() : CalendarDBAL|null