Dotclear 2.26
Loading...
Searching...
No Matches
xmlrpcClient Class Reference
Inheritance diagram for xmlrpcClient:
netHttp Socket PingsAPI xmlrpcClientMulticall

Public Member Functions

 __construct (string $url)
 
 query (string $method,... $args)
 
- Public Member Functions inherited from netHttp
 __construct ($host, int $port=80, ?int $timeout=null)
 
 get (string $path, $data=false)
 
 post (string $path, $data, ?string $charset=null)
 
 getStatus ()
 
 getContent ()
 
 getHeaders ()
 
 getHeader ($header)
 
 getCookies ()
 
 getRequestURL ()
 
 setHost (string $host, int $port=80)
 
 setProxy ($host, int $port=8080)
 
 setTimeout (int $timeout)
 
 setUserAgent (string $user_agent)
 
 setAuthorization (?string $username, ?string $password)
 
 setMoreHeader (string $header)
 
 voidMoreHeaders ()
 
 setCookies (array $cookies)
 
 useSSL (bool $flag)
 
 useGzip (bool $flag)
 
 setPersistCookies (bool $flag)
 
 setPersistReferers (bool $flag)
 
 setHandleRedirects (bool $flag)
 
 setMaxRedirects (int $num)
 
 setHeadersOnly (bool $flag)
 
 setDebug (bool $flag)
 
 setOutput (?string $out)
 
- Public Member Functions inherited from Socket
 __construct (string $host, int $port, int $timeout=10)
 
 __destruct ()
 
 host (?string $host=null)
 
 port (?int $port=null)
 
 timeout (?int $timeout=null)
 
 setBlocking (bool $block)
 
 open ()
 
 close ()
 
 write ($data)
 
 flush ()
 
 isOpen ()
 

Protected Member Functions

 buildRequest ()
 
- Protected Member Functions inherited from netHttp
 buildQueryString ($data)
 
 doRequest ()
 
 buildRequest ()
 
 outputOpen ()
 
 outputClose ()
 
 outputWrite ($content)
 
 debug (string $msg, $object=false)
 
- Protected Member Functions inherited from Socket
 iterator ()
 

Protected Attributes

 $request
 
 $message
 
- Protected Attributes inherited from netHttp
 $host
 
 $port
 
 $path
 
 $method
 
 $postdata = ''
 
 $post_charset
 
 $cookies = []
 
 $referer
 
 $accept = 'text/xml,application/xml,application/xhtml+xml,text/html,text/plain,image/png,image/jpeg,image/gif,image/webp,*/*'
 
 $accept_encoding = 'gzip'
 
 $accept_language = 'en-us'
 
 $user_agent = 'Clearbricks HTTP Client'
 
 $more_headers = []
 
 $timeout = 10
 
 $use_ssl = false
 
 $use_gzip = false
 
 $persist_cookies = true
 
 $persist_referers = true
 
 $debug = false
 
 $handle_redirects = true
 
 $max_redirects = 5
 
 $headers_only = false
 
 $username
 
 $password
 
 $proxy_host
 
 $proxy_port
 
 $status
 
 $status_string
 
 $headers = []
 
 $content = ''
 
 $redirect_count = 0
 
 $cookie_host = ''
 
 $output = null
 
 $output_h = null
 
- Protected Attributes inherited from Socket
 $_host
 
 $_port
 
 $_transport = ''
 
 $_timeout
 
 $_handle
 

Additional Inherited Members

- Static Public Member Functions inherited from netHttp
static quickGet (string $url, ?string $output=null)
 
static quickPost (string $url, array $data, ?string $output=null)
 
static initClient (string $url, string &$path)
 
static readURL (string $url, bool &$ssl, string &$host, int &$port, string &$path, string &$user, string &$pass)
 

Constructor & Destructor Documentation

◆ __construct()

__construct ( string  $url)

Constructor

Creates a new instance. $url is the XML-RPC Server end point.

Parameters
string$urlService URL

References netHttp\$host, netHttp\$path, netHttp\$port, netHttp\setAuthorization(), and netHttp\useSSL().

Member Function Documentation

◆ query()

query ( string  $method,
  $args 
)

XML-RPC Query

This method calls the given query (first argument) on XML-RPC Server. All other arguments of this method are XML-RPC method arguments. This method throws an exception if XML-RPC method returns an error or returns the server's response.

Example: $o = new xmlrpcClient('http://example.com/xmlrpc'); $r = $o->query('method1','hello','world');

Parameters
string$method
mixed$args
Returns
mixed

Reimplemented in xmlrpcClientMulticall.

References netHttp\doRequest().

◆ buildRequest()

buildRequest ( )
protected

Builds an request.

Overloading netHttp::buildRequest method, we don't need all the stuff of HTTP client.

Returns
array The request.

Reimplemented from netHttp.

References netHttp\$path, and netHttp\getRequestURL().

Field Documentation

◆ $request

$request
protected

◆ $message

$message
protected

The documentation for this class was generated from the following file: