ILIAS  Release_5_0_x_branch Revision 61816
 All Data Structures Namespaces Files Functions Variables Groups Pages
Public Member Functions
ilObjCategory Class Reference
Modules/Category

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.
 delete ()
 delete category and all related data
 getTranslations ()
 get all translations from this category
 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)
 cloneDependencies ($a_target_id, $a_copy_id)
 Clone object dependencies (container sorting)
 addAdditionalSubItemInformation (&$a_item_data)
 Add additional information to sub item, e.g.
- Public Member Functions inherited from ilContainer
 ilContainer ($a_id=0, $a_call_by_reference=true)
 Constructor public.
 createContainerDirectory ()
 Create directory for the container.
 getContainerDirectory ()
 Get the container directory.
 _getContainerDirectory ($a_id)
 Get the container directory.
 getBigIconPath ()
 Get path for big icon.
 getSmallIconPath ()
 Get path for small icon.
 getTinyIconPath ()
 Get path for tiny icon.
 getCustomIconPath ()
 Get path for custom icon.
 setHiddenFilesFound ($a_hiddenfilesfound)
 Set Found hidden files (set by getSubItems).
 getHiddenFilesFound ()
 Get Found hidden files (set by getSubItems).
 getStyleSheetId ()
 get ID of assigned style sheet object
 setStyleSheetId ($a_style_id)
 set ID of assigned style sheet object
 _lookupContainerSetting ($a_id, $a_keyword, $a_default_value=NULL)
 Lookup a container setting.
 _writeContainerSetting ($a_id, $a_keyword, $a_value)
 _lookupIconPath ($a_id, $a_size="big")
 lookup icon path
 saveIcons ($a_custom_icon)
 save container icons
 removeCustomIcon ()
 remove small icon
 cloneAllObject ($session_id, $client_id, $new_type, $ref_id, $clone_source, $options, $soap_call=false)
 clone all objects according to this container
 getViewMode ()
 Get container view mode.
 getOrderType ()
 Get order type default implementation.
 setOrderType ($a_value)
 getSubItems ($a_admin_panel_enabled=false, $a_include_side_block=false, $a_get_single=0)
 Get subitems of container.
 gotItems ()
 Check whether we got any items.
 getGroupedObjTypes ()
 Get grouped repository object types.
 enablePageEditing ()
 Check whether page editing is allowed for container.
 create ()
 Create.
 update ()
 Update.
 read ()
 read
- Public Member Functions inherited from ilObject
 ilObject ($a_id=0, $a_reference=true)
 Constructor public.
 withReferences ()
 determines wehter objects are referenced or not (got ref ids or not)
 read ($a_force_db=false)
 read object data from db into object
 getId ()
 get object id public
 setId ($a_id)
 set object id public
 setRefId ($a_id)
 set reference id public
 getRefId ()
 get reference id public
 getType ()
 get object type public
 setType ($a_type)
 set object type public
 getPresentationTitle ()
 get presentation title Normally same as title Overwritten for sessions
 getTitle ()
 get object title public
 getUntranslatedTitle ()
 get untranslated object title public
 setTitle ($a_title)
 set object title
 getDescription ()
 get object description
 setDescription ($a_desc)
 set object description
 getLongDescription ()
 get object long description (stored in object_description)
 getImportId ()
 get import id
 setImportId ($a_import_id)
 set import id
 getOwner ()
 get object owner
 getOwnerName ()
 _lookupOwnerName ($a_owner_id)
 lookup owner name for owner id
 setOwner ($a_owner)
 set object owner
 getCreateDate ()
 get create date public
 getLastUpdateDate ()
 get last update date public
 getDiskUsage ()
 Gets the disk usage of the object in bytes.
 setObjDataRecord ($a_record)
 set object_data record (note: this method should only be called from the ilObjectFactory class)
 MDUpdateListener ($a_element)
 Meta data update listener.
 createMetaData ()
 create meta data entry
 updateMetaData ()
 update meta data entry
 deleteMetaData ()
 delete meta data entry
 updateOwner ()
 update owner of object in db
 _getIdForImportId ($a_import_id)
 get current object id for import id (static)
 _lookupOwner ($a_id)
 lookup object owner
 _lookupLastUpdate ($a_id, $a_as_string=false)
 lookup last update
 _getLastUpdateOfObjects ($a_objs)
 Get last update for a set of media objects.
 _setDeletedDate ($a_ref_id)
 only called in ilTree::saveSubTree
 _resetDeletedDate ($a_ref_id)
 only called in ilObjectGUI::insertSavedNodes
 _lookupDeletedDate ($a_ref_id)
 only called in ilObjectGUI::insertSavedNodes
 _writeTitle ($a_obj_id, $a_title)
 write title to db (static)
 _writeDescription ($a_obj_id, $a_desc)
 write description to db (static)
 _writeImportId ($a_obj_id, $a_import_id)
 write import id to db (static)
 _isInTrash ($a_ref_id)
 checks wether object is in trash
 _hasUntrashedReference ($a_obj_id)
 checks wether an object has at least one reference that is not in trash
 _getObjectsDataForType ($a_type, $a_omit_trash=false)
 get all objects of a certain type
 putInTree ($a_parent_ref)
 maybe this method should be in tree object!?
 setPermissions ($a_parent_ref)
 set permissions of object
 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.
 createReference ()
 creates reference for object
 countReferences ()
 count references of object
 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
 applyDidacticTemplate ($a_tpl_id)
 Apply template.
 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.
 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 ...
 appendCopyInfo ($a_target_id, $a_copy_id)
 Prepend Copy info if object with same name exists in that container.
 cloneMetaData ($target_obj)
 Copy meta data.
 _lookupCreationDate ($a_id)
 Lookup creation date.

Additional Inherited Members

- Static Public Member Functions inherited from ilContainer
static _getContainerSettings ($a_id)
static _deleteContainerSettings ($a_id, $a_keyword=null, $a_keyword_like=false)
static _exportContainerSettings (ilXmlWriter $a_xml, $a_obj_id)
static getCompleteDescriptions (array $objects)
 overwrites description fields to long or short description in an assoc array keys needed (obj_id and description)
- 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
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
- 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:
class.ilObjCategory.php 51970 2014-08-01 14:14:46Z akill

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

Member Function Documentation

ilObjCategory::addAdditionalSubItemInformation ( &  $a_item_data)

Add additional information to sub item, e.g.

used in courses for timings information etc.

Reimplemented from ilContainer.

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

{
include_once './Services/Object/classes/class.ilObjectActivation.php';
ilObjectActivation::addAdditionalSubItemInformation($a_item_data);
}
ilObjCategory::addTranslation (   $a_title,
  $a_desc,
  $a_lang,
  $a_lang_default 
)

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

References $ilDB, $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:

ilObjCategory::cloneDependencies (   $a_target_id,
  $a_copy_id 
)

Clone object dependencies (container sorting)

public

Parameters
inttarget ref id of new course
intcopy id return bool

Reimplemented from ilContainer.

Definition at line 217 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:

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

Clone course (no member data)

public

Parameters
inttarget ref_id
intcopy id

Reimplemented from ilContainer.

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

References $ilDB, $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:

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

Reimplemented from ilObject.

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

References $ilDB, $query, $res, ilObjUserFolder\_updateUserFolderAssignment(), ilObject\getId(), ilObjTaxonomy\getUsageOfObject(), 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);
// 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:

ilObjCategory::deleteTranslation (   $a_lang)

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

References $ilDB, $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:

ilObjCategory::getTranslations ( )

get all translations from this category

public

Returns
array

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

References $ilDB, $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 (   $a_id = 0,
  $a_call_by_reference = true 
)

Constructor public.

Parameters
integerreference_id or object_id
booleantreat 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:

ilObjCategory::removeTranslations ( )

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

References $ilDB, $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:

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

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

References $ilDB, $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: