phpTranslator
[ class tree: phpTranslator ] [ index: phpTranslator ] [ all elements ]
Packages:
phpTranslator


Files:
Translator.php

Classes:
Translator

Class: Translator

Source Location: /Translator.php

Class Overview




Classe para realizar a traducao de um texto com base em arquivos pre-definidos




Author(s):






    








Methods
























Class Details



[line 102]

Classe para realizar a traducao de um texto com base em arquivos pre-definidos

As aplicacoes baseadas nessa classe deverao adaptar-se ao modo como esta classe 
  monta os arquivos de idiomas e seus requisitos de codificacao de idioma.
Um exemplo de como usar a classe:  
  1.  define(TRANSLATOR_PATH, "../include/phpTranslator/");
    2. 

  2.  define(TRANSLATOR_PATH_URL, "../include/phpTranslator/");
    3. 

  3.  
    4. 

  4.  if(!@include_once( TRANSLATOR_PATH.'/Translator.php'))
    5. 

  5.    echo "<h1>There is a trouble with phpTranslator package.
    6. 

  6.               It isn't found.</h1>";
    7. 

  7.  
    8. 

  8.  $_objTranslator = new Translator( USER_LOCALE );
    9. 

  9.  
    10. 

  10.  $_objTranslator->setLangFilePath("/myapplic_path_lang_files/");
    11. 

  11.  $_objTranslator->setURLPath(TRANSLATOR_PATH_URL);
    12. 

  12.  $_objTranslator->buildLangArray();
    13. 

  13.  $_objTranslator->buildLangArray('target');
    14. 

  14.  if(CODING)
    15. 

  15.    $_objTranslator->Translate(false);
    16. 

  16.  elseif(TRANSLATING)
    17. 

  17.    $_objTranslator->Translate();
    18. 

  18.  else
    19. 

  19.    echo $_objTranslator->getText('some text to translate and
    20. 

  20.                          be showed after had been registred.');
    21. 






Tags:





  

    author:  Adriano dos Santos Vieira (harpiain) <harpiain@users.sourceforge.net>
  










[ Top ]








Class Methods



  

	
	
constructor Translator [line 342]

	

    

    

		Translator Translator(
[string
$_abbr_i18n_tgt = ''], [string
$_abbr_i18n_src = 'en'])
    

    


	
		Metodo contrutor para realizar a traducao de um texto com base em arquivos pre-definidos





Tags:





  

    name:  Translator
  

  

    access:  public
  










        
Parameters:

    

    

          

        string  
        $_abbr_i18n_tgt  
        - Deve ser informado o idioma destino para a aplicacao
      

          

        string  
        $_abbr_i18n_src  
        - Deve ser informado o idioma padrao da aplicacao                                   (se nao informado sera conciderado "en" = English)
      

        

    


        
[ Top ]

  

  

	
	
method buildLangArray [line 821]

	

    

    

		void buildLangArray(
[string
$_lang_choice = 'standard'])
    

    


	
		Le os arquivos de idioma e os armazena em array especificos (padrao ou destino)






        
Parameters:

    

    

          

        string  
        $_lang_choice  
        Qual o padrao a ser lido e armazenado
                                     . standard - o padrao para a aplicacao
                                     . target   - o idioma a ser mostrado para o usuario

      

        

    


        
[ Top ]

  

  

	
	
method getMessage [line 641]

	

    

    

		void getMessage(
)
    

    


	
		Metodo para retornar a mensagens de erros ocorridas





Tags:





  

    name:  getMessage
  

  

    access:  public
  










        
[ Top ]

  

  

	
	
method getText [line 622]

	

    

    

		string getText(
string
$_msg_code, [boolean
$_sigla = false], [boolean
$_text_case = 0])
    

    


	
		Busca o texto a ser traduzido

Busca a traducao do texto - caso o texto traduzido nao exista retorna o texto padrao e caso este  tambem nao exista retorna o codigo de pesquisa





Tags:





  

    return:  O texto traduzido, o texto padrao ou o codigo da mensagem
  










        
Parameters:

    

    

          

        string  
        $_msg_code  
        O codigo da mensagem a ser traduzida
      

          

        boolean  
        $_sigla  
        Se retorna a sigla em lugar da mensagem completa
      

          

        boolean  
        $_text_case  
        Se o texto retorna o texto como cadastrado, em maiusculas ou minusculas 
  1. - maiuscula
  2. - minuscula
                                          outro - como estiver cadastrado		
      

        

    


        
[ Top ]

  

  

	
	
method isError [line 652]

	

    

    

		boolean isError(
)
    

    


	
		Metodo para retornar se houve erro ou nao na classe





Tags:





  

    return:  TRUE  - houve erro ao processar a classe                              FALSE - nao houve erro
  

  

    access:  public
  










        
[ Top ]

  

  

	
	
method setActiveSection [line 1333]

	

    

    

		void setActiveSection(
[string
$_activeSection = ""])
    

    


	
		Atribui a secao ativa a ser mostrada a TAG em "showTagHeader"





Tags:





  

    access:  public
  










        
Parameters:

    

    

          

        string  
        $_activeSection  
        O nome da seccao ativa (ex: admin ou setup)                                  Obs: Deve ser o nome interno e nao a traducao
      

        

    


        
[ Top ]

  

  

	
	
method setLangFilePath [line 692]

	

    

    

		void setLangFilePath(
[string
$_language_file_path = ""])
    

    


	
		Atribui o caminho fisico para os arquivos de idiomas






        
Parameters:

    

    

          

        string  
        $_language_file_path  
        O caminho para os arquivos de idiomas
      

        

    


        
[ Top ]

  

  

	
	
method setLangFilePrefix [line 782]

	

    

    

		void setLangFilePrefix(
[string
$_file_prefix = ""])
    

    


	
		Atribui o prefixo para o arquivo de idiomas






        
Parameters:

    

    

          

        string  
        $_file_prefix  
        O prefixo a ser atribuido ao arquivo
      

        

    


        
[ Top ]

  

  

	
	
method setLangFileSections [line 675]

	

    

    

		void setLangFileSections(
[mixed
$_language_sections = array()], string
$_language_file_path)
    

    


	
		Atribui o caminho fisico para os arquivos de idiomas

devera conter as secoes dos arquivos de idiomas, conforme contextualizacao  
  1.   ...
    2. 

  2.   $_lang_sections = array(
    3. 

  3.                       'phpTranslator' => 'textos da classe de traducao',
    4. 

  4.                       'admin'             => 'Textos da secao administrativa',
    5. 

  5.                       'home'              => 'textos da secao principal',
    6. 

  6.                       'and son on'      => 'e assim por diante...');
    7. 

  7.  
    8. 

  8.   $objTranslator->setLangFileSections($_lang_sections);
    9. 

  9.   ...
    10. 






Tags:





  

    since:  v 0.2.0-40
  










        
Parameters:

    

    

          

        string  
        $_language_file_path  
        O caminho para os arquivos de idiomas
      

        

    


        
[ Top ]

  

  

	
	
method setLangFilesInSections [line 1323]

	

    

    

		void setLangFilesInSections(
[boolean
$_filesInSections = false])
    

    


	
		Atribui que os arquivos de idiomas serao seccionados conforme contextualizacao





Tags:





  

    access:  public
  










        
Parameters:

    

    

          

        boolean  
        $_filesInSections  
        TRUE - seccionados                                    FALSE -  nao seccionados (default)
      

        

    


        
[ Top ]

  

  

	
	
method setLangFilesInSubDirs [line 1313]

	

    

    

		void setLangFilesInSubDirs(
[boolean
$_filesInSubDirs = false])
    

    


	
		Atribui que o caminho dos arquivos de idiomas ficarao em subdiretorios abbrI18N





Tags:





  

    access:  public
  










        
Parameters:

    

    

          

        boolean  
        $_filesInSubDirs  
        TRUE - em subdiretorio abbrI18N                                    FALSE - sem subdiretorio abbrI18N (default)
      

        

    


        
[ Top ]

  

  

	
	
method setLangFileSufix [line 772]

	

    

    

		void setLangFileSufix(
[string
$_file_sufix = ""])
    

    


	
		Atribui o sufixo para o arquivo de idiomas






        
Parameters:

    

    

          

        string  
        $_file_sufix  
        O sufixo a ser atribuido ao arquivo
      

        

    


        
[ Top ]

  

  

	
	
method setURLPath [line 762]

	

    

    

		void setURLPath(
[string
$_translator_url_path = ""])
    

    


	
		Atribui o caminho (URL) para a classe





Tags:





  

    since:  v 0.2.0-40
  










        
Parameters:

    

    

          

        string  
        $_translator_url_path  
        A URL para a classe
      

        

    


        
[ Top ]

  

  

	
	
method Translate [line 377]

	

    

    

		void Translate(
[boolean
$_translate_only = true])
    

    


	
		Prove a interface de cadastramento de codigos de mensagems ou a de traducao






        
Parameters:

    

    

          

        boolean  
        $_translate_only  
        FALSE - Se apenas para traduzir                                   TRUE - tambem para fazer manutencao (default)
      

        

    


        
[ Top ]

  






        

		    

		    Documentation generated on Fri, 10 Mar 2006 20:00:17 -0300 by phpDocumentor 1.3.0RC4