ilObjLinkResource Class Reference

Class ilObjLinkResource. More...

Inheritance diagram for ilObjLinkResource:

Collaboration diagram for ilObjLinkResource:

Public Member Functions
	ilObjLinkResource ($a_id=0, $a_call_by_reference=true)
	Constructor public.
	create ($a_upload=false)
	create object
	update ()
	update object
	MDUpdateListener ($a_element)
	Overwriten Metadata update listener for ECS functionalities.
	delete ()
	delete object and all related data
	initLinkResourceItemsObject ()
	cloneObject ($a_target_id, $a_copy_id=0)
	Clone.
	toXML (ilXmlWriter $writer)
	Write webresource xml.
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)
	create ()
	create
	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
	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
	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.
	cloneDependencies ($a_target_id, $a_copy_id)
	Clone object dependencies.
	cloneMetaData ($target_obj)
	Copy meta data.
	_lookupCreationDate ($a_id)
	Lookup creation date.

Additional Inherited Members
Static Public Member Functions inherited from ilObject
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
	_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, $show_path=true)
	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.
static	getLongDescriptions (array $a_obj_ids)
	Get long description data.
static	getAllOwnedRepositoryObjects ($a_user_id)
	Get all ids of objects user owns.
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 ilObjLinkResource.

Author

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

Version

$Id$

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

Member Function Documentation

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

Clone.

public

Parameters

int	target id
int	copy id

Definition at line 170 of file class.ilObjLinkResource.php.

References ilObject\cloneMetaData(), and ilObject\getId().

        {
                $new_obj = parent::cloneObject($a_target_id,$a_copy_id);
                $this->cloneMetaData($new_obj);
                
                // object created now copy other settings
                include_once('Modules/WebResource/classes/class.ilLinkResourceItems.php');
                $links = new ilLinkResourceItems($this->getId());
                $links->cloneItems($new_obj->getId());
                
                return $new_obj;
        }

Here is the call graph for this function:

ilObjLinkResource::create

(

$a_upload = false

)

create object

Parameters

bool	upload mode (if enabled no meta data will be created)

Definition at line 57 of file class.ilObjLinkResource.php.

References ilObject\create(), and ilObject\createMetaData().

        {
                $new_id = parent::create();
                
                if(!$a_upload)
                {
                        $this->createMetaData();
                }
                
                return $new_id;
        }

Here is the call graph for this function:

ilObjLinkResource::delete

(

)

delete object 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 130 of file class.ilObjLinkResource.php.

References ilLinkResourceItems\_deleteAll(), ilLinkCheckNotify\_deleteObject(), ilObject\deleteMetaData(), and ilObject\getId().

        {
                // always call parent delete function first!!
                if (!parent::delete())
                {
                        return false;
                }

                // delete items
                include_once './Modules/WebResource/classes/class.ilLinkResourceItems.php';
                ilLinkResourceItems::_deleteAll($this->getId());


                // Delete notify entries
                include_once './Services/LinkChecker/classes/class.ilLinkCheckNotify.php';
                ilLinkCheckNotify::_deleteObject($this->getId());

                // delete meta data
                $this->deleteMetaData();

                return true;
        }

Here is the call graph for this function:

ilObjLinkResource::ilObjLinkResource	(		$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 45 of file class.ilObjLinkResource.php.

        {
                //$this->type = "lnkr";
                $this->type = "webr";
                parent::__construct($a_id,$a_call_by_reference);
        }

ilObjLinkResource::initLinkResourceItemsObject

(

)

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

References ilObject\getId().

        {
                include_once './Modules/WebResource/classes/class.ilLinkResourceItems.php';

                $this->items_obj =& new ilLinkResourceItems($this->getId());

                return true;
        }

Here is the call graph for this function:

ilObjLinkResource::MDUpdateListener

(

$a_element

)

Overwriten Metadata update listener for ECS functionalities.

public

Reimplemented from ilObject.

Definition at line 84 of file class.ilObjLinkResource.php.

References ilObject\$id, $ilLog, ilObject\$title, ilLinkResourceItems\_getFirstLink(), ilObject\getId(), ilObject\getType(), and ilLinkResourceItems\lookupNumberOfLinks().

        {
                global $ilLog;
                
                parent::MDUpdateListener($a_element);
                
                $md = new ilMD($this->getId(),0, $this->getType());
                if(!is_object($md_gen = $md->getGeneral()))
                {
                        return false;
                }
                $title = $md_gen->getTitle();
                foreach($md_gen->getDescriptionIds() as $id)
                {
                        $md_des = $md_gen->getDescription($id);
                        $description = $md_des->getDescription();
                        break;
                }
                switch($a_element)
                {
                        case 'General':
                                        include_once './Modules/WebResource/classes/class.ilLinkResourceItems.php';
                                        if(ilLinkResourceItems::lookupNumberOfLinks($this->getId()) == 1)
                                        {
                                                $link_arr = ilLinkResourceItems::_getFirstLink($this->getId());
                                                $link = new ilLinkResourceItems($this->getId());
                                                $link->readItem($link_arr['link_id']);
                                                $link->setTitle($title);
                                                $link->setDescription($description);
                                                $link->update();
                                        }
                                        break;
                        default:
                                return true;
                }
                return true;
        }

Here is the call graph for this function:

ilObjLinkResource::toXML

(

ilXmlWriter

$writer

)

Write webresource xml.

Parameters

ilXmlWriter

$writer

Returns

Definition at line 188 of file class.ilObjLinkResource.php.

References ilContainerSortingSettings\_lookupSortMode(), ilXmlWriter\appendXML(), ilObject\getId(), ilContainer\SORT_MANUAL, ilContainer\SORT_TITLE, ilXmlWriter\xmlElement(), ilXmlWriter\xmlEndTag(), and ilXmlWriter\xmlStartTag().

        {
                $attribs = array("obj_id" => "il_".IL_INST_ID."_webr_".$this->getId());

                $writer->xmlStartTag('WebLinks',$attribs);
                                
                // LOM MetaData
                include_once 'Services/MetaData/classes/class.ilMD2XML.php';
                $md2xml = new ilMD2XML($this->getId(),$this->getId(),'webr');
                $md2xml->startExport();
                $writer->appendXML($md2xml->getXML());

                // Sorting
                include_once './Services/Container/classes/class.ilContainerSortingSettings.php';
                switch(ilContainerSortingSettings::_lookupSortMode($this->getId()))
                {
                        case ilContainer::SORT_MANUAL:
                                $writer->xmlElement(
                                        'Sorting',
                                        array('type'    => 'Manual')
                                );
                                break;
                        
                        case ilContainer::SORT_TITLE:
                        default:
                                $writer->xmlElement(
                                        'Sorting',
                                        array('type'    => 'Title')
                                );
                                break;
                }
                
                // All links
                include_once './Modules/WebResource/classes/class.ilLinkResourceItems.php';
                $links = new ilLinkResourceItems($this->getId());
                $links->toXML($writer);
                
                
                $writer->xmlEndTag('WebLinks');
                return true;            
        }

Here is the call graph for this function:

ilObjLinkResource::update

(

)

update object

Reimplemented from ilObject.

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

References ilObject\updateMetaData().

        {
                $this->updateMetaData();
                parent::update();
        }

Here is the call graph for this function:

---

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

• Modules/WebResource/classes/class.ilObjLinkResource.php