time.php
Table of Contents
- mpa_format_minutes() : string
- mpa_minutes_to_duration() : string
- mpa_parse_to_minutes() : int
- Convert something like '08:20' into 500.
- mpa_format_time() : string
- mpa_parse_time() : DateTime|mixed
- mpa_validate_time() : string|false
- mpa_validate_time_pattern() : string
- mpa_time_format() : string
- Public time format, set in Settings > General.
- mpa_time_durations() : array<string|int, mixed>
- mpa_time_stamps() : array<string|int, mixed>
- mpa_timestamp_minutes() : int
- mpa_time_slots() : array<string|int, TimePeriod>
- mpa_next_time_step() : DateTime
- mpa_time_step() : int
- mpa_add_buffer_time() : TimePeriod
Functions
mpa_format_minutes()
mpa_format_minutes(int $minutes[, string $format = 'public' ]) : string
Parameters
- $minutes : int
- $format : string = 'public'
-
Optional. 'public', 'internal' ('H:i') or custom time format. 'public' by default.
Tags
mpa_minutes_to_duration()
mpa_minutes_to_duration(int $minutes) : string
Parameters
- $minutes : int
Tags
mpa_parse_to_minutes()
Convert something like '08:20' into 500.
mpa_parse_to_minutes(string $timeString) : int
Parameters
- $timeString : string
-
Time in format 'H:i' ('XX:XX'; the function will not check if the format is OK).
Tags
mpa_format_time()
mpa_format_time(DateTime $time[, string $format = 'public' ]) : string
Parameters
- $time : DateTime
- $format : string = 'public'
-
Optional. 'public', 'internal' ('H:i') or custom time format. 'public' by default.
Tags
mpa_parse_time()
mpa_parse_time(string|DateTime $time[, mixed $default = false ]) : DateTime|mixed
Parameters
- $time : string|DateTime
-
Only the internal format is acceptable as a string: 'H:i'.
- $default : mixed = false
-
Optional. False by default (same return value as in the DateTime::createFromFormat()).
Tags
mpa_validate_time()
mpa_validate_time(string $timeString) : string|false
Parameters
- $timeString : string
-
Only the internal format is acceptable - 'H:i'.
Tags
mpa_validate_time_pattern()
mpa_validate_time_pattern() : string
Tags
mpa_time_format()
Public time format, set in Settings > General.
mpa_time_format() : string
Tags
mpa_time_durations()
mpa_time_durations(int $min[, int $max = 1439 ]) : array<string|int, mixed>
Parameters
- $min : int
-
Optional. 0 by default.
- $max : int = 1439
-
Optional. 1439 by default (the latest time (in minutes): 23:59).
Tags
mpa_time_stamps()
mpa_time_stamps([array<string|int, mixed> $args = [] ]) : array<string|int, mixed>
Parameters
- $args : array<string|int, mixed> = []
-
Optional. @param int $args['time_step'] Time step from the settings by default. @param string $args['map_function'] mpa_format_minutes() by default. @param int $args['min'] 0 by default. @param int $args['max'] 1439 by default (the latest time (in minutes): 23:59).
Tags
mpa_timestamp_minutes()
mpa_timestamp_minutes(DateTime $time) : int
Parameters
- $time : DateTime
Tags
mpa_time_slots()
mpa_time_slots(TimePeriod|array<string|int, TimePeriod>|TimePeriods $time, array<string|int, mixed> $args) : array<string|int, TimePeriod>
Parameters
- $time : TimePeriod|array<string|int, TimePeriod>|TimePeriods
- $args : array<string|int, mixed>
-
@param int $args['duration'] Required. Service duration (minutes). @param int $args['time_step'] Optional. Length of the time slot step. Time step from the settings by default. @param int $args['buffer_before'] Optional. Buffer time before the service (in minutes). 0 by default. @param int $args['buffer_after'] Optional. Buffer time after the service (in minutes). 0 by default. @param DateTime $args['min_time'] Optional. No limitations by default. @param string $args['alignment'] Optional. 'hour'|'none'. Alignment from the settings by default.
Tags
mpa_next_time_step()
mpa_next_time_step(DateTime $time[, array<string|int, mixed> $args = [] ]) : DateTime
Parameters
- $time : DateTime
- $args : array<string|int, mixed> = []
-
Optional. @param int $args['time_step'] Time step from the settings by default. @param string $args['alignment'] Alignment from the settings by default.
Tags
mpa_time_step()
mpa_time_step() : int
Tags
mpa_add_buffer_time()
mpa_add_buffer_time(TimePeriod|string $timePeriod, Service $service) : TimePeriod
Parameters
- $timePeriod : TimePeriod|string
- $service : Service