ILIAS  Release_5_0_x_branch Revision 61816
 All Data Structures Namespaces Files Functions Variables Groups Pages
Public Member Functions | Static Public Member Functions | Data Fields | Protected Member Functions | Protected Attributes
ilObjBlog Class Reference

Class ilObjBlog. More...

+ Inheritance diagram for ilObjBlog:
+ Collaboration diagram for ilObjBlog:

Public Member Functions

 initType ()
 getNotesStatus ()
 Get notes status.
 setNotesStatus ($a_status)
 Toggle notes status.
 hasProfilePicture ()
 Get profile picture status.
 setProfilePicture ($a_status)
 Toggle profile picture status.
 getBackgroundColor ()
 Get background color.
 setBackgroundColor ($a_value)
 Set background color.
 getFontColor ()
 Get font color.
 setFontColor ($a_value)
 Set font color.
 getImage ()
 Get banner image.
 setImage ($a_value)
 Set banner image.
 getImageFullPath ($a_as_thumb=false)
 Get banner image incl.
 deleteImage ()
 remove existing file
 uploadImage (array $a_upload)
 Upload new image file.
 hasRSS ()
 Get RSS status.
 setRSS ($a_status)
 Toggle RSS status.
 hasApproval ()
 Get approval status.
 setApproval ($a_status)
 Toggle approval status.
 getStyleSheetId ()
 Get style sheet id.
 setStyleSheetId ($a_style)
 Set style sheet id.
 hasAbstractShorten ()
 setAbstractShorten ($a_value)
 getAbstractShortenLength ()
 setAbstractShortenLength ($a_value)
 hasAbstractImage ()
 setAbstractImage ($a_value)
 getAbstractImageWidth ()
 setAbstractImageWidth ($a_value)
 getAbstractImageHeight ()
 setAbstractImageHeight ($a_value)
 setKeywords ($a_value)
 hasKeywords ()
 setAuthors ($a_value)
 hasAuthors ()
 setNavMode ($a_value)
 getNavMode ()
 setNavModeListPostings ($a_value)
 getNavModeListPostings ()
 setNavModeListMonths ($a_value)
 getNavModeListMonths ()
 setOverviewPostings ($a_value)
 getOverviewPostings ()
 setOrder (array $a_values=null)
 getOrder ()
 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
 getLocalContributorRole ($a_node_id)
 Get object id of local contributor role.
 getRolesWithContribute ($a_node_id)
- Public Member Functions inherited from ilObject2
 __construct ($a_id=0, $a_reference=true)
 Constructor public.
 withReferences ()
 determines wehter objects are referenced or not (got ref ids or not)
 read ($a_force_db=false)
 Read data from db.
 getId ()
 get object id public
 setId ($a_id)
 set object id public
 setRefId ($a_id)
 set reference id public
 getRefId ()
 get reference id public
 getType ()
 get object type public
 setType ($a_type)
 set object type public
 getPresentationTitle ()
 get presentation title Normally same as title Overwritten for sessions
 getTitle ()
 get object title public
 getUntranslatedTitle ()
 get untranslated object title public
 setTitle ($a_title)
 set object title
 getDescription ()
 get object description
 setDescription ($a_desc)
 set object description
 getLongDescription ()
 get object long description (stored in object_description)
 getImportId ()
 get import id
 setImportId ($a_import_id)
 set import id
 getOwner ()
 get object owner
 getOwnerName ()
 _lookupOwnerName ($a_owner_id)
 lookup owner name for owner id
 setOwner ($a_owner)
 set object owner
 getCreateDate ()
 get create date public
 getLastUpdateDate ()
 get last update date public
 setObjDataRecord ($a_record)
 set object_data record (note: this method should only be called from the ilObjectFactory class)
 create ($a_clone_mode=false)
 update ()
 update object in db
 MDUpdateListener ($a_element)
 Meta data update listener.
 createMetaData ()
 create meta data entry
 updateMetaData ()
 update meta data entry
 deleteMetaData ()
 delete meta data entry
 updateOwner ()
 update owner of object in db
 _getIdForImportId ($a_import_id)
 get current object id for import id (static)
 _lookupOwner ($a_id)
 lookup object owner
 _lookupLastUpdate ($a_id, $a_as_string=false)
 lookup last update
 _getLastUpdateOfObjects ($a_objs)
 Get last update for a set of media objects.
 _setDeletedDate ($a_ref_id)
 only called in ilTree::saveSubTree
 _resetDeletedDate ($a_ref_id)
 only called in ilObjectGUI::insertSavedNodes
 _lookupDeletedDate ($a_ref_id)
 only called in ilObjectGUI::insertSavedNodes
 _writeTitle ($a_obj_id, $a_title)
 write title to db (static)
 _writeDescription ($a_obj_id, $a_desc)
 write description to db (static)
 _writeImportId ($a_obj_id, $a_import_id)
 write import id to db (static)
 _isInTrash ($a_ref_id)
 checks wether object is in trash
 _hasUntrashedReference ($a_obj_id)
 checks wether an object has at least one reference that is not in trash
 _getObjectsDataForType ($a_type, $a_omit_trash=false)
 get all objects of a certain type
 putInTree ($a_parent_ref)
 maybe this method should be in tree object!?
 setPermissions ($a_parent_ref)
 set permissions of object
 createReference ()
 creates reference for object
 countReferences ()
 count references of object
 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!!
 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.
 setRegisterMode ($a_bool)
 isUserRegistered ($a_user_id=0)
 requireRegistration ()
 appendCopyInfo ($a_target_id, $a_copy_id)
 Prepend Copy info if object with same name exists in that container.
 cloneMetaData ($target_obj)
 Copy meta data.
 cloneObject ($a_target_id, $a_copy_id=null, $a_omit_tree=false)
 Clone object permissions, put in tree ...
 cloneDependencies ($a_target_id, $a_copy_id)
 Clone object dependencies.
- Public Member Functions inherited from ilObject
 ilObject ($a_id=0, $a_reference=true)
 Constructor public.
 getDiskUsage ()
 Gets the disk usage of the object in bytes.
 create ()
 create
 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.
 applyDidacticTemplate ($a_tpl_id)
 Apply template.
 getXMLZip ()
 getHTMLDirectory ()
 _lookupCreationDate ($a_id)
 Lookup creation date.

Static Public Member Functions

static initStorage ($a_id, $a_subdir=null)
 Init file system storage.
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.
- Static Public Member Functions inherited from ilObject2
static _lookupObjIdByImportId ($a_import_id)
static _getAllReferences ($a_id)
 get all reference ids of object
static _lookupTitle ($a_id)
 lookup object title
static _getIdsForTitle ($title, $type= '', $partialmatch=false)
static _lookupDescription ($a_id)
 lookup object description
static _lookupObjId ($a_id)
static _lookupType ($a_id, $a_reference=false)
 lookup object type
static _lookupObjectId ($a_ref_id)
 lookup object id
static _exists ($a_id, $a_reference=false)
static _getObjectsByType ($a_obj_type="", $a_owner="")
 Get objects by type.
static _prepareCloneSelection ($a_ref_ids, $new_type)
static _getIcon ($a_obj_id="", $a_size="big", $a_type="", $a_offline=false)
 Get icon for repository item.
- Static Public Member Functions inherited from ilObject
static setDeletedDates ($a_ref_ids)
 Set deleted date type $ilDB.
static _exists ($a_id, $a_reference=false, $a_type=null)
 checks if an object exists in object_data
static _prepareCloneSelection ($a_ref_ids, $new_type, $show_path=true)
 Prepare copy wizard object selection.
static collectDeletionDependencies (&$deps, $a_ref_id, $a_obj_id, $a_type, $a_depth=0)
 Collect deletion dependencies.
static getDeletionDependencies ($a_obj_id)
 Get deletion dependencies.
static getLongDescriptions (array $a_obj_ids)
 Get long description data.
static getAllOwnedRepositoryObjects ($a_user_id)
 Get all ids of objects user owns.
static hasAutoRating ($a_type, $a_ref_id)
 Check if auto rating is active for parent group/course.

Data Fields

const NAV_MODE_LIST = 1
const NAV_MODE_MONTH = 2
const ABSTRACT_DEFAULT_SHORTEN_LENGTH = 500
const ABSTRACT_DEFAULT_IMAGE_WIDTH = 144
const ABSTRACT_DEFAULT_IMAGE_HEIGHT = 144
const NAV_MODE_LIST_DEFAULT_POSTINGS = 10

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
 beforeCreate ()
 beforeUpdate ()
 doMDUpdateListener ($a_element)
 beforeMDUpdateListener ($a_element)
 doCreateMetaData ()
 beforeCreateMetaData ()
 doUpdateMetaData ()
 beforeUpdateMetaData ()
 beforeDelete ()
 doCloneObject ($new_obj, $a_target_id, $a_copy_id=null)
 beforeCloneObject ()

Protected Attributes

 $notes
 $bg_color
 $font_color
 $img
 $ppic
 $rss
 $approval
 $style
 $abstract_shorten = false
 $abstract_shorten_length = self::ABSTRACT_DEFAULT_SHORTEN_LENGTH
 $abstract_image = false
 $abstract_image_width = self::ABSTRACT_DEFAULT_IMAGE_WIDTH
 $abstract_image_height = self::ABSTRACT_DEFAULT_IMAGE_HEIGHT
 $keywords = true
 $nav_mode = self::NAV_MODE_LIST
 $nav_mode_list_postings = self::NAV_MODE_LIST_DEFAULT_POSTINGS
 $nav_mode_list_months
 $overview_postings
 $authors = true
 $order

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

ilObjBlog::deleteImage ( )

remove existing file

Definition at line 347 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:

static ilObjBlog::deliverRSS (   $a_wsp_id)
static

Deliver blog as rss feed.

Parameters
int$a_wsp_id

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

References ilObject\$id, $ilSetting, $tpl, ilLink\_getStaticLink(), ilPageObject\_lookupActive(), ilObject2\_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("&", "&", $url);
// #11870
$feed->setChannelTitle(str_replace("&", "&", $blog->getTitle()));
$feed->setChannelDescription(str_replace("&", "&", $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;
}
// #16434
$snippet = strip_tags(ilBlogPostingGUI::getSnippet($id), "<br><br/><div><p>");
$snippet = str_replace("&", "&amp;", $snippet);
$snippet = "<![CDATA[".$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:

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

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

References $img, ilObjStyleSheet\_lookupStandard(), getAbstractImageHeight(), getAbstractImageWidth(), getAbstractShortenLength(), getBackgroundColor(), getFontColor(), ilObject2\getId(), getImage(), ilObjectFactory\getInstanceByObjId(), getNotesStatus(), getStyleSheetId(), hasAbstractImage(), hasAbstractShorten(), hasApproval(), hasProfilePicture(), hasRSS(), initStorage(), setAbstractImage(), setAbstractImageHeight(), setAbstractImageWidth(), setAbstractShorten(), setAbstractShortenLength(), 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->setAbstractShorten($this->hasAbstractShorten());
$new_obj->setAbstractShortenLength($this->getAbstractShortenLength());
$new_obj->setAbstractImage($this->hasAbstractImage());
$new_obj->setAbstractImageWidth($this->getAbstractImageWidth());
$new_obj->setAbstractImageHeight($this->getAbstractImageHeight());
$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:

ilObjBlog::doCreate ( )
protected

Reimplemented from ilObject2.

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

References $ilDB, ilNote\activateComments(), getAbstractImageHeight(), getAbstractImageWidth(), getAbstractShortenLength(), getNavMode(), getNavModeListPostings(), hasAbstractImage(), hasAbstractShorten(), hasAuthors(), and hasKeywords().

{
global $ilDB;
$ilDB->manipulate("INSERT INTO il_blog (id,ppic,rss_active,approval".
",abs_shorten,abs_shorten_len,abs_image,abs_img_width,abs_img_height".
",keywords,authors,nav_mode,nav_list_post) VALUES (".
$ilDB->quote($this->id, "integer").",".
$ilDB->quote(true, "integer").",".
$ilDB->quote(true, "integer").",".
$ilDB->quote(false, "integer").",".
$ilDB->quote($this->hasAbstractShorten(), "integer").",".
$ilDB->quote($this->getAbstractShortenLength(), "integer").",".
$ilDB->quote($this->hasAbstractImage(), "integer").",".
$ilDB->quote($this->getAbstractImageWidth(), "integer").",".
$ilDB->quote($this->getAbstractImageHeight(), "integer").",".
$ilDB->quote($this->hasKeywords(), "integer").",".
$ilDB->quote($this->hasAuthors(), "integer").",".
$ilDB->quote($this->getNavMode(), "integer").",".
$ilDB->quote($this->getNavModeListPostings(), "integer").
")");
// #14661
include_once("./Services/Notes/classes/class.ilNote.php");
ilNote::activateComments($this->id, 0, "blog", true);
/*
if ($this->getStyleSheetId() > 0)
{
include_once("./Services/Style/classes/class.ilObjStyleSheet.php");
ilObjStyleSheet::writeStyleUsage($this->id, $this->getStyleSheetId());
}
*/
}

+ Here is the call graph for this function:

ilObjBlog::doDelete ( )
protected

Reimplemented from ilObject2.

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

References $ilDB, 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:

ilObjBlog::doRead ( )
protected

Reimplemented from ilObject2.

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

References $ilDB, $row, ilNote\commentsActivated(), ilObjStyleSheet\lookupObjectStyle(), setAbstractImage(), setAbstractImageHeight(), setAbstractImageWidth(), setAbstractShorten(), setAbstractShortenLength(), setApproval(), setAuthors(), setBackgroundColor(), setFontColor(), setImage(), setKeywords(), setNavMode(), setNavModeListMonths(), setNavModeListPostings(), setNotesStatus(), setOrder(), setOverviewPostings(), 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->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"]);
$this->setAbstractShorten($row["abs_shorten"]);
$this->setAbstractShortenLength($row["abs_shorten_len"]);
$this->setAbstractImage($row["abs_image"]);
$this->setAbstractImageWidth($row["abs_img_width"]);
$this->setAbstractImageHeight($row["abs_img_height"]);
$this->setKeywords($row["keywords"]);
$this->setAuthors($row["authors"]);
$this->setNavMode($row["nav_mode"]);
$this->setNavModeListPostings($row["nav_list_post"]);
$this->setNavModeListMonths($row["nav_list_mon"]);
$this->setOverviewPostings($row["ov_post"]);
if(trim($row["nav_order"]))
{
$this->setOrder(explode(";", $row["nav_order"]));
}
// #14661
include_once("./Services/Notes/classes/class.ilNote.php");
$this->setNotesStatus(ilNote::commentsActivated($this->id, 0, "blog"));
include_once("./Services/Style/classes/class.ilObjStyleSheet.php");
$this->setStyleSheetId(ilObjStyleSheet::lookupObjectStyle($this->id));
}

+ Here is the call graph for this function:

ilObjBlog::doUpdate ( )
protected

Reimplemented from ilObject2.

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

References $ilDB, ilNote\activateComments(), getNotesStatus(), getOrder(), getStyleSheetId(), and ilObjStyleSheet\writeStyleUsage().

{
global $ilDB;
if($this->id)
{
$ilDB->manipulate("UPDATE il_blog".
" SET 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").
",abs_shorten = ".$ilDB->quote($this->hasAbstractShorten(), "integer").
",abs_shorten_len = ".$ilDB->quote($this->getAbstractShortenLength(), "integer").
",abs_image = ".$ilDB->quote($this->hasAbstractImage(), "integer").
",abs_img_width = ".$ilDB->quote($this->getAbstractImageWidth(), "integer").
",abs_img_height = ".$ilDB->quote($this->getAbstractImageHeight(), "integer").
",keywords = ".$ilDB->quote($this->hasKeywords(), "integer").
",authors = ".$ilDB->quote($this->hasAuthors(), "integer").
",nav_mode = ".$ilDB->quote($this->getNavMode(), "integer").
",nav_list_post = ".$ilDB->quote($this->getNavModeListPostings(), "integer").
",nav_list_mon = ".$ilDB->quote($this->getNavModeListMonths(), "integer").
",ov_post = ".$ilDB->quote($this->getOverviewPostings(), "integer").
",nav_order = ".$ilDB->quote(implode(";", $this->getOrder()), "text").
" WHERE id = ".$ilDB->quote($this->id, "integer"));
// #14661
include_once("./Services/Notes/classes/class.ilNote.php");
ilNote::activateComments($this->id, 0, "blog", $this->getNotesStatus());
include_once("./Services/Style/classes/class.ilObjStyleSheet.php");
ilObjStyleSheet::writeStyleUsage($this->id, $this->getStyleSheetId());
}
}

+ Here is the call graph for this function:

ilObjBlog::getAbstractImageHeight ( )

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

References $abstract_image_height.

Referenced by doCloneObject(), and doCreate().

{
return $this->abstract_image_height;
}

+ Here is the caller graph for this function:

ilObjBlog::getAbstractImageWidth ( )

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

References $abstract_image_width.

Referenced by doCloneObject(), and doCreate().

{
return $this->abstract_image_width;
}

+ Here is the caller graph for this function:

ilObjBlog::getAbstractShortenLength ( )

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

References $abstract_shorten_length.

Referenced by doCloneObject(), and doCreate().

{
return $this->abstract_shorten_length;
}

+ Here is the caller graph for this function:

ilObjBlog::getBackgroundColor ( )

Get background color.

Returns
string

Definition at line 260 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:

ilObjBlog::getFontColor ( )

Get font color.

Returns
string

Definition at line 284 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:

ilObjBlog::getImage ( )

Get banner image.

Returns
string

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

References $img.

Referenced by doCloneObject().

{
return $this->img;
}

+ Here is the caller graph for this function:

ilObjBlog::getImageFullPath (   $a_as_thumb = false)

Get banner image incl.

path

Parameters
bool$a_as_thumb

Definition at line 328 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:

ilObjBlog::getLocalContributorRole (   $a_node_id)

Get object id of local contributor role.

Parameters
int$a_node_id
Returns
int

Definition at line 840 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:

ilObjBlog::getNavMode ( )

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

References $nav_mode.

Referenced by doCreate().

{
return $this->nav_mode;
}

+ Here is the caller graph for this function:

ilObjBlog::getNavModeListMonths ( )

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

References $nav_mode_list_months.

{
return $this->nav_mode_list_months;
}
ilObjBlog::getNavModeListPostings ( )

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

References $nav_mode_list_postings.

Referenced by doCreate().

{
return $this->nav_mode_list_postings;
}

+ Here is the caller graph for this function:

ilObjBlog::getNotesStatus ( )

Get notes status.

Returns
bool

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

References $notes.

Referenced by doCloneObject(), and doUpdate().

{
return $this->notes;
}

+ Here is the caller graph for this function:

ilObjBlog::getOrder ( )

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

References $order.

Referenced by doUpdate().

{
return (array)$this->order;
}

+ Here is the caller graph for this function:

ilObjBlog::getOverviewPostings ( )

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

References $overview_postings.

{
return $this->overview_postings;
}
ilObjBlog::getRolesWithContribute (   $a_node_id)

Definition at line 853 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:

ilObjBlog::getStyleSheetId ( )

Get style sheet id.

Returns
bool

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

References $style.

Referenced by doCloneObject(), and doUpdate().

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

+ Here is the caller graph for this function:

ilObjBlog::handleQuotaUpdate ( )
protected

Definition at line 875 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:

ilObjBlog::hasAbstractImage ( )

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

References $abstract_image.

Referenced by doCloneObject(), and doCreate().

{
return $this->abstract_image;
}

+ Here is the caller graph for this function:

ilObjBlog::hasAbstractShorten ( )

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

References $abstract_shorten.

Referenced by doCloneObject(), and doCreate().

{
return $this->abstract_shorten;
}

+ Here is the caller graph for this function:

ilObjBlog::hasApproval ( )

Get approval status.

Returns
bool

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

References $approval.

Referenced by doCloneObject().

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

+ Here is the caller graph for this function:

ilObjBlog::hasAuthors ( )

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

References $authors.

Referenced by doCreate().

{
return $this->authors;
}

+ Here is the caller graph for this function:

ilObjBlog::hasKeywords ( )

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

References $keywords.

Referenced by doCreate().

{
return $this->keywords;
}

+ Here is the caller graph for this function:

ilObjBlog::hasProfilePicture ( )

Get profile picture status.

Returns
bool

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

References $ppic.

Referenced by doCloneObject().

{
return $this->ppic;
}

+ Here is the caller graph for this function:

ilObjBlog::hasRSS ( )

Get RSS status.

Returns
bool

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

References $rss.

Referenced by doCloneObject().

{
return $this->rss;
}

+ Here is the caller graph for this function:

ilObjBlog::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

Returns
array empty array

Reimplemented from ilObject2.

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

References ilObjRole\createDefaultRole(), ilObject2\getId(), and ilObject2\getRefId().

{
include_once './Services/AccessControl/classes/class.ilObjRole.php';
$role = ilObjRole::createDefaultRole(
'il_blog_contributor_'.$this->getRefId(),
"Contributor of blog obj_no.".$this->getId(),
'il_blog_contributor',
$this->getRefId()
);
return array();
}

+ Here is the call graph for this function:

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 368 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:

ilObjBlog::initType ( )

Reimplemented from ilObject2.

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

{
$this->type = "blog";
}
static ilObjBlog::sendNotification (   $a_action,
  $a_in_wsp,
  $a_blog_node_id,
  $a_posting_id,
  $a_comment = null 
)
static

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

References $ilUser, ilObject2\_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");
$admin_only = false;
// approval handling
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;
$a_action = "approve";
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');
$abstract = $posting->getNotificationAbstract();
if($abstract)
{
$ntf->addAdditionalInfo('content', $abstract, true);
}
$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:

ilObjBlog::setAbstractImage (   $a_value)

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

Referenced by doCloneObject(), and doRead().

{
$this->abstract_image = (bool)$a_value;
}

+ Here is the caller graph for this function:

ilObjBlog::setAbstractImageHeight (   $a_value)

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

Referenced by doCloneObject(), and doRead().

{
$this->abstract_image_height = (int)$a_value;
}

+ Here is the caller graph for this function:

ilObjBlog::setAbstractImageWidth (   $a_value)

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

Referenced by doCloneObject(), and doRead().

{
$this->abstract_image_width = (int)$a_value;
}

+ Here is the caller graph for this function:

ilObjBlog::setAbstractShorten (   $a_value)

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

Referenced by doCloneObject(), and doRead().

{
$this->abstract_shorten = (bool)$a_value;
}

+ Here is the caller graph for this function:

ilObjBlog::setAbstractShortenLength (   $a_value)

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

Referenced by doCloneObject(), and doRead().

{
$this->abstract_shorten_length = (int)$a_value;
}

+ Here is the caller graph for this function:

ilObjBlog::setApproval (   $a_status)

Toggle approval status.

Parameters
bool$a_status

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

Referenced by doCloneObject(), and doRead().

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

+ Here is the caller graph for this function:

ilObjBlog::setAuthors (   $a_value)

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

Referenced by doRead().

{
$this->authors = (bool)$a_value;
}

+ Here is the caller graph for this function:

ilObjBlog::setBackgroundColor (   $a_value)

Set background color.

Parameters
string$a_value

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

Referenced by doCloneObject(), and doRead().

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

+ Here is the caller graph for this function:

ilObjBlog::setFontColor (   $a_value)

Set font color.

Parameters
string$a_value

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

Referenced by doCloneObject(), and doRead().

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

+ Here is the caller graph for this function:

ilObjBlog::setImage (   $a_value)

Set banner image.

Parameters
string$a_value

Definition at line 318 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:

ilObjBlog::setKeywords (   $a_value)

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

Referenced by doRead().

{
$this->keywords = (bool)$a_value;
}

+ Here is the caller graph for this function:

ilObjBlog::setNavMode (   $a_value)

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

Referenced by doRead().

{
$a_value = (int)$a_value;
if(in_array($a_value, array(self::NAV_MODE_LIST, self::NAV_MODE_MONTH)))
{
$this->nav_mode = $a_value;
}
}

+ Here is the caller graph for this function:

ilObjBlog::setNavModeListMonths (   $a_value)

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

Referenced by doRead().

{
if(!$a_value)
{
$a_value = null;
}
else
{
$a_value = (int)$a_value;
}
$this->nav_mode_list_months = $a_value;
}

+ Here is the caller graph for this function:

ilObjBlog::setNavModeListPostings (   $a_value)

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

Referenced by doRead().

{
$this->nav_mode_list_postings = (int)$a_value;
}

+ Here is the caller graph for this function:

ilObjBlog::setNotesStatus (   $a_status)

Toggle notes status.

Parameters
bool$a_status

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

Referenced by doCloneObject(), and doRead().

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

+ Here is the caller graph for this function:

ilObjBlog::setOrder ( array  $a_values = null)

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

Referenced by doRead().

{
$this->order = $a_values;
}

+ Here is the caller graph for this function:

ilObjBlog::setOverviewPostings (   $a_value)

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

Referenced by doRead().

{
if(!$a_value)
{
$a_value = null;
}
else
{
$a_value = (int)$a_value;
}
$this->overview_postings = $a_value;
}

+ Here is the caller graph for this function:

ilObjBlog::setProfilePicture (   $a_status)

Toggle profile picture status.

Parameters
bool$a_status

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

Referenced by doCloneObject(), and doRead().

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

+ Here is the caller graph for this function:

ilObjBlog::setRSS (   $a_status)

Toggle RSS status.

Parameters
bool$a_status

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

Referenced by doCloneObject(), and doRead().

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

+ Here is the caller graph for this function:

ilObjBlog::setStyleSheetId (   $a_style)

Set style sheet id.

Parameters
int$a_style

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

Referenced by doCloneObject(), and doRead().

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

+ Here is the caller graph for this function:

ilObjBlog::uploadImage ( array  $a_upload)

Upload new image file.

Parameters
array$a_upload
Returns
bool

Definition at line 395 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");
/* as banner height should overflow, we only handle width
$dimensions = $blga_set->get("banner_width")."x".
$blga_set->get("banner_height");
*/
$dimensions = $blga_set->get("banner_width");
// 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

ilObjBlog::$abstract_image = false
protected

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

Referenced by hasAbstractImage().

ilObjBlog::$abstract_image_height = self::ABSTRACT_DEFAULT_IMAGE_HEIGHT
protected

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

Referenced by getAbstractImageHeight().

ilObjBlog::$abstract_image_width = self::ABSTRACT_DEFAULT_IMAGE_WIDTH
protected

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

Referenced by getAbstractImageWidth().

ilObjBlog::$abstract_shorten = false
protected

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

Referenced by hasAbstractShorten().

ilObjBlog::$abstract_shorten_length = self::ABSTRACT_DEFAULT_SHORTEN_LENGTH
protected

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

Referenced by getAbstractShortenLength().

ilObjBlog::$approval
protected

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

Referenced by hasApproval().

ilObjBlog::$authors = true
protected

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

Referenced by hasAuthors().

ilObjBlog::$bg_color
protected

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

Referenced by getBackgroundColor().

ilObjBlog::$font_color
protected

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

Referenced by getFontColor().

ilObjBlog::$img
protected

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

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

ilObjBlog::$keywords = true
protected

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

Referenced by hasKeywords().

ilObjBlog::$nav_mode = self::NAV_MODE_LIST
protected

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

Referenced by getNavMode().

ilObjBlog::$nav_mode_list_months
protected

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

Referenced by getNavModeListMonths().

ilObjBlog::$nav_mode_list_postings = self::NAV_MODE_LIST_DEFAULT_POSTINGS
protected

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

Referenced by getNavModeListPostings().

ilObjBlog::$notes
protected

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

Referenced by getNotesStatus().

ilObjBlog::$order
protected

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

Referenced by getOrder().

ilObjBlog::$overview_postings
protected

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

Referenced by getOverviewPostings().

ilObjBlog::$ppic
protected

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

Referenced by hasProfilePicture().

ilObjBlog::$rss
protected

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

Referenced by hasRSS().

ilObjBlog::$style
protected

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

Referenced by getStyleSheetId().

const ilObjBlog::ABSTRACT_DEFAULT_IMAGE_HEIGHT = 144

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

Referenced by ilObjBlogGUI\getEditFormCustomValues().

const ilObjBlog::ABSTRACT_DEFAULT_IMAGE_WIDTH = 144

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

Referenced by ilObjBlogGUI\getEditFormCustomValues().

const ilObjBlog::ABSTRACT_DEFAULT_SHORTEN_LENGTH = 500

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

Referenced by ilObjBlogGUI\getEditFormCustomValues().

const ilObjBlog::NAV_MODE_LIST = 1

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

Referenced by ilObjBlogGUI\initEditCustomForm(), and ilObjBlogGUI\renderNavigationByDate().

const ilObjBlog::NAV_MODE_LIST_DEFAULT_POSTINGS = 10

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

const ilObjBlog::NAV_MODE_MONTH = 2

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

Referenced by ilObjBlogGUI\initEditCustomForm().

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