ilObjCategory Class Reference

Class ilObjCategory. More...

Inheritance diagram for ilObjCategory:

Collaboration diagram for ilObjCategory:

Public Member Functions
	__construct ($a_id=0, $a_call_by_reference=true)
	Constructor public. More...
	delete ()
	delete category and all related data More...
	getTranslations ()
	get all translations from this category More...
	removeTranslations ()
	deleteTranslation ($a_lang)
	addTranslation ($a_title, $a_desc, $a_lang, $a_lang_default)
	updateTranslation ($a_title, $a_desc, $a_lang, $a_lang_default)
	cloneObject ($a_target_id, $a_copy_id=0, $a_omit_tree=false)
	Clone course (no member data) More...
	cloneDependencies ($a_target_id, $a_copy_id)
	addAdditionalSubItemInformation (&$a_item_data)
	Add additional information to sub item, e.g. More...
Public Member Functions inherited from ilContainer
	__construct ($a_id=0, $a_reference=true)
	createContainerDirectory ()
	Create directory for the container. More...
	getContainerDirectory ()
	Get the container directory. More...
	getBigIconPath ()
	Get path for big icon. More...
	getSmallIconPath ()
	Get path for small icon. More...
	getTinyIconPath ()
	Get path for tiny icon. More...
	getCustomIconPath ()
	Get path for custom icon. More...
	setHiddenFilesFound ($a_hiddenfilesfound)
	Set Found hidden files (set by getSubItems). More...
	getHiddenFilesFound ()
	Get Found hidden files (set by getSubItems). More...
	getStyleSheetId ()
	get ID of assigned style sheet object More...
	setStyleSheetId ($a_style_id)
	set ID of assigned style sheet object More...
	setNewsTimeline ($a_val)
	Set news timeline. More...
	getNewsTimeline ()
	Get news timeline. More...
	setNewsTimelineAutoEntries ($a_val)
	Set news timeline auto entries. More...
	getNewsTimelineAutoEntries ()
	Get news timeline auto entries. More...
	setNewsTimelineLandingPage ($a_val)
	Set news timline is landing page. More...
	getNewsTimelineLandingPage ()
	Get news timline is landing page. More...
	isNewsTimelineEffective ()
	Is news timeline effective? More...
	isNewsTimelineLandingPageEffective ()
	Is news timeline landing page effective? More...
	setNewsBlockActivated ($a_val)
	Set news block activated. More...
	getNewsBlockActivated ()
	Get news block activated. More...
	setUseNews ($a_val)
	Set use news. More...
	getUseNews ()
	Get use news. More...
	saveIcons ($a_custom_icon)
	save container icons More...
	removeCustomIcon ()
	remove small icon More...
	cloneDependencies ($a_target_id, $a_copy_id)
	Clone object dependencies (container sorting) More...
	cloneAllObject ($session_id, $client_id, $new_type, $ref_id, $clone_source, $options, $soap_call=false, $a_submode=1)
	clone all objects according to this container More...
	getViewMode ()
	Get container view mode. More...
	getOrderType ()
	Get order type default implementation. More...
	setOrderType ($a_value)
	getSubItems ($a_admin_panel_enabled=false, $a_include_side_block=false, $a_get_single=0)
	Get subitems of container. More...
	gotItems ()
	Check whether we got any items. More...
	addAdditionalSubItemInformation (&$object)
	Add additional information to sub item, e.g. More...
	getGroupedObjTypes ()
	Get grouped repository object types. More...
	enablePageEditing ()
	Check whether page editing is allowed for container. More...
	create ()
	Create. More...
	update ()
	Update. More...
	read ()
	read More...
	readContainerSettings ()
	Read container settings. More...
Public Member Functions inherited from ilObject
	__construct ($a_id=0, $a_reference=true)
	Constructor public. More...
	withReferences ()
	determines wehter objects are referenced or not (got ref ids or not) More...
	read ()
	read object data from db into object More...
	getId ()
	get object id public More...
	setId ($a_id)
	set object id public More...
	setRefId ($a_id)
	set reference id public More...
	getRefId ()
	get reference id public More...
	getType ()
	get object type public More...
	setType ($a_type)
	set object type public More...
	getPresentationTitle ()
	get presentation title Normally same as title Overwritten for sessions More...
	getTitle ()
	get object title public More...
	getUntranslatedTitle ()
	get untranslated object title public More...
	setTitle ($a_title)
	set object title More...
	getDescription ()
	get object description More...
	setDescription ($a_desc)
	set object description More...
	getLongDescription ()
	get object long description (stored in object_description) More...
	getImportId ()
	get import id More...
	setImportId ($a_import_id)
	set import id More...
	getOwner ()
	get object owner More...
	getOwnerName ()
	setOwner ($a_owner)
	set object owner More...
	getCreateDate ()
	get create date public More...
	getLastUpdateDate ()
	get last update date public More...
	getDiskUsage ()
	Gets the disk usage of the object in bytes. More...
	create ()
	create More...
	update ()
	update object in db More...
	MDUpdateListener ($a_element)
	Meta data update listener. More...
	createMetaData ()
	create meta data entry More...
	updateMetaData ()
	update meta data entry More...
	deleteMetaData ()
	delete meta data entry More...
	updateOwner ()
	update owner of object in db More...
	putInTree ($a_parent_ref)
	maybe this method should be in tree object!? More...
	setPermissions ($a_parent_ref)
	set permissions of object More...
	setParentRolePermissions ($a_parent_ref)
	Initialize the permissions of parent roles (local roles of categories, global roles...) This method is overwritten in e.g courses, groups for building permission intersections with non_member templates. More...
	createReference ()
	creates reference for object More...
	countReferences ()
	count references of object More...
	initDefaultRoles ()
	init default roles settings Purpose of this function is to create a local role folder and local roles, that are needed depending on the object type If you want to setup default local roles you MUST overwrite this method in derived object classes (see ilObjForum for an example) public More...
	applyDidacticTemplate ($a_tpl_id)
	Apply template. More...
	setRegisterMode ($a_bool)
	isUserRegistered ($a_user_id=0)
	requireRegistration ()
	getXMLZip ()
	getHTMLDirectory ()
	appendCopyInfo ($a_target_id, $a_copy_id)
	Prepend Copy info if object with same name exists in that container. More...
	cloneDependencies ($a_target_id, $a_copy_id)
	Clone object dependencies. More...
	cloneMetaData ($target_obj)
	Copy meta data. More...
	getPossibleSubObjects ($a_filter=true)
	get all possible subobjects of this type the object can decide which types of subobjects are possible jut in time overwrite if the decision distinguish from standard model More...

Additional Inherited Members
Static Public Member Functions inherited from ilContainer
static	_getContainerDirectory ($a_id)
	Get the container directory. More...
static	_lookupContainerSetting ($a_id, $a_keyword, $a_default_value=null)
	Lookup a container setting. More...
static	_writeContainerSetting ($a_id, $a_keyword, $a_value)
static	_getContainerSettings ($a_id)
static	_deleteContainerSettings ($a_id, $a_keyword=null, $a_keyword_like=false)
static	_exportContainerSettings (ilXmlWriter $a_xml, $a_obj_id)
static	_lookupIconPath ($a_id, $a_size="big")
	lookup icon path More...
static	getCompleteDescriptions (array $objects)
	overwrites description fields to long or short description in an assoc array keys needed (obj_id and description) More...
Static Public Member Functions inherited from ilObject
static	_lookupObjIdByImportId ($a_import_id)
static	_lookupImportId ($a_obj_id)
static	_lookupOwnerName ($a_owner_id)
	lookup owner name for owner id More...
static	_getIdForImportId ($a_import_id)
	get current object id for import id (static) More...
static	_getAllReferences ($a_id)
	get all reference ids of object More...
static	_lookupTitle ($a_id)
	lookup object title More...
static	_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...
Data Fields inherited from ilContainer
const	VIEW_SESSIONS = 0
const	VIEW_OBJECTIVE = 1
const	VIEW_TIMING = 2
const	VIEW_ARCHIVE = 3
const	VIEW_SIMPLE = 4
const	VIEW_BY_TYPE = 5
const	VIEW_INHERIT = 6
const	VIEW_DEFAULT = self::VIEW_BY_TYPE
const	SORT_TITLE = 0
const	SORT_MANUAL = 1
const	SORT_ACTIVATION = 2
const	SORT_INHERIT = 3
const	SORT_CREATION = 4
const	SORT_DIRECTION_ASC = 0
const	SORT_DIRECTION_DESC = 1
const	SORT_NEW_ITEMS_POSITION_TOP = 0
const	SORT_NEW_ITEMS_POSITION_BOTTOM = 1
const	SORT_NEW_ITEMS_ORDER_TITLE = 0
const	SORT_NEW_ITEMS_ORDER_CREATION = 1
const	SORT_NEW_ITEMS_ORDER_ACTIVATION = 2
Data Fields inherited from ilObject
const	TITLE_LENGTH = 255
	max length of object title More...
const	DESC_LENGTH = 128
	$lng
	$id
	$ref_id
	$type
	$title
	$untranslatedTitle
	$desc
	$long_desc
	$owner
	$create_date
	$last_update
	$import_id
	$register = false
	$referenced
	$objectList
	$max_title
	$max_desc
	$add_dots
Static Public Attributes inherited from ilContainer
static	$data_preloaded = false
Protected Attributes inherited from ilContainer
	$db
	$log
	$access
	$error
	$rbacsystem
	$tree
	$user
	$obj_definition
	$order_type = 0
	$hiddenfilesfound = false
	$news_timeline = false
	$news_timeline_auto_entries = false
	$setting
Protected Attributes inherited from ilObject
	$objDefinition
	$db
	$log
	$error
	$tree
	$app_event_handler
	$rbacadmin
	$rbacreview

Detailed Description

Class ilObjCategory.

Author

Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Version

$Id$

Definition at line 19 of file class.ilObjCategory.php.

Constructor & Destructor Documentation

__construct()

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

Constructor public.

Parameters

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

Definition at line 27 of file class.ilObjCategory.php.

References $DIC, and user().

    {
        global $DIC;

        $this->db = $DIC->database();
        $this->app_event_handler = $DIC["ilAppEventHandler"];
        $this->log = $DIC["ilLog"];
        $this->user = $DIC->user();
        $this->type = "cat";
        parent::__construct($a_id, $a_call_by_reference);
    }

Here is the call graph for this function:

Member Function Documentation

addAdditionalSubItemInformation()

ilObjCategory::addAdditionalSubItemInformation

(

&

$a_item_data

)

Add additional information to sub item, e.g.

used in courses for timings information etc.

Definition at line 246 of file class.ilObjCategory.php.

References ilObjectActivation\addAdditionalSubItemInformation().

    {
        include_once './Services/Object/classes/class.ilObjectActivation.php';
        ilObjectActivation::addAdditionalSubItemInformation($a_item_data);
    }

Here is the call graph for this function:

addTranslation()

ilObjCategory::addTranslation	(		$a_title,
			$a_desc,
			$a_lang,
			$a_lang_default
	)

Definition at line 133 of file class.ilObjCategory.php.

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

    {
        $ilDB = $this->db;
        
        if (empty($a_title)) {
            $a_title = "NO TITLE";
        }

        $query = "INSERT INTO object_translation " .
             "(obj_id,title,description,lang_code,lang_default) " .
             "VALUES " .
             "(" . $ilDB->quote($this->getId(), 'integer') . "," .
                $ilDB->quote($a_title, 'text') . "," . $ilDB->quote($a_desc, 'text') . "," .
                $ilDB->quote($a_lang, 'text') . "," . $ilDB->quote($a_lang_default, 'integer') . ")";
        $res = $ilDB->manipulate($query);

        return true;
    }

Here is the call graph for this function:

cloneDependencies()

ilObjCategory::cloneDependencies	(		$a_target_id,
			$a_copy_id
	)

Definition at line 193 of file class.ilObjCategory.php.

References ilCopyWizardOptions\_getInstance(), ilObject\_lookupObjId(), ilObject\_lookupType(), ilTaxNodeAssignment\addAssignment(), ilObject\getId(), ilObjTaxonomy\getUsageOfObject(), and ilObjTaxonomy\saveUsage().

    {
        parent::cloneDependencies($a_target_id, $a_copy_id);
    
                                
        // clone taxonomies
            
        include_once("./Services/Taxonomy/classes/class.ilObjTaxonomy.php");
        $all_tax = ilObjTaxonomy::getUsageOfObject($this->getId());
        if (sizeof($all_tax)) {
            include_once("./Services/Taxonomy/classes/class.ilTaxNodeAssignment.php");
            
            $cwo = ilCopyWizardOptions::_getInstance($a_copy_id);
            $mappings = $cwo->getMappings();
            
            foreach ($all_tax as $old_tax_id) {
                if ($old_tax_id) {
                    // clone it
                    $old_tax = new ilObjTaxonomy($old_tax_id);
                    $new_tax = $old_tax->cloneObject(0, 0, true);
                    $tax_map = $old_tax->getNodeMapping();
                
                    // assign new taxonomy to new category
                    ilObjTaxonomy::saveUsage($new_tax->getId(), ilObject::_lookupObjId($a_target_id));
                                                        
                    // clone assignments (for all sub-items)
                    foreach ($mappings as $old_ref_id => $new_ref_id) {
                        if ($old_ref_id != $new_ref_id) {
                            $old_obj_id = ilObject::_lookupObjId($old_ref_id);
                            $new_obj_id = ilObject::_lookupObjId($new_ref_id);
                            $obj_type = ilObject::_lookupType($old_obj_id);
                                                                    
                            $tax_ass = new ilTaxNodeAssignment($obj_type, $old_obj_id, "obj", $old_tax_id);
                            $assignmts = $tax_ass->getAssignmentsOfItem($old_obj_id);
                            if (sizeof($assignmts)) {
                                $new_tax_ass = new ilTaxNodeAssignment($obj_type, $new_obj_id, "obj", $new_tax->getId());
                                foreach ($assignmts as $a) {
                                    if ($tax_map[$a["node_id"]]) {
                                        $new_tax_ass->addAssignment($tax_map[$a["node_id"]], $new_obj_id);
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }

Here is the call graph for this function:

cloneObject()

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

Clone course (no member data)

public

Parameters

int	target ref_id
int	copy id

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

References ilObject\getId(), and ilObjectTranslation\getInstance().

    {
        $new_obj = parent::cloneObject($a_target_id, $a_copy_id, $a_omit_tree);

        include_once("./Services/Object/classes/class.ilObjectTranslation.php");
        $ot = ilObjectTranslation::getInstance($this->getId());
        $ot->copy($new_obj->getId());

        return $new_obj;
    }

Here is the call graph for this function:

delete()

ilObjCategory::delete

(

)

delete category and all related data

public

Returns

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

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

References ilObject\$app_event_handler, ilContainer\$db, $ilDB, $query, $res, ilObjUserFolder\_updateUserFolderAssignment(), array, ilObject\getId(), ilObjTaxonomy\getUsageOfObject(), and USER_FOLDER_ID.

    {
        $ilDB = $this->db;
        $ilAppEventHandler = $this->app_event_handler;
        
        // always call parent delete function first!!
        if (!parent::delete()) {
            return false;
        }
        
        // put here category specific stuff
        include_once('./Services/User/classes/class.ilObjUserFolder.php');
        ilObjUserFolder::_updateUserFolderAssignment($this->ref_id, USER_FOLDER_ID);

        $query = "DELETE FROM object_translation WHERE obj_id = " . $ilDB->quote($this->getId(), 'integer');
        $res = $ilDB->manipulate($query);
        
        // taxonomies
        include_once "Services/Taxonomy/classes/class.ilObjTaxonomy.php";
        foreach (ilObjTaxonomy::getUsageOfObject($this->getId()) as $tax_id) {
            if ($tax_id) {
                $tax = new ilObjTaxonomy($tax_id);
                $tax->delete();
            }
        }
        
        $ilAppEventHandler->raise(
            'Modules/Category',
            'delete',
            array('object' => $this,
                'obj_id' => $this->getId())
        );
        
        return true;
    }

Here is the call graph for this function:

deleteTranslation()

ilObjCategory::deleteTranslation

(

$a_lang

)

Definition at line 122 of file class.ilObjCategory.php.

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

    {
        $ilDB = $this->db;

        $query = "DELETE FROM object_translation WHERE obj_id= " .
            $ilDB->quote($this->getId(), 'integer') . " AND lang_code = " .
            $ilDB->quote($a_lang, 'text');
        $res = $ilDB->manipulate($query);
    }

Here is the call graph for this function:

getTranslations()

ilObjCategory::getTranslations

(

)

get all translations from this category

public

Returns

array

Definition at line 87 of file class.ilObjCategory.php.

References $data, ilContainer\$db, $ilDB, $r, $row, array, ilDBConstants\FETCHMODE_OBJECT, and ilObject\getId().

    {
        $ilDB = $this->db;
        
        $q = "SELECT * FROM object_translation WHERE obj_id = " .
            $ilDB->quote($this->getId(), 'integer') . " ORDER BY lang_default DESC";
        $r = $ilDB->query($q);
        
        $num = 0;

        while ($row = $r->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $data["Fobject"][$num]= array("title"       => $row->title,
                                          "desc"        => $row->description,
                                          "lang"        => $row->lang_code
                                          );
            $num++;
        }

        // first entry is always the default language
        $data["default_language"] = 0;

        return $data ? $data : array();
    }

Here is the call graph for this function:

removeTranslations()

ilObjCategory::removeTranslations

(

)

Definition at line 112 of file class.ilObjCategory.php.

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

    {
        $ilDB = $this->db;
        
        $query = "DELETE FROM object_translation WHERE obj_id= " .
            $ilDB->quote($this->getId(), 'integer');
        $res = $ilDB->manipulate($query);
    }

Here is the call graph for this function:

updateTranslation()

ilObjCategory::updateTranslation	(		$a_title,
			$a_desc,
			$a_lang,
			$a_lang_default
	)

Definition at line 153 of file class.ilObjCategory.php.

References ilContainer\$db, $ilDB, $ilLog, ilContainer\$log, $query, $res, and ilObject\getId().

    {
        $ilDB = $this->db;
        $ilLog = $this->log;
        
        if (empty($a_title)) {
            $a_title = "NO TITLE";
        }

        $query = "UPDATE object_translation " .
             "SET title = " . $ilDB->quote($a_title, 'text') . "," .
                  "description = " . $ilDB->quote($a_desc, 'text') . "," .
                  "lang_code = " . $ilDB->quote($a_lang, 'text') . "," .
                  "lang_default = " . $ilDB->quote($a_lang_default, 'integer') . " " .
             "WHERE " .
             " obj_id = " . $ilDB->quote($this->getId(), 'integer');
        $res = $ilDB->manipulate($query);

        return true;
    }

Here is the call graph for this function:

---

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

• Modules/Category/classes/class.ilObjCategory.php