Class: Base_RegionalSettingsCommon

Source Location: /modules/Base/RegionalSettings/RegionalSettingsCommon_0.php

Class Base_RegionalSettingsCommon

Class Overview

Regional settings like currency, time...

Located in /modules/Base/RegionalSettings/RegionalSettingsCommon_0.php [line 13]

ModuleAcl
   |
   --ModulePrimitive
      |
      --ModuleCommon
         |
         --Base_RegionalSettingsCommon

Author(s):

Paul Bukowski <pbukowski@telaxus.com>

Information Tags:

Version:	1.0
Copyright:	Copyright © 2008, Telaxus LLC
License:	MIT

Methods

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From ModuleCommon

ModuleCommon::Instance()

Singleton.

Inherited From ModulePrimitive

ModulePrimitive::__construct()

ModulePrimitive::check_access()

Checks access to function which name is passed as first parameter.

ModulePrimitive::create_data_dir()

Creates default data directory for module. Typical usage: in module installation

ModulePrimitive::get_data_dir()

Returns path to the default data directory for module calling this method.

ModulePrimitive::get_module_dir()

Returns path to the module directory.

ModulePrimitive::get_type()

Returns name(type) of module that called this function.

ModulePrimitive::get_type_with_bt()

ModulePrimitive::remove_data_dir()

Removes default data directory of a module. Typical usage: in module uninstallation

Inherited From ModuleAcl

ModuleAcl::acl_check()

ModuleAcl::add_aco()

ModuleAcl::del_aco()

ModuleAcl::get_type()

[ Top ]

Method Summary

static void	check_12h()
static string	date_format()	Get date format (strftime).
static void	default_country_elem()
static void	default_state_elem()
static void	get_default_location()
static int	reg2time()	Convert regional time format to unix time (and server timezone)
static void	restore()
static void	restore_locale()
static void	restore_tz()
static string	seconds_to_words()
static void	set()
static void	set_locale()
static void	set_tz()
static string	time2reg()	Convert local time to client format and timezone(optional)
static boolean	time_12h()	Is user clock 12h?
static string	time_format()	Get time format (strftime).
static void	user_settings()

[ Top ]

Methods

static method check_12h [line 88]

static void check_12h(

$v, 
$form 
)

Parameters:

	$v:
	$form:

API Tags:

Access:

public

[ Top ]

static method date_format [line 260]

static string date_format(
)

Get date format (strftime).

API Tags:

Access:

public

[ Top ]

static method default_country_elem [line 72]

static void default_country_elem(

$name, 
$args, 
&$def_js 
)

Parameters:

	$name:
	$args:
	&$def_js:

API Tags:

Access:

public

[ Top ]

static method default_state_elem [line 77]

static void default_state_elem(

$name, 
$args, 
&$def_js 
)

Parameters:

	$name:
	$args:
	&$def_js:

API Tags:

Access:

public

[ Top ]

static method get_default_location [line 81]

static void get_default_location(
)

API Tags:

Access:

public

[ Top ]

static method reg2time [line 216]

static int reg2time(
string
$t, [boolean
$tz = true] 
)

Convert regional time format to unix time (and server timezone)

Parameters:

string	$t:
boolean	$tz:	convert from local time to server time

API Tags:

Access:

public

[ Top ]

static method restore [line 204]

static void restore(
)

API Tags:

Access:

public

[ Top ]

static method restore_locale [line 195]

static void restore_locale(
)

API Tags:

Access:

public

[ Top ]

static method restore_tz [line 188]

static void restore_tz(
)

API Tags:

Access:

public

[ Top ]

static method seconds_to_words [line 289]

static string seconds_to_words(
int
$seconds, [
$days_h = true] 
)

Parameters:

int	$seconds:	The number of seconds
	$days_h:

API Tags:

Return:	for example 2 hour(s) 15 minutes (translated)
Access:	public

[ Top ]

static method set [line 199]

static void set(
)

API Tags:

Access:

public

[ Top ]

static method set_locale [line 170]

static void set_locale(
[
$tz = true] 
)

Parameters:

$tz:

API Tags:

Access:

public

[ Top ]

static method set_tz [line 181]

static void set_tz(
)

API Tags:

Access:

public

[ Top ]

static method time2reg [line 120]

static string time2reg(
[mixed
$t = null], [mixed
$time = true], [mixed
$date = true], [boolean
$tz = true], [boolean
$reg_format = true] 
)

Convert local time to client format and timezone(optional)

Parameters:

mixed	$t:	string-strtotime recognizable string, null-current time, int-unix time
mixed	$time:	{0,false,null,''}-no time (you probably don't want to set it!),{1,true,'with_seconds'}-time with seconds,{2,'without_seconds'}-time without seconds
mixed	$date:	{0,false,null,''}-no date,{1,true}-with date,{2,'without_year'}-date without year, {3,'with_weekday'}-date with weekday
boolean	$tz:	convert to client time
boolean	$reg_format:	use regional user format

API Tags:

Access:

public

[ Top ]

static method time_12h [line 278]

static boolean time_12h(
)

Is user clock 12h?

API Tags:

Access:

public

[ Top ]

static method time_format [line 269]

static string time_format(
)

Get time format (strftime).

API Tags:

Access:

public

[ Top ]

static method user_settings [line 42]

static void user_settings(
)

API Tags:

Access:

public

[ Top ]

Documentation generated on Fri, 26 Dec 2008 21:45:27 -0500 by phpDocumentor 1.4.2

	epesi-base regionalsettings

[ class tree: epesi-base ] [ index: epesi-base ] [ all elements ]