ILIAS
Release_5_0_x_branch Revision 61816
|
Public Member Functions | |
ilBMFTransport_HTTP ($url, $encoding=SOAP_DEFAULT_ENCODING) | |
ilBMFTransport_HTTP Constructor | |
send ($msg, $options=null) | |
Sends and receives SOAP data. | |
setCredentials ($username, $password) | |
Sets data for HTTP authentication, creates authorization header. | |
addCookie ($name, $value) | |
Adds a cookie. | |
_genCookieHeader () | |
Generates the correct headers for the cookies. | |
_validateUrl () | |
Validate url data passed to constructor. | |
_parseEncoding ($headers) | |
Finds out what the encoding is. | |
_parseHeaders ($headers) | |
Parses the headers. | |
_parseResponse () | |
Removes HTTP headers from response. | |
_getRequest ($msg, $options) | |
Creates HTTP request, including headers, for outgoing request. | |
_sendHTTP ($msg, $options) | |
Sends outgoing request, and read/parse response. | |
_sendHTTPS ($msg, $options) | |
Sends outgoing request, and read/parse response, via HTTPS. | |
Public Member Functions inherited from ilBMFBase | |
ilBMFBase ($faultcode= 'Client') | |
Constructor. | |
_resetNamespaces () | |
_setSchemaVersion ($schemaVersion) | |
Sets the schema version used in the SOAP message. | |
_getNamespacePrefix ($ns) | |
_getNamespaceForPrefix ($prefix) | |
_isSoapValue (&$value) | |
_serializeValue (&$value, $name= '', $type=false, $elNamespace=NULL, $typeNamespace=NULL, $options=array(), $attributes=array(), $artype='', $OBJTypeNS=array()) | |
_getType (&$value) | |
Converts a PHP type to a SOAP type. | |
_multiArrayType (&$value, &$type, &$size, &$xml) | |
_isBase64 (&$value) | |
Returns whether a string is base64 encoded data. | |
_isBase64Type ($type) | |
Returns whether a type is a base64 type. | |
_isHash (&$a) | |
Returns whether an array is a hash. | |
_un_htmlentities ($string) | |
& | _decode (&$soapval) |
_makeEnvelope (&$method, &$headers, $encoding=SOAP_DEFAULT_ENCODING, $options=array()) | |
Creates the SOAP envelope with the SOAP envelop data. | |
_makeMimeMessage (&$xml, $encoding=SOAP_DEFAULT_ENCODING) | |
_makeDIMEMessage ($xml) | |
_decodeMimeMessage (&$data, &$headers, &$attachments) | |
_decodeDIMEMessage (&$data, &$headers, &$attachments) | |
__set_type_translation ($type, $class=null) | |
Public Member Functions inherited from ilBMFBase_Object | |
ilBMFBase_Object ($faultcode= 'Client') | |
Constructor. | |
& | _raiseSoapFault ($str, $detail= '', $actorURI= '', $code=null, $mode=null, $options=null, $skipmsg=false) |
Raises a SOAP error. | |
__isfault () | |
& | __getfault () |
_debug ($string) | |
Adds a string to the debug data. | |
Public Member Functions inherited from PEAR | |
PEAR ($error_class=null) | |
Constructor. | |
_PEAR () | |
Destructor (the emulated type of...). | |
& | getStaticProperty ($class, $var) |
If you have a class that's mostly/entirely static, and you need static properties, you can use this method to simulate them. | |
registerShutdownFunc ($func, $args=array()) | |
Use this function to register a shutdown method for static classes. | |
isError ($data, $code=null) | |
Tell whether a value is a PEAR error. | |
setErrorHandling ($mode=null, $options=null) | |
Sets how errors generated by this object should be handled. | |
expectError ($code= '*') | |
This method is used to tell which errors you expect to get. | |
popExpect () | |
This method pops one element off the expected error codes stack. | |
_checkDelExpect ($error_code) | |
This method checks unsets an error code if available. | |
delExpect ($error_code) | |
This method deletes all occurences of the specified element from the expected error codes stack. | |
& | raiseError ($message=null, $code=null, $mode=null, $options=null, $userinfo=null, $error_class=null, $skipmsg=false) |
This method is a wrapper that returns an instance of the configured error class with this object's default error handling applied. | |
& | throwError ($message=null, $code=null, $userinfo=null) |
Simpler form of raiseError with fewer options. | |
staticPushErrorHandling ($mode, $options=null) | |
staticPopErrorHandling () | |
pushErrorHandling ($mode, $options=null) | |
Push a new error handler on top of the error handler options stack. | |
popErrorHandling () | |
Pop the last error handler used. | |
loadExtension ($ext) | |
OS independant PHP extension load. |
Data Fields | |
$headers = array() | |
$cookies | |
$timeout = 4 | |
$urlparts = null | |
$url = '' | |
$incoming_payload = '' | |
$_userAgent = SOAP_LIBRARY_NAME | |
$encoding = SOAP_DEFAULT_ENCODING | |
$result_encoding = 'UTF-8' | |
$result_content_type | |
HTTP-Response Content-Type. | |
$result_headers = array() | |
$result_cookies = array() | |
Data Fields inherited from ilBMFBase | |
$_XMLSchema | |
$_XMLSchemaVersion = 'http://www.w3.org/2001/XMLSchema' | |
$_typemap | |
$_defaultObjectClassname = 'stdClass' | |
Default class name to use for decoded response objects. | |
$_namespaces | |
$_namespace | |
$_xmlEntities | |
$_doconversion = false | |
$__attachments = array() | |
$_wsdl = null | |
$_section5 = true | |
True if we use section 5 encoding, or false if this is literal. | |
$_auto_translation = false | |
$_type_translation = array() | |
Data Fields inherited from ilBMFBase_Object | |
$_debug_flag = false | |
Store debugging information in $_debug_data? | |
$_debug_data = '' | |
String containing debugging information if $_debug_flag is true. | |
$_encodings = array('ISO-8859-1', 'US-ASCII', 'UTF-8') | |
Supported encodings, limited by XML extension. | |
$_myfaultcode = '' | |
Fault code. | |
$fault = null | |
Recent PEAR_Error object. | |
Data Fields inherited from PEAR | |
$_debug = false | |
$_default_error_mode = null | |
$_default_error_options = null | |
$_default_error_handler = '' | |
$_error_class = 'PEAR_Error' | |
$_expected_errors = array() |
Definition at line 41 of file class.ilBMFTransport_HTTP.php.
ilBMFTransport_HTTP::_genCookieHeader | ( | ) |
Generates the correct headers for the cookies.
private
Definition at line 191 of file class.ilBMFTransport_HTTP.php.
References $cookies.
Referenced by _getRequest().
ilBMFTransport_HTTP::_getRequest | ( | $msg, | |
$options | |||
) |
Creates HTTP request, including headers, for outgoing request.
string | $msg | Outgoing SOAP package. |
array | $options | Options. |
Definition at line 421 of file class.ilBMFTransport_HTTP.php.
References $_userAgent, $headers, $options, _genCookieHeader(), and setCredentials().
Referenced by _sendHTTP(), and _sendHTTPS().
ilBMFTransport_HTTP::_parseEncoding | ( | $headers | ) |
Finds out what the encoding is.
Sets the object property accordingly.
private
array | $headers | Headers. |
Definition at line 242 of file class.ilBMFTransport_HTTP.php.
Referenced by _parseResponse().
ilBMFTransport_HTTP::_parseHeaders | ( | $headers | ) |
Parses the headers.
array | $headers | The headers. |
Definition at line 275 of file class.ilBMFTransport_HTTP.php.
References $headers.
Referenced by _parseResponse().
ilBMFTransport_HTTP::_parseResponse | ( | ) |
Removes HTTP headers from response.
Definition at line 334 of file class.ilBMFTransport_HTTP.php.
References $incoming_payload, ilBMFBase\_decodeDIMEMessage(), ilBMFBase\_decodeMimeMessage(), _parseEncoding(), _parseHeaders(), ilBMFBase_Object\_raiseSoapFault(), and PEAR\isError().
Referenced by _sendHTTP(), and _sendHTTPS().
ilBMFTransport_HTTP::_sendHTTP | ( | $msg, | |
$options | |||
) |
Sends outgoing request, and read/parse response.
Definition at line 496 of file class.ilBMFTransport_HTTP.php.
References ilBMFBase_Object\$fault, $options, _getRequest(), _parseResponse(), and ilBMFBase_Object\_raiseSoapFault().
Referenced by send().
ilBMFTransport_HTTP::_sendHTTPS | ( | $msg, | |
$options | |||
) |
Sends outgoing request, and read/parse response, via HTTPS.
Definition at line 551 of file class.ilBMFTransport_HTTP.php.
References ilBMFBase_Object\$fault, $options, _getRequest(), _parseResponse(), and ilBMFBase_Object\_raiseSoapFault().
Referenced by send().
ilBMFTransport_HTTP::_validateUrl | ( | ) |
Validate url data passed to constructor.
private
Definition at line 206 of file class.ilBMFTransport_HTTP.php.
References ilBMFBase_Object\_raiseSoapFault(), and setCredentials().
Referenced by send().
ilBMFTransport_HTTP::addCookie | ( | $name, | |
$value | |||
) |
Adds a cookie.
public
string | $name | Cookie name. |
mixed | $value | Cookie value. |
Definition at line 181 of file class.ilBMFTransport_HTTP.php.
ilBMFTransport_HTTP::ilBMFTransport_HTTP | ( | $url, | |
$encoding = SOAP_DEFAULT_ENCODING |
|||
) |
ilBMFTransport_HTTP Constructor
public
string | $url | HTTP url to SOAP endpoint. |
string | $encoding | Encoding to use. |
Definition at line 125 of file class.ilBMFTransport_HTTP.php.
References $encoding, $url, and ilBMFBase\ilBMFBase().
ilBMFTransport_HTTP::send | ( | $msg, | |
$options = null |
|||
) |
Sends and receives SOAP data.
string | Outgoing POST data. |
array | Options. |
Definition at line 142 of file class.ilBMFTransport_HTTP.php.
References ilBMFBase_Object\$fault, $options, ilBMFBase_Object\_raiseSoapFault(), _sendHTTP(), _sendHTTPS(), and _validateUrl().
ilBMFTransport_HTTP::setCredentials | ( | $username, | |
$password | |||
) |
Sets data for HTTP authentication, creates authorization header.
string | $username | Username. |
string | $password | Response data, minus HTTP headers. |
public
Definition at line 169 of file class.ilBMFTransport_HTTP.php.
Referenced by _getRequest(), and _validateUrl().
ilBMFTransport_HTTP::$_userAgent = SOAP_LIBRARY_NAME |
Definition at line 91 of file class.ilBMFTransport_HTTP.php.
Referenced by _getRequest().
ilBMFTransport_HTTP::$cookies |
Definition at line 56 of file class.ilBMFTransport_HTTP.php.
Referenced by _genCookieHeader().
ilBMFTransport_HTTP::$encoding = SOAP_DEFAULT_ENCODING |
Definition at line 98 of file class.ilBMFTransport_HTTP.php.
Referenced by ilBMFTransport_HTTP().
ilBMFTransport_HTTP::$headers = array() |
Definition at line 49 of file class.ilBMFTransport_HTTP.php.
Referenced by _getRequest(), _parseEncoding(), and _parseHeaders().
ilBMFTransport_HTTP::$incoming_payload = '' |
Definition at line 84 of file class.ilBMFTransport_HTTP.php.
Referenced by _parseResponse().
ilBMFTransport_HTTP::$result_content_type |
HTTP-Response Content-Type.
Definition at line 111 of file class.ilBMFTransport_HTTP.php.
ilBMFTransport_HTTP::$result_cookies = array() |
Definition at line 115 of file class.ilBMFTransport_HTTP.php.
ilBMFTransport_HTTP::$result_encoding = 'UTF-8' |
Definition at line 106 of file class.ilBMFTransport_HTTP.php.
ilBMFTransport_HTTP::$result_headers = array() |
Definition at line 113 of file class.ilBMFTransport_HTTP.php.
ilBMFTransport_HTTP::$timeout = 4 |
Definition at line 63 of file class.ilBMFTransport_HTTP.php.
ilBMFTransport_HTTP::$url = '' |
Definition at line 77 of file class.ilBMFTransport_HTTP.php.
Referenced by ilBMFTransport_HTTP().
ilBMFTransport_HTTP::$urlparts = null |
Definition at line 70 of file class.ilBMFTransport_HTTP.php.