XML-RPC

2 XML-RPC
Introduo
Essas 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.
3 XML-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
configuração deve ser definida.
Tipos Resource
Essa extenso define um recurso (resource) para um servidor XML-RPC retornado por
xmlrpc_server_create().
4 XML-RPC
Constantes pr-definidas
Esta extenso no possui nenhuma constante.
5 XML-RPC
Funes para XML-RPC
6 XML-RPC
xmlrpc_decode_request
xmlrpc_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.
7 XML-RPC
xmlrpc_decode
xmlrpc_decode -- Decodifica XML para tipos nativos do PHP
Descrio
mixed xmlrpc_decode ( string $xml [, 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.
Parmetros
xml
Resposta XML retornada por mtodo XMLRPC.
encoding
Codificao 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()
8 XML-RPC
xmlrpc_encode_request
xmlrpc_encode_request -- Gera XML para uma requisio
Descrio
string xmlrpc_encode_request ( string $method, mixed $params [, array $
output_options ] )
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.
Parmetros
method
Nome do mtodo a ser chamado.
params
Parmetros do mtodo compatvel com assinatura do mtodo.
output_options
Array 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
9 XML-RPC
Exemplo #1 - Exemplo de uso das funes de cliente XMLRPC
<?php
$request = xmlrpc_encode_request("method", array(1, 2, 3));
$context = stream_context_create(array('http' => 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()
10 XML-RPC
xmlrpc_encode
xmlrpc_encode -- Gera XML para um valor do PHP
Descrio
string xmlrpc_encode ( mixed $value )
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.
11 XML-RPC
xmlrpc_get_type
xmlrpc_get_type -- Pega o tipo xmlrpc para um valor do PHP
Descrio
string xmlrpc_get_type ( mixed $value )
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.
Essa funo especialmente til para strings datetime e base64.
Aviso
Esta funo no est documentada; somente a lista de argumentos est disponvel.
12 XML-RPC
xmlrpc_is_fault
xmlrpc_is_fault -- Determina se um valor de array representa uma falha XMLRPC
Descrio
bool xmlrpc_is_fault ( array $arg )
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.
Parmetros
arg
Array 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()
13 XML-RPC
xmlrpc_parse_method_descriptions
xmlrpc_parse_method_descriptions -- Decodifica XML e gera uma lista de descrio de
mtodos
Descrio
array xmlrpc_parse_method_descriptions ( string $xml )
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.
14 XML-RPC
xmlrpc_server_add_introspection_data
xmlrpc_server_add_introspection_data -- Adiciona documentao de introspeco
Descrio
int xmlrpc_server_add_introspection_data ( resource $server, array $desc )
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.
15 XML-RPC
xmlrpc_server_call_method
xmlrpc_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
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.
16 XML-RPC
xmlrpc_server_create
xmlrpc_server_create -- Cria um servidor xmlrpc
Descrio
resource xmlrpc_server_create ( void )
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.
17 XML-RPC
xmlrpc_server_destroy
xmlrpc_server_destroy -- Destri o servidor xmlrpc
Descrio
int xmlrpc_server_destroy ( resource $server )
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.
18 XML-RPC
xmlrpc_server_register_introspection_callback
xmlrpc_server_register_introspection_callback -- Registra uma funo do PHP para gerar
documentao
Descrio
bool xmlrpc_server_register_introspection_callback ( resource $server, string $
function )
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.
19 XML-RPC
xmlrpc_server_register_method
xmlrpc_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
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.
20 XML-RPC
xmlrpc_set_type
xmlrpc_set_type -- Configura um tipo xmlrpc, base64 ou datetime, para uma string do
PHP
Descrio
bool xmlrpc_set_type ( string &$value, string $type )
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.
Parmetros
value
Valor 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..