Component definition reader (reads common tags in module.xml and service.xml files) Name is misleading and should be ilComponentDefReader instead. More...

Inheritance diagram for ilObjDefReader:

Collaboration diagram for ilObjDefReader:

Public Member Functions
	__construct ($a_path, $a_name, $a_type, \ilDBInterface $db=null)

	setHandlers ($a_xml_parser)

	clearTables ()
	clear the tables More...

	deleteObjectDefinition ($a_id)
	Delete an object definition (this is currently needed for test cases) More...

	handlerBeginTag ($a_xml_parser, $a_name, $a_attribs)
	Start tag handler. More...

	handlerEndTag ($a_xml_parser, $a_name)
	End tag handler. More...

	handlerCharacterData ($a_xml_parser, $a_data)
	end tag handler More...

	setComponentId ($a_component_id)
	Set from module or service reader. More...

	getComponentId ()
	Get component id. More...

Public Member Functions inherited from ilSaxParser
	__construct ($a_xml_file='', $throwException=false)
	Constructor setup ILIAS global object 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 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...

Protected Attributes
	$component_id

	$readers

	$current_reader = null

	$in_mail_templates = false

	$db

	$mail_templates_by_component = 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...

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()

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

Component definition reader (reads common tags in module.xml and service.xml files) Name is misleading and should be ilComponentDefReader instead.

Reads reads module information of modules.xml files into db

Author: Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Version: $Id$

Definition at line 15 of file class.ilObjDefReader.php.

Constructor & Destructor Documentation

◆ __construct()

ilObjDefReader::__construct	(		$a_path,
			$a_name,
			$a_type,
		\ilDBInterface	$db = `null`
	)

Definition at line 36 of file class.ilObjDefReader.php.

References $a_type, $db, $ilDB, $reader, and ILIAS\GlobalScreen\Provider\__construct().

     {
         if ($db !== null) {
             $this->db = $db;
         } else {
             global $ilDB;
             $this->db = $ilDB;
         }
         // init specialized readers
         foreach ($this->readers as $k => $reader) {
             $class = $reader["class"];
             $this->readers[$k]["reader"] = new $class($this->db);
         }
         
         $this->name = $a_name;
         $this->type = $a_type;
 
         parent::__construct($a_path);
     }

Here is the call graph for this function:

Member Function Documentation

◆ clearTables()

ilObjDefReader::clearTables ( )

clear the tables

Definition at line 66 of file class.ilObjDefReader.php.

References $reader.

     {
         $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_pluginslot");
         
         $this->db->manipulate("DELETE FROM il_component");
 
         // Keep the plugin listeners in the table
         // This avoids reading them in the setup
         // ilPluginReader is called in the plugin administration
         $this->db->manipulate("DELETE FROM il_event_handling WHERE component NOT LIKE 'Plugins/%'");
         
         $this->db->manipulate("DELETE FROM il_object_sub_type");
         
         foreach ($this->readers as $k => $reader) {
             $this->readers[$k]["reader"]->clearTables();
         }
     }

◆ deleteObjectDefinition()

ilObjDefReader::deleteObjectDefinition ( $a_id )

Delete an object definition (this is currently needed for test cases)

Definition at line 93 of file class.ilObjDefReader.php.

     {
         $this->db->manipulateF(
             "DELETE FROM il_object_def WHERE id = %s",
             array("text"),
             array($a_id)
         );
         
         $this->db->manipulateF(
             "DELETE FROM il_object_subobj WHERE parent = %s OR subobj = %s",
             array("text", "text"),
             array($a_id, $a_id)
         );
     }

◆ getComponentId()

ilObjDefReader::getComponentId ( )

Get component id.

Returns: type

Definition at line 385 of file class.ilObjDefReader.php.

References $component_id.

Referenced by handlerBeginTag(), and handlerEndTag().

     {
         return $this->component_id;
     }

Here is the caller graph for this function:

◆ handlerBeginTag()

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

Start tag handler.

Parameters

ressouce	internal xml_parser_handler
string	element tag name
array	element attributes

Definition at line 115 of file class.ilObjDefReader.php.

References $current_reader, Vendor\Package\$e, ActiveRecord\findOrFail(), getComponentId(), ilSCGroups\getInstance(), ilSCTasks\getInstanceByGroupId(), ilMailTemplateContextService\insertFromXML(), ilLogComponentLevels\updateFromXML(), ilPDFCompInstaller\updateFromXML(), ilBadgeHandler\updateFromXML(), and ilCronManager\updateFromXML().

     {
         $this->current_tag = $a_name;
         
         // check if a special reader needs to be activated
         if (isset($this->readers[$a_name])) {
             $this->current_reader = $a_name;
         }
         
         // call special reader
         if ($this->current_reader != "") {
             $this->readers[$this->current_reader]["reader"]->handlerBeginTag(
                 $a_xml_parser,
                 $a_name,
                 $a_attribs,
                 $this->current_component
             );
         } else {
             // default handling
             switch ($a_name) {
                 case 'object':
     
                     // if attributes are not given, set default (repository only)
                     if (($a_attribs["repository"] ?? null) === null) {
                         $a_attribs["repository"] = true;
                     }
                     if (($a_attribs["workspace"] ?? null) === null) {
                         $a_attribs["workspace"] = false;
                     }
     
                     $this->current_object = $a_attribs["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(
                             $a_attribs["id"],
                             $a_attribs["class_name"],
                             $this->current_component,
                             $this->current_component . "/" . $a_attribs["dir"],
                             (int) ($a_attribs["checkbox"] ?? null),
                             (int) ($a_attribs["inherit"] ?? null),
                             $a_attribs["translate"] ?? null,
                             (int) ($a_attribs["devmode"] ?? null),
                             (int) ($a_attribs["allow_link"] ?? null),
                             (int) ($a_attribs["allow_copy"] ?? null),
                             (int) ($a_attribs["rbac"] ?? null),
                             (int) ($a_attribs["default_pos"] ?? null),
                             (int) ($a_attribs["default_pres_pos"] ?? null),
                             (int) ($a_attribs["sideblock"] ?? null),
                             $a_attribs["group"] ?? null,
                             (int) ($a_attribs["system"] ?? null),
                             (int) ($a_attribs["export"] ?? null),
                             (int) ($a_attribs["repository"] ?? null),
                             (int) ($a_attribs["workspace"] ?? null),
                             (int) ($a_attribs['administration'] ?? null),
                             (int) ($a_attribs['amet'] ?? null),
                             (int) ($a_attribs['orgunit_permissions'] ?? null),
                             (int) ($a_attribs['lti_provider'] ?? null),
                             (int) ($a_attribs['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, $a_attribs["id"], (int) ($a_attribs["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($a_attribs["id"], $this->current_object, (int) ($a_attribs["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($a_attribs["id"], $a_attribs["name"], $a_attribs["default_pres_pos"])
                     );
                     break;
     
                 case "pluginslot":
                     $this->current_object = $a_attribs["id"];
                     $q = "INSERT INTO il_pluginslot (component, id, name) VALUES (" .
                         $this->db->quote($this->current_component, "text") . "," .
                         $this->db->quote($a_attribs["id"], "text") . "," .
                         $this->db->quote($a_attribs["name"], "text") . ")";
                     $this->db->manipulate($q);
                     break;
                 
                 case "event":
                     $component = $a_attribs["component"] ?? null;
                     if (!$component) {
                         $component = $this->current_component;
                     }
                     $q = "INSERT INTO il_event_handling (component, type, id) VALUES (" .
                         $this->db->quote($component, "text") . "," .
                         $this->db->quote($a_attribs["type"], "text") . "," .
                         $this->db->quote($a_attribs["id"], "text") . ")";
                     $this->db->manipulate($q);
                     break;
                     
                 case "cron":
                     $component = $a_attribs["component"] ?? null;
                     if (!$component) {
                         $component = $this->current_component;
                     }
                     ilCronManager::updateFromXML($component, $a_attribs["id"], $a_attribs["class"], ($a_attribs["path"] ?? null));
                     $this->has_cron[$component][] = $a_attribs["id"];
                     break;
     
                 case 'mailtemplates':
                     $this->in_mail_templates = true;
                     break;
 
                 case 'context':
                     if (!$this->in_mail_templates) {
                         break;
                     }
 
                     $component = $a_attribs['component'] ?? null;
                     if (!$component) {
                         $component = $this->current_component;
                     }
 
                     ilMailTemplateContextService::insertFromXML(
                         $component,
                         $a_attribs['id'],
                         $a_attribs['class'],
                         $a_attribs['path'] ?? null
                     );
                     $this->mail_templates_by_component[$component][] = $a_attribs["id"];
                     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($a_attribs["id"], "text") . "," .
                         $this->db->quote($a_attribs["amet"], "integer") .
                         ")");
                     break;
 
                 case 'systemcheck':
                     
                     include_once './Services/SystemCheck/classes/class.ilSCGroups.php';
                     ilSCGroups::getInstance()->updateFromComponentDefinition($this->getComponentId());
                     break;
                 
                 case 'systemcheck_task':
                     include_once './Services/SystemCheck/classes/class.ilSCGroups.php';
                     $group_id = ilSCGroups::getInstance()->lookupGroupByComponentId($this->getComponentId());
                     
                     include_once './Services/SystemCheck/classes/class.ilSCTasks.php';
                     $tasks = ilSCTasks::getInstanceByGroupId($group_id);
                     $tasks->updateFromComponentDefinition($a_attribs['identifier']);
                     break;
 
                 case "secure_path":
                     require_once('./Services/WebAccessChecker/classes/class.ilWACSecurePath.php');
                     try {
                         $ilWACSecurePath = ilWACSecurePath::findOrFail($a_attribs["path"]);
                     } catch (arException $e) {
                         $ilWACSecurePath = new ilWACSecurePath();
                         $ilWACSecurePath->setPath($a_attribs["path"]);
                         $ilWACSecurePath->create();
                     }
                     $ilWACSecurePath->setCheckingClass($a_attribs["checking-class"]);
                     $ilWACSecurePath->setInSecFolder((bool) ($a_attribs["in-sec-folder"] ?? null));
                     $ilWACSecurePath->setComponentDirectory(dirname($this->xml_file));
                     $ilWACSecurePath->update();
                     break;
                 
                 case 'logging':
                     include_once './Services/Logging/classes/class.ilLogComponentLevels.php';
                     ilLogComponentLevels::updateFromXML($this->getComponentId());
                     break;
                 
                 case 'badges':
                     include_once "Services/Badge/classes/class.ilBadgeHandler.php";
                     ilBadgeHandler::updateFromXML($this->getComponentId());
                     $this->has_badges[] = $this->getComponentId();
                     break;
 
                 case 'pdfpurpose':
                     require_once './Services/PDFGeneration/classes/class.ilPDFCompInstaller.php';
                     ilPDFCompInstaller::updateFromXML($this->current_component, $a_attribs['name'], $a_attribs['preferred']);
                     break;
             }
         }
     }

Here is the call graph for this function:

◆ handlerCharacterData()

ilObjDefReader::handlerCharacterData	(	$a_xml_parser,
		$a_data
	)

end tag handler

Parameters

ressouce	internal xml_parser_handler
string	data private

Definition at line 360 of file class.ilObjDefReader.php.

     {
         // DELETE WHITESPACES AND NEWLINES OF CHARACTER DATA
         $a_data = preg_replace("/\n/", "", $a_data);
         $a_data = preg_replace("/\t+/", "", $a_data);
 
         if (!empty($a_data)) {
             switch ($this->current_tag) {
                 case '':
             }
         }
     }

◆ handlerEndTag()

ilObjDefReader::handlerEndTag	(	$a_xml_parser,
		$a_name
	)

End tag handler.

Parameters

object	internal xml_parser_handler
string	element tag name

Definition at line 325 of file class.ilObjDefReader.php.

References $current_reader, ilMailTemplateContextService\clearFromXml(), ilCronManager\clearFromXML(), and getComponentId().

     {
         // call special reader
         if ($this->current_reader != "") {
             $this->readers[$this->current_reader]["reader"]->handlerEndTag($a_xml_parser, $a_name);
         } else {
             if ($a_name == "module" || $a_name == "service") {
                 ilCronManager::clearFromXML(
                     $this->current_component,
                     ($this->has_cron[$this->current_component] ?? [])
                 );
 
                 ilMailTemplateContextService::clearFromXml($this->current_component, ($this->mail_templates_by_component[$this->current_component] ?? []));
                 
                 if (!in_array($this->getComponentId(), ($this->has_badges ?? []))) {
                     include_once "Services/Badge/classes/class.ilBadgeHandler.php";
                     ilBadgeHandler::clearFromXml($this->getComponentId());
                 }
             }
         }
         
         // check if a special reader needs to be activated
         if (isset($this->readers[$a_name])) {
             $this->current_reader = null;
         }
     }

Here is the call graph for this function:

◆ setComponentId()

ilObjDefReader::setComponentId ( $a_component_id )

Set from module or service reader.

Definition at line 376 of file class.ilObjDefReader.php.

Referenced by ilServiceReader\handlerBeginTag(), and ilModuleReader\handlerBeginTag().

     {
         $this->component_id = $a_component_id;
     }

Here is the caller graph for this function:

◆ setHandlers()

ilObjDefReader::setHandlers ( $a_xml_parser )

Definition at line 56 of file class.ilObjDefReader.php.

     {
         xml_set_object($a_xml_parser, $this);
         xml_set_element_handler($a_xml_parser, 'handlerBeginTag', 'handlerEndTag');
         xml_set_character_data_handler($a_xml_parser, 'handlerCharacterData');
     }

Field Documentation

◆ $component_id

ilObjDefReader::$component_id

protected

Definition at line 17 of file class.ilObjDefReader.php.

Referenced by getComponentId().

◆ $current_reader

ilObjDefReader::$current_reader = null

protected

Definition at line 22 of file class.ilObjDefReader.php.

Referenced by handlerBeginTag(), and handlerEndTag().

◆ $db

ilObjDefReader::$db

protected

Definition at line 29 of file class.ilObjDefReader.php.

Referenced by __construct().

◆ $in_mail_templates

ilObjDefReader::$in_mail_templates = false

protected

Definition at line 24 of file class.ilObjDefReader.php.

◆ $mail_templates_by_component

ilObjDefReader::$mail_templates_by_component = array()

protected

Definition at line 34 of file class.ilObjDefReader.php.

◆ $readers

ilObjDefReader::$readers

protected

Initial value:

= array(
        "copage" => array("class" => "ilCOPageDefReader")
        )

Definition at line 19 of file class.ilObjDefReader.php.

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

Services/Component/classes/Setup/class.ilObjDefReader.php

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ clearTables()

◆ deleteObjectDefinition()

◆ getComponentId()

◆ handlerBeginTag()

◆ handlerCharacterData()

◆ handlerEndTag()

◆ setComponentId()

◆ setHandlers()

Field Documentation

◆ $component_id

◆ $current_reader

◆ $db

◆ $in_mail_templates

◆ $mail_templates_by_component

◆ $readers