Interface LanguageProviderInterface

Interface LanguageProviderInterface

Direct known implementers

LanguageProvider

Package: Shared\Interfaces
Category: System
Located at Shared/Interfaces/LanguageProviderInterface.inc.php

Methods summary

`public IdCollection`	# `getIds( )` Returns the language IDs. Returns the language IDs. Returns `IdCollection` Throws UnexpectedValueException If no ID has been found. InvalidArgumentException If ID is not valid.
`public KeyValueCollection`	# `getCodes( )` Returns the language codes. Returns the language codes. Returns `KeyValueCollection` Throws UnexpectedValueException If no code has been found. InvalidArgumentException If code is not valid.
`public LanguageCode`	# `getCodeById( IdType $id )` Returns the language code from a specific language, selected by the language ID. Returns the language code from a specific language, selected by the language ID. Parameters `$id` Language ID. Returns `LanguageCode` Throws UnexpectedValueException If no code has been found. InvalidArgumentException If code is not valid.
`public string`	# `getDirectoryById( IdType $id )` Returns the directory from the a specific language, selected by the language ID. Returns the directory from the a specific language, selected by the language ID. Parameters `$id` Language ID. Returns string Throws UnexpectedValueException If no directory has been found. InvalidArgumentException If code is not valid.
`public string`	# `getCharsetById( IdType $id )` Returns the charset from the a specific language, selected by the language ID. Returns the charset from the a specific language, selected by the language ID. Parameters `$id` Language ID. Returns string Throws UnexpectedValueException If no charset has been found.
`public integer`	# `getIdByCode( LanguageCode $code )` Returns the ID from the a specific language, selected by the language code. Returns the ID from the a specific language, selected by the language code. Parameters `$code` Language code. Returns integer Throws UnexpectedValueException If no ID has been found.
`public string`	# `getDirectoryByCode( LanguageCode $code )` Returns the directory from the a specific language, selected by the language code. Returns the directory from the a specific language, selected by the language code. Parameters `$code` Language code. Returns string Throws UnexpectedValueException If no directory has been found.
`public string`	# `getCharsetByCode( LanguageCode $code )` Returns the charset from the a specific language, selected by the language code. Returns the charset from the a specific language, selected by the language code. Parameters `$code` Language code. Returns string Throws UnexpectedValueException If no directory has been found.
`public KeyValueCollection`	# `getActiveCodes( )` Returns the active language codes. Returns the active language codes. Returns `KeyValueCollection` Throws InvalidArgumentException If code is not valid.
`public string`	# `getIconFilenameByCode( LanguageCode $code )` Returns the icon for a specific language by a given language code. Returns the icon for a specific language by a given language code. Parameters `$code` The given language code Returns string Throws UnexpectedValueException If no icon has been found.
`public string`	# `getDefaultLanguageCode( )` Returns the default language code. Returns the default language code. Returns string Throws InvalidArgumentException If no default code exists.
`public integer`	# `getDefaultLanguageId( )` Returns the default language ID. Returns the default language ID. Returns integer Throws InvalidArgumentException If no default code exists.