ILIAS  trunk Revision v11.0_alpha-3011-gc6b235a2e85
Duration.php
Go to the documentation of this file.
1<?php
2
19declare(strict_types=1);
20
22
25use DateTimeImmutable;
26
30interface Duration extends Group, FilterInput
31{
35 public function withFormat(DateFormat $format): Duration;
36
40 public function getFormat(): DateFormat;
41
45 public function withMinValue(DateTimeImmutable $date): Duration;
46
50 public function getMinValue(): ?DateTimeImmutable;
51
55 public function withMaxValue(DateTimeImmutable $date): Duration;
56
60 public function getMaxValue(): ?DateTimeImmutable;
61
65 public function withUseTime(bool $with_time): Duration;
66
70 public function getUseTime(): bool;
71
75 public function withTimeOnly(bool $time_only): Duration;
76
80 public function getTimeOnly(): bool;
81
85 public function withTimezone(string $tz): Duration;
86
90 public function getTimezone(): ?string;
91
95 public function withLabels(string $start_label, string $end_label): Duration;
96}
A Date Format provides a format definition akin to PHP's date formatting options, but stores the sing...
Definition: DateFormat.php:27
This interface must be implemented by all Inputs that support Filter Containers.
Definition: FilterInput.php:36
This describes the duration input.
Definition: Duration.php:31
getTimezone()
Get the timezone of this input.
withTimezone(string $tz)
Get an input like this using the given timezone.
withTimeOnly(bool $time_only)
Use this Input for a time-value rather than a date.
getTimeOnly()
Should the input be used to get a time only?
getMaxValue()
Return the maximum date the input accepts.
withMinValue(DateTimeImmutable $date)
Limit accepted values to Duration past (and including) the given $Duration.
withUseTime(bool $with_time)
Input both date and time.
getMinValue()
Return the lowest value the input accepts.
withLabels(string $start_label, string $end_label)
Change labels for contained fields.
getUseTime()
Should the input be used to get both date and time?
getFormat()
Get the date-format of this input.
withFormat(DateFormat $format)
Get an input like this using the given format.
withMaxValue(DateTimeImmutable $date)
Limit accepted values to Duration before (and including) the given value.
Describes the monoid operation of grouping form inputs.
Definition: Group.php:32
This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Le...
Definition: Checkbox.php:21