ILIAS  trunk Revision v11.0_alpha-3011-gc6b235a2e85
ilCmiXapiLP Class Reference
+ Inheritance diagram for ilCmiXapiLP:
+ Collaboration diagram for ilCmiXapiLP:

Public Member Functions

 initModeOptions (ilRadioGroupInputGUI $modeRadio)
 
 fetchModeOption (ilPropertyFormGUI $form)
 
 getDefaultMode ()
 
 getValidModes ()
 
- Public Member Functions inherited from ilObjectLP
 resetCaches ()
 
 isAnonymized ()
 
 getDefaultMode ()
 
 getValidModes ()
 
 getCurrentMode ()
 
 isActive ()
 
 getModeText (int $mode)
 
 getModeInfoText (int $mode)
 
 getSettingsInfo ()
 
 getCollectionInstance ()
 
 getMembers (bool $search=true)
 
 resetLPDataForCompleteObject (bool $recursive=true)
 
 resetLPDataForUserIds (array $user_ids, bool $recursive=true)
 
 handleToTrash ()
 
 handleDelete ()
 
 getMailTemplateId ()
 
 hasIndividualModeOptions ()
 
 initInvidualModeOptions ()
 Post vars for input groups is taken from array keys. More...
 
 shouldFetchIndividualModeFromFormSubmission ()
 
 fetchIndividualModeFromFormSubmission (string $selected_group, array $group_data)
 
 appendModeConfiguration (int $mode)
 
 saveModeConfiguration (string $selected_group, array $group_data, bool &$modeChanged)
 

Data Fields

const MOVEON_COMPLETED = 'Completed'
 
const MOVEON_PASSED = 'Passed'
 
const MOVEON_COMPLETED_OR_PASSED = 'CompletedOrPassed'
 
const MOVEON_COMPLETED_AND_PASSED = 'CompletedAndPassed'
 
const MOVEON_NOT_APPLICABLE = 'NotApplicable'
 

Additional Inherited Members

- Static Public Member Functions inherited from ilObjectLP
static getInstance (int $obj_id)
 
static getTypeClass (string $type)
 
static getSupportedObjectTypes ()
 
static isSupportedObjectType (string $type)
 
static handleMove (int $source_ref_id)
 
static getLPMemberships (int $usr_id, array $obj_ids, ?int $parent_ref_id=null, bool $mapped_ref_ids=false)
 Get all objects where given user is member (from LP POV) More...
 
static supportsSpentSeconds (string $obj_type)
 
static supportsMark (string $obj_type)
 
static supportsMatrixView (string $obj_type)
 
static getDefaultModes (bool $lp_active)
 Get available type-specific default modes (no administration needed) More...
 
static saveTypeDefaults (array $data)
 
static getTypeDefault (string $type)
 
- Protected Member Functions inherited from ilObjectLP
 __construct (int $obj_id)
 
 resetCustomLPDataForUserIds (array $user_ids, bool $recursive=true)
 
 gatherLPUsers ()
 
 updateParentCollections ()
 
- Static Protected Member Functions inherited from ilObjectLP
static isLPMember (array &$res, int $usr_id, array $obj_ids)
 Find (lp-relevant) members for given object ids. More...
 
static findMembershipsByPath (array &$res, int $usr_id, int $parent_ref_id, array $obj_ids, bool $mapped_ref_ids=false)
 Find (lp-relevant) memberships by path. More...
 
static getTypeDefaultFromDB (string $type)
 
- Protected Attributes inherited from ilObjectLP
ilTree $tree
 
ilDBInterface $db
 
ilObjectDefinition $objectDefinition
 
int $obj_id
 
ilLPCollection $collection_instance = null
 
int $mode = null
 
- Static Protected Attributes inherited from ilObjectLP
static array $type_defaults = null
 

Detailed Description

Definition at line 30 of file class.ilCmiXapiLP.php.

Member Function Documentation

◆ fetchModeOption()

ilCmiXapiLP::fetchModeOption ( ilPropertyFormGUI  $form)

Definition at line 112 of file class.ilCmiXapiLP.php.

112 : int
113 {
114 $mainMode = (int) $form->getInput('modus');
115 $failedOpt = (int) $form->getInput('modus_' . $mainMode . '_failed');
116
117 if ($failedOpt) {
118 switch ($mainMode) {
121
124
127 }
128 }
129
130 return $mainMode;
131 }
const LP_MODE_CMIX_COMPL_OR_PASSED_WITH_FAILED
getInput(string $a_post_var, bool $ensureValidation=true)
Returns the input of an item, if item provides getInput method and as fallback the value of the HTTP-...

References ilPropertyFormGUI\getInput(), ILIAS\Repository\int(), ilLPObjSettings\LP_MODE_CMIX_COMPL_OR_PASSED_WITH_FAILED, ilLPObjSettings\LP_MODE_CMIX_COMPL_WITH_FAILED, ilLPObjSettings\LP_MODE_CMIX_COMPLETED, ilLPObjSettings\LP_MODE_CMIX_COMPLETED_OR_PASSED, ilLPObjSettings\LP_MODE_CMIX_PASSED, and ilLPObjSettings\LP_MODE_CMIX_PASSED_WITH_FAILED.

+ Here is the call graph for this function:

◆ getDefaultMode()

ilCmiXapiLP::getDefaultMode ( )

Reimplemented from ilObjectLP.

Definition at line 133 of file class.ilCmiXapiLP.php.

133 : int
134 {
136 }

References ilLPObjSettings\LP_MODE_DEACTIVATED.

◆ getValidModes()

◆ initModeOptions()

ilCmiXapiLP::initModeOptions ( ilRadioGroupInputGUI  $modeRadio)

Definition at line 38 of file class.ilCmiXapiLP.php.

38 : void
39 {
40 global $DIC; /* @var \ILIAS\DI\Container $DIC */
41 $modeCompleted = new ilRadioOption(
42 $DIC->language()->txt('cmix_lp_mode_deactivated'),
44 );
45 $modeCompleted->setInfo($DIC->language()->txt('cmix_lp_mode_deactivated_info'));
46 $modeRadio->addOption($modeCompleted);
47
48 $modeCompleted = new ilRadioOption(
49 $DIC->language()->txt('cmix_lp_mode_when_completed'),
51 );
52 $modeCompleted->setInfo($DIC->language()->txt('cmix_lp_mode_when_completed_info'));
53 $modeRadio->addOption($modeCompleted);
54 $modeCompletedFailed = new ilCheckboxInputGUI(
55 $DIC->language()->txt('cmix_lp_mode_with_failed'),
56 'modus_' . ilLPObjSettings::LP_MODE_CMIX_COMPLETED . '_failed'
57 );
58 $modeCompletedFailed->setInfo($DIC->language()->txt('cmix_lp_mode_with_failed_info'));
59 $modeCompleted->addSubItem($modeCompletedFailed);
60
61 $modePassed = new ilRadioOption(
62 $DIC->language()->txt('cmix_lp_mode_when_passed'),
64 );
65 $modePassed->setInfo($DIC->language()->txt('cmix_lp_mode_when_passed_info'));
66 $modeRadio->addOption($modePassed);
67 $modePassedFailed = new ilCheckboxInputGUI(
68 $DIC->language()->txt('cmix_lp_mode_with_failed'),
69 'modus_' . ilLPObjSettings::LP_MODE_CMIX_PASSED . '_failed'
70 );
71 $modePassedFailed->setInfo($DIC->language()->txt('cmix_lp_mode_with_failed_info'));
72 $modePassed->addSubItem($modePassedFailed);
73
74 $modePassedOrCompleted = new ilRadioOption(
75 $DIC->language()->txt('cmix_lp_mode_when_passed_or_completed'),
77 );
78 $modePassedOrCompleted->setInfo($DIC->language()->txt('cmix_lp_mode_when_passed_or_completed_info'));
79 $modeRadio->addOption($modePassedOrCompleted);
80 $modePassedOrCompletedFailed = new ilCheckboxInputGUI(
81 $DIC->language()->txt('cmix_lp_mode_with_failed'),
83 );
84 $modePassedOrCompletedFailed->setInfo($DIC->language()->txt('cmix_lp_mode_with_failed_info'));
85 $modePassedOrCompleted->addSubItem($modePassedOrCompletedFailed);
86
87 switch ($this->getCurrentMode()) {
90 break;
93 $modeCompletedFailed->setChecked(true);
94 break;
97 break;
100 $modePassedFailed->setChecked(true);
101 break;
104 break;
107 $modePassedOrCompletedFailed->setChecked(true);
108 break;
109 }
110 }
This class represents a checkbox property in a property form.
addOption(ilRadioOption $a_option)
This class represents an option in a radio group.
global $DIC
Definition: shib_login.php:26

References $DIC, ilRadioGroupInputGUI\addOption(), ilObjectLP\getCurrentMode(), ilLPObjSettings\LP_MODE_CMIX_COMPL_OR_PASSED_WITH_FAILED, ilLPObjSettings\LP_MODE_CMIX_COMPL_WITH_FAILED, ilLPObjSettings\LP_MODE_CMIX_COMPLETED, ilLPObjSettings\LP_MODE_CMIX_COMPLETED_OR_PASSED, ilLPObjSettings\LP_MODE_CMIX_PASSED, ilLPObjSettings\LP_MODE_CMIX_PASSED_WITH_FAILED, ilLPObjSettings\LP_MODE_DEACTIVATED, and ilRadioGroupInputGUI\setValue().

+ Here is the call graph for this function:

Field Documentation

◆ MOVEON_COMPLETED

const ilCmiXapiLP::MOVEON_COMPLETED = 'Completed'

◆ MOVEON_COMPLETED_AND_PASSED

const ilCmiXapiLP::MOVEON_COMPLETED_AND_PASSED = 'CompletedAndPassed'

◆ MOVEON_COMPLETED_OR_PASSED

const ilCmiXapiLP::MOVEON_COMPLETED_OR_PASSED = 'CompletedOrPassed'

◆ MOVEON_NOT_APPLICABLE

const ilCmiXapiLP::MOVEON_NOT_APPLICABLE = 'NotApplicable'

Definition at line 36 of file class.ilCmiXapiLP.php.

Referenced by ilObjCmiXapi\getLMSMoveOn().

◆ MOVEON_PASSED

const ilCmiXapiLP::MOVEON_PASSED = 'Passed'

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