/i18n_v2/inc/class.I18Nlocale.inc.php

http://flaimo-php.googlecode.com/ · PHP · 340 lines · 173 code · 37 blank · 130 comment · 35 complexity · a2820e7f9d51c71a0c0aa614fbeaeffb MD5 · raw file 

    

  1. <?php

    2. 

  2. /**

    3. 

  3. * load base class which takes care of all the other includes via it's autoload function

    4. 

  4. */

    5. 

  5. require_once 'class.I18Nbase.inc.php';

    6. 

  6. 

    7. 

  7. /**

    8. 

  8. * holds information about locale/country/language selected by the user or automatically; also loads settings L10N settings

    9. 

  9. * @author Michael Wimmer <flaimo@gmail.com>

    10. 

  10. * @category flaimo-php

    11. 

  11. * @example  ../www_root/i18n_example_script.php  i18n example script

    12. 

  12. * @license GNU General Public License v3

    13. 

  13. * @link http://code.google.com/p/flaimo-php/

    14. 

  14. * @package i18n

    15. 

  15. * @version 2.3.1

    16. 

  16. */

    17. 

  17. class I18Nlocale extends I18Nbase {

    18. 

  18. 

    19. 

  19. 	/**#@+

    20. 

  20. 	* @var string

    21. 

  21. 	*/

    22. 

  22. 	protected $locale;

    23. 

  23. 	protected $country;

    24. 

  24. 	protected $language;

    25. 

  25. 	/**#@-*/

    26. 

  26. 	/**#@+

    27. 

  27. 	* @var array

    28. 

  28. 	*/

    29. 

  29. 	protected $locales;

    30. 

  30. 	protected $countries;

    31. 

  31. 	protected $languages;

    32. 

  32. 	protected $locale_settings;

    33. 

  33. 	/**#@-*/

    34. 

  34. 

    35. 

  35. 	/**

    36. 

  36. 	* @var boolean

    37. 

  37. 	*/

    38. 

  38. 	protected $use_prefs = TRUE;

    39. 

  39. 	const TRANSLATE_IP = TRUE;

    40. 

  40. 	/**#@-*/

    41. 

  41. 

    42. 

  42. 	/**

    43. 

  43. 	* @param string $locale

    44. 

  44. 	* @return void

    45. 

  45. 	* @uses I18Nbase::isValidLocaleCode()

    46. 

  46. 	* @uses I18Nlocale::addLocale()

    47. 

  47. 	* @uses I18Nlocale::$use_prefs

    48. 

  48. 	* @uses I18Nlocale::$locale

    49. 

  49. 	* @uses I18Nlocale::$language

    50. 

  50. 	* @uses I18Nlocale::$country

    51. 

  51. 	* @uses I18Nbase::__construct()

    52. 

  52. 	*/

    53. 

  53. 	public function __construct($locale = '') {

    54. 

  54. 		if (parent::isValidLocaleCode($locale) === TRUE) {

    55. 

  55. 

    56. 

  56. 			// hier lokale check  machen

    57. 

  57. 

    58. 

  58. 			$this->addLocale($locale);

    59. 

  59. 			$this->use_prefs = FALSE;

    60. 

  60. 			$this->locale =& $this->locales[0];

    61. 

  61. 			$this->language =& $this->languages[0];

    62. 

  62. 			if (count($this->countries) > 0) {

    63. 

  63. 				$this->country =& $this->countries[0];

    64. 

  64. 			} // end if

    65. 

  65. 		} // end if

    66. 

  66. 		parent::__construct();

    67. 

  67. 	} // end if

    68. 

  68. 

    69. 

  69. 	/**

    70. 

  70. 	* fetches l10n settings from the ini file

    71. 

  71. 	* @return void

    72. 

  72. 	* @uses I18Nlocale::$locale_settings

    73. 

  73. 	* @uses I18Nbase::getI18Nsetting()

    74. 

  74. 	*/

    75. 

  75. 	protected function readL10Nsettings() {

    76. 

  76. 		$this->locale_settings = @parse_ini_file(parent::getI18Nsetting('locales_path') . '/' . $this->getI18NLocale() . '/' . 'l10n_settings.ini');

    77. 

  77. 		return (boolean) ($this->locale_settings == FALSE) ? FALSE : TRUE;

    78. 

  78. 	} // end function

    79. 

  79. 

    80. 

  80. 	/**

    81. 

  81. 	* returns a value for a l10n setting

    82. 

  82. 	* @param string $setting

    83. 

  83. 	* @return mixed

    84. 

  84. 	* @uses I18Nlocale::readL10Nsettings()

    85. 

  85. 	* @uses I18Nlocale::$locale_settings

    86. 

  86. 	*/

    87. 

  87. 	public function getL10NSetting($setting = '') {

    88. 

  88. 		if (!isset($this->locale_settings)) {

    89. 

  89. 			$this->readL10Nsettings();

    90. 

  90. 		} // end if

    91. 

  91. 		if (array_key_exists($setting, $this->locale_settings)) {

    92. 

  92. 			return $this->locale_settings[$setting];

    93. 

  93. 		} // end if

    94. 

  94. 		return (boolean) FALSE;

    95. 

  95. 	} // end function

    96. 

  96. 

    97. 

  97. 	/**

    98. 

  98. 	* returns a country from a given domainname

    99. 

  99. 	* @param string $host

    100. 

  100. 	* @return mixed

    101. 

  101. 	*/

    102. 

  102. 	protected static function domain2Country($host = '') {

    103. 

  103. 		if (($lastdot = strrpos($host,'.')) < 1) {

    104. 

  104. 			return (boolean) FALSE;

    105. 

  105. 		} // end if

    106. 

  106. 		$parts = split('[.]', $host);

    107. 

  107. 		$domain_name = array_pop($parts);

    108. 

  108. 		/* top level domains (com, org, gov, aero, info)

    109. 

  109. 			or eu-domain are all english */

    110. 

  110. 		if (strlen($domain_name) > 2 || $domain_name === 'eu') {

    111. 

  111. 			return 'en';

    112. 

  112. 		} elseif (strlen($domain_name) == 2) { // country domains

    113. 

  113. 			return $domain_name;

    114. 

  114. 		} // end if

    115. 

  115. 		return (boolean) FALSE;

    116. 

  116. 	} // end function

    117. 

  117. 

    118. 

  118. 	/**

    119. 

  119. 	* adds a given locale to the locales array

    120. 

  120. 	* @param string $locale

    121. 

  121. 	* @return void

    122. 

  122. 	* @uses I18Nlocale::isValidLocaleCode()

    123. 

  123. 	* @uses I18Nlocale::$locales

    124. 

  124. 	* @uses I18Nlocale::$languages

    125. 

  125. 	* @uses I18Nlocale::$countries

    126. 

  126. 	*/

    127. 

  127. 	protected function addLocale($locale = '') {

    128. 

  128. 		if (parent::isValidLocaleCode($locale) == FALSE) {

    129. 

  129. 			return (boolean) FALSE;

    130. 

  130. 		} // endif

    131. 

  131. 		$this->locales[] = strtolower($locale);

    132. 

  132. 		$temp = (array) explode('-', $locale);

    133. 

  133. 		$language = trim($temp[0]);

    134. 

  134. 

    135. 

  135. 		if (parent::isValidLocaleCode($language) === TRUE) {

    136. 

  136. 			$this->languages[] = strtolower($language);

    137. 

  137. 		} // endif

    138. 

  138. 

    139. 

  139. 		if (isset($temp[1]) &&

    140. 

  140. 			parent::isValidLocaleCode(trim($temp[1])) === TRUE) {

    141. 

  141. 			$this->countries[] = strtolower(trim($temp[1]));

    142. 

  142. 		} // end if

    143. 

  143. 	} // end if

    144. 

  144. 

    145. 

  145. 	/**

    146. 

  146. 	* gets the data from the http header request

    147. 

  147. 	* @return boolean

    148. 

  148. 	* @uses I18Nlocale::addLocale()

    149. 

  149. 	* @uses I18Nlocale::$locales

    150. 

  150. 	* @uses I18Nlocale::$languages

    151. 

  151. 	* @uses I18Nlocale::$countries

    152. 

  152. 	*/

    153. 

  153. 	protected function readUserHeader() {

    154. 

  154. 		$client_header = split('[,]', $_SERVER['HTTP_ACCEPT_LANGUAGE']);

    155. 

  155. 

    156. 

  156. 		if (count($client_header) < 1) {

    157. 

  157. 			return (boolean) FALSE;

    158. 

  158. 		} // end if

    159. 

  159. 

    160. 

  160. 		foreach ($client_header as $raw_entry) {

    161. 

  161. 			$temp = split('[;]', $raw_entry);

    162. 

  162. 			$locale = trim($temp[0]);

    163. 

  163. 			$this->addLocale($locale);

    164. 

  164. 		} // end foreach

    165. 

  165. 

    166. 

  166. 		if (is_array($this->languages)) {

    167. 

  167. 			$this->languages = array_unique($this->languages);

    168. 

  168. 		} // end if

    169. 

  169. 

    170. 

  170. 		if (is_array($this->countries)) {

    171. 

  171. 			$this->countries = array_unique($this->countries);

    172. 

  172. 		} // end if

    173. 

  173. 		$_SESSION['i18n']['settings']['tmp_user_locales'] = $this->locales;

    174. 

  174. 		$_SESSION['i18n']['settings']['tmp_user_languages'] = $this->languages;

    175. 

  175. 		return (boolean) TRUE;

    176. 

  176. 	} // end function

    177. 

  177. 

    178. 

  178. 	/**

    179. 

  179. 	* translates the users ip to a domainname

    180. 

  180. 	* @return boolean

    181. 

  181. 	* @uses I18Nlocale::domain2Country()

    182. 

  182. 	* @uses I18Nlocale::$countries

    183. 

  183. 	*/

    184. 

  184. 	protected function readUserIP() {

    185. 

  185. 		$country = $this->domain2Country(gethostbyaddr($_SERVER['REMOTE_ADDR']));

    186. 

  186. 

    187. 

  187. 		if ($country == FALSE) {

    188. 

  188. 			$country = $this->domain2Country($_SERVER['SERVER_NAME']);

    189. 

  189. 		} // end if

    190. 

  190. 

    191. 

  191. 		if ($country == FALSE) {

    192. 

  192. 			return (boolean) FALSE;

    193. 

  193. 		} // end if

    194. 

  194. 

    195. 

  195. 		$this->countries[] = $country;

    196. 

  196. 		$this->countries = array_unique($this->countries);

    197. 

  197. 		$_SESSION['i18n']['settings']['tmp_user_countries'] = $this->countries;

    198. 

  198. 		return (boolean) TRUE;

    199. 

  199. 	} // end function

    200. 

  200. 

    201. 

  201. 	/**

    202. 

  202. 	* creates locale/language/country arrays

    203. 

  203. 	* @return boolean

    204. 

  204. 	* @uses I18Nlocale::$locales

    205. 

  205. 	* @uses I18Nlocale::$use_prefs

    206. 

  206. 	* @uses I18Nbase::getI18Nuser()

    207. 

  207. 	* @uses I18Nlocale::addLocale()

    208. 

  208. 	* @uses I18Nlocale::$languages

    209. 

  209. 	* @uses I18Nlocale::$countries

    210. 

  210. 	* @uses I18Nlocale::readUserHeader()

    211. 

  211. 	* @uses I18Nlocale::readUserIP()

    212. 

  212. 	* @uses I18Nlocale::$translate_ip

    213. 

  213. 	* @uses I18Nbase::getI18NSetting(()

    214. 

  214. 	*/

    215. 

  215. 	protected function setLocaleVars() {

    216. 

  216. 		if (isset($this->locales) && isset($this->locale)) {

    217. 

  217. 			return (boolean) TRUE;

    218. 

  218. 		} // end if

    219. 

  219. 

    220. 

  220. 		if ($this->use_prefs == TRUE && parent::getI18Nuser()->getPrefLocale() != FALSE) {

    221. 

  221. 			$this->addLocale(parent::getI18Nuser()->getPrefLocale());

    222. 

  222. 			$this->countries[] =& parent::getI18Nuser()->getPrefCountry();

    223. 

  223. 			$this->languages[] =& parent::getI18Nuser()->getPrefLanguage();

    224. 

  224. 		} elseif (isset($_SESSION['i18n']['settings']['tmp_user_locales'])) {

    225. 

  225. 			$sess =& $_SESSION['i18n']['settings'];

    226. 

  226. 			$this->locales =& $sess['tmp_user_locales'];

    227. 

  227. 			$this->countries =& $sess['tmp_user_countries'];

    228. 

  228. 			$this->languages =& $sess['tmp_user_languages'];

    229. 

  229. 		} else {

    230. 

  230. 			$this->readUserHeader();

    231. 

  231. 			if (count($this->countries) < 1 && self::TRANSLATE_IP == TRUE) {

    232. 

  232. 				$this->readUserIP();

    233. 

  233. 			} // end if

    234. 

  234. 		} // end if

    235. 

  235. 

    236. 

  236. 		if (count($this->locales) < 1) {

    237. 

  237. 			$this->locale =& parent::getI18NSetting('default_locale');

    238. 

  238. 			$this->country =& parent::getI18NSetting('default_country');

    239. 

  239. 			$this->language =& parent::getI18NSetting('default_language');

    240. 

  240. 			return (boolean) TRUE;

    241. 

  241. 		} // end if

    242. 

  242. 

    243. 

  243. 		$this->locale =& $this->locales[0];

    244. 

  244. 		$this->language =& $this->languages[0];

    245. 

  245. 

    246. 

  246. 		if (count($this->countries) > 0) {

    247. 

  247. 			$this->country =& $this->countries[0];

    248. 

  248. 			return (boolean) TRUE;

    249. 

  249. 		} // end if

    250. 

  250. 		$this->country =& parent::getI18Nsetting('default_country');

    251. 

  251. 		return (boolean) TRUE;

    252. 

  252. 	} // end function

    253. 

  253. 

    254. 

  254. 	/**

    255. 

  255. 	* returns a class var

    256. 

  256. 	* @param string $var

    257. 

  257. 	* @return mixed

    258. 

  258. 	* @uses I18Nlocale::setLocaleVars()

    259. 

  259. 	* @uses I18Nbase::getVar()

    260. 

  260. 	*/

    261. 

  261. 	protected function getVar($var = '') {

    262. 

  262. 		if (!isset($this->$var)) {

    263. 

  263. 			$this->setLocaleVars();

    264. 

  264. 		} // end if

    265. 

  265. 		return parent::getVar($var);

    266. 

  266. 	} // end function

    267. 

  267. 

    268. 

  268. 	/**

    269. 

  269. 	* assigns a value to a class var

    270. 

  270. 	* @param string $data

    271. 

  271. 	* @param string $var

    272. 

  272. 	* @return boolean

    273. 

  273. 	* @uses I18Nlocale::isValidLocaleCode()

    274. 

  274. 	* @uses I18Nbase::setVar()

    275. 

  275. 	*/

    276. 

  276. 	protected function setVar($data = '', $var = '', $type = '') {

    277. 

  277. 		if (parent::isValidLocaleCode($data) == FALSE) {

    278. 

  278. 			return (boolean) FALSE;

    279. 

  279. 		} // end if

    280. 

  280. 		return (boolean) parent::setVar(strtolower($data), $var, 'string');

    281. 

  281. 	} // end function

    282. 

  282. 

    283. 

  283. 	/**#@+

    284. 

  284. 	* assigns a value to a class var

    285. 

  285. 	* @return boolean

    286. 

  286. 	* @uses I18Nlocale::setVar()

    287. 

  287. 	*/

    288. 

  288. 	/**

    289. 

  289. 	* @param string $locale

    290. 

  290. 	*/

    291. 

  291. 	public function setI18NLocale($locale = '') {

    292. 

  292. 		return (boolean) $this->setVar($locale, 'locale');

    293. 

  293. 	} // end function

    294. 

  294. 

    295. 

  295. 	/**

    296. 

  296. 	* @param string $country

    297. 

  297. 	*/

    298. 

  298. 	public function setI18NCountry($country = '') {

    299. 

  299. 		return (boolean) $this->setVar($country, 'country');

    300. 

  300. 	} // end function

    301. 

  301. 

    302. 

  302. 	/**

    303. 

  303. 	* @param string $language

    304. 

  304. 	*/

    305. 

  305. 	public function setI18NLanguage($language = '') {

    306. 

  306. 		return (boolean) $this->setVar($language, 'language');

    307. 

  307. 	} // end function

    308. 

  308. 	/**#@-*/

    309. 

  309. 

    310. 

  310. 	/**#@+

    311. 

  311. 	* returns a class var

    312. 

  312. 	* @return string

    313. 

  313. 	* @uses I18Nlocale::getVar()

    314. 

  314. 	*/

    315. 

  315. 	public function getI18NLocale() {

    316. 

  316. 		return $this->getVar('locale');

    317. 

  317. 	} // end function

    318. 

  318. 

    319. 

  319. 	public function getI18NCountry() {

    320. 

  320. 		return $this->getVar('country');

    321. 

  321. 	} // end function

    322. 

  322. 

    323. 

  323. 	public function getI18NLanguage() {

    324. 

  324. 		return $this->getVar('language');

    325. 

  325. 	} // end function

    326. 

  326. 

    327. 

  327. 	public function getI18NLanguages() {

    328. 

  328. 		return $this->getVar('languages');

    329. 

  329. 	} // end function

    330. 

  330. 

    331. 

  331. 	public function getI18NLocales() {

    332. 

  332. 		return $this->getVar('locales');

    333. 

  333. 	} // end function

    334. 

  334. 	/**#@-*/

    335. 

  335. 

    336. 

  336. 	function __toString() {

    337. 

  337. 		return $this->getI18NLocale();

    338. 

  338. 	} // end function

    339. 

  339. } // end class I18Nlocale

    340. 

  340. ?>
    341.