Class ilObjLearningSequence. More...

Inheritance diagram for ilObjLearningSequence:

Collaboration diagram for ilObjLearningSequence:

Public Member Functions

__construct (int $id=0, bool $call_by_reference=true)

read ()

Detailed Description

Class ilObjLearningSequence.

Definition at line 9 of file class.ilObjLearningSequence.php.

Constructor & Destructor Documentation

◆ __construct()

ilObjLearningSequence::__construct	(	int	$id = `0`,
		bool	$call_by_reference = `true`
	)

Definition at line 77 of file class.ilObjLearningSequence.php.

    {
        global $DIC;
 
        $this->type = self::OBJ_TYPE;
        $this->lng = $DIC['lng'];
        $this->ctrl = $DIC['ilCtrl'];
        $this->user = $DIC['ilUser'];
        $this->tree = $DIC['tree'];
        $this->kiosk_mode_service = $DIC['service.kiosk_mode'];
        $this->template = $DIC['tpl'];
        $this->database = $DIC['ilDB'];
        $this->log = $DIC["ilLoggerFactory"]->getRootLogger();
        $this->rbacadmin = $DIC['rbacadmin'];
        $this->rbacreview = $DIC['rbacreview'];
        $this->app_event_handler = $DIC['ilAppEventHandler'];
        $this->filesystem = $DIC['filesystem'];
        $this->ilias = $DIC['ilias'];
        $this->il_settings = $DIC['ilSetting'];
        $this->il_news = $DIC->news();
        $this->il_condition_handler = new ilConditionHandler();
 
        $this->data_factory = new \ILIAS\Data\Factory();
 
        parent::__construct($id, $call_by_reference);
    }

References $DIC, ilObject\$id, OBJ_TYPE, and user().

Here is the call graph for this function:

Member Function Documentation

◆ _goto()

static ilObjLearningSequence::_goto	(	$target,
		$add = `""`
	)

static

Goto target learning sequence.

Parameters

int	$target
string	$add

Definition at line 583 of file class.ilObjLearningSequence.php.

    {
        global $DIC;
 
        $ilAccess = $DIC['ilAccess'];
        $ilErr = $DIC['ilErr'];
        $lng = $DIC['lng'];
        $ilUser = $DIC['ilUser'];
 
        if (substr($add, 0, 5) == 'rcode') {
            if ($ilUser->getId() == ANONYMOUS_USER_ID) {
                // Redirect to login for anonymous
                ilUtil::redirect(
                    "login.php?target=" . $_GET["target"] . "&cmd=force_login&lang=" .
                    $ilUser->getCurrentLanguage()
                );
            }
 
            // Redirects to target location after assigning user to learning sequence
            ilMembershipRegistrationCodeUtils::handleCode(
                $target,
                ilObject::_lookupType(ilObject::_lookupObjId($target)),
                substr($add, 5)
            );
        }
 
        if ($add == "mem" && $ilAccess->checkAccess("manage_members", "", $target)) {
            ilObjectGUI::_gotoRepositoryNode($target, "members");
        }
 
        if ($ilAccess->checkAccess("read", "", $target)) {
            ilObjectGUI::_gotoRepositoryNode($target);
        } else {
            // to do: force flat view
            if ($ilAccess->checkAccess("visible", "", $target)) {
                ilObjectGUI::_gotoRepositoryNode($target, "infoScreenGoto");
            } else {
                if ($ilAccess->checkAccess("read", "", ROOT_FOLDER_ID)) {
                    ilUtil::sendFailure(
                        sprintf(
                            $lng->txt("msg_no_perm_read_item"),
                            ilObject::_lookupTitle(ilObject::_lookupObjId($target))
                        ),
                        true
                    );
                    ilObjectGUI::_gotoRepositoryRoot();
                }
            }
        }
 
        $ilErr->raiseError($lng->txt("msg_no_perm_read"), $ilErr->FATAL);
    }

References $_GET, $DIC, $ilErr, $ilUser, ilObject\$lng, $target, ilObjectGUI\_gotoRepositoryNode(), ilObjectGUI\_gotoRepositoryRoot(), ilObject\_lookupObjId(), ilObject\_lookupTitle(), ilObject\_lookupType(), ilMembershipRegistrationCodeUtils\handleCode(), ilUtil\redirect(), and ilUtil\sendFailure().

Here is the call graph for this function:

◆ addMember()

ilObjLearningSequence::addMember	(	$user_id,
		$mem_role
	)

Definition at line 712 of file class.ilObjLearningSequence.php.

                                                   : bool
    {
        return $this->getLSRoles()->addLSMember($user_id, $mem_role);
    }

References getLSRoles().

Here is the call graph for this function:

◆ announceLSOOffline()

ilObjLearningSequence::announceLSOOffline ( )

Definition at line 681 of file class.ilObjLearningSequence.php.

    {
        //NYI
    }

◆ announceLSOOnline()

ilObjLearningSequence::announceLSOOnline ( )

Definition at line 670 of file class.ilObjLearningSequence.php.

    {
        $ns = $this->il_news;
        $context = $ns->contextForRefId((int) $this->getRefId());
        $item = $ns->item($context);
        $item->setContentIsLangVar(true);
        $item->setContentTextIsLangVar(true);
        $item->setTitle("lso_news_online_title");
        $item->setContent("lso_news_online_txt");
        $news_id = $ns->data()->save($item);
    }

References $context, and ilObject\getRefId().

Here is the call graph for this function:

◆ cloneAutoGeneratedRoles()

ilObjLearningSequence::cloneAutoGeneratedRoles ( ilObjLearningSequence $new_obj )

protected

Definition at line 182 of file class.ilObjLearningSequence.php.

                                                                               : bool
    {
        $admin = $this->getDefaultAdminRole();
        $new_admin = $new_obj->getDefaultAdminRole();
 
        if (!$admin || !$new_admin || !$this->getRefId() || !$new_obj->getRefId()) {
            $this->log->write(__METHOD__ . ' : Error cloning auto generated role: il_lso_admin');
        }
 
        $this->rbacadmin->copyRolePermissions($admin, $this->getRefId(), $new_obj->getRefId(), $new_admin, true);
        $this->log->write(__METHOD__ . ' : Finished copying of role lso_admin.');
 
        $member = $this->getDefaultMemberRole();
        $new_member = $new_obj->getDefaultMemberRole();
 
        if (!$member || !$new_member) {
            $this->log->write(__METHOD__ . ' : Error cloning auto generated role: il_lso_member');
        }
 
        $this->rbacadmin->copyRolePermissions($member, $this->getRefId(), $new_obj->getRefId(), $new_member, true);
        $this->log->write(__METHOD__ . ' : Finished copying of role lso_member.');
 
        return true;
    }

References getDefaultAdminRole(), getDefaultMemberRole(), and ilObject\getRefId().

Referenced by cloneObject().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ cloneLPSettings()

ilObjLearningSequence::cloneLPSettings ( int $obj_id )

protected

Definition at line 230 of file class.ilObjLearningSequence.php.

    {
        $lp_settings = new ilLPObjSettings($this->getId());
        $lp_settings->cloneSettings($obj_id);
    }

References ilObject\getId().

Referenced by cloneObject().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ cloneObject()

ilObjLearningSequence::cloneObject	(	$target_id,
		$copy_id = `0`,
		$omit_tree = `false`
	)

Definition at line 167 of file class.ilObjLearningSequence.php.

    {
        $new_obj = parent::cloneObject($target_id, $copy_id, $omit_tree);
 
        $this->cloneAutoGeneratedRoles($new_obj);
        $this->cloneMetaData($new_obj);
        $this->cloneSettings($new_obj);
        $this->cloneLPSettings((int) $new_obj->getId());
 
        $new_obj->addMember((int) $this->user->getId(), $new_obj->getDefaultAdminRole());
 
        return $new_obj;
    }

References $target_id, cloneAutoGeneratedRoles(), cloneLPSettings(), ilObject\cloneMetaData(), cloneSettings(), and user().

Here is the call graph for this function:

◆ cloneSettings()

ilObjLearningSequence::cloneSettings ( ilObjLearningSequence $new_obj )

protected

Definition at line 207 of file class.ilObjLearningSequence.php.

    {
        $source = $this->getLSSettings();
        $target = $new_obj->getLSSettings();
 
        foreach ($source->getUploads() as $key => $upload_info) {
            $target = $target->withUpload($upload_info, $key);
        }
 
        foreach ($source->getDeletions() as $deletion) {
            $target = $target->withDeletion($deletion);
        }
 
        $target = $target
            ->withAbstract($source->getAbstract())
            ->withExtro($source->getExtro())
            ->withAbstractImage($source->getAbstractImage())
            ->withExtroImage($source->getExtroImage())
        ;
 
        $new_obj->updateSettings($target);
    }

References $key, $source, $target, getLSSettings(), and updateSettings().

Referenced by cloneObject().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ create()

ilObjLearningSequence::create ( )

Create.

Reimplemented from ilContainer.

Definition at line 118 of file class.ilObjLearningSequence.php.

                             : int
    {
        $id = parent::create();
        if (!$id) {
            return 0;
        }
        $this->raiseEvent(self::E_CREATE);
 
        return (int) $this->getId();
    }

References ilObject\$id, ilObject\getId(), and raiseEvent().

Here is the call graph for this function:

◆ delete()

ilObjLearningSequence::delete ( )

delete category and all related data

Returns: boolean true if all object data were removed; false if only a references were removed

Reimplemented from ilContainer.

Definition at line 139 of file class.ilObjLearningSequence.php.

                             : bool
    {
        if (!parent::delete()) {
            return false;
        }
 
        ilLearningSequenceParticipants::_deleteAllEntries($this->getId());
        $this->getSettingsDB()->delete((int) $this->getId());
        $this->getStateDB()->deleteFor((int) $this->getRefId());
        $this->getActivationDB()->deleteForRefId((int) $this->getRefId());
 
        $this->raiseEvent(self::E_DELETE);
 
        return true;
    }

References ilParticipants\_deleteAllEntries(), getActivationDB(), ilObject\getId(), ilObject\getRefId(), getSettingsDB(), getStateDB(), and raiseEvent().

Here is the call graph for this function:

◆ deletePostConditionsForSubObjects()

ilObjLearningSequence::deletePostConditionsForSubObjects ( array $ref_ids )

Delete post conditions for ref ids.

Parameters

int[]

Definition at line 375 of file class.ilObjLearningSequence.php.

    {
        $rep_utils = new ilRepUtil();
        $rep_utils->deleteObjects($this->getRefId(), $ref_ids);
        $db = $this->getPostConditionDB();
        $db->delete($ref_ids);
    }

References ilContainer\$db, getPostConditionDB(), and ilObject\getRefId().

Here is the call graph for this function:

◆ getActivationDB()

ilObjLearningSequence::getActivationDB ( )

protected

Definition at line 248 of file class.ilObjLearningSequence.php.

                                         : ilLearningSequenceActivationDB
    {
        if (!$this->activation_db) {
            $this->activation_db = new ilLearningSequenceActivationDB(
                $this->database
            );
        }
        return $this->activation_db;
    }

References $activation_db.

Referenced by delete(), getLSActivation(), setEffectiveOnlineStatus(), and updateActivation().

Here is the caller graph for this function:

◆ getCurrentItemForLearner()

ilObjLearningSequence::getCurrentItemForLearner ( int $usr_id )

Get ref-id of the last item the user touched.

Definition at line 448 of file class.ilObjLearningSequence.php.

                                                          : int
    {
        $db = $this->getStateDB();
        $current = $db->getCurrentItemsFor($this->getRefId(), [$usr_id]);
        $ref_id = $current[$usr_id];
 
        if ($ref_id < 0) {
            $ref_id = 0;
        }
 
        return $ref_id;
    }

References $current, ilContainer\$db, ilObject\$ref_id, ilObject\getRefId(), and getStateDB().

Here is the call graph for this function:

◆ getCurriculumBuilder()

ilObjLearningSequence::getCurriculumBuilder	(	array	$items,
		LSUrlBuilder	$url_builder = `null`
	)

Parameters

LSLearnerItem[] $items

Definition at line 464 of file class.ilObjLearningSequence.php.

                                                                                         : ilLSCurriculumBuilder
    {
        global $DIC;
 
        return new ilLSCurriculumBuilder(
            $items,
            $DIC["ui.factory"],
            $this->lng,
            ilLSPlayer::LSO_CMD_GOTO,
            $url_builder
        );
    }

References $DIC, and ilLSPlayer\LSO_CMD_GOTO.

Referenced by getSequencePlayer().

Here is the caller graph for this function:

◆ getDefaultAdminRole()

ilObjLearningSequence::getDefaultAdminRole ( )

Definition at line 707 of file class.ilObjLearningSequence.php.

    {
        return $this->getLSRoles()->getDefaultAdminRole();
    }

References getLSRoles().

Referenced by cloneAutoGeneratedRoles().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getDefaultLearningSequenceRoles()

ilObjLearningSequence::getDefaultLearningSequenceRoles ( $a_grp_id = "" )

Definition at line 748 of file class.ilObjLearningSequence.php.

    {
        return $this->getLSRoles()->getDefaultLearningSequenceRoles($a_grp_id);
    }

References getLSRoles().

Here is the call graph for this function:

◆ getDefaultMemberRole()

ilObjLearningSequence::getDefaultMemberRole ( )

Definition at line 702 of file class.ilObjLearningSequence.php.

                                           : int
    {
        return $this->getLSRoles()->getDefaultMemberRole();
    }

References getLSRoles().

Referenced by cloneAutoGeneratedRoles(), and join().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getGlobalSettings()

ilObjLearningSequence::getGlobalSettings ( )

protected

Definition at line 483 of file class.ilObjLearningSequence.php.

                                           : LSGlobalSettings
    {
        $db = new ilLSGlobalSettingsDB($this->il_settings);
        return $db->getSettings();
    }

References ilContainer\$db.

Referenced by getSequencePlayer().

Here is the caller graph for this function:

◆ getInstanceByRefId()

static ilObjLearningSequence::getInstanceByRefId ( int $ref_id )

static

Definition at line 104 of file class.ilObjLearningSequence.php.

    {
        return ilObjectFactory::getInstanceByRefId($ref_id, false);
    }

References ilObject\$ref_id, and ilObjectFactory\getInstanceByRefId().

Referenced by ilObjLearningSequenceGUI\getObject().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getKioskRenderer()

ilObjLearningSequence::getKioskRenderer ( LSUrlBuilder $url_builder )

protected

Definition at line 540 of file class.ilObjLearningSequence.php.

    {
        if (!$this->kiosk_renderer) {
            global $DIC;
 
            $kiosk_template = new ilTemplate("tpl.kioskpage.html", true, true, 'Modules/LearningSequence');
 
            $toc_gui = new ilLSTOCGUI($url_builder, $this->ctrl);
            $loc_gui = new ilLSLocatorGUI($url_builder, $DIC["ui.factory"]);
 
            $window_title = $this->il_settings->get('short_inst_name');
            if ($window_title === false) {
                $window_title = 'ILIAS';
            }
 
            $this->kiosk_renderer = new ilKioskPageRenderer(
                $this->template,
                $DIC["ui.renderer"],
                $kiosk_template,
                $toc_gui,
                $loc_gui,
                $window_title
            );
        }
 
        return $this->kiosk_renderer;
    }

References $DIC.

Referenced by getSequencePlayer().

Here is the caller graph for this function:

◆ getLearnerProgressDB()

ilObjLearningSequence::getLearnerProgressDB ( )

protected

Definition at line 398 of file class.ilObjLearningSequence.php.

                                              : ilLearnerProgressDB
    {
        if (!$this->learner_progress_db) {
            $state_db = $this->getStateDB();
            $this->learner_progress_db = new ilLearnerProgressDB(
                $state_db,
                $this->access
            );
        }
 
        return $this->learner_progress_db;
    }

References $learner_progress_db, $state_db, and getStateDB().

Referenced by getLSLearnerItems().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getLearningSequenceAdminIds()

ilObjLearningSequence::getLearningSequenceAdminIds ( $a_grpId = "" )

Definition at line 743 of file class.ilObjLearningSequence.php.

    {
        return $this->getLSRoles()->getLearningSequenceAdminIds();
    }

References getLSRoles().

Here is the call graph for this function:

◆ getLearningSequenceMemberData()

ilObjLearningSequence::getLearningSequenceMemberData	(	$a_mem_ids,
		$active = `1`
	)

Definition at line 738 of file class.ilObjLearningSequence.php.

    {
        return $this->getLSRoles()->getLearningSequenceMemberData($a_mem_ids, $active);
    }

References getLSRoles().

Here is the call graph for this function:

◆ getLearningSequenceMemberIds()

ilObjLearningSequence::getLearningSequenceMemberIds ( )

Definition at line 728 of file class.ilObjLearningSequence.php.

    {
        return $this->getLSRoles()->getLearningSequenceMemberIds();
    }

References getLSRoles().

Here is the call graph for this function:

◆ getLocalLearningSequenceRoles()

ilObjLearningSequence::getLocalLearningSequenceRoles ( bool $translate = false )

Definition at line 697 of file class.ilObjLearningSequence.php.

                                                                           : array
    {
        return $this->getLSRoles()->getLocalLearningSequenceRoles($translate);
    }

References getLSRoles().

Here is the call graph for this function:

◆ getLPCompletionStates()

ilObjLearningSequence::getLPCompletionStates ( )

Definition at line 773 of file class.ilObjLearningSequence.php.

                                            : array
    {
        return [
            \ilLPStatus::LP_STATUS_COMPLETED_NUM
        ];
    }

References ilLPStatus\LP_STATUS_COMPLETED_NUM.

◆ getLSAccess()

ilObjLearningSequence::getLSAccess ( )

Definition at line 343 of file class.ilObjLearningSequence.php.

                                  : ilObjLearningSequenceAccess
    {
        if (is_null($this->ls_access)) {
            $this->ls_access = new ilObjLearningSequenceAccess();
        }
 
        return $this->ls_access;
    }

◆ getLSActivation()

ilObjLearningSequence::getLSActivation ( )

Definition at line 258 of file class.ilObjLearningSequence.php.

                                      : ilLearningSequenceActivation
    {
        if (!$this->ls_activation) {
            $this->ls_activation = $this->getActivationDB()->getActivationForRefId((int) $this->getRefId());
        }
 
        return $this->ls_activation;
    }

References $ls_activation, getActivationDB(), and ilObject\getRefId().

Referenced by ilObjLearningSequenceSettingsGUI\__construct(), and read().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getLSFileSystem()

ilObjLearningSequence::getLSFileSystem ( )

Definition at line 273 of file class.ilObjLearningSequence.php.

    {
        if (!$this->ls_file_system) {
            $this->ls_file_system = new ilLearningSequenceFilesystem();
        }
        return $this->ls_file_system;
    }

References $ls_file_system.

Referenced by getSettingsDB().

Here is the caller graph for this function:

◆ getLSItemOnlineStatus()

ilObjLearningSequence::getLSItemOnlineStatus ( )

protected

Definition at line 319 of file class.ilObjLearningSequence.php.

                                               : LSItemOnlineStatus
    {
        if (!$this->ls_item_online_status) {
            $this->ls_item_online_status = new LSItemOnlineStatus();
        }
 
        return $this->ls_item_online_status;
    }

References $ls_item_online_status.

Referenced by getLSItemsDB().

Here is the caller graph for this function:

◆ getLSItems()

ilObjLearningSequence::getLSItems ( )

Get a list of LSItems.

Definition at line 355 of file class.ilObjLearningSequence.php.

                                 : array
    {
        $db = $this->getLSItemsDB();
        return $db->getLSItems((int) $this->getRefId());
    }

References ilContainer\$db, getLSItemsDB(), and ilObject\getRefId().

Referenced by getLSLearnerItems().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getLSItemsDB()

ilObjLearningSequence::getLSItemsDB ( )

protected

Definition at line 296 of file class.ilObjLearningSequence.php.

                                      : ilLSItemsDB
    {
        if (!$this->items_db) {
            $this->items_db = new ilLSItemsDB(
                $this->tree,
                ilContainerSorting::_getInstance($this->getId()),
                $this->getPostConditionDB(),
                $this->getLSItemOnlineStatus()
            );
        }
 
        return $this->items_db;
    }

References $items_db, ilContainerSorting\_getInstance(), ilObject\getId(), getLSItemOnlineStatus(), and getPostConditionDB().

Referenced by getLSItems(), and storeLSItems().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getLSLearnerItems()

ilObjLearningSequence::getLSLearnerItems ( int $usr_id )

Get a list of LSLearnerItems.

Definition at line 423 of file class.ilObjLearningSequence.php.

                                                   : array
    {
        $db = $this->getLearnerProgressDB();
        return $db->getLearnerItems($usr_id, $this->getRefId(), $this->getLSItems());
    }

References ilContainer\$db, getLearnerProgressDB(), getLSItems(), and ilObject\getRefId().

Referenced by getSequencePlayer().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getLSParticipants()

ilObjLearningSequence::getLSParticipants ( )

Definition at line 328 of file class.ilObjLearningSequence.php.

                                        : ilLearningSequenceParticipants
    {
        if (!$this->ls_participant) {
            $this->ls_participant = new ilLearningSequenceParticipants(
                (int) $this->getId(),
                $this->log,
                $this->app_event_handler,
                $this->il_settings
            );
        }
 
        return $this->ls_participant;
    }

References $ls_participant, and ilObject\getId().

Referenced by ilLearningSequenceParticipantsTableGUI\__construct(), getLSRoles(), getMembersObject(), and isMember().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getLSRoles()

ilObjLearningSequence::getLSRoles ( )

Definition at line 429 of file class.ilObjLearningSequence.php.

                                 : ilLearningSequenceRoles
    {
        if (!$this->ls_roles) {
            $this->ls_roles = new ilLearningSequenceRoles(
                $this,
                $this->getLSParticipants(),
                $this->ctrl,
                $this->rbacadmin,
                $this->rbacreview,
                $this->database,
                $this->user
            );
        }
        return $this->ls_roles;
    }

References $ls_roles, getLSParticipants(), and user().

Referenced by addMember(), getDefaultAdminRole(), getDefaultLearningSequenceRoles(), getDefaultMemberRole(), getLearningSequenceAdminIds(), getLearningSequenceMemberData(), getLearningSequenceMemberIds(), getLocalLearningSequenceRoles(), initDefaultRoles(), join(), leave(), and leaveLearningSequence().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getLSSettings()

ilObjLearningSequence::getLSSettings ( )

Definition at line 281 of file class.ilObjLearningSequence.php.

                                    : ilLearningSequenceSettings
    {
        if (!$this->ls_settings) {
            $this->ls_settings = $this->getSettingsDB()->getSettingsFor((int) $this->getId());
        }
 
        return $this->ls_settings;
    }

References $ls_settings, ilObject\getId(), and getSettingsDB().

Referenced by ilLearningSequenceXMLWriter\__construct(), ilObjLearningSequenceSettingsGUI\__construct(), cloneSettings(), getShowMembers(), and read().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getMailToMembersType()

ilObjLearningSequence::getMailToMembersType ( )

Get mail to members type.

Returns: int

Definition at line 572 of file class.ilObjLearningSequence.php.

    {
        return $this->mail_members;
    }

◆ getMembersObject()

ilObjLearningSequence::getMembersObject ( )

Definition at line 636 of file class.ilObjLearningSequence.php.

    {
        return $this->getLSParticipants();
    }

References getLSParticipants().

Here is the call graph for this function:

◆ getParentObjectInfo()

ilObjLearningSequence::getParentObjectInfo	(	int	$ref_id,
		array	$search_types
	)

Definition at line 763 of file class.ilObjLearningSequence.php.

    {
        foreach ($this->tree->getPathFull($ref_id) as $hop) {
            if (in_array($hop['type'], $search_types)) {
                return $hop;
            }
        }
        return null;
    }

References ilObject\$ref_id.

◆ getPossiblePostConditionsForType()

ilObjLearningSequence::getPossiblePostConditionsForType ( string $type )

Returns: array<"value" => "option_text">

Definition at line 386 of file class.ilObjLearningSequence.php.

                                                                   : array
    {
        $condition_types = $this->il_condition_handler->getOperatorsByTriggerType($type);
        $conditions = [
            $this->conditions_db::STD_ALWAYS_OPERATOR => $this->lng->txt('condition_always')
        ];
        foreach ($condition_types as $cond_type) {
            $conditions[$cond_type] = $this->lng->txt($cond_type);
        }
        return $conditions;
    }

References ilObject\$type.

◆ getPostConditionDB()

ilObjLearningSequence::getPostConditionDB ( )

protected

Definition at line 310 of file class.ilObjLearningSequence.php.

                                            : ilLSPostConditionDB
    {
        if (!$this->conditions_db) {
            $this->conditions_db = new ilLSPostConditionDB($this->database);
        }
 
        return $this->conditions_db;
    }

References $conditions_db.

Referenced by deletePostConditionsForSubObjects(), and getLSItemsDB().

Here is the caller graph for this function:

◆ getSequencePlayer()

ilObjLearningSequence::getSequencePlayer	(		$gui,
		string	$player_command,
		int	$usr_id
	)

factors the player

Definition at line 492 of file class.ilObjLearningSequence.php.

                                                                                 : ilLSPlayer
    {
        global $DIC;
 
        $lso_ref_id = $this->getRefId();
        $lso_title = $this->getTitle();
 
        $player_url = $this->ctrl->getLinkTarget($gui, $player_command, '', false, false);
        $items = $this->getLSLearnerItems($usr_id);
        $url_builder = $this->getUrlBuilder($player_url);
 
        $curriculum_builder = $this->getCurriculumBuilder(
            $items,
            $url_builder
        );
 
        $global_settings = $this->getGlobalSettings();
        $control_builder = new LSControlBuilder(
            $DIC["ui.factory"],
            $url_builder,
            $this->lng,
            $global_settings
        );
 
        $view_factory = new ilLSViewFactory(
            $this->kiosk_mode_service,
            $this->lng,
            $this->access
        );
 
        $state_db = $this->getStateDB();
        $kiosk_renderer = $this->getKioskRenderer($url_builder);
 
        return new ilLSPlayer(
            $lso_ref_id,
            $lso_title,
            $usr_id,
            $items,
            $state_db,
            $control_builder,
            $url_builder,
            $curriculum_builder,
            $view_factory,
            $kiosk_renderer,
            $DIC["ui.factory"]
        );
    }

References $DIC, $state_db, getCurriculumBuilder(), getGlobalSettings(), getKioskRenderer(), getLSLearnerItems(), ilObject\getRefId(), getStateDB(), ilObject\getTitle(), and getUrlBuilder().

Here is the call graph for this function:

◆ getSettingsDB()

ilObjLearningSequence::getSettingsDB ( )

protected

Definition at line 236 of file class.ilObjLearningSequence.php.

                                       : ilLearningSequenceSettingsDB
    {
        if (!$this->settings_db) {
            $fs = $this->getLSFileSystem();
            $this->settings_db = new ilLearningSequenceSettingsDB(
                $this->database,
                $fs
            );
        }
        return $this->settings_db;
    }

References $settings_db, and getLSFileSystem().

Referenced by delete(), getLSSettings(), and updateSettings().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getShowMembers()

ilObjLearningSequence::getShowMembers ( )

Definition at line 655 of file class.ilObjLearningSequence.php.

    {
        return $this->getLSSettings()->getMembersGallery();
    }

References getLSSettings().

Here is the call graph for this function:

◆ getStateDB()

ilObjLearningSequence::getStateDB ( )

Definition at line 411 of file class.ilObjLearningSequence.php.

                                 : ilLSStateDB
    {
        if (!$this->state_db) {
            $this->state_db = new ilLSStateDB($this->database);
        }
 
        return $this->state_db;
    }

References $state_db.

Referenced by delete(), getCurrentItemForLearner(), getLearnerProgressDB(), and getSequencePlayer().

Here is the caller graph for this function:

◆ getUrlBuilder()

ilObjLearningSequence::getUrlBuilder ( string $player_url )

Definition at line 477 of file class.ilObjLearningSequence.php.

                                                      : LSUrlBuilder
    {
        $player_url = $this->data_factory->uri(ILIAS_HTTP_PATH . '/' . $player_url);
        return new LSUrlBuilder($player_url);
    }

Referenced by getSequencePlayer().

Here is the caller graph for this function:

◆ initDefaultRoles()

ilObjLearningSequence::initDefaultRoles ( )

init default roles settings Purpose of this function is to create a local role folder and local roles, that are needed depending on the object type If you want to setup default local roles you MUST overwrite this method in derived object classes (see ilObjForum for an example) @access public

Returns: array empty array

Reimplemented from ilObject.

Definition at line 753 of file class.ilObjLearningSequence.php.

    {
        return $this->getLSRoles()->initDefaultRoles();
    }

References getLSRoles().

Here is the call graph for this function:

◆ isCompletedByUser()

ilObjLearningSequence::isCompletedByUser ( int $usr_id )

Definition at line 647 of file class.ilObjLearningSequence.php.

                                                   : bool
    {
        \ilLPStatusWrapper::_updateStatus($this->getId(), $usr_id);
        $tracking_active = ilObjUserTracking::_enabledLearningProgress();
        $user_completion = ilLPStatus::_hasUserCompleted($this->getId(), $usr_id);
        return ($tracking_active && $user_completion);
    }

References ilObjUserTracking\_enabledLearningProgress(), ilLPStatus\_hasUserCompleted(), ilLPStatusWrapper\_updateStatus(), and ilObject\getId().

Here is the call graph for this function:

◆ isMember()

ilObjLearningSequence::isMember ( int $usr_id )

Definition at line 641 of file class.ilObjLearningSequence.php.

    {
        $part = $this->getLSParticipants();
        return $part->isMember($usr_id);
    }

References getLSParticipants().

Here is the call graph for this function:

◆ join()

ilObjLearningSequence::join ( int $user_id )

Definition at line 717 of file class.ilObjLearningSequence.php.

    {
        $member_role = $this->getDefaultMemberRole();
        return $this->getLSRoles()->join($user_id, $member_role);
    }

References getDefaultMemberRole(), and getLSRoles().

Here is the call graph for this function:

◆ leave()

ilObjLearningSequence::leave ( $a_user_id )

Definition at line 733 of file class.ilObjLearningSequence.php.

    {
        return $this->getLSRoles()->leave($a_user_id);
    }

References getLSRoles().

Here is the call graph for this function:

◆ leaveLearningSequence()

ilObjLearningSequence::leaveLearningSequence ( )

Definition at line 723 of file class.ilObjLearningSequence.php.

    {
        return $this->getLSRoles()->leaveLearningSequence();
    }

References getLSRoles().

Here is the call graph for this function:

◆ raiseEvent()

ilObjLearningSequence::raiseEvent ( string $event_type )

protected

Definition at line 155 of file class.ilObjLearningSequence.php.

    {
        $this->app_event_handler->raise(
            'Modules/LearningSequence',
            $event_type,
            array(
                'obj_id' => $this->getId(),
                'appointments' => null
            )
        );
    }

References ilObject\getId().

Referenced by create(), delete(), and update().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ read()

ilObjLearningSequence::read ( )

read

@access public

Parameters

return

Reimplemented from ilContainer.

Definition at line 109 of file class.ilObjLearningSequence.php.

    {
        $this->getLSSettings();
        if ($this->getRefId()) {
            $this->getLSActivation();
        }
        parent::read();
    }

References getLSActivation(), getLSSettings(), and ilObject\getRefId().

Here is the call graph for this function:

◆ readMemberData()

ilObjLearningSequence::readMemberData	(	array	$user_ids,
		array	$columns = `null`
	)

Definition at line 758 of file class.ilObjLearningSequence.php.

    {
        return $this->getLsRoles()->readMemberData($user_ids, $columns);
    }

References $columns.

◆ setEffectiveOnlineStatus()

ilObjLearningSequence::setEffectiveOnlineStatus ( bool $status )

Definition at line 686 of file class.ilObjLearningSequence.php.

    {
        $act_db = $this->getActivationDB();
        $act_db->setEffectiveOnlineStatus((int) $this->getRefId(), $status);
    }

References getActivationDB(), and ilObject\getRefId().

Here is the call graph for this function:

◆ storeLSItems()

ilObjLearningSequence::storeLSItems ( array $ls_items )

Update LSItems.

Parameters

LSItem[]

Definition at line 365 of file class.ilObjLearningSequence.php.

    {
        $db = $this->getLSItemsDB();
        $db->storeItems($ls_items);
    }

References ilContainer\$db, and getLSItemsDB().

Here is the call graph for this function:

◆ update()

ilObjLearningSequence::update ( )

Update.

Reimplemented from ilContainer.

Definition at line 129 of file class.ilObjLearningSequence.php.

                             : bool
    {
        if (!parent::update()) {
            return false;
        }
        $this->raiseEvent(self::E_UPDATE);
 
        return true;
    }

References raiseEvent(), and League\Flysystem\Adapter\Polyfill\update().

Here is the call graph for this function:

◆ updateActivation()

ilObjLearningSequence::updateActivation ( ilLearningSequenceActivation $settings )

Definition at line 267 of file class.ilObjLearningSequence.php.

    {
        $this->getActivationDB()->store($settings);
        $this->ls_activation = $settings;
    }

References getActivationDB().

Here is the call graph for this function:

◆ updateSettings()

ilObjLearningSequence::updateSettings ( ilLearningSequenceSettings $settings )

Definition at line 290 of file class.ilObjLearningSequence.php.

    {
        $this->getSettingsDB()->store($settings);
        $this->ls_settings = $settings;
    }

References getSettingsDB().

Referenced by cloneSettings().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ userMayJoin()

ilObjLearningSequence::userMayJoin ( )

Definition at line 665 of file class.ilObjLearningSequence.php.

                                  : bool
    {
        return $this->access->checkAccess('participate', '', $this->getRefId());
    }

References ilObject\getRefId().

Here is the call graph for this function:

◆ userMayUnparticipate()

ilObjLearningSequence::userMayUnparticipate ( )

Definition at line 660 of file class.ilObjLearningSequence.php.

                                           : bool
    {
        return $this->access->checkAccess('unparticipate', '', $this->getRefId());
    }

References ilObject\getRefId().

Here is the call graph for this function:

Field Documentation

◆ $activation_db

ilObjLearningSequence::$activation_db

protected

Definition at line 65 of file class.ilObjLearningSequence.php.

Referenced by getActivationDB().

◆ $conditions_db

ilObjLearningSequence::$conditions_db

protected

Definition at line 25 of file class.ilObjLearningSequence.php.

Referenced by getPostConditionDB().

◆ $items_db

ilObjLearningSequence::$items_db

protected

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

Referenced by getLSItemsDB().

◆ $learner_progress_db

ilObjLearningSequence::$learner_progress_db

protected

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

Referenced by getLearnerProgressDB().

◆ $ls_activation

ilObjLearningSequence::$ls_activation

protected

Definition at line 70 of file class.ilObjLearningSequence.php.

Referenced by getLSActivation().

◆ $ls_file_system

ilObjLearningSequence::$ls_file_system

protected

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

Referenced by getLSFileSystem().

◆ $ls_item_online_status

ilObjLearningSequence::$ls_item_online_status

protected

Definition at line 75 of file class.ilObjLearningSequence.php.

Referenced by getLSItemOnlineStatus().

◆ $ls_participant

ilObjLearningSequence::$ls_participant

protected

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

Referenced by getLSParticipants().

◆ $ls_roles

ilObjLearningSequence::$ls_roles

protected

Definition at line 55 of file class.ilObjLearningSequence.php.

Referenced by getLSRoles().

◆ $ls_settings

ilObjLearningSequence::$ls_settings

protected

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

Referenced by getLSSettings().

◆ $settings_db

ilObjLearningSequence::$settings_db

protected

Definition at line 60 of file class.ilObjLearningSequence.php.

Referenced by getSettingsDB().

◆ $state_db

ilObjLearningSequence::$state_db

protected

Definition at line 50 of file class.ilObjLearningSequence.php.

Referenced by getLearnerProgressDB(), getSequencePlayer(), and getStateDB().

◆ E_CREATE

const ilObjLearningSequence::E_CREATE = 'create'

Definition at line 13 of file class.ilObjLearningSequence.php.

◆ E_DELETE

const ilObjLearningSequence::E_DELETE = 'delete'

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

◆ E_UPDATE

const ilObjLearningSequence::E_UPDATE = 'update'

Definition at line 14 of file class.ilObjLearningSequence.php.

◆ OBJ_TYPE

const ilObjLearningSequence::OBJ_TYPE = 'lso'

Definition at line 11 of file class.ilObjLearningSequence.php.

Referenced by ilObjLearningSequenceGUI\__construct(), ilObjLearningSequenceListGUI\__construct(), __construct(), and ilObjLearningSequenceListGUI\init().

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

Modules/LearningSequence/classes/class.ilObjLearningSequence.php

Static Public Member Functions
static	getInstanceByRefId (int $ref_id)

static	_goto ($target, $add="")
	Goto target learning sequence. More...

Static Public Member Functions inherited from ilContainer
static	_getContainerDirectory ($a_id)
	Get the container directory. More...

static	_lookupContainerSetting ($a_id, $a_keyword, $a_default_value=null)
	Lookup a container setting. More...

static	_writeContainerSetting ($a_id, $a_keyword, $a_value)

static	_getContainerSettings ($a_id)

static	_deleteContainerSettings ($a_id, $a_keyword=null, $a_keyword_like=false)

static	_exportContainerSettings (ilXmlWriter $a_xml, $a_obj_id)

static	getCompleteDescriptions (array $objects)
	overwrites description fields to long or short description in an assoc array keys needed (obj_id and description) More...

Static Public Member Functions inherited from ilObject
static	_lookupObjIdByImportId ($a_import_id)

static	_lookupImportId ($a_obj_id)

static	_lookupOwnerName ($a_owner_id)
	lookup owner name for owner id More...

static	_getIdForImportId ($a_import_id)
	get current object id for import id (static) More...

static	_getAllReferences ($a_id)
	get all reference ids of object More...

static	_lookupTitle ($a_id)
	lookup object title More...

static	lookupOfflineStatus ($a_obj_id)
	Lookup offline status using objectDataCache. More...

static	_lookupOwner ($a_id)
	lookup object owner More...

static	_getIdsForTitle ($title, $type='', $partialmatch=false)

static	_lookupDescription ($a_id)
	lookup object description More...

static	_lookupLastUpdate ($a_id, $a_as_string=false)
	lookup last update More...

static	_getLastUpdateOfObjects ($a_objs)
	Get last update for a set of media objects. More...

static	_lookupObjId ($a_id)

static	_setDeletedDate ($a_ref_id)
	only called in ilTree::saveSubTree More...

static	setDeletedDates ($a_ref_ids)
	Set deleted date. More...

static	_resetDeletedDate ($a_ref_id)
	only called in ilObjectGUI::insertSavedNodes More...

static	_lookupDeletedDate ($a_ref_id)
	only called in ilObjectGUI::insertSavedNodes More...

static	_writeTitle ($a_obj_id, $a_title)
	write title to db (static) More...

static	_writeDescription ($a_obj_id, $a_desc)
	write description to db (static) More...

static	_writeImportId ($a_obj_id, $a_import_id)
	write import id to db (static) More...

static	_lookupType ($a_id, $a_reference=false)
	lookup object type More...

static	_isInTrash ($a_ref_id)
	checks wether object is in trash More...

static	_hasUntrashedReference ($a_obj_id)
	checks wether an object has at least one reference that is not in trash More...

static	_lookupObjectId ($a_ref_id)
	lookup object id More...

static	_getObjectsDataForType ($a_type, $a_omit_trash=false)
	get all objects of a certain type More...

static	_exists ($a_id, $a_reference=false, $a_type=null)
	checks if an object exists in object_data@access public More...

static	_getObjectsByType ($a_obj_type="", $a_owner="")
	Get objects by type. More...

static	_prepareCloneSelection ($a_ref_ids, $new_type, $show_path=true)
	Prepare copy wizard object selection. More...

static	collectDeletionDependencies (&$deps, $a_ref_id, $a_obj_id, $a_type, $a_depth=0)
	Collect deletion dependencies. More...

static	getDeletionDependencies ($a_obj_id)
	Get deletion dependencies. More...

static	getLongDescriptions (array $a_obj_ids)
	Get long description data. More...

static	getAllOwnedRepositoryObjects ($a_user_id)
	Get all ids of objects user owns. More...

static	fixMissingTitles ($a_type, array &$a_obj_title_map)
	Try to fix missing object titles. More...

static	_lookupCreationDate ($a_id)
	Lookup creation date. More...

static	hasAutoRating ($a_type, $a_ref_id)
	Check if auto rating is active for parent group/course. More...

Data Fields
const	OBJ_TYPE = 'lso'

const	E_CREATE = 'create'

const	E_UPDATE = 'update'

const	E_DELETE = 'delete'

Data Fields inherited from ilContainer
const	VIEW_SESSIONS = 0

const	VIEW_OBJECTIVE = 1

const	VIEW_TIMING = 2

const	VIEW_ARCHIVE = 3

const	VIEW_SIMPLE = 4

const	VIEW_BY_TYPE = 5

const	VIEW_INHERIT = 6

const	VIEW_DEFAULT = self::VIEW_BY_TYPE

const	SORT_TITLE = 0

const	SORT_MANUAL = 1

const	SORT_ACTIVATION = 2

const	SORT_INHERIT = 3

const	SORT_CREATION = 4

const	SORT_DIRECTION_ASC = 0

const	SORT_DIRECTION_DESC = 1

const	SORT_NEW_ITEMS_POSITION_TOP = 0

const	SORT_NEW_ITEMS_POSITION_BOTTOM = 1

const	SORT_NEW_ITEMS_ORDER_TITLE = 0

const	SORT_NEW_ITEMS_ORDER_CREATION = 1

const	SORT_NEW_ITEMS_ORDER_ACTIVATION = 2

Data Fields inherited from ilObject
const	TITLE_LENGTH = 255
	max length of object title More...

const	DESC_LENGTH = 128

	$lng

	$id

	$ref_id

	$type

	$title

	$untranslatedTitle

	$desc

	$long_desc

	$owner

	$create_date

	$last_update

	$import_id

	$register = false

	$referenced

	$objectList

	$max_title

	$max_desc

	$add_dots

Protected Member Functions
	raiseEvent (string $event_type)

	cloneAutoGeneratedRoles (ilObjLearningSequence $new_obj)

	cloneSettings (ilObjLearningSequence $new_obj)

	cloneLPSettings (int $obj_id)

	getSettingsDB ()

	getActivationDB ()

	getLSItemsDB ()

	getPostConditionDB ()

	getLSItemOnlineStatus ()

	getLearnerProgressDB ()

	getGlobalSettings ()

	getKioskRenderer (LSUrlBuilder $url_builder)

Protected Attributes
	$items_db

	$conditions_db

	$learner_progress_db

	$ls_participant

	$ls_settings

	$ls_file_system

	$state_db

	$ls_roles

	$settings_db

	$activation_db

	$ls_activation

	$ls_item_online_status

Protected Attributes inherited from ilContainer
	$db

	$log

	$access

	$error

	$rbacsystem

	$tree

	$user

	$obj_definition

	$order_type = 0

	$hiddenfilesfound = false

	$news_timeline = false

	$news_timeline_auto_entries = false

	$setting

	$obj_trans = null

Protected Attributes inherited from ilObject
	$objDefinition

	$db

	$log

	$error

	$tree

	$app_event_handler

	$rbacadmin

	$rbacreview

Additional Inherited Members
Static Public Attributes inherited from ilContainer
static	$data_preloaded = false

Public Member Functions

Static Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _goto()

◆ addMember()

◆ announceLSOOffline()

◆ announceLSOOnline()

◆ cloneAutoGeneratedRoles()

◆ cloneLPSettings()

◆ cloneObject()

◆ cloneSettings()

◆ create()

◆ delete()

◆ deletePostConditionsForSubObjects()

◆ getActivationDB()

◆ getCurrentItemForLearner()

◆ getCurriculumBuilder()

◆ getDefaultAdminRole()

◆ getDefaultLearningSequenceRoles()

◆ getDefaultMemberRole()

◆ getGlobalSettings()

◆ getInstanceByRefId()

◆ getKioskRenderer()

◆ getLearnerProgressDB()

◆ getLearningSequenceAdminIds()

◆ getLearningSequenceMemberData()

◆ getLearningSequenceMemberIds()

◆ getLocalLearningSequenceRoles()

◆ getLPCompletionStates()

◆ getLSAccess()

◆ getLSActivation()

◆ getLSFileSystem()

◆ getLSItemOnlineStatus()

◆ getLSItems()

◆ getLSItemsDB()

◆ getLSLearnerItems()

◆ getLSParticipants()

◆ getLSRoles()

◆ getLSSettings()

◆ getMailToMembersType()

◆ getMembersObject()

◆ getParentObjectInfo()

◆ getPossiblePostConditionsForType()

◆ getPostConditionDB()

◆ getSequencePlayer()

◆ getSettingsDB()

◆ getShowMembers()

◆ getStateDB()

◆ getUrlBuilder()

◆ initDefaultRoles()

◆ isCompletedByUser()

◆ isMember()

◆ join()

◆ leave()

◆ leaveLearningSequence()

◆ raiseEvent()

◆ read()

◆ readMemberData()

◆ setEffectiveOnlineStatus()

◆ storeLSItems()

◆ update()

◆ updateActivation()

◆ updateSettings()

◆ userMayJoin()

◆ userMayUnparticipate()

Field Documentation

◆ $activation_db

◆ $conditions_db

◆ $items_db

◆ $learner_progress_db

◆ $ls_activation

◆ $ls_file_system

◆ $ls_item_online_status