PHP 클래스 I18n

This file is part of AgenDAV. AgenDAV is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or any later version. AgenDAV is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with AgenDAV. If not, see .
상속: extends CI_Model
파일 보기 프로젝트 열기: baserproject/basercms 1 사용 예제들

공개 프로퍼티들

프로퍼티 타입 설명
$category string Current category of translation
$defaultDomain string Default domain of translation
$domain string Current domain of translation
$l10n L10n Instance of the L10n class for localization

보호된 프로퍼티들

프로퍼티 타입 설명
$_categories array Translation categories
$_domains array Translation strings for a specific domain read from the .mo or .po files
$_escape string Escape string
$_lang string Current language used for translations
$_noLocale boolean If a translation file is found it is set to false again

공개 메소드들

메소드 설명
__construct ( ) Constructor, use I18n::getInstance() to get the i18n translation object.
clear ( ) : void Clears the domains internal data array. Useful for testing i18n.
domains ( ) : array Get the loaded domains cache.
getInstance ( ) : I18n Return a static instance of the I18n class
insertArgs ( string $translated, array $args ) : string Puts the parameters in raw translated strings
loadLocaleDefinition ( string $filename ) : mixed Parses a locale definition file following the POSIX standard
loadMo ( string $filename ) : mixed Loads the binary .mo file and returns array of translations
loadPo ( string $filename ) : mixed Loads the text .po file and returns array of translations
translate ( string $singular, string $plural = null, string $domain = null, string $category = self::LC_MESSAGES, integer $count = null, string $language = null, string $context = null ) : string Used by the translation functions in basics.php Returns a translated string based on current language and translation files stored in locale folder

보호된 메소드들

메소드 설명
_bindTextDomain ( string $domain ) : string Binds the given domain to a file in the specified directory.
_parseLiteralValue ( string $string ) : string Auxiliary function to parse a symbol from a locale definition file
_pluralGuess ( string $header, integer $n ) : integer Attempts to find the plural form of a string.
_translateTime ( string $format, string $domain ) : mixed Returns a Time format definition from corresponding domain

메소드 상세

__construct() 공개 메소드

Constructor, use I18n::getInstance() to get the i18n translation object.
public __construct ( )

_bindTextDomain() 보호된 메소드

Binds the given domain to a file in the specified directory.
protected _bindTextDomain ( string $domain ) : string
$domain string Domain to bind
리턴 string Domain binded

_parseLiteralValue() 보호된 메소드

Auxiliary function to parse a symbol from a locale definition file
protected _parseLiteralValue ( string $string ) : string
$string string Symbol to be parsed
리턴 string parsed symbol

_pluralGuess() 보호된 메소드

Attempts to find the plural form of a string.
protected _pluralGuess ( string $header, integer $n ) : integer
$header string Type
$n integer Number
리턴 integer plural match

_translateTime() 보호된 메소드

Returns a Time format definition from corresponding domain
protected _translateTime ( string $format, string $domain ) : mixed
$format string Format to be translated
$domain string Domain where format is stored
리턴 mixed translated format string if only value or array of translated strings for corresponding format.

clear() 공개 정적인 메소드

Clears the domains internal data array. Useful for testing i18n.
public static clear ( ) : void
리턴 void

domains() 공개 정적인 메소드

Get the loaded domains cache.
public static domains ( ) : array
리턴 array

getInstance() 공개 정적인 메소드

Return a static instance of the I18n class
public static getInstance ( ) : I18n
리턴 I18n

insertArgs() 공개 정적인 메소드

Puts the parameters in raw translated strings
public static insertArgs ( string $translated, array $args ) : string
$translated string The raw translated string
$args array The arguments to put in the translation
리턴 string Translated string with arguments

loadLocaleDefinition() 공개 정적인 메소드

Parses a locale definition file following the POSIX standard
public static loadLocaleDefinition ( string $filename ) : mixed
$filename string Locale definition filename
리턴 mixed Array of definitions on success or false on failure

loadMo() 공개 정적인 메소드

Loads the binary .mo file and returns array of translations
public static loadMo ( string $filename ) : mixed
$filename string Binary .mo file to load
리턴 mixed Array of translations on success or false on failure

loadPo() 공개 정적인 메소드

Loads the text .po file and returns array of translations
public static loadPo ( string $filename ) : mixed
$filename string Text .po file to load
리턴 mixed Array of translations on success or false on failure

translate() 공개 정적인 메소드

Used by the translation functions in basics.php Returns a translated string based on current language and translation files stored in locale folder
public static translate ( string $singular, string $plural = null, string $domain = null, string $category = self::LC_MESSAGES, integer $count = null, string $language = null, string $context = null ) : string
$singular string String to translate
$plural string Plural string (if any)
$domain string Domain The domain of the translation. Domains are often used by plugin translations. If null, the default domain will be used.
$category string Category The integer value of the category to use.
$count integer Count Count is used with $plural to choose the correct plural form.
$language string Language to translate string to. If null it checks for language in session followed by Config.language configuration variable.
$context string Context The context of the translation, e.g a verb or a noun.
리턴 string translated string.

프로퍼티 상세

$_categories 보호되어 있는 프로퍼티

Translation categories
protected array $_categories
리턴 array

$_domains 보호되어 있는 프로퍼티

Translation strings for a specific domain read from the .mo or .po files
protected array $_domains
리턴 array

$_escape 보호되어 있는 프로퍼티

Escape string
protected string $_escape
리턴 string

$_lang 보호되어 있는 프로퍼티

Current language used for translations
protected string $_lang
리턴 string

$_noLocale 보호되어 있는 프로퍼티

If a translation file is found it is set to false again
protected bool $_noLocale
리턴 boolean

$category 공개적으로 프로퍼티

Current category of translation
public string $category
리턴 string

$defaultDomain 공개적으로 정적으로 프로퍼티

Default domain of translation
public static string $defaultDomain
리턴 string

$domain 공개적으로 프로퍼티

Current domain of translation
public string $domain
리턴 string

$l10n 공개적으로 프로퍼티

Instance of the L10n class for localization
public L10n $l10n
리턴 L10n