GemsTracker library API
Back to top  

Provides translated strings for default options like gender and takes care of date/time formatting

package Gems
subpackage Util
copyright Copyright (c) 2011 Erasmus MC
license New BSD License

 Methods

Returns a callable if a method is called as a variable

__get(string $name) : Callable

Parameters

$name

string

Returns

Callable

Called after the check that all required registry values have been set correctly has run.

afterRegistry() : void

Get a readable version of date / time object with nearby days translated in text

formatDate(\MUtil_Date $dateValue) : string | \MUtil_Html_HtmlElement

Parameters

$dateValue

\MUtil_Date

Returns

string\MUtil_Html_HtmlElement

Get a readable version of date / time object with nearby days translated in text or 'forever' when null

formatDateForever(\MUtil_Date $dateValue) : string | \MUtil_Html_HtmlElement

Parameters

$dateValue

\MUtil_Date

Returns

string\MUtil_Html_HtmlElement

Get a readable version of date / time object with nearby days translated in text or 'n/a' when null

formatDateNa(\MUtil_Date $dateValue) : string | \MUtil_Html_HtmlElement

Parameters

$dateValue

\MUtil_Date

Returns

string\MUtil_Html_HtmlElement

Get a readable version of date / time object with nearby days translated in text or 'never' when null

formatDateNever(\MUtil_Date $dateValue) : string | \MUtil_Html_HtmlElement

Parameters

$dateValue

\MUtil_Date

Returns

string\MUtil_Html_HtmlElement

Get a readable version of date / time object with nearby days translated in text

formatDateTime(\MUtil_Date $dateTimeValue) : string

Parameters

$dateTimeValue

\MUtil_Date

Returns

string

Get a readable version of date / time object with nearby days translated in text or 'unknown' when null

formatDateUnknown(\MUtil_Date $dateValue) : string | \MUtil_Html_HtmlElement

Parameters

$dateValue

\MUtil_Date

Returns

string\MUtil_Html_HtmlElement

Returns the time in seconds as a display string

formatTime(integer $dateTimeValue) : string

Parameters

$dateTimeValue

integer

Returns

string

Returns the time in seconds as a display string or unknown when null

formatTimeUnknown(integer $dateTimeValue) : string

Parameters

$dateTimeValue

integer

Returns

string

The options for bulk mail token processing.

getBulkMailProcessOptions() : array

Returns

array

The date calculation versus manual set

getDateCalculationOptions() : array

Returns

array

Get a translated empty value for usage in dropdowns

getEmptyDropdownArray() : array

On instantiation of the class via \Gems_Loader this variable will be populated in checkRegistryRequestsAnswers

Returns

array

Returns the gender for use as part of a sentence, e.g. Dear Mr/Mrs

getGenderGreeting(string $locale = null) : array

In practice: starts lowercase

Parameters

$locale

string

Returns

arraygender => string

Returns the gender for use in stand-alone name display

getGenderHello(string $locale = null) : array

In practice: starts uppercase

Parameters

$locale

string

Returns

arraygender => string

Returns the functional description of a gender for use in e.g. interface elements

getGenders(string $locale = null) : array

Parameters

$locale

string

Returns

arraygender => string

Get an array of translated labels for the date period units

getPeriodUnits() : array

Returns

arraydate_unit => label

Yes / no values array

getYesNo() : array
staticvar array $data

Returns

array1 => Yes, 0 => No

 Properties

 

Date format string usaed by this project

$dateFormatString : string

Default

'yyyy-MM-dd'
 

DateTime format string usaed by this project

$dateTimeFormatString : string

Default

'yyyy-MM-dd HH:mm:ss'
 

Array representing an empty choice

$emptyDropdownArray : array

Default

Static
 

Format string usaed by this project date time output to site users

$phpDateFormatString : string

Default

'd-m-Y'