ilPCLearningHistory 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 ilPCLearningHistory:

Collaboration diagram for ilPCLearningHistory:

Public Member Functions
	init ()
	create (ilPageObject $a_pg_obj, string $a_hier_id, string $a_pc_id="")
	Create learning history node. More...
	setFrom (string $a_val)
	getFrom ()
	setTo (string $a_val)
	getTo ()
	setClasses (array $a_val)
	getClasses ()
	modifyPageContentPostXsl (string $a_output, string $a_mode, bool $a_abstract_only=false)
Public Member Functions inherited from ilPageContent
	__construct (ilPageObject $a_pg_obj, ?PageManagerInterface $page_manager=null, ?ObjectAdapterInterface $object_adapter=null)
	setPage (ilPageObject $a_val)
	getPage ()
	init ()
	Init object. More...
	getType ()
	getDomNode ()
	getDomDoc ()
	setDomNode (DOMNode $node)
	getChildNode ()
	getJavascriptFiles (string $a_mode)
	getCssFiles (string $a_mode)
	getOnloadCode (string $a_mode)
	setHierId (string $a_hier_id)
	getHierId ()
	lookupHierId ()
	readHierId ()
	setPcId (string $a_pcid)
	getPCId ()
	setFileDownloadLink (string $a_download_link)
	getFileDownloadLink ()
	setProfileBackUrl (string $url)
	getProfileBackUrl ()
	setFullscreenLink (string $a_fullscreen_link)
	getFullscreenLink ()
	setSourcecodeDownloadScript (string $script_name)
	getSourcecodeDownloadScript ()
	readPCId ()
	writePCId (string $a_pc_id)
	setEnabled (string $value)
	Set Enabled value for page content component. More...
	enable ()
	disable ()
	isEnabled ()
	createPageContentNode (bool $a_set_this_node=true)
	Create page content node (always use this method first when adding a new element) More...
	getNewPageContentNode ()
	modifyPageContentPostXsl (string $a_output, string $a_mode, bool $a_abstract_only=false)
	Modify page content after xsl. More...
	getModel ()
	Get model as needed for the front-end editor. More...

Static Public Member Functions
static	afterPageUpdate (ilPageObject $a_page, DOMDocument $a_domdoc, string $a_xml, bool $a_creation)
static	beforePageDelete (ilPageObject $a_page)
static	afterPageHistoryEntry (ilPageObject $a_page, DOMDocument $a_old_domdoc, string $a_old_xml, int $a_old_nr)
	After page history entry has been created. More...
static	getLangVars ()
	Get lang vars needed for editing. More...
Static Public Member Functions inherited from ilPageContent
static	sortHierIds (array $a_array)
	Sort an array of Hier IDS in ascending order. More...
static	isGreaterHierId (string $a, string $b)
	Check whether Hier ID $a is greater than Hier ID $b. More...
static	getLangVars ()
	Get lang vars needed for editing. More...
static	handleCopiedContent (DOMDocument $a_domdoc, bool $a_self_ass=true, bool $a_clone_mobs=false, int $new_parent_id=0, int $obj_copy_id=0)
	Handle copied content. More...
static	afterPageUpdate (ilPageObject $a_page, DOMDocument $a_domdoc, string $a_xml, bool $a_creation)
	After page has been updated (or created) More...
static	beforePageDelete (ilPageObject $a_page)
	Before page is being deleted. More...
static	afterRepositoryCopy (ilPageObject $page, array $mapping, int $source_ref_id)
	After repository (container) copy action. More...
static	afterPageHistoryEntry (ilPageObject $a_page, DOMDocument $a_old_domdoc, string $a_old_xml, int $a_old_nr)
	After page history entry has been created. More...
static	deleteHistoryLowerEqualThan (string $parent_type, int $page_id, string $lang, int $delete_lower_than_nr)
	Overwrite in derived classes, if old history entries are being deleted. More...

Protected Member Functions
	getPresentation (string $from, string $to, array $classes, string $a_mode)
	Get presentation. More...
Protected Member Functions inherited from ilPageContent
	getPageManager ()
	setType (string $a_type)
	Set Type. More...
	hasNode ()
	createInitialChildNode (string $hier_id, string $pc_id, string $child, array $child_attributes=[])

Protected Attributes
ilObjUser	$user
Protected Attributes inherited from ilPageContent
DOMDocument	$dom_doc
ILIAS COPage InternalDomainService	$domain
string	$pcid
string	$type = ""
ilPageObject	$pg_obj
string	$file_download_link
string	$fullscreen_link
string	$sourcecode_download_script
ilLogger	$log
string	$profile_back_url = ""
ILIAS COPage Dom DomUtil	$dom_util
PageManagerInterface	$page_manager = null
ObjectAdapterInterface	$object = null

Additional Inherited Members
Data Fields inherited from ilPageContent
string	$hier_id = ""
DOMNode	$dom_node = null
string	$page_lang = ""

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 Learning history page content

Author

Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

Definition at line 23 of file class.ilPCLearningHistory.php.

Member Function Documentation

afterPageHistoryEntry()

static ilPCLearningHistory::afterPageHistoryEntry ( ilPageObject  $a_page, DOMDocument  $a_old_domdoc, string  $a_old_xml, int  $a_old_nr  )

static

After page history entry has been created.

Parameters

ilPageObject	$a_page	page object
DOMDocument	$a_old_domdoc	old dom document
string	$a_old_xml	old xml
int	$a_old_nr	history number

Definition at line 112 of file class.ilPCLearningHistory.php.

     : void {
    }

afterPageUpdate()

static ilPCLearningHistory::afterPageUpdate ( ilPageObject  $a_page, DOMDocument  $a_domdoc, string  $a_xml, bool  $a_creation  )

static

Definition at line 92 of file class.ilPCLearningHistory.php.

     : void {
    }

beforePageDelete()

static ilPCLearningHistory::beforePageDelete ( ilPageObject  $a_page )

static

Definition at line 100 of file class.ilPCLearningHistory.php.

     : void {
    }

create()

ilPCLearningHistory::create	(	ilPageObject	$a_pg_obj,
		string	$a_hier_id,
		string	$a_pc_id = ""
	)

Create learning history node.

Definition at line 38 of file class.ilPCLearningHistory.php.

References ilPageContent\createPageContentNode(), ilPageContent\getDomNode(), IL_INSERT_AFTER, and ilPageObject\insertContent().

                                                                                           : void
    {
        $this->createPageContentNode();
        $a_pg_obj->insertContent($this, $a_hier_id, IL_INSERT_AFTER, $a_pc_id);
        $lhist_node = $this->dom_doc->createElement("LearningHistory");
        $lhist_node = $this->getDomNode()->appendChild($lhist_node);
    }

Here is the call graph for this function:

getClasses()

ilPCLearningHistory::getClasses

(

)

Definition at line 81 of file class.ilPCLearningHistory.php.

References ilPageContent\getChildNode().

                                : array
    {
        $classes = [];
        // delete properties
        $children = $this->getChildNode()->childNodes;
        foreach ($children as $iValue) {
            $classes[] = $iValue->getAttribute("Name");
        }
        return $classes;
    }

Here is the call graph for this function:

getFrom()

ilPCLearningHistory::getFrom

(

)

Definition at line 51 of file class.ilPCLearningHistory.php.

References ilPageContent\getChildNode().

                             : string
    {
        return (string) $this->getChildNode()->getAttribute("From");
    }

Here is the call graph for this function:

getLangVars()

static ilPCLearningHistory::getLangVars ( )

static

Get lang vars needed for editing.

Definition at line 123 of file class.ilPCLearningHistory.php.

                                        : array
    {
        return array("ed_insert_learning_history", "pc_learning_history");
    }

getPresentation()

ilPCLearningHistory::getPresentation ( string  $from, string  $to, array  $classes, string  $a_mode  )

protected

Get presentation.

Exceptions

ilCtrlException
ilDateTimeException

Definition at line 174 of file class.ilPCLearningHistory.php.

References $user_id, ilObject\_lookupOwner(), ilPageContent\getPage(), ilPCLearningHistoryGUI\getPlaceholderPresentation(), IL_CAL_DATETIME, IL_CAL_UNIX, and null.

Referenced by modifyPageContentPostXsl().

     : string {
        $user_id = 0;
        if ($a_mode === "preview" || $a_mode === "presentation" || $a_mode === "print") {
            if ($this->getPage()->getParentType() === "prtf") {
                $user_id = ilObject::_lookupOwner($this->getPage()->getPortfolioId());
            }
        }
        if ($user_id > 0) {
            $tpl = new ilTemplate("tpl.pc_lhist.html", true, true, "components/ILIAS/LearningHistory");
            $hist_gui = new ilLearningHistoryGUI();
            $hist_gui->setUserId($user_id);
            $from_unix = ($from != "")
                ? (new ilDateTime($from . " 00:00:00", IL_CAL_DATETIME))->get(IL_CAL_UNIX)
                : null;
            $to_unix = ($to != "")
                ? (new ilDateTime($to . " 23:59:59", IL_CAL_DATETIME))->get(IL_CAL_UNIX)
                : null;
            $classes = (is_array($classes))
                ? array_filter($classes, static function ($i): bool {
                    return ($i != "");
                })
                : [];
            if (count($classes) === 0) {
                $classes = null;
            }
            $tpl->setVariable("LHIST", $hist_gui->getEmbeddedHTML($from_unix, $to_unix, $classes, $a_mode));
            return $tpl->get();
        }

        return ilPCLearningHistoryGUI::getPlaceholderPresentation();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getTo()

ilPCLearningHistory::getTo

(

)

Definition at line 61 of file class.ilPCLearningHistory.php.

References ilPageContent\getChildNode().

                           : string
    {
        return (string) $this->getChildNode()->getAttribute("To");
    }

Here is the call graph for this function:

init()

ilPCLearningHistory::init

(

)

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

References $DIC, ilPageContent\setType(), and ILIAS\Repository\user().

                          : void
    {
        global $DIC;

        $this->user = $DIC->user();
        $this->setType("lhist");
    }

Here is the call graph for this function:

modifyPageContentPostXsl()

ilPCLearningHistory::modifyPageContentPostXsl	(	string	$a_output,
		string	$a_mode,
		bool	$a_abstract_only = false
	)

Definition at line 128 of file class.ilPCLearningHistory.php.

References $param, and getPresentation().

     : string {
        $start = strpos($a_output, "{{{{{LearningHistory");
        $end = 0;
        if (is_int($start)) {
            $end = strpos($a_output, "}}}}}", $start);
        }

        while ($end > 0) {
            $param = substr($a_output, $start + 5, $end - $start - 5);
            $param = str_replace(' xmlns:xhtml="http://www.w3.org/1999/xhtml"', "", $param);
            $param = explode("#", $param);
            $from = $param[1];
            $to = $param[2];
            $classes = explode(";", $param[3]);
            $classes = array_map(static function ($i) {
                return trim($i);
            }, $classes);


            $a_output = substr($a_output, 0, $start) .
                $this->getPresentation($from, $to, $classes, $a_mode) .
                substr($a_output, $end + 5);

            if (strlen($a_output) > $start + 5) {
                $start = strpos($a_output, "{{{{{LearningHistory", $start + 5);
            } else {
                $start = false;
            }
            $end = 0;
            if (is_int($start)) {
                $end = strpos($a_output, "}}}}}", $start);
            }
        }

        return $a_output;
    }

Here is the call graph for this function:

setClasses()

ilPCLearningHistory::setClasses

(

array

$a_val

)

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

References ilPageContent\getChildNode().

                                            : void
    {
        // delete properties
        $children = $this->getChildNode()->childNodes;
        foreach ($children as $iValue) {
            $this->getChildNode()->removeChild($iValue);
        }
        // set classes
        foreach ($a_val as $key => $class) {
            $prop_node = $this->dom_doc->createElement("LearningHistoryProvider");
            $prop_node = $this->getChildNode()->appendChild($prop_node);
            $prop_node->setAttribute("Name", $class);
        }
    }

Here is the call graph for this function:

setFrom()

ilPCLearningHistory::setFrom

(

string

$a_val

)

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

References ilPageContent\getChildNode().

                                          : void
    {
        $this->getChildNode()->setAttribute("From", $a_val);
    }

Here is the call graph for this function:

setTo()

ilPCLearningHistory::setTo

(

string

$a_val

)

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

References ilPageContent\getChildNode().

                                        : void
    {
        $this->getChildNode()->setAttribute("To", $a_val);
    }

Here is the call graph for this function:

Field Documentation

$user

ilObjUser ilPCLearningHistory::$user

protected

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

---

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

• components/ILIAS/LearningHistory/classes/class.ilPCLearningHistory.php