This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilObjectDefinitionProcessor:

Collaboration diagram for ilObjectDefinitionProcessor:

Public Member Functions
	__construct (ilDBInterface $db)

	purge ()
	This methods is supposed to purge existing data in the provider of the component, so new components can be added to a clean slate. More...

	beginComponent (string $component, string $type)
	This method is called when parsing of component.xml for the given component starts. More...

	endComponent (string $component, string $type)
	This method is called when parsing of component.xml for the given component ends. More...

	beginTag (string $name, array $attributes)
	This is called when a tag starts in the context of the given component. More...

	endTag (string $name)
	This is called when a tag ends in the context of the given component. More...

Protected Attributes
ilDBInterface	$db

string	$component

string	$current_object

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning

Definition at line 21 of file class.ilObjectDefinitionProcessor.php.

Constructor & Destructor Documentation

◆ __construct()

ilObjectDefinitionProcessor::__construct ( ilDBInterface $db )

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

References $db.

     {
         $this->db = $db;
     }

Member Function Documentation

◆ beginComponent()

ilObjectDefinitionProcessor::beginComponent	(	string	$component,
		string	$type
	)

This method is called when parsing of component.xml for the given component starts.

This is supposed to reset any internal parsing state.

Implements ilComponentDefinitionProcessor.

Definition at line 40 of file class.ilObjectDefinitionProcessor.php.

References $component.

                                                                    : void
     {
         $this->component = $type . "/" . $component;
         $this->current_object = null;
     }

◆ beginTag()

ilObjectDefinitionProcessor::beginTag	(	string	$name,
		array	$attributes
	)

This is called when a tag starts in the context of the given component.

Parameters

string[] $attributes

Implements ilComponentDefinitionProcessor.

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

                                                              : void
     {
         switch ($name) {
             case 'object':
 
                 // if attributes are not given, set default (repository only)
                 if (($attributes["repository"] ?? null) === null) {
                     $attributes["repository"] = true;
                 }
                 if (($attributes["workspace"] ?? null) === null) {
                     $attributes["workspace"] = false;
                 }
 
                 $this->current_object = $attributes["id"];
                 $this->db->manipulateF(
                     "INSERT INTO il_object_def (id, class_name, component,location," .
                     "checkbox,inherit,translate,devmode,allow_link,allow_copy,rbac,default_pos," .
                     "default_pres_pos,sideblock,grp," . $this->db->quoteIdentifier("system") . ",export,repository,workspace,administration," .
                     "amet,orgunit_permissions,lti_provider,offline_handling) VALUES " .
                     "(%s,%s,%s,%s,%s,%s,%s,%s,%s,%s,%s,%s,%s,%s,%s,%s,%s,%s,%s,%s,%s,%s,%s,%s)",
                     array("text", "text", "text", "text", "integer", "integer", "text", "integer","integer","integer",
                         "integer","integer","integer","integer", "text", "integer", "integer", "integer", "integer",
                         'integer','integer','integer','integer','integer'),
                     array(
                         $attributes["id"],
                         $attributes["class_name"],
                         $this->component,
                         $this->component . "/" . $attributes["dir"],
                         (int) ($attributes["checkbox"] ?? null),
                         (int) ($attributes["inherit"] ?? null),
                         $attributes["translate"] ?? null,
                         (int) ($attributes["devmode"] ?? null),
                         (int) ($attributes["allow_link"] ?? null),
                         (int) ($attributes["allow_copy"] ?? null),
                         (int) ($attributes["rbac"] ?? null),
                         (int) ($attributes["default_pos"] ?? null),
                         (int) ($attributes["default_pres_pos"] ?? null),
                         (int) ($attributes["sideblock"] ?? null),
                         $attributes["group"] ?? null,
                         (int) ($attributes["system"] ?? null),
                         (int) ($attributes["export"] ?? null),
                         (int) ($attributes["repository"] ?? null),
                         (int) ($attributes["workspace"] ?? null),
                         (int) ($attributes['administration'] ?? null),
                         (int) ($attributes['amet'] ?? null),
                         (int) ($attributes['orgunit_permissions'] ?? null),
                         (int) ($attributes['lti_provider'] ?? null),
                         (int) ($attributes['offline_handling'] ?? null)
                     )
                 );
                 break;
 
             case "subobj":
                 $this->db->manipulateF(
                     "INSERT INTO il_object_subobj (parent, subobj, mmax) VALUES (%s,%s,%s)",
                     array("text", "text", "integer"),
                     array($this->current_object, $attributes["id"], (int) ($attributes["max"] ?? null))
                 );
                 break;
 
             case "parent":
                 $this->db->manipulateF(
                     "INSERT INTO il_object_subobj (parent, subobj, mmax) VALUES (%s,%s,%s)",
                     array("text", "text", "integer"),
                     array($attributes["id"], $this->current_object, (int) ($attributes["max"] ?? null))
                 );
                 break;
 
             case "objectgroup":
                 $this->db->manipulateF(
                     "INSERT INTO il_object_group (id, name, default_pres_pos) VALUES (%s,%s,%s)",
                     array("text", "text", "integer"),
                     array($attributes["id"], $attributes["name"], $attributes["default_pres_pos"])
                 );
                 break;
             case "sub_type":
                 $this->db->manipulate("INSERT INTO il_object_sub_type " .
                     "(obj_type, sub_type, amet) VALUES (" .
                     $this->db->quote($this->current_object, "text") . "," .
                     $this->db->quote($attributes["id"], "text") . "," .
                     $this->db->quote($attributes["amet"], "integer") .
                     ")");
                 break;
         }
     }

◆ endComponent()

ilObjectDefinitionProcessor::endComponent	(	string	$component,
		string	$type
	)

This method is called when parsing of component.xml for the given component ends.

Implements ilComponentDefinitionProcessor.

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

                                                                  : void
     {
         $this->component = null;
         $this->current_object = null;
     }

◆ endTag()

ilObjectDefinitionProcessor::endTag ( string $name )

This is called when a tag ends in the context of the given component.

Implements ilComponentDefinitionProcessor.

Definition at line 138 of file class.ilObjectDefinitionProcessor.php.

                                         : void
     {
     }

◆ purge()

ilObjectDefinitionProcessor::purge ( )

This methods is supposed to purge existing data in the provider of the component, so new components can be added to a clean slate.

Implements ilComponentDefinitionProcessor.

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

                            : void
     {
         $this->db->manipulate("DELETE FROM il_object_def");
         $this->db->manipulate("DELETE FROM il_object_subobj");
         $this->db->manipulate("DELETE FROM il_object_group");
         $this->db->manipulate("DELETE FROM il_object_sub_type");
     }