ILIAS  release_4-4 Revision
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 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 ()
 
 initDefaultRoles ()
 init default roles settings 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 happend, each object may decide how it reacts. 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...
 
 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...
 
 createRoleFolder ()
 creates a local role folder 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...
 

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

public

Parameters
inttarget id
intcopy id

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

References $ilLog, and getFeedBlock().

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.
+ Here is the call graph for this function:

◆ delete()

ilObjExternalFeed::delete ( )

delete object and all related data

public

Returns
boolean true if all object data were removed; false if only a references were removed

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

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

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  }
Custom block for external feeds.
getId()
get object id public
static _deleteSettingsOfBlock($a_block_id, $a_block_type)
Delete block settings of block.
getType()
get object type public
This is the super class of all custom blocks.
+ Here is the call graph for this function:

◆ getFeedBlock()

ilObjExternalFeed::getFeedBlock ( )

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

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

Referenced by cloneObject().

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  }
Custom block for external feeds.
getId()
get object id public
getType()
get object type public
This is the super class of all custom blocks.
+ 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 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.

References ilObject\ilObject().

22  {
23  $this->type = "feed";
24  $this->ilObject($a_id,$a_call_by_reference);
25  }
ilObject($a_id=0, $a_reference=true)
Constructor public.
+ Here is the call graph for this function:

◆ initDefaultRoles()

ilObjExternalFeed::initDefaultRoles ( )

init default roles settings

If your module does not require any default roles, delete this method (For an example how this method is used, look at ilObjForum)

public

Returns
array object IDs of created local roles.

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

149  {
150  global $rbacadmin;
151 
152  // create a local role folder
153  //$rfoldObj = $this->createRoleFolder("Local roles","Role Folder of forum obj_no.".$this->getId());
154 
155  // create moderator role and assign role to rolefolder...
156  //$roleObj = $rfoldObj->createRole("Moderator","Moderator of forum obj_no.".$this->getId());
157  //$roles[] = $roleObj->getId();
158 
159  //unset($rfoldObj);
160  //unset($roleObj);
161 
162  return $roles ? $roles : array();
163  }

◆ 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)

public

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

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

References $_GET, and ilObject\getType().

179  {
180  global $tree;
181 
182  switch ($a_event)
183  {
184  case "link":
185 
186  //var_dump("<pre>",$a_params,"</pre>");
187  //echo "Module name ".$this->getRefId()." triggered by link event. Objects linked into target object ref_id: ".$a_ref_id;
188  //exit;
189  break;
190 
191  case "cut":
192 
193  //echo "Module name ".$this->getRefId()." triggered by cut event. Objects are removed from target object ref_id: ".$a_ref_id;
194  //exit;
195  break;
196 
197  case "copy":
198 
199  //var_dump("<pre>",$a_params,"</pre>");
200  //echo "Module name ".$this->getRefId()." triggered by copy event. Objects are copied into target object ref_id: ".$a_ref_id;
201  //exit;
202  break;
203 
204  case "paste":
205 
206  //echo "Module name ".$this->getRefId()." triggered by paste (cut) event. Objects are pasted into target object ref_id: ".$a_ref_id;
207  //exit;
208  break;
209 
210  case "new":
211 
212  //echo "Module name ".$this->getRefId()." triggered by paste (new) event. Objects are applied to target object ref_id: ".$a_ref_id;
213  //exit;
214  break;
215  }
216 
217  // At the beginning of the recursive process it avoids second call of the notify function with the same parameter
218  if ($a_node_id==$_GET["ref_id"])
219  {
220  $parent_obj =& $this->ilias->obj_factory->getInstanceByRefId($a_node_id);
221  $parent_type = $parent_obj->getType();
222  if($parent_type == $this->getType())
223  {
224  $a_node_id = (int) $tree->getParentId($a_node_id);
225  }
226  }
227 
228  parent::notify($a_event,$a_ref_id,$a_parent_non_rbac_id,$a_node_id,$a_params);
229  }
$_GET["client_id"]
redirection script todo: (a better solution should control the processing via a xml file) ...
getType()
get object type public
+ Here is the call graph for this function:

◆ update()

ilObjExternalFeed::update ( )

update object data

public

Returns
boolean

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: