|
js-xmlrpc | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Object | +--GLOBALS
Method Summary | |
<static> string
|
base64_decode(<string> aString)
Decodes a Base64 encoded string to a byte string. |
<static> string
|
base64_encode(<string> aString)
Encodes a string using Base64. |
<static> string
|
htmlentities(<string> val, quote_style)
Debug helper. |
<static> Date
|
iso8601_decode(<string> time, <boolean> utc)
Given an ISO8601 date string, return a date obj in the localtime, or UTC |
<static> string
|
iso8601_encode(<Date> time, <boolean> utc)
Given a Date object, returns its representation in the iso8601 format used by xmlrpc |
<static> Object
|
jsonrpc_decode(jsonrpc_val, options)
Takes a json value in jsonrpcval object format and translates it into native javascript types. |
<static> false | jsonrpcresp | jsonrpcmsg | jsonrpcval
|
jsonrpc_decode_json(<string> json_val, <object> options)
Convert the json representation of a jsonrpc method call, jsonrpc method response or single json value into the appropriate object (deserialize) |
<static> Object
|
jsonrpc_encode(js_val, options)
Takes native javascript types and encodes them into jsonrpc object format. |
<static> string
|
var_export(<mixed> val, <boolean> ret, <boolean> whitespaces)
Debug helper. |
<static> Object
|
wrap_xmlrpc_method(client, methodname, extra_options)
Given an xmlrpc client and a method name, register a js wrapper function that will call it and return results using native js types for both params and results. |
<static> Object
|
wrap_xmlrpc_server(client, extra_options)
Similar to wrap_xmlrpc_method, but will generate a javascript class that wraps all xmlrpc methods exposed by the remote server as own methods. |
<static> void
|
xmlrpc_debug_log(<string> logmsg)
Function used to send a debug message to the log. |
<static> mixed
|
xmlrpc_decode(<xmlrpcval> xmlrpc_val, options)
Takes an xmlrpc value in xmlrpcval object format and translates it into native javascript types. |
<static> mixed
|
xmlrpc_decode_xml(<string> xml_val, <array> options)
!!! |
<static> xmlrpcval
|
xmlrpc_encode(<mixed> js_val, <array> options)
Takes native javascript types and encodes them recursively into xmlrpcval object format. |
<static> void
|
xmlrpc_error_log(errormsg)
Function used to send an error message to the log. |
Method Detail |
<static> string base64_decode(<string> aString)
aString
-
<static> string base64_encode(<string> aString)
aString
-
<static> string htmlentities(<string> val, quote_style)
val
-
<static> Date iso8601_decode(<string> time, <boolean> utc)
time
-
utc
-
<static> string iso8601_encode(<Date> time, <boolean> utc)
time
-
utc
- when True, the UTC timezone is assumed
<static> Object jsonrpc_decode(jsonrpc_val, options)
<static> false | jsonrpcresp | jsonrpcmsg | jsonrpcval jsonrpc_decode_json(<string> json_val, <object> options)
json_val
-
options
- not used (yet)
<static> Object jsonrpc_encode(js_val, options)
<static> string var_export(<mixed> val, <boolean> ret, <boolean> whitespaces)
val
-
ret
-
whitespaces
-
<static> Object wrap_xmlrpc_method(client, methodname, extra_options)
xmlrpc_client
- client an xmlrpc client set up correctly to communicate with target server
string
- methodname the xmlrpc method to be mapped to a js function
array
- extra_options map of options that specify conversion details. valid ptions include integer signum the index of the method signature to use in mapping (if method exposes many sigs) integer timeout timeout (in secs) to be used when executing function/calling remote method string protocol 'http' (default), 'http11' or 'https' string new_function_name the name of js function to create. If unsepcified, lib will pick an appropriate name string return_source if true return js code w. function definition instead of created function bool encode_js_objs let js objects be sent to server using the 'improved' xmlrpc notation, so server can deserialize them as js objects bool decode_js_objs --- WARNING !!! possible security hazard. only use it with trusted servers --- mixed return_on_fault a js value to be returned when the xmlrpc call fails/returns a fault response (by default the xmlrpcresp object is returned in this case). If a string is used, '%faultCode%' and '%faultString%' tokens will be substituted with actual error values bool debug set it to 1 or 2 to see debug results of querying server for method synopsis
<static> Object wrap_xmlrpc_server(client, extra_options)
xmlrpc_client
- client the client obj all set to query the desired server
object
- extra_options list of options for wrapped code
<static> void xmlrpc_debug_log(<string> logmsg)
logmsg
-
<static> mixed xmlrpc_decode(<xmlrpcval> xmlrpc_val, options)
xmlrpc_val
-
not
- in use (yet)
<static> mixed xmlrpc_decode_xml(<string> xml_val, <array> options)
xml_val
-
options
-
<static> xmlrpcval xmlrpc_encode(<mixed> js_val, <array> options)
js_val
- The value to be converted into an xmlrpcval object
options
-
<static> void xmlrpc_error_log(errormsg)
|
js-xmlrpc | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |