XML parser for weblink xml. More...

Inheritance diagram for ilWebLinkXmlParser:

Collaboration diagram for ilWebLinkXmlParser:

Public Member Functions
	__construct ($webr, $xml)
	Constructor. More...

	setWebLink (ilObject $webl)
	set weblink More...

	getWebLink ()
	Get weblink object. More...

	setMode ($a_mode)
	Set parsing mode. More...

	getMode ()
	Return parsing mode. More...

	start ()

	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 ilMDSaxParser
	__construct ($a_xml_file='')
	Constructor. More...

	enableMDParsing ($a_status)

	getMDParsingStatus ()

	setMDObject (&$md)

&	getMDObject ()

	inMetaData ()

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

	__getCharacterData ()

	__pushParent (&$md_obj)

	__popParent ()

	__getParent ()

	__construct ($a_xml_file='')
	Constructor. More...

	setMDObject (&$md)

	inMetaData ()

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

	__getCharacterData ()

	__pushParent (&$md_obj)

&	__popParent ()

&	__getParent ()

	__construct ($a_xml_file='')
	Constructor. More...

	enableMDParsing ($a_status)

	getMDParsingStatus ()

	setMDObject (&$md)

&	getMDObject ()

	inMetaData ()

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

	__getCharacterData ()

	__pushParent (&$md_obj)

&	__popParent ()

&	__getParent ()

Public Member Functions inherited from ilSaxParser
	__construct ($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
	__construct ($error_class=null)
	Constructor. More...

	_PEAR ()
	Destructor (the emulated type of...). 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...

	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
const	MODE_UNDEFINED = 0

const	MODE_UPDATE = 1

const	MODE_CREATE = 2

Data Fields inherited from ilMDSaxParser
	$md_in_md = false

	$md_chr_data = ''

	$md_cur_el = null

	$md_parsing_enabled = null

	$md = null

	$md_gen

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()

Private Attributes
	$webl

	$mode = self::MODE_UNDEFINED

	$in_metadata = false

	$sorting_positions = array()

	$current_sorting_position = 0

Additional Inherited Members
Static Public Member Functions inherited from PEAR
static &	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...

static	setErrorHandling ($mode=null, $options=null)
	Sets how errors generated by this object should be handled. 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...

Protected Attributes inherited from ilMDSaxParser
	$meta_log

Detailed Description

XML parser for weblink xml.

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

Version: $Id$

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

Constructor & Destructor Documentation

◆ __construct()

ilWebLinkXmlParser::__construct	(	$webr,
		$xml
	)

Constructor.

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

References $xml, getWebLink(), ilMDSaxParser\setMDObject(), ilSaxParser\setThrowException(), setWebLink(), and ilSaxParser\setXMLContent().

     {
         parent::__construct();
         $this->setXMLContent($xml);
         $this->setWebLink($webr);
 
         $this->setMDObject(new ilMD($this->getWebLink()->getId(), $this->getWebLink()->getId(), 'webr'));
         $this->setThrowException(true);
     }

Here is the call graph for this function:

Member Function Documentation

◆ getMode()

ilWebLinkXmlParser::getMode ( )

Return parsing mode.

Returns

Definition at line 80 of file class.ilWebLinkXmlParser.php.

References $mode.

Referenced by handlerBeginTag().

     {
         return $this->mode;
     }

Here is the caller graph for this function:

◆ getWebLink()

ilWebLinkXmlParser::getWebLink ( )

Get weblink object.

Returns: ilObject

Definition at line 61 of file class.ilWebLinkXmlParser.php.

References $webl.

Referenced by __construct(), handlerBeginTag(), and handlerEndTag().

     {
         return $this->webl;
     }

Here is the caller graph for this function:

◆ handlerBeginTag()

ilWebLinkXmlParser::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 117 of file class.ilWebLinkXmlParser.php.

References $DIC, $ilErr, ilMDSaxParser\$md, $valid, getMode(), ilParameterAppender\getParameterIds(), getWebLink(), LINKS_LOGIN, LINKS_MATRICULATION, LINKS_USER_ID, ilContainer\SORT_MANUAL, and ilContainer\SORT_TITLE.

     {
         global $DIC;
 
         $ilErr = $DIC['ilErr'];
 
         if ($this->in_metadata) {
             parent::handlerBeginTag($a_xml_parser, $a_name, $a_attribs);
             return;
         }
 
         switch ($a_name) {
             case "MetaData":
                 $this->in_metadata = true;
                 
                 // Delete old meta data
                 $md = new ilMD($this->getWebLink()->getId(), 0, 'webr');
                 $md->deleteAll();
 
                 parent::handlerBeginTag($a_xml_parser, $a_name, $a_attribs);
                 break;
 
             case 'WebLink':
                 
                 $this->current_sorting_position = ($a_attribs['position'] ? $a_attribs['position'] : 0);
                 $this->current_link_update = false;
                 $this->current_link_delete = false;
                 $this->current_parameters = array();
                 
                 if ($this->getMode() == self::MODE_CREATE or (isset($a_attribs['action']) and $a_attribs['action'] == 'Create')) {
                     // New weblink
                     $this->current_link = new ilLinkResourceItems($this->getWebLink()->getId());
                 } elseif ($this->getMode() == self::MODE_UPDATE and $a_attribs['action'] == 'Delete') {
                     $this->current_link_delete = true;
                     $this->current_link = new ilLinkResourceItems($this->getWebLink()->getId());
                     $this->current_link->delete($a_attribs['id']);
                     break;
                 } elseif ($this->getMode() == self::MODE_UPDATE and ($a_attribs['action'] == 'Update' or !isset($a_attribs['action']))) {
                     $this->current_link = new ilLinkResourceItems($this->getWebLink()->getId());
                     $this->current_link->readItem($a_attribs['id']);
                     $this->current_link_update = true;
                     
                     // Delete all dynamic parameter
                     include_once './Modules/WebResource/classes/class.ilParameterAppender.php';
                     foreach (ilParameterAppender::getParameterIds($this->getWebLink()->getId(), $a_attribs['id']) as $param_id) {
                         $param = new ilParameterAppender($this->getWebLink()->getId());
                         $param->delete($param_id);
                     }
                 } else {
                     throw new ilWebLinkXmlParserException('Invalid action given for element "Weblink"');
                 }
                 
                 // Active
                 $this->current_link->setActiveStatus($a_attribs['active'] ? 1 : 0);
                 
                 // Valid
                 if (!isset($a_attribs['valid'])) {
                     $valid = 1;
                 } else {
                     $valid = $a_attribs['valid'] ? 1 : 0;
                 }
                 $this->current_link->setValidStatus($valid);
                 
                 // Disable check
                 $this->current_link->setDisableCheckStatus($a_attribs['disableValidation'] ? 1 : 0);
                 
                 // internal
                 if (isset($a_attribs['internal'])) {
                     $this->current_link->setInternal($a_attribs['internal']);
                 }
                 break;
 
 
             case 'Sorting':
                 
                 include_once './Services/Container/classes/class.ilContainerSortingSettings.php';
                 $sort = new ilContainerSortingSettings($this->getWebLink()->getId());
                 $sort->delete();
                 
                 switch ($a_attribs['type']) {
                     case 'Manual':
                         $sort->setSortMode(ilContainer::SORT_MANUAL);
                         break;
                                                 
                     case 'Title':
                     default:
                         $sort->setSortMode(ilContainer::SORT_TITLE);
                 }
                 $sort->save();
                 break;
                 
             case 'WebLinks':
                 $this->sorting_positions = array();
                 // no break
             case 'Title':
             case 'Description':
             case 'Target':
                 // Nothing to do
                 break;
                 
             case 'DynamicParameter':
                 
                 $param = new ilParameterAppender($this->getWebLink()->getId());
                 $param->setName($a_attribs['name']);
                 
                 switch ($a_attribs['type']) {
                     case 'userName':
                         $param->setValue(LINKS_LOGIN);
                         break;
                         
                     case 'userId':
                         $param->setValue(LINKS_USER_ID);
                         break;
                     
                     case 'matriculation':
                         $param->setValue(LINKS_MATRICULATION);
                         break;
                         
                     default:
                         throw new ilWebLinkXmlParserException('Invalid attribute "type" given for element "Dynamic parameter". Aborting');
                         break;
                 }
                 
                 $this->current_parameters[] = $param;
                 break;
         }
     }

Here is the call graph for this function:

◆ handlerCharacterData()

ilWebLinkXmlParser::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 338 of file class.ilWebLinkXmlParser.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()

ilWebLinkXmlParser::handlerEndTag	(	$a_xml_parser,
		$a_name
	)

handler for end of element

Parameters

resource	$a_xml_parser	xml parser
string	$a_name	element name

Exceptions

ilSaxParserException	if invalid xml structure is given
ilWebLinkXMLParserException	missing elements

Definition at line 253 of file class.ilWebLinkXmlParser.php.

References ilContainerSorting\_getInstance(), ilLoggerFactory\getLogger(), and getWebLink().

     {
         if ($this->in_metadata) {
             parent::handlerEndTag($a_xml_parser, $a_name);
         }
         
 
         switch ($a_name) {
             case 'MetaData':
                 $this->in_metadata = false;
                 parent::handlerEndTag($a_xml_parser, $a_name);
                 break;
                 
             case 'WebLinks':
                 $this->getWebLink()->MDUpdateListener('General');
                 $this->getWebLink()->update();
                 
                 // save sorting
                 include_once './Services/Container/classes/class.ilContainerSorting.php';
                 $sorting = ilContainerSorting::_getInstance($this->getWebLink()->getId());
                 $sorting->savePost($this->sorting_positions);
                 ilLoggerFactory::getLogger('webr')->dump($this->sorting_positions);
                 break;
                 
             case 'WebLink':
                 
                 if ($this->current_link_delete) {
                     break;
                 }
                 if (!$this->current_link) {
                     throw new ilSaxParserException('Invalid xml structure given. Missing start tag "WebLink"');
                 }
                 if (!$this->current_link->validate()) {
                     throw new ilWebLinkXmlParserException('Missing required elements "Title, Target"');
                 }
                 
                 if ($this->current_link_update) {
                     $this->current_link->update();
                 } else {
                     $this->current_link->add();
                 }
                 
                 // Save dynamic parameters
                 foreach ($this->current_parameters as $param) {
                     $param->add($this->current_link->getLinkId());
                 }
                 
                 
                 // store positions
                 $this->sorting_positions[$this->current_link->getLinkId()] = (int) $this->current_sorting_position;
 
                 unset($this->current_link);
                 break;
                 
             case 'Title':
                 if ($this->current_link) {
                     $this->current_link->setTitle(trim($this->cdata));
                 }
                 break;
                 
             case 'Description':
                 if ($this->current_link) {
                     $this->current_link->setDescription(trim($this->cdata));
                 }
                 break;
                 
             case 'Target':
                 if ($this->current_link) {
                     $this->current_link->setTarget(trim($this->cdata));
                 }
                 break;
         }
         
         // Reset cdata
         $this->cdata = '';
     }

Here is the call graph for this function:

◆ setHandlers()

ilWebLinkXmlParser::setHandlers ( $a_xml_parser )

set event handlers

Parameters

resource reference to the xml parser private

Definition at line 103 of file class.ilWebLinkXmlParser.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');
     }

◆ setMode()

ilWebLinkXmlParser::setMode ( $a_mode )

Set parsing mode.

Parameters

int $a_mode

Returns

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

     {
         $this->mode = $a_mode;
     }

◆ setWebLink()

ilWebLinkXmlParser::setWebLink ( ilObject $webl )

set weblink

Parameters

ilObject $webl

Returns

Definition at line 52 of file class.ilWebLinkXmlParser.php.

References $webl.

Referenced by __construct().

     {
         $this->webl = $webl;
     }

Here is the caller graph for this function:

◆ start()

ilWebLinkXmlParser::start ( )

Returns

Exceptions

ilSaxParserException	if invalid xml structure is given
ilWebLinkXMLParserException	missing elements

Definition at line 92 of file class.ilWebLinkXmlParser.php.

References ilSaxParser\startParsing().

     {
         return $this->startParsing();
     }

Here is the call graph for this function:

Field Documentation

◆ $current_sorting_position

ilWebLinkXmlParser::$current_sorting_position = 0

private

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

◆ $in_metadata

ilWebLinkXmlParser::$in_metadata = false

private

Definition at line 29 of file class.ilWebLinkXmlParser.php.

◆ $mode

ilWebLinkXmlParser::$mode = self::MODE_UNDEFINED

private

Definition at line 27 of file class.ilWebLinkXmlParser.php.

Referenced by getMode().

◆ $sorting_positions

ilWebLinkXmlParser::$sorting_positions = array()

private

Definition at line 31 of file class.ilWebLinkXmlParser.php.

◆ $webl

ilWebLinkXmlParser::$webl

private

Definition at line 26 of file class.ilWebLinkXmlParser.php.

Referenced by getWebLink(), and setWebLink().

◆ MODE_CREATE

const ilWebLinkXmlParser::MODE_CREATE = 2

Definition at line 24 of file class.ilWebLinkXmlParser.php.

Referenced by ilSoapWebLinkAdministration\createWebLink(), and ilWebResourceImporter\importXmlRepresentation().

◆ MODE_UNDEFINED

const ilWebLinkXmlParser::MODE_UNDEFINED = 0

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

◆ MODE_UPDATE

const ilWebLinkXmlParser::MODE_UPDATE = 1

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

Referenced by ilSoapWebLinkAdministration\updateWebLink().

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

Modules/WebResource/classes/class.ilWebLinkXmlParser.php

Public Member Functions

Data Fields

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getMode()

◆ getWebLink()

◆ handlerBeginTag()

◆ handlerCharacterData()

◆ handlerEndTag()

◆ setHandlers()

◆ setMode()

◆ setWebLink()

◆ start()

Field Documentation

◆ $current_sorting_position

◆ $in_metadata

◆ $mode

◆ $sorting_positions

◆ $webl

◆ MODE_CREATE

◆ MODE_UNDEFINED

◆ MODE_UPDATE