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...
	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, ?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	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 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 = ""
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=[])

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 36 of file class.ilPCProfile.php.

     : void {
        $this->createInitialChildNode($a_hier_id, $a_pc_id, "Profile");
    }

getFields()

ilPCProfile::getFields

(

)

Get profile settings.

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

                               : array
    {
        $res = array();
        if (is_object($this->getChildNode())) {
            foreach ($this->getChildNode()->childNodes as $child) {
                $res[] = $child->getAttribute("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 87 of file class.ilPCProfile.php.

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

getMode()

ilPCProfile::getMode

(

)

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

                             : string
    {
        if (is_object($this->getChildNode())) {
            return $this->getChildNode()->getAttribute("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 28 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 44 of file class.ilPCProfile.php.

     : void {
        $ilUser = $this->user;
 
        $this->getChildNode()->setAttribute("Mode", $a_mode);
        $this->getChildNode()->setAttribute("User", $ilUser->getId());
 
        // remove all children first
        $this->dom_util->deleteAllChilds($this->getChildNode());
 
        if ($a_mode == "manual") {
            foreach ($a_fields as $field) {
                $field_node = $this->dom_doc->createElement("ProfileField");
                $field_node = $this->getChildNode()->appendChild($field_node);
                $field_node->setAttribute("Name", $field);
            }
        }
    }

Field Documentation

$user

ilObjUser ilPCProfile::$user

protected

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

---

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

• components/ILIAS/COPage/PC/Profile/class.ilPCProfile.php