PHP Class Kimai_Config

Inheritance: extends Kimai_ArrayObject
Mostra file Open project: kimai/kimai Class Usage Examples

Public Methods

Method Description
__construct ( array $kga ) Prefill the configuration object with the given array.
getAdminEmail ( ) : string Returns the administrators email address.
getAuthenticator ( ) : string Returns the applications default authenticator.
getBillable ( ) : array
getCurrencyName ( ) : string
getCurrencySign ( ) : string
getDateFormat ( integer $id ) : string Set one of the date formats.
getDefault ( $config ) : array | null | string Returns the default value for a given CONSTANT (see DEFAULT_*)
getDefaultStatus ( ) : integer
getDefaultVat ( ) : integer
getEditLimit ( ) : integer
getLanguage ( boolean $system = false ) : string | null Returns the current language.
getLoginBanTime ( ) : integer
getLoginTriesBeforeBan ( ) : integer
getRevision ( ) : integer Returns the actual Kimai revision from the database.
getRoundPrecisionRecorderTimes ( ) : integer
getSettings ( ) : Kimai_Config_Settings Return user specific settings.
getSkin ( ) : mixed | null Returns the applications default skin.
getStatuses ( ) : array Returns an array of all available statuses.
getTableTimeFormat ( ) : string
getTimezone ( ) : string Returns the timezone of the Kimai installation, which could be user specific if configured.
getVersion ( ) : string Returns the actual Kimai version from the database.
isDisplayCurrencyFirst ( ) : boolean
isEditLimit ( ) : boolean
isRoundDownRecorderTimes ( ) : boolean
isShowDaySeperatorLines ( ) : boolean
isShowGabBreaks ( ) : boolean
isShowRecordAgain ( ) : boolean
isTrackingNumberEnabled ( ) : mixed | null Returns whether the tracking number field is editable.
isUseExactSums ( ) : boolean
setAuthenticator ( $authenticator ) Sets the authenticator.
setBillable ( array $billable ) Sets the billable values as array.
setLanguage ( $language ) Sets the system language.
setSkin ( $skin ) Sets the skin.
setStatuses ( array $statuses ) Sets all available statuses.
setTimezone ( $timezone ) Sets the timezone.
setTranslation ( Kimai_Translation_Data $data ) There is no "getTranslation()" as you should access them through Kimai_Registry
setUser ( Kimai_User $user ) There is no "getUser()" as you should access them through Kimai_Registry

Protected Methods

Method Description
getCoreDefaults ( ) : array Return default settings for the application.

Method Details

__construct() public method

Prefill the configuration object with the given array.
public __construct ( array $kga )
$kga array

getAdminEmail() public method

Returns the administrators email address.
public getAdminEmail ( ) : string
return string

getAuthenticator() public method

Returns the applications default authenticator.
public getAuthenticator ( ) : string
return string

getBillable() public method

public getBillable ( ) : array
return array

getCoreDefaults() protected method

Return default settings for the application.
protected getCoreDefaults ( ) : array
return array

getCurrencyName() public method

public getCurrencyName ( ) : string
return string

getCurrencySign() public method

public getCurrencySign ( ) : string
return string

getDateFormat() public method

Set one of the date formats.
public getDateFormat ( integer $id ) : string
$id integer
return string

getDefault() public static method

Returns the default value for a given CONSTANT (see DEFAULT_*)
public static getDefault ( $config ) : array | null | string
$config
return array | null | string

getDefaultStatus() public method

public getDefaultStatus ( ) : integer
return integer

getDefaultVat() public method

public getDefaultVat ( ) : integer
return integer

getEditLimit() public method

public getEditLimit ( ) : integer
return integer

getLanguage() public method

Can either be user specific, admin specific or system specific.
public getLanguage ( boolean $system = false ) : string | null
$system boolean whether the system language is re
return string | null

getLoginBanTime() public method

public getLoginBanTime ( ) : integer
return integer

getLoginTriesBeforeBan() public method

public getLoginTriesBeforeBan ( ) : integer
return integer

getRevision() public method

This is NOT the installed software revision, but the revision of the database structure.
public getRevision ( ) : integer
return integer

getRoundPrecisionRecorderTimes() public method

public getRoundPrecisionRecorderTimes ( ) : integer
return integer

getSettings() public method

Return user specific settings.
public getSettings ( ) : Kimai_Config_Settings
return Kimai_Config_Settings

getSkin() public method

Returns the applications default skin.
public getSkin ( ) : mixed | null
return mixed | null

getStatuses() public method

Returns an array of all available statuses.
public getStatuses ( ) : array
return array

getTableTimeFormat() public method

public getTableTimeFormat ( ) : string
return string

getTimezone() public method

Returns the timezone of the Kimai installation, which could be user specific if configured.
public getTimezone ( ) : string
return string

getVersion() public method

This is NOT the installed software version, but the version of the database structure.
public getVersion ( ) : string
return string

isDisplayCurrencyFirst() public method

public isDisplayCurrencyFirst ( ) : boolean
return boolean

isEditLimit() public method

public isEditLimit ( ) : boolean
return boolean

isRoundDownRecorderTimes() public method

public isRoundDownRecorderTimes ( ) : boolean
return boolean

isShowDaySeperatorLines() public method

public isShowDaySeperatorLines ( ) : boolean
return boolean

isShowGabBreaks() public method

public isShowGabBreaks ( ) : boolean
return boolean

isShowRecordAgain() public method

public isShowRecordAgain ( ) : boolean
return boolean

isTrackingNumberEnabled() public method

Returns whether the tracking number field is editable.
public isTrackingNumberEnabled ( ) : mixed | null
return mixed | null

isUseExactSums() public method

public isUseExactSums ( ) : boolean
return boolean

setAuthenticator() public method

Sets the authenticator.
public setAuthenticator ( $authenticator )
$authenticator

setBillable() public method

Sets the billable values as array.
public setBillable ( array $billable )
$billable array

setLanguage() public method

Sets the system language.
public setLanguage ( $language )
$language

setSkin() public method

Sets the skin.
public setSkin ( $skin )
$skin

setStatuses() public method

Sets all available statuses.
public setStatuses ( array $statuses )
$statuses array

setTimezone() public method

Sets the timezone.
public setTimezone ( $timezone )
$timezone

setTranslation() public method

There is no "getTranslation()" as you should access them through Kimai_Registry
Deprecation: do not call directly, only meant for backward compatibility
public setTranslation ( Kimai_Translation_Data $data )
$data Kimai_Translation_Data

setUser() public method

There is no "getUser()" as you should access them through Kimai_Registry
Deprecation: do not call directly, only meant for backward compatibility
public setUser ( Kimai_User $user )
$user Kimai_User