| ILIAS
    Release_4_1_x_branch Revision 61804
    | 
Class ilObjDlBook. More...
 Inheritance diagram for ilObjDlBook:
 Inheritance diagram for ilObjDlBook: Collaboration diagram for ilObjDlBook:
 Collaboration diagram for ilObjDlBook:| Public Member Functions | |
| ilObjDlBook ($a_id=0, $a_call_by_reference=true) | |
| Constructor  public. | |
| initBibItemObject () | |
| init bib object (contains all bib item data) | |
| exportRekursiv ($obj_id, $depth, $left, $right) | |
| export lm_data-table to xml-structure | |
| export ($a_deliver=true) | |
| exports the digi-lib-object into a xml structure | |
| addTranslation ($a_ref_id) | |
| addTranslations ($a_arr_ref_id) | |
| deleteTranslation ($a_ref_id) | |
| deleteTranslations ($a_arr_ref_id) | |
| getTranslations () | |
| getXMLZip () | |
| readAssignedTranslations () | |
|  Public Member Functions inherited from ilObjContentObject | |
| ilObjContentObject ($a_id=0, $a_call_by_reference=true) | |
| Constructor  public. | |
| create ($a_upload=false) | |
| create content object | |
| initDefaultRoles () | |
| init default roles settings OBSOLETE. | |
| read () | |
| read data of content object | |
| getTitle () | |
| get title of content object | |
| setTitle ($a_title) | |
| set title of content object | |
| getDescription () | |
| get description of content object | |
| setDescription ($a_description) | |
| set description of content object | |
| getImportId () | |
| get import id | |
| setImportId ($a_id) | |
| set import id | |
| setLayoutPerPage ($a_val) | |
| Set layout per page. | |
| getLayoutPerPage () | |
| Get layout per page. | |
| & | getTree () | 
| update () | |
| update complete object (meta data and properties) | |
| import () | |
| if implemented, this function should be called from an Out/GUI-Object | |
| putInTree ($a_parent) | |
| put content object in main tree | |
| createLMTree () | |
| create content object tree (that stores structure object hierarchie) | |
| & | getLMTree () | 
| get content object tree | |
| 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) | |
| getDataDirectory () | |
| get data directory | |
| getImportDirectory () | |
| get import directory of lm | |
| setImportDirectory ($a_import_dir) | |
| Set import directory for further use in ilContObjParser. | |
| 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) | |
| getExportDirectory ($a_type="xml") | |
| get export directory of lm | |
| delete () | |
| delete learning module and all related data | |
| getLayout () | |
| get default page layout of content object (see directory layouts/) | |
| setLayout ($a_layout) | |
| set default page layout | |
| getStyleSheetId () | |
| get ID of assigned style sheet object | |
| setStyleSheetId ($a_style_id) | |
| set ID of assigned style sheet object | |
| writeStyleSheetId ($a_style_id) | |
| write ID of assigned style sheet object to db | |
| _moveLMStyles ($a_from_style, $a_to_style) | |
| move learning modules from one style to another | |
| _lookupStyleSheetId ($a_cont_obj_id) | |
| lookup style sheet ID | |
| _lookupContObjIdByStyleId ($a_style_id) | |
| lookup style sheet ID | |
| _getNrOfAssignedLMs ($a_style_id) | |
| gets the number of learning modules assigned to a content style | |
| _getNrLMsIndividualStyles () | |
| get number of learning modules with individual styles | |
| _getNrLMsNoStyle () | |
| get number of learning modules assigned no style | |
| _deleteStyleAssignments ($a_style_id) | |
| delete all style references to style | |
| getPageHeader () | |
| get page header mode (IL_CHAPTER_TITLE | IL_PAGE_TITLE | IL_NO_HEADER) | |
| setPageHeader ($a_pg_header=IL_CHAPTER_TITLE) | |
| set page header mode | |
| getTOCMode () | |
| get toc mode ("chapters" | "pages") | |
| getPublicAccessMode () | |
| get public access mode ("complete" | "selected") | |
| setTOCMode ($a_toc_mode="chapters") | |
| set toc mode | |
| setOnline ($a_online) | |
| getOnline () | |
| setActiveLMMenu ($a_act_lm_menu) | |
| isActiveLMMenu () | |
| setActiveTOC ($a_toc) | |
| isActiveTOC () | |
| setActiveNumbering ($a_num) | |
| isActiveNumbering () | |
| setActivePrintView ($a_print) | |
| isActivePrintView () | |
| setActivePreventGlossaryAppendix ($a_print) | |
| isActivePreventGlossaryAppendix () | |
| 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 | |
| updateProperties () | |
| Update content object properties. | |
| createProperties () | |
| create new properties record | |
| _lookupOnline ($a_id) | |
| check wether content object is online | |
| getAvailableLayouts () | |
| get all available lm layouts | |
| _checkPreconditionsOfPage ($cont_ref_id, $cont_obj_id, $page_id) | |
| checks wether the preconditions of a page are fulfilled or not | |
| _getMissingPreconditionsOfPage ($cont_ref_id, $cont_obj_id, $page_id) | |
| gets all missing preconditions of page | |
| _getMissingPreconditionsTopChapter ($cont_obj_ref_id, $cont_obj_id, $page_id) | |
| get top chapter of page for that any precondition is missing | |
| notify ($a_event, $a_ref_id, $a_parent_non_rbac_id, $a_node_id, $a_params=0) | |
| notifys an object about an event occured Based on the event happend, each object may decide how it reacts. | |
| hasSuccessorPage ($a_cont_obj_id, $a_page_id) | |
| checks if page has a successor page | |
| checkTree () | |
| fixTree () | |
| fix tree | |
| exportXML (&$a_xml_writer, $a_inst, $a_target_dir, &$expLog) | |
| export object to xml (see ilias_co.dtd) | |
| exportXMLMetaData (&$a_xml_writer) | |
| export content objects meta data to xml (see ilias_co.dtd) | |
| exportXMLStructureObjects (&$a_xml_writer, $a_inst, &$expLog) | |
| export structure objects to xml (see ilias_co.dtd) | |
| exportXMLPageObjects (&$a_xml_writer, $a_inst, &$expLog) | |
| export page objects to xml (see ilias_co.dtd) | |
| exportXMLMediaObjects (&$a_xml_writer, $a_inst, $a_target_dir, &$expLog) | |
| export media objects to xml (see ilias_co.dtd) | |
| exportFileItems ($a_target_dir, &$expLog) | |
| export files of file itmes | |
| exportXMLProperties ($a_xml_writer, &$expLog) | |
| export properties of content object | |
| getExportFiles () | |
| get export files | |
| setPublicExportFile ($a_type, $a_file) | |
| specify public export file for type | |
| getPublicExportFile ($a_type) | |
| get public export file | |
| getOfflineFiles ($dir) | |
| get offline files | |
| exportSCORM ($a_target_dir, $log) | |
| export scorm package | |
| exportHTML ($a_target_dir, $log, $a_zip_file=true, $a_export_format="html") | |
| export html package | |
| exportHTMLFile ($a_target_dir, $a_file_id) | |
| export file object | |
| exportHTMLMOB ($a_target_dir, &$a_lm_gui, $a_mob_id, $a_frame, &$a_linked_mobs) | |
| export media object to html | |
| exportHTMLGlossaryTerms (&$a_lm_gui, $a_target_dir) | |
| export glossary terms | |
| exportHTMLPages (&$a_lm_gui, $a_target_dir) | |
| export all pages of learning module to html file | |
| exportPageHTML (&$a_lm_gui, $a_target_dir, $a_lm_page_id, $a_frame="") | |
| export page html | |
| exportFO (&$a_xml_writer, $a_target_dir) | |
| export object to fo | |
| exportFOStructureObjects (&$a_xml_writer) | |
| export structure objects to fo | |
| executeDragDrop ($source_id, $target_id, $first_child, $as_subitem=false, $movecopy="move") | |
| Execute Drag Drop Action. | |
| validatePages () | |
| Validate all pages. | |
| importFromZipFile ($a_tmp_file, $a_filename, $a_validate=true) | |
| Import lm from zip file. | |
| importFromDirectory ($a_directory, $a_validate=true) | |
| Import lm from directory. | |
|  Public Member Functions inherited from ilObject | |
| ilObject ($a_id=0, $a_reference=true) | |
| Constructor  public. | |
| withReferences () | |
| determines wehter objects are referenced or not (got ref ids or not) | |
| read ($a_force_db=false) | |
| read object data from db into object | |
| getId () | |
| get object id  public | |
| setId ($a_id) | |
| set object id  public | |
| setRefId ($a_id) | |
| set reference id  public | |
| getRefId () | |
| get reference id  public | |
| getType () | |
| get object type  public | |
| setType ($a_type) | |
| set object type  public | |
| getPresentationTitle () | |
| get presentation title Normally same as title Overwritten for sessions | |
| getUntranslatedTitle () | |
| get untranslated object title  public | |
| getLongDescription () | |
| get object long description (stored in object_description) | |
| _lookupObjIdByImportId ($a_import_id) | |
| getOwner () | |
| get object owner | |
| getOwnerName () | |
| _lookupOwnerName ($a_owner_id) | |
| lookup owner name for owner id | |
| setOwner ($a_owner) | |
| set object owner | |
| getCreateDate () | |
| get create date  public | |
| getLastUpdateDate () | |
| get last update date  public | |
| getDiskUsage () | |
| Gets the disk usage of the object in bytes. | |
| setObjDataRecord ($a_record) | |
| set object_data record (note: this method should only be called from the ilObjectFactory class) | |
| create () | |
| create | |
| MDUpdateListener ($a_element) | |
| Meta data update listener. | |
| createMetaData () | |
| create meta data entry | |
| updateMetaData () | |
| update meta data entry | |
| deleteMetaData () | |
| delete meta data entry | |
| updateOwner () | |
| update owner of object in db | |
| _getIdForImportId ($a_import_id) | |
| get current object id for import id (static) | |
| _lookupOwner ($a_id) | |
| lookup object owner | |
| _lookupDescription ($a_id) | |
| lookup object description | |
| _lookupLastUpdate ($a_id, $a_as_string=false) | |
| lookup last update | |
| _getLastUpdateOfObjects ($a_objs) | |
| Get last update for a set of media objects. | |
| _setDeletedDate ($a_ref_id) | |
| only called in ilTree::saveSubTree | |
| _resetDeletedDate ($a_ref_id) | |
| only called in ilObjectGUI::insertSavedNodes | |
| _lookupDeletedDate ($a_ref_id) | |
| only called in ilObjectGUI::insertSavedNodes | |
| _writeTitle ($a_obj_id, $a_title) | |
| write title to db (static) | |
| _writeDescription ($a_obj_id, $a_desc) | |
| write description to db (static) | |
| _writeImportId ($a_obj_id, $a_import_id) | |
| write import id to db (static) | |
| _isInTrash ($a_ref_id) | |
| checks wether object is in trash | |
| _hasUntrashedReference ($a_obj_id) | |
| checks wether an object has at least one reference that is not in trash | |
| _lookupObjectId ($a_ref_id) | |
| lookup object id | |
| _getObjectsDataForType ($a_type, $a_omit_trash=false) | |
| get all objects of a certain type | |
| setPermissions ($a_parent_ref) | |
| set permissions of object | |
| createReference () | |
| creates reference for object | |
| countReferences () | |
| count references of object | |
| createRoleFolder () | |
| creates a local role folder | |
| setRegisterMode ($a_bool) | |
| isUserRegistered ($a_user_id=0) | |
| requireRegistration () | |
| getHTMLDirectory () | |
| cloneObject ($a_target_id, $a_copy_id=0) | |
| Clone object permissions, put in tree ... | |
| appendCopyInfo ($a_target_id, $a_copy_id) | |
| Prepend Copy info if object with same name exists in that container. | |
| cloneDependencies ($a_target_id, $a_copy_id) | |
| Clone object dependencies. | |
| cloneMetaData ($target_obj) | |
| Copy meta data. | |
| Data Fields | |
| $bib_obj | |
|  Data Fields inherited from ilObjContentObject | |
| $lm_tree | |
| $meta_data | |
| $layout | |
| $style_id | |
| $pg_header | |
| $online | |
|  Data Fields inherited from ilObject | |
| const | TITLE_LENGTH = 128 | 
| max length of object title | |
| $ilias | |
| $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 | |
| $obj_data_record | |
| object_data record | |
| Additional Inherited Members | |
|  Static Public Member Functions inherited from ilObjContentObject | |
| static | getSupplyingExportFiles ($a_target_dir=".") | 
| Get supplying export files. | |
Class ilObjDlBook.
Definition at line 14 of file class.ilObjDlBook.php.
| ilObjDlBook::addTranslation | ( | $a_ref_id | ) | 
Definition at line 326 of file class.ilObjDlBook.php.
References $ilDB, and readAssignedTranslations().
Referenced by addTranslations().
 Here is the call graph for this function:
 Here is the call graph for this function: Here is the caller graph for this function:
 Here is the caller graph for this function:| ilObjDlBook::addTranslations | ( | $a_arr_ref_id | ) | 
Definition at line 352 of file class.ilObjDlBook.php.
References ilObject\$ref_id, and addTranslation().
 Here is the call graph for this function:
 Here is the call graph for this function:| ilObjDlBook::deleteTranslation | ( | $a_ref_id | ) | 
Definition at line 364 of file class.ilObjDlBook.php.
References $ilDB, and readAssignedTranslations().
Referenced by deleteTranslations().
 Here is the call graph for this function:
 Here is the call graph for this function: Here is the caller graph for this function:
 Here is the caller graph for this function:| ilObjDlBook::deleteTranslations | ( | $a_arr_ref_id | ) | 
Definition at line 387 of file class.ilObjDlBook.php.
References ilObject\$ref_id, and deleteTranslation().
 Here is the call graph for this function:
 Here is the call graph for this function:| ilObjDlBook::export | ( | $a_deliver = true | ) | 
exports the digi-lib-object into a xml structure
Definition at line 129 of file class.ilObjDlBook.php.
References $ilDB, $query, $result, $row, ilObject\_lookupObjId(), ilObject\_lookupTitle(), ilObjContentObject\createExportDirectory(), ilUtil\deliverFile(), exportRekursiv(), ilObjContentObject\getExportDirectory(), ilUtil\rCopy(), and ilUtil\zip().
Referenced by getXMLZip().
 Here is the call graph for this function:
 Here is the call graph for this function: Here is the caller graph for this function:
 Here is the caller graph for this function:| ilObjDlBook::exportRekursiv | ( | $obj_id, | |
| $depth, | |||
| $left, | |||
| $right | |||
| ) | 
export lm_data-table to xml-structure
| integer | obj_id | 
| integer | depth | 
| integer | left left border of nested-set-structure | 
| integer | right right border of nested-set-structure public | 
Definition at line 57 of file class.ilObjDlBook.php.
References $ilDB, $path, $query, $res, $result, $row, DB_FETCHMODE_ASSOC, domxml_open_mem(), xpath_eval(), and xpath_new_context().
Referenced by export().
 Here is the call graph for this function:
 Here is the call graph for this function: Here is the caller graph for this function:
 Here is the caller graph for this function:| ilObjDlBook::getTranslations | ( | ) | 
Definition at line 399 of file class.ilObjDlBook.php.
| ilObjDlBook::getXMLZip | ( | ) | 
Reimplemented from ilObjContentObject.
Definition at line 404 of file class.ilObjDlBook.php.
References export().
 Here is the call graph for this function:
 Here is the call graph for this function:| ilObjDlBook::ilObjDlBook | ( | $a_id = 0, | |
| $a_call_by_reference = true | |||
| ) | 
Constructor public.
Definition at line 22 of file class.ilObjDlBook.php.
References ilObjContentObject\ilObjContentObject(), and readAssignedTranslations().
 Here is the call graph for this function:
 Here is the call graph for this function:| ilObjDlBook::initBibItemObject | ( | ) | 
init bib object (contains all bib item data)
Definition at line 37 of file class.ilObjDlBook.php.
| ilObjDlBook::readAssignedTranslations | ( | ) | 
Definition at line 411 of file class.ilObjDlBook.php.
References $ilDB, $query, $res, and $row.
Referenced by addTranslation(), deleteTranslation(), and ilObjDlBook().
 Here is the caller graph for this function:
 Here is the caller graph for this function:| ilObjDlBook::$bib_obj | 
Definition at line 16 of file class.ilObjDlBook.php.