Class ilObjLearningSequence. More...

Inheritance diagram for ilObjLearningSequence:

Collaboration diagram for ilObjLearningSequence:

Public Member Functions

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

read ()

readContainerSettings ()

Read container settings. More...

removeTranslations ()

Remove all translations of container. More...

deleteTranslation ($a_lang)

Delete translation. More...

addTranslation ($a_title, $a_desc, $a_lang, $a_lang_default)

Add translation. More...

Public Member Functions inherited from ilObject

__construct ($a_id=0, $a_reference=true)

Constructor @access public. More...

withReferences ()

determines wehter objects are referenced or not (got ref ids or not) More...

read ()

read object data from db into object More...

getId ()

get object id @access public More...

setId ($a_id)

set object id @access public More...

setRefId ($a_id)

set reference id @access public More...

getRefId ()

get reference id @access public More...

getType ()

get object type @access public More...

setType ($a_type)

set object type @access public More...

getPresentationTitle ()

get presentation title Normally same as title Overwritten for sessions More...

getTitle ()

get object title @access public More...

getUntranslatedTitle ()

get untranslated object title @access public More...

setTitle ($a_title)

set object title More...

getDescription ()

get object description More...

setDescription ($a_desc)

set object description More...

getLongDescription ()

get object long description (stored in object_description) More...

getImportId ()

get import id More...

setImportId ($a_import_id)

set import id More...

setOfflineStatus ($a_status)

Set offline status. More...

getOfflineStatus ()

Get offline status. More...

supportsOfflineHandling ()

Check whether object supports offline handling. More...

getOwner ()

get object owner More...

getOwnerName ()

setOwner ($a_owner)

set object owner More...

getCreateDate ()

get create date @access public More...

getLastUpdateDate ()

get last update date @access public More...

getDiskUsage ()

Gets the disk usage of the object in bytes. More...

create ()

create More...

update ()

update object in db More...

MDUpdateListener ($a_element)

Meta data update listener. More...

createMetaData ()

create meta data entry More...

updateMetaData ()

update meta data entry More...

deleteMetaData ()

delete meta data entry More...

updateOwner ()

update owner of object in db More...

putInTree ($a_parent_ref)

maybe this method should be in tree object!? More...

setPermissions ($a_parent_ref)

set permissions of object More...

setParentRolePermissions ($a_parent_ref)

Initialize the permissions of parent roles (local roles of categories, global roles...) This method is overwritten in e.g courses, groups for building permission intersections with non_member templates. More...

createReference ()

creates reference for object More...

countReferences ()

count references of object More...

delete ()

delete object or referenced object (in the case of a referenced object, object data is only deleted if last reference is deleted) This function removes an object entirely from system!! More...

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 More...

applyDidacticTemplate ($a_tpl_id)

Apply template. More...

setRegisterMode ($a_bool)

isUserRegistered ($a_user_id=0)

requireRegistration ()

getXMLZip ()

getHTMLDirectory ()

appendCopyInfo ($a_target_id, $a_copy_id)

Prepend Copy info if object with same name exists in that container. More...

cloneDependencies ($a_target_id, $a_copy_id)

Clone object dependencies. More...

cloneMetaData ($target_obj)

Copy meta data. More...

getPossibleSubObjects ($a_filter=true)

get all possible subobjects of this type the object can decide which types of subobjects are possible jut in time overwrite if the decision distinguish from standard model More...

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, $a_deleted_by)

static	setDeletedDates ($a_ref_ids, $a_user_id)
	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	_getIcon ( $a_obj_id="", $a_size="big", $a_type="", $a_offline=false)
	Get icon for repository item. 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)

	cloneActivation (ilObjLearningSequence $new_obj, int $a_copy_id)

	getDIC ()

	getSettingsDB ()

	getActivationDB ()

	getLSItemsDB ()

	getPostConditionDB ()

	getLearnerProgressDB ()

Protected Member Functions inherited from ilContainer
	getInitialSubitems ()
	Get initial subitems. More...

	applyContainerUserFilter ($objects, ilContainerUserFilter $container_user_filter=null)
	Apply container user filter on objects. More...

	legacyOnlineFilter ($obj_ids, $objects, $val)
	Legacy online filter. More...

Protected Attributes
	$items_db

	$conditions_db

	$learner_progress_db

	$ls_participant

	$ls_settings

	$state_db

	$ls_roles

	$settings_db

	$activation_db

	$ls_activation

Protected Attributes inherited from ilContainer
	$news

	$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

	$recommended_content_manager

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

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 68 of file class.ilObjLearningSequence.php.

    {
        global $DIC;
        $this->dic = $DIC;
 
        $this->type = self::OBJ_TYPE;
        $this->lng = $DIC['lng'];
        $this->ctrl = $DIC['ilCtrl'];
        $this->user = $DIC['ilUser'];
        $this->tree = $DIC['tree'];
        $this->log = $DIC["ilLoggerFactory"]->getRootLogger();
        $this->rbacadmin = $DIC['rbacadmin'];
        $this->app_event_handler = $DIC['ilAppEventHandler'];
        $this->il_news = $DIC->news();
        $this->il_condition_handler = new ilConditionHandler();
 
        parent::__construct($id, $call_by_reference);
 
        $this->lng->loadLanguageModule('rbac');
    }

References $DIC, ilObject\$id, ILIAS\GlobalScreen\Provider\__construct(), 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 452 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, ilObjectGUI\_gotoRepositoryNode(), ilObjectGUI\_gotoRepositoryRoot(), ilObject\_lookupObjId(), ilObject\_lookupTitle(), ilObject\_lookupType(), ANONYMOUS_USER_ID, ilMembershipRegistrationCodeUtils\handleCode(), ilUtil\redirect(), ROOT_FOLDER_ID, and ilUtil\sendFailure().

Here is the call graph for this function:

◆ announceLSOOffline()

ilObjLearningSequence::announceLSOOffline ( )

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

    {
        //NYI
    }

◆ announceLSOOnline()

ilObjLearningSequence::announceLSOOnline ( )

Definition at line 510 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:

◆ cloneActivation()

ilObjLearningSequence::cloneActivation	(	ilObjLearningSequence	$new_obj,
		int	$a_copy_id
	)

protected

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

                                                                                       : void
    {
        // #14596
        $cwo = ilCopyWizardOptions::_getInstance($a_copy_id);
        if ($cwo->isRootNode($this->getRefId())) {
            $activation = $new_obj->getLSActivation()->withIsOnline(false);
        } else {
            $activation = $new_obj->getLSActivation()
                ->withIsOnline($this->getLSActivation()->getIsOnline())
                ->withActivationStart($this->getLSActivation()->getActivationStart())
                ->withActivationEnd($this->getLSActivation()->getActivationEnd());
        }
 
        $new_obj->getActivationDB()->store(
            $activation
        );
    }

References ilCopyWizardOptions\_getInstance(), getActivationDB(), and getLSActivation().

Referenced by cloneObject().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ cloneAutoGeneratedRoles()

ilObjLearningSequence::cloneAutoGeneratedRoles ( ilObjLearningSequence $new_obj )

protected

Definition at line 171 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 219 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 152 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());
        $this->cloneActivation($new_obj, (int) $copy_id);
 
        $roles = $new_obj->getLSRoles();
        $roles->addLSMember(
            (int) $this->user->getId(),
            $roles->getDefaultAdminRole()
        );
        return $new_obj;
    }

References $target_id, cloneActivation(), 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 196 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 $source, 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 103 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 124 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 380 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 281 of file class.ilObjLearningSequence.php.

                                         : ilLearningSequenceActivationDB
    {
        if (!$this->activation_db) {
            $this->activation_db = $this->getDI()['db.activation'];
        }
        return $this->activation_db;
    }

References $activation_db, and getDI().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getDefaultAdminRole()

ilObjLearningSequence::getDefaultAdminRole ( )

Definition at line 545 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 555 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 540 of file class.ilObjLearningSequence.php.

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

References getLSRoles().

Referenced by cloneAutoGeneratedRoles().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getDI()

ilObjLearningSequence::getDI ( )

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

                            : \ArrayAccess
    {
        if (is_null($this->di)) {
            $di = new ilLSDI();
            $di->init($this->getDIC());
            $this->di = $di;
        }
        return $this->di;
    }

References getDIC().

Referenced by getActivationDB(), getLocalDI(), getPostConditionDB(), getSettingsDB(), and getStateDB().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getDIC()

ilObjLearningSequence::getDIC ( )

protected

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

                                : \ArrayAccess
    {
        return $this->dic;
    }

References $dic.

Referenced by getDI(), and getLocalDI().

Here is the caller graph for this function:

◆ getInstanceByRefId()

static ilObjLearningSequence::getInstanceByRefId ( int $ref_id )

static

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

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

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

Referenced by ilDashboardLearningSequenceGUI\getHTML(), and ilObjLearningSequenceGUI\getObject().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getLearnerProgressDB()

ilObjLearningSequence::getLearnerProgressDB ( )

protected

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

                                              : ilLearnerProgressDB
    {
        if (!$this->learner_progress_db) {
            $this->learner_progress_db = $this->getLocalDI()['db.progress'];
        }
        return $this->learner_progress_db;
    }

References $learner_progress_db, and getLocalDI().

Referenced by getLSLearnerItems().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getLearningSequenceMemberData()

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

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

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

References getLSRoles().

Here is the call graph for this function:

◆ getLocalDI()

ilObjLearningSequence::getLocalDI ( )

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

                                 : \ArrayAccess
    {
        if (is_null($this->local_di)) {
            $di = new ilLSLocalDI();
            $di->init(
                $this->getDIC(),
                $this->getDI(),
                new \ILIAS\Data\Factory(),
                $this
            );
            $this->local_di = $di;
        }
        return $this->local_di;
    }

References getDI(), and getDIC().

Referenced by getLearnerProgressDB(), getLSItemsDB(), getLSParticipants(), and getLSRoles().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getLocalLearningSequenceRoles()

ilObjLearningSequence::getLocalLearningSequenceRoles ( bool $translate = false )

Definition at line 535 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 580 of file class.ilObjLearningSequence.php.

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

References ilLPStatus\LP_STATUS_COMPLETED_NUM.

◆ getLSAccess()

ilObjLearningSequence::getLSAccess ( )

Definition at line 348 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 289 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(), cloneActivation(), and read().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getLSItems()

ilObjLearningSequence::getLSItems ( )

Get a list of LSItems.

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

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

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

Here is the call graph for this function:

◆ getLSItemsDB()

ilObjLearningSequence::getLSItemsDB ( )

protected

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

                                      : ilLSItemsDB
    {
        if (!$this->items_db) {
            $this->items_db = $this->getLocalDI()['db.lsitems'];
        }
        return $this->items_db;
    }

References $items_db, and getLocalDI().

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

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

Referenced by ilDashboardLearningSequenceGUI\isRelevantLso().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getLSParticipants()

ilObjLearningSequence::getLSParticipants ( )

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

                                        : ilLearningSequenceParticipants
    {
        if (!$this->ls_participant) {
            $this->ls_participant = $this->getLocalDI()['participants'];
        }
 
        return $this->ls_participant;
    }

References $ls_participant, and getLocalDI().

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

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 = $this->getLocalDI()['roles'];
        }
        return $this->ls_roles;
    }

References $ls_roles, and getLocalDI().

Referenced by getDefaultAdminRole(), getDefaultLearningSequenceRoles(), getDefaultMemberRole(), getLearningSequenceMemberData(), getLocalLearningSequenceRoles(), and initDefaultRoles().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getLSSettings()

ilObjLearningSequence::getLSSettings ( )

Definition at line 304 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 441 of file class.ilObjLearningSequence.php.

    {
        return $this->mail_members;
    }

◆ getMembersObject()

ilObjLearningSequence::getMembersObject ( )

Definition at line 343 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 570 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 391 of file class.ilObjLearningSequence.php.

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

References ilObject\$type, and getPostConditionDB().

Here is the call graph for this function:

◆ getPostConditionDB()

ilObjLearningSequence::getPostConditionDB ( )

protected

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

                                            : ilLSPostConditionDB
    {
        if (!$this->conditions_db) {
            $this->conditions_db = $this->getDI()["db.postconditions"];
        }
        return $this->conditions_db;
    }

References $conditions_db, and getDI().

Referenced by deletePostConditionsForSubObjects(), and getPossiblePostConditionsForType().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getSettingsDB()

ilObjLearningSequence::getSettingsDB ( )

protected

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

                                       : ilLearningSequenceSettingsDB
    {
        if (!$this->settings_db) {
            $this->settings_db = $this->getDI()['db.settings'];
        }
        return $this->settings_db;
    }

References $settings_db, and getDI().

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 505 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 412 of file class.ilObjLearningSequence.php.

                                 : ilLSStateDB
    {
        if (!$this->state_db) {
            $this->state_db = $this->getDI()['db.states'];
        }
        return $this->state_db;
    }

References $state_db, and getDI().

Referenced by delete().

Here is the call graph for this function:

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 560 of file class.ilObjLearningSequence.php.

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

References getLSRoles().

Here is the call graph for this function:

◆ raiseEvent()

ilObjLearningSequence::raiseEvent ( string $event_type )

protected

Definition at line 140 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 94 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 565 of file class.ilObjLearningSequence.php.

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

References $columns.

◆ setEffectiveOnlineStatus()

ilObjLearningSequence::setEffectiveOnlineStatus ( bool $status )

Definition at line 526 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 370 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 114 of file class.ilObjLearningSequence.php.

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

References raiseEvent().

Here is the call graph for this function:

◆ updateActivation()

ilObjLearningSequence::updateActivation ( ilLearningSequenceActivation $settings )

Definition at line 298 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 313 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:

Field Documentation

◆ $activation_db

ilObjLearningSequence::$activation_db

protected

Definition at line 60 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 65 of file class.ilObjLearningSequence.php.

Referenced by getLSActivation().

◆ $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 50 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 55 of file class.ilObjLearningSequence.php.

Referenced by getSettingsDB().

◆ $state_db

ilObjLearningSequence::$state_db

protected

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

Referenced by 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

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()

◆ announceLSOOffline()

◆ announceLSOOnline()

◆ cloneActivation()

◆ cloneAutoGeneratedRoles()

◆ cloneLPSettings()

◆ cloneObject()

◆ cloneSettings()

◆ create()

◆ delete()

◆ deletePostConditionsForSubObjects()

◆ getActivationDB()

◆ getDefaultAdminRole()

◆ getDefaultLearningSequenceRoles()

◆ getDefaultMemberRole()

◆ getDI()

◆ getDIC()

◆ getInstanceByRefId()

◆ getLearnerProgressDB()

◆ getLearningSequenceMemberData()

◆ getLocalDI()

◆ getLocalLearningSequenceRoles()

◆ getLPCompletionStates()

◆ getLSAccess()

◆ getLSActivation()

◆ getLSItems()

◆ getLSItemsDB()

◆ getLSLearnerItems()

◆ getLSParticipants()

◆ getLSRoles()

◆ getLSSettings()

◆ getMailToMembersType()

◆ getMembersObject()

◆ getParentObjectInfo()

◆ getPossiblePostConditionsForType()

◆ getPostConditionDB()

◆ getSettingsDB()

◆ getShowMembers()

◆ getStateDB()

◆ initDefaultRoles()

◆ raiseEvent()

◆ read()

◆ readMemberData()

◆ setEffectiveOnlineStatus()

◆ storeLSItems()

◆ update()

◆ updateActivation()

◆ updateSettings()

Field Documentation

◆ $activation_db

◆ $conditions_db

◆ $items_db

◆ $learner_progress_db

◆ $ls_activation

◆ $ls_participant

◆ $ls_roles

◆ $ls_settings

◆ $settings_db

◆ $state_db

◆ E_CREATE

◆ E_DELETE

◆ E_UPDATE

◆ OBJ_TYPE