File Source for idioma.classe.php

<?php
/**
* Provê internacionalização ao framework OpenMind
*
* Busca o idioma a ser utilizado em:
* - Configurações do browser cliente
* - Preferências do usuário (objeto preferências)
* - Configuração
* @see preferencia
* @see i18n_METHOD
*
* Também fornece métodos para recuperação de strings traduzidas e manutenção das mesmas.
*
* @copyright 2008 Soomp
* @author Marcio Merlone <mmerlone@gmail.com>
* @version 0.1
* @since 23/05/2006
* @package i18n
*/
/* $Id: idioma.classe.php,v 1.11 2007/05/29 19:17:25 mmerlone Exp $ */
/**
* Limpa a string de idioma aceita pelo browser, removendo o fator de qualidade, ou seja remove ";q=08"
* @param string idioma aceita pelo browser
* @return string idioma sem o ;q=08 em minúsculas
*/
function trimLang(&$string){
if(strlen($string) > 2){
$string = substr($string, 0, 2);
}
return strtolower($string);
}
require_once(CFG_LOCAL_FRAMEWORK.'model.classe.php');
/**
* Define o algoritmo para definição do idioma
* e métodos para busca de strings conforme mecanismo solicitado no config.
* A preferência de idioma será salva em $_SESSION['lang'] sempre.
* Cada objeto que utilizar esta informção definirá sua própria variável
* (ex: smarty: $sm->strLang;)
* <code>
* require_once('idioma.classe.php');
* $idioma = new idioma();
* $string = $idioma->getString(array('id' => 9, 'value' => 'Texto a ser traduzido'));
* $string2 = $idioma->getString(2);
* </code>
* @todo Implementar mecanismos plain, hash e xml
* @todo Implementar métodos get/set para manutenção de strings
* @author Marcio Merlone <mmerlone@gmail.com>
*/
class idioma extends model{
/**
* @var string $_strTable nome da tabela com os dados
*/
protected $_strTable = 'TB_IDIOMA';
/**
* @var string $_strFldPk nome do campo com o pk
*/
protected $_strFldPk = 'PK_I18N';
/**
* @var string $_strFldNo nome do campo com o nome
*/
protected $_strFldNo = 'NO_I18N';
/**
* @var boolean $_boolUserDb define se deve-se utilizar a conexão db de usuários
*/
protected $_boolUserDb = false;
/**
* @var string $strOrdCampo campo padrão de ordenação
*/
public $strOrdCampo = 'NO_I18N';
/**
* @var string $strLang armazena a string com o idioma a ser utilizado
* $_SERVER['HTTP_ACCEPT_LANGUAGE'] = "pt-br,pt;q=0.8,en-us;q=0.5,en;q=0.3"
* Pode vir do browser, do config ou das preferências.
* @link http://www.ietf.org/rfc/rfc3066.txt
*/
public $strLang = 'pt';
/**
* @var string $strLangTpl armazena a string com o idioma a ser utilizado caso não seja encontrada
* a localização de alguma string específica para $this->strLang (provavelmente sempre pt)
* É o idioma do template.
* @uses i18n_TPL
*/
public $strLangTpl = i18n_TPL;
/**
* @var array Armazena o array com a intersecção das línguas definidas no browser com as disponíveis
*/
private $_arrLangs = array();
/**
* @var bool $_default se é definido i18n_LANG no config ou não - [true|false]
*/
private $_default;
/**
* @var string Armazena o método para escolha de idioma - [browser|pref|config|'null']
* Se nulo desabilita internacionalização
*/
private $_method;
/**
* @var string Armazena o método de armazenamento de idiomas - [db|php|plain|hash|xml]
* caso nulo implica em não internacionlização
*/
private $_store;
/**
* @var string armazena a origem efetiva da string $this->strLang - read-only, para debug
*/
private $_origin;
/**
* @var object $instance instância da classe
*/
private static $instance = null;
/**
* Define o idioma a ser utilizado pelo framework
* @uses i18n_METHOD
* @uses i18n_STORE
* @uses _setLang
*/
public function __construct() {
parent::__construct();
if(defined('i18n_METHOD') && !is_null(i18n_METHOD) && i18n_METHOD != ''){
$this->_setMethod();
$this->_setStorage();
$this->_default = (defined('i18n_LANG') && !is_null(i18n_LANG) && i18n_LANG != '') ? true : false;
$this->_setLang();
}
}
/**
* Singleton
*/
public static function getInstance(){
if (is_null(self::$instance)){
if(isset($_SESSION['idioma'])){
self::$instance = unserialize($_SESSION['idioma']);
}else{
self::$instance = new idioma();
}
}
return self::$instance;
}
/**
* Busca a tradução de um texto conforme método definido no config.
* Caso não exista tradução, usa-se o 'value' do array
* Também efetua substituição de variáveis na string desde que exista
* 'vars' => array('var' => 'value') dentro de $arrI18n.
*
* @param mixed $arrI18n array com os dados para busca da string ou uma string
* @param string $strLang idioma a buscar
* @return string texto traduzido se possível
* @uses i18n_STORE
* @uses _getStringDb
* @uses _getStringPhp
*
* Formato de $arrI18n:
* <code>
* $arrI18n = array('id' => 23, 'value' => 'Texto a traduzir com $var1', 'vars' => array('var1' => 'valor1'))
* </code>
*/
public function getString($arrI18n, $strLang = null){
$strLang = is_null($strLang) ? $this->strLang : $strLang;
/**
* Caso $this->_store == null ou não definido usa-se pt e não considera internacionalização
*/
if($this->_store){
switch(i18n_STORE){
case 'db':
$i18n = $this->_getStringDb($arrI18n, $strLang);
break;
case 'php':
$i18n = $this->_getStringPhp($arrI18n, $strLang);
break;
case 'plain':
trigger_error('getString: Método de armazenamento de idiomas "'.i18n_STORE.'" ainda não foi implementado.', E_USER_WARNING);
$this->_method = null;
$i18n = null;
break;
case 'hash':
trigger_error('getString: Método de armazenamento de idiomas "'.i18n_STORE.'" ainda não foi implementado.', E_USER_WARNING);
$this->_method = null;
$i18n = null;
break;
case 'xml':
trigger_error('getString: Método de armazenamento de idiomas "'.i18n_STORE.'" ainda não foi implementado.', E_USER_WARNING);
$this->_method = null;
$i18n = null;
break;
}
}else{
$i18n = null;
}
/**
* Trata retorno null
*/
if(is_null($i18n)){
if(is_array($arrI18n)){
$i18n = $arrI18n['value'];
}else{
$i18n = $arrI18n;
}
}
/**
* Substitui variáveis caso existam
*/
if(isset($arrI18n['vars']) && is_array($arrI18n['vars']) && !empty($arrI18n['vars'])){
$i18n = compileString($arrI18n['vars'], $i18n);
}
return $i18n;
}
/**
* Valida a string armazenada no config em i18n_METHOD
*/
private function _setMethod(){
$arrMethods = array('browser' => 1,
'pref' => 1,
'config' => 1);
if(isset($arrMethods[i18n_METHOD])){
$this->_method = i18n_METHOD;
}else{
trigger_error('__construct: Método de detecção de idioma "'.i18n_METHOD.'" não existe - verifique o config.php!', E_USER_WARNING);
$this->_method = 'browser'; // Usa do browser pois é o mais provável que sempre exista.
}
}
/**
* Valida a string armazenada no config em i18n_STORE
*/
private function _setStorage(){
$arrStores = array('db' => 1,
'php' => 1,
'plain' => 1,
'hash' => 1,
'xml' => 1);
if((defined('i18n_STORE') && isset($arrStores[i18n_STORE])) || is_null(i18n_STORE)){
$this->_store = i18n_STORE;
}else{
trigger_error('__construct: Método de armazenamento de idioma "'.i18n_STORE.'" não existe - verifique o config.php! Desabilitando funções de internacionalização.', E_USER_WARNING);
$this->_store = null; // Nulo implica em não internacionlização
}
}
/**
* Determina o idioma a ser utilizado
* @uses getLangs
* @uses i18n_LANG
* @uses trimLang
*/
private function _setLang(){
if($this->_store){
if($this->_method == 'browser'){
$arrBrowserAcceptLang = explode(',', $_SERVER['HTTP_ACCEPT_LANGUAGE']);
array_walk($arrBrowserAcceptLang, 'trimLang');
$this->_arrLangs = array_values(array_intersect($arrBrowserAcceptLang, $this->getLangs()));
/**
* Define como o primeiro idioma em comum entre as disponíveis
* e o solicitado pelo browser
*/
if(!empty($this->_arrLangs)){
$this->strLang = $this->_arrLangs[0];
$this->_origin = 'browser';
/**
* Utiliza o idioma default configurado
*/
}elseif($this->_default){
$this->strLang = i18n_LANG;
$this->_origin = 'browser -> i18n_LANG';
/**
* Utiliza o idioma dos templates
*/
}else{
$this->strLang = $this->strLangTpl;
$this->_origin = 'browser -> fallback';
}
/**
* Utiliza o idioma default configurado
*/
}elseif($this->_method == 'config' && $this->_default){
$this->strLang = i18n_LANG;
$this->_origin = 'config';
}else{
trigger_error('_setLang: O método para definição de idioma "'.$this->_method.'" falhou, usando '.$this->strLangTpl, E_USER_WARNING);
$this->strLang = $this->strLangTpl;
$this->_origin = 'falha';
}
}else{
$this->strLang = $this->strLangTpl;
}
}
/*****************************************************************************
*
* Métodos auxiliares de definição de idiomas
*
* Conforme o mecanismo de definição de idioma no config.php i18n_METHOD
* busca os idiomas disponíveis no projeto. São métodos auxiliares do método
* privado principal getLangs.
* Devem sempre retornar um array comum com as strings dos idiomas suportados
* como valores do array.
*
*/
/**
* Retorna as localizações disponíveis no framework/projeto
* @return array Array com os idiomas disponíveis para o framework
* @uses _getLangsDb
* @uses _getLangsPhp
* @uses i18n_STORE
* @uses i18n_TPL
*/
public function getLangs(){
/**
* @todo implementar mecanismo cfme armazenamento das linguas disponiveis
*/
$arrRet = array(i18n_TPL);
switch(i18n_STORE){
case 'db':
$this->_getLangsDb($arrRet);
break;
case 'php':
$this->_getLangsPhp($arrRet);
break;
case 'plain':
trigger_error('getLangs: Método de armazenamento de idiomas "'.i18n_STORE.'" ainda não foi implementado. Usando o texto original.', E_USER_WARNING);
break;
case 'hash':
trigger_error('getLangs: Método de armazenamento de idiomas "'.i18n_STORE.'" ainda não foi implementado. Usando o texto original.', E_USER_WARNING);
break;
case 'xml':
trigger_error('getLangs: Método de armazenamento de idiomas "'.i18n_STORE.'" ainda não foi implementado. Usando o texto original.', E_USER_WARNING);
break;
}
return $arrRet;
}
/**
* Coleta os idiomas disponíveis no banco de dados
* @param array $arrRet por referência o array atual com as strings de idiomas.
* @uses i18n_STORE_DB_WHERE
* @uses i18n_STORE_DB_TABLE
*/
private function _getLangsDb(&$arrRet){
if($db = &$this->getDb()){
$qry = 'SELECT DISTINCT(LANG_i18N) FROM TB_IDIOMA';
if($arrLangs = $db->GetAll($qry)){
foreach($arrLangs as $arrTmp){
if(!in_array($arrTmp['LANG_i18N'], $arrRet)){
array_push($arrRet, $arrTmp['LANG_i18N']);
}
}
}
}else{
trigger_error('_getStringDb: Erro ao conectar no banco de dados.', E_USER_WARNING);
}
}
/**
* Retorna os idiomas disponíveis em arquivos php
* @param array $arrRet Array com as strings de idiomas suportadas
* @uses i18N_STORE_PHP_FILE
*/
private function _getLangsPhp(&$arrRet){
if(defined('i18N_STORE_PHP_FILE') && !is_null(i18N_STORE_PHP_FILE) && i18N_STORE_PHP_FILE != ''){
$langDir = dirname(i18N_STORE_PHP_FILE);
if (is_dir($langDir) && $handle = opendir($langDir)) {
$re = '/'.str_replace('LANG', '(.*)', addcslashes(basename(i18N_STORE_PHP_FILE), './+-')).'/';
while (false !== ($file = readdir($handle))) {
if ($file != "." && $file != ".." && filesize($langDir.'/'.$file) > 0) {
preg_match($re, $file, $match);
if(!empty($match) && !in_array($match[1], $arrRet)){
array_push($arrRet, $match[1]);
}
}
}
closedir($handle);
}else{
trigger_error('O diretório '.$langDir.' não existe!', E_USER_WARNING);
}
}else{
trigger_error('getLangs: Defina i18N_STORE_PHP_FILE no config.php. Desabilitando internacionalização.', E_USER_WARNING);
$this->_method = null;
}
}
/*****************************************************************************
*
* Métodos auxiliares de busca de texto
*
* São sub-métodos auxiliares do método principal getString
* Cada método é implementado de acordo com os mecanismos de
* busca de strings i18n_METHOD
*
* Cada método SEMPRE receberá 2 parâmetros:
* - $arrI18n = array com os dados para busca da string
* - $strLang = idioma para o qual buscar a i18n
*
* Cada método deverá sempre retornar uma de duas possibilidades:
* - A string traduzida para o idioma solicitado OU
* - NULL caso não encontre a tradução. O método público getString
* irá tratar a ausência de tradução.
*
*/
/**
* Busca a tradução de um texto utilizando o banco de dados dado o ID ou o TEXTO
* a ser traduzido. Se omitido 'id', usa 'value' para busca.
*
* @param mixed $arrI18n array com os dados para busca da string ou a própria string
* @param string idioma a ser utilizado
* @return string texto traduzido se possível ou null
* @uses i18n_STORE_DB_PK
* @uses i18n_STORE_DB_NO
* @uses i18n_STORE_DB_STR
* @uses i18n_STORE_DB_TABLE
* @uses i18n_STORE_DB_WHERE
* Formato de $arrI18n:
* <code>
* $arrI18n = array('id' => 23, 'value' => 'texto a traduzir')
* </code>
*/
private function _getStringDb($arrI18n, $strLang){
if($db = &$this->getDb()){
if(is_array($arrI18n)){
if(isset($arrI18n['id']) && $arrI18n['id']){
$campo = 'PK_I18N';
$where = $arrI18n['id'];
}else{
$campo = 'NO_I18N';
$where = $db->qstr($arrI18n['value']);
}
}else{
$campo = 'NO_I18N';
$where = $db->qstr($arrI18n);
}
$qry = 'SELECT LO_I18N FROM TB_IDIOMA WHERE '.$campo.'="'.$where.'" AND LANG_I18N ="'.$strLang.'"';
$arrRet = $db->GetRow($qry);
return isset($arrRet['LO_I18N']) ? $arrRet['LO_I18N'] : null;
}else{
trigger_error('_getStringDb: Erro ao conectar no banco de dados.', E_USER_WARNING);
return null;
}
}
/**
* Busca a tradução de um texto utilizando um arquivo php dado o ID a ser traduzido
* Este método não suporta busca pelo TEXTO.
*
* @param mixed $arrI18n array com os dados para busca da string ou a própria string
* @param string idioma a ser utilizado
* @return string texto traduzido se possível ou null
* @uses CFG_DEBUG
* @uses i18N_STORE_PHP_FILE
*/
private function _getStringPhp($arrI18n, $strLang){
/**
* $_SESSION[$strLang] armazena o array com as strings l10n array(id => 'texto');
*/
if(is_numeric($arrI18n)){
$i = $arrI18n;
}elseif(is_array($arrI18n)){
$i = $arrI18n['id'];
}else{
return null;
}
if(!isset($_SESSION[$strLang]) || (defined('CFG_DEBUG') && !CFG_DEBUG)){
if(defined('i18N_STORE_PHP_FILE') && !is_null(i18N_STORE_PHP_FILE) && i18N_STORE_PHP_FILE != ''){
$file = str_replace('LANG', $strLang, i18N_STORE_PHP_FILE);
if(is_file($file)){
require_once($file);
if(isset($arrStrings) && !empty($arrStrings)){
$_SESSION[$strLang] = $arrStrings;
}
}else{
trigger_error('_getStringPhp: Arquivo de idiomas "'.$file.'" não encontrado! Verifique i18N_STORE_PHP_FILE no config.php.', E_USER_WARNING);
}
}else{
trigger_error('_getStringPhp: Defina i18N_STORE_PHP_FILE no config.php. Desabilitando internacionalização.', E_USER_WARNING);
$this->_method = null;
}
}
return isset($_SESSION[$strLang][$i]) ? $_SESSION[$strLang][$i] : null;
}
}
?>

Documentation generated on Sun, 09 Mar 2008 23:52:12 -0300 by phpDocumentor 1.4.0

Source for file idioma.classe.php