ILIAS  release_4-3 Revision
 All Data Structures Namespaces Files Functions Variables Groups Pages
ilObjItemGroup Class Reference

Class ilObjItemGroup. More...

+ Inheritance diagram for ilObjItemGroup:
+ Collaboration diagram for ilObjItemGroup:

Public Member Functions

 __construct ($a_id=0, $a_reference=true)
 Constructor.
 initType ()
 Init type.
 cloneDependencies ($a_target_id, $a_copy_id)
 Clone dependencies.
- Public Member Functions inherited from ilObject2
 withReferences ()
 determines wehter objects are referenced or not (got ref ids or not)
 read ($a_force_db=false)
 Read data from db.
 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
 setObjDataRecord ($a_record)
 set object_data record (note: this method should only be called from the ilObjectFactory class)
 create ($a_clone_mode=false)
 update ()
 update object in db
 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
 createReference ()
 creates reference for object
 countReferences ()
 count references of object
 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!!
 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
 createRoleFolder ()
 creates a local role folder
 _exists ($a_id, $a_reference=false)
 checks if an object exists in object_data
 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 ()
 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.
 cloneObject ($a_target_id, $a_copy_id=null, $a_omit_tree=false)
 Clone object permissions, put in tree ...
- Public Member Functions inherited from ilObject
 ilObject ($a_id=0, $a_reference=true)
 Constructor public.
 getDiskUsage ()
 Gets the disk usage of the object in bytes.
 create ()
 create
 applyDidacticTemplate ($a_tpl_id)
 Apply template.
 getXMLZip ()
 getHTMLDirectory ()
 _lookupCreationDate ($a_id)
 Lookup creation date.

Static Public Member Functions

static fixContainerItemGroupRefsAfterCloning ($a_source_container, $a_copy_id)
 Fix container item group references after a container has been cloned.
- Static Public Member Functions inherited from ilObject2
static _lookupObjIdByImportId ($a_import_id)
static _getAllReferences ($a_id)
 get all reference ids of object
static _lookupTitle ($a_id)
 lookup object title
static _getIdsForTitle ($title, $type= '', $partialmatch=false)
static _lookupDescription ($a_id)
 lookup object description
static _lookupObjId ($a_id)
static _lookupType ($a_id, $a_reference=false)
 lookup object type
static _lookupObjectId ($a_ref_id)
 lookup object id
static _getObjectsByType ($a_obj_type="", $a_owner="")
 Get objects by type.
static _prepareCloneSelection ($a_ref_ids, $new_type)
static _getIcon ($a_obj_id="", $a_size="big", $a_type="", $a_offline=false)
 Get icon for repository item.
- Static Public Member Functions inherited from ilObject
static _prepareCloneSelection ($a_ref_ids, $new_type, $show_path=true)
 Prepare copy wizard object selection.
static collectDeletionDependencies (&$deps, $a_ref_id, $a_obj_id, $a_type, $a_depth=0)
 Collect deletion dependencies.
static getDeletionDependencies ($a_obj_id)
 Get deletion dependencies.
static getLongDescriptions (array $a_obj_ids)
 Get long description data.
static getAllOwnedRepositoryObjects ($a_user_id)
 Get all ids of objects user owns.

Protected Member Functions

 doRead ()
 Read.
 propertiesToDB ()
 Get properties array.
 doCreate ()
 Creation.
 doUpdate ()
 Update.
 doDelete ()
 Deletion.
 doCloneObject ($new_obj, $a_target_id, $a_copy_id)
 Clone obj item group.
- Protected Member Functions inherited from ilObject2
 beforeCreate ()
 beforeUpdate ()
 doMDUpdateListener ($a_element)
 beforeMDUpdateListener ($a_element)
 doCreateMetaData ()
 beforeCreateMetaData ()
 doUpdateMetaData ()
 beforeUpdateMetaData ()
 beforeDelete ()
 beforeCloneObject ()

Protected Attributes

 $access_type
 $access_begin
 $access_end
 $access_visibility

Additional Inherited Members

- Data Fields inherited from ilObject
const TITLE_LENGTH = 128
 max length of object title
 $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

Detailed Description

Class ilObjItemGroup.

Author
Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e
Version
$Id$

Definition at line 16 of file class.ilObjItemGroup.php.

Constructor & Destructor Documentation

ilObjItemGroup::__construct (   $a_id = 0,
  $a_reference = true 
)

Constructor.

Parameters
int$a_idid
bool$a_referenceref id?
Returns

Reimplemented from ilObject2.

Definition at line 30 of file class.ilObjItemGroup.php.

{
global $tree, $objDefinition;
$this->tree = $tree;
$this->obj_def = $objDefinition;
parent::__construct($a_id, $a_reference);
}

Member Function Documentation

ilObjItemGroup::cloneDependencies (   $a_target_id,
  $a_copy_id 
)

Clone dependencies.

Parameters
@return

Reimplemented from ilObject2.

Definition at line 165 of file class.ilObjItemGroup.php.

References $ilLog, and ilObject2\getRefId().

{
global $ilLog;
$ilLog->write(__METHOD__.': Cloning item group dependencies -'.$a_source_id.'-');
parent::cloneDependencies($a_target_id,$a_copy_id);
include_once('./Modules/ItemGroup/classes/class.ilItemGroupItems.php');
$ig_items = new ilItemGroupItems($a_target_id);
$ig_items->cloneItems($this->getRefId(), $a_copy_id);
return true;
}

+ Here is the call graph for this function:

ilObjItemGroup::doCloneObject (   $new_obj,
  $a_target_id,
  $a_copy_id 
)
protected

Clone obj item group.

Parameters
@return

Reimplemented from ilObject2.

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

{
}
ilObjItemGroup::doCreate ( )
protected

Creation.

Reimplemented from ilObject2.

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

References ilObject2\getId(), and propertiesToDB().

{
global $ilDB;
if($this->getId())
{
$fields = $this->propertiesToDB();
// $fields["id"] = array("integer", $this->getId());
// $ilDB->insert("il_poll", $fields);
// object activation default entry will be created on demand
}
}

+ Here is the call graph for this function:

ilObjItemGroup::doDelete ( )
protected

Deletion.

Reimplemented from ilObject2.

Definition at line 132 of file class.ilObjItemGroup.php.

References ilObject2\getId().

{
global $ilDB;
if($this->getId())
{
if($this->ref_id)
{
// ilObjectActivation::deleteAllEntries($this->ref_id);
}
// $ilDB->manipulate("DELETE FROM il_poll".
// " WHERE id = ".$ilDB->quote($this->id, "integer"));
}
}

+ Here is the call graph for this function:

ilObjItemGroup::doRead ( )
protected

Read.

Reimplemented from ilObject2.

Definition at line 51 of file class.ilObjItemGroup.php.

{
global $ilDB;
/*$set = $ilDB->query("SELECT * FROM il_poll".
" WHERE id = ".$ilDB->quote($this->getId(), "integer"));
$row = $ilDB->fetchAssoc($set);*/
if ($this->ref_id)
{
/* $activation = ilObjectActivation::getItem($this->ref_id);
$this->setAccessType($activation["timing_type"]);
$this->setAccessBegin($activation["timing_start"]);
$this->setAccessEnd($activation["timing_end"]);
$this->setAccessVisibility($activation["visible"]);*/
}
}
ilObjItemGroup::doUpdate ( )
protected

Update.

Reimplemented from ilObject2.

Definition at line 104 of file class.ilObjItemGroup.php.

References ilObject2\getId(), and propertiesToDB().

{
global $ilDB;
if($this->getId())
{
$fields = $this->propertiesToDB();
// $ilDB->update("il_poll", $fields,
// array("id"=>array("integer", $this->getId())));
if($this->ref_id)
{
/* $activation = new ilObjectActivation();
$activation->setTimingType($this->getAccessType());
$activation->setTimingStart($this->getAccessBegin());
$activation->setTimingEnd($this->getAccessEnd());
$activation->toggleVisible($this->getAccessVisibility());
$activation->update($this->ref_id);*/
}
}
}

+ Here is the call graph for this function:

static ilObjItemGroup::fixContainerItemGroupRefsAfterCloning (   $a_source_container,
  $a_copy_id 
)
static

Fix container item group references after a container has been cloned.

Parameters
@return

Definition at line 186 of file class.ilObjItemGroup.php.

References $ilLog, ilPageObject\_exists(), ilCopyWizardOptions\_getInstance(), ilObject2\_lookupObjId(), ilPageObject\buildDom(), and ilPCResources\modifyItemGroupRefIdsByMapping().

Referenced by ilContainer\cloneDependencies().

{
global $ilLog;
$ilLog->write(__METHOD__.': Fix item group references in '.$a_source_container->getType());
include_once('Services/CopyWizard/classes/class.ilCopyWizardOptions.php');
$mappings = $cwo->getMappings();
$new_container_ref_id = $mappings[$a_source_container->getRefId()];
$ilLog->write(__METHOD__.': 2-'.$new_container_ref_id.'-');
$new_container_obj_id = ilObject::_lookupObjId($new_container_ref_id);
include_once("./Services/COPage/classes/class.ilPageObject.php");
if (ilPageObject::_exists($a_source_container->getType(), $new_container_obj_id))
{
$new_page = new ilPageObject($a_source_container->getType(), $new_container_obj_id);
$new_page->buildDom();
include_once("./Services/COPage/classes/class.ilPCResources.php");
$new_page->update();
}
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ilObjItemGroup::initType ( )

Init type.

Reimplemented from ilObject2.

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

{
$this->type = "itgr";
}
ilObjItemGroup::propertiesToDB ( )
protected

Get properties array.

Definition at line 72 of file class.ilObjItemGroup.php.

Referenced by doCreate(), and doUpdate().

{
$fields = array(
);
return $fields;
}

+ Here is the caller graph for this function:

Field Documentation

ilObjItemGroup::$access_begin
protected

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

ilObjItemGroup::$access_end
protected

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

ilObjItemGroup::$access_type
protected

Definition at line 18 of file class.ilObjItemGroup.php.

ilObjItemGroup::$access_visibility
protected

Definition at line 21 of file class.ilObjItemGroup.php.


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