ILIAS  release_9 Revision v9.13-25-g2c18ec4c24f
ilLearningSequenceXMLParser Class Reference
+ Inheritance diagram for ilLearningSequenceXMLParser:
+ Collaboration diagram for ilLearningSequenceXMLParser:

Public Member Functions

 __construct (protected ilObjLearningSequence $obj, string $xml)
 
 start ()
 
 setHandlers ($a_xml_parser)
 
 handleBeginTag ( $parser, string $name, array $attributes)
 
 handleEndTag ($parser, string $name)
 
 handleCharacterData ($parser, $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 Attributes

array $object
 
array $ls_item_data
 
array $settings
 
array $lp_settings
 
int $counter
 
string $actual_name
 
string $cdata = ''
 
string $current_container_setting = ''
 
- Protected Attributes inherited from ilSaxParser
ilLanguage $lng = null
 

Additional Inherited Members

- Data Fields inherited from ilSaxParser
string $xml_file
 
bool $throw_exception = false
 
- Protected Member Functions inherited from ilSaxParser
 openXMLFile ()
 
 handleError (string $message)
 
 setThrowException (bool $throw_exception)
 

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

ilLearningSequenceXMLParser::__construct ( protected ilObjLearningSequence  $obj,
string  $xml 
)

Definition at line 49 of file class.ilLearningSequenceXMLParser.php.

References ILIAS\MetaData\Repository\Validation\Data\__construct(), ILIAS\Repository\settings(), and ilSaxParser\setXMLContent().

52  {
54 
55  $this->setXMLContent($xml);
56 
57  $this->object = [];
58  $this->ls_item_data = [];
59  $this->settings = [];
60  $this->lp_settings = [];
61  $this->lp_settings["lp_item_ref_ids"] = [];
62  $this->counter = 0;
63  }
__construct(VocabulariesInterface $vocabularies)
setXMLContent(string $a_xml_content)
+ Here is the call graph for this function:

Member Function Documentation

◆ handleBeginTag()

ilLearningSequenceXMLParser::handleBeginTag (   $parser,
string  $name,
array  $attributes 
)

Definition at line 87 of file class.ilLearningSequenceXMLParser.php.

References $counter, ILIAS\Repository\int(), and ILIAS\Repository\settings().

91  : void {
92  $this->actual_name = $name;
93 
94  switch ($name) {
95  case Writer::TAG_LSO:
96  $this->object["ref_id"] = $attributes["ref_id"];
97  $this->settings["members_gallery"] = $attributes['members_gallery'];
98  break;
99  case Writer::TAG_LPSETTING:
100  $this->lp_settings["lp_type"] = $attributes['type'];
101  $this->lp_settings["lp_mode"] = $attributes['mode'];
102  $this->lp_settings["lp_item_ref_ids"] = [];
103  break;
104 
105  case Writer::TAG_LSITEM:
106  $this->counter = (int)$attributes["ref_id"];
107  $this->ls_item_data[$this->counter]["ref_id"] = $attributes["ref_id"];
108  break;
109 
110  case Writer::TAG_CONDITION:
111  $this->ls_item_data[$this->counter]["condition_type"] = $attributes["type"];
112  $this->ls_item_data[$this->counter]["condition_value"] = '';
113  break;
114 
115  case Writer::TAG_CONTAINERSETTING:
116  $this->current_container_setting = $attributes['id'];
117  break;
118 
119  default:
120  break;
121  }
122  }
+ Here is the call graph for this function:

◆ handleCharacterData()

ilLearningSequenceXMLParser::handleCharacterData (   $parser,
  $data 
)

Definition at line 157 of file class.ilLearningSequenceXMLParser.php.

References $data.

157  : void
158  {
159  $this->cdata .= ($data ?? "");
160  }

◆ handleEndTag()

ilLearningSequenceXMLParser::handleEndTag (   $parser,
string  $name 
)

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

References $current_container_setting, and ilContainer\_writeContainerSetting().

124  : void
125  {
126  $this->cdata = trim($this->cdata);
127 
128  switch ($name) {
129  case Writer::TAG_LPREFID:
130  $this->lp_settings["lp_item_ref_ids"][] = trim($this->cdata);
131  break;
132  case Writer::TAG_CONTAINERSETTING:
133  if ($this->current_container_setting) {
135  $this->obj->getId(),
137  trim($this->cdata)
138  );
139  }
140  break;
141 
142  case Writer::TAG_TITLE:
143  $this->obj->setTitle(trim($this->cdata));
144  break;
145 
146  case Writer::TAG_DESCRIPTION:
147  $this->obj->setDescription(trim($this->cdata));
148  break;
149 
150  default:
151  break;
152  }
153 
154  $this->cdata = '';
155  }
static _writeContainerSetting(int $a_id, string $a_keyword, string $a_value)
+ Here is the call graph for this function:

◆ setHandlers()

ilLearningSequenceXMLParser::setHandlers (   $a_xml_parser)

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

80  : void
81  {
82  xml_set_object($a_xml_parser, $this);
83  xml_set_element_handler($a_xml_parser, "handleBeginTag", "handleEndTag");
84  xml_set_character_data_handler($a_xml_parser, 'handleCharacterData');
85  }

◆ start()

ilLearningSequenceXMLParser::start ( )
Returns
array<string, mixed>

Definition at line 68 of file class.ilLearningSequenceXMLParser.php.

References $lp_settings, $ls_item_data, $object, $settings, and ilSaxParser\startParsing().

68  : array
69  {
70  $this->startParsing();
71  $ret = [];
72  $ret["object"] = $this->object;
73  $ret["item_data"] = $this->ls_item_data;
74  $ret["settings"] = $this->settings;
75  $ret["lp_settings"] = $this->lp_settings;
76 
77  return $ret;
78  }
startParsing()
stores xml data in array
+ Here is the call graph for this function:

Field Documentation

◆ $actual_name

string ilLearningSequenceXMLParser::$actual_name
protected

Definition at line 45 of file class.ilLearningSequenceXMLParser.php.

◆ $cdata

string ilLearningSequenceXMLParser::$cdata = ''
protected

Definition at line 46 of file class.ilLearningSequenceXMLParser.php.

◆ $counter

int ilLearningSequenceXMLParser::$counter
protected

Definition at line 44 of file class.ilLearningSequenceXMLParser.php.

Referenced by handleBeginTag().

◆ $current_container_setting

string ilLearningSequenceXMLParser::$current_container_setting = ''
protected

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

Referenced by handleEndTag().

◆ $lp_settings

array ilLearningSequenceXMLParser::$lp_settings
protected

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

Referenced by start().

◆ $ls_item_data

array ilLearningSequenceXMLParser::$ls_item_data
protected

Definition at line 33 of file class.ilLearningSequenceXMLParser.php.

Referenced by start().

◆ $object

array ilLearningSequenceXMLParser::$object
protected

Definition at line 28 of file class.ilLearningSequenceXMLParser.php.

Referenced by start().

◆ $settings

array ilLearningSequenceXMLParser::$settings
protected

Definition at line 38 of file class.ilLearningSequenceXMLParser.php.

Referenced by start().


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