ilWebLinkXmlParser Class Reference
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 | |
| ilMDSaxParser ($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 () |
| ilMDSaxParser ($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 | |
| ilSaxParser ($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 | |
| PEAR ($error_class=null) | |
| Constructor. More... | |
| _PEAR () | |
| Destructor (the emulated type of...). More... | |
| & | 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... | |
| 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... | |
| setErrorHandling ($mode=null, $options=null) | |
| Sets how errors generated by this object should be handled. 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 | |
| Protected Member Functions inherited from ilSaxParser | |
| handleError ($message, $code) | |
| use given error handler to handle error message or internal ilias error message handle More... | |
Detailed Description
Constructor & Destructor Documentation
◆ __construct()
| ilWebLinkXmlParser::__construct | ( | $webr, | |
| $xml | |||
| ) |
Constructor.
Definition at line 37 of file class.ilWebLinkXmlParser.php.
38 {
39 parent::__construct();
40 $this->setXMLContent($xml);
41 $this->setWebLink($webr);
42
45 }
Definition: class.ilMD.php:35
References getWebLink(), ilMDSaxParser\setMDObject(), ilSaxParser\setThrowException(), setWebLink(), and ilSaxParser\setXMLContent().
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.
81 {
83 }
References $mode.
Referenced by handlerBeginTag().
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.
62 {
64 }
References $webl.
Referenced by __construct(), handlerBeginTag(), and handlerEndTag().
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
Reimplemented from ilMDSaxParser.
Definition at line 117 of file class.ilWebLinkXmlParser.php.
118 {
119 global $ilErr;
120
121 if($this->in_metadata)
122 {
123 parent::handlerBeginTag($a_xml_parser,$a_name,$a_attribs);
124 return;
125 }
126
127 switch($a_name)
128 {
129 case "MetaData":
130 $this->in_metadata = true;
131
132 // Delete old meta data
134 $md->deleteAll();
135
136 parent::handlerBeginTag($a_xml_parser,$a_name,$a_attribs);
137 break;
138
139 case 'WebLink':
140
141 $this->current_sorting_position = ($a_attribs['position'] ? $a_attribs['position'] : 0);
142 $this->current_link_update = false;
143 $this->current_link_delete = false;
144 $this->current_parameters = array();
145
146 if($this->getMode() == self::MODE_CREATE or (isset($a_attribs['action']) and $a_attribs['action'] == 'Create'))
147 {
148 // New weblink
150 }
152 {
153 $this->current_link_delete = true;
155 $this->current_link->delete($a_attribs['id']);
156 break;
157 }
158 elseif($this->getMode() == self::MODE_UPDATE and ($a_attribs['action'] == 'Update' or !isset($a_attribs['action'])))
159 {
161 $this->current_link->readItem($a_attribs['id']);
162 $this->current_link_update = true;
163
164 // Delete all dynamic parameter
165 include_once './Modules/WebResource/classes/class.ilParameterAppender.php';
166 foreach(ilParameterAppender::getParameterIds($this->getWebLink()->getId(), $a_attribs['id']) as $param_id)
167 {
169 $param->delete($param_id);
170 }
171 }
172 else
173 {
175 }
176
177 // Active
178 $this->current_link->setActiveStatus($a_attribs['active'] ? 1 : 0);
179
180 // Valid
181 if(!isset($a_attribs['valid']))
182 {
183 $valid = 1;
184 }
185 else
186 {
188 }
189 $this->current_link->setValidStatus($valid);
190
191 // Disable check
192 $this->current_link->setDisableCheckStatus($a_attribs['disableValidation'] ? 1 : 0);
193 break;
194
195
196 case 'Sorting':
197
198 include_once './Services/Container/classes/class.ilContainerSortingSettings.php';
200 $sort->delete();
201
202 switch($a_attribs['type'])
203 {
204 case 'Manual':
205 $sort->setSortMode(ilContainer::SORT_MANUAL);
206 break;
207
208 case 'Title':
209 default:
210 $sort->setSortMode(ilContainer::SORT_TITLE);
211 }
212 $sort->save();
213 break;
214
215 case 'WebLinks':
216 $this->sorting_positions = array();
217 case 'Title':
218 case 'Description':
219 case 'Target':
220 // Nothing to do
221 break;
222
223 case 'DynamicParameter':
224
226 $param->setName($a_attribs['name']);
227
228 switch($a_attribs['type'])
229 {
230 case 'userName':
231# $GLOBALS['ilLog']->write("VALUE: ".LINKS_LOGIN);
232 $param->setValue(LINKS_LOGIN);
233 break;
234
235 case 'userId':
236# $GLOBALS['ilLog']->write("VALUE: ".LINKS_USER_ID);
237 $param->setValue(LINKS_USER_ID);
238 break;
239
240 case 'matriculation':
241# $GLOBALS['ilLog']->write("VALUE: ".LINKS_MATRICULATION);
242 $param->setValue(LINKS_MATRICULATION);
243 break;
244
245 default:
246 throw new ilWebLinkXmlParserException('Invalid attribute "type" given for element "Dynamic parameter". Aborting');
247 break;
248 }
249
250 $this->current_parameters[] = $param;
251 break;
252 }
253 }
static getParameterIds($a_webr_id, $a_link_id)
Get Parameter ids of link.
Definition: class.ilParameterAppender.php:68
XML parser exception.
Definition: class.ilWebLinkXmlParserException.php:15
References $ilErr, ilMDSaxParser\$md, $valid, getMode(), ilParameterAppender\getParameterIds(), getWebLink(), LINKS_LOGIN, LINKS_MATRICULATION, LINKS_USER_ID, ilContainer\SORT_MANUAL, and ilContainer\SORT_TITLE.
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
Reimplemented from ilMDSaxParser.
Definition at line 361 of file class.ilWebLinkXmlParser.php.
362 {
363 if($this->in_metadata)
364 {
365 parent::handlerCharacterData($a_xml_parser,$a_data);
366 }
367
368 if($a_data != "\n")
369 {
370 // Replace multiple tabs with one space
371 $a_data = preg_replace("/\t+/"," ",$a_data);
372 $this->cdata .= $a_data;
373 }
374 }
◆ 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
Reimplemented from ilMDSaxParser.
Definition at line 263 of file class.ilWebLinkXmlParser.php.
264 {
265 if($this->in_metadata)
266 {
267 parent::handlerEndTag($a_xml_parser,$a_name);
268 }
269
271
272 switch($a_name)
273 {
274 case 'MetaData':
275 $this->in_metadata = false;
276 parent::handlerEndTag($a_xml_parser,$a_name);
277 break;
278
279 case 'WebLinks':
281 $this->getWebLink()->update();
282
283 // save sorting
284 include_once './Services/Container/classes/class.ilContainerSorting.php';
286 $sorting->savePost($this->sorting_positions);
288 break;
289
290 case 'WebLink':
291
292 if($this->current_link_delete)
293 {
294 break;
295 }
296 if(!$this->current_link)
297 {
299 }
300 if(!$this->current_link->validate())
301 {
303 }
304
305 if($this->current_link_update)
306 {
307 $this->current_link->update();
308 }
309 else
310 {
311 $this->current_link->add();
312 }
313
314 // Save dynamic parameters
315 foreach($this->current_parameters as $param)
316 {
317 $param->add($this->current_link->getLinkId());
318 }
319
320
321 // store positions
322 $this->sorting_positions[$this->current_link->getLinkId()] = (int) $this->current_sorting_position;
323
324 unset($this->current_link);
325 break;
326
327 case 'Title':
328 if($this->current_link)
329 {
330 $this->current_link->setTitle(trim($this->cdata));
331 }
332 break;
333
334 case 'Description':
335 if($this->current_link)
336 {
337 $this->current_link->setDescription(trim($this->cdata));
338 }
339 break;
340
341 case 'Target':
342 if($this->current_link)
343 {
344 $this->current_link->setTarget(trim($this->cdata));
345 }
346 break;
347 }
348
349 // Reset cdata
350 $this->cdata = '';
351 }
SaxParserException thrown by ilSaxParser if property throwException is set.
Definition: class.ilSaxParserException.php:15
$GLOBALS['PHPCAS_CLIENT']
This global variable is used by the interface class phpCAS.
Definition: CAS.php:276
References $GLOBALS, ilContainerSorting\_getInstance(), ilLoggerFactory\getLogger(), and getWebLink().
Here is the call graph for this function:
◆ setHandlers()
| ilWebLinkXmlParser::setHandlers | ( | $a_xml_parser | ) |
set event handlers
- Parameters
-
resource reference to the xml parser @access private
Reimplemented from ilMDSaxParser.
Definition at line 103 of file class.ilWebLinkXmlParser.php.
104 {
105 xml_set_object($a_xml_parser,$this);
106 xml_set_element_handler($a_xml_parser,'handlerBeginTag','handlerEndTag');
107 xml_set_character_data_handler($a_xml_parser,'handlerCharacterData');
108 }
◆ setMode()
| ilWebLinkXmlParser::setMode | ( | $a_mode | ) |
Set parsing mode.
- Parameters
-
int $a_mode
- Returns
Definition at line 71 of file class.ilWebLinkXmlParser.php.
72 {
73 $this->mode = $a_mode;
74 }
◆ 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().
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.
93 {
95 }
References ilSaxParser\startParsing().
Here is the call graph for this function:
Field Documentation
◆ $current_sorting_position
|
private |
Definition at line 32 of file class.ilWebLinkXmlParser.php.
◆ $in_metadata
|
private |
Definition at line 29 of file class.ilWebLinkXmlParser.php.
◆ $mode
|
private |
Definition at line 27 of file class.ilWebLinkXmlParser.php.
Referenced by getMode().
◆ $sorting_positions
|
private |
Definition at line 31 of file class.ilWebLinkXmlParser.php.
◆ $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
