ilContainerReference Class Reference

Inheritance diagram for ilContainerReference:

Collaboration diagram for ilContainerReference:

Public Member Functions
	__construct ($a_id=0, $a_call_by_reference=true)
	Constructor. More...
	getTargetId ()
	get target id More...
	setTargetId ($a_target_id)
	set target id More...
	setTargetRefId ($a_id)
	set target ref_id More...
	getTargetRefId ()
	get Target ref_id More...
	getTitleType ()
	get title type More...
	setTitleType ($type)
	Set title type. More...
	read ()
	read More...
	getPresentationTitle ()
	Get presentation title. More...
	update ()
	update object More...
	delete ()
	delete More...
	cloneObject ($a_target_id, $a_copy_id=0)
	Clone course reference. 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...
	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...
	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...
	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...

Static Public Member Functions
static	_lookupTargetId ($a_obj_id)
	lookup target id More...
static	_lookupTargetRefId ($a_obj_id)
	Lookup target ref_id. More...
static	_lookupTitle ($a_obj_id)
	Overwitten from base class. More...
static	_lookupTargetTitle ($a_obj_id)
	Lookup target title. More...
static	_lookupSourceId ($a_target_id)
	lookup source id 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
const	TITLE_TYPE_REUSE = 1
const	TITLE_TYPE_CUSTOM = 2
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...

Protected Attributes
	$db = null
	$target_id = null
	$target_ref_id = null
	$title_type = self::TITLE_TYPE_REUSE

Detailed Description

Author

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

Version

$Id$

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

Constructor & Destructor Documentation

__construct()

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

Constructor.

Parameters

int	$a_id	reference id
bool	$a_call_by_reference

Returns

void

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

References $ilDB.

        {
                global $ilDB;

                parent::__construct($a_id,$a_call_by_reference);
        }

Member Function Documentation

_lookupSourceId()

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 152 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:

_lookupTargetId()

static ilContainerReference::_lookupTargetId (   $a_obj_id )

static

lookup target id

public

Parameters

int

$a_ref_id

Course reference obj_id

Returns

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

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

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

        {
                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:

_lookupTargetRefId()

static ilContainerReference::_lookupTargetRefId (   $a_obj_id )

static

Lookup target ref_id.

Parameters

int

$a_obj_id

obj_id

Returns

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

_lookupTargetTitle()

static ilContainerReference::_lookupTargetTitle (   $a_obj_id )

static

Lookup target title.

Returns

string title

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

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

Referenced by _lookupTitle(), and ilCourseObjectivesTableGUI\fillRow().

         {
                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:

_lookupTitle()

static ilContainerReference::_lookupTitle (   $a_obj_id )

static

Overwitten from base class.

Parameters

int

$a_obj_id

Returns

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

References $ilDB, $query, $res, $row, _lookupTargetTitle(), DB_FETCHMODE_OBJECT, and TITLE_TYPE_CUSTOM.

Referenced by ilTree\fetchNodeData(), ilNoteGUI\getNoteListHTML(), ilObjCourseReferenceListGUI\initItem(), ilObjCategoryReferenceListGUI\initItem(), and ilPCResourcesGUI\insertResourcesIntoPageContent().

         {
                 global $ilDB;
                 
                 $query = 'SELECT title,title_type FROM container_reference cr '.
                                 'JOIN object_data od ON cr.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))
                 {
                         if($row->title_type == ilContainerReference::TITLE_TYPE_CUSTOM)
                         {
                                 return $row->title;
                         }
                 }
                 return ilContainerReference::_lookupTargetTitle($a_obj_id);
         }

Here is the call graph for this function:

Here is the caller graph for this function:

cloneObject()

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

Clone course reference.

public

Parameters

int	target ref_id
int	copy id

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

References $ilDB, $ilUser, 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, title_type) ".
                        "VALUES( ".
                        $ilDB->quote($new_obj->getId(),'integer').", ".
                        $ilDB->quote($this->getTargetId(),'integer').", ".
                        $ilDB->quote($this->getTitleType(),'integer').' '.
                        ")";
                $ilDB->manipulate($query);
                return $new_obj;
        }

delete()

ilContainerReference::delete

(

)

delete

public

Parameters

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

getPresentationTitle()

ilContainerReference::getPresentationTitle

(

)

Get presentation title.

Returns

string presentation title

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

References ilObject\getTitle(), and getTitleType().

        {
                if($this->getTitleType() == self::TITLE_TYPE_CUSTOM)
                {
                        return $this->getTitle();
                }
                else
                {
                        return $this->lng->txt('reference_of').' '.$this->getTitle();
                }
        }

Here is the call graph for this function:

getTargetId()

ilContainerReference::getTargetId

(

)

get target id

public

Returns

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

getTargetRefId()

ilContainerReference::getTargetRefId

(

)

get Target ref_id

public

Parameters

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

References $target_ref_id.

        {
                return $this->target_ref_id;
        }

getTitleType()

ilContainerReference::getTitleType

(

)

get title type

Returns

type

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

References $title_type.

Referenced by getPresentationTitle(), read(), and update().

        {
                return $this->title_type;
        }

Here is the caller graph for this function:

read()

ilContainerReference::read

(

)

read

public

Returns

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

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

        {
                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);
                        $this->setTitleType($row->title_type);
                }
                $ref_ids = ilObject::_getAllReferences($this->getTargetId());
                $this->setTargetRefId(current($ref_ids));
                
                if($this->getTitleType() == ilContainerReference::TITLE_TYPE_REUSE)
                {
                        #$this->title = $this->lng->txt('reference_of').' '.ilObject::_lookupTitle($this->getTargetId());
                        $this->title = ilObject::_lookupTitle($this->getTargetId());
                }
        }

Here is the call graph for this function:

setTargetId()

ilContainerReference::setTargetId

(

$a_target_id

)

set target id

public

Parameters

int

$a_target_id

target id

Returns

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

Referenced by read().

        {
                $this->target_id = $a_target_id;
        }

Here is the caller graph for this function:

setTargetRefId()

ilContainerReference::setTargetRefId

(

$a_id

)

set target ref_id

public

Parameters

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

Referenced by read().

        {
                $this->target_ref_id = $a_id;
        }

Here is the caller graph for this function:

setTitleType()

ilContainerReference::setTitleType

(

$type

)

Set title type.

Parameters

type

$type

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

References ilObject\$type.

Referenced by read().

        {
                $this->title_type = $type;
        }

Here is the caller graph for this function:

update()

ilContainerReference::update

(

)

update object

public

Parameters

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

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

        {
                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, title_type) ".
                        "VALUES( ".
                        $ilDB->quote($this->getId(),'integer').", ".
                        $ilDB->quote($this->getTargetId(),'integer').", ".
                        $ilDB->quote($this->getTitleType(),'integer').' '.
                        ")";
                $ilDB->manipulate($query);
        }

Here is the call graph for this function:

Field Documentation

$db

ilContainerReference::$db = null

protected

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

$target_id

ilContainerReference::$target_id = null

protected

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

Referenced by getTargetId().

$target_ref_id

ilContainerReference::$target_ref_id = null

protected

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

Referenced by getTargetRefId().

$title_type

ilContainerReference::$title_type = self::TITLE_TYPE_REUSE

protected

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

Referenced by getTitleType().

TITLE_TYPE_CUSTOM

const ilContainerReference::TITLE_TYPE_CUSTOM = 2

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

Referenced by _lookupTitle(), ilContainerReferenceXmlWriter\buildTitle(), ilContainerReferenceXmlParser\handlerEndTag(), ilContainerReferenceGUI\initFormTitle(), and ilContainerReferenceGUI\updateTitleObject().

TITLE_TYPE_REUSE

const ilContainerReference::TITLE_TYPE_REUSE = 1

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

Referenced by ilContainerReferenceXmlParser\handlerBeginTag(), ilContainerReferenceGUI\initFormTitle(), and read().

---

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

• Services/ContainerReference/classes/class.ilContainerReference.php