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. | |
| update () | |
| update object data | |
| cloneObject ($a_target_id, $a_copy_id=0) | |
| Clone. | |
| delete () | |
| delete object and all related data | |
| getFeedBlock () | |
| initDefaultRoles () | |
| init default roles settings | |
| 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. | |
Detailed Description
Class ilObjExternalFeed.
- Version:
- $Id$
Definition at line 33 of file class.ilObjExternalFeed.php.
Member Function Documentation
| ilObjExternalFeed::cloneObject | ( | $ | a_target_id, | |
| $ | a_copy_id = 0 | |||
| ) |
Clone.
public
- Parameters:
-
int target id int copy id
Reimplemented from ilObject.
Definition at line 73 of file class.ilObjExternalFeed.php.
References $ilLog, and getFeedBlock().
{
global $ilDB, $ilLog;
$new_obj = parent::cloneObject($a_target_id,$a_copy_id);
$fb = $this->getFeedBlock();
include_once("./Services/Block/classes/class.ilExternalFeedBlock.php");
$new_feed_block = new ilExternalFeedBlock();
$new_feed_block->setContextObjId($new_obj->getId());
$new_feed_block->setContextObjType("feed");
if (is_object($fb))
{
$new_feed_block->setFeedUrl($fb->getFeedUrl());
$new_feed_block->setTitle($fb->getTitle());
}
$new_feed_block->create();
return $new_obj;
}
Here is the call graph for this function:
| 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
Reimplemented from ilObject.
Definition at line 101 of file class.ilObjExternalFeed.php.
References ilBlockSetting::_deleteSettingsOfBlock(), ilObject::getId(), and ilObject::getType().
{
// always call parent delete function first!!
if (!parent::delete())
{
return false;
}
//put here your module specific stuff
// delete feed block
include_once("./Services/Block/classes/class.ilCustomBlock.php");
$costum_block = new ilCustomBlock();
$costum_block->setContextObjId($this->getId());
$costum_block->setContextObjType($this->getType());
$c_blocks = $costum_block->queryBlocksForContext();
include_once("./Services/Block/classes/class.ilExternalFeedBlock.php");
foreach($c_blocks as $c_block) // should be usually only one
{
if ($c_block["type"] == "feed")
{
$fb = new ilExternalFeedBlock($c_block["id"]);
$fb->delete();
include_once("./Services/Block/classes/class.ilBlockSetting.php");
ilBlockSetting::_deleteSettingsOfBlock($c_block["id"], "feed");
}
}
//ilBlockSetting::_lookupSide($type, $user_id, $c_block["id"]);
return true;
}
Here is the call graph for this function:
| ilObjExternalFeed::getFeedBlock | ( | ) |
Definition at line 135 of file class.ilObjExternalFeed.php.
References $ilLog, ilObject::getId(), and ilObject::getType().
Referenced by cloneObject().
{
global $ilLog;
// delete feed block
include_once("./Services/Block/classes/class.ilCustomBlock.php");
$costum_block = new ilCustomBlock();
$costum_block->setContextObjId($this->getId());
$costum_block->setContextObjType($this->getType());
$c_blocks = $costum_block->queryBlocksForContext();
include_once("./Services/Block/classes/class.ilExternalFeedBlock.php");
foreach($c_blocks as $c_block) // should be usually only one
{
if ($c_block["type"] == "feed")
{
$fb = new ilExternalFeedBlock($c_block["id"]);
return $fb;
}
}
return false;
}
Here is the call graph for this function:
Here is the caller graph for this function:
| ilObjExternalFeed::ilObjExternalFeed | ( | $ | 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 41 of file class.ilObjExternalFeed.php.
References ilObject::ilObject().
{
$this->type = "feed";
$this->ilObject($a_id,$a_call_by_reference);
}
Here is the call graph for this function:
| 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.
Reimplemented from ilObject.
Definition at line 168 of file class.ilObjExternalFeed.php.
{
global $rbacadmin;
// create a local role folder
//$rfoldObj = $this->createRoleFolder("Local roles","Role Folder of forum obj_no.".$this->getId());
// create moderator role and assign role to rolefolder...
//$roleObj = $rfoldObj->createRole("Moderator","Moderator of forum obj_no.".$this->getId());
//$roles[] = $roleObj->getId();
//unset($rfoldObj);
//unset($roleObj);
return $roles ? $roles : array();
}
| 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:
-
string event integer reference id of object where the event occured array passes optional parameters if required
- Returns:
- boolean
Reimplemented from ilObject.
Definition at line 198 of file class.ilObjExternalFeed.php.
References $_GET, and ilObject::getType().
{
global $tree;
switch ($a_event)
{
case "link":
//var_dump("<pre>",$a_params,"</pre>");
//echo "Module name ".$this->getRefId()." triggered by link event. Objects linked into target object ref_id: ".$a_ref_id;
//exit;
break;
case "cut":
//echo "Module name ".$this->getRefId()." triggered by cut event. Objects are removed from target object ref_id: ".$a_ref_id;
//exit;
break;
case "copy":
//var_dump("<pre>",$a_params,"</pre>");
//echo "Module name ".$this->getRefId()." triggered by copy event. Objects are copied into target object ref_id: ".$a_ref_id;
//exit;
break;
case "paste":
//echo "Module name ".$this->getRefId()." triggered by paste (cut) event. Objects are pasted into target object ref_id: ".$a_ref_id;
//exit;
break;
case "new":
//echo "Module name ".$this->getRefId()." triggered by paste (new) event. Objects are applied to target object ref_id: ".$a_ref_id;
//exit;
break;
}
// At the beginning of the recursive process it avoids second call of the notify function with the same parameter
if ($a_node_id==$_GET["ref_id"])
{
$parent_obj =& $this->ilias->obj_factory->getInstanceByRefId($a_node_id);
$parent_type = $parent_obj->getType();
if($parent_type == $this->getType())
{
$a_node_id = (int) $tree->getParentId($a_node_id);
}
}
parent::notify($a_event,$a_ref_id,$a_parent_non_rbac_id,$a_node_id,$a_params);
}
Here is the call graph for this function:
| ilObjExternalFeed::update | ( | ) |
update object data
public
- Returns:
- boolean
Reimplemented from ilObject.
Definition at line 53 of file class.ilObjExternalFeed.php.
{
if (!parent::update())
{
return false;
}
// put here object specific stuff
return true;
}
The documentation for this class was generated from the following file:
- Modules/ExternalFeed/classes/class.ilObjExternalFeed.php
