ILIAS  release_7 Revision v7.30-3-g800a261c036
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 ()
 stores xml data in array 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...
 
 __setFilter ()
 
 __inFilter ($a_tag_name)
 
- 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 ()
 
- Public Member Functions inherited from ilSaxParser
 __construct ($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
 __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

 $filter = array()
 
- 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()
 

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 ilMDSaxParser
 trimAndStripAttribs (array $attribs)
 
 trimAndStrip (string $input)
 
- 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

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

Constructor & Destructor Documentation

◆ __construct()

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

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

42 {
43 $this->setMDObject(new ilMD($a_rbac_id, $a_obj_id, $a_obj_type));
44
46 $this->setXMLContent($content);
47
48 // set filter of tags which are handled in this class
49 $this->__setFilter();
50 }
setXMLContent($a_xml_content)
__construct(Container $dic, ilPlugin $plugin)
@inheritDoc

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

+ Here is the call graph for this function:

Member Function Documentation

◆ __inFilter()

ilMDXMLCopier::__inFilter (   $a_tag_name)

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

146 {
147 return in_array($a_tag_name, $this->filter);
148 }
filter()
Definition: filter.php:2

References filter().

Referenced by handlerBeginTag(), and handlerEndTag().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ __setFilter()

ilMDXMLCopier::__setFilter ( )

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

137 {
138 $this->filter[] = 'Identifier';
139 }

References filter().

Referenced by __construct().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ handlerBeginTag()

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

handler for begin of element

Reimplemented from ilMDSaxParser.

Reimplemented in ilSCORM13MDImporter.

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

78 {
79 if ($this->in_meta_data and !$this->__inFilter($a_name)) {
80 parent::handlerBeginTag($a_xml_parser, $a_name, $a_attribs);
81 return true;
82 }
83
84
85 switch ($a_name) {
86 case 'MetaData':
87 $this->in_meta_data = true;
88 parent::handlerBeginTag($a_xml_parser, $a_name, $a_attribs);
89 break;
90
91 case 'Identifier':
92 $par = &$this->__getParent();
93 $this->md_ide = &$par->addIdentifier();
94 $this->md_ide->setCatalog($a_attribs['Catalog']);
95 $this->md_ide->setEntry('il__' . $this->md->getObjType() . '_' . $this->md->getObjId());
96 $this->md_ide->save();
97 $this->__pushParent($this->md_ide);
98 break;
99 }
100 return true;
101 }
__inFilter($a_tag_name)

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

+ Here is the call graph for this function:

◆ handlerCharacterData()

ilMDXMLCopier::handlerCharacterData (   $a_xml_parser,
  $a_data 
)

handler for character data

Reimplemented from ilMDSaxParser.

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

125 {
126 if ($this->in_meta_data) {
127 parent::handlerCharacterData($a_xml_parser, $a_data);
128 return true;
129 }
130 }

◆ handlerEndTag()

ilMDXMLCopier::handlerEndTag (   $a_xml_parser,
  $a_name 
)

handler for end of element

Reimplemented from ilMDSaxParser.

Reimplemented in ilSCORM13MDImporter.

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

103 {
104 if ($this->in_meta_data and !$this->__inFilter($a_name)) {
105 parent::handlerEndTag($a_xml_parser, $a_name);
106 return true;
107 }
108 switch ($a_name) {
109 case 'Identifier':
110 $par = &$this->__getParent();
111 $par->update();
112 $this->__popParent();
113 break;
114
115
116 case 'MetaData':
117 $this->in_meta_data = false;
118 parent::handlerEndTag($a_xml_parser, $a_name);
119 break;
120 }
121 return true;
122 }

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

+ Here is the call graph for this function:

◆ setHandlers()

ilMDXMLCopier::setHandlers (   $a_xml_parser)

set event handlers

Parameters
resourcereference to the xml parser @access private

Reimplemented from ilMDSaxParser.

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

71 {
72 xml_set_object($a_xml_parser, $this);
73 xml_set_element_handler($a_xml_parser, 'handlerBeginTag', 'handlerEndTag');
74 xml_set_character_data_handler($a_xml_parser, 'handlerCharacterData');
75 }

◆ startParsing()

ilMDXMLCopier::startParsing ( )

stores xml data in array

@access private

Exceptions
ilSaxParserExceptionor ILIAS Error

Reimplemented from ilSaxParser.

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

53 {
54 // delete existing entries from creations process
55 $clone_md = $this->getMDObject();
56 $clone_md->deleteAll();
57
58 // rewrite autogenerated entry
59 $identifier = new ilMDIdentifier(
60 $clone_md->getRBACId(),
61 $clone_md->getObjId(),
62 $clone_md->getObjType(),
63 );
64 $identifier->setEntry('il__' . $clone_md->getObjType() . '_' . $clone_md->getObjId());
65 $identifier->update();
66
67 parent::startParsing();
68 }

References ilMDSaxParser\getMDObject().

Referenced by ilSCORM13MDImporter\import().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

Field Documentation

◆ $filter

ilMDXMLCopier::$filter = array()

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


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