Schedule extends AbstractEntity
in package

Tags
since
1.0
see
ScheduleRepository

Table of Contents

$customWorkdays  : array<string|int, mixed>
$daysOff  : array<string|int, DateTime>
$employeeId  : int
$id  : int
$locationId  : int
$timetable  : array<string|int, mixed>
$title  : string
__construct()  : mixed
getCustomWorkingHoursForDate()  : array<string|int, TimePeriod>
getId()  : int
getLocationIds()  : array<string|int, int>
getLocationIdsForDate()  : array<string|int, int>
getWorkingWeek()  : array<string|int, mixed>
Skips days without working hours.
hasCustomWorkingHoursForDate()  : bool
isDayOff()  : bool
isWorkingAt()  : bool
setupFields()  : mixed

Properties

$customWorkdays

public array<string|int, mixed> $customWorkdays = []
Tags
since
1.0

$daysOff

public array<string|int, DateTime> $daysOff = []
Tags
since
1.0

DatePeriod[]

since
1.2.2

DateTime[]

$employeeId

public int $employeeId = 0
Tags
since
1.0

$id

public int $id = 0
Tags
since
1.0

$locationId

public int $locationId = 0
Tags
since
1.0

$timetable

public array<string|int, mixed> $timetable = []
Tags
since
1.0

$title

public string $title = ''
Tags
since
1.0

Methods

__construct()

public __construct(int $id[, array<string|int, mixed> $fieldValues = [] ]) : mixed
Parameters
$id : int
$fieldValues : array<string|int, mixed> = []

Optional.

Tags
since
1.0
Return values
mixed —

getCustomWorkingHoursForDate()

public getCustomWorkingHoursForDate(DateTime|string $date) : array<string|int, TimePeriod>
Parameters
$date : DateTime|string
Tags
since
1.2.2
Return values
array<string|int, TimePeriod> —

getId()

public getId() : int
Tags
since
1.11.0
Return values
int —

getLocationIds()

public getLocationIds() : array<string|int, int>
Tags
since
1.2.2

(Replaced the Schedule::getLocations())

Return values
array<string|int, int> —

getLocationIdsForDate()

public getLocationIdsForDate(DateTime|string $date) : array<string|int, int>
Parameters
$date : DateTime|string
Tags
since
1.2.2

(Replaced the Schedule::getLocationsForDate())

Return values
array<string|int, int> —

getWorkingWeek()

Skips days without working hours.

public getWorkingWeek([int $firstDay = -1 ]) : array<string|int, mixed>
Parameters
$firstDay : int = -1

Optional. -1 by default (use settings value).

Tags
since
1.2
Return values
array<string|int, mixed> —

[Day index => TimePeriod], where day index starts from 0 for Sunday.

hasCustomWorkingHoursForDate()

public hasCustomWorkingHoursForDate(DateTime|string $date) : bool
Parameters
$date : DateTime|string
Tags
since
1.2.2
Return values
bool —

isDayOff()

public isDayOff(string|DateTime $date) : bool
Parameters
$date : string|DateTime
Tags
since
1.0
Return values
bool —

isWorkingAt()

public isWorkingAt(int $locationId[, DateTime|string $date = null ]) : bool
Parameters
$locationId : int
$date : DateTime|string = null
Tags
since
1.0
Return values
bool —

setupFields()

protected setupFields( $fieldValues) : mixed
Parameters
$fieldValues :
Tags
since
1.0
Return values
mixed —

Search results