Public Member Functions |
Data Fields |
Static Public Attributes |
Protected Attributes |
Private Attributes
ilGroupXMLParser Class Reference
Inheritance diagram for ilGroupXMLParser:
Collaboration diagram for ilGroupXMLParser:
Public Member Functions | |
| __construct ($a_xml, $a_parent_id) | |
| Constructor. More... | |
| __pushParentId ($a_id) | |
| __popParentId () | |
| __getParentId () | |
| setHandlers ($a_xml_parser) | |
| set event handler should be overwritten by inherited class @access private More... | |
| startParsing () | |
| start the parser More... | |
| handlerBeginTag ($a_xml_parser, $a_name, $a_attribs) | |
| handler for begin of element More... | |
| handlerEndTag ($a_xml_parser, $a_name) | |
| handlerCharacterData ($a_xml_parser, $a_data) | |
| handler for character data More... | |
| __save () | |
| __assignMembers () | |
| __initGroupObject () | |
| __parseId ($a_id) | |
| setMode ($mode) | |
| setGroup (& $grp) | |
| __initContainerSorting ($a_attribs, $a_group_id) | |
| 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 | |
| $group_data | |
| $group_obj | |
| $parent | |
| $counter | |
| $mode | |
| $grp | |
| 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() | |
Static Public Attributes | |
| static | $CREATE = 1 |
| static | $UPDATE = 2 |
Protected Attributes | |
| $log | |
Private Attributes | |
| $participants = null | |
| $current_container_setting | |
| $sort = null | |
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 ilSaxParser | |
| handleError ($message, $code) | |
| use given error handler to handle error message or internal ilias error message handle More... | |
Detailed Description
Group Import Parser.
- Version
- Id
- class.ilGroupXMLParser.php 15678 2008-01-06 20:40:55Z akill
Definition at line 39 of file class.ilGroupXMLParser.php.
Constructor & Destructor Documentation
◆ __construct()
| ilGroupXMLParser::__construct | ( | $a_xml, | |
| $a_parent_id | |||
| ) |
Constructor.
- Parameters
-
string $a_xml_file xml file
@access public
Reimplemented from ilSaxParser.
Definition at line 70 of file class.ilGroupXMLParser.php.
71 {
72 define('EXPORT_VERSION',2);
73
74 parent::__construct(null);
75
76 $this->mode = ilGroupXMLParser::$CREATE;
77 $this->grp = null;
78
80
81 $this->setXMLContent($a_xml);
82
83 // SET MEMBER VARIABLES
84 $this->__pushParentId($a_parent_id);
85
86
87 }
$GLOBALS['loaded']
Global hash that tracks already loaded includes.
Definition: generate-standalone.php:18
References $CREATE, $GLOBALS, __pushParentId(), and ilSaxParser\setXMLContent().
Here is the call graph for this function:
Member Function Documentation
◆ __assignMembers()
| ilGroupXMLParser::__assignMembers | ( | ) |
Definition at line 462 of file class.ilGroupXMLParser.php.
463 {
465
468 $this->participants->updateNotification($ilUser->getId(),$ilSetting->get('mail_grp_admin_notification', true));
469
470 // attach ADMINs
471 if (count($this->group_data["admin"]["attach"]))
472 {
473 foreach($this->group_data["admin"]["attach"] as $user)
474 {
476 {
477 if($id_data['local'] or $id_data['imported'])
478 {
480 if(in_array($user,(array) $this->group_data['notifications']))
481 {
482 $this->participants->updateNotification($id_data['usr_id'],true);
483 }
484 }
485 }
486 }
487 }
488 // detach ADMINs
489 if (count($this->group_data["admin"]["detach"]))
490 {
491 foreach($this->group_data["admin"]["detach"] as $user)
492 {
494 {
495 if($id_data['local'] or $id_data['imported'])
496 {
497 if($this->participants->isAssigned($id_data['usr_id']))
498 {
499 $this->participants->delete($id_data['usr_id']);
500 }
501 }
502 }
503 }
504 }
505 // MEMBER
506 if (count($this->group_data["member"]["attach"]))
507 {
508 foreach($this->group_data["member"]["attach"] as $user)
509 {
511 {
512 if($id_data['local'] or $id_data['imported'])
513 {
515 }
516 }
517 }
518 }
519
520 if (count($this->group_data["member"]["detach"]))
521 {
522 foreach($this->group_data["member"]["detach"] as $user)
523 {
525 {
526 if($id_data['local'] or $id_data['imported'])
527 {
528 if($this->participants->isAssigned($id_data['usr_id']))
529 {
530 $this->participants->delete($id_data['usr_id']);
531 }
532 }
533 }
534 }
535 }
536 return true;
537 }
References ilSaxParser\$ilias, $ilSetting, $ilUser, __parseId(), IL_GRP_ADMIN, and IL_GRP_MEMBER.
Referenced by __save().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ __getParentId()
| ilGroupXMLParser::__getParentId | ( | ) |
Definition at line 99 of file class.ilGroupXMLParser.php.
100 {
101 return $this->parent[count($this->parent) - 1];
102 }
Referenced by __save().
Here is the caller graph for this function:
◆ __initContainerSorting()
| ilGroupXMLParser::__initContainerSorting | ( | $a_attribs, | |
| $a_group_id | |||
| ) |
Definition at line 595 of file class.ilGroupXMLParser.php.
596 {
597 include_once './Services/Container/classes/class.ilContainerSortingSettings.php';
598 ilContainerSortingSettings::_importContainerSortingSettings($a_attribs, $a_group_id);
599 }
static _importContainerSortingSettings($attibs, $obj_id)
sorting import for all container objects
Definition: class.ilContainerSortingSettings.php:490
References ilContainerSortingSettings\_importContainerSortingSettings().
Referenced by __save(), and handlerBeginTag().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ __initGroupObject()
| ilGroupXMLParser::__initGroupObject | ( | ) |
Definition at line 539 of file class.ilGroupXMLParser.php.
540 {
541 include_once "./Modules/Group/classes/class.ilObjGroup.php";
542
544 {
546 } elseif ($this->mode == ilGroupXMLParser::$UPDATE) {
547 $this->group_obj = $this->grp;
548 }
549
550 return true;
551 }
References $CREATE, $grp, and $UPDATE.
Referenced by __save(), and handlerEndTag().
Here is the caller graph for this function:
◆ __parseId()
| ilGroupXMLParser::__parseId | ( | $a_id | ) |
Definition at line 553 of file class.ilGroupXMLParser.php.
554 {
555 global $ilias;
556
557 $fields = explode('_',$a_id);
558
559 if(!is_array($fields) or
560 $fields[0] != 'il' or
561 !is_numeric($fields[1]) or
562 $fields[2] != 'usr' or
563 !is_numeric($fields[3]))
564 {
565 return false;
566 }
568 {
569 return array('imported' => true,
570 'local' => false,
571 'usr_id' => $id);
572 }
573 if(($fields[1] == $ilias->getSetting('inst_id',0)) and ($user = ilObjUser::_lookupName($fields[3])))
574 {
575 if(strlen($user['login']))
576 {
577 return array('imported' => false,
578 'local' => true,
579 'usr_id' => $fields[3]);
580 }
581 }
583 return false;
584 }
References $GLOBALS, ilSaxParser\$ilias, ilObjUser\_getImportedUserId(), and ilObjUser\_lookupName().
Referenced by __assignMembers().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ __popParentId()
| ilGroupXMLParser::__popParentId | ( | ) |
Definition at line 93 of file class.ilGroupXMLParser.php.
94 {
95 array_pop($this->parent);
96
97 return true;
98 }
◆ __pushParentId()
| ilGroupXMLParser::__pushParentId | ( | $a_id | ) |
Definition at line 89 of file class.ilGroupXMLParser.php.
90 {
91 $this->parent[] = $a_id;
92 }
Referenced by __construct(), and __save().
Here is the caller graph for this function:
◆ __save()
| ilGroupXMLParser::__save | ( | ) |
mode can be create or update
Definition at line 327 of file class.ilGroupXMLParser.php.
328 {
329 if($this->group_imported)
330 {
331 return true;
332 }
333
334 $this->__initGroupObject();
335
336 $this->group_obj->setImportId($this->group_data["id"]);
337 $this->group_obj->setTitle($this->group_data["title"]);
338 $this->group_obj->setDescription($this->group_data["description"]);
339 $this->group_obj->setInformation((string) $this->group_data['information']);
340
341 $ownerChanged = false;
342 if (isset($this->group_data["owner"]))
343 {
344 $owner = $this->group_data["owner"];
345 if (!is_numeric($owner))
346 {
347 $owner = ilUtil::__extractId ($owner, IL_INST_ID);
348 }
349 if (is_numeric($owner) && $owner > 0)
350 {
351 $this->group_obj->setOwner($owner);
352 $ownerChanged = true;
353 }
354 }
355
360 {
361 $this->group_obj->create();
362 $this->group_obj->createReference();
363 $this->group_obj->putInTree($this->__getParentId());
364 $this->group_obj->setPermissions($this->__getParentId());
365 $this->group_obj->initGroupStatus($this->group_data["type"] == "open" ? GRP_TYPE_PUBLIC : GRP_TYPE_CLOSED);
366 }
367 else
368 {
369 switch($this->group_data['type'])
370 {
371 case 'open':
372 $grp_status = GRP_TYPE_PUBLIC;
373 break;
374
375 case 'closed':
376 $grp_status = GRP_TYPE_CLOSED;
377 break;
378
379 }
380
381 $this->group_obj->updateOwner();
382 if($this->group_obj->getGroupStatus() != $grp_status)
383 {
384 $this->group_obj->setGroupType($grp_status);
385 $this->group_obj->updateGroupType();
386 }
387 }
388
389 // SET GROUP SPECIFIC DATA
390 switch($this->group_data['registration_type'])
391 {
392 case 'direct':
393 case 'enabled':
394 $flag = GRP_REGISTRATION_DIRECT;
395 break;
396
397 case 'disabled':
398 $flag = GRP_REGISTRATION_DEACTIVATED;
399 break;
400
401 case 'confirmation':
402 $flag = GRP_REGISTRATION_REQUEST;
403 break;
404
405 case 'password':
406 $flag = GRP_REGISTRATION_PASSWORD;
407 break;
408
409 default:
410 $flag = GRP_REGISTRATION_DIRECT;
411 }
412 $this->group_obj->setRegistrationType($flag);
413
415 if($this->group_data['expiration_end'])
416 {
418 }
419
420 $start = clone $end;
421 if($this->group_data['expiration_start'])
422 {
424 }
425
426 $this->group_obj->setRegistrationStart($start);
427 $this->group_obj->setRegistrationEnd($end);
428 $this->group_obj->setPassword($this->group_data['password']);
429 $this->group_obj->enableUnlimitedRegistration(!isset($this->group_data['expiration_end']));
430 $this->group_obj->enableMembershipLimitation($this->group_data['max_members_enabled']);
431 $this->group_obj->setMaxMembers($this->group_data['max_members'] ? $this->group_data['max_members'] : 0);
432 $this->group_obj->enableWaitingList($this->group_data['waiting_list_enabled']);
433
434 $this->group_obj->setWaitingListAutoFill($this->group_data['auto_wait']);
435 $this->group_obj->setCancellationEnd($this->group_data['cancel_end']);
436 $this->group_obj->setMinMembers($this->group_data['min_members']);
437
438 $this->group_obj->setMailToMembersType((int) $this->group_data['mail_members_type']);
439
441 {
442 $this->group_obj->initGroupStatus($this->group_data["type"] == "open" ? 0 : 1);
443 }
444
445 $this->group_obj->update();
446
447 // ASSIGN ADMINS/MEMBERS
448 $this->__assignMembers();
449
450 $this->__pushParentId($this->group_obj->getRefId());
451
452 if($this->sort)
453 {
454 $this->__initContainerSorting($this->sort, $this->group_obj->getId());
455 }
456
457 $this->group_imported = true;
458
459 return true;
460 }
__initContainerSorting($a_attribs, $a_group_id)
Definition: class.ilGroupXMLParser.php:595
static __extractId($ilias_id, $inst_id)
extract ref id from role title, e.g.
Definition: class.ilUtil.php:4656
References $CREATE, $start, __assignMembers(), ilUtil\__extractId(), __getParentId(), __initContainerSorting(), __initGroupObject(), __pushParentId(), GRP_REGISTRATION_DEACTIVATED, GRP_REGISTRATION_DIRECT, GRP_REGISTRATION_PASSWORD, GRP_REGISTRATION_REQUEST, GRP_TYPE_CLOSED, GRP_TYPE_PUBLIC, and IL_CAL_UNIX.
Referenced by handlerEndTag().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ handlerBeginTag()
| ilGroupXMLParser::handlerBeginTag | ( | $a_xml_parser, | |
| $a_name, | |||
| $a_attribs | |||
| ) |
handler for begin of element
Definition at line 137 of file class.ilGroupXMLParser.php.
138 {
139 global $ilErr;
140
141 switch($a_name)
142 {
143 // GROUP DATA
144 case "group":
145 $this->group_data["admin"] = array();
146 $this->group_data["member"] = array();
147
148 $this->group_data["type"] = $a_attribs["type"];
149 $this->group_data["id"] = $a_attribs["id"];
150
151 break;
152
153 case 'title':
154 break;
155
156 case "owner":
157 $this->group_data["owner"] = $a_attribs["id"];
158 break;
159
160 case 'registration':
161 $this->group_data['registration_type'] = $a_attribs['type'];
162 $this->group_data['waiting_list_enabled'] = $a_attribs['waitingList'] == 'Yes' ? true : false;
163 break;
164
165 case 'maxMembers':
166 $this->group_data['max_members_enabled'] = $a_attribs['enabled'] == 'Yes' ? true : false;
167 break;
168
169 case "admin":
170 if (!isset($a_attribs['action']) || $a_attribs['action'] == "Attach")
171 {
172 $this->group_data["admin"]["attach"][] = $a_attribs["id"];
173 }
174 elseif (isset($a_attribs['action']) || $a_attribs['action'] == "Detach")
175 {
176 $this->group_data["admin"]["detach"][] = $a_attribs["id"];
177 }
178
179 if(isset($a_attribs['notification']) and $a_attribs['notification'] == 'Yes')
180 {
181 $this->group_data['notifications'][] = $a_attribs['id'];
182 }
183
184 break;
185
186 case "member":
187 if (!isset($a_attribs['action']) || $a_attribs['action'] == "Attach")
188 {
190 $this->group_data["member"]["attach"][] = $a_attribs["id"];
191 } elseif (isset($a_attribs['action']) || $a_attribs['action'] == "Detach")
192 {
194 $this->group_data["member"]["detach"][] = $a_attribs["id"];
195 }
196
197 break;
198
199 case 'ContainerSetting':
200 $this->current_container_setting = $a_attribs['id'];
201 break;
202
203 case 'Sort':
204
205 if($this->group_imported)
206 {
207 $this->__initContainerSorting($a_attribs, $this->group_obj->getId());
208 }
209 else
210 {
211 $this->sort = $a_attribs;
212 }
213
214 break;
215
216 case 'WaitingListAutoFill':
217 case 'CancellationEnd':
218 case 'minMembers':
219 case 'mailMembersType':
220 break;
221 }
222 }
References $GLOBALS, $ilErr, and __initContainerSorting().
Here is the call graph for this function:
◆ handlerCharacterData()
| ilGroupXMLParser::handlerCharacterData | ( | $a_xml_parser, | |
| $a_data | |||
| ) |
handler for character data
Definition at line 311 of file class.ilGroupXMLParser.php.
312 {
313 // i don't know why this is necessary, but
314 // the parser seems to convert ">" to ">" and "<" to "<"
315 // in character data, but we don't want that, because it's the
316 // way we mask user html in our content, so we convert back...
317 $a_data = str_replace("<","<",$a_data);
318 $a_data = str_replace(">",">",$a_data);
319
320 if(!empty($a_data))
321 {
322 $this->cdata .= $a_data;
323 }
324 }
◆ handlerEndTag()
| ilGroupXMLParser::handlerEndTag | ( | $a_xml_parser, | |
| $a_name | |||
| ) |
Definition at line 225 of file class.ilGroupXMLParser.php.
226 {
227 switch($a_name)
228 {
229 case "title":
230 $this->group_data["title"] = trim($this->cdata);
231 break;
232
233 case "description":
234 $this->group_data["description"] = trim($this->cdata);
235 break;
236
237 case 'information':
238 $this->group_data['information'] = trim($this->cdata);
239 break;
240
241 case 'password':
242 $this->group_data['password'] = trim($this->cdata);
243 break;
244
245 case 'maxMembers':
246 $this->group_data['max_members'] = trim($this->cdata);
247 break;
248
249 case 'expiration':
250 $this->group_data['expiration_end'] = trim($this->cdata);
251 break;
252
253 case 'start':
254 $this->group_data['expiration_start'] = trim($this->cdata);
255 break;
256
257 case 'end':
258 $this->group_data['expiration_end'] = trim($this->cdata);
259 break;
260
261 case "group":
262 // NOW SAVE THE NEW OBJECT (if it hasn't been imported)
263 $this->__save();
264 break;
265
266 case 'ContainerSetting':
267 if($this->current_container_setting)
268 {
269 // #17357
271 {
272 $this->__initGroupObject();
273 }
275 $this->group_obj->getId(),
276 $this->current_container_setting,
277 $this->cdata);
278 }
279 break;
280
281 case 'WaitingListAutoFill':
282 $this->group_data['auto_wait'] = trim($this->cdata);
283 break;
284
285 case 'CancellationEnd':
286 if((int)$this->cdata)
287 {
289 }
290 break;
291
292 case 'minMembers':
293 if((int)$this->cdata)
294 {
295 $this->group_data['min_members'] = (int)$this->cdata;
296 }
297 break;
298
299 case 'mailMembersType':
300 $this->group_data['mail_members_type'] = (int) $this->cdata;
301 break;
302
303 }
304 $this->cdata = '';
305 }
static _writeContainerSetting($a_id, $a_keyword, $a_value)
Definition: class.ilContainer.php:384
References __initGroupObject(), __save(), ilContainer\_writeContainerSetting(), and IL_CAL_UNIX.
Here is the call graph for this function:
◆ setGroup()
| ilGroupXMLParser::setGroup | ( | & | $grp | ) |
Definition at line 591 of file class.ilGroupXMLParser.php.
References $grp.
◆ setHandlers()
| ilGroupXMLParser::setHandlers | ( | $a_xml_parser | ) |
set event handler should be overwritten by inherited class @access private
Reimplemented from ilSaxParser.
Definition at line 109 of file class.ilGroupXMLParser.php.
110 {
111 xml_set_object($a_xml_parser,$this);
112 xml_set_element_handler($a_xml_parser,'handlerBeginTag','handlerEndTag');
113 xml_set_character_data_handler($a_xml_parser,'handlerCharacterData');
114 }
◆ setMode()
| ilGroupXMLParser::setMode | ( | $mode | ) |
Definition at line 587 of file class.ilGroupXMLParser.php.
References $mode.
◆ startParsing()
| ilGroupXMLParser::startParsing | ( | ) |
start the parser
Reimplemented from ilSaxParser.
Definition at line 119 of file class.ilGroupXMLParser.php.
120 {
121 parent::startParsing();
122
124 {
125 return is_object($this->group_obj) ? $this->group_obj->getRefId() : false;
126 }
127 else
128 {
129 return is_object($this->group_obj) ? $this->group_obj->update() : false;
130 }
131 }
References $CREATE.
Field Documentation
◆ $counter
| ilGroupXMLParser::$counter |
Definition at line 57 of file class.ilGroupXMLParser.php.
◆ $CREATE
|
static |
Definition at line 41 of file class.ilGroupXMLParser.php.
Referenced by __construct(), __initGroupObject(), __save(), and startParsing().
◆ $current_container_setting
|
private |
Definition at line 50 of file class.ilGroupXMLParser.php.
◆ $group_data
| ilGroupXMLParser::$group_data |
Definition at line 53 of file class.ilGroupXMLParser.php.
◆ $group_obj
| ilGroupXMLParser::$group_obj |
Definition at line 54 of file class.ilGroupXMLParser.php.
◆ $grp
| ilGroupXMLParser::$grp |
Definition at line 60 of file class.ilGroupXMLParser.php.
Referenced by __initGroupObject(), and setGroup().
◆ $log
|
protected |
Definition at line 47 of file class.ilGroupXMLParser.php.
◆ $mode
| ilGroupXMLParser::$mode |
Definition at line 59 of file class.ilGroupXMLParser.php.
Referenced by setMode().
◆ $parent
| ilGroupXMLParser::$parent |
Definition at line 56 of file class.ilGroupXMLParser.php.
◆ $participants
|
private |
Definition at line 49 of file class.ilGroupXMLParser.php.
◆ $sort
|
private |
Definition at line 51 of file class.ilGroupXMLParser.php.
◆ $UPDATE
|
static |
Definition at line 42 of file class.ilGroupXMLParser.php.
Referenced by __initGroupObject(), ilGroupImporter\importXmlRepresentation(), and ilSoapGroupAdministration\updateGroup().
The documentation for this class was generated from the following file:
- Modules/Group/classes/class.ilGroupXMLParser.php
