Skip to content

Refer to time-related constants and intended use. #1584

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
andrewnicols merged 1 commit into from
May 6, 2026
+36 −0
Merged

Refer to time-related constants and intended use. #1584

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions docs/apis/subsystems/time/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,15 @@ Moodle provides a range of methods to display a Unix Timestamp in the relevant L
- `usergetdate` - Given a Unix Timestamp, returns an array that represents the date-time in user time
- `usertime` - Appends the users timezone offset to an integer timestamp

### Relative time {/* #relative-time */}

1. Time constants
- See the time-related [constants here](https://github.com/moodle/moodle/blob/4da09fd5082b7d0c05331ebeed6fb6dc70fc55ae/public/lib/moodlelib.php#L38-L73).
- These constants should be used when presenting options for relative time in the user interface.
- They should never be used for the actual calculation of relative times because they cannot account for leap years, DST, etc.
1. Calculation of relative time
- In order to calculate relative time, one of the PHP `\DateTime` classes should be used, e.g. [`\DateTimeImmutable`](https://www.php.net/manual/en/class.datetimeimmutable.php).
Comment thread
paulholden marked this conversation as resolved.

## Glossary {/* #glossary */}

### Timezone {/* #timezone */}
Expand Down
9 changes: 9 additions & 0 deletions versioned_docs/version-4.5/apis/subsystems/time/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,15 @@ Moodle provides a range of methods to display a Unix Timestamp in the relevant L
- `usergetdate` - Given a Unix Timestamp, returns an array that represents the date-time in user time
- `usertime` - Appends the users timezone offset to an integer timestamp

### Relative time {/* #relative-time */}

1. Time constants
- See the time-related [constants here](https://github.com/moodle/moodle/blob/4da09fd5082b7d0c05331ebeed6fb6dc70fc55ae/public/lib/moodlelib.php#L38-L73).
- These constants should be used when presenting options for relative time in the user interface.
- They should never be used for the actual calculation of relative times because they cannot account for leap years, DST, etc.
1. Calculation of relative time
- In order to calculate relative time, one of the PHP `\DateTime` classes should be used, e.g. [`\DateTimeImmutable`](https://www.php.net/manual/en/class.datetimeimmutable.php).

## Glossary {/* #glossary */}

### Timezone {/* #timezone */}
Expand Down
9 changes: 9 additions & 0 deletions versioned_docs/version-5.0/apis/subsystems/time/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,15 @@ Moodle provides a range of methods to display a Unix Timestamp in the relevant L
- `usergetdate` - Given a Unix Timestamp, returns an array that represents the date-time in user time
- `usertime` - Appends the users timezone offset to an integer timestamp

### Relative time {/* #relative-time */}

1. Time constants
- See the time-related [constants here](https://github.com/moodle/moodle/blob/4da09fd5082b7d0c05331ebeed6fb6dc70fc55ae/public/lib/moodlelib.php#L38-L73).
- These constants should be used when presenting options for relative time in the user interface.
- They should never be used for the actual calculation of relative times because they cannot account for leap years, DST, etc.
1. Calculation of relative time
- In order to calculate relative time, one of the PHP `\DateTime` classes should be used, e.g. [`\DateTimeImmutable`](https://www.php.net/manual/en/class.datetimeimmutable.php).

## Glossary {/* #glossary */}

### Timezone {/* #timezone */}
Expand Down
9 changes: 9 additions & 0 deletions versioned_docs/version-5.1/apis/subsystems/time/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,15 @@ Moodle provides a range of methods to display a Unix Timestamp in the relevant L
- `usergetdate` - Given a Unix Timestamp, returns an array that represents the date-time in user time
- `usertime` - Appends the users timezone offset to an integer timestamp

### Relative time {/* #relative-time */}

1. Time constants
- See the time-related [constants here](https://github.com/moodle/moodle/blob/4da09fd5082b7d0c05331ebeed6fb6dc70fc55ae/public/lib/moodlelib.php#L38-L73).
- These constants should be used when presenting options for relative time in the user interface.
- They should never be used for the actual calculation of relative times because they cannot account for leap years, DST, etc.
1. Calculation of relative time
- In order to calculate relative time, one of the PHP `\DateTime` classes should be used, e.g. [`\DateTimeImmutable`](https://www.php.net/manual/en/class.datetimeimmutable.php).

## Glossary {/* #glossary */}

### Timezone {/* #timezone */}
Expand Down
Loading