ILIAS  trunk Revision v11.0_alpha-2662-g519ff7d528f
ilPCLoginPageElement 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 ilPCLoginPageElement:
+ Collaboration diagram for ilPCLoginPageElement:

Public Member Functions

 init ()
 
 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, ?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 getAllTypes ()
 Get all types. More...
 
static getLangVars ()
 
- 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...
 

Static Private Attributes

static array $types
 

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=[])
 
- 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
 

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 50 of file class.ilPCLoginPageElement.php.

References ilPageContent\createInitialChildNode().

54  : void {
55  $this->createInitialChildNode($a_hier_id, $a_pc_id, "LoginPageElement");
56  }
createInitialChildNode(string $hier_id, string $pc_id, string $child, array $child_attributes=[])
+ Here is the call graph for this function:

◆ getAlignment()

ilPCLoginPageElement::getAlignment ( )

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

References ilPageContent\getChildNode().

78  : string
79  {
80  if (is_object($this->getChildNode())) {
81  return $this->getChildNode()->getAttribute('HorizontalAlign');
82  }
83  return "";
84  }
+ Here is the call graph for this function:

◆ getAllTypes()

static ilPCLoginPageElement::getAllTypes ( )
static

Get all types.

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

Referenced by ilPCLoginPageElementGUI\edit().

40  : array
41  {
42  return self::$types;
43  }
+ Here is the caller graph for this function:

◆ getLangVars()

static ilPCLoginPageElement::getLangVars ( )
static

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

86  : array
87  {
88  return array("ed_insert_login_page_element");
89  }

◆ getLoginPageElementType()

ilPCLoginPageElement::getLoginPageElementType ( )

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

References ilPageContent\getChildNode().

65  : string
66  {
67  if (is_object($this->getChildNode())) {
68  return $this->getChildNode()->getAttribute('Type');
69  }
70  return "";
71  }
+ Here is the call graph for this function:

◆ init()

ilPCLoginPageElement::init ( )

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

References ilPageContent\setType().

45  : void
46  {
47  $this->setType('lpe');
48  }
setType(string $a_type)
Set Type.
+ Here is the call graph for this function:

◆ setAlignment()

ilPCLoginPageElement::setAlignment ( string  $a_alignment)

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

References ilPageContent\getChildNode().

73  : void
74  {
75  $this->getChildNode()->setAttribute('HorizontalAlign', $a_alignment);
76  }
+ Here is the call graph for this function:

◆ setLoginPageElementType()

ilPCLoginPageElement::setLoginPageElementType ( string  $a_type)

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

References ilPageContent\getChildNode().

58  : void
59  {
60  if (!empty($a_type)) {
61  $this->getChildNode()->setAttribute('Type', $a_type);
62  }
63  }
+ Here is the call graph for this function:

Field Documentation

◆ $types

array ilPCLoginPageElement::$types
staticprivate
Initial value:
= array(
'login-form' => 'login_form',
'shibboleth-login-form' => 'shib_login_form',
'openid-connect-login' => 'openid_connect_login',
'registration-link' => 'registration_link',
'user-agreement' => 'user_agreement_link',
'dpro-agreement' => 'dpro_agreement_link',
'saml-login' => 'saml_login'
)

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


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