ZurmoTimeZoneHelper Class Reference

Public Member Functions

 setTimeZone ($value)
 getTimeZone ()
 load ()
 getForCurrentUser ()
 getGlobalValue ()
 convertFromUtcTimeStampForCurrentUser ($utcTimeStamp)
 convertFromLocalTimeStampForCurrentUser ($utcTimeStamp)
 isCurrentUsersTimeZoneConfirmed ()
 confirmCurrentUsersTimeZone ()
 isTimeZoneSetForCurrentUser ()

Static Public Member Functions

static setGlobalValue ($timeZone)
static getTimeZoneOffset ()

Protected Attributes

 $_timeZone

Detailed Description

Application loaded component at run time.

See also:
BeginBehavior - calls load() method. Defaults time zone to configuration set in common configuration 'timeZone' setting.

Definition at line 41 of file ZurmoTimeZoneHelper.php.


Member Function Documentation

setTimeZone ( value  ) 

This is set from the value in the application common config file. It is used as the final fall back if no other configuration settings are found.

Definition at line 52 of file ZurmoTimeZoneHelper.php.

load (  ) 

Loads time zone for current user. This is called by BeginBehavior.

Definition at line 71 of file ZurmoTimeZoneHelper.php.

getForCurrentUser (  ) 

Get the time zone value for the current user

Returns:
$timeZone - string.

Definition at line 80 of file ZurmoTimeZoneHelper.php.

getGlobalValue (  ) 

Get the global configuration value.

Returns:
string - time zone.

Definition at line 96 of file ZurmoTimeZoneHelper.php.

static setGlobalValue ( timeZone  )  [static]

Set the global time zone configuration value.

Definition at line 111 of file ZurmoTimeZoneHelper.php.

convertFromUtcTimeStampForCurrentUser ( utcTimeStamp  ) 

Given a utc time stamp, convert the time stamp to a timezone adjusted time stamp. The time zone is based on the current user's time zone.

Definition at line 121 of file ZurmoTimeZoneHelper.php.

convertFromLocalTimeStampForCurrentUser ( utcTimeStamp  ) 

Given a local time stamp, convert the time stamp to UTC based on a timezone adjusted time stamp. The time zone is based on the current user's time zone.

Definition at line 132 of file ZurmoTimeZoneHelper.php.

static getTimeZoneOffset (  )  [static]

Gets timezone offset.

Returns:
int in seconds

Definition at line 168 of file ZurmoTimeZoneHelper.php.


Field Documentation

$_timeZone [protected]

Systemwide time zone.

Definition at line 46 of file ZurmoTimeZoneHelper.php.


The documentation for this class was generated from the following file:
 All Data Structures Functions Variables
Generated on Thu May 25 07:10:31 2017