PtBR:Documentação 0.5

Contents 1 Configuração inicial 1.1 require() 1.2 xajax() 1.3 registerFunction() 2 xajax.inc.php 2.1 getVersion() 2.2 setFlag() 2.3 getFlag() 2.4 setTimeout() 2.5 getTimeout() 2.6 setWrapperPrefix() 2.7 getWrapperPrefix() 2.8 setLogFile() 2.9 getLogFile() 2.10 setCharEncoding() 2.11 getCharEncoding() 2.12 registerEvent() 2.13 canProcessRequest() 2.14 getRequestMode() 2.15 processRequest() 2.16 printJavascript() 2.17 getJavascript() 2.18 getJavascriptConfig() 2.19 getJavascriptInclude() 2.20 autoCompressJavascript() 2.21 _detectURI() 3 xajaxResponse.inc.php 3.1 assign() 3.2 append() 3.3 prepend() 3.4 replace() 3.5 clear() 3.6 alert() 3.7 redirect() 3.8 script() 3.9 call() 3.10 remove() 3.11 create() 3.12 insert() 3.13 insertAfter() 3.14 createInput() 3.15 insertInput() 3.16 insertInputAfter() 3.17 addEvent() 3.18 addHandler() 3.19 removeHandler() 3.20 includeScript() 3.21 includeScriptOnce() 3.22 includeCSS() 3.23 getContentType() 3.24 getOutput() 3.25 getCommandCount() 3.26 loadCommands()

[edit] Configuração inicial

[edit] require()

Inicia o script xajax.

require('xajax_core/xajax.inc.php')

[edit] xajax()

Configura o objeto xajax e o sistema de plugins

$xajax = new xajax($sRequisiçãoURI)

• string $sRequisiçãoURI: URI de requisição opcional; padrão para o URI do navegador corrente

[edit] registerFunction()

Registra uma função ou método PHP para ser acessado por seu JavaScript com o xajax.

Se você deseja registrar uma função, coloque o nome desta função. Se você deseja registrar um método estático de uma classe, coloque em um array assim: array("nomeMinhaFunção", "minhaClasse", "meuMétodo"). Para métodos de objetos instanciados, utilize uma variável objeto para o segundo elemento do array (e no PHP 4 tenha certeza de colocar um & antes da variável para passar o objeto como referência). Nota: o nome da função é o que você deve chamar via JavaScript, então isso pode ser qualquer coisa contanto que não conflita com nenhuma outra função registrada.

$xajax->registerFunction($nomeMinhaFunção,$stringArquivoParaIncluir=null)

• mixed $nomeMinhaFunção: contém o nome da função ou um objeto array-string de retorno
• string $stringArquivoParaIncluir: opcional; um arquivo externo PHP para ser incluído antes da função ser chamada.

[edit] xajax.inc.php

[edit] getVersion()

Retorna a versão atual do xajax.

$xajax->getVersion()

[edit] setFlag()

Seta um sinalizador (Flag) (booleano true ou false).

Padrões

• debug: false
• statusMessages: false
• waitCursor: true
• exitAllowed: true
• errorHandler: false
• cleanBuffer: false
• decodeUTF8Input: false
• outputEntities: false
• allowBlankResponse: false

$xajax->setFlag($nome,$valor)

• string $nome: nome do sinalizador
• boolean $valor: se true seta o sinalizador

[edit] getFlag()

Retorna o valor de um sinalizador booleano, retorna true ou false para este sinalizador

$xajax->getFlag($nome)

• string $nome: nome do sinalizador

[edit] setTimeout()

Ajusta um tempo de espera antes que o xajax notifique o cliente que o xajax não foi carregado

$xajax->setTimeout($iTempodeEspera)

• integer $iTempoDeEspera: o número de milisegundos, ou 0 para desativar

[edit] getTimeout()

Retorna o tempo de espera do xajax

retorna um número inteiro dos milisegundos (ou 0 se desativado)

$xajax->getTimeout()

[edit] setWrapperPrefix()

Ajusta o prefixo adicionado ao wrapper do JavaScript

$xajax->setWrapperPrefix($sPrefixo)

• string $sPrefixo: nome do wrapper, (o padrão é "xajax_").

[edit] getWrapperPrefix()

Retorna o prefixo do wrapper

$xajax->getWrapperPrefix()

[edit] setLogFile()

Especifica um arquivo de registro (log) que seja escrito pelo xajax durante uma requisição

Usado somente quando o sistema de manipulação de erro estiver ativo. Se você não invocar este método, ou você passar "", nenhum arquivo de registro será escrito.

$xajax->setLogFile($sNomeDoArquivo)

• string $sNomeDoArquivo: nome do arquivo de registro.

[edit] getLogFile()

Retorna o arquivo de registro para mostrar os erros

retorna uma string ou "" se o arquivo não foi escrito.

$xajax->getLogFile()

[edit] setCharEncoding()

Ajusta a codificação do conjunto de caracteres utilizado na resposta HTTP

$xajax->setCharEncoding($sCodificação)

• string $sCodificação: a codificação a ser utilizada (utf-8, iso-8859-1, etc.)

[edit] getCharEncoding()

Retorna o conjunto de caracteres codificado utilizado na saída HTTP

$xajax->getCharEncoding()

[edit] registerEvent()

Registra uma chamada de retorno com um evento xajax.

Eventos disponíveis são:

• beforeProcessing -- ocorre antes do processamento da requisição
• afterProcessing -- ocorre após o processamento da requisição
• onMissingFunction -- ocorre se não encontrar o método/função de tratamento
• onProcessingError -- ocorre se houver erro durante o processamento de uma requisição

$xajax->registerEvent($mChamadaDeRetorno, $sNomeDoEvento)

• mixed $mChamadaDeRetorno: função ou objeto padrão PHP de retorno
• string $sNomeDoEvento: nome do evento

[edit] canProcessRequest()

Retorna true se o xajax consegue processar requições e false do contrário.

Você pode usar isso para determinar se o xajax precisa processar uma requisição ou não. 
(executa o plugin de processamento de requisições)

$xajax->canProcessRequest()

[edit] getRequestMode()

Retorna o modo de requisição corrente

(XAJAX_GET ou XAJAX_POST), ou -1 se não foi definido. (executa o plugin processador de requisições)

$xajax->getRequestMode()

[edit] processRequest()

Este é o mecanismo de comunicação principal do xajax.

o mecanismo trata todos as chamadas de requisições do xajax, chama as funções apropriadas do PHP (ou métodos da classe/objeto) e retorna a resposta para processador de respostas JavaScript. Se seu recurso de tratamento de requisições for o mesmo que exibe sua página então esta função deve ser chamada antes que todos os cabeçalhos ou códigos HTML sejam emitidos. (executa o plugin processador de requisições)

$xajax->processRequest()

[edit] printJavascript()

Imprime o cabeçalho do código JavaScript do xajax.

Isto só deve ser chamado entre as tags:

<head> </head>

de sua página HTML. Lembre-se, se você somente deseja o resultado desta função, use getJavascript().
(executa a inclusão do plugin Javascript)

$xajax->printJavascript($sEndereçoURIdoJavaScript="", $sArquivoJavaScript=NULL)

• string $sEndereçoURIdoJavaScript: o endereço relativo do diretório onde o xajax foi instalado. Por exemplo, se seu arquivo PHP é http://www.meuservidor.com.br/meudiretorio/minhapagina.php e o xajax foi instalado em http://www.meuservidor.com.br/outrodiretorio, então $sEndereçoURIdoJavaScript poderá ser "../outrodiretorio". Por padrão assume que o xajax foi instalado no mesmo diretório do seu arquivo PHP.
• string $sArquivoJavaScript: o par diretório relativo/arquivo do mecanismo JavaScript do xajax localizado dentro do diretório de instalação do xajax. O padrão é xajax_js/xajax.js.

[edit] getJavascript()

Retorna o conteúdo do código JavaScript do xajax

Pode ser incluido entre as tags <head> </head>. (executa o plugin de inclusão Javascript)

$xajax->getJavascript($sEndereçoURIdoJavaScript="", $sArquivoJavaScript=NULL)

• string $sEndereçoURIdoJavaScript: o endereço relativo do diretório onde o xajax foi instalado. Por exemplo, se seu arquivo PHP é http://www.meuservidor.com.br/meudiretorio/minhapagina.php e o xajax foi instalado em http://www.meuservidor.com.br/outrodiretorio, então $sEndereçoURIdoJavaScript poderá ser "../outrodiretorio". Por padrão assume que o xajax foi instalado no mesmo diretório do seu arquivo PHP.
• string $sArquivoJavaScript: o par diretório relativo/arquivo do mecanismo JavaScript do xajax localizado dentro do diretório de instalação do xajax. O padrão é xajax_js/xajax.js.

[edit] getJavascriptConfig()

Retorna uma string contendo o JavaScript de configuração em tempo de execução do xajax

tipicamente chamada internamente pelo xajax em get/printJavascript). (executa a inclusão do plugin JavaScript)

$xajax->getJavascriptConfig()

[edit] getJavascriptInclude()

Retorna uma string com o código HTML para incluir o arquivo xajax.js

Uma verificação para saber se o arquivo foi carregado após x segundos. Tipicamente chamado internamente por get/printJavascript. (executa a inclusão do plugin JavaScript)

$xajax->getJavascriptInclude($sEndereçoURIdoJavaScript="", $sArquivoJavaScript=NULL)

• string $sEndereçoURIdoJavaScript: o endereço relativo do diretório onde o xajax foi instalado. Por exemplo, se seu arquivo PHP é http://www.meuservidor.com.br/meudiretorio/minhapagina.php e o xajax foi instalado em http://www.meuservidor.com.br/outrodiretorio, então $sEndereçoURIdoJavaScript poderá ser "../outrodiretorio". Por padrão assume que o xajax foi instalado no mesmo diretório do seu arquivo PHP.
• string $sArquivoJavaScript: o par diretório relativo/arquivo do mecanismo JavaScript do xajax localizado dentro do diretório de instalação do xajax. O padrão é xajax_js/xajax.js.

[edit] autoCompressJavascript()

cria um novo arquivo xajax.js apartir do arquivo xajax_uncompressed.js

Ocorre somente se o arquivo xajax.js já não existir no sistema de arquivos

$xajax->autoCompressJavascript($sJsNomeCompletoDoArquivo=NULL)

• string $sJsNomeCompletoDoArquivo: um argumento opcional contendo o caminho completo para o arquivo xajax.js.

[edit] _detectURI()

Retorna a URL corrente apartir das variáveis SERVER.

retorna uma string

$xajax->_detectURI()

[edit] xajaxResponse.inc.php

[edit] assign()

Inclui um comando na mensagem de resposta. Sobrescreve o conteúdo de um elemento especificado.

$objDeResposta->assign($sDestino,$sAtributo,$sDados)

• string $sDestino: contém o id de um elemento HTML.
• string $sAtributo: a parte do elemento que você deseja modificar. innerHTML,value etc..
• string $sDados: os dados que você deseja definir para a parte.

[edit] append()

Inclui uma mensagem de comando a resposta. Anexa após o conteúdo do elemento especificado.

$objDeResposta->append($sDestino,$sAtributo,$sDados)

• string $sDestino: contém o id de um elemento HTML.
• string $sAtributo: a parte do elemento que você deseja modificar. innerHTML,value etc..
• string $sDados: os dados que você deseja anexar à parte.

[edit] prepend()

Inclui uma mensagem de comando a resposta. Anexa ao inicio do conteúdo do elemento especificado.

$objDeResposta->prepend($sDestino,$sAtributo,$sDados)

• string $sDestino: contém o id de um elemento HTML.
• string $sAtributo: a parte do elemento que você deseja modificar. innerHTML,value etc..
• string $sDados: os dados que você deseja pré-anexar à parte.

[edit] replace()

Inclui uma mensagem de comando a resposta. Substitui a string especificada no conteúdo do elemento especificado.

$objDeResposta->replace($sDestino,$sAtributo,$sPesquisa,$sDados)

• string $sDestino: contém o id de um elemento HTML.
• string $sAtributo: a parte do elemento que você deseja modificar. innerHTML,value etc..
• string $sPesquisa: a string que deve ser procurada.
• string $sDados: a string que deve substituir a original.

[edit] clear()

Inclui uma mensagem de comando para limpar a resposta. Limpa o conteúdo do atributo especificado

$objDeResposta->clear($sDestino,$sAtributo)

• string $sDestino: contém o id de um elemento HTML.
• string sAtributo: a parte do elemento que você deseja modificar. innerHTML,value etc..

[edit] alert()

Inclui uma mensagem de comando de alerta a resposta.

$objDeResposta->alert($sMsg)

• string $sMsg: o texto que deve ser exibido na mensagem de alerta.

[edit] redirect()

Redireciona para uma outra URL

$objDeResposta->redirect($sURL, $iEspera=0)

• string $sURL: a URL que o navegador deve ser redirecionado
• string $iEspera: tempo de espera

[edit] script()

Incluir um script em JavaScript na resposta.

$objDeResposta->script($sJS)

• string $sJS: contém o código JavaScript a ser executado.

[edit] call()

Inclui uma chamada a uma função JavaScript na resposta.

$objDeResposta->call($sFunção,$Argumentos)

• string $sFunção: O nome da função JavaScript.
• mixed $Argumentos: argumentos a serem passados a função, opcional.

[edit] remove()

Inclui um comando para excluir um elemento HTML na mensagem de resposta.

$objDeResposta->remove($sDestino)

• string $sDestino: contém o id do elemento HTML a ser excluído

[edit] create()

Inclui um comando para criar um elemento na mensagem de resposta.

$objDeResposta->create($sElementoPai, $sTag, $sId, $sType="")

• string $sElementoPai: contém o id de um elemento HTML ao qual o novo elemento será adicionado.
• string $sTag: a tag a ser adicionada.
• string $sId: o id do novo elemento
• string $sType: em desuso, use o método CreateInput(). É opcional.

[edit] insert()

Inclui um comando para inserir um elemento na mensagem de resposta.

$objDeResposta->create($sAntes, $sTag, $sId)

• string $sAntes: contém o id do elemento-filho, que o novo elemento deve ficar anterior.
• string $sTag: a tag a ser adicionada.
• string $sId: o id do novo elemento.

[edit] insertAfter()

Inclui um comando para inserir um elemento na mensagem de resposta.

$objDeResposta->insertAfter($sDepois, $sTag, $sId)

• string $sAfter: contém o id do elemento-filho, que o novo elemento deve ser colocado após.
• string $sTag: a tag a ser adicionada.
• string $sId: o id do novo elemento.

[edit] createInput()

Inclui um comando para inserir um elemento input na mensagem de resposta.

$objDeResposta->createInput($sElementoPai, $sTipo, $sNome, $sId)

• string $sElementoPai: contém o id do elemento-pai, que o novo elemento deve ficar anexado.
• string $sType: o tipo de input a ser criado (text, radio, checkbox, etc.)
• string $sNome: o nome atribuido ao novo input e o nome da variável quando ele for enviado.
• string $sId: o id do novo elemento input.

[edit] insertInput()

Inclui um comando para inserir um elemento input na mensagem de resposta.

$objDeResposta->insertInput($sAntes, $sTipo, $sNome, $sId)

• string $sAntes: contém o id do elemento-filho, que o novo elemento deve ficar antes.
• string $sTipo: o tipo de input a ser criado (text, radio, checkbox, etc.)
• string $sNome: o nome atribuido ao novo input e o nome da variável quando ele for enviado.
• string $sId: o id do novo elemento input.

[edit] insertInputAfter()

Inclui um comando para inserir um elemento input na mensagem de resposta.

$objDeResposta->insertInputAfter($sDepois, $sTipo, $sNome, $sId)

• string $sDepois: contém o id do elemento-filho, que o novo elemento deve ficar depois.
• string $sTipo: o tipo de input a ser criado (text, radio, checkbox, etc.)
• string $sNome: o nome atribuido ao novo input e o nome da variável quando ele for enviado.
• string $sId: o id do novo elemento input.

[edit] addEvent()

Inclui um evento a mensagem de resposta.

$objDeResposta->addEvent($sDestino,$sEvento,$sScript)

• string $sDestino: contém o id do elemento HTML
• string $sEvento: nome do evento que você quer definir (onclick, onmouseover, etc.)
• string $sScript: o JavaScript que você deseja que o evento chame.

[edit] addHandler()

Inclui um tratamento a um evento a mensagem de resposta.

$objDeResposta->addHandler($sDestino,$sEvento,$sFunçãoDeTratamento)

• string $sTarget: contém o id do elemento HTML
• string $sEvent: nome do evento que você quer definir (onclick, onmouseover, etc.)
• string $sFunçãoDeTratamento: a função JavaScript que você deseja que o evento chame. Multiplas funções podem ser incluidas para tratar um único evento.

[edit] removeHandler()

Remove um tratamento de um evento na mensagem de resposta.

$objDeResposta->removeHandler($sDestino,$sEvent,$sFunçãoDeTratamento)

• string $sDestino: contém o id do elemento HTML.
• string $sEvent:nome do evento que você quer definir (onclick, onmouseover, etc.)
• string $sFunçãoDeTratamento: o nome da função JavaScript que você deseja remover do tratamento do evento.

[edit] includeScript()

Inclui um comando para incluir um Script na mensagem de resposta.

$objDeResposta->includeScript($sNomeDoArquivo)

• string $sNomeDoArquivo: URL do arquivo JavaScript a ser incluido.

[edit] includeScriptOnce()

Inclui um comando para incluir um Script, uma única vez, na mensagem de resposta.

$objDeResposta->includeScriptOnce($sNomeDoArquivo)

• string $sNomeDoArquivo: URL do arquivo JavaScript a ser incluido.

[edit] includeCSS()

Inclui um comando para anexar um arquivo CSS a página na mensagem de resposta.

$objDeResposta->includeCSS($sNomeDoArquivo)

• string $sNomeDoArquivo: URL do arquivo CSS a ser incluido.

[edit] getContentType()

Retorna o tipo de conteúdo da mensagem de resposta (tipicamente "text/xml").

$objDeResposta->getContentType()

[edit] getOutput()

Retorna o tipo da saída da resposta apropriado para enviar ao navegador Web. (i. e., XML or JSON)

$objDeResposta->getOutput()

[edit] getCommandCount()

Retorna o número de comandos da resposta atual.

$objDeResposta->getCommandCount()

[edit] loadCommands()

Inclui comandos de um objeto informado a resposta de outro objeto de resposta.

$objDeResposta2->loadCommands($objDeResposta1);
return $objDeResposta2;
//ou 
$objDeResposta->loadCommands($mCommandos, $bAntes=false)

• mixed $mCommandos: o objeto de resposta a ser adicionado no fim deste objeto de resposta, ou um array de comandos de resposta.
• boolean $bAntes: True para incluir no inicio ou false para incluir no fim do array