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

Collaboration diagram for ilPCProfile:

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="")
	setFields (string $a_mode, array $a_fields=null)
	getMode ()
	getFields ()
	Get profile settings. 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	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 Attributes
php4DOMElement	$prof_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 = ""
Protected Member Functions inherited from ilPageContent
	setType (string $a_type)
	Set Type. More...

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 Class ilPCProfile Personal data content object (see ILIAS DTD)

Author

Jörg Lützenkirchen luetz.nosp@m.enki.nosp@m.rchen.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Definition at line 24 of file class.ilPCProfile.php.

Member Function Documentation

create()

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

Definition at line 43 of file class.ilPCProfile.php.

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

getFields()

ilPCProfile::getFields

(

)

Get profile settings.

Definition at line 91 of file class.ilPCProfile.php.

                               : array
    {
        $res = array();
        if (is_object($this->prof_node)) {
            $children = $this->prof_node->child_nodes();
            if ($children) {
                foreach ($children as $child) {
                    $res[] = $child->get_attribute("Name");
                }
            }
        }
        return $res;
    }

References $res.

getLangVars()

static ilPCProfile::getLangVars ( )

static

Get lang vars needed for editing.

Returns

string[] array of lang var keys

Reimplemented from ilPageContent.

Definition at line 105 of file class.ilPCProfile.php.

                                        : array
    {
        return array("pc_prof", "ed_insert_profile");
    }

getMode()

ilPCProfile::getMode

(

)

Definition at line 80 of file class.ilPCProfile.php.

                             : string
    {
        if (is_object($this->prof_node)) {
            return $this->prof_node->get_attribute("Mode");
        }
        return "";
    }

init()

ilPCProfile::init

(

)

Init object.

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

Reimplemented from ilPageContent.

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

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

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

Here is the call graph for this function:

setFields()

ilPCProfile::setFields	(	string	$a_mode,
		array	$a_fields = null
	)

Definition at line 54 of file class.ilPCProfile.php.

     : void {
        $ilUser = $this->user;
 
        $this->prof_node->set_attribute("Mode", $a_mode);
        $this->prof_node->set_attribute("User", $ilUser->getId());
 
        // remove all children first
        $children = $this->prof_node->child_nodes();
        if ($children) {
            foreach ($children as $child) {
                $this->prof_node->remove_child($child);
            }
        }
 
        if ($a_mode == "manual") {
            foreach ($a_fields as $field) {
                $field_node = $this->dom->create_element("ProfileField");
                $field_node = $this->prof_node->append_child($field_node);
                $field_node->set_attribute("Name", $field);
            }
        }
    }

setNode()

ilPCProfile::setNode

(

php4DOMElement

$a_node

)

Set xml node of page content.

Parameters

php4DOMElement

$a_node

node object

Reimplemented from ilPageContent.

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

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

References php4DOMNode\first_child().

Here is the call graph for this function:

Field Documentation

$prof_node

php4DOMElement ilPCProfile::$prof_node

protected

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

$user

ilObjUser ilPCProfile::$user

protected

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

---

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

• Services/COPage/classes/class.ilPCProfile.php