ilPCLearningHistory Class Reference

Learning history page content. More...

Inheritance diagram for ilPCLearningHistory:

Collaboration diagram for ilPCLearningHistory:

Public Member Functions
	init ()
	Init page content component. More...
	setNode ($a_node)
	Set node. More...
	create (ilPageObject $a_pg_obj, string $a_hier_id, $a_pc_id="")
	Create learning history node. More...
	setFrom ($a_val)
	Set from. More...
	getFrom ()
	Get from. More...
	setTo ($a_val)
	Set to. More...
	getTo ()
	Get to. More...
	setClasses ($a_val)
	Set classes. More...
	getClasses ()
	Get classes. More...
	modifyPageContentPostXsl ($a_html, $a_mode, $a_abstract_only=false)
Public Member Functions inherited from ilPageContent
	__construct ($a_pg_obj)
	Constructor. More...
	setPage ($a_val)
	Set page. More...
	getPage ()
	Get page. More...
	init ()
	Init object. More...
	getType ()
	Get type of page content. More...
	setNode ($a_node)
	Set xml node of page content. More...
&	getNode ()
	Get xml node of page content. More...
	getJavascriptFiles ($a_mode)
	Get Javascript files. More...
	getCssFiles ($a_mode)
	Get css files. More...
	getOnloadCode ($a_mode)
	Get on load code. More...
	setHierId ($a_hier_id)
	Set hierarchical ID in xml structure. More...
	getHierId ()
	Get hierarchical id. More...
	lookupHierId ()
	Get hierarchical id from dom. More...
	readHierId ()
	Read PC Id. More...
	setPcId ($a_pcid)
	Set PC Id. More...
	getPCId ()
	Get PC Id. More...
	setFileDownloadLink ($a_download_link)
	Set file download link. More...
	getFileDownloadLink ()
	Get file download link. More...
	setProfileBackUrl ($url)
	getProfileBackUrl ()
	setFullscreenLink ($a_fullscreen_link)
	Set fullscreen link. More...
	getFullscreenLink ()
	Get fullscreen link. More...
	setSourcecodeDownloadScript ($script_name)
	Set sourcecode download script. More...
	getSourcecodeDownloadScript ()
	Get sourcecode download script. More...
	readPCId ()
	Read PC Id. More...
	writePCId ($a_pc_id)
	Write pc id. More...
	setEnabled ($value)
	Set Enabled value for page content component. More...
	enable ()
	Enable page content. More...
	disable ()
	Disable page content. More...
	isEnabled ()
	Check whether page content is enabled. More...
	createPageContentNode ($a_set_this_node=true)
	Create page content node (always use this method first when adding a new element) More...
	modifyPageContentPostXsl ($a_output, $a_mode, $a_abstract_only=false)
	Modify page content after xsl. More...

Static Public Member Functions
static	afterPageUpdate ($a_page, DOMDocument $a_domdoc, $a_xml, $a_creation)
	After page has been updated (or created) More...
static	beforePageDelete ($a_page)
	Before page is being deleted. More...
static	afterPageHistoryEntry ($a_page, DOMDocument $a_old_domdoc, $a_old_xml, $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 ($ed_id)
	Increases an hierarchical editing id at lowest level (last number) More...
static	decEdId ($ed_id)
	Decreases an hierarchical editing id at lowest level (last number) More...
static	haveSameContainer ($ed_id1, $ed_id2)
	Check, if two ids are in same container. More...
static	sortHierIds ($a_array)
	Sort an array of Hier IDS in ascending order. More...
static	isGreaterHierId ($a, $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, $a_self_ass=true, $a_clone_mobs=false)
	Handle copied content. More...
static	afterPageUpdate ($a_page, DOMDocument $a_domdoc, $a_xml, $a_creation)
	After page has been updated (or created) More...
static	beforePageDelete ($a_page)
	Before page is being deleted. More...
static	afterPageHistoryEntry ($a_page, DOMDocument $a_old_domdoc, $a_old_xml, $a_old_nr)
	After page history entry has been created. More...

Data Fields
	$dom
Data Fields inherited from ilPageContent
	$hier_id
	$node
	$dom
	$page_lang

Protected Member Functions
	getPresentation ($from, $to, $classes, $a_mode)
	Get presentation. More...
Protected Member Functions inherited from ilPageContent
	setType ($a_type)
	Set Type. More...

Protected Attributes
	$user
Protected Attributes inherited from ilPageContent
	$profile_back_url
	$file_download_link
	$fullscreen_link
	$sourcecode_download_script
	$log

Detailed Description

Learning history page content.

Author

killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..com

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

Member Function Documentation

afterPageHistoryEntry()

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

static

After page history entry has been created.

Parameters

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

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

    {
    }

afterPageUpdate()

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

static

After page has been updated (or created)

Parameters

object	$a_page	page object
DOMDocument	$a_domdoc	dom document
string	$a_xml	xml
bool	$a_creation	true on creation, otherwise false

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

    {
    }

beforePageDelete()

static ilPCLearningHistory::beforePageDelete (   $a_page )

static

Before page is being deleted.

Parameters

object

$a_page

page object

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

    {
    }

create()

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

Create learning history node.

Parameters

ilPageObject	$a_pg_obj
string	$a_hier_id
string	$a_pc_id

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

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

    {
        $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);
    }

Here is the call graph for this function:

getClasses()

ilPCLearningHistory::getClasses

(

)

Get classes.

Returns

array classes

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

References $i.

    {
        $classes = [];
        // delete properties
        $children = $this->lhist_node->child_nodes();
        for ($i = 0; $i < count($children); $i++) {
            $classes[] = $children[$i]->get_attribute("Name");
        }
        return $classes;
    }

getFrom()

ilPCLearningHistory::getFrom

(

)

Get from.

Returns

string from

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

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

getLangVars()

static ilPCLearningHistory::getLangVars ( )

static

Get lang vars needed for editing.

Returns

array array of lang var keys

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

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

getPresentation()

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

protected

Get presentation.

Parameters

int	$from	unix timestamp
int	$to	unix timestamp
array	$classes
string	$mode

Returns

string

Exceptions

ilCtrlException

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

References $i, $tpl, ilObject\_lookupOwner(), ilPageContent\getPage(), IL_CAL_DATETIME, and IL_CAL_UNIX.

Referenced by modifyPageContentPostXsl().

                                                                      : string
    {
        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, function ($i) {
                    return ($i != "");
                })
                : null;
            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

(

)

Get to.

Returns

string to

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

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

init()

ilPCLearningHistory::init

(

)

Init page content component.

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

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

    {
        global $DIC;

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

Here is the call graph for this function:

modifyPageContentPostXsl()

ilPCLearningHistory::modifyPageContentPostXsl	(		$a_html,
			$a_mode,
			$a_abstract_only = false
	)

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

References $i, $lng, $param, and getPresentation().

    {
        $lng = $this->lng;
        $ilPluginAdmin = $this->plugin_admin;

        $start = strpos($a_html, "{{{{{LearningHistory");
        if (is_int($start)) {
            $end = strpos($a_html, "}}}}}", $start);
        }

        while ($end > 0) {
            $param = substr($a_html, $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(function ($i) {
                return trim($i);
            }, $classes);


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

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

        return $a_html;
    }

Here is the call graph for this function:

setClasses()

ilPCLearningHistory::setClasses

(

$a_val

)

Set classes.

Parameters

array

$a_val

classes

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

References $i.

    {
        // delete properties
        $children = $this->lhist_node->child_nodes();
        for ($i = 0; $i < count($children); $i++) {
            $this->lhist_node->remove_child($children[$i]);
        }
        // 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);
        }
    }

setFrom()

ilPCLearningHistory::setFrom

(

$a_val

)

Set from.

Parameters

string

$a_val

from

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

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

setNode()

ilPCLearningHistory::setNode

(

$a_node

)

Set node.

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

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

setTo()

ilPCLearningHistory::setTo

(

$a_val

)

Set to.

Parameters

string

$a_val

to

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

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

Field Documentation

$dom

ilPCLearningHistory::$dom

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

$user

ilPCLearningHistory::$user

protected

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

---

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

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