This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilPCLoginPageElement:

Collaboration diagram for ilPCLoginPageElement:

Public Member Functions
	init ()
	Init object. More...

	setNode (php4DOMElement $a_node)
	Set node. More...

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

	setLoginPageElementType (string $a_type)

	getLoginPageElementType ()

	setAlignment (string $a_alignment)

	getAlignment ()

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	getAllTypes ()
	Get all types. 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...

Data Fields
php4DOMElement	$res_node

Data Fields inherited from ilPageContent
string	$hier_id = ""

php4DOMElement	$node = null

php4DOMDocument	$dom = null

string	$page_lang = ""

Static Private Attributes
static array	$types

Additional Inherited Members
Protected Member Functions inherited from ilPageContent
	setType (string $a_type)
	Set Type. More...

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 = ""

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 ilPCLoginPageElement

Login page element object (see ILIAS DTD). Inserts login page elements

Author: Stefan Meyer smeye.nosp@m.r.il.nosp@m.ias@g.nosp@m.mx.d.nosp@m.e

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

Member Function Documentation

◆ create()

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

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

     : void {
        $this->node = $this->createPageContentNode();
        $a_pg_obj->insertContent($this, $a_hier_id, IL_INSERT_AFTER, $a_pc_id);
        $lpe = $this->dom->create_element('LoginPageElement');
        $this->res_node = $this->node->append_child($lpe);
    }

◆ getAlignment()

ilPCLoginPageElement::getAlignment ( )

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

                                  : string
    {
        if (isset($this->res_node) && is_object($this->res_node)) {
            return $this->res_node->get_attribute('HorizontalAlign');
        }
        return "";
    }

◆ getAllTypes()

static ilPCLoginPageElement::getAllTypes ( )

static

Get all types.

Definition at line 42 of file class.ilPCLoginPageElement.php.

                                        : array
    {
        return self::$types;
    }

References $types.

Referenced by ilPCLoginPageElementGUI\edit().

Here is the caller graph for this function:

◆ getLangVars()

static ilPCLoginPageElement::getLangVars ( )

static

Get lang vars needed for editing.

Returns: string[] array of lang var keys

Reimplemented from ilPageContent.

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

                                        : array
    {
        return array("ed_insert_login_page_element");
    }

◆ getLoginPageElementType()

ilPCLoginPageElement::getLoginPageElementType ( )

Definition at line 79 of file class.ilPCLoginPageElement.php.

                                             : string
    {
        if (is_object($this->res_node)) {
            return $this->res_node->get_attribute('Type');
        }
        return "";
    }

◆ init()

ilPCLoginPageElement::init ( )

Init object.

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

Reimplemented from ilPageContent.

Definition at line 47 of file class.ilPCLoginPageElement.php.

                          : void
    {
        $this->setType('lpe');
    }

References ilPageContent\setType().

Here is the call graph for this function:

◆ setAlignment()

ilPCLoginPageElement::setAlignment ( string $a_alignment )

Definition at line 87 of file class.ilPCLoginPageElement.php.

                                                     : void
    {
        $this->res_node->set_attribute('HorizontalAlign', $a_alignment);
    }

◆ setLoginPageElementType()

ilPCLoginPageElement::setLoginPageElementType ( string $a_type )

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

                                                           : void
    {
        if (!empty($a_type)) {
            $this->res_node->set_attribute('Type', $a_type);
        }
    }

◆ setNode()

ilPCLoginPageElement::setNode ( php4DOMElement $a_node )

Set node.

Reimplemented from ilPageContent.

Definition at line 55 of file class.ilPCLoginPageElement.php.

                                                   : void
    {
        parent::setNode($a_node);                                               // this is the PageContent node
        $this->res_node = $a_node->first_child();               // this is the login page element
    }

References php4DOMNode\first_child().

Here is the call graph for this function:

Field Documentation

◆ $res_node

php4DOMElement ilPCLoginPageElement::$res_node

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

◆ $types

array ilPCLoginPageElement::$types

staticprivate

Initial value:

= array(
        'login-form' => 'login_form',
        'cas-login-form' => 'cas_login_form',
        'shibboleth-login-form' => 'shib_login_form',
        'openid-connect-login' => 'openid_connect_login',
        'registration-link' => 'registration_link',
        'user-agreement' => 'user_agreement_link',
        'saml-login' => 'saml_login'
    )

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

Referenced by getAllTypes().

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

Services/COPage/classes/class.ilPCLoginPageElement.php

Public Member Functions

Static Public Member Functions

Data Fields

Static Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ create()

◆ getAlignment()

◆ getAllTypes()

◆ getLangVars()

◆ getLoginPageElementType()

◆ init()

◆ setAlignment()

◆ setLoginPageElementType()

◆ setNode()

Field Documentation

◆ $res_node

◆ $types