ilObjHelpSettings Class Reference

Help settings application class. More...

Inheritance diagram for ilObjHelpSettings:

Collaboration diagram for ilObjHelpSettings:

Public Member Functions
	__construct ()
	Constructor. More...
	initType ()
	Init type. More...
	uploadHelpModule ($a_file)
	Upload help file. More...
	getHelpModules ()
	Get help modules. More...
	deleteModule ($a_id)
	Delete module. More...
Public Member Functions inherited from ilObject2
	__construct ($a_id=0, $a_reference=true)
	Constructor public. More...
	withReferences ()
	read ()
	Read data from db. More...
	getId ()
	setId ($a_id)
	setRefId ($a_id)
	getRefId ()
	getType ()
	setType ($a_type)
	getPresentationTitle ()
	getTitle ()
	getUntranslatedTitle ()
	setTitle ($a_title)
	getDescription ()
	setDescription ($a_desc)
	getLongDescription ()
	getImportId ()
	setImportId ($a_import_id)
	getOwner ()
	getOwnerName ()
	setOwner ($a_owner)
	getCreateDate ()
	getLastUpdateDate ()
	create ($a_clone_mode=false)
	update ()
	MDUpdateListener ($a_element)
	createMetaData ()
	updateMetaData ()
	deleteMetaData ()
	updateOwner ()
	putInTree ($a_parent_ref)
	setPermissions ($a_parent_ref)
	createReference ()
	countReferences ()
	delete ()
	initDefaultRoles ()
	setRegisterMode ($a_bool)
	isUserRegistered ($a_user_id=0)
	requireRegistration ()
	appendCopyInfo ($a_target_id, $a_copy_id)
	cloneMetaData ($target_obj)
	cloneObject ($a_target_id, $a_copy_id=null, $a_omit_tree=false)
	cloneDependencies ($a_target_id, $a_copy_id)
Public Member Functions inherited from ilObject
	__construct ($a_id=0, $a_reference=true)
	Constructor public. More...
	withReferences ()
	determines wehter objects are referenced or not (got ref ids or not) More...
	read ()
	read object data from db into object More...
	getId ()
	get object id public More...
	setId ($a_id)
	set object id public More...
	setRefId ($a_id)
	set reference id public More...
	getRefId ()
	get reference id public More...
	getType ()
	get object type public More...
	setType ($a_type)
	set object type public More...
	getPresentationTitle ()
	get presentation title Normally same as title Overwritten for sessions More...
	getTitle ()
	get object title public More...
	getUntranslatedTitle ()
	get untranslated object title public More...
	setTitle ($a_title)
	set object title More...
	getDescription ()
	get object description More...
	setDescription ($a_desc)
	set object description More...
	getLongDescription ()
	get object long description (stored in object_description) More...
	getImportId ()
	get import id More...
	setImportId ($a_import_id)
	set import id More...
	getOwner ()
	get object owner More...
	getOwnerName ()
	setOwner ($a_owner)
	set object owner More...
	getCreateDate ()
	get create date public More...
	getLastUpdateDate ()
	get last update date public More...
	getDiskUsage ()
	Gets the disk usage of the object in bytes. More...
	create ()
	create More...
	update ()
	update object in db More...
	MDUpdateListener ($a_element)
	Meta data update listener. More...
	createMetaData ()
	create meta data entry More...
	updateMetaData ()
	update meta data entry More...
	deleteMetaData ()
	delete meta data entry More...
	updateOwner ()
	update owner of object in db More...
	putInTree ($a_parent_ref)
	maybe this method should be in tree object!? More...
	setPermissions ($a_parent_ref)
	set permissions of object More...
	setParentRolePermissions ($a_parent_ref)
	Initialize the permissions of parent roles (local roles of categories, global roles...) This method is overwritten in e.g courses, groups for building permission intersections with non_member templates. More...
	createReference ()
	creates reference for object More...
	countReferences ()
	count references of object More...
	initDefaultRoles ()
	init default roles settings Purpose of this function is to create a local role folder and local roles, that are needed depending on the object type If you want to setup default local roles you MUST overwrite this method in derived object classes (see ilObjForum for an example) public More...
	applyDidacticTemplate ($a_tpl_id)
	Apply template. More...
	setRegisterMode ($a_bool)
	isUserRegistered ($a_user_id=0)
	requireRegistration ()
	getXMLZip ()
	getHTMLDirectory ()
	appendCopyInfo ($a_target_id, $a_copy_id)
	Prepend Copy info if object with same name exists in that container. More...
	cloneDependencies ($a_target_id, $a_copy_id)
	Clone object dependencies. More...
	cloneMetaData ($target_obj)
	Copy meta data. More...
	getPossibleSubObjects ($a_filter=true)
	get all possible subobjects of this type the object can decide which types of subobjects are possible jut in time overwrite if the decision distinguish from standard model More...

Static Public Member Functions
static	createHelpModule ()
	Create help module. More...
static	writeHelpModuleLmId ($a_id, $a_lm_id)
	Write help module lm id. More...
static	lookupModuleTitle ($a_id)
	lookup module title More...
static	lookupModuleLmId ($a_id)
	lookup module lm id More...
static	isHelpLM ($a_lm_id)
	Check if LM is a help LM. More...
Static Public Member Functions inherited from ilObject2
static	_lookupObjIdByImportId ($a_import_id)
static	_lookupOwnerName ($a_owner_id)
static	_getIdForImportId ($a_import_id)
static	_getAllReferences ($a_id)
static	_lookupTitle ($a_id)
static	_lookupOwner ($a_id)
static	_getIdsForTitle ($title, $type='', $partialmatch=false)
static	_lookupDescription ($a_id)
static	_lookupLastUpdate ($a_id, $a_as_string=false)
static	_getLastUpdateOfObjects ($a_objs)
static	_lookupObjId ($a_id)
static	_setDeletedDate ($a_ref_id)
static	_resetDeletedDate ($a_ref_id)
static	_lookupDeletedDate ($a_ref_id)
static	_writeTitle ($a_obj_id, $a_title)
static	_writeDescription ($a_obj_id, $a_desc)
static	_writeImportId ($a_obj_id, $a_import_id)
static	_lookupType ($a_id, $a_reference=false)
static	_isInTrash ($a_ref_id)
static	_hasUntrashedReference ($a_obj_id)
static	_lookupObjectId ($a_ref_id)
static	_getObjectsDataForType ($a_type, $a_omit_trash=false)
static	_exists ($a_id, $a_reference=false, $a_type=null)
static	_getObjectsByType ($a_obj_type="", $a_owner="")
static	_prepareCloneSelection ($a_ref_ids, $new_type, $a_show_path=true)
static	_getIcon ($a_obj_id="", $a_size="big", $a_type="", $a_offline=false)
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	_lookupOwner ($a_id)
	lookup object owner More...
static	_getIdsForTitle ($title, $type='', $partialmatch=false)
static	_lookupDescription ($a_id)
	lookup object description More...
static	_lookupLastUpdate ($a_id, $a_as_string=false)
	lookup last update More...
static	_getLastUpdateOfObjects ($a_objs)
	Get last update for a set of media objects. More...
static	_lookupObjId ($a_id)
static	_setDeletedDate ($a_ref_id)
	only called in ilTree::saveSubTree More...
static	setDeletedDates ($a_ref_ids)
	Set deleted date type $ilDB. More...
static	_resetDeletedDate ($a_ref_id)
	only called in ilObjectGUI::insertSavedNodes More...
static	_lookupDeletedDate ($a_ref_id)
	only called in ilObjectGUI::insertSavedNodes More...
static	_writeTitle ($a_obj_id, $a_title)
	write title to db (static) More...
static	_writeDescription ($a_obj_id, $a_desc)
	write description to db (static) More...
static	_writeImportId ($a_obj_id, $a_import_id)
	write import id to db (static) More...
static	_lookupType ($a_id, $a_reference=false)
	lookup object type More...
static	_isInTrash ($a_ref_id)
	checks wether object is in trash More...
static	_hasUntrashedReference ($a_obj_id)
	checks wether an object has at least one reference that is not in trash More...
static	_lookupObjectId ($a_ref_id)
	lookup object id More...
static	_getObjectsDataForType ($a_type, $a_omit_trash=false)
	get all objects of a certain type More...
static	_exists ($a_id, $a_reference=false, $a_type=null)
	checks if an object exists in object_data More...
static	_getObjectsByType ($a_obj_type="", $a_owner="")
	Get objects by type. More...
static	_prepareCloneSelection ($a_ref_ids, $new_type, $show_path=true)
	Prepare copy wizard object selection. More...
static	_getIcon ( $a_obj_id="", $a_size="big", $a_type="", $a_offline=false)
	Get icon for repository item. 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...

Protected Attributes
	$db
	$settings
Protected Attributes inherited from ilObject
	$objDefinition
	$db
	$log
	$error
	$tree
	$app_event_handler
	$rbacadmin
	$rbacreview

Additional Inherited Members
Data Fields inherited from ilObject
const	TITLE_LENGTH = 255
	max length of object title More...
const	DESC_LENGTH = 128
	$lng
	$id
	$ref_id
	$type
	$title
	$untranslatedTitle
	$desc
	$long_desc
	$owner
	$create_date
	$last_update
	$import_id
	$register = false
	$referenced
	$objectList
	$max_title
	$max_desc
	$add_dots
Protected Member Functions inherited from ilObject2
	initType ()
	doRead ()
	doCreate ()
	beforeCreate ()
	doUpdate ()
	beforeUpdate ()
	doMDUpdateListener ($a_element)
	beforeMDUpdateListener ($a_element)
	doCreateMetaData ()
	beforeCreateMetaData ()
	doUpdateMetaData ()
	beforeUpdateMetaData ()
	doDelete ()
	beforeDelete ()
	doCloneObject ($new_obj, $a_target_id, $a_copy_id=null)
	beforeCloneObject ()

Detailed Description

Help settings application class.

Author

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

Version

$Id$

Definition at line 15 of file class.ilObjHelpSettings.php.

Constructor & Destructor Documentation

__construct()

ilObjHelpSettings::__construct

(

)

Constructor.

Definition at line 31 of file class.ilObjHelpSettings.php.

References $DIC, and settings().

    {
        parent::__construct();
        global $DIC;

        $this->db = $DIC->database();
        $this->settings = $DIC->settings();
    }

Here is the call graph for this function:

Member Function Documentation

createHelpModule()

static ilObjHelpSettings::createHelpModule ( )

static

Create help module.

Parameters

Definition at line 54 of file class.ilObjHelpSettings.php.

References $DIC, ilObject\$id, and $ilDB.

Referenced by uploadHelpModule().

    {
        global $DIC;

        $ilDB = $DIC->database();
        
        $id = $ilDB->nextId("help_module");
        
        $ilDB->manipulate("INSERT INTO help_module " .
            "(id) VALUES (" .
            $ilDB->quote($id, "integer") .
            ")");
        
        return $id;
    }

Here is the caller graph for this function:

deleteModule()

ilObjHelpSettings::deleteModule

(

$a_id

)

Delete module.

Parameters

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

References $db, $ilDB, $ilSetting, $settings, ilObject\_lookupType(), ilHelpMapping\deleteEntriesOfModule(), and ilHelp\deleteTooltipsOfModule().

    {
        $ilDB = $this->db;
        $ilSetting = $this->settings;
        
        // if this is the currently activated one, deactivate it first
        if ($a_id == (int) $ilSetting->get("help_module")) {
            $ilSetting->set("help_module", "");
        }
        
        $set = $ilDB->query(
            "SELECT * FROM help_module " .
            " WHERE id = " . $ilDB->quote($a_id, "integer")
        );
        $rec  = $ilDB->fetchAssoc($set);

        // delete learning module
        if (ilObject::_lookupType($rec["lm_id"]) == "lm") {
            include_once("./Modules/LearningModule/classes/class.ilObjLearningModule.php");
            $lm = new ilObjLearningModule($rec["lm_id"], false);
            $lm->delete();
        }
        
        // delete mappings
        include_once("./Services/Help/classes/class.ilHelpMapping.php");
        ilHelpMapping::deleteEntriesOfModule($a_id);
        
        // delete tooltips
        include_once("./Services/Help/classes/class.ilHelp.php");
        ilHelp::deleteTooltipsOfModule($a_id);
        
        // delete help module record
        $ilDB->manipulate("DELETE FROM help_module WHERE " .
            " id = " . $ilDB->quote($a_id, "integer"));
    }

Here is the call graph for this function:

getHelpModules()

ilObjHelpSettings::getHelpModules

(

)

Get help modules.

Parameters

Definition at line 185 of file class.ilObjHelpSettings.php.

References $db, $ilDB, ilObject\_lookupCreationDate(), ilObject\_lookupTitle(), ilObject\_lookupType(), and array.

    {
        $ilDB = $this->db;
        
        $set = $ilDB->query("SELECT * FROM help_module");
        
        $mods = array();
        while ($rec  = $ilDB->fetchAssoc($set)) {
            if (ilObject::_lookupType($rec["lm_id"]) == "lm") {
                $rec["title"] = ilObject::_lookupTitle($rec["lm_id"]);
                $rec["create_date"] = ilObject::_lookupCreationDate($rec["lm_id"]);
            }
            
            $mods[] = $rec;
        }
        
        return $mods;
    }

Here is the call graph for this function:

initType()

ilObjHelpSettings::initType

(

)

Init type.

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

    {
        $this->type = "hlps";
    }

isHelpLM()

static ilObjHelpSettings::isHelpLM (   $a_lm_id )

static

Check if LM is a help LM.

Parameters

integer

$a_lm_id

lm id

Returns

bool true/false

Definition at line 295 of file class.ilObjHelpSettings.php.

References $DIC, and $ilDB.

Referenced by ilLMObject\_getIdForImportId().

    {
        global $DIC;

        $ilDB = $DIC->database();

        $set = $ilDB->query(
            "SELECT id FROM help_module " .
            " WHERE lm_id = " . $ilDB->quote($a_lm_id, "integer")
        );
        if ($rec = $ilDB->fetchAssoc($set)) {
            return true;
        }
        return false;
    }

Here is the caller graph for this function:

lookupModuleLmId()

static ilObjHelpSettings::lookupModuleLmId (   $a_id )

static

lookup module lm id

Parameters

Definition at line 233 of file class.ilObjHelpSettings.php.

References $DIC, and $ilDB.

Referenced by ilHelp\getHelpLMId().

    {
        global $DIC;

        $ilDB = $DIC->database();
        
        $set = $ilDB->query(
            "SELECT lm_id FROM help_module " .
            " WHERE id = " . $ilDB->quote($a_id, "integer")
        );
        $rec  = $ilDB->fetchAssoc($set);
        return $rec["lm_id"];
    }

Here is the caller graph for this function:

lookupModuleTitle()

static ilObjHelpSettings::lookupModuleTitle (   $a_id )

static

lookup module title

Parameters

Definition at line 210 of file class.ilObjHelpSettings.php.

References $DIC, $ilDB, ilObject\_lookupTitle(), and ilObject\_lookupType().

    {
        global $DIC;

        $ilDB = $DIC->database();
        
        $set = $ilDB->query(
            "SELECT * FROM help_module " .
            " WHERE id = " . $ilDB->quote($a_id, "integer")
        );
        $rec  = $ilDB->fetchAssoc($set);
        if (ilObject::_lookupType($rec["lm_id"]) == "lm") {
            return ilObject::_lookupTitle($rec["lm_id"]);
        }
        return "";
    }

Here is the call graph for this function:

uploadHelpModule()

ilObjHelpSettings::uploadHelpModule

(

$a_file

)

Upload help file.

Parameters

Definition at line 96 of file class.ilObjHelpSettings.php.

References $file, $files, $GLOBALS, ilObject\$id, $t, array, createHelpModule(), ilUtil\delDir(), ilUtil\getDir(), and ilLMObject\getObjectList().

    {
        $id = $this->createHelpModule();
        
        // create and insert object in objecttree
        /*include_once("./Modules/LearningModule/classes/class.ilObjContentObject.php");
        $newObj = new ilObjContentObject();
        $newObj->setType("lm");
        $newObj->setTitle("Help Module");
        $newObj->create(true);
        $newObj->createLMTree();*/

        try {
            include_once("./Services/Export/classes/class.ilImport.php");
            $imp = new ilImport();
            $conf = $imp->getConfig("Services/Help");
            $conf->setModuleId($id);
            $new_id = $imp->importObject("", $a_file["tmp_name"], $a_file["name"], "lm", "Modules/LearningModule");
            $newObj = new ilObjLearningModule($new_id, false);

            self::writeHelpModuleLmId($id, $newObj->getId());
        } catch (ilManifestFileNotFoundImportException $e) {
            // old import
            $t = $imp->getTemporaryImportDir();

            // create and insert object in objecttree
            include_once("./Modules/LearningModule/classes/class.ilObjContentObject.php");
            $newObj = new ilObjContentObject();
            $newObj->setType("lm");
            $newObj->setTitle("Help Module");
            $newObj->create(true);
            $newObj->createLMTree();

            $mess =  $newObj->importFromDirectory($t, false);

            // this should only be true for help modules
            // search the zip file
            $dir = $t;
            $files = ilUtil::getDir($dir);
            foreach ($files as $file) {
                if (is_int(strpos($file["entry"], "__help_")) &&
                    is_int(strpos($file["entry"], ".zip"))) {
                    include_once("./Services/Export/classes/class.ilImport.php");
                    $imp = new ilImport();
                    $imp->getMapping()->addMapping('Services/Help', 'help_module', 0, $id);
                    include_once("./Modules/LearningModule/classes/class.ilLMObject.php");
                    $chaps = ilLMObject::getObjectList($newObj->getId(), "st");
                    foreach ($chaps as $chap) {
                        $chap_arr = explode("_", $chap["import_id"]);
                        $imp->getMapping()->addMapping(
                            'Services/Help',
                            'help_chap',
                            $chap_arr[count($chap_arr) - 1],
                            $chap["obj_id"]
                        );
                    }
                    $imp->importEntity(
                        $dir . "/" . $file["entry"],
                        $file["entry"],
                        "help",
                        "Services/Help",
                        true
                    );
                }
            }

            // delete import directory
            ilUtil::delDir($t);

            self::writeHelpModuleLmId($id, $newObj->getId());
        }


        $GLOBALS['ilAppEventHandler']->raise(
            'Services/Help',
            'create',
            array(
                'obj_id' => $id,
                'obj_type' => 'lm'
            )
        );
    }

Here is the call graph for this function:

writeHelpModuleLmId()

static ilObjHelpSettings::writeHelpModuleLmId (   $a_id,   $a_lm_id  )

static

Write help module lm id.

Parameters

Definition at line 76 of file class.ilObjHelpSettings.php.

References $DIC, and $ilDB.

    {
        global $DIC;

        $ilDB = $DIC->database();
        
        $ilDB->manipulate(
            "UPDATE help_module SET " .
            " lm_id = " . $ilDB->quote($a_lm_id, "integer") .
            " WHERE id = " . $ilDB->quote($a_id, "integer")
        );
    }

Field Documentation

$db

ilObjHelpSettings::$db

protected

Definition at line 20 of file class.ilObjHelpSettings.php.

Referenced by deleteModule(), and getHelpModules().

$settings

ilObjHelpSettings::$settings

protected

Definition at line 25 of file class.ilObjHelpSettings.php.

Referenced by deleteModule().

---

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

• Services/Help/classes/class.ilObjHelpSettings.php