ILIAS  trunk Revision v11.0_alpha-3011-gc6b235a2e85
ilPCConsultationHours 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 ilPCConsultationHours:
+ Collaboration diagram for ilPCConsultationHours:

Public Member Functions

 init ()
 Init object. More...
 
 create (ilPageObject $a_pg_obj, string $a_hier_id, string $a_pc_id="")
 
 setData (string $a_mode, array $a_grp_ids)
 Set consultation hours settings. More...
 
 getGroupIds ()
 Get consultation hours group ids. 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 ilPCConsultationHours Consultation hours 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.ilPCConsultationHours.php.

Member Function Documentation

◆ create()

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

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

44 : void {
45 $this->createPageContentNode();
46 $a_pg_obj->insertContent($this, $a_hier_id, IL_INSERT_AFTER, $a_pc_id);
47 $cach_node = $this->dom_doc->createElement("ConsultationHours");
48 $cach_node = $this->getDomNode()->appendChild($cach_node);
49 }
const IL_INSERT_AFTER
createPageContentNode(bool $a_set_this_node=true)
Create page content node (always use this method first when adding a new element)
insertContent(ilPageContent $a_cont_obj, string $a_pos, int $a_mode=IL_INSERT_AFTER, string $a_pcid="", bool $remove_placeholder=true)
insert a content node before/after a sibling or as first child of a parent

◆ getGroupIds()

ilPCConsultationHours::getGroupIds ( )

Get consultation hours group ids.

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

78 : array
79 {
80 $res = array();
81 if (is_object($this->getChildNode())) {
82 foreach ($this->getChildNode()->childNodes as $child) {
83 $res[] = $child->getAttribute("Id");
84 }
85 }
86 return $res;
87 }
$res
Definition: ltiservices.php:69

References $res.

◆ getLangVars()

static ilPCConsultationHours::getLangVars ( )
static

Get lang vars needed for editing.

Returns
string[] array of lang var keys

Reimplemented from ilPageContent.

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

35 : array
36 {
37 return array("ed_insert_consultation_hours", "pc_cach");
38 }

◆ init()

ilPCConsultationHours::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.ilPCConsultationHours.php.

28 : void
29 {
30 global $DIC;
31 $this->user = $DIC->user();
32 $this->setType("cach");
33 }
setType(string $a_type)
Set Type.
global $DIC
Definition: shib_login.php:26

References $DIC, ilPageContent\setType(), and ILIAS\Repository\user().

+ Here is the call graph for this function:

◆ setData()

ilPCConsultationHours::setData ( string  $a_mode,
array  $a_grp_ids 
)

Set consultation hours settings.

Definition at line 54 of file class.ilPCConsultationHours.php.

57 : void {
58 $ilUser = $this->user;
59
60 $this->getChildNode()->setAttribute("Mode", $a_mode);
61 $this->getChildNode()->setAttribute("User", $ilUser->getId());
62
63 // remove all children first
64 $this->dom_util->deleteAllChilds($this->getChildNode());
65
66 if ($a_mode === "manual") {
67 foreach ($a_grp_ids as $grp_id) {
68 $field_node = $this->dom_doc->createElement("ConsultationHoursGroup");
69 $field_node = $this->getChildNode()->appendChild($field_node);
70 $field_node->setAttribute("Id", $grp_id);
71 }
72 }
73 }

Field Documentation

◆ $user

ilObjUser ilPCConsultationHours::$user
protected

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


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