Inheritance diagram for ilContainerReference:

Collaboration diagram for ilContainerReference:

Public Member Functions
	__construct ($a_id=0, $a_call_by_reference=true)
	Constructor.
	getTargetId ()
	get target id
	setTargetId ($a_target_id)
	set target id
	setTargetRefId ($a_id)
	set target ref_id
	getTargetRefId ()
	get Target ref_id
	read ()
	read
	update ()
	update object
	delete ()
	delete
	cloneObject ($a_target_id, $a_copy_id=0)
	Clone course reference.
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
	_lookupObjIdByImportId ($a_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)
	create ()
	create
	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
	_lookupDescription ($a_id)
	lookup object description
	_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
	_lookupObjectId ($a_ref_id)
	lookup object id
	_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
	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
	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 ()
	appendCopyInfo ($a_target_id, $a_copy_id)
	Prepend Copy info if object with same name exists in that container.
	cloneDependencies ($a_target_id, $a_copy_id)
	Clone object dependencies.
	cloneMetaData ($target_obj)
	Copy meta data.

Static Public Member Functions
static	_lookupTargetId ($a_obj_id)
	lookup target id
static	_lookupTargetRefId ($a_obj_id)
	Lookup target ref_id.
static	_lookupTitle ($a_obj_id)
	Overwitten from base class.
static	_lookupTargetTitle ($a_obj_id)
	Lookup target title.
static	_lookupSourceId ($a_target_id)
	lookup source id
Static Public Member Functions inherited from ilObject
static	_getAllReferences ($a_id)
	get all reference ids of object
static	_getIdsForTitle ($title, $type= '', $partialmatch=false)
static	_lookupObjId ($a_id)
static	_lookupType ($a_id, $a_reference=false)
	lookup object type
	_exists ($a_id, $a_reference=false)
	checks if an object exists in object_data
static	_getObjectsByType ($a_obj_type="", $a_owner="")
	Get objects by type.
static	_prepareCloneSelection ($a_ref_ids, $new_type)
	Prepare copy wizard object selection.
static	_getIcon ($a_obj_id="", $a_size="big", $a_type="", $a_offline=false)
	Get icon for repository item.
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.

Protected Attributes
	$db = null
	$target_id = null
	$target_ref_id = null

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

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

Version: $Id$

Definition at line 33 of file class.ilContainerReference.php.

Constructor & Destructor Documentation

ilContainerReference::__construct	(	$a_id = `0`,
		$a_call_by_reference = `true`
	)

Constructor.

Parameters

int	$a_id	reference id
bool	$a_call_by_reference

Returns: void

Reimplemented in ilObjCategoryReference, and ilObjCourseReference.

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

References $ilDB.

        {
                global $ilDB;
                parent::__construct($a_id,$a_call_by_reference);
        }

Member Function Documentation

static ilContainerReference::_lookupSourceId ( $a_target_id )

static

lookup source id

Parameters

int $a_target_id obj_id of course or category

Returns: int obj_id of references

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

References $ilDB, $query, $res, $row, and DB_FETCHMODE_OBJECT.

Referenced by ilContainerReferenceAppEventListener\deleteReferences().

         {
                global $ilDB;
                
                $query = "SELECT * FROM container_reference ".
                        "WHERE target_obj_id = ".$ilDB->quote($a_target_id,'integer')." ";
                $res = $ilDB->query($query);
                while($row = $res->fetchRow(DB_FETCHMODE_OBJECT))
                {
                        return $row->obj_id;
                }
                return false;
         }

Here is the caller graph for this function:

static ilContainerReference::_lookupTargetId ( $a_obj_id )

static

lookup target id

public

Parameters

int $a_ref_id Course reference obj_id

Returns

Definition at line 60 of file class.ilContainerReference.php.

References $ilDB, $query, $res, $row, and DB_FETCHMODE_OBJECT.

Referenced by ilObjCourseReferenceListGUI\initItem(), and ilObjCategoryReferenceListGUI\initItem().

        {
                global $ilDB;
                
                $query = "SELECT * FROM container_reference ".
                        "WHERE obj_id = ".$ilDB->quote($a_obj_id,'integer')." ";
                $res = $ilDB->query($query);
                while($row = $res->fetchRow(DB_FETCHMODE_OBJECT))
                {
                        return $row->target_obj_id;
                }
                return $a_obj_id;
        }

Here is the caller graph for this function:

static ilContainerReference::_lookupTargetRefId ( $a_obj_id )

static

Lookup target ref_id.

Parameters

int $a_obj_id obj_id

Returns

Definition at line 80 of file class.ilContainerReference.php.

References $ilDB, $query, $res, $row, and DB_FETCHMODE_OBJECT.

Referenced by ilObjCourseReferenceAccess\_checkAccess(), ilObjCourseReferenceGUI\_goto(), and ilObjCategoryReferenceGUI\_goto().

         {
                global $ilDB;
                
                $query = "SELECT ref_id FROM object_reference obr ".
                        "JOIN container_reference cr ON obr.obj_id = cr.target_obj_id ".
                        "WHERE cr.obj_id = ".$ilDB->quote($a_obj_id,'integer');
                $res = $ilDB->query($query);
                while($row = $res->fetchRow(DB_FETCHMODE_OBJECT))
                {
                        return $row->ref_id;
                }
                return false;
         }

Here is the caller graph for this function:

static ilContainerReference::_lookupTargetTitle ( $a_obj_id )

static

Lookup target title.

Returns: string title

Definition at line 111 of file class.ilContainerReference.php.

References $ilDB, $query, $res, $row, and DB_FETCHMODE_OBJECT.

Referenced by _lookupTitle(), and ilTree\fetchNodeData().

         {
                global $ilDB;
                
                $query = "SELECT title FROM object_data od ".
                        "JOIN container_reference cr ON target_obj_id = od.obj_id ".
                        "WHERE cr.obj_id = ".$ilDB->quote($a_obj_id ,'integer');
                $res = $ilDB->query($query);
                while($row = $res->fetchRow(DB_FETCHMODE_OBJECT))
                {
                        return $row->title;
                }
                return '';
         }

Here is the caller graph for this function:

static ilContainerReference::_lookupTitle ( $a_obj_id )

static

Overwitten from base class.

Parameters

int $a_obj_id

Returns

Reimplemented from ilObject.

Definition at line 100 of file class.ilContainerReference.php.

References _lookupTargetTitle().

Referenced by read().

         {
                return ilContainerReference::_lookupTargetTitle($a_obj_id);
         }

Here is the call graph for this function:

Here is the caller graph for this function:

ilContainerReference::cloneObject	(	$a_target_id,
		$a_copy_id = `0`
	)

Clone course reference.

public

Parameters

int	target ref_id
int	copy id

Reimplemented from ilObject.

Definition at line 277 of file class.ilContainerReference.php.

References $ilDB, and $query.

        {
                global $ilDB,$ilUser;
                
                $new_obj = parent::cloneObject($a_target_id,$a_copy_id);
                
                $query = "INSERT INTO container_reference (obj_id, target_obj_id) ".
                        "VALUES( ".
                        $ilDB->quote($new_obj->getId(),'integer').", ".
                        $ilDB->quote($this->getTargetId(),'integer')." ".
                        ")";
                $ilDB->manipulate($query);
                return $new_obj;
        }

ilContainerReference::delete ( )

delete

public

Parameters

@return

Reimplemented from ilObject.

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

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

        {
                global $ilDB;
                if(!parent::delete())
                {
                        return false;
                }
                $query = "DELETE FROM container_reference ".
                        "WHERE obj_id = ".$ilDB->quote($this->getId(),'integer')." ";
                $ilDB->manipulate($query);
                
                return true;
        }

Here is the call graph for this function:

ilContainerReference::getTargetId ( )

get target id

public

Returns

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

References $target_id.

Referenced by read(), and update().

        {
                return $this->target_id;
        }

Here is the caller graph for this function:

ilContainerReference::getTargetRefId ( )

get Target ref_id

public

Parameters

@return

Definition at line 190 of file class.ilContainerReference.php.

References $target_ref_id.

        {
                return $this->target_ref_id;
        }

ilContainerReference::read ( )

read

public

Returns

Definition at line 201 of file class.ilContainerReference.php.

References $ilDB, $query, $res, $row, ilObject\_getAllReferences(), _lookupTitle(), DB_FETCHMODE_OBJECT, ilObject\getId(), getTargetId(), setTargetId(), and setTargetRefId().

        {
                global $ilDB;
                
                parent::read();
                
                $query = "SELECT * FROM container_reference ".
                        "WHERE obj_id = ".$ilDB->quote($this->getId(),'integer')." ";
                $res = $ilDB->query($query);
                while($row = $res->fetchRow(DB_FETCHMODE_OBJECT))
                {
                        $this->setTargetId($row->target_obj_id);
                }
                $ref_ids = ilObject::_getAllReferences($this->getTargetId());
                $this->setTargetRefId(current($ref_ids));
                
                $this->title = $this->lng->txt('reference_of').' '.ilObject::_lookupTitle($this->getTargetId());
                
        }

Here is the call graph for this function:

ilContainerReference::setTargetId ( $a_target_id )

set target id

public

Parameters

int $a_target_id target id

Returns

Definition at line 166 of file class.ilContainerReference.php.

Referenced by read().

        {
                $this->target_id = $a_target_id;
        }

Here is the caller graph for this function:

ilContainerReference::setTargetRefId ( $a_id )

set target ref_id

public

Parameters

@return

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

Referenced by read().

        {
                $this->target_ref_id = $a_id;
        }

Here is the caller graph for this function:

ilContainerReference::update ( )

update object

public

Parameters

@return

Reimplemented from ilObject.

Definition at line 228 of file class.ilContainerReference.php.

References $ilDB, $query, ilObject\getId(), and getTargetId().

        {
                global $ilDB;
                
                parent::update();
                
                $query = "DELETE FROM container_reference ".
                        "WHERE obj_id = ".$ilDB->quote($this->getId(),'integer')." ";
                $ilDB->manipulate($query);
                
                $query = "INSERT INTO container_reference (obj_id, target_obj_id) ".
                        "VALUES( ".
                        $ilDB->quote($this->getId(),'integer').", ".
                        $ilDB->quote($this->getTargetId(),'integer')." ".
                        ")";
                $ilDB->manipulate($query);
        }