Inheritance diagram for ilObjBlog:

Collaboration diagram for ilObjBlog:

Public Member Functions
	initType ()

	getNotesStatus ()
	Get notes status. More...

	setNotesStatus ($a_status)
	Toggle notes status. More...

	hasProfilePicture ()
	Get profile picture status. More...

	setProfilePicture ($a_status)
	Toggle profile picture status. More...

	getBackgroundColor ()
	Get background color. More...

	setBackgroundColor ($a_value)
	Set background color. More...

	getFontColor ()
	Get font color. More...

	setFontColor ($a_value)
	Set font color. More...

	getImage ()
	Get banner image. More...

	setImage ($a_value)
	Set banner image. More...

	getImageFullPath ($a_as_thumb=false)
	Get banner image incl. More...

	deleteImage ()
	remove existing file More...

	uploadImage (array $a_upload)
	Upload new image file. More...

	hasRSS ()
	Get RSS status. More...

	setRSS ($a_status)
	Toggle RSS status. More...

	hasApproval ()
	Get approval status. More...

	setApproval ($a_status)
	Toggle approval status. More...

	getStyleSheetId ()
	Get style sheet id. More...

	setStyleSheetId ($a_style)
	Set style sheet id. More...

	initDefaultRoles ()

	getLocalContributorRole ($a_node_id)
	Get object id of local contributor role. More...

	getRolesWithContribute ($a_node_id)

Public Member Functions inherited from ilObject2
	__construct ($a_id=0, $a_reference=true)
	Constructor public. More...

	withReferences ()

	read ($a_force_db=false)
	Read data from db. More...

	getId ()

	setId ($a_id)

	setRefId ($a_id)

	getRefId ()

	getType ()

	setType ($a_type)

	getPresentationTitle ()

	getTitle ()

	getUntranslatedTitle ()

	setTitle ($a_title)

	getDescription ()

	setDescription ($a_desc)

	getLongDescription ()

	getImportId ()

	setImportId ($a_import_id)

	getOwner ()

	getOwnerName ()

	_lookupOwnerName ($a_owner_id)

	setOwner ($a_owner)

	getCreateDate ()

	getLastUpdateDate ()

	setObjDataRecord ($a_record)

	create ($a_clone_mode=false)

	update ()

	MDUpdateListener ($a_element)

	createMetaData ()

	updateMetaData ()

	deleteMetaData ()

	updateOwner ()

	_getIdForImportId ($a_import_id)

	_lookupOwner ($a_id)

	_lookupLastUpdate ($a_id, $a_as_string=false)

	_getLastUpdateOfObjects ($a_objs)

	_setDeletedDate ($a_ref_id)

	_resetDeletedDate ($a_ref_id)

	_lookupDeletedDate ($a_ref_id)

	_writeTitle ($a_obj_id, $a_title)

	_writeDescription ($a_obj_id, $a_desc)

	_writeImportId ($a_obj_id, $a_import_id)

	_isInTrash ($a_ref_id)

	_hasUntrashedReference ($a_obj_id)

	_getObjectsDataForType ($a_type, $a_omit_trash=false)

	putInTree ($a_parent_ref)

	setPermissions ($a_parent_ref)

	createReference ()

	countReferences ()

	delete ()

	initDefaultRoles ()

	createRoleFolder ()

	notify ($a_event, $a_ref_id, $a_parent_non_rbac_id, $a_node_id, $a_params=0)

	setRegisterMode ($a_bool)

	isUserRegistered ($a_user_id=0)

	requireRegistration ()

	appendCopyInfo ($a_target_id, $a_copy_id)

	cloneMetaData ($target_obj)

	cloneObject ($a_target_id, $a_copy_id=null, $a_omit_tree=false)

	cloneDependencies ($a_target_id, $a_copy_id)

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

Static Public Member Functions
static	initStorage ($a_id, $a_subdir=null)
	Init file system storage. More...

static	sendNotification ($a_action, $a_in_wsp, $a_blog_node_id, $a_posting_id, $a_comment=null)

static	deliverRSS ($a_wsp_id)
	Deliver blog as rss feed. More...

Static Public Member Functions inherited from ilObject2
static	_lookupObjIdByImportId ($a_import_id)

static	_getAllReferences ($a_id)

static	_lookupTitle ($a_id)

static	_getIdsForTitle ($title, $type='', $partialmatch=false)

static	_lookupDescription ($a_id)

static	_lookupObjId ($a_id)

static	_lookupType ($a_id, $a_reference=false)

static	_lookupObjectId ($a_ref_id)

static	_exists ($a_id, $a_reference=false)

static	_getObjectsByType ($a_obj_type="", $a_owner="")

static	_prepareCloneSelection ($a_ref_ids, $new_type)

static	_getIcon ($a_obj_id="", $a_size="big", $a_type="", $a_offline=false)

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

Protected Member Functions
	doRead ()

	doCreate ()

	doDelete ()

	doUpdate ()

	doCloneObject (ilObjBlog $new_obj, $a_target_id, $a_copy_id=null)

	handleQuotaUpdate ()

Protected Member Functions inherited from ilObject2
	initType ()

	doRead ()

	doCreate ()

	beforeCreate ()

	doUpdate ()

	beforeUpdate ()

	doMDUpdateListener ($a_element)

	beforeMDUpdateListener ($a_element)

	doCreateMetaData ()

	beforeCreateMetaData ()

	doUpdateMetaData ()

	beforeUpdateMetaData ()

	doDelete ()

	beforeDelete ()

	doCloneObject ($new_obj, $a_target_id, $a_copy_id=null)

	beforeCloneObject ()

Protected Attributes
	$notes

	$bg_color

	$font_color

	$img

	$ppic

	$rss

	$approval

	$style

Additional Inherited Members
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 ilObjBlog.

Author: Jörg Lützenkirchen luetz.nosp@m.enki.nosp@m.rchen.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Version

Id: class.ilObjFolder.php 25528 2010-09-03 10:37:11Z smeyer

Definition at line 15 of file class.ilObjBlog.php.

Member Function Documentation

◆ deleteImage()

ilObjBlog::deleteImage ( )

remove existing file

Definition at line 275 of file class.ilObjBlog.php.

References handleQuotaUpdate(), and setImage().

Referenced by doDelete(), and uploadImage().

         {
                 if($this->id)
                 {
                         include_once "Modules/Blog/classes/class.ilFSStorageBlog.php";
                         $storage = new ilFSStorageBlog($this->id);
                         $storage->delete();
                         
                         $this->setImage(null);
                         
                         $this->handleQuotaUpdate();
                 }
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ deliverRSS()

static ilObjBlog::deliverRSS ( $a_wsp_id )

static

Deliver blog as rss feed.

Parameters

int $a_wsp_id

Definition at line 515 of file class.ilObjBlog.php.

References ilObject\$id, $ilSetting, $tpl, ilLink\_getStaticLink(), ilPageObject\_lookupActive(), ilObject\_lookupObjId(), exit, ilBlogPosting\getAllPostings(), ilBlogPostingGUI\getSnippet(), and IL_CAL_DATETIME.

         {
                 global $tpl, $ilSetting;
                 
                 if(!$ilSetting->get('enable_global_profiles'))
                 {
                         return;
                 }
                 
                 // #10827
                 if(substr($a_wsp_id, -4) != "_cll")
                 {
                         include_once "Services/PersonalWorkspace/classes/class.ilWorkspaceTree.php";
                         $wsp_id = new ilWorkspaceTree(0);
                         $obj_id = $wsp_id->lookupObjectId($a_wsp_id);   
                         $is_wsp = "_wsp";
                 }
                 else
                 {
                         $a_wsp_id = substr($a_wsp_id, 0, -4);
                         $obj_id = ilObject::_lookupObjId($a_wsp_id);
                         $is_wsp = null;
                 }
                 if(!$obj_id)
                 {                       
                         return;
                 }
                 
                 $blog = new self($obj_id, false);               
                 if(!$blog->hasRSS())
                 {
                         return;
                 }
                                         
                 include_once "Services/Feeds/classes/class.ilFeedWriter.php";
                 $feed = new ilFeedWriter();
                                 
                 include_once "Services/Link/classes/class.ilLink.php";
                 $url = ilLink::_getStaticLink($a_wsp_id, "blog", true, $is_wsp);
                 $url = str_replace("&", "&amp;", $url);
                 
                 // #11870
                 $feed->setChannelTitle(str_replace("&", "&amp;", $blog->getTitle()));
                 $feed->setChannelDescription(str_replace("&", "&amp;", $blog->getDescription()));
                 $feed->setChannelLink($url);
                 
                 // needed for blogpostinggui / pagegui
                 $tpl = new ilTemplate("tpl.main.html", true, true);
                 
                 include_once("./Modules/Blog/classes/class.ilBlogPosting.php");                                 
                 include_once("./Modules/Blog/classes/class.ilBlogPostingGUI.php");                      
                 foreach(ilBlogPosting::getAllPostings($obj_id) as $item)
                 {
                         $id = $item["id"];
 
                         // only published items
                         $is_active = ilBlogPosting::_lookupActive($id, "blp");
                         if(!$is_active)
                         {
                                 continue;
                         }
                                                                         
                         $snippet = strip_tags(ilBlogPostingGUI::getSnippet($id));
                         $snippet = str_replace("&", "&amp;", $snippet); 
 
                         $url = ilLink::_getStaticLink($a_wsp_id, "blog", true, "_".$id.$is_wsp);
                         $url = str_replace("&", "&amp;", $url);                         
 
                         $feed_item = new ilFeedItem();
                         $feed_item->setTitle(str_replace("&", "&amp;", $item["title"])); // #16022
                         $feed_item->setDate($item["created"]->get(IL_CAL_DATETIME));
                         $feed_item->setDescription($snippet);
                         $feed_item->setLink($url);
                         $feed_item->setAbout($url);                             
                         $feed->addItem($feed_item);
                 }                                       
                 
                 $feed->showFeed();
                 exit();         
         }       

Here is the call graph for this function:

◆ doCloneObject()

ilObjBlog::doCloneObject	(	ilObjBlog	$new_obj,
			$a_target_id,
			$a_copy_id = `null`
	)

protected

Definition at line 109 of file class.ilObjBlog.php.

References $img, ilObjStyleSheet\_lookupStandard(), getBackgroundColor(), getFontColor(), ilObject2\getId(), getImage(), ilObjectFactory\getInstanceByObjId(), getNotesStatus(), getStyleSheetId(), hasApproval(), hasProfilePicture(), hasRSS(), initStorage(), setApproval(), setBackgroundColor(), setFontColor(), setImage(), setNotesStatus(), setProfilePicture(), setRSS(), setStyleSheetId(), and ilObject2\update().

         {
                 // banner?
                 $img = $this->getImage();
                 if($img)
                 {
                         $new_obj->setImage($img);
                         
                         $source = $this->initStorage($this->getId());
                         $target = $new_obj->initStorage($new_obj->getId());
                         
                         copy($source.$img, $target.$img);
                 }
                 
                 $new_obj->setNotesStatus($this->getNotesStatus());
                 $new_obj->setProfilePicture($this->hasProfilePicture());
                 $new_obj->setBackgroundColor($this->getBackgroundColor());
                 $new_obj->setFontColor($this->getFontColor());
                 $new_obj->setRSS($this->hasRSS());
                 $new_obj->setApproval($this->hasApproval());
                 $new_obj->update();             
                 
                 // set/copy stylesheet
                 include_once("./Services/Style/classes/class.ilObjStyleSheet.php");
                 $style_id = $this->getStyleSheetId();
                 if ($style_id > 0 && !ilObjStyleSheet::_lookupStandard($style_id))
                 {
                         $style_obj = ilObjectFactory::getInstanceByObjId($style_id);
                         $new_id = $style_obj->ilClone();
                         $new_obj->setStyleSheetId($new_id);
                         $new_obj->update();
                 }
         }

Here is the call graph for this function:

◆ doCreate()

ilObjBlog::doCreate ( )

protected

Definition at line 50 of file class.ilObjBlog.php.

         {
                 global $ilDB;
                 
                 $ilDB->manipulate("INSERT INTO il_blog (id,notes,ppic,rss_active,approval) VALUES (".
                         $ilDB->quote($this->id, "integer").",".
                         $ilDB->quote(true, "integer").",".
                         $ilDB->quote(true, "integer").",".
                         $ilDB->quote(true, "integer").",".
                         $ilDB->quote(false, "integer").")");
                 
                 /*
                 if ($this->getStyleSheetId() > 0)
                 {
                         include_once("./Services/Style/classes/class.ilObjStyleSheet.php");
                         ilObjStyleSheet::writeStyleUsage($this->id, $this->getStyleSheetId());
                 }                
                 */
         }

◆ doDelete()

ilObjBlog::doDelete ( )

protected

Definition at line 70 of file class.ilObjBlog.php.

References ilBlogPosting\deleteAllBlogPostings(), deleteImage(), ilNotification\removeForObject(), and ilNotification\TYPE_BLOG.

         {
                 global $ilDB;
                 
                 $this->deleteImage();
 
                 include_once "Modules/Blog/classes/class.ilBlogPosting.php";
                 ilBlogPosting::deleteAllBlogPostings($this->id);
                 
                 // remove all notifications
                 include_once "./Services/Notification/classes/class.ilNotification.php";
                 ilNotification::removeForObject(ilNotification::TYPE_BLOG, $this->id);
 
                 $ilDB->manipulate("DELETE FROM il_blog".
                         " WHERE id = ".$ilDB->quote($this->id, "integer"));
         }

Here is the call graph for this function:

◆ doRead()

ilObjBlog::doRead ( )

protected

Definition at line 31 of file class.ilObjBlog.php.

References $row, ilObjStyleSheet\lookupObjectStyle(), setApproval(), setBackgroundColor(), setFontColor(), setImage(), setNotesStatus(), setProfilePicture(), setRSS(), and setStyleSheetId().

         {
                 global $ilDB;
 
                 $set = $ilDB->query("SELECT * FROM il_blog".
                                 " WHERE id = ".$ilDB->quote($this->id, "integer"));
                 $row = $ilDB->fetchAssoc($set);
                 $this->setNotesStatus((bool)$row["notes"]);
                 $this->setProfilePicture((bool)$row["ppic"]);
                 $this->setBackgroundColor($row["bg_color"]);
                 $this->setFontColor($row["font_color"]);
                 $this->setImage($row["img"]);
                 $this->setRSS($row["rss_active"]);
                 $this->setApproval($row["approval"]);
                 
                 include_once("./Services/Style/classes/class.ilObjStyleSheet.php");
                 $this->setStyleSheetId(ilObjStyleSheet::lookupObjectStyle($this->id));
         }

Here is the call graph for this function:

◆ doUpdate()

ilObjBlog::doUpdate ( )

protected

Definition at line 87 of file class.ilObjBlog.php.

References getStyleSheetId(), and ilObjStyleSheet\writeStyleUsage().

         {
                 global $ilDB;
         
                 if($this->id)
                 {
                         $ilDB->manipulate("UPDATE il_blog".
                                         " SET notes = ".$ilDB->quote($this->getNotesStatus(), "integer").
                                         ",ppic = ".$ilDB->quote($this->hasProfilePicture(), "integer").
                                         ",bg_color = ".$ilDB->quote($this->getBackgroundColor(), "text").
                                         ",font_color = ".$ilDB->quote($this->getFontcolor(), "text").
                                         ",img = ".$ilDB->quote($this->getImage(), "text").
                                         ",rss_active = ".$ilDB->quote($this->hasRSS(), "integer").
                                         ",approval = ".$ilDB->quote($this->hasApproval(), "integer").
                                         " WHERE id = ".$ilDB->quote($this->id, "integer"));
                         
                         
                         include_once("./Services/Style/classes/class.ilObjStyleSheet.php");
                         ilObjStyleSheet::writeStyleUsage($this->id, $this->getStyleSheetId());
                 }
         }

Here is the call graph for this function:

◆ getBackgroundColor()

ilObjBlog::getBackgroundColor ( )

Get background color.

Returns: string

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

References $bg_color.

Referenced by doCloneObject().

         {
                 if(!$this->bg_color)
                 {
                         $this->bg_color = "ffffff";
                 }
                 return $this->bg_color;
         }

Here is the caller graph for this function:

◆ getFontColor()

ilObjBlog::getFontColor ( )

Get font color.

Returns: string

Definition at line 212 of file class.ilObjBlog.php.

References $font_color.

Referenced by doCloneObject().

         {
                 if(!$this->font_color)
                 {
                         $this->font_color = "505050";
                 }
                 return $this->font_color;
         }

Here is the caller graph for this function:

◆ getImage()

ilObjBlog::getImage ( )

Get banner image.

Returns: string

Definition at line 236 of file class.ilObjBlog.php.

References $img.

Referenced by doCloneObject().

         {
                 return $this->img;
         }

Here is the caller graph for this function:

◆ getImageFullPath()

ilObjBlog::getImageFullPath ( $a_as_thumb = false )

Get banner image incl.

path

Parameters

bool $a_as_thumb

Definition at line 256 of file class.ilObjBlog.php.

References $img, $path, and initStorage().

         {               
                 if($this->img)
                 {
                         $path = $this->initStorage($this->id);
                         if(!$a_as_thumb)
                         {
                                 return $path.$this->img;
                         }
                         else
                         {
                                 return $path."thb_".$this->img;
                         }
                 }
         }

Here is the call graph for this function:

◆ getLocalContributorRole()

ilObjBlog::getLocalContributorRole ( $a_node_id )

Get object id of local contributor role.

Parameters

int $a_node_id

Returns: int

Definition at line 632 of file class.ilObjBlog.php.

References ilObject\_lookupTitle().

Referenced by getRolesWithContribute().

         {
                 global $rbacreview;
                 
                 foreach($rbacreview->getLocalRoles($a_node_id) as $role_id)
                 {
                         if(substr(ilObject::_lookupTitle($role_id), 0, 19)  == "il_blog_contributor")
                         {
                                 return $role_id;
                         }
                 }
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getNotesStatus()

ilObjBlog::getNotesStatus ( )

Get notes status.

Returns: bool

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

References $notes.

Referenced by doCloneObject().

         {
                 return $this->notes;
         }

Here is the caller graph for this function:

◆ getRolesWithContribute()

ilObjBlog::getRolesWithContribute ( $a_node_id )

Definition at line 645 of file class.ilObjBlog.php.

References $res, ilRbacReview\_getOperationIdByName(), ilObjRole\_getTranslation(), and getLocalContributorRole().

         {
                 global $rbacreview;
                 
                 include_once "Services/AccessControl/classes/class.ilObjRole.php";
                 
                 $contr_op_id = ilRbacReview::_getOperationIdByName("contribute");
                 $contr_role_id = $this->getLocalContributorRole($a_node_id);
                 
                 $res = array();
                 foreach($rbacreview->getParentRoleIds($a_node_id) as $role_id => $role)
                 {                       
                         if($role_id != $contr_role_id &&
                                 in_array($contr_op_id, $rbacreview->getActiveOperationsOfRole($a_node_id, $role_id)))
                         {                               
                                 $res[$role_id] = ilObjRole:: _getTranslation($role["title"]);
                         }
                 }
         
                 return $res;
         }               

Here is the call graph for this function:

◆ getStyleSheetId()

ilObjBlog::getStyleSheetId ( )

Get style sheet id.

Returns: bool

Definition at line 410 of file class.ilObjBlog.php.

References $style.

Referenced by doCloneObject(), and doUpdate().

         {
                 return (int)$this->style;
         }

Here is the caller graph for this function:

◆ handleQuotaUpdate()

ilObjBlog::handleQuotaUpdate ( )

protected

Definition at line 667 of file class.ilObjBlog.php.

References ilUtil\dirsize(), ilObject2\getId(), ilObject2\getType(), ilDiskQuotaHandler\handleUpdatedSourceObject(), and initStorage().

Referenced by deleteImage(), and uploadImage().

         {                                                               
                 include_once "Services/DiskQuota/classes/class.ilDiskQuotaHandler.php";
                 ilDiskQuotaHandler::handleUpdatedSourceObject($this->getType(), 
                         $this->getId(),
                         ilUtil::dirsize($this->initStorage($this->getId())), 
                         array($this->getId())); 
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ hasApproval()

ilObjBlog::hasApproval ( )

Get approval status.

Returns: bool

Definition at line 390 of file class.ilObjBlog.php.

References $approval.

Referenced by doCloneObject().

         {
                 return (bool)$this->approval;
         }

Here is the caller graph for this function:

◆ hasProfilePicture()

ilObjBlog::hasProfilePicture ( )

Get profile picture status.

Returns: bool

Definition at line 168 of file class.ilObjBlog.php.

References $ppic.

Referenced by doCloneObject().

         {
                 return $this->ppic;
         }

Here is the caller graph for this function:

◆ hasRSS()

ilObjBlog::hasRSS ( )

Get RSS status.

Returns: bool

Definition at line 370 of file class.ilObjBlog.php.

References $rss.

Referenced by doCloneObject().

         {
                 return $this->rss;
         }

Here is the caller graph for this function:

◆ initDefaultRoles()

ilObjBlog::initDefaultRoles ( )

Definition at line 596 of file class.ilObjBlog.php.

References $res, ilObject2\createRoleFolder(), ilObject2\getId(), and ilObject2\getRefId().

         {
                 global $rbacadmin, $rbacreview, $ilDB;
 
                 // SET PERMISSION TEMPLATE OF NEW LOCAL CONTRIBUTOR ROLE
                 $set = $ilDB->query("SELECT obj_id FROM object_data ".
                         " WHERE type=".$ilDB->quote("rolt", "text").
                         " AND title=".$ilDB->quote("il_blog_contributor", "text"));
                 $res = $ilDB->fetchAssoc($set);
                 if($res["obj_id"])
                 {
                         $rolf_obj = $this->createRoleFolder();
 
                         // CREATE ADMIN ROLE
                         $role_obj = $rolf_obj->createRole("il_blog_contributor_".$this->getRefId(),
                                 "Contributor of blog obj_no.".$this->getId());
 
                         $rbacadmin->copyRoleTemplatePermissions($res["obj_id"], ROLE_FOLDER_ID, 
                                 $rolf_obj->getRefId(), $role_obj->getId());
 
                         // SET OBJECT PERMISSIONS OF BLOG OBJECT
                         $ops = $rbacreview->getOperationsOfRole($role_obj->getId(), "blog", $rolf_obj->getRefId());
                         $rbacadmin->grantPermission($role_obj->getId(), $ops, $this->getRefId());
                         
                         return true;
                 }
 
                 return false;
         }

Here is the call graph for this function:

◆ initStorage()

static ilObjBlog::initStorage	(	$a_id,
		$a_subdir = `null`
	)

static

Init file system storage.

Parameters

type	$a_id
type	$a_subdir

Returns: string

Definition at line 296 of file class.ilObjBlog.php.

References $path.

Referenced by doCloneObject(), getImageFullPath(), ilBlogDataSet\getXmlRecord(), handleQuotaUpdate(), ilBlogDataSet\importRecord(), and uploadImage().

         {               
                 include_once "Modules/Blog/classes/class.ilFSStorageBlog.php";
                 $storage = new ilFSStorageBlog($a_id);
                 $storage->create();
                 
                 $path = $storage->getAbsolutePath()."/";
                 
                 if($a_subdir)
                 {
                         $path .= $a_subdir."/";
                         
                         if(!is_dir($path))
                         {
                                 mkdir($path);
                         }
                 }
                                 
                 return $path;
         }

Here is the caller graph for this function:

◆ initType()

ilObjBlog::initType ( )

Definition at line 26 of file class.ilObjBlog.php.

         {
                 $this->type = "blog";
         }

◆ sendNotification()

static ilObjBlog::sendNotification	(	$a_action,
		$a_in_wsp,
		$a_blog_node_id,
		$a_posting_id,
		$a_comment = `null`
	)

static

Definition at line 425 of file class.ilObjBlog.php.

References $ilUser, ilObject\_lookupObjId(), ilNotification\getNotificationsForObject(), ilWorkspaceTree\lookupObjectId(), ilNotification\TYPE_BLOG, and ilNotification\updateNotificationTime().

Referenced by ilBlogPostingGUI\activatePage(), ilBlogPostingGUI\observeNoteAction(), and ilBlogPosting\update().

         {
                 global $ilUser;
                 
                 // get blog object id (repository or workspace)         
                 if($a_in_wsp)
                 {                               
                         include_once "Services/PersonalWorkspace/classes/class.ilWorkspaceTree.php";
                         include_once "Services/PersonalWorkspace/classes/class.ilWorkspaceAccessHandler.php";
                         $tree = new ilWorkspaceTree($ilUser->getId()); // owner of tree is irrelevant
                         $blog_obj_id = $tree->lookupObjectId($a_blog_node_id);                                                  
                         $access_handler = new ilWorkspaceAccessHandler($tree);  
                 }
                 else
                 {
                         $blog_obj_id = ilObject::_lookupObjId($a_blog_node_id);
                         $access_handler = null;
                 }
                 if(!$blog_obj_id)
                 {
                         return;
                 }       
                                 
                 include_once "./Modules/Blog/classes/class.ilBlogPosting.php";
                 $posting = new ilBlogPosting($a_posting_id);
                                                                 
                 // #11138
                 $ignore_threshold = ($a_action == "comment");           
                 
                 // approval handling    
                 $admin_only = false;    
                 if(!$posting->isApproved())
                 {                       
                         $blog = new self($blog_obj_id, false);
                         if($blog->hasApproval())
                         {                                                                               
                                 switch($a_action)
                                 {
                                         case "update":
                                                 // un-approved posting was updated - no notifications                                   
                                                 return;
 
                                         case "new":
                                                 // un-approved posting was activated - admin-only notification                                  
                                                 $admin_only = true;     
                                                 $ignore_threshold = true;
                                                 break;                          
                                 }
                         }
                 }
                 
                 // recipients
                 include_once "./Services/Notification/classes/class.ilNotification.php";                
                 $users = ilNotification::getNotificationsForObject(ilNotification::TYPE_BLOG, 
                         $blog_obj_id, $a_posting_id, $ignore_threshold);                
                 if(!sizeof($users))
                 {
                         return;
                 }                               
                                                                 
                 include_once "./Services/Notification/classes/class.ilSystemNotification.php";
                 $ntf = new ilSystemNotification($a_in_wsp);             
                 $ntf->setLangModules(array("blog"));
                 $ntf->setRefId($a_blog_node_id);
                 $ntf->setChangedByUserId($ilUser->getId());
                 $ntf->setSubjectLangId('blog_change_notification_subject');
                 $ntf->setIntroductionLangId('blog_change_notification_body_'.$a_action);
                 $ntf->addAdditionalInfo('blog_posting', $posting->getTitle());
                 if($a_comment)
                 {
                         $ntf->addAdditionalInfo('comment', $a_comment, true);
                 }       
                 $ntf->setGotoLangId('blog_change_notification_link');                           
                 $ntf->setReasonLangId('blog_change_notification_reason');                               
                                 
                 $notified = $ntf->sendMail($users, "_".$a_posting_id, 
                         ($admin_only ? "write" : "read"));                                                              
 
                 // #14387
                 if(sizeof($notified))
                 {
                         ilNotification::updateNotificationTime(ilNotification::TYPE_BLOG, $blog_obj_id, $notified, $a_posting_id);                              
                 }
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setApproval()

ilObjBlog::setApproval ( $a_status )

Toggle approval status.

Parameters

bool $a_status

Definition at line 400 of file class.ilObjBlog.php.

Referenced by doCloneObject(), and doRead().

         {
                 $this->approval = (bool)$a_status;
         }

Here is the caller graph for this function:

◆ setBackgroundColor()

ilObjBlog::setBackgroundColor ( $a_value )

Set background color.

Parameters

string $a_value

Definition at line 202 of file class.ilObjBlog.php.

Referenced by doCloneObject(), and doRead().

         {
                 $this->bg_color = (string)$a_value;
         }

Here is the caller graph for this function:

◆ setFontColor()

ilObjBlog::setFontColor ( $a_value )

Set font color.

Parameters

string $a_value

Definition at line 226 of file class.ilObjBlog.php.

Referenced by doCloneObject(), and doRead().

         {               
                 $this->font_color = (string)$a_value;
         }

Here is the caller graph for this function:

◆ setImage()

ilObjBlog::setImage ( $a_value )

Set banner image.

Parameters

string $a_value

Definition at line 246 of file class.ilObjBlog.php.

Referenced by deleteImage(), doCloneObject(), doRead(), and uploadImage().

         {               
                 $this->img = (string)$a_value;
         }

Here is the caller graph for this function:

◆ setNotesStatus()

ilObjBlog::setNotesStatus ( $a_status )

Toggle notes status.

Parameters

bool $a_status

Definition at line 158 of file class.ilObjBlog.php.

Referenced by doCloneObject(), and doRead().

         {
                 $this->notes = (bool)$a_status;
         }

Here is the caller graph for this function:

◆ setProfilePicture()

ilObjBlog::setProfilePicture ( $a_status )

Toggle profile picture status.

Parameters

bool $a_status

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

Referenced by doCloneObject(), and doRead().

         {
                 $this->ppic = (bool)$a_status;
         }

Here is the caller graph for this function:

◆ setRSS()

ilObjBlog::setRSS ( $a_status )

Toggle RSS status.

Parameters

bool $a_status

Definition at line 380 of file class.ilObjBlog.php.

Referenced by doCloneObject(), and doRead().

         {
                 $this->rss = (bool)$a_status;
         }

Here is the caller graph for this function:

◆ setStyleSheetId()

ilObjBlog::setStyleSheetId ( $a_style )

Set style sheet id.

Parameters

int $a_style

Definition at line 420 of file class.ilObjBlog.php.

Referenced by doCloneObject(), and doRead().

         {
                 $this->style = (int)$a_style;
         }

Here is the caller graph for this function:

◆ uploadImage()

ilObjBlog::uploadImage ( array $a_upload )

Upload new image file.

Parameters

array $a_upload

Returns: bool

Definition at line 323 of file class.ilObjBlog.php.

References $path, deleteImage(), ilUtil\escapeShellArg(), ilUtil\execConvert(), handleQuotaUpdate(), initStorage(), and setImage().

         {
                 if(!$this->id)
                 {
                         return false;
                 }
                 
                 $this->deleteImage();
                 
                 // #10074
                 $clean_name = preg_replace("/[^a-zA-Z0-9\_\.\-]/", "", $a_upload["name"]);
         
                 $path = $this->initStorage($this->id);
                 $original = "org_".$this->id."_".$clean_name;
                 $thumb = "thb_".$this->id."_".$clean_name;
                 $processed = $this->id."_".$clean_name;
                 
                 if(@move_uploaded_file($a_upload["tmp_name"], $path.$original))
                 {
                         chmod($path.$original, 0770);
 
                         $blga_set = new ilSetting("blga");      
                         $dimensions = $blga_set->get("banner_width")."x".
                                 $blga_set->get("banner_height");
                         
                         // take quality 100 to avoid jpeg artefacts when uploading jpeg files
                         // taking only frame [0] to avoid problems with animated gifs
                         $original_file = ilUtil::escapeShellArg($path.$original);
                         $thumb_file = ilUtil::escapeShellArg($path.$thumb);
                         $processed_file = ilUtil::escapeShellArg($path.$processed);
                         ilUtil::execConvert($original_file."[0] -geometry 100x100 -quality 100 JPEG:".$thumb_file);
                         ilUtil::execConvert($original_file."[0] -geometry ".$dimensions."! -quality 100 JPEG:".$processed_file);
                         
                         $this->setImage($processed);
                         
                         $this->handleQuotaUpdate();
                         
                         return true;
                 }
                 return false;
         }       

Here is the call graph for this function:

Field Documentation

◆ $approval

ilObjBlog::$approval

protected

Definition at line 23 of file class.ilObjBlog.php.

Referenced by hasApproval().

◆ $bg_color

ilObjBlog::$bg_color

protected

Definition at line 18 of file class.ilObjBlog.php.

Referenced by getBackgroundColor().

◆ $font_color

ilObjBlog::$font_color

protected

Definition at line 19 of file class.ilObjBlog.php.

Referenced by getFontColor().

◆ $img

ilObjBlog::$img

protected

Definition at line 20 of file class.ilObjBlog.php.

Referenced by doCloneObject(), getImage(), and getImageFullPath().

◆ $notes

ilObjBlog::$notes

protected

Definition at line 17 of file class.ilObjBlog.php.

Referenced by getNotesStatus().

◆ $ppic

ilObjBlog::$ppic

protected

Definition at line 21 of file class.ilObjBlog.php.

Referenced by hasProfilePicture().

◆ $rss

ilObjBlog::$rss

protected

Definition at line 22 of file class.ilObjBlog.php.

Referenced by hasRSS().

◆ $style

ilObjBlog::$style

protected

Definition at line 24 of file class.ilObjBlog.php.

Referenced by getStyleSheetId().

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

Modules/Blog/classes/class.ilObjBlog.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ deleteImage()

◆ deliverRSS()

◆ doCloneObject()

◆ doCreate()

◆ doDelete()

◆ doRead()

◆ doUpdate()

◆ getBackgroundColor()

◆ getFontColor()

◆ getImage()

◆ getImageFullPath()

◆ getLocalContributorRole()

◆ getNotesStatus()

◆ getRolesWithContribute()

◆ getStyleSheetId()

◆ handleQuotaUpdate()

◆ hasApproval()

◆ hasProfilePicture()

◆ hasRSS()

◆ initDefaultRoles()

◆ initStorage()

◆ initType()

◆ sendNotification()

◆ setApproval()

◆ setBackgroundColor()

◆ setFontColor()

◆ setImage()

◆ setNotesStatus()

◆ setProfilePicture()

◆ setRSS()

◆ setStyleSheetId()

◆ uploadImage()

Field Documentation

◆ $approval

◆ $bg_color

◆ $font_color

◆ $img

◆ $notes

◆ $ppic

◆ $rss

◆ $style