ilMDXMLCopier Class Reference

Inheritance diagram for ilMDXMLCopier:

Collaboration diagram for ilMDXMLCopier:

Public Member Functions
	__construct ($content, $a_rbac_id, $a_obj_id, $a_obj_type)
	startParsing ()
	handlerBeginTag ($a_xml_parser, string $a_name, array $a_attribs)
	handlerEndTag ($a_xml_parser, string $a_name)
	handlerCharacterData ($a_xml_parser, string $a_data)
	__setFilter ()
	__inFilter (string $a_tag_name)
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)

Protected Attributes
bool	$in_meta_data = false
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
array	$filter = []

Additional Inherited Members
Data Fields inherited from ilSaxParser
string	$xml_file
bool	$throw_exception = false
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)

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilMDXMLCopier::__construct	(		$content,
			$a_rbac_id,
			$a_obj_id,
			$a_obj_type
	)

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

References ILIAS\GlobalScreen\Provider\__construct(), __setFilter(), ilMDSaxParser\setMDObject(), and ilSaxParser\setXMLContent().

    {
        $this->setMDObject(new ilMD($a_rbac_id, $a_obj_id, $a_obj_type));

        parent::__construct();
        $this->setXMLContent($content);

        // set filter of tags which are handled in this class
        $this->__setFilter();
    }

Here is the call graph for this function:

Member Function Documentation

__inFilter()

ilMDXMLCopier::__inFilter

(

string

$a_tag_name

)

Definition at line 126 of file class.ilMDXMLCopier.php.

References ILIAS\Repository\filter().

Referenced by handlerBeginTag(), and handlerEndTag().

                                                  : bool
    {
        return in_array($a_tag_name, $this->filter, true);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

__setFilter()

ilMDXMLCopier::__setFilter

(

)

Definition at line 121 of file class.ilMDXMLCopier.php.

References ILIAS\Repository\filter().

Referenced by __construct().

                                 : void
    {
        $this->filter[] = 'Identifier';
    }

Here is the call graph for this function:

Here is the caller graph for this function:

handlerBeginTag()

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

Parameters

XMLParser | resource

$a_xml_parser

reference to the xml parser

Definition at line 64 of file class.ilMDXMLCopier.php.

References ilMDSaxParser\__getParent(), __inFilter(), and ilMDSaxParser\__pushParent().

                                                                                    : void
    {
        if ($this->in_meta_data && !$this->__inFilter($a_name)) {
            parent::handlerBeginTag($a_xml_parser, $a_name, $a_attribs);
            return;
        }

        switch ($a_name) {
            case 'MetaData':
                $this->in_meta_data = true;
                parent::handlerBeginTag($a_xml_parser, $a_name, $a_attribs);
                break;

            case 'Identifier':
                $par = $this->__getParent();
                $this->md_ide = $par->addIdentifier();
                $this->md_ide->setCatalog($a_attribs['Catalog'] ?? '');
                $this->md_ide->setEntry('il__' . $this->md->getObjType() . '_' . $this->md->getObjId());
                $this->md_ide->save();
                $this->__pushParent($this->md_ide);
                break;
        }
    }

Here is the call graph for this function:

handlerCharacterData()

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

Parameters

XMLParser | resource

$a_xml_parser

reference to the xml parser

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

                                                                       : void
    {
        if ($this->in_meta_data) {
            parent::handlerCharacterData($a_xml_parser, $a_data);
        }
    }

handlerEndTag()

ilMDXMLCopier::handlerEndTag	(		$a_xml_parser,
		string	$a_name
	)

Parameters

XMLParser | resource

$a_xml_parser

reference to the xml parser

Definition at line 91 of file class.ilMDXMLCopier.php.

References ilMDSaxParser\__getParent(), __inFilter(), and ilMDSaxParser\__popParent().

                                                                : void
    {
        if ($this->in_meta_data && !$this->__inFilter($a_name)) {
            parent::handlerEndTag($a_xml_parser, $a_name);
            return;
        }
        switch ($a_name) {
            case 'Identifier':
                $par = $this->__getParent();
                $par->update();
                $this->__popParent();
                break;

            case 'MetaData':
                $this->in_meta_data = false;
                parent::handlerEndTag($a_xml_parser, $a_name);
                break;
        }
    }

Here is the call graph for this function:

startParsing()

ilMDXMLCopier::startParsing

(

)

Definition at line 43 of file class.ilMDXMLCopier.php.

References ilMDSaxParser\getMDObject(), and ilMDIdentifier\setEntry().

Referenced by ilMD\cloneMD().

                                  : void
    {
        // delete existing entries from creations process
        $clone_md = $this->getMDObject();
        $clone_md->deleteAll();

        // rewrite autogenerated entry
        $identifier = new ilMDIdentifier(
            $clone_md->getRBACId(),
            $clone_md->getObjId(),
            $clone_md->getObjType(),
        );
        $identifier->setEntry('il__' . $clone_md->getObjType() . '_' . $clone_md->getObjId());
        $identifier->update();

        parent::startParsing();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$filter

array ilMDXMLCopier::$filter = []

private

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

$in_meta_data

bool ilMDXMLCopier::$in_meta_data = false

protected

Definition at line 30 of file class.ilMDXMLCopier.php.

---

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

• components/ILIAS/MetaData/classes/class.ilMDXMLCopier.php