ilPCLoginPageElements Class Reference

Class ilPCLoginPageElements. More...

Inheritance diagram for ilPCLoginPageElements:

Collaboration diagram for ilPCLoginPageElements:

Public Member Functions
	init ()
	Init page content component.
	setNode (&$a_node)
	Set node.
	create (&$a_pg_obj, $a_hier_id, $a_pc_id="")
	Create resources node in xml.
	setLoginPageElementType ($a_type)
	Set Type of Login Page Element.
	getLoginPageElementType ()
	Get log page element type.
	setAlignment ($a_alignment)
	set alignment
	getAlignment ()
	Get alignment.
Public Member Functions inherited from ilPageContent
	__construct ($a_dom)
	Constructor.
	getType ()
	Get type of page content.
&	getNode ()
	Get xml node of page content.
	setHierId ($a_hier_id)
	Set hierarchical ID in xml structure.
	getHierId ()
	Get hierarchical id.
	lookupHierId ()
	Get hierarchical id from dom.
	readHierId ()
	Read PC Id.
	setPcId ($a_pcid)
	Set PC Id.
	getPCId ()
	Get PC Id.
	readPCId ()
	Read PC Id.
	writePCId ($a_pc_id)
	Write pc id.
	isGreaterHierId ($a, $b)
	Check whether Hier ID $a is greater than Hier ID $b.
	setEnabled ($value)
	Set Enabled value for page content component.
	enable ()
	Enable page content.
	disable ()
	Disable page content.
	isEnabled ()
	Check whether page content is enabled.
	createPageContentNode ($a_set_this_node=true)
	Create page content node (always use this method first when adding a new element)

Static Public Member Functions
static	getAllTypes ()
	Get all types.
Static Public Member Functions inherited from ilPageContent
static	incEdId ($ed_id)
	Increases an hierarchical editing id at lowest level (last number)
static	decEdId ($ed_id)
	Decreases an hierarchical editing id at lowest level (last number)
static	haveSameContainer ($ed_id1, $ed_id2)
	Check, if two ids are in same container.
static	sortHierIds ($a_array)
	Sort an array of Hier IDS in ascending order.

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

Static Private Attributes
static	$types

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

Detailed Description

Class ilPCLoginPageElements.

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

Member Function Documentation

ilPCLoginPageElements::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 63 of file class.ilPCLoginPageElements.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:

ilPCLoginPageElements::getAlignment

(

)

Get alignment.

Returns

string $alignment

Definition at line 109 of file class.ilPCLoginPageElements.php.

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

static ilPCLoginPageElements::getAllTypes ( )

static

Get all types.

Returns

array all type

Definition at line 35 of file class.ilPCLoginPageElements.php.

References $types.

Referenced by ilPCLoginPageElementGUI\edit().

        {
                return self::$types;
        }

Here is the caller graph for this function:

ilPCLoginPageElements::getLoginPageElementType

(

)

Get log page element type.

Returns

string resource type group

Definition at line 89 of file class.ilPCLoginPageElements.php.

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

ilPCLoginPageElements::init

(

)

Init page content component.

Reimplemented from ilPageContent.

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

References ilPageContent\setType().

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

Here is the call graph for this function:

ilPCLoginPageElements::setAlignment

(

$a_alignment

)

set alignment

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

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

ilPCLoginPageElements::setLoginPageElementType

(

$a_type

)

Set Type of Login Page Element.

Parameters

string

$a_type

Resource Type Group

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

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

ilPCLoginPageElements::setNode

(

&

$a_node

)

Set node.

Reimplemented from ilPageContent.

Definition at line 51 of file class.ilPCLoginPageElements.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

ilPCLoginPageElements::$dom

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

ilPCLoginPageElements::$res_node

Definition at line 19 of file class.ilPCLoginPageElements.php.

ilPCLoginPageElements::$types

staticprivate

Initial value:

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

Definition at line 21 of file class.ilPCLoginPageElements.php.

Referenced by getAllTypes().

---

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

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