1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158
<?php
/* --------------------------------------------------------------
LanguageProviderInterface.inc.php 2016-05-31
Gambio GmbH
http://www.gambio.de
Copyright (c) 2016 Gambio GmbH
Released under the GNU General Public License (Version 2)
[http://www.gnu.org/licenses/gpl-2.0.html]
--------------------------------------------------------------
*/
/**
* Interface LanguageProviderInterface
*
* @category System
* @package Shared
* @subpackage Interfaces
*/
interface LanguageProviderInterface
{
/**
* Returns the language IDs.
*
* @throws UnexpectedValueException If no ID has been found.
* @throws InvalidArgumentException If ID is not valid.
*
* @return IdCollection
*/
public function getIds();
/**
* Returns the language codes.
*
* @throws UnexpectedValueException If no code has been found.
* @throws InvalidArgumentException If code is not valid.
*
* @return KeyValueCollection
*/
public function getCodes();
/**
* Returns the language code from a specific language, selected by the language ID.
*
* @param IdType $id Language ID.
*
* @throws UnexpectedValueException If no code has been found.
* @throws InvalidArgumentException If code is not valid.
*
* @return LanguageCode
*/
public function getCodeById(IdType $id);
/**
* Returns the directory from the a specific language, selected by the language ID.
*
* @param IdType $id Language ID.
*
* @throws UnexpectedValueException If no directory has been found.
* @throws InvalidArgumentException If code is not valid.
*
* @return string
*/
public function getDirectoryById(IdType $id);
/**
* Returns the charset from the a specific language, selected by the language ID.
*
* @param IdType $id Language ID.
*
* @throws UnexpectedValueException If no charset has been found.
*
* @return string
*/
public function getCharsetById(IdType $id);
/**
* Returns the ID from the a specific language, selected by the language code.
*
* @param LanguageCode $code Language code.
*
* @throws UnexpectedValueException If no ID has been found.
*
* @return int
*/
public function getIdByCode(LanguageCode $code);
/**
* Returns the directory from the a specific language, selected by the language code.
*
* @param LanguageCode $code Language code.
*
* @throws UnexpectedValueException If no directory has been found.
*
* @return string
*/
public function getDirectoryByCode(LanguageCode $code);
/**
* Returns the charset from the a specific language, selected by the language code.
*
* @param LanguageCode $code Language code.
*
* @throws UnexpectedValueException If no directory has been found.
*
* @return string
*/
public function getCharsetByCode(LanguageCode $code);
/**
* Returns the active language codes.
*
* @throws InvalidArgumentException If code is not valid.
*
* @return KeyValueCollection
*/
public function getActiveCodes();
/**
* Returns the icon for a specific language by a given language code.
*
* @param LanguageCode $code The given language code
*
* @throws UnexpectedValueException If no icon has been found.
*
* @return string
*/
public function getIconFilenameByCode(LanguageCode $code);
/**
* Returns the default language code.
*
* @throws InvalidArgumentException If no default code exists.
*
* @return string
*/
public function getDefaultLanguageCode();
/**
* Returns the default language ID.
*
* @throws InvalidArgumentException If no default code exists.
*
* @return int
*/
public function getDefaultLanguageId();
}