ILIAS  release_5-1 Revision 5.0.0-5477-g43f3e3fab5f
ilSoapMailXmlParser Class Reference

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 @access 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 @access 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.

22 {
23 parent::__construct('',true);
24 $this->setThrowException(true);
25 $this->setXMLContent($a_xml);
26 }
setThrowException($throwException)
set error handling
setXMLContent($a_xml_content)

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

+ 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.

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

◆ handlerBeginTag()

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

handler for begin of element

Parameters
resource$a_xml_parserxml parser
string$a_nameelement name
array$a_attribselement attributes array

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

72 {
73 switch($a_name)
74 {
75 case 'Mail':
76 $this->mail = array();
77 $this->mail['usePlaceholders'] = $a_attribs['usePlaceholders'] ? true : false;
78 $this->mail['type'] = $a_attribs['type'] == 'System' ? 'system' : 'normal';
79 break;
80
81 case 'To':
82 $this->mail['to'] = $this->parseName($a_attribs);
83 break;
84
85 case 'Cc':
86 $this->mail['cc'] = $this->parseName($a_attribs);
87 break;
88
89 case 'Bcc':
90 $this->mail['bcc'] = $this->parseName($a_attribs);
91 break;
92
93 case 'Subject':
94 break;
95
96 case 'Message':
97 $this->lines = array();
98 break;
99
100 case 'Attachment':
101 $this->attachment = array();
102 $this->attachment['name'] = $a_attribs['name'];
103 break;
104
105 }
106 }
parseName($a_attribs)
extract user name

References parseName().

+ Here is the call graph for this function:

◆ handlerCharacterData()

ilSoapMailXmlParser::handlerCharacterData (   $a_xml_parser,
  $a_data 
)

handler for character data

Parameters
resource$a_xml_parserxml parser
string$a_datacharacter data

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

150 {
151 if($this->in_metadata)
152 {
153 parent::handlerCharacterData($a_xml_parser,$a_data);
154 }
155
156 if($a_data != "\n")
157 {
158 // Replace multiple tabs with one space
159 $a_data = preg_replace("/\t+/"," ",$a_data);
160 $this->cdata .= $a_data;
161 }
162 }

◆ handlerEndTag()

ilSoapMailXmlParser::handlerEndTag (   $a_xml_parser,
  $a_name 
)

handler for end of element

Parameters
resource$a_xml_parserxml parser
string$a_nameelement name

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

115 {
116 switch($a_name)
117 {
118 case 'Mail':
119 $this->mails[] = $this->mail;
120 break;
121
122 case 'Subject':
123 $this->mail['subject'] = $this->cdata;
124 break;
125
126 case 'Message':
127 $this->mail['body'] = (array) $this->lines;
128 break;
129
130 case 'P':
131 $this->lines[] = trim($this->cdata);
132 break;
133
134 case 'Attachment':
135 $this->attachment['content'] = base64_decode(trim($this->cdata));
136 $this->mail['attachments'][] = $this->attachment;
137 break;
138 }
139
140 $this->cdata = '';
141 }

◆ parseName()

ilSoapMailXmlParser::parseName (   $a_attribs)
protected

extract user name

Parameters
object$a_attribs
Returns
Exceptions
InvalidArgumentExceptionif recipient, sender is invalid

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

171 {
172 include_once './Services/Object/classes/class.ilObjectFactory.php';
173
174 if($a_attribs['obj_id'])
175 {
176 $il_id = explode('_',$a_attribs['obj_id']);
177 $GLOBALS['ilLog']->write('il ID:'.print_r($il_id,true));
178 if(!$user = ilObjectFactory::getInstanceByObjId($il_id[3],false))
179 {
180 throw new InvalidArgumentException("Invalid user id given: obj_id => ".$a_attribs['obj_id']);
181 }
182 return $user->getLogin();
183 }
184 else
185 {
186 return $a_attribs['name'];
187 }
188 }
getInstanceByObjId($a_obj_id, $stop_on_error=true)
get an instance of an Ilias object by object id
$GLOBALS['PHPCAS_CLIENT']
This global variable is used by the interface class phpCAS.
Definition: CAS.php:276

References $GLOBALS, and ilObjectFactory\getInstanceByObjId().

Referenced by handlerBeginTag().

+ 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
resourcereference to the xml parser @access private

Reimplemented from ilSaxParser.

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

58 {
59 xml_set_object($a_xml_parser,$this);
60 xml_set_element_handler($a_xml_parser,'handlerBeginTag','handlerEndTag');
61 xml_set_character_data_handler($a_xml_parser,'handlerCharacterData');
62 }

◆ start()

ilSoapMailXmlParser::start ( )

starts parsing

Exceptions
InvalidArgumentExceptionwhen recipent or sender is invalid.
Returns
boolean true, if no errors happend.

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

45 {
46 $this->startParsing();
47 return true;
48 }
startParsing()
stores xml data in array

References ilSaxParser\startParsing().

+ Here is the call graph for this function:

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