Inheritance diagram for ilPCLoginPageElement:

Collaboration diagram for ilPCLoginPageElement:

Public Member Functions
	init ()
	Init page content component. More...

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

	create (&$a_pg_obj, $a_hier_id, $a_pc_id="")
	Create resources node in xml. More...

	setLoginPageElementType ($a_type)
	Set Type of Login Page Element. More...

	getLoginPageElementType ()
	Get log page element type. More...

	setAlignment ($a_alignment)
	set alignment More...

	getAlignment ()
	Get alignment. More...

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...

	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)
	Modify page content after xsl. 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 ($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
	$res_node

Data Fields inherited from ilPageContent
	$hier_id

	$node

	$dom

	$page_lang

Static Private Attributes
static	$types

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

Protected Attributes inherited from ilPageContent
	$file_download_link

	$fullscreen_link

	$sourcecode_download_script

	$log

Detailed Description

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

Version: $Id$

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

Member Function Documentation

◆ create()

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

Create resources node in xml.

Parameters

object	$a_pg_obj	Page Object
string	$a_hier_id	Hierarchical ID

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

References ilPageContent\createPageContentNode(), and IL_INSERT_AFTER.

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

Here is the call graph for this function:

◆ getAlignment()

ilPCLoginPageElement::getAlignment ( )

Get alignment.

Returns: string $alignment

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

     {
         if (is_object($this->res_node)) {
             return $this->res_node->get_attribute('HorizontalAlign');
         }
     }

◆ getAllTypes()

static ilPCLoginPageElement::getAllTypes ( )

static

Get all types.

Returns: array all type

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

Referenced by ilPCLoginPageElementGUI\edit().

     {
         return self::$types;
     }

Here is the caller graph for this function:

◆ getLangVars()

static ilPCLoginPageElement::getLangVars ( )

static

Get lang vars needed for editing.

Returns: array array of lang var keys

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

References array.

     {
         return array("ed_insert_login_page_element");
     }

◆ getLoginPageElementType()

ilPCLoginPageElement::getLoginPageElementType ( )

Get log page element type.

Returns: string resource type group

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

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

◆ init()

ilPCLoginPageElement::init ( )

Init page content component.

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

References ilPageContent\setType().

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

Here is the call graph for this function:

◆ setAlignment()

ilPCLoginPageElement::setAlignment ( $a_alignment )

set alignment

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

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

◆ setLoginPageElementType()

ilPCLoginPageElement::setLoginPageElementType ( $a_type )

Set Type of Login Page Element.

Parameters

string $a_type Resource Type Group

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

References $a_type.

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

◆ setNode()

ilPCLoginPageElement::setNode ( $a_node )

Set node.

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

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

Field Documentation

◆ $res_node

ilPCLoginPageElement::$res_node

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

◆ $types

ilPCLoginPageElement::$types

staticprivate

Initial value:

= array(
        'login-form' => 'login_form',
        'cas-login-form' => 'cas_login_form',
        'shibboleth-login-form' => 'shib_login_form',
        'registration-link' => 'registration_link',
        'language-selection' => 'language_selection',
        'user-agreement' => 'user_agreement_link'
    )

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

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