ilSoapMailXmlParser Class Reference

XML parser for soap mails. More...

Inheritance diagram for ilSoapMailXmlParser:

Collaboration diagram for ilSoapMailXmlParser:

Public Member Functions
	__construct (string $a_xml)
	getMails ()
	start ()
	setHandlers ($a_xml_parser)
	Set event handlers. More...
	handlerBeginTag ($a_xml_parser, string $a_name, array $a_attribs)
	handler for begin of element More...
	handlerEndTag ($a_xml_parser, string $a_name)
	Handler for end of element. More...
	handlerCharacterData ($a_xml_parser, string $a_data)
Public Member Functions inherited from ilSaxParser
	__construct (?string $path_to_file='', ?bool $throw_exception=false)
	setXMLContent (string $a_xml_content)
	getXMLContent ()
	getInputType ()
	startParsing ()
	stores xml data in array More...
	createParser ()
	setHandlers ($a_xml_parser)
	parse ($a_xml_parser, $a_fp=null)

Protected Member Functions
	parseName (array $a_attribs)
Protected Member Functions inherited from ilSaxParser
	openXMLFile ()
	handleError (string $message)
	setThrowException (bool $throw_exception)

Protected Attributes
array	$mails = []
array	$mail = []
array	$attachment = []
array	$lines = []
string	$cdata = ''
Protected Attributes inherited from ilSaxParser
ilLanguage	$lng = null

Additional Inherited Members
Data Fields inherited from ilSaxParser
string	$xml_file
bool	$throw_exception = false

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

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

Constructor & Destructor Documentation

__construct()

ilSoapMailXmlParser::__construct

(

string

$a_xml

)

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

References ILIAS\GlobalScreen\Provider\__construct(), 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

(

)

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

References $mails.

                              : array
    {
        return $this->mails;
    }

handlerBeginTag()

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

handler for begin of element

Parameters

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

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

References ILIAS\UI\examples\Symbol\Glyph\Attachment\attachment(), and parseName().

                                                                                    : void
    {
        switch ($a_name) {
            case 'Mail':
                $this->mail = array();
                $this->mail['usePlaceholders'] = (bool) $a_attribs['usePlaceholders'];
                $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,
		string	$a_data
	)

Parameters

XMLParser | resource	$a_xml_parser
string	$a_data

Returns

void

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

                                                                       : void
    {
        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,
		string	$a_name
	)

Handler for end of element.

Parameters

XMLParser | resource	$a_xml_parser	xml parser
string	$a_name	element name

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

References $attachment, $cdata, $lines, $mail, and ILIAS\UI\examples\Symbol\Glyph\Attachment\attachment().

                                                                : void
    {
        switch ($a_name) {
            case 'Mail':
                $this->mails[] = $this->mail;
                break;

            case 'Subject':
                $this->mail['subject'] = $this->cdata;
                break;

            case 'Message':
                $this->mail['body'] = $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 = '';
    }

Here is the call graph for this function:

parseName()

ilSoapMailXmlParser::parseName ( array  $a_attribs )

protected

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

References ilObjectFactory\getInstanceByObjId().

Referenced by handlerBeginTag().

                                                  : string
    {
        if ($a_attribs['obj_id']) {
            $il_id = explode('_', $a_attribs['obj_id']);
            if (!$user = ilObjectFactory::getInstanceByObjId($il_id[3], false)) {
                throw new InvalidArgumentException("Invalid user id given: obj_id => " . $a_attribs['obj_id']);
            }
            return $user->getLogin();
        }
        return (string) ($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

XMLParser|resource

A reference to the xml parser

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

                                              : void
    {
        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

(

)

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

References ilSaxParser\startParsing().

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

Here is the call graph for this function:

Field Documentation

$attachment

array ilSoapMailXmlParser::$attachment = []

protected

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

Referenced by handlerEndTag().

$cdata

string ilSoapMailXmlParser::$cdata = ''

protected

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

Referenced by handlerEndTag().

$lines

array ilSoapMailXmlParser::$lines = []

protected

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

Referenced by handlerEndTag().

$mail

array ilSoapMailXmlParser::$mail = []

protected

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

Referenced by handlerEndTag().

$mails

array ilSoapMailXmlParser::$mails = []

protected

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

Referenced by getMails().

---

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

• components/ILIAS/soap/classes/class.ilSoapMailXmlParser.php