ILIAS  release_8 Revision v8.24
ilPCVerification 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 ilPCVerification:
+ Collaboration diagram for ilPCVerification:

Public Member Functions

 init ()
 Init object. More...
 
 setNode (php4DOMElement $a_node)
 Set xml node of page content. More...
 
 create (ilPageObject $a_pg_obj, string $a_hier_id, string $a_pc_id="")
 
 setData (string $a_type, int $a_id)
 
 getData ()
 
- 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 getLangVars ()
 
static isInPortfolioPage (ilPortfolioPage $a_page, string $a_type, int $a_id)
 
- 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...
 

Protected Attributes

ilObjUser $user
 
- 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 = ""
 

Private Attributes

php4DOMElement $vrfc_node
 

Additional Inherited Members

- Data Fields inherited from ilPageContent
string $hier_id = ""
 
php4DOMElement $node = null
 
php4DOMDocument $dom = null
 
string $page_lang = ""
 
- Protected Member Functions inherited from ilPageContent
 setType (string $a_type)
 Set Type. More...
 

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 ilPCVerification Verification 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 26 of file class.ilPCVerification.php.

Member Function Documentation

◆ create()

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

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

49 : void {
50 $this->node = $this->createPageContentNode();
51 $a_pg_obj->insertContent($this, $a_hier_id, IL_INSERT_AFTER, $a_pc_id);
52 $this->vrfc_node = $this->dom->create_element('Verification');
53 $this->vrfc_node = $this->node->append_child($this->vrfc_node);
54 }
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

◆ getData()

ilPCVerification::getData ( )
Returns
null|array<string, string>

Definition at line 68 of file class.ilPCVerification.php.

68 : ?array
69 {
70 if (is_object($this->vrfc_node)) {
71 return [
72 'id' => $this->vrfc_node->get_attribute('Id'),
73 'type' => $this->vrfc_node->get_attribute('Type'),
74 'user' => $this->vrfc_node->get_attribute('User')
75 ];
76 }
77
78 return null;
79 }

◆ getLangVars()

static ilPCVerification::getLangVars ( )
static
Returns
string[]

Reimplemented from ilPageContent.

Definition at line 84 of file class.ilPCVerification.php.

84 : array
85 {
86 return [
87 'pc_vrfc',
88 'ed_insert_verification'
89 ];
90 }

◆ init()

ilPCVerification::init ( )

Init object.

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

Reimplemented from ilPageContent.

Definition at line 31 of file class.ilPCVerification.php.

31 : void
32 {
33 global $DIC;
34
35 $this->user = $DIC->user();
36 $this->setType('vrfc');
37 }
setType(string $a_type)
Set Type.
global $DIC
Definition: feed.php:28

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

+ Here is the call graph for this function:

◆ isInPortfolioPage()

static ilPCVerification::isInPortfolioPage ( ilPortfolioPage  $a_page,
string  $a_type,
int  $a_id 
)
static

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

96 : bool {
97 // try to find verification in portfolio page
98 $a_page->buildDom();
99
100 $dom = $a_page->getDom();
101 if ($dom instanceof php4DOMDocument) {
102 $dom = $dom->myDOMDocument;
103 }
104
105 $xpath_temp = new DOMXPath($dom);
106 $nodes = $xpath_temp->query('//PageContent/Verification');
107 foreach ($nodes as $node) {
108 if ($node->getAttribute('Type') === $a_type && (int) $node->getAttribute('Id') === $a_id) {
109 return true;
110 }
111 }
112
113 return false;
114 }
php4DOMElement $node
php4DOMDocument $dom
getDom()
@depracated
buildDom(bool $a_force=false)

Referenced by ilObjCmiXapiVerificationGUI\downloadFromPortfolioPage(), ilObjCourseVerificationGUI\downloadFromPortfolioPage(), ilObjExerciseVerificationGUI\downloadFromPortfolioPage(), ilObjLTIConsumerVerificationGUI\downloadFromPortfolioPage(), ilObjSCORMVerificationGUI\downloadFromPortfolioPage(), ilObjTestVerificationGUI\downloadFromPortfolioPage(), and ilObjPersistentCertificateVerificationGUI\downloadFromPortfolioPage().

+ Here is the caller graph for this function:

◆ setData()

ilPCVerification::setData ( string  $a_type,
int  $a_id 
)

Definition at line 56 of file class.ilPCVerification.php.

59 : void {
60 $this->vrfc_node->set_attribute('Type', $a_type);
61 $this->vrfc_node->set_attribute('Id', $a_id);
62 $this->vrfc_node->set_attribute('User', $this->user->getId());
63 }

◆ setNode()

ilPCVerification::setNode ( php4DOMElement  $a_node)

Set xml node of page content.

Parameters
php4DOMElement$a_nodenode object

Reimplemented from ilPageContent.

Definition at line 39 of file class.ilPCVerification.php.

39 : void
40 {
41 parent::setNode($a_node); // this is the PageContent node
42 $this->vrfc_node = $a_node->first_child(); // this is the verification node
43 }

References php4DOMNode\first_child().

+ Here is the call graph for this function:

Field Documentation

◆ $user

ilObjUser ilPCVerification::$user
protected

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

◆ $vrfc_node

php4DOMElement ilPCVerification::$vrfc_node
private

Definition at line 28 of file class.ilPCVerification.php.


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