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 ()
	Init object. More...
	setNode (php4DOMElement $a_node)
	Set xml node of page content. More...
	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)
	Modify page content after xsl. More...
Public Member Functions inherited from ilPageContent
	__construct (ilPageObject $a_pg_obj)
	setPage (ilPageObject $a_val)
	getPage ()
	init ()
	Init object. More...
	getType ()
	setNode (php4DOMElement $a_node)
	Set xml node of page content. More...
	getNode ()
	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...
	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)
	After page has been updated (or created) More...
static	beforePageDelete (ilPageObject $a_page)
	Before page is being deleted. 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	getLangVars ()
	Get lang vars needed for editing. More...
Static Public Member Functions inherited from ilPageContent
static	incEdId (string $ed_id)
	Increases an hierarchical editing id at lowest level (last number) More...
static	decEdId (string $ed_id)
	Decreases an hierarchical editing id at lowest level (last number) More...
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
	setType (string $a_type)
	Set Type. More...

Protected Attributes
php4DOMElement	$lhist_node
ilObjUser	$user
Protected Attributes inherited from ilPageContent
string	$pcid
string	$type = ""
ilPageObject	$pg_obj
string	$file_download_link
string	$fullscreen_link
string	$sourcecode_download_script
ilLogger	$log
string	$profile_back_url = ""

Additional Inherited Members
Data Fields inherited from ilPageContent
string	$hier_id = ""
php4DOMElement	$node = null
php4DOMDocument	$dom = 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

Reimplemented from ilPageContent.

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

     : void {
    }

afterPageUpdate()

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

static

After page has been updated (or created)

Reimplemented from ilPageContent.

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

     : void {
    }

beforePageDelete()

static ilPCLearningHistory::beforePageDelete ( ilPageObject  $a_page )

static

Before page is being deleted.

Parameters

ilPageObject

$a_page

page object

Reimplemented from ilPageContent.

Definition at line 107 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 45 of file class.ilPCLearningHistory.php.

                                                                                           : void
    {
        $this->node = $this->createPageContentNode();
        $a_pg_obj->insertContent($this, $a_hier_id, IL_INSERT_AFTER, $a_pc_id);
        $this->lhist_node = $this->dom->create_element("LearningHistory");
        $this->lhist_node = $this->node->append_child($this->lhist_node);
    }

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

Here is the call graph for this function:

getClasses()

ilPCLearningHistory::getClasses

(

)

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

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

getFrom()

ilPCLearningHistory::getFrom

(

)

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

                             : string
    {
        return (string) $this->lhist_node->get_attribute("From");
    }

getLangVars()

static ilPCLearningHistory::getLangVars ( )

static

Get lang vars needed for editing.

Reimplemented from ilPageContent.

Definition at line 130 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 181 of file class.ilPCLearningHistory.php.

     : 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, "Services/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();
    }

References ilObject\_lookupOwner().

Here is the call graph for this function:

getTo()

ilPCLearningHistory::getTo

(

)

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

                           : string
    {
        return (string) $this->lhist_node->get_attribute("To");
    }

init()

ilPCLearningHistory::init

(

)

Init object.

This function must be overwritten and at least set the content type.

Reimplemented from ilPageContent.

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

                          : void
    {
        global $DIC;
 
        $this->user = $DIC->user();
        $this->setType("lhist");
    }

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

Here is the call graph for this function:

modifyPageContentPostXsl()

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

Modify page content after xsl.

Reimplemented from ilPageContent.

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

     : 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;
    }

setClasses()

ilPCLearningHistory::setClasses

(

array

$a_val

)

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

                                            : void
    {
        // delete properties
        $children = $this->lhist_node->child_nodes();
        foreach ($children as $iValue) {
            $this->lhist_node->remove_child($iValue);
        }
        // set classes
        foreach ($a_val as $key => $class) {
            $prop_node = $this->dom->create_element("LearningHistoryProvider");
            $prop_node = $this->lhist_node->append_child($prop_node);
            $prop_node->set_attribute("Name", $class);
        }
    }

References ILIAS\LTI\ToolProvider\$key.

setFrom()

ilPCLearningHistory::setFrom

(

string

$a_val

)

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

                                          : void
    {
        $this->lhist_node->set_attribute("From", $a_val);
    }

setNode()

ilPCLearningHistory::setNode

(

php4DOMElement

$a_node

)

Set xml node of page content.

Parameters

php4DOMElement

$a_node

node object

Reimplemented from ilPageContent.

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

                                                   : void
    {
        parent::setNode($a_node);               // this is the PageContent node
        $this->lhist_node = $a_node->first_child();             // this is the skill node
    }

References php4DOMNode\first_child().

Here is the call graph for this function:

setTo()

ilPCLearningHistory::setTo

(

string

$a_val

)

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

                                        : void
    {
        $this->lhist_node->set_attribute("To", $a_val);
    }

Field Documentation

$lhist_node

php4DOMElement ilPCLearningHistory::$lhist_node

protected

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

$user

ilObjUser ilPCLearningHistory::$user

protected

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

---

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

• Services/LearningHistory/classes/class.ilPCLearningHistory.php