ILIAS  release_5-1 Revision 5.0.0-5477-g43f3e3fab5f
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 @access public. More...
 
 create ($a_upload=false)
 create object More...
 
 update ()
 update object More...
 
 MDUpdateListener ($a_element)
 Overwriten Metadata update listener for ECS functionalities. More...
 
 delete ()
 delete object and all related data More...
 
 initLinkResourceItemsObject ()
 
 cloneObject ($a_target_id, $a_copy_id=0)
 Clone. More...
 
 toXML (ilXmlWriter $writer)
 Write webresource xml. More...
 
- Public Member Functions inherited from ilObject
 ilObject ($a_id=0, $a_reference=true)
 Constructor @access 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 @access public More...
 
 setId ($a_id)
 set object id @access public More...
 
 setRefId ($a_id)
 set reference id @access public More...
 
 getRefId ()
 get reference id @access public More...
 
 getType ()
 get object type @access public More...
 
 setType ($a_type)
 set object type @access public More...
 
 getPresentationTitle ()
 get presentation title Normally same as title Overwritten for sessions More...
 
 getTitle ()
 get object title @access public More...
 
 getUntranslatedTitle ()
 get untranslated object title @access 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 @access public More...
 
 getLastUpdateDate ()
 get last update date @access public More...
 
 getDiskUsage ()
 
 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) @access 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...
 
 getPossibleSubObjects ($a_filter=true)
 get all possible subobjects of this type the object can decide which types of subobjects are possible jut in time overwrite if the decision distinguish from standard model More...
 

Additional Inherited Members

- Static Public Member Functions inherited from ilObject
static _lookupObjIdByImportId ($a_import_id)
 
static _lookupImportId ($a_obj_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 @global 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@access public 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 fixMissingTitles ($a_type, array &$a_obj_title_map)
 Try to fix missing object titles. More...
 
static hasAutoRating ($a_type, $a_ref_id)
 Check if auto rating is active for parent group/course. More...
 
- 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...
 

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

◆ cloneObject()

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

Clone.

@access public

Parameters
inttarget id
intcopy id

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

171 {
172 $new_obj = parent::cloneObject($a_target_id,$a_copy_id);
173 $this->cloneMetaData($new_obj);
174
175 // object created now copy other settings
176 include_once('Modules/WebResource/classes/class.ilLinkResourceItems.php');
177 $links = new ilLinkResourceItems($this->getId());
178 $links->cloneItems($new_obj->getId());
179
180 // append copy info weblink title
181 if(ilLinkResourceItems::_isSingular($new_obj->getId()))
182 {
183 $first = ilLinkResourceItems::_getFirstLink($new_obj->getId());
184 ilLinkResourceItems::updateTitle($first['link_id'], $new_obj->getTitle());
185 }
186
187 return $new_obj;
188 }
Class ilObjLinkResourceGUI.
static updateTitle($a_link_id, $a_title)
Update title.
static _getFirstLink($a_webr_id)
Get first link item Check before with _isSingular() if there is more or less than one.
static _isSingular($a_webr_id)
Check whether there is only one active link in the web resource.
cloneMetaData($target_obj)
Copy meta data.
getId()
get object id @access public

References ilLinkResourceItems\_getFirstLink(), ilLinkResourceItems\_isSingular(), ilObject\cloneMetaData(), ilObject\getId(), and ilLinkResourceItems\updateTitle().

+ Here is the call graph for this function:

◆ create()

ilObjLinkResource::create (   $a_upload = false)

create object

Parameters
boolupload mode (if enabled no meta data will be created)

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

58 {
59 $new_id = parent::create();
60
61 if(!$a_upload)
62 {
63 $this->createMetaData();
64 }
65
66 return $new_id;
67 }
createMetaData()
create meta data entry

References ilObject\createMetaData().

+ Here is the call graph for this function:

◆ delete()

ilObjLinkResource::delete ( )

delete object and all related data

@access 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.

131 {
132 // always call parent delete function first!!
133 if (!parent::delete())
134 {
135 return false;
136 }
137
138 // delete items
139 include_once './Modules/WebResource/classes/class.ilLinkResourceItems.php';
141
142
143 // Delete notify entries
144 include_once './Services/LinkChecker/classes/class.ilLinkCheckNotify.php';
146
147 // delete meta data
148 $this->deleteMetaData();
149
150 return true;
151 }
deleteMetaData()
delete meta data entry

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

+ Here is the call graph for this function:

◆ ilObjLinkResource()

ilObjLinkResource::ilObjLinkResource (   $a_id = 0,
  $a_call_by_reference = true 
)

Constructor @access public.

Parameters
integerreference_id or object_id
booleantreat the id as reference_id (true) or object_id (false)

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

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

◆ initLinkResourceItemsObject()

ilObjLinkResource::initLinkResourceItemsObject ( )

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

154 {
155 include_once './Modules/WebResource/classes/class.ilLinkResourceItems.php';
156
157 $this->items_obj =& new ilLinkResourceItems($this->getId());
158
159 return true;
160 }

References ilObject\getId().

+ Here is the call graph for this function:

◆ MDUpdateListener()

ilObjLinkResource::MDUpdateListener (   $a_element)

Overwriten Metadata update listener for ECS functionalities.

@access public

Reimplemented from ilObject.

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

85 {
86 global $ilLog;
87
88 parent::MDUpdateListener($a_element);
89
90 $md = new ilMD($this->getId(),0, $this->getType());
91 if(!is_object($md_gen = $md->getGeneral()))
92 {
93 return false;
94 }
95 $title = $md_gen->getTitle();
96 foreach($md_gen->getDescriptionIds() as $id)
97 {
98 $md_des = $md_gen->getDescription($id);
99 $description = $md_des->getDescription();
100 break;
101 }
102 switch($a_element)
103 {
104 case 'General':
105 include_once './Modules/WebResource/classes/class.ilLinkResourceItems.php';
107 {
108 $link_arr = ilLinkResourceItems::_getFirstLink($this->getId());
109 $link = new ilLinkResourceItems($this->getId());
110 $link->readItem($link_arr['link_id']);
111 $link->setTitle($title);
112 $link->setDescription($description);
113 $link->update();
114 }
115 break;
116 default:
117 return true;
118 }
119 return true;
120 }
static lookupNumberOfLinks($a_webr_id)
Get number of assigned links.
getType()
get object type @access public

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

+ Here is the call graph for this function:

◆ toXML()

ilObjLinkResource::toXML ( ilXmlWriter  $writer)

Write webresource xml.

Parameters
ilXmlWriter$writer
Returns

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

196 {
197 $attribs = array("obj_id" => "il_".IL_INST_ID."_webr_".$this->getId());
198
199 $writer->xmlStartTag('WebLinks',$attribs);
200
201 // LOM MetaData
202 include_once 'Services/MetaData/classes/class.ilMD2XML.php';
203 $md2xml = new ilMD2XML($this->getId(),$this->getId(),'webr');
204 $md2xml->startExport();
205 $writer->appendXML($md2xml->getXML());
206
207 // Sorting
208 include_once './Services/Container/classes/class.ilContainerSortingSettings.php';
210 {
212 $writer->xmlElement(
213 'Sorting',
214 array('type' => 'Manual')
215 );
216 break;
217
219 default:
220 $writer->xmlElement(
221 'Sorting',
222 array('type' => 'Title')
223 );
224 break;
225 }
226
227 // All links
228 include_once './Modules/WebResource/classes/class.ilLinkResourceItems.php';
229 $links = new ilLinkResourceItems($this->getId());
230 $links->toXML($writer);
231
232
233 $writer->xmlEndTag('WebLinks');
234 return true;
235 }
static _lookupSortMode($a_obj_id)
lookup sort mode
xmlEndTag($tag)
Writes an endtag.
xmlStartTag($tag, $attrs=NULL, $empty=FALSE, $encode=TRUE, $escape=TRUE)
Writes a starttag.
appendXML($a_str)
append xml string to document
xmlElement($tag, $attrs=NULL, $data=Null, $encode=TRUE, $escape=TRUE)
Writes a basic element (no children, just textual content)

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

+ Here is the call graph for this function:

◆ update()

ilObjLinkResource::update ( )

update object

Reimplemented from ilObject.

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

73 {
74 $this->updateMetaData();
75 parent::update();
76 }
updateMetaData()
update meta data entry

References ilObject\updateMetaData().

+ Here is the call graph for this function:

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