ilPluginReader Class Reference

Class ilPluginReader. More...

Inheritance diagram for ilPluginReader:

Collaboration diagram for ilPluginReader:

Public Member Functions
	__construct ($a_path, $a_ctype, $a_cname, $a_slot_id, $a_pname)
	clearEvents ()
	Delete the event listeneing information. More...
	startParsing ()
	stores xml data in array More...
	setHandlers ($a_xml_parser)
	set event handler should be overwritten by inherited class @access private 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...
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...

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

Class ilPluginReader.

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 15 of file class.ilPluginReader.php.

Constructor & Destructor Documentation

__construct()

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

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

    {
        parent::__construct($a_path);
 
        $this->ctype = $a_ctype;
        $this->cname = $a_cname;
        $this->slot_id = $a_slot_id;
        $this->pname = $a_pname;
    }

References ILIAS\GlobalScreen\Provider\__construct().

Here is the call graph for this function:

Member Function Documentation

clearEvents()

ilPluginReader::clearEvents

(

)

Delete the event listeneing information.

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

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

References $DIC, and $ilDB.

handlerBeginTag()

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

start tag handler

Parameters

ressouce	internal xml_parser_handler
string	element tag name
array	element attributes @access private

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

    {
        global $DIC;
        $ilDB = $DIC->database();
 
        switch ($a_name) {
            // base plugin info is still read from the plugin.php
            case 'plugin_tag_analyzed_in_future':
                
                // check whether record exists
                $q = "SELECT * FROM il_plugin WHERE " .
                    " component_type = " . $ilDB->quote($this->ctype, "text") .
                    " AND component_name = " . $ilDB->quote($this->cname, "text") .
                    " AND slot_id = " . $ilDB->quote($this->slot_id, "text") .
                    " AND name = " . $ilDB->quote($this->pname, "text");
                $set = $ilDB->query($q);
                if ($ilDB->numRows($set) == 0) {
                    $q = "INSERT INTO il_plugin (component_type,component_name,slot_id," .
                        "name, id, last_update_version, current_version, ilias_min_version," .
                        " ilias_max_version, active) VALUES " .
                        "(" . $ilDB->quote($this->ctype, "text") . "," .
                        $ilDB->quote($this->cname, "text") . "," .
                        $ilDB->quote($this->slot_id, "text") . "," .
                        $ilDB->quote($this->pname, "text") . "," .
                        $ilDB->quote($a_attribs["id"], "text") . "," .
                        $ilDB->quote("0.0.0", "text") . "," .
                        $ilDB->quote($a_attribs["version"], "text") . "," .
                        $ilDB->quote($a_attribs["ilias_min_version"], "text") . "," .
                        $ilDB->quote($a_attribs["ilias_max_version"], "text") . "," .
                        $ilDB->quote(0, "integer") . ")";
                    $ilDB->manipulate($q);
                } else {
                    $q = "UPDATE il_plugin SET " .
                        " id = " . $ilDB->quote($a_attribs["id"], "text") . "," .
                        " current_version = " . $ilDB->quote($a_attribs["version"], "text") . "," .
                        " ilias_min_version = " . $ilDB->quote($a_attribs["ilias_min_version"], "text") . "," .
                        " ilias_max_version = " . $ilDB->quote($a_attribs["ilias_max_version"], "text") .
                        " WHERE " .
                        " component_type = " . $ilDB->quote($this->ctype, "text") .
                        " AND component_name = " . $ilDB->quote($this->cname, "text") .
                        " AND slot_id = " . $ilDB->quote($this->slot_id, "text") .
                        " AND name = " . $ilDB->quote($this->pname, "text");
                    $ilDB->manipulate($q);
                }
                break;
 
            case "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);
                break;
        }
    }

References $DIC, and $ilDB.

handlerCharacterData()

ilPluginReader::handlerCharacterData	(		$a_xml_parser,
			$a_data
	)

end tag handler

Parameters

ressouce	internal xml_parser_handler
string	data @access private

Definition at line 142 of file class.ilPluginReader.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()

ilPluginReader::handlerEndTag	(		$a_xml_parser,
			$a_name
	)

end tag handler

Parameters

ressouce	internal xml_parser_handler
string	element tag name @access private

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

    {
    }

setHandlers()

ilPluginReader::setHandlers

(

$a_xml_parser

)

set event handler should be overwritten by inherited class @access private

Reimplemented from ilSaxParser.

Definition at line 51 of file class.ilPluginReader.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');
    }

startParsing()

ilPluginReader::startParsing

(

)

stores xml data in array

@access private

Exceptions

ilSaxParserException

or ILIAS Error

Reimplemented from ilSaxParser.

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

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

References ilSaxParser\getInputType().

Here is the call graph for this function:

---

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

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