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 ($a_mode)
	getModeInfoText ($a_mode)
	getSettingsInfo ()
	getCollectionInstance ()
	getMembers ($a_search=true)
	resetLPDataForCompleteObject ($a_recursive=true)
	resetLPDataForUserIds (array $a_user_ids, $a_recursive=true)
	handleToTrash ()
	handleDelete ()
	getMailTemplateId ()

Static Public Member Functions
static	getDefaultModes ($a_lp_active)
Static Public Member Functions inherited from ilObjectLP
static	getInstance ($a_obj_id)
static	getTypeClass ($a_type)
static	isSupportedObjectType ($a_type)
static	handleMove ($a_source_ref_id)
static	getLPMemberships ($a_usr_id, array $a_obj_ids, $a_parent_ref_id=null, $a_mapped_ref_ids=false)
	Get all objects where given user is member (from LP POV) More...
static	supportsSpentSeconds ($a_obj_type)
static	supportsMark ($a_obj_type)
static	supportsMatrixView ($a_obj_type)
static	getDefaultModes ($a_lp_active)
	Get available type-specific default modes (no administration needed) More...
static	saveTypeDefaults (array $a_data)
static	getTypeDefault ($a_type)
	Get current type default. More...

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
Protected Member Functions inherited from ilObjectLP
	__construct ($a_obj_id)
	resetCustomLPDataForUserIds (array $a_user_ids, $a_recursive=true)
	gatherLPUsers ()
	updateParentCollections ()
Static Protected Member Functions inherited from ilObjectLP
static	isLPMember (array &$a_res, $a_usr_id, $a_obj_ids)
	Find (lp-relevant) members for given object ids. More...
static	findMembershipsByPath (array &$a_res, $a_usr_id, $a_parent_ref_id, array $a_obj_ids, $a_mapped_ref_ids=false)
	Find (lp-relevant) memberships by path. More...
static	getTypeDefaultFromDB ($a_type)
Protected Attributes inherited from ilObjectLP
	$tree
	$db
	$obj_id
	$collection_instance
	$mode
Static Protected Attributes inherited from ilObjectLP
static	$type_defaults

Detailed Description

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

Member Function Documentation

fetchModeOption()

ilCmiXapiLP::fetchModeOption

(

ilPropertyFormGUI

$form

)

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

References ilPropertyFormGUI\getInput(), 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.

    {
        $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 131 of file class.ilCmiXapiLP.php.

References ilLPObjSettings\LP_MODE_DEACTIVATED.

    {
        return ilLPObjSettings::LP_MODE_DEACTIVATED;
    }

getDefaultModes()

static ilCmiXapiLP::getDefaultModes (   $a_lp_active )

static

Definition at line 118 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.

    {
        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
        );
    }

getValidModes()

ilCmiXapiLP::getValidModes

(

)

Definition at line 136 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.

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

    {
        global $DIC; /* @var \ILIAS\DI\Container $DIC */
        $modeCompleted = new ilRadioOption(
            $DIC->language()->txt('cmix_lp_mode_deactivated'),
            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'),
            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'),
            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'),
            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(ilLPObjSettings::LP_MODE_CMIX_COMPLETED);
                break;
            case ilLPObjSettings::LP_MODE_CMIX_COMPL_WITH_FAILED:
                $modeRadio->setValue(ilLPObjSettings::LP_MODE_CMIX_COMPLETED);
                $modeCompletedFailed->setChecked(true);
                break;
            case ilLPObjSettings::LP_MODE_CMIX_PASSED:
                $modeRadio->setValue(ilLPObjSettings::LP_MODE_CMIX_PASSED);
                break;
            case ilLPObjSettings::LP_MODE_CMIX_PASSED_WITH_FAILED:
                $modeRadio->setValue(ilLPObjSettings::LP_MODE_CMIX_PASSED);
                $modePassedFailed->setChecked(true);
                break;
            case ilLPObjSettings::LP_MODE_CMIX_COMPLETED_OR_PASSED:
                $modeRadio->setValue(ilLPObjSettings::LP_MODE_CMIX_COMPLETED_OR_PASSED);
                break;
            case ilLPObjSettings::LP_MODE_CMIX_COMPL_OR_PASSED_WITH_FAILED:
                $modeRadio->setValue(ilLPObjSettings::LP_MODE_CMIX_COMPLETED_OR_PASSED);
                $modePassedOrCompletedFailed->setChecked(true);
                break;
        }
    }

Here is the call graph for this function:

Field Documentation

MOVEON_COMPLETED

const ilCmiXapiLP::MOVEON_COMPLETED = 'Completed'

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

Referenced by ilObjCmiXapi\getLMSMoveOn(), and ilCmiXapiContentUploadImporter\initObjectFromCmi5Xml().

MOVEON_COMPLETED_AND_PASSED

const ilCmiXapiLP::MOVEON_COMPLETED_AND_PASSED = 'CompletedAndPassed'

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

Referenced by ilCmiXapiContentUploadImporter\initObjectFromCmi5Xml().

MOVEON_COMPLETED_OR_PASSED

const ilCmiXapiLP::MOVEON_COMPLETED_OR_PASSED = 'CompletedOrPassed'

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

Referenced by ilObjCmiXapi\getLMSMoveOn(), and ilCmiXapiContentUploadImporter\initObjectFromCmi5Xml().

MOVEON_NOT_APPLICABLE

const ilCmiXapiLP::MOVEON_NOT_APPLICABLE = 'NotApplicable'

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

Referenced by ilObjCmiXapi\getLMSMoveOn().

MOVEON_PASSED

const ilCmiXapiLP::MOVEON_PASSED = 'Passed'

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

Referenced by ilObjCmiXapi\getLMSMoveOn(), and ilCmiXapiContentUploadImporter\initObjectFromCmi5Xml().

---

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

• Modules/CmiXapi/classes/class.ilCmiXapiLP.php