Skip to content

Update Human-readable time for legacy Localize Class (missing $include_time parameter) #775

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
merged 2 commits into from
Jan 18, 2024
Merged

Update Human-readable time for legacy Localize Class (missing $include_time parameter) #775

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fd11fb4
Add documentation
RK311y Nov 11, 2023
b2e2edc
Update markdown table formatting (i.e. spaces)
RK311y Nov 11, 2023
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
17 changes: 9 additions & 8 deletions docs/development/legacy/libraries/localization.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,14 +74,15 @@ Similar to PHP's `strtotime()`, the Localize class provides a way to take a pre-

## Human-readable time

### `human_time([$timestamp = NULL[, $localize = TRUE[, $seconds = FALSE]]])`

| Parameter | Type | Description |
| ----------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| \$timestamp | `Integer` | Unix timestamp |
| \$localize | `Boolean` | Boolean of whether to use the current member's timezone for localization (TRUE), or to use GMT (FALSE); or string of PHP timezone to use for the localization |
| \$seconds | `Boolean` | Whether or not to include seconds, overrides `include_seconds` hidden config |
| Returns | `String` | Human-readable date |
### `human_time([$timestamp = NULL[, $localize = TRUE[, $seconds = FALSE[, $include_time = TRUE]]]])`

| Parameter | Type | Description |
| -------------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| \$timestamp | `Integer` | Unix timestamp |
| \$localize | `Boolean` | Boolean of whether to use the current member's timezone for localization (TRUE), or to use GMT (FALSE); or string of PHP timezone to use for the localization |
| \$seconds | `Boolean` | Whether or not to include seconds, overrides `include_seconds` hidden config |
| \$include_time | `Boolean` | Whether or not to include time |
| Returns | `String` | Human-readable date |

Returns a common human-readable date format conforming to ExpressionEngine's [default time formatting setting](control-panel/settings/general.md). This method is most commonly used to express dates in the control panel.

Expand Down