XML parser for soap mails. More...

Inheritance diagram for ilSoapMailXmlParser:

Collaboration diagram for ilSoapMailXmlParser:

Public Member Functions
	__construct ($a_xml)
	Constructor. More...

	getMails ()
	Get parsed mails. More...

	start ()
	starts parsing More...

	setHandlers ($a_xml_parser)
	set event handlers More...

	handlerBeginTag ($a_xml_parser, $a_name, $a_attribs)
	handler for begin of element More...

	handlerEndTag ($a_xml_parser, $a_name)
	handler for end of element More...

	handlerCharacterData ($a_xml_parser, $a_data)
	handler for character data More...

Public Member Functions inherited from ilSaxParser
	ilSaxParser ($a_xml_file='', $throwException=false)
	Constructor setup ILIAS global object public. More...

	setXMLContent ($a_xml_content)

	getXMLContent ()

	getInputType ()

	startParsing ()
	stores xml data in array More...

	createParser ()
	create parser More...

	setOptions ($a_xml_parser)
	set parser options More...

	setHandlers ($a_xml_parser)
	set event handler should be overwritten by inherited class private More...

	openXMLFile ()
	open xml file More...

	parse ($a_xml_parser, $a_fp=null)
	parse xml file More...

	freeParser ($a_xml_parser)
	free xml parser handle More...

	setThrowException ($throwException)
	set error handling 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...

Protected Member Functions
	parseName ($a_attribs)
	extract user name More...

Protected Member Functions inherited from ilSaxParser
	handleError ($message, $code)
	use given error handler to handle error message or internal ilias error message handle More...

Additional Inherited Members
Data Fields inherited from ilSaxParser
	$input_type = null

	$xml_content = ''

	$ilias

	$lng

	$xml_file

	$throwException = false

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

XML parser for soap mails.

Author: Stefan Meyer smeye.nosp@m.r.il.nosp@m.ias@g.nosp@m.mx.d.nosp@m.e

Version: $Id$

Definition at line 16 of file class.ilSoapMailXmlParser.php.

Constructor & Destructor Documentation

◆ __construct()

ilSoapMailXmlParser::__construct ( $a_xml )

Constructor.

Definition at line 21 of file class.ilSoapMailXmlParser.php.

References ilSaxParser\setThrowException(), and ilSaxParser\setXMLContent().

         {
                 parent::__construct('',true);
                 $this->setThrowException(true);
                 $this->setXMLContent($a_xml);
         }

Here is the call graph for this function:

Member Function Documentation

◆ getMails()

ilSoapMailXmlParser::getMails ( )

Get parsed mails.

Returns

Definition at line 32 of file class.ilSoapMailXmlParser.php.

         {
                 return (array) $this->mails;
         }

◆ handlerBeginTag()

ilSoapMailXmlParser::handlerBeginTag	(	$a_xml_parser,
		$a_name,
		$a_attribs
	)

handler for begin of element

Parameters

resource	$a_xml_parser	xml parser
string	$a_name	element name
array	$a_attribs	element attributes array

Definition at line 71 of file class.ilSoapMailXmlParser.php.

References parseName().

         {
                 switch($a_name)
                 {
                         case 'Mail':
                                 $this->mail = array();
                                 $this->mail['usePlaceholders'] = $a_attribs['usePlaceholders'] ? true : false;
                                 $this->mail['type'] = $a_attribs['type'] == 'System' ? 'system' : 'normal';
                                 break;
                                 
                         case 'To':
                                 $this->mail['to'] = $this->parseName($a_attribs);
                                 break;
 
                         case 'Cc':
                                 $this->mail['cc'] = $this->parseName($a_attribs);
                                 break;
 
                         case 'Bcc':
                                 $this->mail['bcc'] = $this->parseName($a_attribs);
                                 break;
                                 
                         case 'Subject':
                                 break;
                                 
                         case 'Message':
                                 $this->lines = array();
                                 break;
                                 
                         case 'Attachment':
                                 $this->attachment = array();
                                 $this->attachment['name'] = $a_attribs['name'];
                                 break;
                                 
                 }
         }

Here is the call graph for this function:

◆ handlerCharacterData()

ilSoapMailXmlParser::handlerCharacterData	(	$a_xml_parser,
		$a_data
	)

handler for character data

Parameters

resource	$a_xml_parser	xml parser
string	$a_data	character data

Definition at line 149 of file class.ilSoapMailXmlParser.php.

         {
                 if($this->in_metadata)
                 {
                         parent::handlerCharacterData($a_xml_parser,$a_data);
                 }
 
                 if($a_data != "\n")
                 {
                         // Replace multiple tabs with one space
                         $a_data = preg_replace("/\t+/"," ",$a_data);
                         $this->cdata .= $a_data;
                 }
         }

◆ handlerEndTag()

ilSoapMailXmlParser::handlerEndTag	(	$a_xml_parser,
		$a_name
	)

handler for end of element

Parameters

resource	$a_xml_parser	xml parser
string	$a_name	element name

Definition at line 114 of file class.ilSoapMailXmlParser.php.

         {
                 switch($a_name)
                 {
                         case 'Mail':
                                 $this->mails[] = $this->mail;
                                 break;
 
                         case 'Subject':
                                 $this->mail['subject'] = $this->cdata;
                                 break;
                                 
                         case 'Message':
                                 $this->mail['body'] = (array) $this->lines;
                                 break;
                                 
                         case 'P':
                                 $this->lines[] = trim($this->cdata);
                                 break; 
                                 
                         case 'Attachment':
                                 $this->attachment['content'] = base64_decode(trim($this->cdata));
                                 $this->mail['attachments'][] = $this->attachment;
                                 break;
                 }
                 
                 $this->cdata = '';
         }

◆ parseName()

ilSoapMailXmlParser::parseName ( $a_attribs )

protected

extract user name

Parameters

object $a_attribs

Returns

Exceptions

InvalidArgumentException if recipient, sender is invalid

Definition at line 170 of file class.ilSoapMailXmlParser.php.

References $GLOBALS, and ilObjectFactory\getInstanceByObjId().

Referenced by handlerBeginTag().

         {
                 include_once './Services/Object/classes/class.ilObjectFactory.php';
                 
                 if($a_attribs['obj_id'])
                 {
                         $il_id = explode('_',$a_attribs['obj_id']);
                         $GLOBALS['ilLog']->write('il ID:'.print_r($il_id,true));
                         if(!$user = ilObjectFactory::getInstanceByObjId($il_id[3],false))
                         {
                                 throw new InvalidArgumentException("Invalid user id given: obj_id => ".$a_attribs['obj_id']);
                         }
                         return $user->getLogin();
                 }
                 else
                 {
                         return $a_attribs['name'];
                 }
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setHandlers()

ilSoapMailXmlParser::setHandlers ( $a_xml_parser )

set event handlers

Parameters

resource reference to the xml parser private

Definition at line 57 of file class.ilSoapMailXmlParser.php.

         {
                 xml_set_object($a_xml_parser,$this);
                 xml_set_element_handler($a_xml_parser,'handlerBeginTag','handlerEndTag');
                 xml_set_character_data_handler($a_xml_parser,'handlerCharacterData');
         }

◆ start()

ilSoapMailXmlParser::start ( )

starts parsing

Exceptions

InvalidArgumentException when recipent or sender is invalid.

Returns: boolean true, if no errors happend.

Definition at line 44 of file class.ilSoapMailXmlParser.php.

References ilSaxParser\startParsing().

         {
             $this->startParsing();
                 return true;
         }

Here is the call graph for this function:

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

webservice/soap/classes/class.ilSoapMailXmlParser.php

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getMails()

◆ handlerBeginTag()

◆ handlerCharacterData()

◆ handlerEndTag()

◆ parseName()

◆ setHandlers()

◆ start()