ilObjCategory Class Reference

Class ilObjCategory. More...

Inheritance diagram for ilObjCategory:

Collaboration diagram for ilObjCategory:

Public Member Functions
	ilObjCategory ($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)
	Clone course (no member data) More...
	addAdditionalSubItemInformation (&$a_item_data)
	Add additional information to sub item, e.g. More...
Public Member Functions inherited from ilContainer
	ilContainer ($a_id=0, $a_call_by_reference=true)
	Constructor public. More...
	createContainerDirectory ()
	Create directory for the container. More...
	getContainerDirectory ()
	Get the container directory. More...
	_getContainerDirectory ($a_id)
	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...
	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...
	_lookupContainerSetting ($a_id, $a_keyword, $a_default_value=NULL)
	Lookup a container setting. More...
	_writeContainerSetting ($a_id, $a_keyword, $a_value)
	_lookupIconPath ($a_id, $a_size="big")
	lookup icon path More...
	saveIcons ($a_big_icon, $a_small_icon, $a_tiny_icon)
	save container icons More...
	removeBigIcon ()
	remove big icon More...
	removeSmallIcon ()
	remove small icon More...
	removeTinyIcon ()
	remove tiny icon More...
	cloneObject ($a_target_id, $a_copy_id=0)
	Clone container settings. 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)
	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...
Public Member Functions inherited from ilObject
	ilObject ($a_id=0, $a_reference=true)
	Constructor public. More...
	withReferences ()
	determines wehter objects are referenced or not (got ref ids or not) More...
	read ($a_force_db=false)
	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 ()
	_lookupOwnerName ($a_owner_id)
	lookup owner name for owner id More...
	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...
	setObjDataRecord ($a_record)
	set object_data record (note: this method should only be called from the ilObjectFactory class) 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...
	_getIdForImportId ($a_import_id)
	get current object id for import id (static) More...
	_lookupOwner ($a_id)
	lookup object owner More...
	_lookupLastUpdate ($a_id, $a_as_string=false)
	lookup last update More...
	_getLastUpdateOfObjects ($a_objs)
	Get last update for a set of media objects. More...
	_setDeletedDate ($a_ref_id)
	only called in ilTree::saveSubTree More...
	_resetDeletedDate ($a_ref_id)
	only called in ilObjectGUI::insertSavedNodes More...
	_lookupDeletedDate ($a_ref_id)
	only called in ilObjectGUI::insertSavedNodes More...
	_writeTitle ($a_obj_id, $a_title)
	write title to db (static) More...
	_writeDescription ($a_obj_id, $a_desc)
	write description to db (static) More...
	_writeImportId ($a_obj_id, $a_import_id)
	write import id to db (static) More...
	_isInTrash ($a_ref_id)
	checks wether object is in trash More...
	_hasUntrashedReference ($a_obj_id)
	checks wether an object has at least one reference that is not in trash More...
	_getObjectsDataForType ($a_type, $a_omit_trash=false)
	get all objects of a certain type More...
	putInTree ($a_parent_ref)
	maybe this method should be in tree object!? More...
	setPermissions ($a_parent_ref)
	set permissions of object More...
	createReference ()
	creates reference for object More...
	countReferences ()
	count references of object More...
	delete ()
	delete object or referenced object (in the case of a referenced object, object data is only deleted if last reference is deleted) This function removes an object entirely from system!! 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...
	createRoleFolder ()
	creates a local role folder More...
	applyDidacticTemplate ($a_tpl_id)
	Apply template. More...
	notify ($a_event, $a_ref_id, $a_parent_non_rbac_id, $a_node_id, $a_params=0)
	notifys an object about an event occured Based on the event passed, each object may decide how it reacts. More...
	setRegisterMode ($a_bool)
	isUserRegistered ($a_user_id=0)
	requireRegistration ()
	getXMLZip ()
	getHTMLDirectory ()
	cloneObject ($a_target_id, $a_copy_id=0, $a_omit_tree=false)
	Clone object permissions, put in tree ... More...
	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...
	_lookupCreationDate ($a_id)
	Lookup creation date. More...

Additional Inherited Members
Static Public Member Functions inherited from ilContainer
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	_getAllReferences ($a_id)
	get all reference ids of object More...
static	_lookupTitle ($a_id)
	lookup object title More...
static	_getIdsForTitle ($title, $type='', $partialmatch=false)
static	_lookupDescription ($a_id)
	lookup object description More...
static	_lookupObjId ($a_id)
static	setDeletedDates ($a_ref_ids)
	Set deleted date type $ilDB. More...
static	_lookupType ($a_id, $a_reference=false)
	lookup object type More...
static	_lookupObjectId ($a_ref_id)
	lookup object id 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	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_ILINC = 7
const	VIEW_DEFAULT = self::VIEW_BY_TYPE
const	SORT_TITLE = 0
const	SORT_MANUAL = 1
const	SORT_ACTIVATION = 2
const	SORT_INHERIT = 3
Data Fields inherited from ilObject
const	TITLE_LENGTH = 255
	max length of object title More...
const	DESC_LENGTH = 128
	$ilias
	$lng
	$id
	$ref_id
	$type
	$title
	$untranslatedTitle
	$desc
	$long_desc
	$owner
	$create_date
	$last_update
	$import_id
	$register = false
	$referenced
	$objectList
	$max_title
	$max_desc
	$add_dots
	$obj_data_record
	object_data record More...
Static Public Attributes inherited from ilContainer
static	$data_preloaded = false
Protected Attributes inherited from ilContainer
	$order_type = 0
	$hiddenfilesfound = false

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.

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 211 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 117 of file class.ilObjCategory.php.

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

        {
                global $ilDB;
                
                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:

cloneObject()

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

Clone course (no member data)

public

Parameters

int	target ref_id
int	copy id

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

References $ilUser, ilContainer\getBigIconPath(), ilObject\getId(), ilObjectTranslation\getInstance(), ilContainer\getSmallIconPath(), and ilContainer\getTinyIconPath().

        {
                global $ilDB,$ilUser;
                
                $new_obj = parent::cloneObject($a_target_id,$a_copy_id);

                /*       done in class.ilContainer      
                include_once('./Services/Container/classes/class.ilContainerSortingSettings.php');
                ilContainerSortingSettings::_cloneSettings($this->getId(),$new_obj->getId());
                */

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

                /*
                $first = true;
                $translations = $this->getTranslations();
                if(is_array($translations['Fobject']))
                {
                        foreach($translations['Fobject'] as $num => $translation)
                        {
                                $new_obj->addTranslation($translation['title'],$translation['desc'],$translation['lang'],$first);
                                
                                if($first)
                                {
                                        $first = false;
                                }
                        }
                }*/
                
                // clone icons
                $new_obj->saveIcons($this->getBigIconPath(),
                        $this->getSmallIconPath(),
                        $this->getTinyIconPath());
                
                
                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 39 of file class.ilObjCategory.php.

References $query, $res, ilObjUserFolder\_updateUserFolderAssignment(), ilObject\getId(), and USER_FOLDER_ID.

        {
                global $ilDB,$ilAppEventHandler;
                
                // 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);
                
                $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 106 of file class.ilObjCategory.php.

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

        {
                global $ilDB;

                $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 70 of file class.ilObjCategory.php.

References $data, $r, $row, DB_FETCHMODE_OBJECT, and ilObject\getId().

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

                while ($row = $r->fetchRow(DB_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:

ilObjCategory()

ilObjCategory::ilObjCategory	(		$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 ilContainer\ilContainer().

        {
                $this->type = "cat";
                $this->ilContainer($a_id,$a_call_by_reference);
        }

Here is the call graph for this function:

removeTranslations()

ilObjCategory::removeTranslations

(

)

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

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

        {
                global $ilDB;
                
                $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 138 of file class.ilObjCategory.php.

References $ilLog, $query, $res, and ilObject\getId().

        {
                global $ilDB, $ilLog;
                
                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