Overview

Packages

  • Jyxo_Beholder
  • Jyxo_Charset
  • Jyxo_Color
  • Jyxo_Css
  • Jyxo_ErrorHandling
  • Jyxo_FirePhp
  • Jyxo_Gettext
    • Parser
  • Jyxo_Html
  • Jyxo_Input
    • Chain
    • Filter
    • Validator
  • Jyxo_Mail
    • Email
    • Parser
    • Sender
  • Jyxo_Rpc
    • Json
    • Xml
  • Jyxo_Shell
  • Jyxo_SpamFilter
  • Jyxo_Spl
  • Jyxo_String
  • Jyxo_Svn
  • Jyxo_Time
  • Jyxo_Timer
  • Jyxo_Webdav
  • Jyxo_XmlReader
  • PHP

Classes

  • Jyxo_Rpc_Client
  • Jyxo_Rpc_Server

Exceptions

  • Jyxo_Rpc_Exception
  • Overview
  • Package
  • Class
  • Tree
  • Deprecated

Class Jyxo_Rpc_Client

Abstract class for sending RPC requests.

Direct known subclasses

Jyxo_Rpc_Json_Client, Jyxo_Rpc_Xml_Client
Abstract
Category: Jyxo
Package: Jyxo_Rpc
Copyright: Copyright (c) 2005-2011 Jyxo, s.r.o.
License: https://github.com/jyxo/php/blob/master/license.txt
Author: Jaroslav HanslĂ­k
Located at Rpc/Client.php
Methods summary
public
# __construct( string $url = '' )

Creates client instance and eventually sets server address.

Creates client instance and eventually sets server address.

Parameters

$url
string
Server address
public Jyxo_Rpc_Client
# setUrl( string $url )

Sets server address.

Sets server address.

Parameters

$url
string
Server address

Returns

Jyxo_Rpc_Client
public Jyxo_Rpc_Client
# setTimeout( integer $timeout )

Sets timeout.

Sets timeout.

Parameters

$timeout
integer
Call timeout

Returns

Jyxo_Rpc_Client
public Jyxo_Rpc_Client
# setOption( string $key, mixed $value )

Changes client settings.

Changes client settings.

Parameters

$key
string
Parameter name
$value
mixed
Parameter value

Returns

Jyxo_Rpc_Client
public mixed
# getOption( string $key = '' )

Returns certain parameter or whole array of parameters if no parameter name is provided.

Returns certain parameter or whole array of parameters if no parameter name is provided.

Parameters

$key
string
Parameter name

Returns

mixed
public Jyxo_Rpc_Client
# enableProfiler( )

Turns request profiler on.

Turns request profiler on.

Returns

Jyxo_Rpc_Client
public Jyxo_Rpc_Client
# disableProfiler( )

Turns request profiler off.

Turns request profiler off.

Returns

Jyxo_Rpc_Client
abstract public mixed
# send( string $method, array $params )

Sends a request and fetches a response from the server.

Sends a request and fetches a response from the server.

Parameters

$method
string
Method name
$params
array
Method parameters

Returns

mixed

Throws

BadMethodCallException
If no server address was provided
Jyxo_Rpc_Exception
On error
protected string
# process( string $contentType, string $data )

Processes request data and fetches response.

Processes request data and fetches response.

Parameters

$contentType
string
Request content-type
$data
string
Request data

Returns

string

Throws

BadMethodCallException
If no server address was provided
Jyxo_Rpc_Exception
On error
protected Jyxo_Rpc_Client
# profileStart( )

Starts profiling.

Starts profiling.

Returns

Jyxo_Rpc_Client
protected Jyxo_Rpc_Client
# profileEnd( string $type, string $method, array $params, mixed $response )

Finishes profiling.

Finishes profiling.

Parameters

$type
string
Request type
$method
string
Method name
$params
array
Method parameters
$response
mixed
Server response

Returns

Jyxo_Rpc_Client
Properties summary
protected string $url ''
#

Server address.

Server address.

protected integer $timeout 5
#

Time limit for communication with RPC server (seconds).

Time limit for communication with RPC server (seconds).

protected array $options array()
#

Parameters for creating RPC requests.

Parameters for creating RPC requests.

Jyxo PHP Library API documentation generated by ApiGen 2.3.0