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 (ilRadioGroupInputGUI $modeRadio)

	shouldFetchIndividualModeFromFormSubmission ()

	fetchIndividualModeFromFormSubmission (ilPropertyFormGUI $form)

	appendModeConfiguration (int $mode, ilRadioOption $modeElement)

	saveModeConfiguration (ilPropertyFormGUI $form, 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.

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.

                                                             : int
     {
         $mainMode = (int) $form->getInput('modus');
         $failedOpt = (int) $form->getInput('modus_' . $mainMode . '_failed');
 
         if ($failedOpt) {
             switch ($mainMode) {
                 case ilLPObjSettings::LP_MODE_CMIX_COMPLETED:
                     return ilLPObjSettings::LP_MODE_CMIX_COMPL_WITH_FAILED;
 
                 case ilLPObjSettings::LP_MODE_CMIX_PASSED:
                     return ilLPObjSettings::LP_MODE_CMIX_PASSED_WITH_FAILED;
 
                 case ilLPObjSettings::LP_MODE_CMIX_COMPLETED_OR_PASSED:
                     return ilLPObjSettings::LP_MODE_CMIX_COMPL_OR_PASSED_WITH_FAILED;
             }
         }
 
         return $mainMode;
     }

Here is the call graph for this function:

◆ getDefaultMode()

ilCmiXapiLP::getDefaultMode ( )

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

References ilLPObjSettings\LP_MODE_DEACTIVATED.

                                     : int
     {
         return ilLPObjSettings::LP_MODE_DEACTIVATED;
     }

◆ getValidModes()

ilCmiXapiLP::getValidModes ( )

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

References 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, and ilLPObjSettings\LP_MODE_DEACTIVATED.

                                    : array
     {
         return array(
             ilLPObjSettings::LP_MODE_DEACTIVATED,
             ilLPObjSettings::LP_MODE_CMIX_COMPLETED,
             ilLPObjSettings::LP_MODE_CMIX_COMPL_WITH_FAILED,
             ilLPObjSettings::LP_MODE_CMIX_PASSED,
             ilLPObjSettings::LP_MODE_CMIX_PASSED_WITH_FAILED,
             ilLPObjSettings::LP_MODE_CMIX_COMPLETED_OR_PASSED,
             ilLPObjSettings::LP_MODE_CMIX_COMPL_OR_PASSED_WITH_FAILED
         );
     }

◆ initModeOptions()

ilCmiXapiLP::initModeOptions ( ilRadioGroupInputGUI $modeRadio )

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

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, ilFormPropertyGUI\setInfo(), and ilRadioGroupInputGUI\setValue().

                                                                     : void
     {
         global $DIC; /* @var \ILIAS\DI\Container $DIC */
         $modeCompleted = new ilRadioOption(
             $DIC->language()->txt('cmix_lp_mode_deactivated'),
             (string) ilLPObjSettings::LP_MODE_DEACTIVATED
         );
         $modeCompleted->setInfo($DIC->language()->txt('cmix_lp_mode_deactivated_info'));
         $modeRadio->addOption($modeCompleted);
 
         $modeCompleted = new ilRadioOption(
             $DIC->language()->txt('cmix_lp_mode_when_completed'),
             (string) ilLPObjSettings::LP_MODE_CMIX_COMPLETED
         );
         $modeCompleted->setInfo($DIC->language()->txt('cmix_lp_mode_when_completed_info'));
         $modeRadio->addOption($modeCompleted);
         $modeCompletedFailed = new ilCheckboxInputGUI(
             $DIC->language()->txt('cmix_lp_mode_with_failed'),
             'modus_' . ilLPObjSettings::LP_MODE_CMIX_COMPLETED . '_failed'
         );
         $modeCompletedFailed->setInfo($DIC->language()->txt('cmix_lp_mode_with_failed_info'));
         $modeCompleted->addSubItem($modeCompletedFailed);
 
         $modePassed = new ilRadioOption(
             $DIC->language()->txt('cmix_lp_mode_when_passed'),
             (string) ilLPObjSettings::LP_MODE_CMIX_PASSED
         );
         $modePassed->setInfo($DIC->language()->txt('cmix_lp_mode_when_passed_info'));
         $modeRadio->addOption($modePassed);
         $modePassedFailed = new ilCheckboxInputGUI(
             $DIC->language()->txt('cmix_lp_mode_with_failed'),
             'modus_' . ilLPObjSettings::LP_MODE_CMIX_PASSED . '_failed'
         );
         $modePassedFailed->setInfo($DIC->language()->txt('cmix_lp_mode_with_failed_info'));
         $modePassed->addSubItem($modePassedFailed);
 
         $modePassedOrCompleted = new ilRadioOption(
             $DIC->language()->txt('cmix_lp_mode_when_passed_or_completed'),
             (string) ilLPObjSettings::LP_MODE_CMIX_COMPLETED_OR_PASSED
         );
         $modePassedOrCompleted->setInfo($DIC->language()->txt('cmix_lp_mode_when_passed_or_completed_info'));
         $modeRadio->addOption($modePassedOrCompleted);
         $modePassedOrCompletedFailed = new ilCheckboxInputGUI(
             $DIC->language()->txt('cmix_lp_mode_with_failed'),
             'modus_' . ilLPObjSettings::LP_MODE_CMIX_COMPLETED_OR_PASSED . '_failed'
         );
         $modePassedOrCompletedFailed->setInfo($DIC->language()->txt('cmix_lp_mode_with_failed_info'));
         $modePassedOrCompleted->addSubItem($modePassedOrCompletedFailed);
 
         switch ($this->getCurrentMode()) {
             case ilLPObjSettings::LP_MODE_CMIX_COMPLETED:
                 $modeRadio->setValue((string) ilLPObjSettings::LP_MODE_CMIX_COMPLETED);
                 break;
             case ilLPObjSettings::LP_MODE_CMIX_COMPL_WITH_FAILED:
                 $modeRadio->setValue((string) ilLPObjSettings::LP_MODE_CMIX_COMPLETED);
                 $modeCompletedFailed->setChecked(true);
                 break;
             case ilLPObjSettings::LP_MODE_CMIX_PASSED:
                 $modeRadio->setValue((string) ilLPObjSettings::LP_MODE_CMIX_PASSED);
                 break;
             case ilLPObjSettings::LP_MODE_CMIX_PASSED_WITH_FAILED:
                 $modeRadio->setValue((string) ilLPObjSettings::LP_MODE_CMIX_PASSED);
                 $modePassedFailed->setChecked(true);
                 break;
             case ilLPObjSettings::LP_MODE_CMIX_COMPLETED_OR_PASSED:
                 $modeRadio->setValue((string) ilLPObjSettings::LP_MODE_CMIX_COMPLETED_OR_PASSED);
                 break;
             case ilLPObjSettings::LP_MODE_CMIX_COMPL_OR_PASSED_WITH_FAILED:
                 $modeRadio->setValue((string) ilLPObjSettings::LP_MODE_CMIX_COMPLETED_OR_PASSED);
                 $modePassedOrCompletedFailed->setChecked(true);
                 break;
         }
     }