ilObjLearningModule Class Reference
Class ilObjLearningModule. More...
Inheritance diagram for ilObjLearningModule:
Collaboration diagram for ilObjLearningModule:
Public Member Functions | |
| __construct ($a_id=0, $a_call_by_reference=true) | |
| Constructor public. More... | |
| Public Member Functions inherited from ilObjContentObject | |
| __construct ($a_id=0, $a_call_by_reference=true) | |
| Constructor public. More... | |
| create ($a_no_meta_data=false) | |
| create content object More... | |
| read () | |
| read data of content object More... | |
| getTitle () | |
| get title of content object More... | |
| setTitle ($a_title) | |
| set title of content object More... | |
| getDescription () | |
| get description of content object More... | |
| setDescription ($a_description) | |
| set description of content object More... | |
| getImportId () | |
| setImportId ($a_id) | |
| setLayoutPerPage ($a_val) | |
| Set layout per page. More... | |
| getLayoutPerPage () | |
| Get layout per page. More... | |
| setDisableDefaultFeedback ($a_val) | |
| Set disable default feedback for questions. More... | |
| getDisableDefaultFeedback () | |
| Get disable default feedback for questions. More... | |
| setProgressIcons ($a_val) | |
| Set progress icons. More... | |
| getProgressIcons () | |
| Get progress icons. More... | |
| setStoreTries ($a_val) | |
| Set store tries. More... | |
| getStoreTries () | |
| Get store tries. More... | |
| setRestrictForwardNavigation ($a_val) | |
| Set restrict forward navigation. More... | |
| getRestrictForwardNavigation () | |
| Get restrict forward navigation. More... | |
| & | getTree () |
| update () | |
| update complete object (meta data and properties) More... | |
| updateAutoGlossaries () | |
| Update auto glossaries. More... | |
| import () | |
| if implemented, this function should be called from an Out/GUI-Object More... | |
| putInTree ($a_parent) | |
| put content object in main tree More... | |
| createLMTree () | |
| create content object tree (that stores structure object hierarchie) More... | |
| setAutoGlossaries ($a_val) | |
| Set auto glossaries. More... | |
| getAutoGlossaries () | |
| Get auto glossaries. More... | |
| removeAutoGlossary ($a_glo_id) | |
| Remove auto glossary. More... | |
| addFirstChapterAndPage () | |
| Add first chapter and page. More... | |
| setForTranslation ($a_val) | |
| Set for translation. More... | |
| getForTranslation () | |
| Get for translation. More... | |
| & | getLMTree () |
| get content object tree More... | |
| createImportDirectory () | |
| creates data directory for import files (data_dir/lm_data/lm_<id>/import, depending on data directory that is set in ILIAS setup/ini) More... | |
| getDataDirectory () | |
| get data directory More... | |
| getImportDirectory () | |
| get import directory of lm More... | |
| setImportDirectory ($a_import_dir) | |
| Set import directory for further use in ilContObjParser. More... | |
| createExportDirectory ($a_type="xml") | |
| creates data directory for export files (data_dir/lm_data/lm_<id>/export, depending on data directory that is set in ILIAS setup/ini) More... | |
| getExportDirectory ($a_type="xml") | |
| get export directory of lm More... | |
| delete () | |
| delete learning module and all related data More... | |
| getLayout () | |
| get default page layout of content object (see directory layouts/) More... | |
| setLayout ($a_layout) | |
| set default page layout More... | |
| getStyleSheetId () | |
| get ID of assigned style sheet object More... | |
| setStyleSheetId ($a_style_id) | |
| set ID of assigned style sheet object More... | |
| writeStyleSheetId ($a_style_id) | |
| write ID of assigned style sheet object to db More... | |
| getPageHeader () | |
| get page header mode (IL_CHAPTER_TITLE | IL_PAGE_TITLE | IL_NO_HEADER) More... | |
| setPageHeader ($a_pg_header=IL_CHAPTER_TITLE) | |
| set page header mode More... | |
| getTOCMode () | |
| get toc mode ("chapters" | "pages") More... | |
| getPublicAccessMode () | |
| get public access mode ("complete" | "selected") More... | |
| setTOCMode ($a_toc_mode="chapters") | |
| set toc mode More... | |
| setActiveLMMenu ($a_act_lm_menu) | |
| isActiveLMMenu () | |
| setActiveTOC ($a_toc) | |
| isActiveTOC () | |
| setActiveNumbering ($a_num) | |
| isActiveNumbering () | |
| setActivePrintView ($a_print) | |
| isActivePrintView () | |
| setActivePreventGlossaryAppendix ($a_print) | |
| isActivePreventGlossaryAppendix () | |
| setHideHeaderFooterPrint ($a_val) | |
| Set hide header footer in print mode. More... | |
| getHideHeaderFooterPrint () | |
| Get hide header footer in print mode. More... | |
| setActiveDownloads ($a_down) | |
| isActiveDownloads () | |
| setActiveDownloadsPublic ($a_down) | |
| isActiveDownloadsPublic () | |
| setPublicNotes ($a_pub_notes) | |
| publicNotes () | |
| setCleanFrames ($a_clean) | |
| cleanFrames () | |
| setHistoryUserComments ($a_comm) | |
| setPublicAccessMode ($a_mode) | |
| isActiveHistoryUserComments () | |
| setHeaderPage ($a_pg) | |
| getHeaderPage () | |
| setFooterPage ($a_pg) | |
| getFooterPage () | |
| readProperties () | |
| read content object properties More... | |
| updateProperties () | |
| Update content object properties. More... | |
| createProperties () | |
| create new properties record More... | |
| checkTree () | |
| fixTree () | |
| fix tree More... | |
| checkStructure () | |
| Check tree (this has been copied from fixTree due to a bug fixing, should be reorganised) More... | |
| exportXML (&$a_xml_writer, $a_inst, $a_target_dir, &$expLog) | |
| export object to xml (see ilias_co.dtd) More... | |
| exportXMLMetaData (&$a_xml_writer) | |
| export content objects meta data to xml (see ilias_co.dtd) More... | |
| exportXMLStructureObjects (&$a_xml_writer, $a_inst, &$expLog) | |
| export structure objects to xml (see ilias_co.dtd) More... | |
| exportXMLPageObjects (&$a_xml_writer, $a_inst, &$expLog) | |
| export page objects to xml (see ilias_co.dtd) More... | |
| exportXMLMediaObjects (&$a_xml_writer, $a_inst, $a_target_dir, &$expLog) | |
| export media objects to xml (see ilias_co.dtd) More... | |
| exportFileItems ($a_target_dir, &$expLog) | |
| export files of file itmes More... | |
| exportXMLProperties ($a_xml_writer, &$expLog) | |
| export properties of content object More... | |
| getExportFiles () | |
| get export files More... | |
| setPublicExportFile ($a_type, $a_file) | |
| specify public export file for type More... | |
| getPublicExportFile ($a_type) | |
| get public export file More... | |
| getOfflineFiles ($dir) | |
| get offline files More... | |
| exportSCORM ($a_target_dir, $log) | |
| export scorm package More... | |
| exportHTML ($a_target_dir, $log, $a_zip_file=true, $a_export_format="html", $a_lang="") | |
| export html package More... | |
| exportHTMLFile ($a_target_dir, $a_file_id) | |
| export file object More... | |
| exportHTMLMOB ($a_target_dir, &$a_lm_gui, $a_mob_id, $a_frame, &$a_linked_mobs) | |
| export media object to html More... | |
| exportHTMLGlossaryTerms (&$a_lm_gui, $a_target_dir) | |
| export glossary terms More... | |
| exportHTMLPages (&$a_lm_gui, $a_target_dir, $a_lang="", $a_all_languages=false) | |
| export all pages of learning module to html file More... | |
| exportPageHTML (&$a_lm_gui, $a_target_dir, $a_lm_page_id, $a_frame="", $a_exp_id_map=array(), $a_lang="-", $a_all_languages=false) | |
| export page html More... | |
| exportFO (&$a_xml_writer, $a_target_dir) | |
| export object to fo More... | |
| exportFOStructureObjects (&$a_xml_writer) | |
| export structure objects to fo More... | |
| getXMLZip () | |
| executeDragDrop ($source_id, $target_id, $first_child, $as_subitem=false, $movecopy="move") | |
| Execute Drag Drop Action. More... | |
| validatePages () | |
| Validate all pages. More... | |
| importFromZipFile ( $a_tmp_file, $a_filename, $a_validate=true, $a_import_into_help_module=0) | |
| Import lm from zip file. More... | |
| importFromDirectory ($a_directory, $a_validate=true, $a_mapping=null) | |
| Import lm from directory. More... | |
| cloneObject ($a_target_id, $a_copy_id=0, $a_omit_tree=false) | |
| Clone learning module. More... | |
| copyAllPagesAndChapters ($a_target_obj, $a_copy_id=0) | |
| Copy all pages and chapters. More... | |
| autoLinkGlossaryTerms ($a_glo_ref_id) | |
| Auto link glossary terms. More... | |
| setRating ($a_value) | |
| hasRating () | |
| setRatingPages ($a_value) | |
| hasRatingPages () | |
| MDUpdateListener ($a_element) | |
| getPublicExportFiles () | |
| Get public export files. 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... | |
Additional Inherited Members | |
| Static Public Member Functions inherited from ilObjContentObject | |
| static | writeHeaderPage ($a_lm_id, $a_page_id) |
| Write header page. More... | |
| static | writeFooterPage ($a_lm_id, $a_page_id) |
| Write footer page. More... | |
| static | _moveLMStyles ($a_from_style, $a_to_style) |
| move learning modules from one style to another More... | |
| static | _lookupRestrictForwardNavigation ($a_obj_id) |
| Lookup forward restriction navigation. More... | |
| static | _lookupStyleSheetId ($a_cont_obj_id) |
| lookup style sheet ID More... | |
| static | _lookupContObjIdByStyleId ($a_style_id) |
| lookup style sheet ID More... | |
| static | _lookupDisableDefaultFeedback ($a_id) |
| Lookup disable default feedback. More... | |
| static | _lookupStoreTries ($a_id) |
| Lookup disable default feedback. More... | |
| static | _getNrOfAssignedLMs ($a_style_id) |
| gets the number of learning modules assigned to a content style More... | |
| static | _getNrLMsIndividualStyles () |
| get number of learning modules with individual styles More... | |
| static | _getNrLMsNoStyle () |
| get number of learning modules assigned no style More... | |
| static | _deleteStyleAssignments ($a_style_id) |
| delete all style references to style More... | |
| static | getAvailableLayouts () |
| get all available lm layouts More... | |
| static | _checkPreconditionsOfPage ($cont_ref_id, $cont_obj_id, $page_id) |
| checks wether the preconditions of a page are fulfilled or not More... | |
| static | _getMissingPreconditionsOfPage ($cont_ref_id, $cont_obj_id, $page_id) |
| gets all missing preconditions of page More... | |
| static | _getMissingPreconditionsTopChapter ($cont_obj_ref_id, $cont_obj_id, $page_id) |
| get top chapter of page for that any precondition is missing More... | |
| static | hasSuccessorPage ($a_cont_obj_id, $a_page_id) |
| checks if page has a successor page More... | |
| static | getSupplyingExportFiles ($a_target_dir=".") |
| Get supplying export files. More... | |
| static | lookupAutoGlossaries ($a_lm_id) |
| Lookup auto glossaries. More... | |
| static | isOnlineHelpModule ($a_id, $a_as_obj_id=false) |
| Is module an online module. 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 inherited from ilObjContentObject | |
| $lm_tree | |
| $meta_data | |
| $layout | |
| $style_id | |
| $pg_header | |
| $online | |
| $for_translation = 0 | |
| $auto_glossaries = array() | |
| 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 | |
| Static Protected Member Functions inherited from ilObjContentObject | |
| static | _lookup ($a_obj_id, $a_field) |
| Lookup property. More... | |
| Protected Attributes inherited from ilObjContentObject | |
| $user | |
| $tpl | |
| $locator | |
| $rating | |
| $rating_pages | |
| $log | |
| Protected Attributes inherited from ilObject | |
| $objDefinition | |
| $db | |
| $log | |
| $error | |
| $tree | |
| $app_event_handler | |
| $rbacadmin | |
| $rbacreview | |
Detailed Description
Constructor & Destructor Documentation
◆ __construct()
| ilObjLearningModule::__construct | ( | $a_id = 0, |
|
$a_call_by_reference = true |
|||
| ) |
Constructor public.
Definition at line 22 of file class.ilObjLearningModule.php.
The documentation for this class was generated from the following file:
- Modules/LearningModule/classes/class.ilObjLearningModule.php
