ILIAS  release_5-4 Revision v5.4.26-12-gabc799a52e6
ilObjLearningSequence Class Reference

Class ilObjLearningSequence. More...

+ Inheritance diagram for ilObjLearningSequence:
+ Collaboration diagram for ilObjLearningSequence:

Public Member Functions

 __construct (int $id=0, bool $call_by_reference=true)
 
 read ()
 
 create ()
 
 update ()
 
 delete ()
 
 cloneObject ($target_id, $copy_id=0, $omit_tree=false)
 
 getLSActivation ()
 
 updateActivation (ilLearningSequenceActivation $settings)
 
 getLSFileSystem ()
 
 getLSSettings ()
 
 updateSettings (ilLearningSequenceSettings $settings)
 
 getLSParticipants ()
 
 getLSAccess ()
 
 getLSItems ()
 Get a list of LSItems. More...
 
 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)
 Get a list of LSLearnerItems. More...
 
 getLSRoles ()
 
 getCurrentItemForLearner (int $usr_id)
 Get ref-id of the last item the user touched. More...
 
 getCurriculumBuilder (array $items, LSUrlBuilder $url_builder=null)
 
 getUrlBuilder (string $player_url)
 
 getSequencePlayer ($gui, string $player_command, int $usr_id)
 factors the player More...
 
 getMailToMembersType ()
 Get mail to members type. More...
 
 getMembersObject ()
 
 isMember (int $usr_id)
 
 isCompletedByUser (int $usr_id)
 
 getShowMembers ()
 
 userMayUnparticipate ()
 
 userMayJoin ()
 
 announceLSOOnline ()
 
 announceLSOOffline ()
 
 setEffectiveOnlineStatus (bool $status)
 
 getLocalLearningSequenceRoles (bool $translate=false)
 
 getDefaultMemberRole ()
 
 getDefaultAdminRole ()
 
 addMember ($user_id, $mem_role)
 
 join (int $user_id)
 
 leaveLearningSequence ()
 
 getLearningSequenceMemberIds ()
 
 leave ($a_user_id)
 
 getLearningSequenceMemberData ($a_mem_ids, $active=1)
 
 getLearningSequenceAdminIds ($a_grpId="")
 
 getDefaultLearningSequenceRoles ($a_grp_id="")
 
 initDefaultRoles ()
 
 readMemberData (array $user_ids, array $columns=null)
 
 getParentObjectInfo (int $ref_id, array $search_types)
 
 getLPCompletionStates ()
 
- Public Member Functions inherited from ilContainer
 __construct ($a_id=0, $a_reference=true)
 
 getObjectTranslation ()
 Get object translation. More...
 
 setObjectTranslation (ilObjectTranslation $obj_trans)
 Get object translation. More...
 
 createContainerDirectory ()
 Create directory for the container. More...
 
 getContainerDirectory ()
 Get the container directory. More...
 
 setHiddenFilesFound ($a_hiddenfilesfound)
 Set Found hidden files (set by getSubItems). More...
 
 getHiddenFilesFound ()
 Get Found hidden files (set by getSubItems). More...
 
 getStyleSheetId ()
 get ID of assigned style sheet object More...
 
 setStyleSheetId ($a_style_id)
 set ID of assigned style sheet object More...
 
 setNewsTimeline ($a_val)
 Set news timeline. More...
 
 getNewsTimeline ()
 Get news timeline. More...
 
 setNewsTimelineAutoEntries ($a_val)
 Set news timeline auto entries. More...
 
 getNewsTimelineAutoEntries ()
 Get news timeline auto entries. More...
 
 setNewsTimelineLandingPage ($a_val)
 Set news timline is landing page. More...
 
 getNewsTimelineLandingPage ()
 Get news timline is landing page. More...
 
 isNewsTimelineEffective ()
 Is news timeline effective? More...
 
 isNewsTimelineLandingPageEffective ()
 Is news timeline landing page effective? More...
 
 setNewsBlockActivated ($a_val)
 Set news block activated. More...
 
 getNewsBlockActivated ()
 Get news block activated. More...
 
 setUseNews ($a_val)
 Set use news. More...
 
 getUseNews ()
 Get use news. More...
 
 cloneDependencies ($a_target_id, $a_copy_id)
 Clone object dependencies (container sorting) More...
 
 cloneAllObject ($session_id, $client_id, $new_type, $ref_id, $clone_source, $options, $soap_call=false, $a_submode=1)
 clone all objects according to this container More...
 
 delete ()
 delete category and all related data More...
 
 getViewMode ()
 Get container view mode. More...
 
 getOrderType ()
 Get order type default implementation. More...
 
 setOrderType ($a_value)
 
 getSubItems ($a_admin_panel_enabled=false, $a_include_side_block=false, $a_get_single=0)
 Get subitems of container. More...
 
 gotItems ()
 Check whether we got any items. More...
 
 addAdditionalSubItemInformation (&$object)
 Add additional information to sub item, e.g. More...
 
 getGroupedObjTypes ()
 Get grouped repository object types. More...
 
 enablePageEditing ()
 Check whether page editing is allowed for container. More...
 
 create ()
 Create. More...
 
 putInTree ($a_parent_ref)
 
 update ()
 Update. More...
 
 read ()
 read More...
 
 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 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 public More...
 
 setId ($a_id)
 set object id public More...
 
 setRefId ($a_id)
 set reference id public More...
 
 getRefId ()
 get reference id public More...
 
 getType ()
 get object type public More...
 
 setType ($a_type)
 set object type public More...
 
 getPresentationTitle ()
 get presentation title Normally same as title Overwritten for sessions More...
 
 getTitle ()
 get object title public More...
 
 getUntranslatedTitle ()
 get untranslated object title 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 public More...
 
 getLastUpdateDate ()
 get last update date 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...
 
 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) 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)
 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 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
 

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.

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

78  {
79  global $DIC;
80 
81  $this->type = self::OBJ_TYPE;
82  $this->lng = $DIC['lng'];
83  $this->ctrl = $DIC['ilCtrl'];
84  $this->user = $DIC['ilUser'];
85  $this->tree = $DIC['tree'];
86  $this->kiosk_mode_service = $DIC['service.kiosk_mode'];
87  $this->template = $DIC['tpl'];
88  $this->database = $DIC['ilDB'];
89  $this->log = $DIC["ilLoggerFactory"]->getRootLogger();
90  $this->rbacadmin = $DIC['rbacadmin'];
91  $this->rbacreview = $DIC['rbacreview'];
92  $this->app_event_handler = $DIC['ilAppEventHandler'];
93  $this->filesystem = $DIC['filesystem'];
94  $this->ilias = $DIC['ilias'];
95  $this->il_settings = $DIC['ilSetting'];
96  $this->il_news = $DIC->news();
97  $this->il_condition_handler = new ilConditionHandler();
98 
99  $this->data_factory = new \ILIAS\Data\Factory();
100 
101  parent::__construct($id, $call_by_reference);
102  }
global $DIC
Definition: saml.php:7
user()
Definition: user.php:4
redirection script todo: (a better solution should control the processing via a xml file) ...
INTERNAL CLASS: Please do not use in consumer code.
+ 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.

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

584  {
585  global $DIC;
586 
587  $ilAccess = $DIC['ilAccess'];
588  $ilErr = $DIC['ilErr'];
589  $lng = $DIC['lng'];
590  $ilUser = $DIC['ilUser'];
591 
592  if (substr($add, 0, 5) == 'rcode') {
593  if ($ilUser->getId() == ANONYMOUS_USER_ID) {
594  // Redirect to login for anonymous
596  "login.php?target=" . $_GET["target"] . "&cmd=force_login&lang=" .
597  $ilUser->getCurrentLanguage()
598  );
599  }
600 
601  // Redirects to target location after assigning user to learning sequence
603  $target,
605  substr($add, 5)
606  );
607  }
608 
609  if ($add == "mem" && $ilAccess->checkAccess("manage_members", "", $target)) {
611  }
612 
613  if ($ilAccess->checkAccess("read", "", $target)) {
615  } else {
616  // to do: force flat view
617  if ($ilAccess->checkAccess("visible", "", $target)) {
618  ilObjectGUI::_gotoRepositoryNode($target, "infoScreenGoto");
619  } else {
620  if ($ilAccess->checkAccess("read", "", ROOT_FOLDER_ID)) {
622  sprintf(
623  $lng->txt("msg_no_perm_read_item"),
625  ),
626  true
627  );
629  }
630  }
631  }
632 
633  $ilErr->raiseError($lng->txt("msg_no_perm_read"), $ilErr->FATAL);
634  }
global $DIC
Definition: saml.php:7
$_GET["client_id"]
static _gotoRepositoryRoot($a_raise_error=false)
Goto repository root.
static _lookupTitle($a_id)
lookup object title
static handleCode($a_ref_id, $a_type, $a_code)
Handle target parameter.
$ilErr
Definition: raiseError.php:18
static _gotoRepositoryNode($a_ref_id, $a_cmd="frameset")
Goto repository root.
static _lookupObjId($a_id)
$ilUser
Definition: imgupload.php:18
static _lookupType($a_id, $a_reference=false)
lookup object type
static sendFailure($a_info="", $a_keep=false)
Send Failure Message to Screen.
static redirect($a_script)
$target
Definition: test.php:19
+ Here is the call graph for this function:

◆ addMember()

ilObjLearningSequence::addMember (   $user_id,
  $mem_role 
)

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

References getLSRoles().

712  : bool
713  {
714  return $this->getLSRoles()->addLSMember($user_id, $mem_role);
715  }
+ Here is the call graph for this function:

◆ announceLSOOffline()

ilObjLearningSequence::announceLSOOffline ( )

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

682  {
683  //NYI
684  }

◆ announceLSOOnline()

ilObjLearningSequence::announceLSOOnline ( )

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

References $context, and ilObject\getRefId().

671  {
672  $ns = $this->il_news;
673  $context = $ns->contextForRefId((int) $this->getRefId());
674  $item = $ns->item($context);
675  $item->setContentIsLangVar(true);
676  $item->setContentTextIsLangVar(true);
677  $item->setTitle("lso_news_online_title");
678  $item->setContent("lso_news_online_txt");
679  $news_id = $ns->data()->save($item);
680  }
$context
Definition: webdav.php:25
getRefId()
get reference id public
+ Here is the call graph for this function:

◆ cloneAutoGeneratedRoles()

ilObjLearningSequence::cloneAutoGeneratedRoles ( ilObjLearningSequence  $new_obj)
protected

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

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

Referenced by cloneObject().

182  : bool
183  {
184  $admin = $this->getDefaultAdminRole();
185  $new_admin = $new_obj->getDefaultAdminRole();
186 
187  if (!$admin || !$new_admin || !$this->getRefId() || !$new_obj->getRefId()) {
188  $this->log->write(__METHOD__ . ' : Error cloning auto generated role: il_lso_admin');
189  }
190 
191  $this->rbacadmin->copyRolePermissions($admin, $this->getRefId(), $new_obj->getRefId(), $new_admin, true);
192  $this->log->write(__METHOD__ . ' : Finished copying of role lso_admin.');
193 
194  $member = $this->getDefaultMemberRole();
195  $new_member = $new_obj->getDefaultMemberRole();
196 
197  if (!$member || !$new_member) {
198  $this->log->write(__METHOD__ . ' : Error cloning auto generated role: il_lso_member');
199  }
200 
201  $this->rbacadmin->copyRolePermissions($member, $this->getRefId(), $new_obj->getRefId(), $new_member, true);
202  $this->log->write(__METHOD__ . ' : Finished copying of role lso_member.');
203 
204  return true;
205  }
getRefId()
get reference id public
+ 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.

References ilObject\getId().

Referenced by cloneObject().

231  {
232  $lp_settings = new ilLPObjSettings($this->getId());
233  $lp_settings->cloneSettings($obj_id);
234  }
getId()
get object id public
+ 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.

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

168  {
169  $new_obj = parent::cloneObject($target_id, $copy_id, $omit_tree);
170 
171  $this->cloneAutoGeneratedRoles($new_obj);
172  $this->cloneMetaData($new_obj);
173  $this->cloneSettings($new_obj);
174  $this->cloneLPSettings((int) $new_obj->getId());
175 
176  $new_obj->addMember((int) $this->user->getId(), $new_obj->getDefaultAdminRole());
177 
178  return $new_obj;
179  }
cloneAutoGeneratedRoles(ilObjLearningSequence $new_obj)
cloneSettings(ilObjLearningSequence $new_obj)
$target_id
Definition: goto.php:49
user()
Definition: user.php:4
cloneMetaData($target_obj)
Copy meta data.
+ Here is the call graph for this function:

◆ cloneSettings()

ilObjLearningSequence::cloneSettings ( ilObjLearningSequence  $new_obj)
protected

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

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

Referenced by cloneObject().

208  {
209  $source = $this->getLSSettings();
210  $target = $new_obj->getLSSettings();
211 
212  foreach ($source->getUploads() as $key => $upload_info) {
213  $target = $target->withUpload($upload_info, $key);
214  }
215 
216  foreach ($source->getDeletions() as $deletion) {
217  $target = $target->withDeletion($deletion);
218  }
219 
220  $target = $target
221  ->withAbstract($source->getAbstract())
222  ->withExtro($source->getExtro())
223  ->withAbstractImage($source->getAbstractImage())
224  ->withExtroImage($source->getExtroImage())
225  ;
226 
227  $new_obj->updateSettings($target);
228  }
updateSettings(ilLearningSequenceSettings $settings)
$source
Definition: linkback.php:22
$target
Definition: test.php:19
$key
Definition: croninfo.php:18
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ create()

ilObjLearningSequence::create ( )

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

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

118  : int
119  {
120  $id = parent::create();
121  if (!$id) {
122  return 0;
123  }
124  $this->raiseEvent(self::E_CREATE);
125 
126  return (int) $this->getId();
127  }
getId()
get object id public
+ Here is the call graph for this function:

◆ delete()

ilObjLearningSequence::delete ( )

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

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

139  : bool
140  {
141  if (!parent::delete()) {
142  return false;
143  }
144 
146  $this->getSettingsDB()->delete((int) $this->getId());
147  $this->getStateDB()->deleteFor((int) $this->getRefId());
148  $this->getActivationDB()->deleteForRefId((int) $this->getRefId());
149 
150  $this->raiseEvent(self::E_DELETE);
151 
152  return true;
153  }
static _deleteAllEntries($a_obj_id)
Delete all entries Normally called for course deletion.
getId()
get object id public
getRefId()
get reference id public
+ 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.

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

376  {
377  $rep_utils = new ilRepUtil();
378  $rep_utils->deleteObjects($this->getRefId(), $ref_ids);
379  $db = $this->getPostConditionDB();
380  $db->delete($ref_ids);
381  }
Repository Utilities (application layer, put GUI related stuff into ilRepUtilGUI) ...
getRefId()
get reference id public
+ Here is the call graph for this function:

◆ getActivationDB()

ilObjLearningSequence::getActivationDB ( )
protected

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

References $activation_db.

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

249  {
250  if (!$this->activation_db) {
251  $this->activation_db = new ilLearningSequenceActivationDB(
252  $this->database
253  );
254  }
255  return $this->activation_db;
256  }
Persistence for online/activation period.
+ 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.

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

448  : int
449  {
450  $db = $this->getStateDB();
451  $current = $db->getCurrentItemsFor($this->getRefId(), [$usr_id]);
452  $ref_id = $current[$usr_id];
453 
454  if ($ref_id < 0) {
455  $ref_id = 0;
456  }
457 
458  return $ref_id;
459  }
getRefId()
get reference id public
+ 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.

References $DIC, and ilLSPlayer\LSO_CMD_GOTO.

Referenced by getSequencePlayer().

465  {
466  global $DIC;
467 
468  return new ilLSCurriculumBuilder(
469  $items,
470  $DIC["ui.factory"],
471  $this->lng,
473  $url_builder
474  );
475  }
global $DIC
Definition: saml.php:7
Builds the overview (curriculum) of a LearningSequence.
+ Here is the caller graph for this function:

◆ getDefaultAdminRole()

ilObjLearningSequence::getDefaultAdminRole ( )

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

References getLSRoles().

Referenced by cloneAutoGeneratedRoles().

708  {
709  return $this->getLSRoles()->getDefaultAdminRole();
710  }
+ 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.

References getLSRoles().

749  {
750  return $this->getLSRoles()->getDefaultLearningSequenceRoles($a_grp_id);
751  }
+ Here is the call graph for this function:

◆ getDefaultMemberRole()

ilObjLearningSequence::getDefaultMemberRole ( )

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

References getLSRoles().

Referenced by cloneAutoGeneratedRoles(), and join().

702  : int
703  {
704  return $this->getLSRoles()->getDefaultMemberRole();
705  }
+ 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.

References ilContainer\$db.

Referenced by getSequencePlayer().

484  {
485  $db = new ilLSGlobalSettingsDB($this->il_settings);
486  return $db->getSettings();
487  }
Global Settings of the Learning Sequence.
Repository for LSGlobalSettings over ILIAS global settings.
+ 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.

References ilObjectFactory\getInstanceByRefId().

Referenced by ilObjLearningSequenceGUI\getObject().

105  {
107  }
static getInstanceByRefId($a_ref_id, $stop_on_error=true)
get an instance of an Ilias object by reference id
+ 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.

References $DIC.

Referenced by getSequencePlayer().

541  {
542  if (!$this->kiosk_renderer) {
543  global $DIC;
544 
545  $kiosk_template = new ilTemplate("tpl.kioskpage.html", true, true, 'Modules/LearningSequence');
546 
547  $toc_gui = new ilLSTOCGUI($url_builder, $this->ctrl);
548  $loc_gui = new ilLSLocatorGUI($url_builder, $DIC["ui.factory"]);
549 
550  $window_title = $this->il_settings->get('short_inst_name');
551  if ($window_title === false) {
552  $window_title = 'ILIAS';
553  }
554 
555  $this->kiosk_renderer = new ilKioskPageRenderer(
556  $this->template,
557  $DIC["ui.renderer"],
558  $kiosk_template,
559  $toc_gui,
560  $loc_gui,
561  $window_title
562  );
563  }
564 
565  return $this->kiosk_renderer;
566  }
global $DIC
Definition: saml.php:7
Class ilKioskPageRenderer.
special template class to simplify handling of ITX/PEAR
GUI for Locator element.
Tree-GUI for ToC.
+ Here is the caller graph for this function:

◆ getLearnerProgressDB()

ilObjLearningSequence::getLearnerProgressDB ( )
protected

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

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

Referenced by getLSLearnerItems().

399  {
400  if (!$this->learner_progress_db) {
401  $state_db = $this->getStateDB();
402  $this->learner_progress_db = new ilLearnerProgressDB(
403  $state_db,
404  $this->access
405  );
406  }
407 
409  }
Get LearningProgress and availability of items in sequence.
+ 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.

References getLSRoles().

744  {
745  return $this->getLSRoles()->getLearningSequenceAdminIds();
746  }
+ 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.

References getLSRoles().

739  {
740  return $this->getLSRoles()->getLearningSequenceMemberData($a_mem_ids, $active);
741  }
+ Here is the call graph for this function:

◆ getLearningSequenceMemberIds()

ilObjLearningSequence::getLearningSequenceMemberIds ( )

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

References getLSRoles().

729  {
730  return $this->getLSRoles()->getLearningSequenceMemberIds();
731  }
+ Here is the call graph for this function:

◆ getLocalLearningSequenceRoles()

ilObjLearningSequence::getLocalLearningSequenceRoles ( bool  $translate = false)

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

References getLSRoles().

697  : array
698  {
699  return $this->getLSRoles()->getLocalLearningSequenceRoles($translate);
700  }
+ Here is the call graph for this function:

◆ getLPCompletionStates()

ilObjLearningSequence::getLPCompletionStates ( )

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

References ilLPStatus\LP_STATUS_COMPLETED_NUM.

773  : array
774  {
775  return [
777  ];
778  }
const LP_STATUS_COMPLETED_NUM

◆ getLSAccess()

ilObjLearningSequence::getLSAccess ( )

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

344  {
345  if (is_null($this->ls_access)) {
346  $this->ls_access = new ilObjLearningSequenceAccess();
347  }
348 
349  return $this->ls_access;
350  }
Class ilObjLearningSequenceAccess class.

◆ getLSActivation()

ilObjLearningSequence::getLSActivation ( )

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

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

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

259  {
260  if (!$this->ls_activation) {
261  $this->ls_activation = $this->getActivationDB()->getActivationForRefId((int) $this->getRefId());
262  }
263 
264  return $this->ls_activation;
265  }
getRefId()
get reference id public
+ 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.

References $ls_file_system.

Referenced by getSettingsDB().

274  {
275  if (!$this->ls_file_system) {
276  $this->ls_file_system = new ilLearningSequenceFilesystem();
277  }
278  return $this->ls_file_system;
279  }
+ Here is the caller graph for this function:

◆ getLSItemOnlineStatus()

ilObjLearningSequence::getLSItemOnlineStatus ( )
protected

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

References $ls_item_online_status.

Referenced by getLSItemsDB().

320  {
321  if (!$this->ls_item_online_status) {
322  $this->ls_item_online_status = new LSItemOnlineStatus();
323  }
324 
326  }
+ 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.

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

Referenced by getLSLearnerItems().

355  : array
356  {
357  $db = $this->getLSItemsDB();
358  return $db->getLSItems((int) $this->getRefId());
359  }
getRefId()
get reference id public
+ 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.

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

Referenced by getLSItems(), and storeLSItems().

296  : ilLSItemsDB
297  {
298  if (!$this->items_db) {
299  $this->items_db = new ilLSItemsDB(
300  $this->tree,
302  $this->getPostConditionDB(),
303  $this->getLSItemOnlineStatus()
304  );
305  }
306 
307  return $this->items_db;
308  }
Class ilLSItemsDB.
Definition: ilLSItemsDB.php:11
getId()
get object id public
static _getInstance($a_obj_id)
get instance by obj_id
+ 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.

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

Referenced by getSequencePlayer().

423  : array
424  {
425  $db = $this->getLearnerProgressDB();
426  return $db->getLearnerItems($usr_id, $this->getRefId(), $this->getLSItems());
427  }
getLSItems()
Get a list of LSItems.
getRefId()
get reference id public
+ 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.

References $ls_participant, and ilObject\getId().

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

329  {
330  if (!$this->ls_participant) {
331  $this->ls_participant = new ilLearningSequenceParticipants(
332  (int) $this->getId(),
333  $this->log,
334  $this->app_event_handler,
335  $this->il_settings
336  );
337  }
338 
339  return $this->ls_participant;
340  }
getId()
get object id public
+ 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.

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

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

430  {
431  if (!$this->ls_roles) {
432  $this->ls_roles = new ilLearningSequenceRoles(
433  $this,
434  $this->getLSParticipants(),
435  $this->ctrl,
436  $this->rbacadmin,
437  $this->rbacreview,
438  $this->database,
439  $this->user
440  );
441  }
442  return $this->ls_roles;
443  }
user()
Definition: user.php:4
+ 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.

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

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

282  {
283  if (!$this->ls_settings) {
284  $this->ls_settings = $this->getSettingsDB()->getSettingsFor((int) $this->getId());
285  }
286 
287  return $this->ls_settings;
288  }
Settings for an LSO (like abstract, extro)
getId()
get object id public
+ 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.

573  {
574  return $this->mail_members;
575  }

◆ getMembersObject()

ilObjLearningSequence::getMembersObject ( )

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

References getLSParticipants().

637  {
638  return $this->getLSParticipants();
639  }
+ 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.

764  {
765  foreach ($this->tree->getPathFull($ref_id) as $hop) {
766  if (in_array($hop['type'], $search_types)) {
767  return $hop;
768  }
769  }
770  return null;
771  }

◆ getPossiblePostConditionsForType()

ilObjLearningSequence::getPossiblePostConditionsForType ( string  $type)
Returns
array<"value" => "option_text">

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

386  : array
387  {
388  $condition_types = $this->il_condition_handler->getOperatorsByTriggerType($type);
389  $conditions = [
390  $this->conditions_db::STD_ALWAYS_OPERATOR => $this->lng->txt('condition_always')
391  ];
392  foreach ($condition_types as $cond_type) {
393  $conditions[$cond_type] = $this->lng->txt($cond_type);
394  }
395  return $conditions;
396  }

◆ getPostConditionDB()

ilObjLearningSequence::getPostConditionDB ( )
protected

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

References $conditions_db.

Referenced by deletePostConditionsForSubObjects(), and getLSItemsDB().

311  {
312  if (!$this->conditions_db) {
313  $this->conditions_db = new ilLSPostConditionDB($this->database);
314  }
315 
316  return $this->conditions_db;
317  }
Storage for ilLSPostConditions.
+ 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.

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

492  : ilLSPlayer
493  {
494  global $DIC;
495 
496  $lso_ref_id = $this->getRefId();
497  $lso_title = $this->getTitle();
498 
499  $player_url = $this->ctrl->getLinkTarget($gui, $player_command, '', false, false);
500  $items = $this->getLSLearnerItems($usr_id);
501  $url_builder = $this->getUrlBuilder($player_url);
502 
503  $curriculum_builder = $this->getCurriculumBuilder(
504  $items,
505  $url_builder
506  );
507 
508  $global_settings = $this->getGlobalSettings();
509  $control_builder = new LSControlBuilder(
510  $DIC["ui.factory"],
511  $url_builder,
512  $this->lng,
513  $global_settings
514  );
515 
516  $view_factory = new ilLSViewFactory(
517  $this->kiosk_mode_service,
518  $this->lng,
519  $this->access
520  );
521 
522  $state_db = $this->getStateDB();
523  $kiosk_renderer = $this->getKioskRenderer($url_builder);
524 
525  return new ilLSPlayer(
526  $lso_ref_id,
527  $lso_title,
528  $usr_id,
529  $items,
530  $state_db,
531  $control_builder,
532  $url_builder,
533  $curriculum_builder,
534  $view_factory,
535  $kiosk_renderer,
536  $DIC["ui.factory"]
537  );
538  }
global $DIC
Definition: saml.php:7
getCurriculumBuilder(array $items, LSUrlBuilder $url_builder=null)
getTitle()
get object title public
getLSLearnerItems(int $usr_id)
Get a list of LSLearnerItems.
getKioskRenderer(LSUrlBuilder $url_builder)
Implementation of KioskMode Player.
Class LSControlBuilder.
getRefId()
get reference id public
+ Here is the call graph for this function:

◆ getSettingsDB()

ilObjLearningSequence::getSettingsDB ( )
protected

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

References $settings_db, and getLSFileSystem().

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

237  {
238  if (!$this->settings_db) {
239  $fs = $this->getLSFileSystem();
240  $this->settings_db = new ilLearningSequenceSettingsDB(
241  $this->database,
242  $fs
243  );
244  }
245  return $this->settings_db;
246  }
Persistence for Settings (like abstract, extro)
+ 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.

References getLSSettings().

656  {
657  return $this->getLSSettings()->getMembersGallery();
658  }
+ Here is the call graph for this function:

◆ getStateDB()

ilObjLearningSequence::getStateDB ( )

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

References $state_db.

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

411  : ilLSStateDB
412  {
413  if (!$this->state_db) {
414  $this->state_db = new ilLSStateDB($this->database);
415  }
416 
417  return $this->state_db;
418  }
Persistence for View-States.
+ Here is the caller graph for this function:

◆ getUrlBuilder()

ilObjLearningSequence::getUrlBuilder ( string  $player_url)

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

Referenced by getSequencePlayer().

477  : LSUrlBuilder
478  {
479  $player_url = $this->data_factory->uri(ILIAS_HTTP_PATH . '/' . $player_url);
480  return new LSUrlBuilder($player_url);
481  }
Class LSUrlBuilder.
+ Here is the caller graph for this function:

◆ initDefaultRoles()

ilObjLearningSequence::initDefaultRoles ( )

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

References getLSRoles().

754  {
755  return $this->getLSRoles()->initDefaultRoles();
756  }
+ Here is the call graph for this function:

◆ isCompletedByUser()

ilObjLearningSequence::isCompletedByUser ( int  $usr_id)

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

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

647  : bool
648  {
649  \ilLPStatusWrapper::_updateStatus($this->getId(), $usr_id);
650  $tracking_active = ilObjUserTracking::_enabledLearningProgress();
651  $user_completion = ilLPStatus::_hasUserCompleted($this->getId(), $usr_id);
652  return ($tracking_active && $user_completion);
653  }
static _updateStatus($a_obj_id, $a_usr_id, $a_obj=null, $a_percentage=false, $a_force_raise=false)
Update status.
static _enabledLearningProgress()
check wether learing progress is enabled or not
getId()
get object id public
static _hasUserCompleted($a_obj_id, $a_user_id)
Lookup user object completion.
+ Here is the call graph for this function:

◆ isMember()

ilObjLearningSequence::isMember ( int  $usr_id)

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

References getLSParticipants().

642  {
643  $part = $this->getLSParticipants();
644  return $part->isMember($usr_id);
645  }
+ Here is the call graph for this function:

◆ join()

ilObjLearningSequence::join ( int  $user_id)

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

References getDefaultMemberRole(), and getLSRoles().

718  {
719  $member_role = $this->getDefaultMemberRole();
720  return $this->getLSRoles()->join($user_id, $member_role);
721  }
+ Here is the call graph for this function:

◆ leave()

ilObjLearningSequence::leave (   $a_user_id)

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

References getLSRoles().

734  {
735  return $this->getLSRoles()->leave($a_user_id);
736  }
+ Here is the call graph for this function:

◆ leaveLearningSequence()

ilObjLearningSequence::leaveLearningSequence ( )

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

References getLSRoles().

724  {
725  return $this->getLSRoles()->leaveLearningSequence();
726  }
+ Here is the call graph for this function:

◆ raiseEvent()

ilObjLearningSequence::raiseEvent ( string  $event_type)
protected

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

References ilObject\getId().

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

156  {
157  $this->app_event_handler->raise(
158  'Modules/LearningSequence',
159  $event_type,
160  array(
161  'obj_id' => $this->getId(),
162  'appointments' => null
163  )
164  );
165  }
getId()
get object id public
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ read()

ilObjLearningSequence::read ( )

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

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

110  {
111  $this->getLSSettings();
112  if ($this->getRefId()) {
113  $this->getLSActivation();
114  }
115  parent::read();
116  }
getRefId()
get reference id public
+ 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.

References $columns.

759  {
760  return $this->getLsRoles()->readMemberData($user_ids, $columns);
761  }
if(! $in) $columns
Definition: Utf8Test.php:45

◆ setEffectiveOnlineStatus()

ilObjLearningSequence::setEffectiveOnlineStatus ( bool  $status)

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

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

687  {
688  $act_db = $this->getActivationDB();
689  $act_db->setEffectiveOnlineStatus((int) $this->getRefId(), $status);
690  }
getRefId()
get reference id public
+ 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.

References ilContainer\$db, and getLSItemsDB().

366  {
367  $db = $this->getLSItemsDB();
368  $db->storeItems($ls_items);
369  }
+ Here is the call graph for this function:

◆ update()

ilObjLearningSequence::update ( )

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

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

129  : bool
130  {
131  if (!parent::update()) {
132  return false;
133  }
134  $this->raiseEvent(self::E_UPDATE);
135 
136  return true;
137  }
update($pash, $contents, Config $config)
+ Here is the call graph for this function:

◆ updateActivation()

ilObjLearningSequence::updateActivation ( ilLearningSequenceActivation  $settings)

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

References getActivationDB().

268  {
269  $this->getActivationDB()->store($settings);
270  $this->ls_activation = $settings;
271  }
+ Here is the call graph for this function:

◆ updateSettings()

ilObjLearningSequence::updateSettings ( ilLearningSequenceSettings  $settings)

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

References getSettingsDB().

Referenced by cloneSettings().

291  {
292  $this->getSettingsDB()->store($settings);
293  $this->ls_settings = $settings;
294  }
+ 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.

References ilObject\getRefId().

665  : bool
666  {
667  return $this->access->checkAccess('participate', '', $this->getRefId());
668  }
getRefId()
get reference id public
+ Here is the call graph for this function:

◆ userMayUnparticipate()

ilObjLearningSequence::userMayUnparticipate ( )

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

References ilObject\getRefId().

660  : bool
661  {
662  return $this->access->checkAccess('unparticipate', '', $this->getRefId());
663  }
getRefId()
get reference id public
+ 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

◆ 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'

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