XML writer learning progress. More...

Inheritance diagram for ilLPXmlWriter:

Collaboration diagram for ilLPXmlWriter:

Public Member Functions
	__construct (bool $a_add_header)
	Constructor. More...

	setTimestamp (string $a_val)
	Set timestamp. More...

	getTimestamp ()
	Get timestamp. More...

	setIncludeRefIds (bool $a_val)

	getIncludeRefIds ()

	setTypeFilter (array $a_val)
	Set type filter. More...

	getTypeFilter ()
	Get type filter. More...

	write ()
	Write XML. More...

	addLPInformation ()

Public Member Functions inherited from ilXmlWriter
	__construct (string $version="1.0", string $outEnc="utf-8", string $inEnc="utf-8")

	xmlSetDtdDef (string $dtdDef)
	Sets dtd definition. More...

	xmlSetGenCmt (string $genCmt)
	Sets generated comment. More...

	xmlFormatData (string $data)
	Indents text for better reading. More...

	xmlHeader ()
	Writes xml header. More...

	xmlStartTag (string $tag, ?array $attrs=null, bool $empty=false, bool $encode=true, bool $escape=true)
	Writes a starttag. More...

	xmlEndTag (string $tag)
	Writes an endtag. More...

	xmlData (string $data, bool $encode=true, bool $escape=true)
	Writes data. More...

	xmlElement (string $tag, $attrs=null, $data=null, $encode=true, $escape=true)
	Writes a basic element (no children, just textual content) More...

	xmlDumpFile (string $file, bool $format=true)
	Dumps xml document from memory into a file. More...

	xmlDumpMem (bool $format=true)
	Returns xml document from memory. More...

	appendXML (string $a_str)
	append xml string to document More...

	xmlClear ()
	clears xmlStr More...

Protected Member Functions
	buildHeader ()

	init ()

Protected Attributes
ilDBInterface	$db

Private Attributes
bool	$add_header = true

string	$timestamp = ""

bool	$include_ref_ids = false

array	$type_filter = array()

Detailed Description

XML writer learning progress.

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

Definition at line 25 of file class.ilLPXmlWriter.php.

Constructor & Destructor Documentation

◆ __construct()

ilLPXmlWriter::__construct ( bool $a_add_header )

Constructor.

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

    {
        global $DIC;
 
        $this->db = $DIC->database();
        $this->add_header = $a_add_header;
        parent::__construct();
    }

References $DIC, and ILIAS\GlobalScreen\Provider\__construct().

Here is the call graph for this function:

Member Function Documentation

◆ addLPInformation()

ilLPXmlWriter::addLPInformation ( )

Definition at line 116 of file class.ilLPXmlWriter.php.

                                      : void
    {
        $this->xmlStartTag('LPData', array());
        $set = $this->db->query(
            $q = "SELECT * FROM ut_lp_marks " .
                " WHERE status_changed >= " . $this->db->quote(
                    $this->getTimestamp(),
                    "timestamp"
                )
        );
 
        while ($rec = $this->db->fetchAssoc($set)) {
            $ref_ids = array();
            if ($this->getIncludeRefIds()) {
                $ref_ids = ilObject::_getAllReferences((int) $rec["obj_id"]);
            }
 
            if (!is_array($this->getTypeFilter()) ||
                (count($this->getTypeFilter()) == 0) ||
                in_array(
                    ilObject::_lookupType((int) $rec["obj_id"]),
                    $this->getTypeFilter()
                )) {
                $this->xmlElement(
                    'LPChange',
                    array(
                        'UserId' => (int) $rec["usr_id"],
                        'ObjId' => (int) $rec["obj_id"],
                        'RefIds' => implode(",", $ref_ids),
                        'Timestamp' => $rec["status_changed"],
                        'LPStatus' => (int) $rec["status"]
                    )
                );
            }
        }
        $this->xmlEndTag('LPData');
    }

References $q, ilObject\_getAllReferences(), ilObject\_lookupType(), getIncludeRefIds(), getTypeFilter(), ilXmlWriter\xmlElement(), ilXmlWriter\xmlEndTag(), and ilXmlWriter\xmlStartTag().

Referenced by write().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildHeader()

ilLPXmlWriter::buildHeader ( )

protected

Definition at line 106 of file class.ilLPXmlWriter.php.

                                    : void
    {
        $this->xmlHeader();
    }

References ilXmlWriter\xmlHeader().

Referenced by write().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getIncludeRefIds()

ilLPXmlWriter::getIncludeRefIds ( )

Definition at line 69 of file class.ilLPXmlWriter.php.

                                      : bool
    {
        return $this->include_ref_ids;
    }

References $include_ref_ids.

Referenced by addLPInformation().

Here is the caller graph for this function:

◆ getTimestamp()

ilLPXmlWriter::getTimestamp ( )

Get timestamp.

Returns: string timestamp (YYYY-MM-DD hh:mm:ss)

Definition at line 59 of file class.ilLPXmlWriter.php.

                                  : string
    {
        return $this->timestamp;
    }

References $timestamp.

◆ getTypeFilter()

ilLPXmlWriter::getTypeFilter ( )

Get type filter.

Returns: string[]

Definition at line 87 of file class.ilLPXmlWriter.php.

                                   : array
    {
        return $this->type_filter;
    }

References $type_filter.

Referenced by addLPInformation().

Here is the caller graph for this function:

◆ init()

ilLPXmlWriter::init ( )

protected

Definition at line 111 of file class.ilLPXmlWriter.php.

                             : void
    {
        $this->xmlClear();
    }

References ilXmlWriter\xmlClear().

Referenced by write().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setIncludeRefIds()

ilLPXmlWriter::setIncludeRefIds ( bool $a_val )

Definition at line 64 of file class.ilLPXmlWriter.php.

                                                 : void
    {
        $this->include_ref_ids = $a_val;
    }

◆ setTimestamp()

ilLPXmlWriter::setTimestamp ( string $a_val )

Set timestamp.

Parameters

string $a_val timestamp (YYYY-MM-DD hh:mm:ss)

Definition at line 50 of file class.ilLPXmlWriter.php.

                                               : void
    {
        $this->timestamp = $a_val;
    }

◆ setTypeFilter()

ilLPXmlWriter::setTypeFilter ( array $a_val )

Set type filter.

Parameters

string[] $a_val

Definition at line 78 of file class.ilLPXmlWriter.php.

                                               : void
    {
        $this->type_filter = $a_val;
    }

◆ write()

ilLPXmlWriter::write ( )

Write XML.

Returns

Exceptions

UnexpectedValueException Thrown if obj_id is not of type webr or no obj_id is given

Definition at line 97 of file class.ilLPXmlWriter.php.

                           : void
    {
        $this->init();
        if ($this->add_header) {
            $this->buildHeader();
        }
        $this->addLPInformation();
    }

References addLPInformation(), buildHeader(), and init().

Here is the call graph for this function:

Field Documentation

◆ $add_header

bool ilLPXmlWriter::$add_header = true

private

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

◆ $db

ilDBInterface ilLPXmlWriter::$db

protected

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

◆ $include_ref_ids

bool ilLPXmlWriter::$include_ref_ids = false

private

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

Referenced by getIncludeRefIds().

◆ $timestamp

string ilLPXmlWriter::$timestamp = ""

private

Definition at line 28 of file class.ilLPXmlWriter.php.

Referenced by getTimestamp().

◆ $type_filter

array ilLPXmlWriter::$type_filter = array()

private

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

Referenced by getTypeFilter().

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

components/ILIAS/Tracking/classes/class.ilLPXmlWriter.php

Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addLPInformation()

◆ buildHeader()

◆ getIncludeRefIds()

◆ getTimestamp()

◆ getTypeFilter()

◆ init()

◆ setIncludeRefIds()

◆ setTimestamp()

◆ setTypeFilter()

◆ write()

Field Documentation

◆ $add_header

◆ $db

◆ $include_ref_ids

◆ $timestamp

◆ $type_filter