KMP PHP API Reference

TimezoneHelper extends Helper

in package

• Application

Timezone View Helper for template-friendly datetime formatting.

Tags

see

TimezoneHelper

Core timezone conversion logic

Table of Contents

Properties

$Form  : FormHelper

$currentUser  : Member|array<string|int, mixed>|null

Current user/member for timezone resolution

$helpers  : array<string|int, string>

Helpers used by this helper

Methods

date()  : string

Format date only (no time)

forInput()  : string

Format datetime for form input (datetime-local format)

format()  : string

Format a datetime in the viewer's timezone.

getAbbreviation()  : string

Get timezone abbreviation for current user or specific timezone

getOffset()  : float

Get timezone offset in hours

getTimezoneOptions()  : array<string|int, mixed>

Create a timezone selector dropdown for forms

getUserTimezone()  : string

Get the current user's timezone

initialize()  : void

Initialize helper

notice()  : string

Display a timezone notice for the user

range()  : string

Format a date range

smartRange()  : string

Smart date range formatting

time()  : string

Format time only (no date)

isGatheringContext()  : bool

Determine if the provided context should be treated as a gathering reference.

isMemberContext()  : bool

Determine if the provided context should be treated as a member reference.

$this->Timezone->format($datetime); // default display format
$this->Timezone->format($datetime, true); // include timezone abbreviation
$this->Timezone->format($datetime, $member, 'Y-m-d'); // member context + format string
$this->Timezone->format($datetime, $gathering, 'M j, Y'); // gathering context + format
$this->Timezone->format($datetime, null, null, IntlDateFormatter::SHORT, IntlDateFormatter::SHORT);