ILIAS  release_4-4 Revision
ilBMFBase_Object Class Reference
+ Inheritance diagram for ilBMFBase_Object:
+ Collaboration diagram for ilBMFBase_Object:

Public Member Functions

 ilBMFBase_Object ($faultcode='Client')
 Constructor. More...
 
_raiseSoapFault ($str, $detail='', $actorURI='', $code=null, $mode=null, $options=null, $skipmsg=false)
 Raises a SOAP error. More...
 
 __isfault ()
 
__getfault ()
 
 _debug ($string)
 Adds a string to the debug data. More...
 
- Public Member Functions inherited from PEAR
 PEAR ($error_class=null)
 Constructor. More...
 
 _PEAR ()
 Destructor (the emulated type of...). More...
 
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. More...
 
 registerShutdownFunc ($func, $args=array())
 Use this function to register a shutdown method for static classes. More...
 
 isError ($data, $code=null)
 Tell whether a value is a PEAR error. More...
 
 setErrorHandling ($mode=null, $options=null)
 Sets how errors generated by this object should be handled. More...
 
 expectError ($code=' *')
 This method is used to tell which errors you expect to get. More...
 
 popExpect ()
 This method pops one element off the expected error codes stack. More...
 
 _checkDelExpect ($error_code)
 This method checks unsets an error code if available. More...
 
 delExpect ($error_code)
 This method deletes all occurences of the specified element from the expected error codes stack. More...
 
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. More...
 
throwError ($message=null, $code=null, $userinfo=null)
 Simpler form of raiseError with fewer options. More...
 
 staticPushErrorHandling ($mode, $options=null)
 
 staticPopErrorHandling ()
 
 pushErrorHandling ($mode, $options=null)
 Push a new error handler on top of the error handler options stack. More...
 
 popErrorHandling ()
 Pop the last error handler used. More...
 
 loadExtension ($ext)
 OS independant PHP extension load. More...
 

Data Fields

 $_debug_flag = false
 Store debugging information in $_debug_data? More...
 
 $_debug_data = ''
 String containing debugging information if $_debug_flag is true. More...
 
 $_encodings = array('ISO-8859-1', 'US-ASCII', 'UTF-8')
 Supported encodings, limited by XML extension. More...
 
 $_myfaultcode = ''
 Fault code. More...
 
 $fault = null
 Recent PEAR_Error object. More...
 
- 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()
 

Detailed Description

Definition at line 119 of file class.ilBMFBase.php.

Member Function Documentation

◆ __getfault()

& ilBMFBase_Object::__getfault ( )

Definition at line 221 of file class.ilBMFBase.php.

References $fault.

Referenced by ilBMFWSDL\generateProxyCode(), ilBMFWSDL\getEndpoint(), ilBMFWSDL\getNamespace(), ilBMFWSDL\getOperationData(), ilBMFWSDL\getPortName(), ilBMFWSDL\getProxy(), ilBMFWSDL\getSoapAction(), and ilBMFWSDL\matchMethod().

222  {
223  return $this->fault;
224  }
$fault
Recent PEAR_Error object.
+ Here is the caller graph for this function:

◆ __isfault()

ilBMFBase_Object::__isfault ( )

Definition at line 216 of file class.ilBMFBase.php.

Referenced by ilBMFWSDL\generateProxyCode(), ilBMFWSDL\getEndpoint(), ilBMFWSDL\getNamespace(), ilBMFWSDL\getOperationData(), ilBMFWSDL\getPortName(), ilBMFWSDL\getProxy(), ilBMFWSDL\getSoapAction(), and ilBMFWSDL\matchMethod().

217  {
218  return $this->fault != null;
219  }
+ Here is the caller graph for this function:

◆ _debug()

ilBMFBase_Object::_debug (   $string)

Adds a string to the debug data.

Parameters
string$stringDebugging message.

Definition at line 231 of file class.ilBMFBase.php.

232  {
233  if ($this->_debug_flag) {
234  $this->_debug_data .= get_class($this) . ': ' .
235  str_replace('>', ">\r\n", $string) . "\n";
236  }
237  }

◆ _raiseSoapFault()

& ilBMFBase_Object::_raiseSoapFault (   $str,
  $detail = '',
  $actorURI = '',
  $code = null,
  $mode = null,
  $options = null,
  $skipmsg = false 
)

Raises a SOAP error.

Please refer to the SOAP definition for an impression of what a certain parameter stands for.

Use $debug_flag to store errors to the member variable $debug_data

See also
$debug_flag, $debug_data, ilBMFFault
Parameters
string | object$strError message or object.
string$detailDetailed error message.
string$actorURI
mixed$code
mixed$mode
mixed$options
boolean$skipmsg

Definition at line 191 of file class.ilBMFBase.php.

References $fault, and $options.

Referenced by ilBMFBase\_decodeDIMEMessage(), ilBMFBase\_decodeMimeMessage(), ilBMFBase\_makeDIMEMessage(), ilBMFBase\_makeMimeMessage(), ilBMFWSDL_ObjectParser\_parse(), ilBMFTransport_HTTP\_parseResponse(), ilBMFTransport_HTTP\_sendHTTP(), ilBMFTransport_HTTP\_sendHTTPS(), ilBMFBase\_setSchemaVersion(), ilBMFTransport_TCP\_validateUrl(), ilBMFTransport_SMTP\_validateUrl(), ilBMFTransport_HTTP\_validateUrl(), ilBMFWSDL_Cache\get(), ilBMFWSDL\getEndpoint(), ilBMFWSDL\getOperationData(), ilBMFWSDL\getPortName(), ilBMFParser\getResponse(), ilBMFTransport\getTransport(), ilBMFParser\ilBMFParser(), ilBMFWSDL_ObjectParser\ilBMFWSDL_ObjectParser(), ilBMFWSDL_Parser\parse(), ilBMFWSDL\parseObject(), ilBMFWSDL\parseURL(), ilBMFTransport_SMTP\send(), ilBMFTransport_TCP\send(), ilBMFTransport_HTTP\send(), and ilBMFWSDL_Parser\startElement().

193  {
194  // Pass through previous faults.
195  $is_instance = isset($this);
196  if (is_object($str)) {
197  $fault =& $str;
198  } else {
199  if (!$code) {
200  $code = $is_instance ? $this->_myfaultcode : 'Client';
201  }
202  $fault =& new ilBMFFault($str,
203  $code,
204  $actorURI,
205  $detail,
206  $mode,
207  $options);
208  }
209  if ($is_instance) {
210  $this->fault =& $fault;
211  }
212 
213  return $fault;
214  }
if(!is_array($argv)) $options
$fault
Recent PEAR_Error object.
+ Here is the caller graph for this function:

◆ ilBMFBase_Object()

ilBMFBase_Object::ilBMFBase_Object (   $faultcode = 'Client')

Constructor.

See also
$debug_data, _debug()
Parameters
string$faultcodeError code.

Definition at line 166 of file class.ilBMFBase.php.

References $GLOBALS.

167  {
168  $this->_myfaultcode = $faultcode;
169  $this->_debug_flag = $GLOBALS['SOAP_DEBUG'];
170  parent::PEAR('ilBMFFault');
171  }
$GLOBALS['SOAP_OBJECT_STRUCT']
SOAP_OBJECT_STRUCT makes PEAR::SOAP use objects for SOAP structures rather than arrays.

Field Documentation

◆ $_debug_data

string ilBMFBase_Object::$_debug_data = ''

String containing debugging information if $_debug_flag is true.

public

See also
$debug_flag, ilBMFBase

Definition at line 136 of file class.ilBMFBase.php.

◆ $_debug_flag

boolean ilBMFBase_Object::$_debug_flag = false

Store debugging information in $_debug_data?

See also
$debug_data, ilBMFBase

Definition at line 127 of file class.ilBMFBase.php.

◆ $_encodings

array ilBMFBase_Object::$_encodings = array('ISO-8859-1', 'US-ASCII', 'UTF-8')

Supported encodings, limited by XML extension.

Definition at line 143 of file class.ilBMFBase.php.

◆ $_myfaultcode

string ilBMFBase_Object::$_myfaultcode = ''

Fault code.

Definition at line 150 of file class.ilBMFBase.php.

◆ $fault


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