XML parser for weblink xml. More...

Inheritance diagram for ilWebLinkXmlParser:

Collaboration diagram for ilWebLinkXmlParser:

Public Member Functions
	__construct (ilObjLinkResource $webr, string $xml)

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

	setWebLink (ilObjLinkResource $webl)

	getWebLink ()

	setMode (int $a_mode)

	getMode ()

	start ()

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

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

	handlerEndTag ($a_xml_parser, string $a_name)

	handlerCharacterData ($a_xml_parser, string $a_data)

Public Member Functions inherited from ilMDSaxParser
	__construct (?string $a_xml_file='')

	enableMDParsing (bool $a_status)

	getMDParsingStatus ()

	setMDObject (ilMD $md)

	getMDObject ()

	inMetaData ()

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

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

	handlerEndTag ($a_xml_parser, string $a_name)

	handlerCharacterData ($a_xml_parser, string $a_data)

	__getCharacterData ()

	__pushParent (object $md_obj)

	__popParent ()

	__getParent ()

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)

Data Fields
const	MODE_UPDATE = 1

const	MODE_CREATE = 2

Data Fields inherited from ilSaxParser
string	$xml_file

bool	$throw_exception = false

Protected Member Functions
	resetStoredValues ()

Protected Member Functions inherited from ilMDSaxParser
	trimAndStripAttribs (array $attribs)

	trimAndStrip (string $input)

Protected Member Functions inherited from ilSaxParser
	openXMLFile ()

	handleError (string $message)

	setThrowException (bool $throw_exception)

Protected Attributes
const	MODE_UNDEFINED = 0

Protected Attributes inherited from ilMDSaxParser
bool	$md_in_md = false

string	$md_chr_data = ''

ilMDIdentifier	$md_ide = null

ilMDLanguage	$md_lan = null

ilMDDescription	$md_des = null

ilMDLifecycle	$md_lif = null

ilMDContribute	$md_con = null

ilMDEntity	$md_ent = null

ilMDMetaMetadata	$md_met = null

ilMDTechnical	$md_tec = null

ilMDFormat	$md_for = null

ilMDLocation	$md_loc = null

ilMDRequirement	$md_req = null

ilMDOrComposite	$md_orc = null

ilMDEducational	$md_edu = null

ilMDTypicalAgeRange	$md_typ = null

ilMDRights	$md_rig = null

ilMDRelation	$md_rel = null

ilMDIdentifier_	$md_ide_ = null

ilMDAnnotation	$md_ann = null

ilMDClassification	$md_cla = null

ilMDTaxonPath	$md_taxp = null

ilMDTaxon	$md_tax = null

ilMDKeyword	$md_key = null

array	$md_parent = array()

ilMD	$md = null

ilMDGeneral	$md_gen = null

ilLogger	$meta_log

Protected Attributes inherited from ilSaxParser
ilLanguage	$lng = null

Private Attributes
ilObjLinkResource	$webl

ilWebLinkRepository	$web_link_repo

int	$mode = self::MODE_UNDEFINED

bool	$in_metadata = false

array	$sorting_positions = []

string	$cdata = ''

int	$current_sorting_position = 0

bool	$current_item_create = false

bool	$current_item_update = false

bool	$current_item_delete = false

int	$current_link_id

string	$current_title

string	$current_target

bool	$current_active

array	$current_parameters = []

string	$current_description

bool	$current_internal

bool	$is_list = false

string	$list_title

string	$list_description

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

Constructor & Destructor Documentation

◆ __construct()

ilWebLinkXmlParser::__construct	(	ilObjLinkResource	$webr,
		string	$xml
	)

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

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

References ILIAS\GlobalScreen\Provider\__construct(), ILIAS\Survey\Mode\getId(), getWebLink(), ilMDSaxParser\setMDObject(), ilSaxParser\setThrowException(), setWebLink(), and ilSaxParser\setXMLContent().

Here is the call graph for this function:

Member Function Documentation

◆ getMode()

ilWebLinkXmlParser::getMode ( )

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

                             : int
    {
        return $this->mode;
    }

References $mode.

◆ getWebLink()

ilWebLinkXmlParser::getWebLink ( )

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

                                : ilObjLinkResource
    {
        return $this->webl;
    }

References $webl.

Referenced by __construct().

Here is the caller graph for this function:

◆ handlerBeginTag()

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

Parameters

XMLParser | resource $a_xml_parser

Reimplemented from ilMDSaxParser.

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

     : void {
        global $DIC;
        $a_attribs = $this->trimAndStripAttribs($a_attribs);
        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 = (int) ($a_attribs['position'] ?: 0);
                $this->resetStoredValues();
 
                if (
                    $this->getMode() == self::MODE_CREATE ||
                    ($a_attribs['action'] ?? null) === 'Create'
                ) {
                    $this->current_item_create = true;
                } else {
                    if (!($a_attribs['id'] ?? false)) {
                        throw new ilWebLinkXmlParserException(
                            'Updating or deleting not possible, no id was given for element "Weblink"'
                        );
                    }
                    if (
                        $this->getMode() == self::MODE_UPDATE &&
                        ($a_attribs['action'] ?? null) === 'Delete'
                    ) {
                        $this->current_item_delete = true;
                        $this->web_link_repo->deleteItemByLinkId($a_attribs['id']);
                        break;
                    } elseif (
                        $this->getMode() == self::MODE_UPDATE &&
                        (!isset($a_attribs['action']) || $a_attribs['action'] == 'Update')
                    ) {
                        $this->current_link_id = $a_attribs['id'];
                        $this->current_item_update = true;
                    } else {
                        throw new ilWebLinkXmlParserException(
                            'Invalid action given for element "Weblink"'
                        );
                    }
                }
 
                // Active
                $this->current_active = (bool) $a_attribs['active'];
 
                // internal
                if (isset($a_attribs['internal'])) {
                    $this->current_internal = (bool) $a_attribs['internal'];
                }
                break;
 
            case 'Sorting':
 
                $sort = new ilContainerSortingSettings(
                    $this->getWebLink()->getId()
                );
                $sort->delete();
 
                switch ($a_attribs['type'] ?? null) {
                    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':
            case 'ListTitle':
            case 'ListDescription':
                // Nothing to do
                break;
 
            case 'DynamicParameter':
                if (!($a_attribs['name'] ?? false)) {
                    throw new ilWebLinkXmlParserException(
                        'No attribute "name" given for element "Dynamic parameter". Aborting'
                    );
                }
                $name = $a_attribs['name'] ?? null;
 
                switch ($a_attribs['type'] ?? null) {
                    case 'userName':
                        $value = ilWebLinkBaseParameter::VALUES['login'];
                        break;
 
                    case 'userId':
                        $value = ilWebLinkBaseParameter::VALUES['user_id'];
                        break;
 
                    case 'matriculation':
                        $value = ilWebLinkBaseParameter::VALUES['matriculation'];
                        break;
 
                    default:
                        throw new ilWebLinkXmlParserException(
                            'Invalid attribute "type" given for element "Dynamic parameter". Aborting'
                        );
                }
 
                $param = new ilWebLinkDraftParameter($value, $name);
                if ($this->current_item_update && ($a_attribs['id'] ?? null)) {
                    $item = $this->web_link_repo->getItemByLinkId($this->current_link_id);
                    $old_param = $this->web_link_repo->getParameterinItemByParamId(
                        $item,
                        $a_attribs['id']
                    );
                    $param->replaces($old_param);
                }
                $this->current_parameters[] = $param;
 
                break;
 
            case 'ListSettings':
                $this->is_list = true;
                break;
        }
    }

◆ handlerCharacterData()

ilWebLinkXmlParser::handlerCharacterData	(		$a_xml_parser,
		string	$a_data
	)

Parameters

resource $a_xml_parser

Reimplemented from ilMDSaxParser.

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

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

Parameters

resource $a_xml_parser

Reimplemented from ilMDSaxParser.

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

                                                                : void
    {
        $this->cdata = $this->trimAndStrip((string) $this->cdata);
 
        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':
                if ($this->is_list || !$this->web_link_repo->doesOnlyOneItemExist()) {
                    $list_draft = new ilWebLinkDraftList(
                        $this->list_title ?? $this->getWebLink()->getTitle(),
                        $this->list_description ?? $this->getWebLink()->getDescription()
                    );
 
                    if (!$this->web_link_repo->doesListExist()) {
                        $this->web_link_repo->createList($list_draft);
                    } else {
                        $this->web_link_repo->updateList(
                            $this->web_link_repo->getList(),
                            $list_draft
                        );
                    }
                }
 
                $this->getWebLink()->MDUpdateListener('General');
                $this->getWebLink()->update();
 
                // save sorting
                $sorting = ilContainerSorting::_getInstance(
                    $this->getWebLink()->getId()
                );
                $sorting->savePost($this->sorting_positions);
                ilLoggerFactory::getLogger('webr')->dump(
                    $this->sorting_positions
                );
                break;
 
            case 'WebLink':
 
                if ($this->current_item_delete) {
                    //Deletion is already handled in the begin tag.
                    break;
                }
                if (!$this->current_item_create && !$this->current_item_update) {
                    throw new ilSaxParserException(
                        'Invalid xml structure given. Missing start tag "WebLink"'
                    );
                }
                if (!$this->current_title || !$this->current_target) {
                    throw new ilWebLinkXmlParserException(
                        'Missing required elements "Title, Target"'
                    );
                }
 
                if ($this->current_item_update) {
                    $item = $this->web_link_repo->getItemByLinkId($this->current_link_id);
                    $draft = new ilWebLinkDraftItem(
                        $this->current_internal ?? $item->isInternal(),
                        $this->current_title ?? $item->getTitle(),
                        $this->current_description ?? $item->getDescription(),
                        $this->current_target ?? $item->getTarget(),
                        $this->current_active ?? $item->isActive(),
                        $this->current_parameters
                    );
 
                    $this->web_link_repo->updateItem($item, $draft);
                } else {
                    $draft = new ilWebLinkDraftItem(
                        $this->current_internal ?? ilLinkInputGUI::isInternalLink($this->current_target),
                        $this->current_title,
                        $this->current_description ?? null,
                        $this->current_target,
                        $this->current_active,
                        $this->current_parameters
                    );
                    $item = $this->web_link_repo->createItem($draft);
                }
 
                // store positions
                $this->sorting_positions[$item->getLinkId()] = $this->current_sorting_position;
 
                $this->resetStoredValues();
                break;
 
            case 'Title':
                $this->current_title = trim($this->cdata);
                break;
 
            case 'Description':
                $this->current_description = trim($this->cdata);
                break;
 
            case 'Target':
                $this->current_target = trim($this->cdata);
                break;
 
            case 'ListTitle':
                $this->list_title = trim($this->cdata);
                break;
 
            case 'ListDescription':
                $this->list_description = trim($this->cdata);
                break;
        }
 
        // Reset cdata
        $this->cdata = '';
    }

References ilContainerSorting\_getInstance(), ILIAS\Survey\Mode\getId(), ilLoggerFactory\getLogger(), and ilLinkInputGUI\isInternalLink().

Here is the call graph for this function:

◆ resetStoredValues()

ilWebLinkXmlParser::resetStoredValues ( )

protected

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

                                          : void
    {
        $this->current_item_create = false;
        $this->current_item_update = false;
        $this->current_item_delete = false;
 
        $this->current_link_id = null;
        $this->current_title = null;
        $this->current_target = null;
        $this->current_active = null;
        $this->current_parameters = [];
        $this->current_description = null;
        $this->current_internal = null;
    }

◆ setHandlers()

ilWebLinkXmlParser::setHandlers ( $a_xml_parser )

Set event handlers.

Parameters

XMLParser|resource reference to the xml parser

Reimplemented from ilMDSaxParser.

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

◆ setMode()

ilWebLinkXmlParser::setMode ( int $a_mode )

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

                                        : void
    {
        $this->mode = $a_mode;
    }

◆ setWebLink()

ilWebLinkXmlParser::setWebLink ( ilObjLinkResource $webl )

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

                                                       : void
    {
        $this->webl = $webl;
    }

References $webl.

Referenced by __construct().

Here is the caller graph for this function:

◆ start()

ilWebLinkXmlParser::start ( )

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

                           : void
    {
        $this->startParsing();
    }

References startParsing().

Here is the call graph for this function:

◆ startParsing()

ilWebLinkXmlParser::startParsing ( )

stores xml data in array

Exceptions

ilSaxParserException

Reimplemented from ilSaxParser.

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

                                  : void
    {
        parent::startParsing();
 
        // rewrite autogenerated entry
        $general = $this->getMDObject()->getGeneral();
        $identifier_ids = $general->getIdentifierIds();
        if (!isset($identifier_ids[0])) {
            return;
        }
        $identifier = $general->getIdentifier($identifier_ids[0]);
        $identifier->setEntry(
            'il__' . $this->getMDObject()->getObjType() . '_' . $this->getMDObject()->getObjId()
        );
        $identifier->update();
    }