ilPluginReader Class Reference

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

Inheritance diagram for ilPluginReader:

Collaboration diagram for ilPluginReader:

Public Member Functions
	__construct (?string $a_path, $a_ctype, $a_cname, $a_slot_id, $a_pname)
	clearEvents ()
	Delete the event listeneing information. More...
	startParsing ()
	setHandlers ($a_xml_parser)
	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...
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
	$ctype
	$cname
	$slot_id
	$pname
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

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 Class ilPluginReader

This is only used in ilPlugin.

as of ILIAS 9

Reads plugin information of plugin.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 32 of file class.ilPluginReader.php.

Constructor & Destructor Documentation

__construct()

ilPluginReader::__construct	(	?string	$a_path,
			$a_ctype,
			$a_cname,
			$a_slot_id,
			$a_pname
	)

Definition at line 39 of file class.ilPluginReader.php.

References ILIAS\GlobalScreen\Provider\__construct().

    {
        parent::__construct($a_path);

        $this->ctype = $a_ctype;
        $this->cname = $a_cname;
        $this->slot_id = $a_slot_id;
        $this->pname = $a_pname;
    }

Here is the call graph for this function:

Member Function Documentation

clearEvents()

ilPluginReader::clearEvents

(

)

Delete the event listeneing information.

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

References $DIC, $ilDB, and $pname.

                                 : void
    {
        global $DIC;
        $ilDB = $DIC->database();

        $component = "Plugins/" . $this->pname;
        $ilDB->manipulate("DELETE FROM il_event_handling WHERE component = " . $ilDB->quote($component, 'text'));
    }

handlerBeginTag()

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

start tag handler

Parameters

mixed	internal xml_parser_handler
string	element tag name
array	element attributes private

Definition at line 86 of file class.ilPluginReader.php.

References $DIC, $ilDB, and $pname.

                                                                       : void
    {
        global $DIC;
        $ilDB = $DIC->database();

        if ($a_name === "event") {
            $component = "Plugins/" . $this->pname;
            $q = "INSERT INTO il_event_handling (component, type, id) VALUES (" .
                $ilDB->quote($component, "text") . "," .
                $ilDB->quote($a_attribs["type"], "text") . "," .
                $ilDB->quote($a_attribs["id"], "text") . ")";
            $ilDB->manipulate($q);
        }
    }

handlerCharacterData()

ilPluginReader::handlerCharacterData	(		$a_xml_parser,
			$a_data
	)

end tag handler

Parameters

mixed	internal xml_parser_handler
string	data private

Definition at line 119 of file class.ilPluginReader.php.

                                                                : void
    {
    }

handlerEndTag()

ilPluginReader::handlerEndTag	(		$a_xml_parser,
			$a_name
	)

end tag handler

Parameters

mixed	internal xml_parser_handler
string	element tag name private

Definition at line 108 of file class.ilPluginReader.php.

                                                         : void
    {
    }

setHandlers()

ilPluginReader::setHandlers

(

$a_xml_parser

)

Definition at line 71 of file class.ilPluginReader.php.

                                              : void
    {
        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');
    }

startParsing()

ilPluginReader::startParsing

(

)

Definition at line 62 of file class.ilPluginReader.php.

References ilSaxParser\getInputType().

                                  : void
    {
        if ($this->getInputType() === 'file' && !file_exists($this->xml_file)) {
            // not every plugin has a plugin.xml yet
            return;
        }
        parent::startParsing();
    }

Here is the call graph for this function:

Field Documentation

$cname

ilPluginReader::$cname

protected

Definition at line 35 of file class.ilPluginReader.php.

$ctype

ilPluginReader::$ctype

protected

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

$pname

ilPluginReader::$pname

protected

Definition at line 37 of file class.ilPluginReader.php.

Referenced by clearEvents(), and handlerBeginTag().

$slot_id

ilPluginReader::$slot_id

protected

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

---

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

• Services/Component/classes/class.ilPluginReader.php