Inheritance diagram for ilObjLearningSequence:

Collaboration diagram for ilObjLearningSequence:

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

	read ()

	create ()
	note: title, description and type should be set when this function is called More...

	update ()

	delete ()
	delete category and all related data More...

	getObjectReferenceProperties ()

	storeAvailabilityPeriod (AvailabilityPeriod $period)

	getDI ()

	getLocalDI ()

	getLSSettings ()

	updateSettings (ilLearningSequenceSettings $settings)

	getLSParticipants ()

	getMembersObject ()

	getLSAccess ()

	getLSItems ()

	storeLSItems (array $ls_items)
	Update LSItems. More...

	deletePostConditionsForSubObjects (array $ref_ids)
	Delete post conditions for ref ids. More...

	getPossiblePostConditionsForType (string $type)

	getStateDB ()

	getLSLearnerItems (int $usr_id)

	getLSRoles ()

	getMailToMembersType ()
	Get mail to members type. More...

	getShowMembers ()

	announceLSOOnline ()

	announceLSOOffline ()

	setEffectiveOnlineStatus (bool $status)

	getCurrentUserCurriculum ()

	getCurrentUserLaunchButtons ()

	getLocalLearningSequenceRoles (bool $translate=false)

	getDefaultMemberRole ()

	getDefaultAdminRole ()

	getDefaultLearningSequenceRoles (string $a_grp_id="")

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

	readMemberData (array $user_ids, ?array $columns=null)

	getParentObjectInfo (int $ref_id, array $search_types)

	getLPCompletionStates ()

	getContentPageId ()

	hasContentPage (LSOPageType $page_type)

	createContentPage (LSOPageType $page_type)

	getContentPageHTML (LSOPageType $page_type)

Public Member Functions inherited from ilContainer
	getTileSizes ()

	getObjectTranslation ()

	setObjectTranslation (?Translations $obj_trans)

	createContainerDirectory ()

	getContainerDirectory ()

	setHiddenFilesFound (bool $a_hiddenfilesfound)

	getHiddenFilesFound ()

	getStyleSheetId ()

	setStyleSheetId (int $a_style_id)

	setNewsTimeline (bool $a_val)

	getNewsTimeline ()

	setNewsTimelineAutoEntries (bool $a_val)

	getNewsTimelineAutoEntries ()

	setNewsTimelineLandingPage (bool $a_val)

	getNewsTimelineLandingPage ()

	isNewsTimelineEffective ()

	isNewsTimelineLandingPageEffective ()

	setNewsBlockActivated (bool $a_val)

	getNewsBlockActivated ()

	setUseNews (bool $a_val)

	getUseNews ()

	cloneDependencies (int $target_id, int $copy_id)
	Clone object dependencies (container sorting) More...

	cloneAllObject (string $session_id, string $client_id, string $new_type, int $ref_id, int $clone_source, array $options, bool $soap_call=false, int $a_submode=1)

	delete ()
	delete category and all related data More...

	getViewMode ()

	getOrderType ()

	setOrderType (int $a_value)

	isClassificationFilterActive ()

	filteredSubtree ()
	Note grp/crs currently allow to filter in their whole subtrees Catetories only their direct childs. More...

	getSubItems (bool $a_admin_panel_enabled=false, bool $a_include_side_block=false, int $a_get_single=0, ?ilContainerUserFilter $container_user_filter=null)

	gotItems ()

	addAdditionalSubItemInformation (array &$object)
	Add additional information to sub item, e.g. More...

	getGroupedObjTypes ()

	enablePageEditing ()

	create ()
	note: title, description and type should be set when this function is called More...

	putInTree (int $parent_ref_id)
	maybe this method should be in tree object!? More...

	update ()

	read ()

	readContainerSettings ()

	removeTranslations ()

	deleteTranslation (string $a_lang)

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

Public Member Functions inherited from ilObject
	getObjectProperties ()

	flushObjectProperties ()

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

	processAutoRating ()

	read ()

	getId ()

	setId (int $id)

	setRefId (int $ref_id)

	getRefId ()

	getType ()

	setType (string $type)

	getPresentationTitle ()
	get presentation title Normally same as title Overwritten for sessions More...

	getTitle ()

	getUntranslatedTitle ()
	Get untranslated object title WebDAV needs to access the untranslated title of an object. More...

	setTitle (string $title)

	getDescription ()

	setDescription (string $description)

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

	getImportId ()

	setImportId (string $import_id)

	setOfflineStatus (bool $status)

	getOfflineStatus ()

	supportsOfflineHandling ()

	getOwner ()

	getOwnerName ()
	get full name of object owner More...

	setOwner (int $usr_id)

	getCreateDate ()
	Get create date in YYYY-MM-DD HH-MM-SS format. More...

	getLastUpdateDate ()
	Get last update date in YYYY-MM-DD HH-MM-SS format. More...

	create ()
	note: title, description and type should be set when this function is called More...

	update ()

	MDUpdateListener (string $element)
	Metadata update listener. More...

	createMetaData ()

	updateMetaData ()

	deleteMetaData ()

	updateOwner ()
	update owner of object in db More...

	putInTree (int $parent_ref_id)
	maybe this method should be in tree object!? More...

	setPermissions (int $parent_ref_id)

	setParentRolePermissions (int $parent_ref_id)
	Initialize the permissions of parent roles (local roles of categories, global roles...) This method is overwritten in e.g. More...

	createReference ()
	creates reference for object More...

	countReferences ()

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

	applyDidacticTemplate (int $tpl_id)

	getXMLZip ()

	getHTMLDirectory ()

	appendCopyInfo (int $target_id, int $copy_id, int $new_obj_id)
	Prepend Copy info if object with same name exists in that container. More...

	cloneDependencies (int $target_id, int $copy_id)
	Clone object dependencies. More...

	cloneMetaData (ilObject $target_obj)
	Copy meta data. More...

	selfOrParentWithRatingEnabled ()

	getPossibleSubObjects (bool $filter=true)
	get all possible sub objects of this type the object can decide which types of sub objects 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 (string $target, string $add="")
	Goto target learning sequence. More...

Static Public Member Functions inherited from ilContainer
static	_getContainerDirectory (int $a_id)

static	_lookupContainerSetting (int $a_id, string $a_keyword, ?string $a_default_value=null)

static	_hasContainerSetting (int $a_id, string $a_keyword)

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

static	_getContainerSettings (int $a_id)

static	_deleteContainerSettings (int $a_id, string $a_keyword="", bool $a_keyword_like=false)

static	_exportContainerSettings (ilXmlWriter $a_xml, int $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 (string $import_id)
	Get (latest) object id for an import id. More...

static	_lookupImportId (int $obj_id)

static	_lookupOwnerName (int $owner_id)
	Lookup owner name for owner id. More...

static	_getIdForImportId (string $import_id)

static	_getAllReferences (int $id)
	get all reference ids for object ID More...

static	_lookupTitle (int $obj_id)

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

static	_lookupOwner (int $obj_id)
	Lookup owner user ID for object ID. More...

static	_getIdsForTitle (string $title, string $type='', bool $partial_match=false)

static	_lookupDescription (int $obj_id)

static	_lookupLastUpdate (int $obj_id, bool $formatted=false)

static	_getLastUpdateOfObjects (array $obj_ids)

static	_lookupObjId (int $ref_id)

static	_setDeletedDate (int $ref_id, int $deleted_by)

static	setDeletedDates (array $ref_ids, int $user_id)

static	_resetDeletedDate (int $ref_id)

static	_lookupDeletedDate (int $ref_id)

static	_writeTitle (int $obj_id, string $title)
	write title to db (static) More...

static	_writeDescription (int $obj_id, string $desc)
	write description to db (static) More...

static	_writeImportId (int $obj_id, string $import_id)
	write import id to db (static) More...

static	_lookupType (int $id, bool $reference=false)

static	_isInTrash (int $ref_id)

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

static	_lookupObjectId (int $ref_id)

static	_getObjectsDataForType (string $type, bool $omit_trash=false)
	get all objects of a certain type More...

static	_exists (int $id, bool $reference=false, ?string $type=null)
	checks if an object exists in object_data More...

static	_getObjectsByType (string $obj_type="", ?int $owner=null)

static	_prepareCloneSelection (array $ref_ids, string $new_type, bool $show_path=true)
	Prepare copy wizard object selection. More...

static	getIconForType (string $type)

static	_getIcon (int $obj_id=0, string $size="big", string $type="", bool $offline=false)
	Get icon for repository item. More...

static	collectDeletionDependencies (array &$deps, int $ref_id, int $obj_id, string $type, int $depth=0)
	Collect deletion dependencies. More...

static	getDeletionDependencies (int $obj_id)
	Get deletion dependencies. More...

static	getLongDescriptions (array $obj_ids)

static	getAllOwnedRepositoryObjects (int $user_id)

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

static	_lookupCreationDate (int $obj_id)

static	_getObjectTypeIdByTitle (string $type, ?\ilDBInterface $ilDB=null)

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

const	TILE_NORMAL = 0

const	TILE_SMALL = 1

const	TILE_LARGE = 2

const	TILE_EXTRA_LARGE = 3

const	TILE_FULL = 4

array	$items = []

Data Fields inherited from ilObject
const	TITLE_LENGTH = 255

const	DESC_LENGTH = 128

const	LONG_DESC_LENGTH = 4000

const	TABLE_OBJECT_DATA = "object_data"

array	$objectList

string	$untranslatedTitle

Protected Member Functions
	raiseEvent (string $event_type)

	cloneIntroAndExtroContentPages (ilObjLearningSequence $new_obj, array $cp_types)

	cloneAutoGeneratedRoles (ilObjLearningSequence $new_obj)

	cloneSettings (ilObjLearningSequence $new_obj)

	cloneLPSettings (int $obj_id)

	getDIC ()

	getSettingsDB ()

	getLSItemsDB ()

	getPostConditionDB ()

	getLearnerProgressDB ()

Protected Member Functions inherited from ilContainer
	getInitialSubitems ()

	applyContainerUserFilter (array $objects, ?ilContainerUserFilter $container_user_filter=null)

Protected Member Functions inherited from ilObject
	doMDUpdateListener (string $a_element)

	beforeMDUpdateListener (string $a_element)

	doCreateMetaData ()

	beforeCreateMetaData ()

	doUpdateMetaData ()

	beforeUpdateMetaData ()

	doDeleteMetaData ()

	beforeDeleteMetaData ()

	handleAutoRating ()

	hasAutoRating ()

Protected Attributes
ilLSItemsDB	$items_db = null

ilLSPostConditionDB	$conditions_db = null

ilLearnerProgressDB	$learner_progress_db = null

ilLearningSequenceParticipants	$ls_participants = null

ilLearningSequenceSettings	$ls_settings = null

ilLSStateDB	$state_db = null

ilLearningSequenceRoles	$ls_roles = null

ilLearningSequenceSettingsDB	$settings_db = null

ilLearningSequenceActivationDB	$activation_db = null

ilLearningSequenceActivation	$ls_activation = null

ArrayAccess	$di = null

ArrayAccess	$local_di = null

ilObjLearningSequenceAccess	$ls_access = null

ArrayAccess	$dic

ilCtrl	$ctrl

ILIAS News Service	$il_news

ilConditionHandler	$il_condition_handler

ReferencePropertiesRepository	$repo_ref_props

ObjectReferenceProperties	$ref_props = null

Protected Attributes inherited from ilContainer
News	$news

ILIAS Style Content DomainService	$content_style_domain

ILIAS Container InternalDomainService	$domain

ilAccessHandler	$access

ilRbacSystem	$rbacsystem

ilObjUser	$user

ilObjectDefinition	$obj_definition

int	$order_type = 0

bool	$hiddenfilesfound = false

bool	$news_timeline = false

bool	$news_timeline_auto_entries = false

ilSetting	$setting

Translations	$obj_trans = null

int	$style_id = 0

bool	$news_timeline_landing_page = false

bool	$news_block_activated = false

bool	$use_news = false

ilRecommendedContentManager	$recommended_content_manager

array	$type_grps = null

Protected Attributes inherited from ilObject
ilLogger	$obj_log

ILIAS	$ilias

ilObjectDefinition	$obj_definition

ilDBInterface	$db

ilLogger	$log

ilErrorHandling	$error

ilTree	$tree

ilAppEventHandler	$app_event_handler

ilRbacAdmin	$rbac_admin

ilRbacReview	$rbac_review

ilObjUser	$user

ilLanguage	$lng

LOMServices	$lom_services

bool	$call_by_reference

int	$max_title = self::TITLE_LENGTH

int	$max_desc = self::DESC_LENGTH

bool	$add_dots = true

int	$ref_id = null

string	$type = ""

string	$title = ""

string	$desc = ""

string	$long_desc = ""

int	$owner = 0

string	$create_date = ""

string	$last_update = ""

string	$import_id = ""

bool	$register = false

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

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

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

Definition at line 54 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->app_event_handler = $DIC['ilAppEventHandler'];
        $this->il_news = $DIC->news();
        $this->il_condition_handler = new ilConditionHandler();
        $this->repo_ref_props = LocalDIC::dic()['properties.object_reference.repositoy'];
        parent::__construct($id, $call_by_reference);
 
        $this->lng->loadLanguageModule('rbac');
    }

References ilObject\$call_by_reference, $DIC, $id, ILIAS\GlobalScreen\Provider\__construct(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), OBJ_TYPE, and ILIAS\Repository\user().

Here is the call graph for this function:

Member Function Documentation

◆ _goto()

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

static

Goto target learning sequence.

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

                                                                  : void
    {
        global $DIC;
        $main_tpl = $DIC->ui()->mainTemplate();
 
        $ilAccess = $DIC['ilAccess'];
        $ilErr = $DIC['ilErr'];
        $lng = $DIC['lng'];
        $ilUser = $DIC['ilUser'];
        $request_wrapper = $DIC->http()->wrapper()->query();
        $refinery = $DIC->refinery();
 
        if (substr($add, 0, 5) == 'rcode') {
            if ($ilUser->getId() == ANONYMOUS_USER_ID) {
                $request_target = $request_wrapper->retrieve("target", $refinery->kindlyTo()->string());
                // Redirect to login for anonymous
                ilUtil::redirect(
                    "login.php?target=" . $request_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)) {
                    $main_tpl->setOnScreenMessage('failure', 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 $DIC, $ilErr, ilObject\$lng, ILIAS\UI\examples\Layout\Page\Mail\$refinery, ILIAS\UI\examples\Layout\Page\Mail\$request_wrapper, ilObjectGUI\_gotoRepositoryNode(), ilObjectGUI\_gotoRepositoryRoot(), ilObject\_lookupObjId(), ilObject\_lookupTitle(), ilObject\_lookupType(), ANONYMOUS_USER_ID, ilMembershipRegistrationCodeUtils\handleCode(), ilUtil\redirect(), ROOT_FOLDER_ID, and ilLanguage\txt().

Here is the call graph for this function:

◆ announceLSOOffline()

ilObjLearningSequence::announceLSOOffline ( )

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

◆ announceLSOOnline()

ilObjLearningSequence::announceLSOOnline ( )

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

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

References $il_news, and ilObject\getRefId().

Here is the call graph for this function:

◆ cloneAutoGeneratedRoles()

ilObjLearningSequence::cloneAutoGeneratedRoles ( ilObjLearningSequence $new_obj )

protected

Definition at line 205 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->rbac_admin->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->rbac_admin->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().

Here is the call graph for this function:

◆ cloneIntroAndExtroContentPages()

ilObjLearningSequence::cloneIntroAndExtroContentPages	(	ilObjLearningSequence	$new_obj,
		array	$cp_types
	)

protected

Parameters

list<LSOPageType> $cp_types

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

                                                                                                      : void
    {
        foreach ($cp_types as $type) {
            $new_obj->createContentPage($type);
            if ($this->hasContentPage($type)) {
                $target_page_id = $new_obj->getContentPageId();
                $source_page_id = $this->getContentPageId();
 
                if ($type === LSOPageType::INTRO) {
                    $source_page = new ilLSOIntroPage($source_page_id);
                } else {
                    $source_page = new ilLSOExtroPage($source_page_id);
                }
                $source_page->copy($target_page_id, $type->value, $target_page_id);
            }
        }
    }

References ilObject\$type, createContentPage(), getContentPageId(), and hasContentPage().

Here is the call graph for this function:

◆ cloneLPSettings()

ilObjLearningSequence::cloneLPSettings ( int $obj_id )

protected

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

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

References ilObject\getId().

Here is the call graph for this function:

◆ cloneSettings()

ilObjLearningSequence::cloneSettings ( ilObjLearningSequence $new_obj )

protected

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

                                                                    : void
    {
        $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 getLSSettings(), and updateSettings().

Here is the call graph for this function:

◆ create()

ilObjLearningSequence::create ( )

note: title, description and type should be set when this function is called

Reimplemented from ilContainer.

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

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

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

Here is the call graph for this function:

◆ createContentPage()

ilObjLearningSequence::createContentPage ( LSOPageType $page_type )

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

                                                             : void
    {
        if ($this->hasContentPage($page_type)) {
            throw new \LogicException('will not create content page - it already exists.');
        }
        $new_page_object = $page_type === LSOPageType::INTRO ? new ilLSOIntroPage() : new ilLSOExtroPage();
        $new_page_object->setId($this->getContentPageId());
        $new_page_object->setParentId($this->getId());
        $new_page_object->createFromXML();
    }

References getContentPageId(), ilObject\getId(), and hasContentPage().

Referenced by cloneIntroAndExtroContentPages().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ delete()

ilObjLearningSequence::delete ( )

delete category and all related data

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

Reimplemented from ilContainer.

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

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

References ilParticipants\_deleteAllEntries(), 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 373 of file class.ilObjLearningSequence.php.

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

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

Here is the call graph for this function:

◆ getContentPageHTML()

ilObjLearningSequence::getContentPageHTML ( LSOPageType $page_type )

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

                                                              : string
    {
        if (!$this->hasContentPage($page_type)) {
            return '';
        }
 
        $gui = $page_type === LSOPageType::INTRO ?
            new ilObjLearningSequenceEditIntroGUI(LSOPageType::INTRO->value, $this->getContentPageId()) :
            new ilObjLearningSequenceEditExtroGUI(LSOPageType::EXTRO->value, $this->getContentPageId());
 
        $gui->setPresentationTitle("");
        $gui->setTemplateOutput(false);
        $gui->setHeader("");
        $ret = $gui->showPage();
        return $ret;
    }

References EXTRO, getContentPageId(), and hasContentPage().

Here is the call graph for this function:

◆ getContentPageId()

ilObjLearningSequence::getContentPageId ( )

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

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

References ilObject\getId().

Referenced by cloneIntroAndExtroContentPages(), createContentPage(), and getContentPageHTML().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getCurrentUserCurriculum()

ilObjLearningSequence::getCurrentUserCurriculum ( )

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

                                              : string
    {
        $dic = $this->getLocalDI();
        $curriculum = $dic["player.curriculumbuilder"]->getLearnerCurriculum(false);
        return $dic['ui.renderer']->render($curriculum);
    }

References $dic, and getLocalDI().

Here is the call graph for this function:

◆ getCurrentUserLaunchButtons()

ilObjLearningSequence::getCurrentUserLaunchButtons ( )

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

                                                 : string
    {
        $dic = $this->getLocalDI();
        $buttons = $dic["player.launchlinksbuilder"]->getLaunchbuttonsComponent();
        return $dic['ui.renderer']->render($buttons);
    }

References $dic, and getLocalDI().

Here is the call graph for this function:

◆ getDefaultAdminRole()

ilObjLearningSequence::getDefaultAdminRole ( )

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

                                         : int
    {
        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 ( string $a_grp_id = "" )

Returns: array<string, int>|[]

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

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

References getLSRoles().

Here is the call graph for this function:

◆ getDefaultMemberRole()

ilObjLearningSequence::getDefaultMemberRole ( )

Definition at line 547 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 264 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 $di, and getDIC().

Referenced by 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 259 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 74 of file class.ilObjLearningSequence.php.

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

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

Referenced by ilDashboardLearningSequenceGUI\confirmedRemove().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getLearnerProgressDB()

ilObjLearningSequence::getLearnerProgressDB ( )

protected

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

◆ getLocalDI()

ilObjLearningSequence::getLocalDI ( )

Definition at line 274 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 $di, $local_di, getDI(), and getDIC().

Referenced by getCurrentUserCurriculum(), getCurrentUserLaunchButtons(), 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 )

Returns: array<string, int>

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

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

References getLSRoles().

Here is the call graph for this function:

◆ getLPCompletionStates()

ilObjLearningSequence::getLPCompletionStates ( )

Returns: int[]

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

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

References ilLPStatus\LP_STATUS_COMPLETED_NUM.

◆ getLSAccess()

ilObjLearningSequence::getLSAccess ( )

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

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

References $ls_access.

◆ getLSItems()

ilObjLearningSequence::getLSItems ( )

Returns: LSItem[]

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

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

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

Here is the call graph for this function:

◆ getLSItemsDB()

ilObjLearningSequence::getLSItemsDB ( )

protected

Definition at line 312 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 )

Returns: LSLearnerItem[]

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

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

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

Here is the call graph for this function:

◆ getLSParticipants()

ilObjLearningSequence::getLSParticipants ( )

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

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

References $ls_participants, 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 421 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(), 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 297 of file class.ilObjLearningSequence.php.

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

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getMailToMembersType()

ilObjLearningSequence::getMailToMembersType ( )

Get mail to members type.

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

◆ getMembersObject()

ilObjLearningSequence::getMembersObject ( )

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

                                      : \ilLearningSequenceParticipants //used by Services/Membership/classes/class.ilMembershipGUI.php
    {
        return $this->getLSParticipants();
    }

References getLSParticipants().

Here is the call graph for this function:

◆ getObjectReferenceProperties()

ilObjLearningSequence::getObjectReferenceProperties ( )

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

                                                  : ?ObjectReferenceProperties
    {
        return $this->ref_props;
    }

References $ref_props.

Referenced by ilObjLearningSequenceSettingsGUI\buildFormElements().

Here is the caller graph for this function:

◆ getParentObjectInfo()

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

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

                                                                         : ?array
    {
        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 384 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, getPostConditionDB(), and ILIAS\Repository\lng().

Here is the call graph for this function:

◆ getPostConditionDB()

ilObjLearningSequence::getPostConditionDB ( )

protected

Definition at line 320 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 289 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 494 of file class.ilObjLearningSequence.php.

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

References getLSSettings().

Here is the call graph for this function:

◆ getStateDB()

ilObjLearningSequence::getStateDB ( )

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

◆ hasContentPage()

ilObjLearningSequence::hasContentPage ( LSOPageType $page_type )

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

                                                          : bool
    {
        return ilContainerPage::_exists($page_type->value, $this->getContentPageId());
    }

References ilPageObject\_exists().

Referenced by cloneIntroAndExtroContentPages(), createContentPage(), and getContentPageHTML().

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 set up default local roles you MUST overwrite this method in derived object classes (see ilObjForum for an example).

Reimplemented from ilObject.

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

                                      : void
    {
        $this->getLSRoles()->initDefaultRoles();
    }

References getLSRoles().

Here is the call graph for this function:

◆ raiseEvent()

ilObjLearningSequence::raiseEvent ( string $event_type )

protected

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

                                                     : void
    {
        $this->app_event_handler->raise(
            'components/ILIAS/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 ( )

Reimplemented from ilContainer.

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

                          : void
    {
        parent::read();
        $this->getLSSettings();
        try {
            $this->ref_props = $this->repo_ref_props->getFor($this->getRefId());
        } catch (\Exception $e) {
            $this->ref_props = $this->repo_ref_props->getFor(null);
            $this->repo_ref_props->storePropertyAvailabilityPeriod(
                $this->ref_props->getPropertyAvailabilityPeriod()
                    ->withObjectReferenceId($this->getRefId())
            );
        }
    }

References Vendor\Package\$e, getLSSettings(), and ilObject\getRefId().

Here is the call graph for this function:

◆ readMemberData()

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

Parameters

	array<int\|string>	$user_ids
string[]	$columns

Returns: array<int|string, array>

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

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

◆ setEffectiveOnlineStatus()

ilObjLearningSequence::setEffectiveOnlineStatus ( bool $status )

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

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

References ilObject\getRefId().

Here is the call graph for this function:

◆ storeAvailabilityPeriod()

ilObjLearningSequence::storeAvailabilityPeriod ( AvailabilityPeriod $period )

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

                                                                       : void
    {
        $this->repo_ref_props->storePropertyAvailabilityPeriod($period);
    }

Referenced by ilObjLearningSequenceSettingsGUI\update().

Here is the caller graph for this function:

◆ storeLSItems()

ilObjLearningSequence::storeLSItems ( array $ls_items )

Update LSItems.

Parameters

LSItem[]

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

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

References ilObject\$db, and getLSItemsDB().

Here is the call graph for this function:

◆ update()

ilObjLearningSequence::update ( )

Reimplemented from ilContainer.

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

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

References raiseEvent().

Referenced by ilObjLearningSequenceSettingsGUI\update().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ updateSettings()

ilObjLearningSequence::updateSettings ( ilLearningSequenceSettings $settings )

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

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

References getSettingsDB().

Referenced by cloneSettings(), and ilObjLearningSequenceSettingsGUI\update().

Here is the call graph for this function: