ILIAS  release_5-1 Revision 5.0.0-5477-g43f3e3fab5f
ilObjExternalFeed Class Reference

Class ilObjExternalFeed. More...

+ Inheritance diagram for ilObjExternalFeed:
+ Collaboration diagram for ilObjExternalFeed:

Public Member Functions

 ilObjExternalFeed ($a_id=0, $a_call_by_reference=true)
 Constructor @access public. More...
 
 update ()
 update object data More...
 
 cloneObject ($a_target_id, $a_copy_id=0)
 Clone. More...
 
 delete ()
 delete object and all related data
More...
 
 getFeedBlock ()
 
 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 happend, each object may decide how it reacts. 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 ilObjExternalFeed.

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

Definition at line 13 of file class.ilObjExternalFeed.php.

Member Function Documentation

◆ cloneObject()

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

Clone.

@access public

Parameters
inttarget id
intcopy id

Definition at line 53 of file class.ilObjExternalFeed.php.

54 {
55 global $ilDB, $ilLog;
56
57 $new_obj = parent::cloneObject($a_target_id,$a_copy_id);
58 $fb = $this->getFeedBlock();
59
60 include_once("./Services/Block/classes/class.ilExternalFeedBlock.php");
61 $new_feed_block = new ilExternalFeedBlock();
62 $new_feed_block->setContextObjId($new_obj->getId());
63 $new_feed_block->setContextObjType("feed");
64
65 if (is_object($fb))
66 {
67 $new_feed_block->setFeedUrl($fb->getFeedUrl());
68 $new_feed_block->setTitle($fb->getTitle());
69 }
70 $new_feed_block->create();
71
72 return $new_obj;
73 }
Custom block for external feeds.
global $ilDB

References $ilDB, $ilLog, and getFeedBlock().

+ Here is the call graph for this function:

◆ delete()

ilObjExternalFeed::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 81 of file class.ilObjExternalFeed.php.

82 {
83 // always call parent delete function first!!
84 if (!parent::delete())
85 {
86 return false;
87 }
88
89 //put here your module specific stuff
90
91 // delete feed block
92 include_once("./Services/Block/classes/class.ilCustomBlock.php");
93 $costum_block = new ilCustomBlock();
94 $costum_block->setContextObjId($this->getId());
95 $costum_block->setContextObjType($this->getType());
96 $c_blocks = $costum_block->queryBlocksForContext();
97
98 include_once("./Services/Block/classes/class.ilExternalFeedBlock.php");
99 foreach($c_blocks as $c_block) // should be usually only one
100 {
101 if ($c_block["type"] == "feed")
102 {
103 $fb = new ilExternalFeedBlock($c_block["id"]);
104 $fb->delete();
105 include_once("./Services/Block/classes/class.ilBlockSetting.php");
106 ilBlockSetting::_deleteSettingsOfBlock($c_block["id"], "feed");
107 }
108 }
109
110 //ilBlockSetting::_lookupSide($type, $user_id, $c_block["id"]);
111
112 return true;
113 }
static _deleteSettingsOfBlock($a_block_id, $a_block_type)
Delete block settings of block.
This is the super class of all custom blocks.
getType()
get object type @access public
getId()
get object id @access public

References ilBlockSetting\_deleteSettingsOfBlock(), ilObject\getId(), and ilObject\getType().

+ Here is the call graph for this function:

◆ getFeedBlock()

ilObjExternalFeed::getFeedBlock ( )

Definition at line 115 of file class.ilObjExternalFeed.php.

116 {
117 global $ilLog;
118
119 // delete feed block
120 include_once("./Services/Block/classes/class.ilCustomBlock.php");
121 $costum_block = new ilCustomBlock();
122 $costum_block->setContextObjId($this->getId());
123 $costum_block->setContextObjType($this->getType());
124 $c_blocks = $costum_block->queryBlocksForContext();
125
126 include_once("./Services/Block/classes/class.ilExternalFeedBlock.php");
127 foreach($c_blocks as $c_block) // should be usually only one
128 {
129 if ($c_block["type"] == "feed")
130 {
131 $fb = new ilExternalFeedBlock($c_block["id"]);
132 return $fb;
133 }
134 }
135
136 return false;
137 }

References $ilLog, ilObject\getId(), and ilObject\getType().

Referenced by cloneObject().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ ilObjExternalFeed()

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

22 {
23 $this->type = "feed";
24 $this->ilObject($a_id,$a_call_by_reference);
25 }
ilObject($a_id=0, $a_reference=true)
Constructor @access public.

References ilObject\ilObject().

+ Here is the call graph for this function:

◆ notify()

ilObjExternalFeed::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 happend, each object may decide how it reacts.

If you are not required to handle any events related to your module, just delete this method. (For an example how this method is used, look at ilObjGroup)

@access public

Parameters
stringevent
integerreference id of object where the event occured
arraypasses optional parameters if required
Returns
boolean

Reimplemented from ilObject.

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

154 {
155 global $tree;
156
157 switch ($a_event)
158 {
159 case "link":
160
161 //var_dump("<pre>",$a_params,"</pre>");
162 //echo "Module name ".$this->getRefId()." triggered by link event. Objects linked into target object ref_id: ".$a_ref_id;
163 //exit;
164 break;
165
166 case "cut":
167
168 //echo "Module name ".$this->getRefId()." triggered by cut event. Objects are removed from target object ref_id: ".$a_ref_id;
169 //exit;
170 break;
171
172 case "copy":
173
174 //var_dump("<pre>",$a_params,"</pre>");
175 //echo "Module name ".$this->getRefId()." triggered by copy event. Objects are copied into target object ref_id: ".$a_ref_id;
176 //exit;
177 break;
178
179 case "paste":
180
181 //echo "Module name ".$this->getRefId()." triggered by paste (cut) event. Objects are pasted into target object ref_id: ".$a_ref_id;
182 //exit;
183 break;
184
185 case "new":
186
187 //echo "Module name ".$this->getRefId()." triggered by paste (new) event. Objects are applied to target object ref_id: ".$a_ref_id;
188 //exit;
189 break;
190 }
191
192 // At the beginning of the recursive process it avoids second call of the notify function with the same parameter
193 if ($a_node_id==$_GET["ref_id"])
194 {
195 $parent_obj =& $this->ilias->obj_factory->getInstanceByRefId($a_node_id);
196 $parent_type = $parent_obj->getType();
197 if($parent_type == $this->getType())
198 {
199 $a_node_id = (int) $tree->getParentId($a_node_id);
200 }
201 }
202
203 parent::notify($a_event,$a_ref_id,$a_parent_non_rbac_id,$a_node_id,$a_params);
204 }
$_GET["client_id"]
redirection script todo: (a better solution should control the processing via a xml file)

References $_GET, and ilObject\getType().

+ Here is the call graph for this function:

◆ update()

ilObjExternalFeed::update ( )

update object data

@access public

Returns
boolean

Reimplemented from ilObject.

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

34 {
35 if (!parent::update())
36 {
37 return false;
38 }
39
40 // put here object specific stuff
41
42 return true;
43 }

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