ilObjContentObject Class Reference

Class ilObjContentObject. More...

Inheritance diagram for ilObjContentObject:

Collaboration diagram for ilObjContentObject:

Public Member Functions
	__construct ($a_id=0, $a_call_by_reference=true)
	Constructor @access 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 ()
	get import id More...
	setImportId ($a_id)
	set import id More...
	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 (ilLMOBject::CHAPTER_TITLE | ilLMOBject::PAGE_TITLE | ilLMOBject::NO_HEADER) More...
	setPageHeader ($a_pg_header=ilLMObject::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...
	exportFO (&$a_xml_writer, $a_target_dir)
	export scorm package 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)
	Meta data update listener. More...
	getPublicExportFiles ()
	Get public export files. More...
Public Member Functions inherited from ilObject
	__construct ($a_id=0, $a_reference=true)
	Constructor @access public. More...
	withReferences ()
	determines wehter objects are referenced or not (got ref ids or not) More...
	read ()
	read object data from db into object More...
	getId ()
	get object id @access public More...
	setId ($a_id)
	set object id @access public More...
	setRefId ($a_id)
	set reference id @access public More...
	getRefId ()
	get reference id @access public More...
	getType ()
	get object type @access public More...
	setType ($a_type)
	set object type @access public More...
	getPresentationTitle ()
	get presentation title Normally same as title Overwritten for sessions More...
	getTitle ()
	get object title @access public More...
	getUntranslatedTitle ()
	get untranslated object title @access public More...
	setTitle ($a_title)
	set object title More...
	getDescription ()
	get object description More...
	setDescription ($a_desc)
	set object description More...
	getLongDescription ()
	get object long description (stored in object_description) More...
	getImportId ()
	get import id More...
	setImportId ($a_import_id)
	set import id More...
	setOfflineStatus ($a_status)
	Set offline status. More...
	getOfflineStatus ()
	Get offline status. More...
	supportsOfflineHandling ()
	Check whether object supports offline handling. More...
	getOwner ()
	get object owner More...
	getOwnerName ()
	setOwner ($a_owner)
	set object owner More...
	getCreateDate ()
	get create date @access public More...
	getLastUpdateDate ()
	get last update date @access public More...
	getDiskUsage ()
	Gets the disk usage of the object in bytes. More...
	create ()
	create More...
	update ()
	update object in db More...
	MDUpdateListener ($a_element)
	Meta data update listener. More...
	createMetaData ()
	create meta data entry More...
	updateMetaData ()
	update meta data entry More...
	deleteMetaData ()
	delete meta data entry More...
	updateOwner ()
	update owner of object in db More...
	putInTree ($a_parent_ref)
	maybe this method should be in tree object!? More...
	setPermissions ($a_parent_ref)
	set permissions of object More...
	setParentRolePermissions ($a_parent_ref)
	Initialize the permissions of parent roles (local roles of categories, global roles...) This method is overwritten in e.g courses, groups for building permission intersections with non_member templates. More...
	createReference ()
	creates reference for object More...
	countReferences ()
	count references of object More...
	initDefaultRoles ()
	init default roles settings Purpose of this function is to create a local role folder and local roles, that are needed depending on the object type If you want to setup default local roles you MUST overwrite this method in derived object classes (see ilObjForum for an example) @access public More...
	applyDidacticTemplate ($a_tpl_id)
	Apply template. More...
	setRegisterMode ($a_bool)
	isUserRegistered ($a_user_id=0)
	requireRegistration ()
	getXMLZip ()
	getHTMLDirectory ()
	appendCopyInfo ($a_target_id, $a_copy_id)
	Prepend Copy info if object with same name exists in that container. More...
	cloneDependencies ($a_target_id, $a_copy_id)
	Clone object dependencies. More...
	cloneMetaData ($target_obj)
	Copy meta data. More...
	getPossibleSubObjects ($a_filter=true)
	get all possible subobjects of this type the object can decide which types of subobjects are possible jut in time overwrite if the decision distinguish from standard model More...

Static Public Member Functions
static	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	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, $a_deleted_by)
static	setDeletedDates ($a_ref_ids, $a_user_id)
	Set deleted date. More...
static	_resetDeletedDate ($a_ref_id)
	only called in ilObjectGUI::insertSavedNodes More...
static	_lookupDeletedDate ($a_ref_id)
	only called in ilObjectGUI::insertSavedNodes More...
static	_writeTitle ($a_obj_id, $a_title)
	write title to db (static) More...
static	_writeDescription ($a_obj_id, $a_desc)
	write description to db (static) More...
static	_writeImportId ($a_obj_id, $a_import_id)
	write import id to db (static) More...
static	_lookupType ($a_id, $a_reference=false)
	lookup object type More...
static	_isInTrash ($a_ref_id)
	checks wether object is in trash More...
static	_hasUntrashedReference ($a_obj_id)
	checks wether an object has at least one reference that is not in trash More...
static	_lookupObjectId ($a_ref_id)
	lookup object id More...
static	_getObjectsDataForType ($a_type, $a_omit_trash=false)
	get all objects of a certain type More...
static	_exists ($a_id, $a_reference=false, $a_type=null)
	checks if an object exists in object_data@access public More...
static	_getObjectsByType ($a_obj_type="", $a_owner="")
	Get objects by type. More...
static	_prepareCloneSelection ($a_ref_ids, $new_type, $show_path=true)
	Prepare copy wizard object selection. More...
static	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
	$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
static	_lookup ($a_obj_id, $a_field)
	Lookup property. More...

Protected Attributes
	$user
	$locator
	$rating
	$rating_pages
	$log
Protected Attributes inherited from ilObject
	$objDefinition
	$db
	$log
	$error
	$tree
	$app_event_handler
	$rbacadmin
	$rbacreview

Private Attributes
	$import_dir = ''

Detailed Description

Class ilObjContentObject.

Author

Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Sascha Hofmann sasch.nosp@m.ahof.nosp@m.mann@.nosp@m.gmx..nosp@m.de

Version

$Id$

Definition at line 17 of file class.ilObjContentObject.php.

Constructor & Destructor Documentation

__construct()

ilObjContentObject::__construct	(		$a_id = 0,
			$a_call_by_reference = true
	)

Constructor @access public.

Parameters

integer	reference_id or object_id
boolean	treat the id as reference_id (true) or object_id (false)

Reimplemented from ilObject.

Reimplemented in ilObjLearningModule.

Definition at line 57 of file class.ilObjContentObject.php.

    {
        global $DIC;
 
        $this->user = $DIC->user();
        $this->db = $DIC->database();
        $this->tree = $DIC->repositoryTree();
        $this->lng = $DIC->language();
        $this->error = $DIC["ilErr"];
        if (isset($DIC["ilLocator"])) {
            $this->locator = $DIC["ilLocator"];
        }
 
        // this also calls read() method! (if $a_id is set)
        parent::__construct($a_id, $a_call_by_reference);
 
        $this->log = ilLoggerFactory::getLogger('lm');
 
        $this->mob_ids = array();
        $this->file_ids = array();
        $this->q_ids = array();
    }

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), error(), ilLoggerFactory\getLogger(), and user().

Here is the call graph for this function:

Member Function Documentation

_checkPreconditionsOfPage()

static ilObjContentObject::_checkPreconditionsOfPage (   $cont_ref_id,   $cont_obj_id,   $page_id  )

static

checks wether the preconditions of a page are fulfilled or not

Definition at line 1288 of file class.ilObjContentObject.php.

    {
        global $DIC;
 
        $ilUser = $DIC->user();
        $ilErr = $DIC["ilErr"];
 
        $lm_tree = new ilTree($cont_obj_id);
        $lm_tree->setTableNames('lm_tree', 'lm_data');
        $lm_tree->setTreeTablePK("lm_id");
 
        if ($lm_tree->isInTree($page_id)) {
            $path = $lm_tree->getPathFull($page_id, $lm_tree->readRootId());
            foreach ($path as $node) {
                if ($node["type"] == "st") {
                    if (!ilConditionHandler::_checkAllConditionsOfTarget($cont_ref_id, $node["child"], "st")) {
                        return false;
                    }
                }
            }
        }
        
        return true;
    }

References $DIC, $ilErr, $ilUser, $lm_tree, and ilConditionHandler\_checkAllConditionsOfTarget().

Referenced by ilLMContentRendererGUI\determineStatus(), ilLMPresentationGUI\showPrintView(), and ilLMPresentationGUI\showPrintViewSelection().

Here is the call graph for this function:

Here is the caller graph for this function:

_deleteStyleAssignments()

static ilObjContentObject::_deleteStyleAssignments (   $a_style_id )

static

delete all style references to style

Parameters

int

$a_style_id

style_id

Definition at line 935 of file class.ilObjContentObject.php.

    {
        global $DIC;
 
        $ilDB = $DIC->database();
        
        $q = "UPDATE content_object SET " .
            " stylesheet = " . $ilDB->quote(0, "integer") .
            " WHERE stylesheet = " . $ilDB->quote((int) $a_style_id, "integer");
 
        $ilDB->manipulate($q);
    }

References $DIC, and $ilDB.

Referenced by ilObjStyleSheet\delete().

Here is the caller graph for this function:

_getMissingPreconditionsOfPage()

static ilObjContentObject::_getMissingPreconditionsOfPage (   $cont_ref_id,   $cont_obj_id,   $page_id  )

static

gets all missing preconditions of page

Definition at line 1316 of file class.ilObjContentObject.php.

    {
        $lm_tree = new ilTree($cont_obj_id);
        $lm_tree->setTableNames('lm_tree', 'lm_data');
        $lm_tree->setTreeTablePK("lm_id");
 
        $conds = array();
        if ($lm_tree->isInTree($page_id)) {
            // get full path of page
            $path = $lm_tree->getPathFull($page_id, $lm_tree->readRootId());
            foreach ($path as $node) {
                if ($node["type"] == "st") {
                    // get all preconditions of upper chapters
                    $tconds = ilConditionHandler::_getPersistedConditionsOfTarget($cont_ref_id, $node["child"], "st");
                    foreach ($tconds as $tcond) {
                        // store all missing preconditions
                        if (!ilConditionHandler::_checkCondition($tcond)) {
                            $conds[] = $tcond;
                        }
                    }
                }
            }
        }
        
        return $conds;
    }

References $lm_tree, ilConditionHandler\_checkCondition(), and ilConditionHandler\_getPersistedConditionsOfTarget().

Referenced by ilLMContentRendererGUI\renderPreconditionsOfPage().

Here is the call graph for this function:

Here is the caller graph for this function:

_getMissingPreconditionsTopChapter()

static ilObjContentObject::_getMissingPreconditionsTopChapter (   $cont_obj_ref_id,   $cont_obj_id,   $page_id  )

static

get top chapter of page for that any precondition is missing

Definition at line 1346 of file class.ilObjContentObject.php.

    {
        $lm_tree = new ilTree($cont_obj_id);
        $lm_tree->setTableNames('lm_tree', 'lm_data');
        $lm_tree->setTreeTablePK("lm_id");
 
        $conds = array();
        if ($lm_tree->isInTree($page_id)) {
            // get full path of page
            $path = $lm_tree->getPathFull($page_id, $lm_tree->readRootId());
            foreach ($path as $node) {
                if ($node["type"] == "st") {
                    // get all preconditions of upper chapters
                    $tconds = ilConditionHandler::_getPersistedConditionsOfTarget($cont_obj_ref_id, $node["child"], "st");
                    foreach ($tconds as $tcond) {
                        // look for missing precondition
                        if (!ilConditionHandler::_checkCondition($tcond)) {
                            return $node["child"];
                        }
                    }
                }
            }
        }
        
        return "";
    }

References $lm_tree, ilConditionHandler\_checkCondition(), and ilConditionHandler\_getPersistedConditionsOfTarget().

Referenced by ilLMContentRendererGUI\renderPreconditionsOfPage().

Here is the call graph for this function:

Here is the caller graph for this function:

_getNrLMsIndividualStyles()

static ilObjContentObject::_getNrLMsIndividualStyles ( )

static

get number of learning modules with individual styles

Definition at line 897 of file class.ilObjContentObject.php.

    {
        global $DIC;
 
        $ilDB = $DIC->database();
        
        // joining with style table (not perfectly nice)
        $q = "SELECT count(*) as cnt FROM content_object, style_data " .
            " WHERE stylesheet = style_data.id " .
            " AND standard = " . $ilDB->quote(0, "integer");
        $cset = $ilDB->query($q);
        $crow = $ilDB->fetchAssoc($cset);
 
        return (int) $crow["cnt"];
    }

References $DIC, and $ilDB.

Referenced by ilContentStyleSettingsGUI\edit().

Here is the caller graph for this function:

_getNrLMsNoStyle()

static ilObjContentObject::_getNrLMsNoStyle ( )

static

get number of learning modules assigned no style

Definition at line 916 of file class.ilObjContentObject.php.

    {
        global $DIC;
 
        $ilDB = $DIC->database();
        
        $q = "SELECT count(*) as cnt FROM content_object " .
            " WHERE stylesheet = " . $ilDB->quote(0, "integer");
        $cset = $ilDB->query($q);
        $crow = $ilDB->fetchAssoc($cset);
 
        return (int) $crow["cnt"];
    }

References $DIC, and $ilDB.

Referenced by ilContentStyleSettingsGUI\edit().

Here is the caller graph for this function:

_getNrOfAssignedLMs()

static ilObjContentObject::_getNrOfAssignedLMs (   $a_style_id )

static

gets the number of learning modules assigned to a content style

Parameters

int

$a_style_id

style id

Definition at line 879 of file class.ilObjContentObject.php.

    {
        global $DIC;
 
        $ilDB = $DIC->database();
        
        $q = "SELECT count(*) as cnt FROM content_object " .
            " WHERE stylesheet = " . $ilDB->quote($a_style_id, "integer");
        $cset = $ilDB->query($q);
        $crow = $ilDB->fetchAssoc($cset);
 
        return (int) $crow["cnt"];
    }

References $DIC, and $ilDB.

Referenced by ilContentStyleSettingsGUI\edit().

Here is the caller graph for this function:

_lookup()

static ilObjContentObject::_lookup (   $a_obj_id,   $a_field  )

staticprotected

Lookup property.

Parameters

int	$a_obj_id	object id
string	$a_field	property field name

Returns

string property value

Definition at line 776 of file class.ilObjContentObject.php.

    {
        global $DIC;
 
        $ilDB = $DIC->database();
        $ilLog = $DIC["ilLog"];
 
        $q = "SELECT " . $a_field . " FROM content_object " .
            " WHERE id = " . $ilDB->quote($a_obj_id, "integer");
 
        $res = $ilDB->query($q);
        $rec = $ilDB->fetchAssoc($res);
 
        return $rec[$a_field];
    }

References $DIC, $ilDB, $ilLog, and $res.

Referenced by _lookupRestrictForwardNavigation().

Here is the caller graph for this function:

_lookupContObjIdByStyleId()

static ilObjContentObject::_lookupContObjIdByStyleId (   $a_style_id )

static

lookup style sheet ID

Definition at line 823 of file class.ilObjContentObject.php.

    {
        global $DIC;
 
        $ilDB = $DIC->database();
 
        $q = "SELECT id FROM content_object " .
            " WHERE stylesheet = " . $ilDB->quote($a_style_id, "integer");
        $res = $ilDB->query($q);
        $obj_ids = array();
        while ($cont = $ilDB->fetchAssoc($res)) {
            $obj_ids[] = $cont["id"];
        }
        return $obj_ids;
    }

References $DIC, $ilDB, and $res.

Referenced by ilObjStyleSheet\_getClonableContentStyles().

Here is the caller graph for this function:

_lookupDisableDefaultFeedback()

static ilObjContentObject::_lookupDisableDefaultFeedback (   $a_id )

static

Lookup disable default feedback.

Definition at line 842 of file class.ilObjContentObject.php.

    {
        global $DIC;
 
        $ilDB = $DIC->database();
 
        $q = "SELECT disable_def_feedback FROM content_object " .
            " WHERE id = " . $ilDB->quote($a_id, "integer");
        $res = $ilDB->query($q);
        $rec = $ilDB->fetchAssoc($res);
 
        return $rec["disable_def_feedback"];
    }

References $DIC, $ilDB, and $res.

Referenced by ilLMPageConfig\configureByObjectId(), and ilLMPageGUI\onFeedbackEditingForwarding().

Here is the caller graph for this function:

_lookupRestrictForwardNavigation()

static ilObjContentObject::_lookupRestrictForwardNavigation (   $a_obj_id )

static

Lookup forward restriction navigation.

Parameters

int

$a_obj_id

object id

Returns

string property value

Definition at line 798 of file class.ilObjContentObject.php.

    {
        return self::_lookup($a_obj_id, "restrict_forw_nav");
    }

References _lookup().

Referenced by ilLMPageGUI\processAnswer().

Here is the call graph for this function:

Here is the caller graph for this function:

_lookupStoreTries()

static ilObjContentObject::_lookupStoreTries (   $a_id )

static

Lookup disable default feedback.

Definition at line 859 of file class.ilObjContentObject.php.

    {
        global $DIC;
 
        $ilDB = $DIC->database();
 
        $q = "SELECT store_tries FROM content_object " .
            " WHERE id = " . $ilDB->quote($a_id, "integer");
        $res = $ilDB->query($q);
        $rec = $ilDB->fetchAssoc($res);
 
        return $rec["store_tries"];
    }

References $DIC, $ilDB, and $res.

Referenced by ilLMPageGUI\__construct().

Here is the caller graph for this function:

_lookupStyleSheetId()

static ilObjContentObject::_lookupStyleSheetId (   $a_cont_obj_id )

static

lookup style sheet ID

Definition at line 806 of file class.ilObjContentObject.php.

    {
        global $DIC;
 
        $ilDB = $DIC->database();
 
        $q = "SELECT stylesheet FROM content_object " .
            " WHERE id = " . $ilDB->quote($a_cont_obj_id, "integer");
        $res = $ilDB->query($q);
        $sheet = $ilDB->fetchAssoc($res);
 
        return $sheet["stylesheet"];
    }

References $DIC, $ilDB, and $res.

Referenced by ilLearningModuleExporter\getXmlExportTailDependencies(), and ilPCParagraphGUI\setStyle().

Here is the caller graph for this function:

_moveLMStyles()

static ilObjContentObject::_moveLMStyles (   $a_from_style,   $a_to_style  )

static

move learning modules from one style to another

Definition at line 738 of file class.ilObjContentObject.php.

    {
        global $DIC;
 
        $ilDB = $DIC->database();
 
        if ($a_from_style < 0) {        // change / delete all individual styles
            $q = "SELECT stylesheet FROM content_object, style_data " .
                " WHERE content_object.stylesheet = style_data.id " .
                " AND style_data.standard = " . $ilDB->quote(0, "integer") .
                " AND content_object.stylesheet > " . $ilDB->quote(0, "integer");
            $style_set = $ilDB->query($q);
            while ($style_rec = $ilDB->fetchAssoc($style_set)) {
                // assign learning modules to new style
                $q = "UPDATE content_object SET " .
                    " stylesheet = " . $ilDB->quote((int) $a_to_style, "integer") .
                    " WHERE stylesheet = " . $ilDB->quote($style_rec["stylesheet"], "integer");
                $ilDB->manipulate($q);
                
                // delete style
                $style_obj = ilObjectFactory::getInstanceByObjId($style_rec["stylesheet"]);
                $style_obj->delete();
            }
        } else {
            $q = "UPDATE content_object SET " .
                " stylesheet = " . $ilDB->quote((int) $a_to_style, "integer") .
                " WHERE stylesheet = " . $ilDB->quote($a_from_style, "integer");
            $ilDB->manipulate($q);
        }
    }

References $DIC, $ilDB, and ilObjectFactory\getInstanceByObjId().

Referenced by ilContentStyleSettingsGUI\moveIndividualStyles(), and ilContentStyleSettingsGUI\moveLMStyles().

Here is the call graph for this function:

Here is the caller graph for this function:

addFirstChapterAndPage()

ilObjContentObject::addFirstChapterAndPage

(

)

Add first chapter and page.

Definition at line 410 of file class.ilObjContentObject.php.

    {
        $lng = $this->lng;
        
 
        $root_id = $this->lm_tree->getRootId();
        
        // chapter
        $chap = new ilStructureObject($this);
        $chap->setType("st");
        $chap->setTitle($lng->txt("cont_new_chap"));
        $chap->setLMId($this->getId());
        $chap->create();
        ilLMObject::putInTree($chap, $root_id, IL_FIRST_NODE);
 
        // page
        $page = new ilLMPageObject($this);
        $page->setType("pg");
        $page->setTitle($lng->txt("cont_new_page"));
        $page->setLMId($this->getId());
        $page->create();
        ilLMObject::putInTree($page, $chap->getId(), IL_FIRST_NODE);
    }

References ilObject\$lng, ilObject\getId(), IL_FIRST_NODE, and ilLMObject\putInTree().

Here is the call graph for this function:

autoLinkGlossaryTerms()

ilObjContentObject::autoLinkGlossaryTerms

(

$a_glo_ref_id

)

Auto link glossary terms.

Parameters

return

Definition at line 2718 of file class.ilObjContentObject.php.

    {
        // get terms
        $terms = ilGlossaryTerm::getTermList($a_glo_ref_id);
 
        // each get page: get content
        $pages = ilLMPage::getAllPages($this->getType(), $this->getId());
        
        // determine terms that occur in the page
        $found_pages = array();
        foreach ($pages as $p) {
            $pg = new ilLMPage($p["id"]);
            $c = $pg->getXMLContent();
            foreach ($terms as $t) {
                if (is_int(stripos($c, $t["term"]))) {
                    $found_pages[$p["id"]]["terms"][] = $t;
                    if (!is_object($found_pages[$p["id"]]["page"])) {
                        $found_pages[$p["id"]]["page"] = $pg;
                    }
                }
            }
            reset($terms);
        }
        
        // ilPCParagraph autoLinkGlossariesPage with page and terms
        foreach ($found_pages as $id => $fp) {
            ilPCParagraph::autoLinkGlossariesPage($fp["page"], $fp["terms"]);
        }
    }

References Vendor\Package\$c, ilObject\$id, ilPCParagraph\autoLinkGlossariesPage(), ilPageObject\getAllPages(), ilObject\getId(), ilGlossaryTerm\getTermList(), and ilObject\getType().

Here is the call graph for this function:

checkStructure()

ilObjContentObject::checkStructure

(

)

Check tree (this has been copied from fixTree due to a bug fixing, should be reorganised)

Definition at line 1533 of file class.ilObjContentObject.php.

    {
        $issues = [];
        $ilDB = $this->db;
 
        $tree = $this->getLMTree();
 
        // check numbering, if errors, renumber
        // it is very important to keep this step before deleting subtrees
        // in the following steps
        $set = $ilDB->query(
            "SELECT l1.child, l1.lft l1lft, l1.rgt l1rgt, l2.parent, l2.lft l2lft, l2.rgt l2rgt" .
            " FROM lm_tree l1" .
            " JOIN lm_tree l2 ON ( l1.child = l2.parent" .
            " AND l1.lm_id = l2.lm_id )" .
            " JOIN lm_data ON ( l1.child = lm_data.obj_id )" .
            " WHERE (l2.lft < l1.lft" .
            " OR l2.rgt > l1.rgt OR l2.lft > l1.rgt OR l2.rgt < l1.lft)" .
            " AND l1.lm_id = " . $ilDB->quote($this->getId(), "integer") .
            " ORDER BY lm_data.create_date DESC"
        );
        while ($rec = $ilDB->fetchAssoc($set)) {
            $issues[] = "Tree numbering: " . print_r($rec, true);
        }
 
        // delete subtrees that have no lm_data records (changed due to #20637)
        $set = $ilDB->query("SELECT * FROM lm_tree WHERE lm_tree.lm_id = " . $ilDB->quote($this->getId(), "integer"));
        while ($node = $ilDB->fetchAssoc($set)) {
            $q = "SELECT * FROM lm_data WHERE obj_id = " .
                $ilDB->quote($node["child"], "integer");
            $obj_set = $ilDB->query($q);
            $obj_rec = $ilDB->fetchAssoc($obj_set);
            if (!$obj_rec) {
                $issues[] = "Tree entry without data entry: " . print_r($node, true);
            }
        }
 
        // delete subtrees that have pages as parent
        $nodes = $tree->getSubtree($tree->getNodeData($tree->getRootId()));
        foreach ($nodes as $node) {
            $q = "SELECT * FROM lm_data WHERE obj_id = " .
                $ilDB->quote($node["parent"], "integer");
            $obj_set = $ilDB->query($q);
            $obj_rec = $ilDB->fetchAssoc($obj_set);
            if ($obj_rec["type"] == "pg") {
                $node_data = $tree->getNodeData($node["child"]);
                if ($tree->isInTree($node["child"])) {
                    $issues[] = "Subtree with page parent: " . print_r($node_data, true);
                }
            }
        }
 
        // check for multi-references pages or chapters
        // if errors -> create copies of them here
        $set = $ilDB->query("SELECT DISTINCT l1.lm_id" .
            " FROM lm_tree l1" .
            " JOIN lm_tree l2 ON ( l1.child = l2.child AND l1.lm_id <> l2.lm_id )" .
            " JOIN lm_data ON (l1.child = lm_data.obj_id)" .
            " WHERE l1.child <> 1" .
            " AND l1.lm_id <> lm_data.lm_id" .
            " AND l1.lm_id = " . $ilDB->quote($this->getId(), "integer"));
        if ($rec = $ilDB->fetchAssoc($set)) {
            $set = $ilDB->query("SELECT DISTINCT l1.child " .
                " FROM lm_tree l1" .
                " JOIN lm_tree l2 ON ( l1.child = l2.child AND l1.lm_id <> l2.lm_id )" .
                " JOIN lm_data ON (l1.child = lm_data.obj_id)" .
                " WHERE l1.child <> 1" .
                " AND l1.lm_id <> lm_data.lm_id" .
                " AND l1.lm_id = " . $ilDB->quote($this->getId(), "integer"));
            while ($rec = $ilDB->fetchAssoc($set)) {
                $set3 = $ilDB->queryF(
                    "SELECT * FROM lm_tree " .
                    " WHERE child = %s ",
                    array("integer"),
                    array($rec["child"])
                );
                while ($rec3 = $ilDB->fetchAssoc($set3)) {
                    $issues[] = "Multi-reference item: " . print_r($rec3, true);
                }
            }
        }
 
        // missing copage entries
        $set = $ilDB->queryF(
            "SELECT * FROM lm_data " .
            " WHERE lm_id = %s AND type = %s",
            array("integer", "text"),
            array($this->getId(), "pg")
        );
        while ($rec = $ilDB->fetchAssoc($set)) {
            if (!ilPageObject::_exists("lm", $rec["obj_id"], "-")) {
                $issues[] = "Missing COPage: " . print_r($rec, true);
            }
        }
 
 
        return $issues;
    }

References ilObject\$db, $ilDB, ilObject\$tree, ilPageObject\_exists(), ilObject\getId(), and getLMTree().

Here is the call graph for this function:

checkTree()

ilObjContentObject::checkTree

(

)

Definition at line 1391 of file class.ilObjContentObject.php.

    {
        $tree = new ilTree($this->getId());
        $tree->setTableNames('lm_tree', 'lm_data');
        $tree->setTreeTablePK("lm_id");
        $tree->checkTree();
        $tree->checkTreeChilds();
        //echo "checked";
    }

References ilObject\$tree, and ilObject\getId().

Referenced by executeDragDrop().

Here is the call graph for this function:

Here is the caller graph for this function:

cleanFrames()

ilObjContentObject::cleanFrames

(

)

Definition at line 1097 of file class.ilObjContentObject.php.

    {
        return $this->clean_frames;
    }

Referenced by cloneObject(), exportXMLProperties(), and updateProperties().

Here is the caller graph for this function:

cloneObject()

ilObjContentObject::cloneObject	(		$a_target_id,
			$a_copy_id = 0,
			$a_omit_tree = false
	)

Clone learning module.

@access public

Parameters

int	target ref_id
int	copy id

Definition at line 2534 of file class.ilObjContentObject.php.

    {
        $new_obj = parent::cloneObject($a_target_id, $a_copy_id, $a_omit_tree);
        $this->cloneMetaData($new_obj);
        //$new_obj->createProperties();
 
        //copy online status if object is not the root copy object
        $cp_options = ilCopyWizardOptions::_getInstance($a_copy_id);
 
        if (!$cp_options->isRootNode($this->getRefId())) {
            $new_obj->setOfflineStatus($this->getOfflineStatus());
        }
        
        //              $new_obj->setTitle($this->getTitle());
        $new_obj->setDescription($this->getDescription());
        $new_obj->setLayoutPerPage($this->getLayoutPerPage());
        $new_obj->setLayout($this->getLayout());
        $new_obj->setTOCMode($this->getTOCMode());
        $new_obj->setActiveLMMenu($this->isActiveLMMenu());
        $new_obj->setActiveTOC($this->isActiveTOC());
        $new_obj->setActiveNumbering($this->isActiveNumbering());
        $new_obj->setActivePrintView($this->isActivePrintView());
        $new_obj->setActivePreventGlossaryAppendix($this->isActivePreventGlossaryAppendix());
        $new_obj->setActiveDownloads($this->isActiveDownloads());
        $new_obj->setActiveDownloadsPublic($this->isActiveDownloadsPublic());
        $new_obj->setPublicNotes($this->publicNotes());
        $new_obj->setCleanFrames($this->cleanFrames());
        $new_obj->setHistoryUserComments($this->isActiveHistoryUserComments());
        $new_obj->setPublicAccessMode($this->getPublicAccessMode());
        $new_obj->setPageHeader($this->getPageHeader());
        $new_obj->setRating($this->hasRating());
        $new_obj->setRatingPages($this->hasRatingPages());
        $new_obj->setDisableDefaultFeedback($this->getDisableDefaultFeedback());
        $new_obj->setProgressIcons($this->getProgressIcons());
        $new_obj->setStoreTries($this->getStoreTries());
        $new_obj->setRestrictForwardNavigation($this->getRestrictForwardNavigation());
        $new_obj->setAutoGlossaries($this->getAutoGlossaries());
 
        $new_obj->update();
        
        $new_obj->createLMTree();
        
        // copy style
        $style_id = $this->getStyleSheetId();
        if ($style_id > 0 &&
            !ilObjStyleSheet::_lookupStandard($style_id)) {
            $style_obj = ilObjectFactory::getInstanceByObjId($style_id);
            $new_id = $style_obj->ilClone();
            $new_obj->setStyleSheetId($new_id);
        } else {        // or just set the same standard style
            $new_obj->setStyleSheetId($style_id);
        }
        $new_obj->update();
        
        // copy content
        $copied_nodes = $this->copyAllPagesAndChapters($new_obj, $a_copy_id);
 
        // page header and footer
        if ($this->getHeaderPage() > 0 && ($new_page_header = $copied_nodes[$this->getHeaderPage()]) > 0) {
            $new_obj->setHeaderPage($new_page_header);
        }
        if ($this->getFooterPage() > 0 && ($new_page_footer = $copied_nodes[$this->getFooterPage()]) > 0) {
            $new_obj->setFooterPage($new_page_footer);
        }
        $new_obj->update();
 
        // Copy learning progress settings
        $obj_settings = new ilLPObjSettings($this->getId());
        $obj_settings->cloneSettings($new_obj->getId());
        unset($obj_settings);
 
        // copy (page) multilang settings
        $ot = ilObjectTranslation::getInstance($this->getId());
        $ot->copy($new_obj->getId());
 
        // copy lm menu
        $menu = new ilLMMenuEditor();
        $menu->setObjId($this->getId());
        $new_menu = new ilLMMenuEditor();
        $new_menu->setObjId($new_obj->getId());
        foreach ($menu->getMenuEntries() as $entry) {
            /*'id'              => $row->id,
                               'title'  => $row->title,
                               'link'   => $row->target,
                               'type'   => $row->link_type,
                               'ref_id' => $row->link_ref_id,
                               'active'*/
 
            $new_menu->setTarget($entry["link"]);
            $new_menu->setTitle($entry["title"]);
            $new_menu->setLinkType($entry["type"]);
            $new_menu->setLinkRefId($entry["ref_id"]);
            $new_menu->create();
            ilLMMenuEditor::writeActive($new_menu->getEntryId(), $entry["active"] == "y" ? true : false);
        }
 
 
        return $new_obj;
    }

References $style_id, ilCopyWizardOptions\_getInstance(), ilObjStyleSheet\_lookupStandard(), cleanFrames(), ilObject\cloneMetaData(), copyAllPagesAndChapters(), getAutoGlossaries(), getDescription(), getDisableDefaultFeedback(), getFooterPage(), getHeaderPage(), ilObject\getId(), ilObjectTranslation\getInstance(), ilObjectFactory\getInstanceByObjId(), getLayout(), getLayoutPerPage(), ilObject\getOfflineStatus(), getPageHeader(), getProgressIcons(), getPublicAccessMode(), getRestrictForwardNavigation(), getStoreTries(), getStyleSheetId(), getTOCMode(), hasRating(), hasRatingPages(), isActiveDownloads(), isActiveDownloadsPublic(), isActiveHistoryUserComments(), isActiveLMMenu(), isActiveNumbering(), isActivePreventGlossaryAppendix(), isActivePrintView(), isActiveTOC(), publicNotes(), and ilLMMenuEditor\writeActive().

Here is the call graph for this function:

copyAllPagesAndChapters()

ilObjContentObject::copyAllPagesAndChapters	(		$a_target_obj,
			$a_copy_id = 0
	)

Copy all pages and chapters.

Parameters

object

$a_target_obj

target learning module

Definition at line 2639 of file class.ilObjContentObject.php.

    {
        $parent_id = $a_target_obj->lm_tree->readRootId();
        
        // get all chapters of root lm
        $chapters = $this->lm_tree->getChildsByType($this->lm_tree->readRootId(), "st");
        $copied_nodes = array();
        //$time = time();
        foreach ($chapters as $chap) {
            $cid = ilLMObject::pasteTree(
                $a_target_obj,
                $chap["child"],
                $parent_id,
                IL_LAST_NODE,
                $time,
                $copied_nodes,
                true,
                $this
            );
            $target = $cid;
        }
        
        // copy free pages
        $pages = ilLMPageObject::getPageList($this->getId());
        foreach ($pages as $p) {
            if (!$this->lm_tree->isInTree($p["obj_id"])) {
                $item = new ilLMPageObject($this, $p["obj_id"]);
                $target_item = $item->copy($a_target_obj);
                $copied_nodes[$item->getId()] = $target_item->getId();
            }
        }
        
        // Add mapping for pages and chapters
        $options = ilCopyWizardOptions::_getInstance($a_copy_id);
        foreach ($copied_nodes as $old_id => $new_id) {
            $options->appendMapping(
                $this->getRefId() . '_' . $old_id,
                $a_target_obj->getRefId() . '_' . $new_id
            );
        }
 
        ilLMObject::updateInternalLinks($copied_nodes);
 
        $a_target_obj->checkTree();
 
        return $copied_nodes;
    }

References ilCopyWizardOptions\_getInstance(), ilObject\getId(), ilLMPageObject\getPageList(), ilObject\getRefId(), IL_LAST_NODE, ilLMObject\pasteTree(), and ilLMObject\updateInternalLinks().

Referenced by cloneObject().

Here is the call graph for this function:

Here is the caller graph for this function:

create()

ilObjContentObject::create

(

$a_no_meta_data = false

)

create content object

Definition at line 83 of file class.ilObjContentObject.php.

    {
        $this->setOfflineStatus(true);
        parent::create();
        
        // meta data will be created by
        // import parser
        if (!$a_no_meta_data) {
            $this->createMetaData();
        }
 
        $this->createProperties();
        $this->updateAutoGlossaries();
    }

References ilObject\createMetaData(), createProperties(), ilObject\setOfflineStatus(), and updateAutoGlossaries().

Here is the call graph for this function:

createExportDirectory()

ilObjContentObject::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)

Definition at line 537 of file class.ilObjContentObject.php.

    {
        $ilErr = $this->error;
 
        $lm_data_dir = ilUtil::getDataDir() . "/lm_data";
        // create learning module directory (data_dir/lm_data/lm_<id>)
        $lm_dir = $lm_data_dir . "/lm_" . $this->getId();
        ilUtil::makeDirParents($lm_dir);
        if (!@is_dir($lm_dir)) {
            $ilErr->raiseError("Creation of Learning Module Directory failed.", $ilErr->FATAL);
        }
        // create Export subdirectory (data_dir/lm_data/lm_<id>/Export)
        switch ($a_type) {
            // scorm
            case "scorm":
                $export_dir = $lm_dir . "/export_scorm";
                break;
 
            default:            // = xml
                if (substr($a_type, 0, 4) == "html") {
                    $export_dir = $lm_dir . "/export_" . $a_type;
                } else {
                    $export_dir = $lm_dir . "/export";
                }
                break;
        }
        ilUtil::makeDir($export_dir);
 
        if (!@is_dir($export_dir)) {
            $ilErr->raiseError("Creation of Export Directory failed.", $ilErr->FATAL);
        }
    }

References $a_type, ilObject\$error, $ilErr, ilUtil\getDataDir(), ilObject\getId(), ilUtil\makeDir(), and ilUtil\makeDirParents().

Here is the call graph for this function:

createImportDirectory()

ilObjContentObject::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)

Definition at line 468 of file class.ilObjContentObject.php.

    {
        $ilErr = $this->error;
 
        $lm_data_dir = ilUtil::getDataDir() . "/lm_data";
        if (!is_writable($lm_data_dir)) {
            $ilErr->raiseError("Content object Data Directory (" . $lm_data_dir
                . ") not writeable.", $ilErr->FATAL);
        }
 
        // create learning module directory (data_dir/lm_data/lm_<id>)
        $lm_dir = $lm_data_dir . "/lm_" . $this->getId();
        ilUtil::makeDir($lm_dir);
        if (!@is_dir($lm_dir)) {
            $ilErr->raiseError("Creation of Learning Module Directory failed.", $ilErr->FATAL);
        }
 
        // create import subdirectory (data_dir/lm_data/lm_<id>/import)
        $import_dir = $lm_dir . "/import";
        ilUtil::makeDir($import_dir);
        if (!@is_dir($import_dir)) {
            $ilErr->raiseError("Creation of Import Directory failed.", $ilErr->FATAL);
        }
    }

References ilObject\$error, $ilErr, $import_dir, ilUtil\getDataDir(), ilObject\getId(), and ilUtil\makeDir().

Referenced by importFromZipFile().

Here is the call graph for this function:

Here is the caller graph for this function:

createLMTree()

ilObjContentObject::createLMTree

(

)

create content object tree (that stores structure object hierarchie)

todo: rename LM to ConOb

Definition at line 352 of file class.ilObjContentObject.php.

    {
        $this->lm_tree = new ilTree($this->getId());
        $this->lm_tree->setTreeTablePK("lm_id");
        $this->lm_tree->setTableNames('lm_tree', 'lm_data');
        $this->lm_tree->addTree($this->getId(), 1);
    }

References ilObject\getId().

Here is the call graph for this function:

createProperties()

ilObjContentObject::createProperties

(

)

create new properties record

Definition at line 1232 of file class.ilObjContentObject.php.

    {
        $ilDB = $this->db;
        
        $q = "INSERT INTO content_object (id) VALUES (" . $ilDB->quote($this->getId(), "integer") . ")";
        $ilDB->manipulate($q);
        
        // #14661
        ilNote::activateComments($this->getId(), 0, $this->getType(), true);
        
        $this->readProperties();                // to get db default values
    }

References ilObject\$db, $ilDB, ilNote\activateComments(), ilObject\getId(), ilObject\getType(), and readProperties().

Referenced by create().

Here is the call graph for this function:

Here is the caller graph for this function:

delete()

ilObjContentObject::delete

(

)

delete learning module and all related data

this method has been tested on may 9th 2004 meta data, content object data, data directory, bib items learning module tree and pages have been deleted correctly as desired

@access public

Returns

boolean true if all object data were removed; false if only a references were removed

Definition at line 602 of file class.ilObjContentObject.php.

    {
        $ilDB = $this->db;
 
        // always call parent delete function first!!
        if (!parent::delete()) {
            return false;
        }
 
        // delete lm object data
        ilLMObject::_deleteAllObjectData($this);
 
        // delete meta data of content object
        $this->deleteMetaData();
 
 
        // delete learning module tree
        $this->lm_tree->removeTree($this->lm_tree->getTreeId());
 
        // delete data directory
        ilUtil::delDir($this->getDataDirectory());
 
        // delete content object record
        $q = "DELETE FROM content_object WHERE id = " .
            $ilDB->quote($this->getId(), "integer");
        $ilDB->manipulate($q);
 
        // delete lm menu entries
        $q = "DELETE FROM lm_menu WHERE lm_id = " .
            $ilDB->quote($this->getId(), "integer");
        $ilDB->manipulate($q);
 
        // remove auto glossary entries
        $ilDB->manipulate(
            "DELETE FROM lm_glossaries WHERE " .
            " lm_id = " . $ilDB->quote($this->getId(), "integer")
        );
 
        
        return true;
    }

References ilObject\$db, $ilDB, ilLMObject\_deleteAllObjectData(), ilUtil\delDir(), ilObject\deleteMetaData(), getDataDirectory(), and ilObject\getId().

Here is the call graph for this function:

executeDragDrop()

ilObjContentObject::executeDragDrop	(		$source_id,
			$target_id,
			$first_child,
			$as_subitem = false,
			$movecopy = "move"
	)

Execute Drag Drop Action.

Parameters

string	$source_id	Source element ID
string	$target_id	Target element ID
string	$first_child	Insert as first child of target
string	$movecopy	Position ("move" | "copy")

Definition at line 2183 of file class.ilObjContentObject.php.

    {
        $lmtree = new ilTree($this->getId());
        $lmtree->setTableNames('lm_tree', 'lm_data');
        $lmtree->setTreeTablePK("lm_id");
        //echo "-".$source_id."-".$target_id."-".$first_child."-".$as_subitem."-";
        $source_obj = ilLMObjectFactory::getInstance($this, $source_id, true);
        $source_obj->setLMId($this->getId());
 
        if (!$first_child) {
            $target_obj = ilLMObjectFactory::getInstance($this, $target_id, true);
            $target_obj->setLMId($this->getId());
            $target_parent = $lmtree->getParentId($target_id);
        }
 
        // handle pages
        if ($source_obj->getType() == "pg") {
            //echo "1";
            if ($lmtree->isInTree($source_obj->getId())) {
                $node_data = $lmtree->getNodeData($source_obj->getId());
 
                // cut on move
                if ($movecopy == "move") {
                    $parent_id = $lmtree->getParentId($source_obj->getId());
                    $lmtree->deleteTree($node_data);
 
                    // write history entry
                    ilHistory::_createEntry(
                        $source_obj->getId(),
                        "cut",
                        array(ilLMObject::_lookupTitle($parent_id), $parent_id),
                        $this->getType() . ":pg"
                    );
                    ilHistory::_createEntry(
                        $parent_id,
                        "cut_page",
                        array(ilLMObject::_lookupTitle($source_obj->getId()), $source_obj->getId()),
                        $this->getType() . ":st"
                    );
                } else {
                    // copy page
                    $new_page = $source_obj->copy();
                    $source_id = $new_page->getId();
                    $source_obj = $new_page;
                }
 
                // paste page
                if (!$lmtree->isInTree($source_obj->getId())) {
                    if ($first_child) {                 // as first child
                        $target_pos = IL_FIRST_NODE;
                        $parent = $target_id;
                    } elseif ($as_subitem) {            // as last child
                        $parent = $target_id;
                        $target_pos = IL_FIRST_NODE;
                        $pg_childs = $lmtree->getChildsByType($parent, "pg");
                        if (count($pg_childs) != 0) {
                            $target_pos = $pg_childs[count($pg_childs) - 1]["obj_id"];
                        }
                    } else {                                            // at position
                        $target_pos = $target_id;
                        $parent = $target_parent;
                    }
 
                    // insert page into tree
                    $lmtree->insertNode(
                        $source_obj->getId(),
                        $parent,
                        $target_pos
                    );
 
                    // write history entry
                    if ($movecopy == "move") {
                        // write history comments
                        ilHistory::_createEntry(
                            $source_obj->getId(),
                            "paste",
                            array(ilLMObject::_lookupTitle($parent), $parent),
                            $this->getType() . ":pg"
                        );
                        ilHistory::_createEntry(
                            $parent,
                            "paste_page",
                            array(ilLMObject::_lookupTitle($source_obj->getId()), $source_obj->getId()),
                            $this->getType() . ":st"
                        );
                    }
                }
            }
        }
 
        // handle chapters
        if ($source_obj->getType() == "st") {
            //echo "2";
            $source_node = $lmtree->getNodeData($source_id);
            $subnodes = $lmtree->getSubtree($source_node);
 
            // check, if target is within subtree
            foreach ($subnodes as $subnode) {
                if ($subnode["obj_id"] == $target_id) {
                    return;
                }
            }
 
            $target_pos = $target_id;
 
            if ($first_child) {         // as first subchapter
                $target_pos = IL_FIRST_NODE;
                $target_parent = $target_id;
                
                $pg_childs = $lmtree->getChildsByType($target_parent, "pg");
                if (count($pg_childs) != 0) {
                    $target_pos = $pg_childs[count($pg_childs) - 1]["obj_id"];
                }
            } elseif ($as_subitem) {            // as last subchapter
                $target_parent = $target_id;
                $target_pos = IL_FIRST_NODE;
                $childs = $lmtree->getChilds($target_parent);
                if (count($childs) != 0) {
                    $target_pos = $childs[count($childs) - 1]["obj_id"];
                }
            }
 
            // insert into
            /*
                        if ($position == "into")
                        {
                            $target_parent = $target_id;
                            $target_pos = IL_FIRST_NODE;
 
                            // if target_pos is still first node we must skip all pages
                            if ($target_pos == IL_FIRST_NODE)
                            {
                                $pg_childs =& $lmtree->getChildsByType($target_parent, "pg");
                                if (count($pg_childs) != 0)
                                {
                                    $target_pos = $pg_childs[count($pg_childs) - 1]["obj_id"];
                                }
                            }
                        }
            */
 
 
            // delete source tree
            if ($movecopy == "move") {
                $lmtree->deleteTree($source_node);
            } else {
                // copy chapter (incl. subcontents)
                $new_chapter = $source_obj->copy($lmtree, $target_parent, $target_pos);
            }
 
            if (!$lmtree->isInTree($source_id)) {
                $lmtree->insertNode($source_id, $target_parent, $target_pos);
 
                // insert moved tree
                if ($movecopy == "move") {
                    foreach ($subnodes as $node) {
                        if ($node["obj_id"] != $source_id) {
                            $lmtree->insertNode($node["obj_id"], $node["parent"]);
                        }
                    }
                }
            }
 
            // check the tree
            $this->checkTree();
        }
 
        $this->checkTree();
    }

References $target_id, ilHistory\_createEntry(), ilLMObject\_lookupTitle(), checkTree(), ilObject\getId(), ilLMObjectFactory\getInstance(), ilObject\getType(), and IL_FIRST_NODE.

Here is the call graph for this function:

exportFileItems()

ilObjContentObject::exportFileItems	(		$a_target_dir,
		&	$expLog
	)

export files of file itmes

Definition at line 1805 of file class.ilObjContentObject.php.

    {
        foreach ($this->file_ids as $file_id) {
            $expLog->write(date("[y-m-d H:i:s] ") . "File Item " . $file_id);
            $file_obj = new ilObjFile($file_id, false);
            $file_obj->export($a_target_dir);
            unset($file_obj);
        }
    }

Referenced by exportXML().

Here is the caller graph for this function:

exportFO()

ilObjContentObject::exportFO	(	&	$a_xml_writer,
			$a_target_dir
	)

export scorm package

export object to fo

Parameters

object

$a_xml_writer

ilXmlWriter object that receives the xml data

Definition at line 2079 of file class.ilObjContentObject.php.

    {
        // fo:root (start)
        $attrs = array();
        $attrs["xmlns:fo"] = "http://www.w3.org/1999/XSL/Format";
        $a_xml_writer->xmlStartTag("fo:root", $attrs);
 
        // fo:layout-master-set (start)
        $attrs = array();
        $a_xml_writer->xmlStartTag("fo:layout-master-set", $attrs);
 
        // fo:simple-page-master (start)
        $attrs = array();
        $attrs["master-name"] = "DinA4";
        $attrs["page-height"] = "29.7cm";
        $attrs["page-width"] = "21cm";
        $attrs["margin-top"] = "4cm";
        $attrs["margin-bottom"] = "1cm";
        $attrs["margin-left"] = "2.8cm";
        $attrs["margin-right"] = "7.3cm";
        $a_xml_writer->xmlStartTag("fo:simple-page-master", $attrs);
 
        // fo:region-body (complete)
        $attrs = array();
        $attrs["margin-top"] = "0cm";
        $attrs["margin-bottom"] = "1.25cm";
        $a_xml_writer->xmlElement("fo:region-body", $attrs);
 
        // fo:region-before (complete)
        $attrs = array();
        $attrs["extent"] = "1cm";
        $a_xml_writer->xmlElement("fo:region-before", $attrs);
 
        // fo:region-after (complete)
        $attrs = array();
        $attrs["extent"] = "1cm";
        $a_xml_writer->xmlElement("fo:region-after", $attrs);
 
        // fo:simple-page-master (end)
        $a_xml_writer->xmlEndTag("fo:simple-page-master");
 
        // fo:layout-master-set (end)
        $a_xml_writer->xmlEndTag("fo:layout-master-set");
 
        // fo:page-sequence (start)
        $attrs = array();
        $attrs["master-reference"] = "DinA4";
        $a_xml_writer->xmlStartTag("fo:page-sequence", $attrs);
 
        // fo:flow (start)
        $attrs = array();
        $attrs["flow-name"] = "xsl-region-body";
        $a_xml_writer->xmlStartTag("fo:flow", $attrs);
 
 
        // StructureObjects
        $this->exportFOStructureObjects($a_xml_writer, $expLog);
 
        // fo:flow (end)
        $a_xml_writer->xmlEndTag("fo:flow");
 
        // fo:page-sequence (end)
        $a_xml_writer->xmlEndTag("fo:page-sequence");
 
        // fo:root (end)
        $a_xml_writer->xmlEndTag("fo:root");
    }

References exportFOStructureObjects().

Here is the call graph for this function:

exportFOStructureObjects()

ilObjContentObject::exportFOStructureObjects

(

&

$a_xml_writer

)

export structure objects to fo

Parameters

object

$a_xml_writer

ilXmlWriter object that receives the xml data

Definition at line 2153 of file class.ilObjContentObject.php.

    {
        $childs = $this->lm_tree->getChilds($this->lm_tree->getRootId());
        foreach ($childs as $child) {
            if ($child["type"] != "st") {
                continue;
            }
 
            $structure_obj = new ilStructureObject($this, $child["obj_id"]);
            $structure_obj->exportFO($a_xml_writer, $expLog);
            unset($structure_obj);
        }
    }

Referenced by exportFO().

Here is the caller graph for this function:

exportXML()

ilObjContentObject::exportXML	(	&	$a_xml_writer,
			$a_inst,
			$a_target_dir,
		&	$expLog
	)

export object to xml (see ilias_co.dtd)

Parameters

object

$a_xml_writer

ilXmlWriter object that receives the xml data

Definition at line 1638 of file class.ilObjContentObject.php.

    {
        $attrs = array();
        switch ($this->getType()) {
            case "lm":
                $attrs["Type"] = "LearningModule";
                break;
        }
        $a_xml_writer->xmlStartTag("ContentObject", $attrs);
 
        // MetaData
        $this->exportXMLMetaData($a_xml_writer);
 
        // StructureObjects
        //echo "ContObj:".$a_inst.":<br>";
        $expLog->write(date("[y-m-d H:i:s] ") . "Start Export Structure Objects");
        $this->exportXMLStructureObjects($a_xml_writer, $a_inst, $expLog);
        $expLog->write(date("[y-m-d H:i:s] ") . "Finished Export Structure Objects");
 
        // PageObjects
        $expLog->write(date("[y-m-d H:i:s] ") . "Start Export Page Objects");
        $this->exportXMLPageObjects($a_xml_writer, $a_inst, $expLog);
        $expLog->write(date("[y-m-d H:i:s] ") . "Finished Export Page Objects");
 
        // MediaObjects
        $expLog->write(date("[y-m-d H:i:s] ") . "Start Export Media Objects");
        $this->exportXMLMediaObjects($a_xml_writer, $a_inst, $a_target_dir, $expLog);
        $expLog->write(date("[y-m-d H:i:s] ") . "Finished Export Media Objects");
 
        // FileItems
        $expLog->write(date("[y-m-d H:i:s] ") . "Start Export File Items");
        $this->exportFileItems($a_target_dir, $expLog);
        $expLog->write(date("[y-m-d H:i:s] ") . "Finished Export File Items");
 
        // Questions
        if (count($this->q_ids) > 0) {
            $qti_file = fopen($a_target_dir . "/qti.xml", "w");
            $pool = new ilObjQuestionPool();
            fwrite($qti_file, $pool->questionsToXML($this->q_ids));
            fclose($qti_file);
        }
        
        // To do: implement version selection/detection
        // Properties
        $expLog->write(date("[y-m-d H:i:s] ") . "Start Export Properties");
        $this->exportXMLProperties($a_xml_writer, $expLog);
        $expLog->write(date("[y-m-d H:i:s] ") . "Finished Export Properties");
 
        $a_xml_writer->xmlEndTag("ContentObject");
    }

References exportFileItems(), exportXMLMediaObjects(), exportXMLMetaData(), exportXMLPageObjects(), exportXMLProperties(), exportXMLStructureObjects(), and ilObject\getType().

Here is the call graph for this function:

exportXMLMediaObjects()

ilObjContentObject::exportXMLMediaObjects	(	&	$a_xml_writer,
			$a_inst,
			$a_target_dir,
		&	$expLog
	)

export media objects to xml (see ilias_co.dtd)

Parameters

object

$a_xml_writer

ilXmlWriter object that receives the xml data

Definition at line 1770 of file class.ilObjContentObject.php.

    {
        $linked_mobs = array();
        
        // mobs directly embedded into pages
        foreach ($this->mob_ids as $mob_id) {
            if ($mob_id > 0 && ilObject::_lookupType($mob_id) == "mob") {
                $expLog->write(date("[y-m-d H:i:s] ") . "Media Object " . $mob_id);
                $media_obj = new ilObjMediaObject($mob_id);
                $media_obj->exportXML($a_xml_writer, $a_inst);
                $media_obj->exportFiles($a_target_dir);
                
                $lmobs = $media_obj->getLinkedMediaObjects($this->mob_ids);
                $linked_mobs = array_merge($linked_mobs, $lmobs);
                
                unset($media_obj);
            }
        }
 
        // linked mobs (in map areas)
        foreach ($linked_mobs as $mob_id) {
            if ($mob_id > 0) {
                $expLog->write(date("[y-m-d H:i:s] ") . "Media Object " . $mob_id);
                $media_obj = new ilObjMediaObject($mob_id);
                $media_obj->exportXML($a_xml_writer, $a_inst);
                $media_obj->exportFiles($a_target_dir);
                unset($media_obj);
            }
        }
    }

References ilObject\_lookupType().

Referenced by exportXML().

Here is the call graph for this function:

Here is the caller graph for this function:

exportXMLMetaData()

ilObjContentObject::exportXMLMetaData

(

&

$a_xml_writer

)

export content objects meta data to xml (see ilias_co.dtd)

Parameters

object

$a_xml_writer

ilXmlWriter object that receives the xml data

Definition at line 1695 of file class.ilObjContentObject.php.

    {
        $md2xml = new ilMD2XML($this->getId(), 0, $this->getType());
        $md2xml->setExportMode(true);
        $md2xml->startExport();
        $a_xml_writer->appendXML($md2xml->getXML());
    }

References ilObject\getId(), and ilObject\getType().

Referenced by exportXML().

Here is the call graph for this function:

Here is the caller graph for this function:

exportXMLPageObjects()

ilObjContentObject::exportXMLPageObjects	(	&	$a_xml_writer,
			$a_inst,
		&	$expLog
	)

export page objects to xml (see ilias_co.dtd)

Parameters

object

$a_xml_writer

ilXmlWriter object that receives the xml data

Definition at line 1730 of file class.ilObjContentObject.php.

    {
        $pages = ilLMPageObject::getPageList($this->getId());
        foreach ($pages as $page) {
            if (ilLMPage::_exists($this->getType(), $page["obj_id"])) {
                $expLog->write(date("[y-m-d H:i:s] ") . "Page Object " . $page["obj_id"]);
    
                // export xml to writer object
                $page_obj = new ilLMPageObject($this, $page["obj_id"]);
                $page_obj->exportXML($a_xml_writer, "normal", $a_inst);
    
                // collect media objects
                $mob_ids = $page_obj->getMediaObjectIDs();
                foreach ($mob_ids as $mob_id) {
                    $this->mob_ids[$mob_id] = $mob_id;
                }
    
                // collect all file items
                $file_ids = $page_obj->getFileItemIds();
                foreach ($file_ids as $file_id) {
                    $this->file_ids[$file_id] = $file_id;
                }
 
                // collect all questions
                $q_ids = $page_obj->getQuestionIds();
                foreach ($q_ids as $q_id) {
                    $this->q_ids[$q_id] = $q_id;
                }
    
                unset($page_obj);
            }
        }
    }

References ilPageObject\_exists(), ilObject\getId(), ilLMPageObject\getPageList(), and ilObject\getType().

Referenced by exportXML().

Here is the call graph for this function:

Here is the caller graph for this function:

exportXMLProperties()

ilObjContentObject::exportXMLProperties	(		$a_xml_writer,
		&	$expLog
	)

export properties of content object

Definition at line 1819 of file class.ilObjContentObject.php.

    {
        $attrs = array();
        $a_xml_writer->xmlStartTag("Properties", $attrs);
 
        // Layout
        $attrs = array("Name" => "Layout", "Value" => $this->getLayout());
        $a_xml_writer->xmlElement("Property", $attrs);
        
        // Page Header
        $attrs = array("Name" => "PageHeader", "Value" => $this->getPageHeader());
        $a_xml_writer->xmlElement("Property", $attrs);
        
        // TOC Mode
        $attrs = array("Name" => "TOCMode", "Value" => $this->getTOCMode());
        $a_xml_writer->xmlElement("Property", $attrs);
        
        // LM Menu Activation
        $attrs = array("Name" => "ActiveLMMenu", "Value" =>
            ilUtil::tf2yn($this->isActiveLMMenu()));
        $a_xml_writer->xmlElement("Property", $attrs);
 
        // Numbering Activation
        $attrs = array("Name" => "ActiveNumbering", "Value" =>
            ilUtil::tf2yn($this->isActiveNumbering()));
        $a_xml_writer->xmlElement("Property", $attrs);
 
        // Table of contents button activation
        $attrs = array("Name" => "ActiveTOC", "Value" =>
            ilUtil::tf2yn($this->isActiveTOC()));
        $a_xml_writer->xmlElement("Property", $attrs);
        
        // Print view button activation
        $attrs = array("Name" => "ActivePrintView", "Value" =>
            ilUtil::tf2yn($this->isActivePrintView()));
        $a_xml_writer->xmlElement("Property", $attrs);
        
        // Note that download button is not saved, because
        // download files do not exist after import
 
        // Clean frames
        $attrs = array("Name" => "CleanFrames", "Value" =>
            ilUtil::tf2yn($this->cleanFrames()));
        $a_xml_writer->xmlElement("Property", $attrs);
        
        // Public notes activation
        $attrs = array("Name" => "PublicNotes", "Value" =>
            ilUtil::tf2yn($this->publicNotes()));
        $a_xml_writer->xmlElement("Property", $attrs);
        
        // History comments for authors activation
        $attrs = array("Name" => "HistoryUserComments", "Value" =>
            ilUtil::tf2yn($this->isActiveHistoryUserComments()));
        $a_xml_writer->xmlElement("Property", $attrs);
        
        // Rating
        $attrs = array("Name" => "Rating", "Value" =>
            ilUtil::tf2yn($this->hasRating()));
        $a_xml_writer->xmlElement("Property", $attrs);
        $attrs = array("Name" => "RatingPages", "Value" =>
            ilUtil::tf2yn($this->hasRatingPages()));
        $a_xml_writer->xmlElement("Property", $attrs);
 
        // Header Page
        if ($this->getHeaderPage() > 0) {
            $attrs = array("Name" => "HeaderPage", "Value" =>
                "il_" . IL_INST_ID . "_pg_" . $this->getHeaderPage());
            $a_xml_writer->xmlElement("Property", $attrs);
        }
 
        // Footer Page
        if ($this->getFooterPage() > 0) {
            $attrs = array("Name" => "FooterPage", "Value" =>
                "il_" . IL_INST_ID . "_pg_" . $this->getFooterPage());
            $a_xml_writer->xmlElement("Property", $attrs);
        }
 
        // layout per page
        $attrs = array("Name" => "LayoutPerPage", "Value" =>
            $this->getLayoutPerPage());
        $a_xml_writer->xmlElement("Property", $attrs);
 
        // progress icons
        $attrs = array("Name" => "ProgressIcons", "Value" =>
            $this->getProgressIcons());
        $a_xml_writer->xmlElement("Property", $attrs);
 
        // store tries
        $attrs = array("Name" => "StoreTries", "Value" =>
            $this->getStoreTries());
        $a_xml_writer->xmlElement("Property", $attrs);
 
        // restrict forward navigation
        $attrs = array("Name" => "RestrictForwardNavigation", "Value" =>
            $this->getRestrictForwardNavigation());
        $a_xml_writer->xmlElement("Property", $attrs);
 
        // disable default feedback
        $attrs = array("Name" => "DisableDefaultFeedback", "Value" =>
            $this->getDisableDefaultFeedback());
        $a_xml_writer->xmlElement("Property", $attrs);
 
        $a_xml_writer->xmlEndTag("Properties");
    }

References cleanFrames(), getDisableDefaultFeedback(), getFooterPage(), getHeaderPage(), getLayout(), getLayoutPerPage(), getPageHeader(), getProgressIcons(), getRestrictForwardNavigation(), getStoreTries(), getTOCMode(), hasRating(), hasRatingPages(), isActiveHistoryUserComments(), isActiveLMMenu(), isActiveNumbering(), isActivePrintView(), isActiveTOC(), publicNotes(), and ilUtil\tf2yn().

Referenced by exportXML().

Here is the call graph for this function:

Here is the caller graph for this function:

exportXMLStructureObjects()

ilObjContentObject::exportXMLStructureObjects	(	&	$a_xml_writer,
			$a_inst,
		&	$expLog
	)

export structure objects to xml (see ilias_co.dtd)

Parameters

object

$a_xml_writer

ilXmlWriter object that receives the xml data

Definition at line 1709 of file class.ilObjContentObject.php.

    {
        $childs = $this->lm_tree->getChilds($this->lm_tree->getRootId());
        foreach ($childs as $child) {
            if ($child["type"] != "st") {
                continue;
            }
 
            $structure_obj = new ilStructureObject($this, $child["obj_id"]);
            $structure_obj->exportXML($a_xml_writer, $a_inst, $expLog);
            unset($structure_obj);
        }
    }

Referenced by exportXML().

Here is the caller graph for this function:

fixTree()

ilObjContentObject::fixTree

(

)

fix tree

Definition at line 1404 of file class.ilObjContentObject.php.

    {
        $ilDB = $this->db;
 
        $tree = $this->getLMTree();
        
        // check numbering, if errors, renumber
        // it is very important to keep this step before deleting subtrees
        // in the following steps
        $set = $ilDB->query(
            "SELECT DISTINCT l1.lm_id" .
            " FROM lm_tree l1" .
            " JOIN lm_tree l2 ON ( l1.child = l2.parent" .
            " AND l1.lm_id = l2.lm_id )" .
            " JOIN lm_data ON ( l1.child = lm_data.obj_id )" .
            " WHERE (l2.lft < l1.lft" .
            " OR l2.rgt > l1.rgt OR l2.lft > l1.rgt OR l2.rgt < l1.lft)" .
            " AND l1.lm_id = " . $ilDB->quote($this->getId(), "integer") .
            " ORDER BY lm_data.create_date DESC"
        );
        if ($rec = $ilDB->fetchAssoc($set)) {
            $tree->renumber();
        }
 
        // delete subtrees that have no lm_data records (changed due to #20637)
        $set = $ilDB->query("SELECT * FROM lm_tree WHERE lm_tree.lm_id = " . $ilDB->quote($this->getId(), "integer"));
        while ($node = $ilDB->fetchAssoc($set)) {
            $q = "SELECT * FROM lm_data WHERE obj_id = " .
                $ilDB->quote($node["child"], "integer");
            $obj_set = $ilDB->query($q);
            $obj_rec = $ilDB->fetchAssoc($obj_set);
            if (!$obj_rec) {
                $node_data = $tree->getNodeData($node["child"]);
                $node_data["child"] = $node["child"];
                $tree->deleteTree($node_data);
            }
        }
 
        // delete subtrees that have pages as parent
        $nodes = $tree->getSubtree($tree->getNodeData($tree->getRootId()));
        foreach ($nodes as $node) {
            $q = "SELECT * FROM lm_data WHERE obj_id = " .
                $ilDB->quote($node["parent"], "integer");
            $obj_set = $ilDB->query($q);
            $obj_rec = $ilDB->fetchAssoc($obj_set);
            if ($obj_rec["type"] == "pg") {
                $node_data = $tree->getNodeData($node["child"]);
                if ($tree->isInTree($node["child"])) {
                    $tree->deleteTree($node_data);
                }
            }
        }
 
        // check for multi-references pages or chapters
        // if errors -> create copies of them here
        $set = $ilDB->query("SELECT DISTINCT l1.lm_id" .
                " FROM lm_tree l1" .
                " JOIN lm_tree l2 ON ( l1.child = l2.child AND l1.lm_id <> l2.lm_id )" .
                " JOIN lm_data ON (l1.child = lm_data.obj_id)" .
                " WHERE l1.child <> 1" .
                " AND l1.lm_id <> lm_data.lm_id" .
                " AND l1.lm_id = " . $ilDB->quote($this->getId(), "integer"));
        if ($rec = $ilDB->fetchAssoc($set)) {
            $set = $ilDB->query("SELECT DISTINCT l1.child " .
                " FROM lm_tree l1" .
                " JOIN lm_tree l2 ON ( l1.child = l2.child AND l1.lm_id <> l2.lm_id )" .
                " JOIN lm_data ON (l1.child = lm_data.obj_id)" .
                " WHERE l1.child <> 1" .
                " AND l1.lm_id <> lm_data.lm_id" .
                " AND l1.lm_id = " . $ilDB->quote($this->getId(), "integer"));
            while ($rec = $ilDB->fetchAssoc($set)) {
                $cobj = ilLMObjectFactory::getInstance($this, $rec["child"]);
 
                if (is_object($cobj)) {
                    if ($cobj->getType() == "pg") {
                        // make a copy of it
                        $pg_copy = $cobj->copy($this);
                        
                        // replace the child in the tree with the copy (id)
                        $ilDB->manipulate(
                            "UPDATE lm_tree SET " .
                            " child = " . $ilDB->quote($pg_copy->getId(), "integer") .
                            " WHERE child = " . $ilDB->quote($cobj->getId(), "integer") .
                            " AND lm_id = " . $ilDB->quote($this->getId(), "integer")
                        );
                    } elseif ($cobj->getType() == "st") {
                        // make a copy of it
                        $st_copy = $cobj->copy($this);
                        
                        // replace the child in the tree with the copy (id)
                        $ilDB->manipulate(
                            "UPDATE lm_tree SET " .
                            " child = " . $ilDB->quote($st_copy->getId(), "integer") .
                            " WHERE child = " . $ilDB->quote($cobj->getId(), "integer") .
                            " AND lm_id = " . $ilDB->quote($this->getId(), "integer")
                        );
                        
                        // make all childs refer to the copy now
                        $ilDB->manipulate(
                            "UPDATE lm_tree SET " .
                            " parent = " . $ilDB->quote($st_copy->getId(), "integer") .
                            " WHERE parent = " . $ilDB->quote($cobj->getId(), "integer") .
                            " AND lm_id = " . $ilDB->quote($this->getId(), "integer")
                        );
                    }
                }
            }
        }
 
        // missing copage entries
        $set = $ilDB->queryF(
            "SELECT * FROM lm_data " .
            " WHERE lm_id = %s AND type = %s",
            array("integer", "text"),
            array($this->getId(), "pg")
        );
        while ($rec = $ilDB->fetchAssoc($set)) {
            if (!ilPageObject::_exists("lm", $rec["obj_id"], "-")) {
                $lm_page = new ilLMPage();
                $lm_page->setId($rec["obj_id"]);
                $lm_page->setParentId($this->getId());
                $lm_page->create();
            }
        }
    }

References ilObject\$db, $ilDB, ilObject\$tree, ilPageObject\_exists(), ilObject\getId(), ilLMObjectFactory\getInstance(), and getLMTree().

Here is the call graph for this function:

getAutoGlossaries()

ilObjContentObject::getAutoGlossaries

(

)

Get auto glossaries.

Returns

array int

Definition at line 384 of file class.ilObjContentObject.php.

    {
        return $this->auto_glossaries;
    }

References $auto_glossaries.

Referenced by cloneObject(), removeAutoGlossary(), and updateAutoGlossaries().

Here is the caller graph for this function:

getAvailableLayouts()

static ilObjContentObject::getAvailableLayouts ( )

static

get all available lm layouts

Definition at line 1249 of file class.ilObjContentObject.php.

    {
        $dir = opendir("./Modules/LearningModule/layouts/lm");
 
        $layouts = array();
 
        while ($file = readdir($dir)) {
            if ($file != "." && $file != ".." && $file != "CVS" && $file != ".svn") {
                // directories
                if (@is_dir("./Modules/LearningModule/layouts/lm/" . $file)) {
                    $layouts[$file] = $file;
                }
            }
        }
        asort($layouts);
        
        // workaround: fix ordering
        $ret = array(
            'toc2win' => 'toc2win',
            'toc2windyn' => 'toc2windyn',
            '1window' => '1window',
            '2window' => '2window',
            '3window' => '3window',
            'presentation' => 'presentation',
            'fullscreen' => 'fullscreen'
            );
        
        foreach ($layouts as $l) {
            if (!in_array($l, $ret)) {
                $ret[$l] = $l;
            }
        }
 
        return $ret;
    }

References $ret.

Referenced by ilObjContentObjectGUI\getLayoutOption(), and ilLMPageObjectGUI\initEditLayoutForm().

Here is the caller graph for this function:

getDataDirectory()

ilObjContentObject::getDataDirectory

(

)

get data directory

Definition at line 496 of file class.ilObjContentObject.php.

    {
        return ilUtil::getDataDir() . "/lm_data" .
            "/lm_" . $this->getId();
    }

References ilUtil\getDataDir(), and ilObject\getId().

Referenced by delete().

Here is the call graph for this function:

Here is the caller graph for this function:

getDescription()

ilObjContentObject::getDescription

(

)

get description of content object

Returns

string description

Reimplemented from ilObject.

Definition at line 154 of file class.ilObjContentObject.php.

    {
        return parent::getDescription();
    }

Referenced by cloneObject().

Here is the caller graph for this function:

getDisableDefaultFeedback()

ilObjContentObject::getDisableDefaultFeedback

(

)

Get disable default feedback for questions.

Returns

bool disable default feedback

Definition at line 214 of file class.ilObjContentObject.php.

    {
        return $this->disable_def_feedback;
    }

Referenced by cloneObject(), exportXMLProperties(), and updateProperties().

Here is the caller graph for this function:

getExportDirectory()

ilObjContentObject::getExportDirectory

(

$a_type = "xml"

)

get export directory of lm

Definition at line 573 of file class.ilObjContentObject.php.

    {
        switch ($a_type) {
            case "scorm":
                $export_dir = ilUtil::getDataDir() . "/lm_data" . "/lm_" . $this->getId() . "/export_scorm";
                break;
                
            default:                    // = xml
                if (substr($a_type, 0, 4) == "html") {
                    $export_dir = ilUtil::getDataDir() . "/lm_data" . "/lm_" . $this->getId() . "/export_" . $a_type;
                } else {
                    $export_dir = ilUtil::getDataDir() . "/lm_data" . "/lm_" . $this->getId() . "/export";
                }
                break;
        }
        return $export_dir;
    }

References $a_type, ilUtil\getDataDir(), and ilObject\getId().

Referenced by getExportFiles(), and getPublicExportFiles().

Here is the call graph for this function:

Here is the caller graph for this function:

getExportFiles()

ilObjContentObject::getExportFiles

(

)

get export files

Definition at line 1927 of file class.ilObjContentObject.php.

    {
        $file = array();
        
        $types = array("xml", "html", "scorm");
        
        foreach ($types as $type) {
            $dir = $this->getExportDirectory($type);
            // quit if import dir not available
            if (!@is_dir($dir) or
                !is_writeable($dir)) {
                continue;
            }
    
            // open directory
            $cdir = dir($dir);
    
            // initialize array
    
            // get files and save the in the array
            while ($entry = $cdir->read()) {
                if ($entry != "." and
                    $entry != ".." and
                    substr($entry, -4) == ".zip" and
                    preg_match("~^[0-9]{10}_{2}[0-9]+_{2}(lm_)*[0-9]+\.zip\$~", $entry)) {
                    $file[$entry . $type] = array("type" => $type, "file" => $entry,
                        "size" => filesize($dir . "/" . $entry));
                }
            }
    
            // close import directory
            $cdir->close();
        }
 
        // sort files
        ksort($file);
        reset($file);
        return $file;
    }

References ilObject\$type, and getExportDirectory().

Here is the call graph for this function:

getFooterPage()

ilObjContentObject::getFooterPage

(

)

Definition at line 1132 of file class.ilObjContentObject.php.

    {
        return $this->footer_page;
    }

Referenced by cloneObject(), exportXMLProperties(), and updateProperties().

Here is the caller graph for this function:

getForTranslation()

ilObjContentObject::getForTranslation

(

)

Get for translation.

Returns

bool lm has been imported for translation purposes

Definition at line 449 of file class.ilObjContentObject.php.

    {
        return $this->for_translation;
    }

References $for_translation.

Referenced by updateProperties().

Here is the caller graph for this function:

getHeaderPage()

ilObjContentObject::getHeaderPage

(

)

Definition at line 1122 of file class.ilObjContentObject.php.

    {
        return $this->header_page;
    }

Referenced by cloneObject(), exportXMLProperties(), and updateProperties().

Here is the caller graph for this function:

getHideHeaderFooterPrint()

ilObjContentObject::getHideHeaderFooterPrint

(

)

Get hide header footer in print mode.

Returns

bool hide header and footer?

Definition at line 1057 of file class.ilObjContentObject.php.

    {
        return $this->hide_header_footer_print;
    }

Referenced by updateProperties().

Here is the caller graph for this function:

getImportDirectory()

ilObjContentObject::getImportDirectory

(

)

get import directory of lm

Definition at line 505 of file class.ilObjContentObject.php.

    {
        if (strlen($this->import_dir)) {
            return $this->import_dir;
        }
        
        $import_dir = ilUtil::getDataDir() . "/lm_data" .
            "/lm_" . $this->getId() . "/import";
        if (@is_dir($import_dir)) {
            return $import_dir;
        } else {
            return false;
        }
    }

References $import_dir, ilUtil\getDataDir(), and ilObject\getId().

Referenced by importFromZipFile().

Here is the call graph for this function:

Here is the caller graph for this function:

getImportId()

ilObjContentObject::getImportId

(

)

get import id

@access public

Returns

string import id

Reimplemented from ilObject.

Definition at line 169 of file class.ilObjContentObject.php.

    {
        return $this->import_id;
    }

References ilObject\$import_id.

Referenced by importFromDirectory().

Here is the caller graph for this function:

getLayout()

ilObjContentObject::getLayout

(

)

get default page layout of content object (see directory layouts/)

Returns

string default layout

Definition at line 650 of file class.ilObjContentObject.php.

    {
        return $this->layout;
    }

References $layout.

Referenced by cloneObject(), exportXMLProperties(), and updateProperties().

Here is the caller graph for this function:

getLayoutPerPage()

ilObjContentObject::getLayoutPerPage

(

)

Get layout per page.

Returns

boolean layout per page

Definition at line 194 of file class.ilObjContentObject.php.

    {
        return $this->layout_per_page;
    }

Referenced by cloneObject(), exportXMLProperties(), and updateProperties().

Here is the caller graph for this function:

getLMTree()

ilObjContentObject::getLMTree

(

)

get content object tree

Definition at line 457 of file class.ilObjContentObject.php.

    {
        return $this->lm_tree;
    }

References $lm_tree.

Referenced by checkStructure(), and fixTree().

Here is the caller graph for this function:

getOfflineFiles()

ilObjContentObject::getOfflineFiles

(

$dir

)

get offline files

Definition at line 1993 of file class.ilObjContentObject.php.

    {
        // quit if offline dir not available
        if (!@is_dir($dir) or
            !is_writeable($dir)) {
            return array();
        }
 
        // open directory
        $dir = dir($dir);
 
        // initialize array
        $file = array();
 
        // get files and save the in the array
        while ($entry = $dir->read()) {
            if ($entry != "." and
                $entry != ".." and
                substr($entry, -4) == ".pdf" and
                preg_match("~^[0-9]{10}_{2}[0-9]+_{2}(lm_)*[0-9]+\.pdf\$~", $entry)) {
                $file[] = $entry;
            }
        }
 
        // close import directory
        $dir->close();
 
        // sort files
        sort($file);
        reset($file);
 
        return $file;
    }

getPageHeader()

ilObjContentObject::getPageHeader

(

)

get page header mode (ilLMOBject::CHAPTER_TITLE | ilLMOBject::PAGE_TITLE | ilLMOBject::NO_HEADER)

Definition at line 951 of file class.ilObjContentObject.php.

    {
        return $this->pg_header;
    }

References $pg_header.

Referenced by cloneObject(), exportXMLProperties(), and updateProperties().

Here is the caller graph for this function:

getProgressIcons()

ilObjContentObject::getProgressIcons

(

)

Get progress icons.

Returns

bool show progress icons

Definition at line 234 of file class.ilObjContentObject.php.

    {
        return $this->progr_icons;
    }

Referenced by cloneObject(), exportXMLProperties(), and updateProperties().

Here is the caller graph for this function:

getPublicAccessMode()

ilObjContentObject::getPublicAccessMode

(

)

get public access mode ("complete" | "selected")

Definition at line 977 of file class.ilObjContentObject.php.

    {
        return $this->public_access_mode;
    }

Referenced by cloneObject(), and updateProperties().

Here is the caller graph for this function:

getPublicExportFile()

ilObjContentObject::getPublicExportFile

(

$a_type

)

get public export file

Parameters

string

$a_type

type ("xml" / "html")

Returns

string $a_file file name

Definition at line 1985 of file class.ilObjContentObject.php.

    {
        return $this->public_export_file[$a_type];
    }

References $a_type.

Referenced by getPublicExportFiles(), and updateProperties().

Here is the caller graph for this function:

getPublicExportFiles()

ilObjContentObject::getPublicExportFiles

(

)

Get public export files.

Returns

array array of arrays with keys "type" (html, scorm or xml), "file" (filename) and "size" in bytes, "dir_type" detailed directoy type, e.g. html_de

Definition at line 2835 of file class.ilObjContentObject.php.

    {
        $dirs = array("xml", "scorm");
        $export_files = array();
 
        $ot = ilObjectTranslation::getInstance($this->getId());
        if ($ot->getContentActivated()) {
            $langs = $ot->getLanguages();
            foreach ($langs as $l => $ldata) {
                $dirs[] = "html_" . $l;
            }
            $dirs[] = "html_all";
        } else {
            $dirs[] = "html";
        }
 
        foreach ($dirs as $dir) {
            $type = explode("_", $dir);
            $type = $type[0];
            if ($this->getPublicExportFile($type) != "") {
                if (is_file($this->getExportDirectory($dir) . "/" .
                    $this->getPublicExportFile($type))) {
                    $size = filesize($this->getExportDirectory($dir) . "/" .
                        $this->getPublicExportFile($type));
                    $export_files[] = array("type" => $type,
                        "dir_type" => $dir,
                        "file" => $this->getPublicExportFile($type),
                        "size" => $size);
                }
            }
        }
 
        return $export_files;
    }

References $size, ilObject\$type, getExportDirectory(), ilObject\getId(), ilObjectTranslation\getInstance(), and getPublicExportFile().

Here is the call graph for this function:

getRestrictForwardNavigation()

ilObjContentObject::getRestrictForwardNavigation

(

)

Get restrict forward navigation.

Returns

bool restrict forward navigation

Definition at line 274 of file class.ilObjContentObject.php.

    {
        return $this->restrict_forw_nav;
    }

Referenced by cloneObject(), exportXMLProperties(), and updateProperties().

Here is the caller graph for this function:

getStoreTries()

ilObjContentObject::getStoreTries

(

)

Get store tries.

Returns

bool store tries

Definition at line 254 of file class.ilObjContentObject.php.

    {
        return $this->store_tries;
    }

Referenced by cloneObject(), exportXMLProperties(), and updateProperties().

Here is the caller graph for this function:

getStyleSheetId()

ilObjContentObject::getStyleSheetId

(

)

get ID of assigned style sheet object

Definition at line 668 of file class.ilObjContentObject.php.

    {
        return $this->style_id;
    }

References $style_id.

Referenced by cloneObject(), and updateProperties().

Here is the caller graph for this function:

getTitle()

ilObjContentObject::getTitle

(

)

get title of content object

Returns

string title

Reimplemented from ilObject.

Definition at line 135 of file class.ilObjContentObject.php.

    {
        return parent::getTitle();
    }

getTOCMode()

ilObjContentObject::getTOCMode

(

)

get toc mode ("chapters" | "pages")

Definition at line 969 of file class.ilObjContentObject.php.

    {
        return $this->toc_mode;
    }

Referenced by cloneObject(), exportXMLProperties(), and updateProperties().

Here is the caller graph for this function:

getTree()

& ilObjContentObject::getTree

(

)

Definition at line 280 of file class.ilObjContentObject.php.

    {
        return $this->lm_tree;
    }

References $lm_tree.

getXMLZip()

ilObjContentObject::getXMLZip

(

)

Reimplemented from ilObject.

Definition at line 2167 of file class.ilObjContentObject.php.

    {
        $cont_exp = new ilContObjectExport($this, 'xml');
 
        $export_file = $cont_exp->buildExportFile();
        return $export_file;
    }

hasRating()

ilObjContentObject::hasRating

(

)

Definition at line 2774 of file class.ilObjContentObject.php.

    {
        return $this->rating;
    }

References $rating.

Referenced by cloneObject(), exportXMLProperties(), and updateProperties().

Here is the caller graph for this function:

hasRatingPages()

ilObjContentObject::hasRatingPages

(

)

Definition at line 2784 of file class.ilObjContentObject.php.

    {
        return $this->rating_pages;
    }

References $rating_pages.

Referenced by cloneObject(), exportXMLProperties(), and updateProperties().

Here is the caller graph for this function:

hasSuccessorPage()

static ilObjContentObject::hasSuccessorPage (   $a_cont_obj_id,   $a_page_id  )

static

checks if page has a successor page

Definition at line 1376 of file class.ilObjContentObject.php.

    {
        $tree = new ilTree($a_cont_obj_id);
        $tree->setTableNames('lm_tree', 'lm_data');
        $tree->setTreeTablePK("lm_id");
        if ($tree->isInTree($a_page_id)) {
            $succ = $tree->fetchSuccessorNode($a_page_id, "pg");
            if ($succ > 0) {
                return true;
            }
        }
        return false;
    }

References ilObject\$tree.

Referenced by ilPageObjectGUI\showPage().

Here is the caller graph for this function:

import()

ilObjContentObject::import

(

)

if implemented, this function should be called from an Out/GUI-Object

Definition at line 324 of file class.ilObjContentObject.php.

    {
        // nothing to do. just display the dialogue in Out
        return;
    }

importFromDirectory()

ilObjContentObject::importFromDirectory	(		$a_directory,
			$a_validate = true,
			$a_mapping = null
	)

Import lm from directory.

Parameters

return

Definition at line 2441 of file class.ilObjContentObject.php.

    {
        $lng = $this->lng;
 
        $this->log->debug("import from directory " . $a_directory);
        
        // determine filename of xml file
        $subdir = basename($a_directory);
        $xml_file = $a_directory . "/" . $subdir . ".xml";
 
        // check directory exists within zip file
        if (!is_dir($a_directory)) {
            $this->log->error(sprintf($lng->txt("cont_no_subdir_in_zip"), $subdir));
            return sprintf($lng->txt("cont_no_subdir_in_zip"), $subdir);
        }
 
        // check whether xml file exists within zip file
        if (!is_file($xml_file)) {
            $this->log->error(sprintf($lng->txt("cont_zip_file_invalid"), $subdir . "/" . $subdir . ".xml"));
            return sprintf($lng->txt("cont_zip_file_invalid"), $subdir . "/" . $subdir . ".xml");
        }
 
        // import questions
        $this->log->debug("import qti");
        $qti_file = $a_directory . "/qti.xml";
        $qtis = array();
        if (is_file($qti_file)) {
            $qtiParser = new ilQTIParser(
                $qti_file,
                IL_MO_VERIFY_QTI,
                0,
                ""
            );
            $result = $qtiParser->startParsing();
            $founditems = &$qtiParser->getFoundItems();
            $testObj = new ilObjTest(0, true);
            if (count($founditems) > 0) {
                $qtiParser = new ilQTIParser($qti_file, IL_MO_PARSE_QTI, 0, "");
                $qtiParser->setTestObject($testObj);
                $result = $qtiParser->startParsing();
                $qtis = array_merge($qtis, $qtiParser->getImportMapping());
            }
        }
 
        $this->log->debug("get ilContObjParser");
        $subdir = ".";
        $contParser = new ilContObjParser($this, $xml_file, $subdir, $a_directory);
        // smeyer: added \ilImportMapping lok im/export
        $contParser->setImportMapping($a_mapping);
        $contParser->setQuestionMapping($qtis);
        $contParser->startParsing();
        ilObject::_writeImportId($this->getId(), $this->getImportId());
        $this->MDUpdateListener('General');
 
        // import style
        $style_file = $a_directory . "/style.xml";
        $style_zip_file = $a_directory . "/style.zip";
        if (is_file($style_zip_file)) { // try to import style.zip first
            $style = new ilObjStyleSheet();
            $style->import($style_zip_file);
            $this->writeStyleSheetId($style->getId());
        } elseif (is_file($style_file)) {       // try to import style.xml
            $style = new ilObjStyleSheet();
            $style->import($style_file);
            $this->writeStyleSheetId($style->getId());
        }
 
        //              // validate
        if ($a_validate) {
            $mess = $this->validatePages();
        }
 
        if ($mess == "") {
            // handle internal links to this learning module
            ilLMPage::_handleImportRepositoryLinks(
                $this->getImportId(),
                $this->getType(),
                $this->getRefId()
            );
        }
 
        return $mess;
    }

References ilObject\$lng, $result, ilPageObject\_handleImportRepositoryLinks(), ilObject\_writeImportId(), ilObject\getId(), getImportId(), ilObject\getRefId(), ilObject\getType(), IL_MO_PARSE_QTI, IL_MO_VERIFY_QTI, MDUpdateListener(), validatePages(), and writeStyleSheetId().

Referenced by importFromZipFile().

Here is the call graph for this function:

Here is the caller graph for this function:

importFromZipFile()

ilObjContentObject::importFromZipFile	(		$a_tmp_file,
			$a_filename,
			$a_validate = true,
			$a_import_into_help_module = 0
	)

Import lm from zip file.

Parameters

return

Definition at line 2395 of file class.ilObjContentObject.php.

      {
        $lng = $this->lng;
 
        // create import directory
        $this->createImportDirectory();
 
        // copy uploaded file to import directory
        $file = pathinfo($a_filename);
        $full_path = $this->getImportDirectory() . "/" . $a_filename;
 
        ilUtil::moveUploadedFile(
            $a_tmp_file,
            $a_filename,
            $full_path
        );
 
        // unzip file
        ilUtil::unzip($full_path);
 
        $subdir = basename($file["basename"], "." . $file["extension"]);
 
        $mess = $this->importFromDirectory(
            $this->getImportDirectory() . "/" . $subdir,
            $a_validate
        );
 
        
        // delete import directory
        ilUtil::delDir($this->getImportDirectory());
 
        return $mess;
    }

References ilObject\$lng, createImportDirectory(), ilUtil\delDir(), getImportDirectory(), importFromDirectory(), ilUtil\moveUploadedFile(), and ilUtil\unzip().

Here is the call graph for this function:

isActiveDownloads()

ilObjContentObject::isActiveDownloads

(

)

Definition at line 1067 of file class.ilObjContentObject.php.

    {
        return $this->downloads_active;
    }

Referenced by cloneObject(), and updateProperties().

Here is the caller graph for this function:

isActiveDownloadsPublic()

ilObjContentObject::isActiveDownloadsPublic

(

)

Definition at line 1077 of file class.ilObjContentObject.php.

    {
        return $this->downloads_public_active;
    }

Referenced by cloneObject(), and updateProperties().

Here is the caller graph for this function:

isActiveHistoryUserComments()

ilObjContentObject::isActiveHistoryUserComments

(

)

Definition at line 1112 of file class.ilObjContentObject.php.

    {
        return $this->user_comments;
    }

Referenced by cloneObject(), exportXMLProperties(), and updateProperties().

Here is the caller graph for this function:

isActiveLMMenu()

ilObjContentObject::isActiveLMMenu

(

)

Definition at line 997 of file class.ilObjContentObject.php.

    {
        return $this->lm_menu_active;
    }

Referenced by cloneObject(), exportXMLProperties(), and updateProperties().

Here is the caller graph for this function:

isActiveNumbering()

ilObjContentObject::isActiveNumbering

(

)

Definition at line 1017 of file class.ilObjContentObject.php.

    {
        return $this->numbering;
    }

Referenced by cloneObject(), exportXMLProperties(), and updateProperties().

Here is the caller graph for this function:

isActivePreventGlossaryAppendix()

ilObjContentObject::isActivePreventGlossaryAppendix

(

)

Definition at line 1037 of file class.ilObjContentObject.php.

    {
        return $this->prevent_glossary_appendix_active;
    }

Referenced by cloneObject(), and updateProperties().

Here is the caller graph for this function:

isActivePrintView()

ilObjContentObject::isActivePrintView

(

)

Definition at line 1027 of file class.ilObjContentObject.php.

    {
        return $this->print_view_active;
    }

Referenced by cloneObject(), exportXMLProperties(), and updateProperties().

Here is the caller graph for this function:

isActiveTOC()

ilObjContentObject::isActiveTOC

(

)

Definition at line 1007 of file class.ilObjContentObject.php.

    {
        return $this->toc_active;
    }

Referenced by cloneObject(), exportXMLProperties(), and updateProperties().

Here is the caller graph for this function:

isOnlineHelpModule()

static ilObjContentObject::isOnlineHelpModule (   $a_id,   $a_as_obj_id = false  )

static

Is module an online module.

Returns

boolean true, if current learning module is an online help lm

Definition at line 2758 of file class.ilObjContentObject.php.

    {
        if (!$a_as_obj_id && $a_id > 0 && $a_id == OH_REF_ID) {
            return true;
        }
        if ($a_as_obj_id && $a_id > 0 && $a_id == ilObject::_lookupObjId(OH_REF_ID)) {
            return true;
        }
        return false;
    }

References ilObject\_lookupObjId().

Referenced by ilContObjectExport\buildExportFileXML(), ilLMPageConfig\configureByObjectId(), ilLearningModuleExporter\getXmlExportTailDependencies(), ilObjContentObjectGUI\setContentSubTabs(), and ilObjContentObjectGUI\showExportIDsOverview().

Here is the call graph for this function:

Here is the caller graph for this function:

lookupAutoGlossaries()

static ilObjContentObject::lookupAutoGlossaries (   $a_lm_id )

static

Lookup auto glossaries.

Parameters

return

Definition at line 2694 of file class.ilObjContentObject.php.

    {
        global $DIC;
 
        $ilDB = $DIC->database();
        
        // read auto glossaries
        $set = $ilDB->query(
            "SELECT * FROM lm_glossaries " .
            " WHERE lm_id = " . $ilDB->quote($a_lm_id, "integer")
        );
        $glos = array();
        while ($rec = $ilDB->fetchAssoc($set)) {
            $glos[] = $rec["glo_id"];
        }
        return $glos;
    }

References $DIC, and $ilDB.

Referenced by ilLMPage\beforePageContentUpdate().

Here is the caller graph for this function:

MDUpdateListener()

ilObjContentObject::MDUpdateListener

(

$a_element

)

Meta data update listener.

Important note: Do never call create() or update() method of ilObject here. It would result in an endless loop: update object -> update meta -> update object -> ... Use static _writeTitle() ... methods instead.

Parameters

string

$a_element

Reimplemented from ilObject.

Definition at line 2790 of file class.ilObjContentObject.php.

    {
        parent::MDUpdateListener($a_element);
        
        switch ($a_element) {
            case 'Educational':
                $obj_lp = ilObjectLP::getInstance($this->getId());
                if (in_array(
                    $obj_lp->getCurrentMode(),
                    array(ilLPObjSettings::LP_MODE_TLT, ilLPObjSettings::LP_MODE_COLLECTION_TLT)
                )) {
                    ilLPStatusWrapper::_refreshStatus($this->getId());
                }
                break;
 
            case 'General':
 
                // Update Title and description
                $md = new ilMD($this->getId(), 0, $this->getType());
                if (!is_object($md_gen = $md->getGeneral())) {
                    return false;
                }
 
                $ot = ilObjectTranslation::getInstance($this->getId());
                if ($ot->getContentActivated()) {
                    $ot->setDefaultTitle($md_gen->getTitle());
 
                    foreach ($md_gen->getDescriptionIds() as $id) {
                        $md_des = $md_gen->getDescription($id);
                        $ot->setDefaultDescription($md_des->getDescription());
                        break;
                    }
                    $ot->save();
                }
                break;
 
        }
        return true;
    }

References ilObject\$id, ilLPStatusWrapper\_refreshStatus(), ilObject\getId(), ilObjectLP\getInstance(), ilObjectTranslation\getInstance(), ilObject\getType(), ilLPObjSettings\LP_MODE_COLLECTION_TLT, and ilLPObjSettings\LP_MODE_TLT.

Referenced by importFromDirectory().

Here is the call graph for this function:

Here is the caller graph for this function:

publicNotes()

ilObjContentObject::publicNotes

(

)

Definition at line 1087 of file class.ilObjContentObject.php.

    {
        return $this->pub_notes;
    }

Referenced by cloneObject(), exportXMLProperties(), and updateProperties().

Here is the caller graph for this function:

putInTree()

ilObjContentObject::putInTree

(

$a_parent

)

put content object in main tree

Reimplemented from ilObject.

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

    {
        $tree = $this->tree;
 
        // put this object in tree under $a_parent
        parent::putInTree($a_parent);
 
        // make new tree for this object
        //$tree->addTree($this->getId());
    }

References ilObject\$tree.

read()

ilObjContentObject::read

(

)

read data of content object

Reimplemented from ilObject.

Definition at line 103 of file class.ilObjContentObject.php.

    {
        $ilDB = $this->db;
        
        parent::read();
        #               echo "Content<br>\n";
 
        $this->lm_tree = new ilTree($this->getId());
        $this->lm_tree->setTableNames('lm_tree', 'lm_data');
        $this->lm_tree->setTreeTablePK("lm_id");
 
        $this->readProperties();
        
        // read auto glossaries
        $set = $ilDB->query(
            "SELECT * FROM lm_glossaries " .
            " WHERE lm_id = " . $ilDB->quote($this->getId(), "integer")
        );
        $glos = array();
        while ($rec = $ilDB->fetchAssoc($set)) {
            $glos[] = $rec["glo_id"];
        }
        $this->setAutoGlossaries($glos);
        
        //parent::read();
    }

References ilObject\$db, $ilDB, ilObject\getId(), readProperties(), and setAutoGlossaries().

Here is the call graph for this function:

readProperties()

ilObjContentObject::readProperties

(

)

read content object properties

Definition at line 1140 of file class.ilObjContentObject.php.

    {
        $ilDB = $this->db;
        
        $q = "SELECT * FROM content_object WHERE id = " .
            $ilDB->quote($this->getId(), "integer");
        $lm_set = $ilDB->query($q);
        $lm_rec = $ilDB->fetchAssoc($lm_set);
        $this->setLayout($lm_rec["default_layout"]);
        $this->setStyleSheetId((int) $lm_rec["stylesheet"]);
        $this->setPageHeader($lm_rec["page_header"]);
        $this->setTOCMode($lm_rec["toc_mode"]);
        $this->setActiveTOC(ilUtil::yn2tf($lm_rec["toc_active"]));
        $this->setActiveNumbering(ilUtil::yn2tf($lm_rec["numbering"]));
        $this->setActivePrintView(ilUtil::yn2tf($lm_rec["print_view_active"]));
        $this->setActivePreventGlossaryAppendix(ilUtil::yn2tf($lm_rec["no_glo_appendix"]));
        $this->setHideHeaderFooterPrint($lm_rec["hide_head_foot_print"]);
        $this->setActiveDownloads(ilUtil::yn2tf($lm_rec["downloads_active"]));
        $this->setActiveDownloadsPublic(ilUtil::yn2tf($lm_rec["downloads_public_active"]));
        $this->setActiveLMMenu(ilUtil::yn2tf($lm_rec["lm_menu_active"]));
        $this->setCleanFrames(ilUtil::yn2tf($lm_rec["clean_frames"]));
        $this->setHeaderPage((int) $lm_rec["header_page"]);
        $this->setFooterPage((int) $lm_rec["footer_page"]);
        $this->setHistoryUserComments(ilUtil::yn2tf($lm_rec["hist_user_comments"]));
        $this->setPublicAccessMode($lm_rec["public_access_mode"]);
        $this->setPublicExportFile("xml", $lm_rec["public_xml_file"]);
        $this->setPublicExportFile("html", $lm_rec["public_html_file"]);
        $this->setPublicExportFile("scorm", $lm_rec["public_scorm_file"]);
        $this->setLayoutPerPage($lm_rec["layout_per_page"]);
        $this->setRating($lm_rec["rating"]);
        $this->setRatingPages($lm_rec["rating_pages"]);
        $this->setDisableDefaultFeedback($lm_rec["disable_def_feedback"]);
        $this->setProgressIcons($lm_rec["progr_icons"]);
        $this->setStoreTries($lm_rec["store_tries"]);
        $this->setRestrictForwardNavigation($lm_rec["restrict_forw_nav"]);
        
        // #14661
        $this->setPublicNotes(ilNote::commentsActivated($this->getId(), 0, $this->getType()));
 
        $this->setForTranslation($lm_rec["for_translation"]);
    }

References ilObject\$db, $ilDB, $lm_set, ilNote\commentsActivated(), ilObject\getId(), ilObject\getType(), setActiveDownloads(), setActiveDownloadsPublic(), setActiveLMMenu(), setActiveNumbering(), setActivePreventGlossaryAppendix(), setActivePrintView(), setActiveTOC(), setCleanFrames(), setDisableDefaultFeedback(), setFooterPage(), setForTranslation(), setHeaderPage(), setHideHeaderFooterPrint(), setHistoryUserComments(), setLayout(), setLayoutPerPage(), setPageHeader(), setProgressIcons(), setPublicAccessMode(), setPublicExportFile(), setPublicNotes(), setRating(), setRatingPages(), setRestrictForwardNavigation(), setStoreTries(), setStyleSheetId(), setTOCMode(), and ilUtil\yn2tf().

Referenced by createProperties(), and read().

Here is the call graph for this function:

Here is the caller graph for this function:

removeAutoGlossary()

ilObjContentObject::removeAutoGlossary

(

$a_glo_id

)

Remove auto glossary.

Parameters

return

Definition at line 395 of file class.ilObjContentObject.php.

    {
        $glo_ids = array();
        foreach ($this->getAutoGlossaries() as $g) {
            if ($g != $a_glo_id) {
                $glo_ids[] = $g;
            }
        }
        $this->setAutoGlossaries($glo_ids);
    }

References getAutoGlossaries(), and setAutoGlossaries().

Here is the call graph for this function:

setActiveDownloads()

ilObjContentObject::setActiveDownloads

(

$a_down

)

Definition at line 1062 of file class.ilObjContentObject.php.

    {
        $this->downloads_active = $a_down;
    }

Referenced by readProperties().

Here is the caller graph for this function:

setActiveDownloadsPublic()

ilObjContentObject::setActiveDownloadsPublic

(

$a_down

)

Definition at line 1072 of file class.ilObjContentObject.php.

    {
        $this->downloads_public_active = $a_down;
    }

Referenced by readProperties().

Here is the caller graph for this function:

setActiveLMMenu()

ilObjContentObject::setActiveLMMenu

(

$a_act_lm_menu

)

Definition at line 992 of file class.ilObjContentObject.php.

    {
        $this->lm_menu_active = $a_act_lm_menu;
    }

Referenced by readProperties().

Here is the caller graph for this function:

setActiveNumbering()

ilObjContentObject::setActiveNumbering

(

$a_num

)

Definition at line 1012 of file class.ilObjContentObject.php.

    {
        $this->numbering = $a_num;
    }

Referenced by readProperties().

Here is the caller graph for this function:

setActivePreventGlossaryAppendix()

ilObjContentObject::setActivePreventGlossaryAppendix

(

$a_print

)

Definition at line 1032 of file class.ilObjContentObject.php.

    {
        $this->prevent_glossary_appendix_active = $a_print;
    }

Referenced by readProperties().

Here is the caller graph for this function:

setActivePrintView()

ilObjContentObject::setActivePrintView

(

$a_print

)

Definition at line 1022 of file class.ilObjContentObject.php.

    {
        $this->print_view_active = $a_print;
    }

Referenced by readProperties().

Here is the caller graph for this function:

setActiveTOC()

ilObjContentObject::setActiveTOC

(

$a_toc

)

Definition at line 1002 of file class.ilObjContentObject.php.

    {
        $this->toc_active = $a_toc;
    }

Referenced by readProperties().

Here is the caller graph for this function:

setAutoGlossaries()

ilObjContentObject::setAutoGlossaries

(

$a_val

)

Set auto glossaries.

Parameters

array

$a_val

int

Definition at line 365 of file class.ilObjContentObject.php.

    {
        $this->auto_glossaries = array();
        if (is_array($a_val)) {
            foreach ($a_val as $v) {
                $v = (int) $v;
                if ($v > 0 && ilObject::_lookupType($v) == "glo" &&
                    !in_array($v, $this->auto_glossaries)) {
                    $this->auto_glossaries[] = $v;
                }
            }
        }
    }

References ilObject\_lookupType().

Referenced by read(), and removeAutoGlossary().

Here is the call graph for this function:

Here is the caller graph for this function:

setCleanFrames()

ilObjContentObject::setCleanFrames

(

$a_clean

)

Definition at line 1092 of file class.ilObjContentObject.php.

    {
        $this->clean_frames = $a_clean;
    }

Referenced by readProperties(), and updateProperties().

Here is the caller graph for this function:

setDescription()

ilObjContentObject::setDescription

(

$a_description

)

set description of content object

Reimplemented from ilObject.

Definition at line 162 of file class.ilObjContentObject.php.

    {
        parent::setDescription($a_description);
        //              $this->meta_data->setDescription($a_description);
    }

setDisableDefaultFeedback()

ilObjContentObject::setDisableDefaultFeedback

(

$a_val

)

Set disable default feedback for questions.

Parameters

bool

$a_val

disable default feedback

Definition at line 204 of file class.ilObjContentObject.php.

    {
        $this->disable_def_feedback = $a_val;
    }

Referenced by readProperties().

Here is the caller graph for this function:

setFooterPage()

ilObjContentObject::setFooterPage

(

$a_pg

)

Definition at line 1127 of file class.ilObjContentObject.php.

    {
        $this->footer_page = $a_pg;
    }

Referenced by readProperties().

Here is the caller graph for this function:

setForTranslation()

ilObjContentObject::setForTranslation

(

$a_val

)

Set for translation.

Parameters

bool

$a_val

lm has been imported for translation purposes

Definition at line 439 of file class.ilObjContentObject.php.

    {
        $this->for_translation = $a_val;
    }

Referenced by readProperties().

Here is the caller graph for this function:

setHeaderPage()

ilObjContentObject::setHeaderPage

(

$a_pg

)

Definition at line 1117 of file class.ilObjContentObject.php.

    {
        $this->header_page = $a_pg;
    }

Referenced by readProperties().

Here is the caller graph for this function:

setHideHeaderFooterPrint()

ilObjContentObject::setHideHeaderFooterPrint

(

$a_val

)

Set hide header footer in print mode.

Parameters

bool

$a_val

hide header and footer?

Definition at line 1047 of file class.ilObjContentObject.php.

    {
        $this->hide_header_footer_print = $a_val;
    }

Referenced by readProperties().

Here is the caller graph for this function:

setHistoryUserComments()

ilObjContentObject::setHistoryUserComments

(

$a_comm

)

Definition at line 1102 of file class.ilObjContentObject.php.

    {
        $this->user_comments = $a_comm;
    }

Referenced by readProperties().

Here is the caller graph for this function:

setImportDirectory()

ilObjContentObject::setImportDirectory

(

$a_import_dir

)

Set import directory for further use in ilContObjParser.

Parameters

string

import directory

Returns

void

Definition at line 526 of file class.ilObjContentObject.php.

    {
        $this->import_dir = $a_import_dir;
    }

setImportId()

ilObjContentObject::setImportId

(

$a_import_id

)

set import id

@access public

Parameters

string

$a_import_id

import id

Reimplemented from ilObject.

Definition at line 174 of file class.ilObjContentObject.php.

    {
        $this->import_id = $a_id;
    }

setLayout()

ilObjContentObject::setLayout

(

$a_layout

)

set default page layout

Parameters

string

$a_layout

default page layout

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

    {
        $this->layout = $a_layout;
    }

Referenced by readProperties().

Here is the caller graph for this function:

setLayoutPerPage()

ilObjContentObject::setLayoutPerPage

(

$a_val

)

Set layout per page.

Parameters

boolean

layout per page

Definition at line 184 of file class.ilObjContentObject.php.

    {
        $this->layout_per_page = $a_val;
    }

Referenced by readProperties().

Here is the caller graph for this function:

setPageHeader()

ilObjContentObject::setPageHeader

(

$a_pg_header = ilLMObject::CHAPTER_TITLE

)

set page header mode

Parameters

string

$a_pg_header

ilLMOBject::CHAPTER_TITLE | ilLMOBject::PAGE_TITLE | ilLMOBject::NO_HEADER

Definition at line 961 of file class.ilObjContentObject.php.

    {
        $this->pg_header = $a_pg_header;
    }

Referenced by readProperties().

Here is the caller graph for this function:

setProgressIcons()

ilObjContentObject::setProgressIcons

(

$a_val

)

Set progress icons.

Parameters

bool

$a_val

show progress icons

Definition at line 224 of file class.ilObjContentObject.php.

    {
        $this->progr_icons = $a_val;
    }

Referenced by readProperties().

Here is the caller graph for this function:

setPublicAccessMode()

ilObjContentObject::setPublicAccessMode

(

$a_mode

)

Definition at line 1107 of file class.ilObjContentObject.php.

    {
        $this->public_access_mode = $a_mode;
    }

Referenced by readProperties().

Here is the caller graph for this function:

setPublicExportFile()

ilObjContentObject::setPublicExportFile	(		$a_type,
			$a_file
	)

specify public export file for type

Parameters

string	$a_type	type ("xml" / "html")
string	$a_file	file name

Definition at line 1973 of file class.ilObjContentObject.php.

    {
        $this->public_export_file[$a_type] = $a_file;
    }

References $a_type.

Referenced by readProperties().

Here is the caller graph for this function:

setPublicNotes()

ilObjContentObject::setPublicNotes

(

$a_pub_notes

)

Definition at line 1082 of file class.ilObjContentObject.php.

    {
        $this->pub_notes = $a_pub_notes;
    }

Referenced by readProperties().

Here is the caller graph for this function:

setRating()

ilObjContentObject::setRating

(

$a_value

)

Definition at line 2769 of file class.ilObjContentObject.php.

    {
        $this->rating = (bool) $a_value;
    }

Referenced by readProperties().

Here is the caller graph for this function:

setRatingPages()

ilObjContentObject::setRatingPages

(

$a_value

)

Definition at line 2779 of file class.ilObjContentObject.php.

    {
        $this->rating_pages = (bool) $a_value;
    }

Referenced by readProperties().

Here is the caller graph for this function:

setRestrictForwardNavigation()

ilObjContentObject::setRestrictForwardNavigation

(

$a_val

)

Set restrict forward navigation.

Parameters

bool

$a_val

restrict forward navigation

Definition at line 264 of file class.ilObjContentObject.php.

    {
        $this->restrict_forw_nav = $a_val;
    }

Referenced by readProperties().

Here is the caller graph for this function:

setStoreTries()

ilObjContentObject::setStoreTries

(

$a_val

)

Set store tries.

Parameters

bool

$a_val

store tries

Definition at line 244 of file class.ilObjContentObject.php.

    {
        $this->store_tries = $a_val;
    }

Referenced by readProperties().

Here is the caller graph for this function:

setStyleSheetId()

ilObjContentObject::setStyleSheetId

(

$a_style_id

)

set ID of assigned style sheet object

Definition at line 676 of file class.ilObjContentObject.php.

    {
        $this->style_id = $a_style_id;
    }

Referenced by readProperties().

Here is the caller graph for this function:

setTitle()

ilObjContentObject::setTitle

(

$a_title

)

set title of content object

Reimplemented from ilObject.

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

    {
        parent::setTitle($a_title);
        //              $this->meta_data->setTitle($a_title);
    }

setTOCMode()

ilObjContentObject::setTOCMode

(

$a_toc_mode = "chapters"

)

set toc mode

Parameters

string

$a_toc_mode

"chapters" | "pages"

Definition at line 987 of file class.ilObjContentObject.php.

    {
        $this->toc_mode = $a_toc_mode;
    }

Referenced by readProperties().

Here is the caller graph for this function:

update()

ilObjContentObject::update

(

)

update complete object (meta data and properties)

Reimplemented from ilObject.

Definition at line 288 of file class.ilObjContentObject.php.

    {
        $this->updateMetaData();
        parent::update();
        $this->updateProperties();
        $this->updateAutoGlossaries();
    }

References updateAutoGlossaries(), ilObject\updateMetaData(), and updateProperties().

Here is the call graph for this function:

updateAutoGlossaries()

ilObjContentObject::updateAutoGlossaries

(

)

Update auto glossaries.

Parameters

return

Definition at line 302 of file class.ilObjContentObject.php.

    {
        $ilDB = $this->db;
        
        // update auto glossaries
        $ilDB->manipulate(
            "DELETE FROM lm_glossaries WHERE " .
            " lm_id = " . $ilDB->quote($this->getId(), "integer")
        );
        foreach ($this->getAutoGlossaries() as $glo_id) {
            $ilDB->manipulate("INSERT INTO lm_glossaries " .
                "(lm_id, glo_id) VALUES (" .
                $ilDB->quote($this->getId(), "integer") . "," .
                $ilDB->quote($glo_id, "integer") .
                ")");
        }
    }

References ilObject\$db, $ilDB, and getAutoGlossaries().

Referenced by create(), and update().

Here is the call graph for this function:

Here is the caller graph for this function:

updateProperties()

ilObjContentObject::updateProperties

(

)

Update content object properties.

Definition at line 1185 of file class.ilObjContentObject.php.

    {
        $ilDB = $this->db;
        
        // force clean_frames to be set, if layout per page is activated
        if ($this->getLayoutPerPage()) {
            $this->setCleanFrames(true);
        }
        
        $q = "UPDATE content_object SET " .
            " default_layout = " . $ilDB->quote($this->getLayout(), "text") . ", " .
            " stylesheet = " . $ilDB->quote($this->getStyleSheetId(), "integer") . "," .
            " page_header = " . $ilDB->quote($this->getPageHeader(), "text") . "," .
            " toc_mode = " . $ilDB->quote($this->getTOCMode(), "text") . "," .
            " toc_active = " . $ilDB->quote(ilUtil::tf2yn($this->isActiveTOC()), "text") . "," .
            " numbering = " . $ilDB->quote(ilUtil::tf2yn($this->isActiveNumbering()), "text") . "," .
            " print_view_active = " . $ilDB->quote(ilUtil::tf2yn($this->isActivePrintView()), "text") . "," .
            " no_glo_appendix = " . $ilDB->quote(ilUtil::tf2yn($this->isActivePreventGlossaryAppendix()), "text") . "," .
            " hide_head_foot_print = " . $ilDB->quote($this->getHideHeaderFooterPrint(), "integer") . "," .
            " downloads_active = " . $ilDB->quote(ilUtil::tf2yn($this->isActiveDownloads()), "text") . "," .
            " downloads_public_active = " . $ilDB->quote(ilUtil::tf2yn($this->isActiveDownloadsPublic()), "text") . "," .
            " clean_frames = " . $ilDB->quote(ilUtil::tf2yn($this->cleanFrames()), "text") . "," .
            " hist_user_comments = " . $ilDB->quote(ilUtil::tf2yn($this->isActiveHistoryUserComments()), "text") . "," .
            " public_access_mode = " . $ilDB->quote($this->getPublicAccessMode(), "text") . "," .
            " public_xml_file = " . $ilDB->quote($this->getPublicExportFile("xml"), "text") . "," .
            " public_html_file = " . $ilDB->quote($this->getPublicExportFile("html"), "text") . "," .
            " public_scorm_file = " . $ilDB->quote($this->getPublicExportFile("scorm"), "text") . "," .
            " header_page = " . $ilDB->quote($this->getHeaderPage(), "integer") . "," .
            " footer_page = " . $ilDB->quote($this->getFooterPage(), "integer") . "," .
            " lm_menu_active = " . $ilDB->quote(ilUtil::tf2yn($this->isActiveLMMenu()), "text") . ", " .
            " layout_per_page = " . $ilDB->quote($this->getLayoutPerPage(), "integer") . ", " .
            " rating = " . $ilDB->quote($this->hasRating(), "integer") . ", " .
            " rating_pages = " . $ilDB->quote($this->hasRatingPages(), "integer") . ", " .
            " disable_def_feedback = " . $ilDB->quote($this->getDisableDefaultFeedback(), "integer") . ", " .
            " progr_icons = " . $ilDB->quote($this->getProgressIcons(), "integer") . ", " .
            " store_tries = " . $ilDB->quote($this->getStoreTries(), "integer") . ", " .
            " restrict_forw_nav = " . $ilDB->quote($this->getRestrictForwardNavigation(), "integer") . ", " .
            " for_translation = " . $ilDB->quote((int) $this->getForTranslation(), "integer") . " " .
            " WHERE id = " . $ilDB->quote($this->getId(), "integer");
        $ilDB->manipulate($q);
        // #14661
        ilNote::activateComments($this->getId(), 0, $this->getType(), $this->publicNotes());
    }

References ilObject\$db, $ilDB, ilNote\activateComments(), cleanFrames(), getDisableDefaultFeedback(), getFooterPage(), getForTranslation(), getHeaderPage(), getHideHeaderFooterPrint(), ilObject\getId(), getLayout(), getLayoutPerPage(), getPageHeader(), getProgressIcons(), getPublicAccessMode(), getPublicExportFile(), getRestrictForwardNavigation(), getStoreTries(), getStyleSheetId(), getTOCMode(), ilObject\getType(), hasRating(), hasRatingPages(), isActiveDownloads(), isActiveDownloadsPublic(), isActiveHistoryUserComments(), isActiveLMMenu(), isActiveNumbering(), isActivePreventGlossaryAppendix(), isActivePrintView(), isActiveTOC(), publicNotes(), setCleanFrames(), and ilUtil\tf2yn().

Referenced by update().

Here is the call graph for this function:

Here is the caller graph for this function:

validatePages()

ilObjContentObject::validatePages

(

)

Validate all pages.

Definition at line 2356 of file class.ilObjContentObject.php.

    {
        $mess = "";
        
        $pages = ilLMPageObject::getPageList($this->getId());
        foreach ($pages as $page) {
            if (ilLMPage::_exists($this->getType(), $page["obj_id"])) {
                $cpage = new ilLMPage($page["obj_id"]);
                $cpage->buildDom();
                $error = @$cpage->validateDom();
                
                if ($error != "") {
                    $this->lng->loadLanguageModule("content");
                    ilUtil::sendInfo($this->lng->txt("cont_import_validation_errors"));
                    $title = ilLMObject::_lookupTitle($page["obj_id"]);
                    $page_obj = new ilLMPageObject($this, $page["obj_id"]);
                    $mess .= $this->lng->txt("obj_pg") . ": " . $title;
                    $mess .= '<div class="small">';
                    foreach ($error as $e) {
                        $err_mess = implode(" - ", $e);
                        if (!is_int(strpos($err_mess, ":0:"))) {
                            $mess .= htmlentities($err_mess) . "<br />";
                        }
                    }
                    $mess .= '</div>';
                    $mess .= "<br />";
                }
            }
        }
        
        return $mess;
    }

References Vendor\Package\$e, ilObject\$error, ilObject\$title, ilPageObject\_exists(), ilLMObject\_lookupTitle(), ilObject\getId(), ilLMPageObject\getPageList(), ilObject\getType(), and ilUtil\sendInfo().

Referenced by importFromDirectory().

Here is the call graph for this function:

Here is the caller graph for this function:

writeFooterPage()

static ilObjContentObject::writeFooterPage (   $a_lm_id,   $a_page_id  )

static

Write footer page.

Parameters

int	$a_lm_id	learning module id
int	$a_page_id	page

Definition at line 721 of file class.ilObjContentObject.php.

    {
        global $DIC;
 
        $ilDB = $DIC->database();
 
        $ilDB->manipulate(
            "UPDATE content_object SET " .
            " footer_page = " . $ilDB->quote($a_page_id, "integer") .
            " WHERE id = " . $ilDB->quote($a_lm_id, "integer")
        );
    }

References $DIC, and $ilDB.

Referenced by ilLearningModuleImporter\finalProcessing().

Here is the caller graph for this function:

writeHeaderPage()

static ilObjContentObject::writeHeaderPage (   $a_lm_id,   $a_page_id  )

static

Write header page.

Parameters

int	$a_lm_id	learning module id
int	$a_page_id	page

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

    {
        global $DIC;
 
        $ilDB = $DIC->database();
 
        $ilDB->manipulate(
            "UPDATE content_object SET " .
            " header_page = " . $ilDB->quote($a_page_id, "integer") .
            " WHERE id = " . $ilDB->quote($a_lm_id, "integer")
        );
    }

References $DIC, and $ilDB.

Referenced by ilLearningModuleImporter\finalProcessing().

Here is the caller graph for this function:

writeStyleSheetId()

ilObjContentObject::writeStyleSheetId

(

$a_style_id

)

write ID of assigned style sheet object to db

Definition at line 684 of file class.ilObjContentObject.php.

    {
        $ilDB = $this->db;
 
        $q = "UPDATE content_object SET " .
            " stylesheet = " . $ilDB->quote((int) $a_style_id, "integer") .
            " WHERE id = " . $ilDB->quote($this->getId(), "integer");
        $ilDB->manipulate($q);
 
        $this->style_id = $a_style_id;
    }

References ilObject\$db, $ilDB, and ilObject\getId().

Referenced by importFromDirectory().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$auto_glossaries

ilObjContentObject::$auto_glossaries = array()

Definition at line 43 of file class.ilObjContentObject.php.

Referenced by getAutoGlossaries().

$for_translation

ilObjContentObject::$for_translation = 0

Definition at line 40 of file class.ilObjContentObject.php.

Referenced by getForTranslation().

$import_dir

ilObjContentObject::$import_dir = ''

private

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

Referenced by createImportDirectory(), and getImportDirectory().

$layout

ilObjContentObject::$layout

Definition at line 36 of file class.ilObjContentObject.php.

Referenced by getLayout().

$lm_tree

ilObjContentObject::$lm_tree

Definition at line 33 of file class.ilObjContentObject.php.

Referenced by _checkPreconditionsOfPage(), _getMissingPreconditionsOfPage(), _getMissingPreconditionsTopChapter(), getLMTree(), and getTree().

$locator

ilObjContentObject::$locator

protected

Definition at line 28 of file class.ilObjContentObject.php.

$log

ilObjContentObject::$log

protected

Definition at line 49 of file class.ilObjContentObject.php.

$meta_data

ilObjContentObject::$meta_data

Definition at line 35 of file class.ilObjContentObject.php.

$online

ilObjContentObject::$online

Definition at line 39 of file class.ilObjContentObject.php.

$pg_header

ilObjContentObject::$pg_header

Definition at line 38 of file class.ilObjContentObject.php.

Referenced by getPageHeader().

$rating

ilObjContentObject::$rating

protected

Definition at line 41 of file class.ilObjContentObject.php.

Referenced by hasRating().

$rating_pages

ilObjContentObject::$rating_pages

protected

Definition at line 42 of file class.ilObjContentObject.php.

Referenced by hasRatingPages().

$style_id

ilObjContentObject::$style_id

Definition at line 37 of file class.ilObjContentObject.php.

Referenced by cloneObject(), and getStyleSheetId().

$user

ilObjContentObject::$user

protected

Definition at line 22 of file class.ilObjContentObject.php.

---

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

• Modules/LearningModule/classes/class.ilObjContentObject.php