XML-RPC

2XML-RPC

IntroduoEssas funes podem ser usadas para escrever servidores e clientes XML-RPC. Voc pode achar mais informao sobre XML-RPC em http://www.xmlrpc.com/, e mais documentao sobre essa extenso e suas funes em http://xmlrpc-epi.sourceforge.net/.

Aviso

Este mdulo EXPERIMENTAL. O comportamento desta extenso ? incluindo o nome de suas funes e qualquer outra documentao sobre esta extenso ? poder mudar sem aviso em futuras verses do PHP. Esta extenso deve ser usada por sua prpria conta e risco.

3XML-RPC

Instalao/Configurao

Dependncias

Nenhuma biblioteca externa necessria para compilar esta extenso.

Instalao

Suporte XML-RPC no PHP no habilitado por padro. Voc precisar usar a opo --with-xmlrpc[=DIR] ao executar o script configure para habilitar o suporte. Essa extenso est faz parte do PHP desde a verso 4.1.0.

Configuraes em Execuo

O comportamento dessas funes podem ser modificado pelas configuraes do php.ini.

Opes de Configurao de XML-RPC

Nome Valor Padro Altervel Changelog

xmlrpc_errors "0" PHP_INI_SYSTEM Disponvel desde o PHP 4.1.0.

xmlrpc_error_number "0" PHP_INI_ALL Disponvel desde o PHP 4.1.0.

Para mais detalhes e definies dos modos PHP_INI_*, veja Aonde uma configurao deve ser definida.

Tipos Resource

Essa extenso define um recurso (resource) para um servidor XML-RPC retornado por xmlrpc_server_create().

4XML-RPC

Constantes pr-definidasEsta extenso no possui nenhuma constante.

5XML-RPC

Funes para XML-RPC

6XML-RPC

xmlrpc_decode_requestxmlrpc_decode_request -- Decodifica XML para tipos nativos do PHP

Descrio

mixed xmlrpc_decode_request ( string $xml, string &$method [, string $encoding ] )

Aviso

Esta funo EXPERIMENTAL. O comportamento desta funo, seu nome, incluindo toda documentao pode ser modificado sem aviso em futuras verses do PHP. Esta funo deve ser usada por sua prpria conta e risco.

Aviso

Esta funo no est documentada; somente a lista de argumentos est disponvel.

7XML-RPC

xmlrpc_decodexmlrpc_decode -- Decodifica XML para tipos nativos do PHP

Descrio

mixed xmlrpc_decode ( string $xml [, string $encoding ] )

Aviso


Parmetros

xmlResposta XML retornada por mtodo XMLRPC.

encodingCodificao da entrada suportada por iconv (padro "iso-8859-1").

Valor Retornado

Retorna ou um array, ou um inteiro, ou uma string, ou um booleano de acordo com a resposta retornada via XMLRPC.

Exemplos

Veja exemplos em xmlrpc_encode_request().

Veja Tambm

xmlrpc_encode_request() xmlrpc_is_fault()

8XML-RPC

xmlrpc_encode_requestxmlrpc_encode_request -- Gera XML para uma requisio

Descrio

string xmlrpc_encode_request ( string $method, mixed $params [, array $output_options ] )

Aviso


Parmetros

methodNome do mtodo a ser chamado.

paramsParmetros do mtodo compatvel com assinatura do mtodo.

output_optionsArray especificando opes de sada. Pode conter (valores padro esto em negrito): output_type: php, xml verbosity: no_white_space, newlines_only, pretty escaping: cdata, non-ascii, non-print, markup (pode ser uma string com um valor

ou um array com mltiplos valores) version: simple, xmlrpc, soap 1.1, auto encoding: iso-8859-1, outra codificao suportada por iconv

Valor Retornado

Retorna uma string contendo a representao XML da requisio.

Exemplos

9XML-RPC

Exemplo #1 - Exemplo de uso das funes de cliente XMLRPC

array(

'method' => "POST",

'header' => "Content-Type: text/xml",

'content' => $request

)));

$file = file_get_contents("http://www.example.com/xmlrpc", false, $context);

$response = xmlrpc_decode($file);

if (xmlrpc_is_fault($response)) {

trigger_error("xmlrpc: $response[faultString] ($response[faultCode])");

} else {

print_r($response);

}

?>

Veja Tambm

stream_context_create() file_get_contents() xmlrpc_decode()

10XML-RPC

xmlrpc_encodexmlrpc_encode -- Gera XML para um valor do PHP

Descrio

string xmlrpc_encode ( mixed $value )

Aviso


Aviso


11XML-RPC

xmlrpc_get_typexmlrpc_get_type -- Pega o tipo xmlrpc para um valor do PHP

Descrio

string xmlrpc_get_type ( mixed $value )

Aviso


Essa funo especialmente til para strings datetime e base64.

Aviso


12XML-RPC

xmlrpc_is_faultxmlrpc_is_fault -- Determina se um valor de array representa uma falha XMLRPC

Descrio

bool xmlrpc_is_fault ( array $arg )

Aviso


Parmetros

argArray retornado por xmlrpc_decode().

Valor Retornado

Retorna TRUE se o argumento significa falha, FALSE caso contrrio. Descrio da falha est disponvel em $arg["faultString"], cdigo da falha est em $arg["faultCode"].

Exemplos

Veja o exemplo em xmlrpc_encode_request().

Veja Tambm

xmlrpc_decode()

13XML-RPC

xmlrpc_parse_method_descriptionsxmlrpc_parse_method_descriptions -- Decodifica XML e gera uma lista de descrio de mtodos

Descrio

array xmlrpc_parse_method_descriptions ( string $xml )

Aviso


Aviso


14XML-RPC

xmlrpc_server_add_introspection_dataxmlrpc_server_add_introspection_data -- Adiciona documentao de introspeco

Descrio

int xmlrpc_server_add_introspection_data ( resource $server, array $desc )

Aviso


Aviso


15XML-RPC

xmlrpc_server_call_methodxmlrpc_server_call_method -- Trata requisies de XML e chamadas de mtodos

Descrio

string xmlrpc_server_call_method ( resource $server, string $xml, mixed $user_data [, array $output_options ] )

Aviso


Aviso


16XML-RPC

xmlrpc_server_createxmlrpc_server_create -- Cria um servidor xmlrpc

Descrio

resource xmlrpc_server_create ( void )

Aviso


Aviso


17XML-RPC

xmlrpc_server_destroyxmlrpc_server_destroy -- Destri o servidor xmlrpc

Descrio

int xmlrpc_server_destroy ( resource $server )

Aviso


Aviso


18XML-RPC

xmlrpc_server_register_introspection_callbackxmlrpc_server_register_introspection_callback -- Registra uma funo do PHP para gerar documentao

Descrio

bool xmlrpc_server_register_introspection_callback ( resource $server, string $function )

Aviso


Aviso


19XML-RPC

xmlrpc_server_register_methodxmlrpc_server_register_method -- Registra uma funo do PHP para o mtodo com nome method_name

Descrio

bool xmlrpc_server_register_method ( resource $server, string $method_name, string $function )

Aviso


Aviso


20XML-RPC

xmlrpc_set_typexmlrpc_set_type -- Configura um tipo xmlrpc, base64 ou datetime, para uma string do PHP

Descrio

bool xmlrpc_set_type ( string &$value, string $type )

Aviso


Parmetros

valueValor a ser definido do tipo

type'base64' ou 'datetime'

Valor Retornado

Retorna TRUE em caso de sucesso ou FALSE em falhas. Se tiver sucesso, value convertido para um objeto.

Erros

emitido E_WARNING com tipo no suportado por XMLRPC..

XML-RPCIntroduoInstalao/ConfiguraoDependnciasInstalaoConfiguraes em ExecuoTipos Resource

Constantes pr-definidasFunes para XML-RPCxmlrpc_decode_requestxmlrpc_decodexmlrpc_encode_requestxmlrpc_encodexmlrpc_get_typexmlrpc_is_faultxmlrpc_parse_method_descriptionsxmlrpc_server_add_introspection_dataxmlrpc_server_call_methodxmlrpc_server_createxmlrpc_server_destroyxmlrpc_server_register_introspection_callbackxmlrpc_server_register_methodxmlrpc_set_type

XML-RPC

Documents

Transcript of XML-RPC