ilObjBlog Class Reference

Inheritance diagram for ilObjBlog:

Collaboration diagram for ilObjBlog:

Public Member Functions
	__construct (int $a_id=0, bool $a_reference=true)
	getNotesStatus ()
	setNotesStatus (bool $a_status)
	initDefaultRoles ()
	getLocalContributorRole (int $a_node_id)
	getLocalEditorRole (int $a_node_id)
	getAllLocalRoles (int $a_node_id)
	getRolesWithContributeOrRedact (int $a_node_id)
Public Member Functions inherited from ilObject2
	__construct (int $a_id=0, bool $a_reference=true)
	Constructor. More...
	read ()
	create (bool $a_clone_mode=false)
	update ()
	delete ()
	cloneMetaData (ilObject $target_obj)
	cloneObject (int $target_id, int $copy_id=0, bool $omit_tree=false)
Public Member Functions inherited from ilObject
	getObjectProperties ()
	flushObjectProperties ()
	withReferences ()
	determines whether objects are referenced or not (got ref ids or not) More...
	processAutoRating ()
	read ()
	getId ()
	setId (int $id)
	setRefId (int $ref_id)
	getRefId ()
	getType ()
	setType (string $type)
	getPresentationTitle ()
	get presentation title Normally same as title Overwritten for sessions More...
	getTitle ()
	getUntranslatedTitle ()
	Get untranslated object title WebDAV needs to access the untranslated title of an object. More...
	setTitle (string $title)
	getDescription ()
	setDescription (string $description)
	getLongDescription ()
	get object long description (stored in object_description) More...
	getImportId ()
	setImportId (string $import_id)
	setOfflineStatus (bool $status)
	getOfflineStatus ()
	supportsOfflineHandling ()
	getOwner ()
	getOwnerName ()
	get full name of object owner More...
	setOwner (int $usr_id)
	getCreateDate ()
	Get create date in YYYY-MM-DD HH-MM-SS format. More...
	getLastUpdateDate ()
	Get last update date in YYYY-MM-DD HH-MM-SS format. More...
	create ()
	note: title, description and type should be set when this function is called More...
	update ()
	MDUpdateListener (string $element)
	Metadata update listener. More...
	createMetaData ()
	updateMetaData ()
	deleteMetaData ()
	updateOwner ()
	update owner of object in db More...
	putInTree (int $parent_ref_id)
	maybe this method should be in tree object!? More...
	setPermissions (int $parent_ref_id)
	setParentRolePermissions (int $parent_ref_id)
	Initialize the permissions of parent roles (local roles of categories, global roles...) This method is overwritten in e.g. More...
	createReference ()
	creates reference for object More...
	countReferences ()
	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. More...
	applyDidacticTemplate (int $tpl_id)
	getXMLZip ()
	getHTMLDirectory ()
	appendCopyInfo (int $target_id, int $copy_id, int $new_obj_id)
	Prepend Copy info if object with same name exists in that container. More...
	cloneDependencies (int $target_id, int $copy_id)
	Clone object dependencies. More...
	cloneMetaData (ilObject $target_obj)
	Copy meta data. More...
	selfOrParentWithRatingEnabled ()
	getPossibleSubObjects (bool $filter=true)
	get all possible sub objects of this type the object can decide which types of sub objects are possible jut in time overwrite if the decision distinguish from standard model More...

Static Public Member Functions
static	sendNotification (string $a_action, bool $a_in_wsp, int $a_blog_node_id, int $a_posting_id, ?string $a_comment=null)
static	deliverRSS (string $a_wsp_id)
	Deliver blog as rss feed. More...
Static Public Member Functions inherited from ilObject
static	_lookupObjIdByImportId (string $import_id)
	Get (latest) object id for an import id. More...
static	_lookupImportId (int $obj_id)
static	_lookupOwnerName (int $owner_id)
	Lookup owner name for owner id. More...
static	_getIdForImportId (string $import_id)
static	_getAllReferences (int $id)
	get all reference ids for object ID More...
static	_lookupTitle (int $obj_id)
static	lookupOfflineStatus (int $obj_id)
	Lookup offline status using objectDataCache. More...
static	_lookupOwner (int $obj_id)
	Lookup owner user ID for object ID. More...
static	_getIdsForTitle (string $title, string $type='', bool $partial_match=false)
static	_lookupDescription (int $obj_id)
static	_lookupLastUpdate (int $obj_id, bool $formatted=false)
static	_getLastUpdateOfObjects (array $obj_ids)
static	_lookupObjId (int $ref_id)
static	_setDeletedDate (int $ref_id, int $deleted_by)
static	setDeletedDates (array $ref_ids, int $user_id)
static	_resetDeletedDate (int $ref_id)
static	_lookupDeletedDate (int $ref_id)
static	_writeTitle (int $obj_id, string $title)
	write title to db (static) More...
static	_writeDescription (int $obj_id, string $desc)
	write description to db (static) More...
static	_writeImportId (int $obj_id, string $import_id)
	write import id to db (static) More...
static	_lookupType (int $id, bool $reference=false)
static	_isInTrash (int $ref_id)
static	_hasUntrashedReference (int $obj_id)
	checks whether an object has at least one reference that is not in trash More...
static	_lookupObjectId (int $ref_id)
static	_getObjectsDataForType (string $type, bool $omit_trash=false)
	get all objects of a certain type More...
static	_exists (int $id, bool $reference=false, ?string $type=null)
	checks if an object exists in object_data More...
static	_getObjectsByType (string $obj_type="", ?int $owner=null)
static	_prepareCloneSelection (array $ref_ids, string $new_type, bool $show_path=true)
	Prepare copy wizard object selection. More...
static	getIconForType (string $type)
static	_getIcon (int $obj_id=0, string $size="big", string $type="", bool $offline=false)
	Get icon for repository item. More...
static	collectDeletionDependencies (array &$deps, int $ref_id, int $obj_id, string $type, int $depth=0)
	Collect deletion dependencies. More...
static	getDeletionDependencies (int $obj_id)
	Get deletion dependencies. More...
static	getLongDescriptions (array $obj_ids)
static	getAllOwnedRepositoryObjects (int $user_id)
static	fixMissingTitles ($type, array &$obj_title_map)
	Try to fix missing object titles. More...
static	_lookupCreationDate (int $obj_id)
static	_getObjectTypeIdByTitle (string $type, ?\ilDBInterface $ilDB=null)

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
Data Fields inherited from ilObject
const	TITLE_LENGTH = 255
const	DESC_LENGTH = 128
const	LONG_DESC_LENGTH = 4000
const	TABLE_OBJECT_DATA = "object_data"
array	$objectList
string	$untranslatedTitle

Protected Member Functions
	initType ()
	doRead ()
	doCreate (bool $clone_mode=false)
	doDelete ()
	doUpdate ()
	doCloneObject (ilObject2 $new_obj, int $a_target_id, ?int $a_copy_id=null)
Protected Member Functions inherited from ilObject2
	initType ()
	doRead ()
	doCreate (bool $clone_mode=false)
	beforeCreate ()
	If overwritten this method should return true, there is currently no "abort" handling for cases where "false" is returned. More...
	doUpdate ()
	beforeUpdate ()
	doDelete ()
	beforeDelete ()
	doCloneObject (ilObject2 $new_obj, int $a_target_id, ?int $a_copy_id=null)
	beforeCloneObject ()
Protected Member Functions inherited from ilObject
	doMDUpdateListener (string $a_element)
	beforeMDUpdateListener (string $a_element)
	doCreateMetaData ()
	beforeCreateMetaData ()
	doUpdateMetaData ()
	beforeUpdateMetaData ()
	doDeleteMetaData ()
	beforeDeleteMetaData ()
	handleAutoRating ()
	hasAutoRating ()

Protected Attributes
Settings	$blog_settings = null
SettingsManager	$settings_manager
ILIAS Style Content DomainService	$content_style_domain
ILIAS Notes Service	$notes_service
bool	$notes = false
bool	$style = false
Protected Attributes inherited from ilObject
ilLogger	$obj_log
ILIAS	$ilias
ilObjectDefinition	$obj_definition
ilDBInterface	$db
ilLogger	$log
ilErrorHandling	$error
ilTree	$tree
ilAppEventHandler	$app_event_handler
ilRbacAdmin	$rbac_admin
ilRbacReview	$rbac_review
ilObjUser	$user
ilLanguage	$lng
LOMServices	$lom_services
bool	$call_by_reference
int	$max_title = self::TITLE_LENGTH
int	$max_desc = self::DESC_LENGTH
bool	$add_dots = true
int	$ref_id = null
string	$type = ""
string	$title = ""
string	$desc = ""
string	$long_desc = ""
int	$owner = 0
string	$create_date = ""
string	$last_update = ""
string	$import_id = ""
bool	$register = false

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilObjBlog::__construct	(	int	$a_id = 0,
		bool	$a_reference = true
	)

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

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), and ilObject\getId().

      {
        global $DIC;

        $this->notes_service = $DIC->notes();
        $this->settings_manager = $DIC->blog()->internal()->domain()->blogSettings();

        parent::__construct($a_id, $a_reference);
        $this->rbac_review = $DIC->rbac()->review();

        $this->content_style_domain = $DIC
            ->contentStyle()
            ->domain();

        if ($this->getId() > 0) {
            $this->blog_settings = $this->settings_manager->getByObjId($this->getId());
        }
    }

Here is the call graph for this function:

Member Function Documentation

deliverRSS()

static ilObjBlog::deliverRSS ( string  $a_wsp_id )

static

Deliver blog as rss feed.

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

References $DIC, $id, $ilSetting, $url, ilPageObject\_lookupActive(), ilObject\_lookupObjId(), exit, ilBlogPosting\getAllPostings(), ilBlogPostingGUI\getSnippet(), IL_CAL_DATETIME, and null.

                                                       : void
    {
        global $DIC;

        $ilSetting = $DIC->settings();

        if (!$ilSetting->get('enable_global_profiles')) {
            return;
        }

        // #10827
        if (!str_ends_with($a_wsp_id, "_cll")) {
            $wsp_id = new ilWorkspaceTree(0);
            $obj_id = $wsp_id->lookupObjectId((int) $a_wsp_id);
            $is_wsp = "_wsp";
            $pl = $DIC->blog()->internal()->gui()->permanentLink(0, (int) $a_wsp_id);
        } else {
            $a_wsp_id = substr($a_wsp_id, 0, -4);
            $obj_id = ilObject::_lookupObjId((int) $a_wsp_id);
            $is_wsp = null;
            $pl = $DIC->blog()->internal()->gui()->permanentLink((int) $a_wsp_id);
        }
        if (!$obj_id) {
            return;
        }

        $blog_settings = $DIC->blog()->internal()->domain()->blogSettings()
            ->getByObjId($obj_id);
        if (!$blog_settings?->getRSS()) {
            return;
        }

        $blog = new self($obj_id, false);
        $feed = new ilFeedWriter();

        $url = $pl->getPermanentLink();
        $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 ilGlobalTemplate("tpl.main.html", true, true);

        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 = $pl->getPermanentLink((int) $id);
            $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 ( ilObject2  $new_obj, int  $a_target_id, ?int  $a_copy_id = null  )

protected

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

References ilObject2\cloneMetaData(), ilObject\getId(), getNotesStatus(), and ilObject2\update().

                                                                                                  : void
    {
        assert($new_obj instanceof ilObjBlog);

        $new_obj->setNotesStatus($this->getNotesStatus());
        $new_obj->update();

        $this->settings_manager->clone($this->getId(), $new_obj->getId());

        // set/copy stylesheet
        $this->content_style_domain->styleForObjId($this->getId())->cloneTo($new_obj->getId());

        $this->cloneMetaData($new_obj);
    }

Here is the call graph for this function:

doCreate()

ilObjBlog::doCreate ( bool  $clone_mode = false )

protected

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

References ilObject\$db, $ilDB, and ilObject\createMetaData().

                                                         : void
    {
        $ilDB = $this->db;

        $this->createMetaData();

        $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_mon_with_post,ov_post) VALUES (" .
            $ilDB->quote($this->id, "integer") . "," .
            $ilDB->quote(true, "integer") . "," .
            $ilDB->quote(true, "integer") . "," .
            $ilDB->quote(false, "integer") . "," .
            $ilDB->quote(false, "integer") . "," .
            $ilDB->quote(0, "integer") . "," .
            $ilDB->quote(false, "integer") . "," .
            $ilDB->quote(0, "integer") . "," .
            $ilDB->quote(0, "integer") . "," .
            $ilDB->quote(true, "integer") . "," .
            $ilDB->quote(false, "integer") . "," .
            $ilDB->quote(self::NAV_MODE_LIST, "integer") . "," .
            $ilDB->quote(5, "integer") . "," .
            $ilDB->quote(5, "integer") .
            ")");

        // #14661
        $this->notes_service->domain()->activateComments($this->id);
    }

Here is the call graph for this function:

doDelete()

ilObjBlog::doDelete ( )

protected

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

References ilObject\$db, $ilDB, ilBlogPosting\deleteAllBlogPostings(), ilObject\deleteMetaData(), ilNotification\removeForObject(), and ilNotification\TYPE_BLOG.

                                 : void
    {
        $ilDB = $this->db;

        $this->deleteMetaData();

        ilBlogPosting::deleteAllBlogPostings($this->id);

        // remove all notifications
        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 66 of file class.ilObjBlog.php.

References ilObject\getId(), and setNotesStatus().

                               : void
    {
        // #14661
        $this->setNotesStatus(
            $this->notes_service->domain()->commentsActive($this->id)
        );
        $this->blog_settings = $this->settings_manager->getByObjId($this->getId());
    }

Here is the call graph for this function:

doUpdate()

ilObjBlog::doUpdate ( )

protected

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

References getNotesStatus(), and ilObject\updateMetaData().

                                 : void
    {
        $this->updateMetaData();

        if ($this->id) {
            // #14661
            $this->notes_service->domain()->activateComments(
                $this->id,
                $this->getNotesStatus()
            );
        }
    }

Here is the call graph for this function:

getAllLocalRoles()

ilObjBlog::getAllLocalRoles

(

int

$a_node_id

)

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

References $res, ilObjRole\_getTranslation(), and ilObject\_lookupTitle().

                                                    : array
    {
        $res = array();
        foreach ($this->rbac_review->getLocalRoles($a_node_id) as $role_id) {
            $res[$role_id] = ilObjRole::_getTranslation(ilObject::_lookupTitle($role_id));
        }

        asort($res);
        return $res;
    }

Here is the call graph for this function:

getLocalContributorRole()

ilObjBlog::getLocalContributorRole

(

int

$a_node_id

)

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

References ilObject\_lookupTitle().

Referenced by getRolesWithContributeOrRedact().

                                                           : int
    {
        foreach ($this->rbac_review->getLocalRoles($a_node_id) as $role_id) {
            if (str_starts_with(ilObject::_lookupTitle($role_id), "il_blog_contributor")) {
                return $role_id;
            }
        }
        return 0;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getLocalEditorRole()

ilObjBlog::getLocalEditorRole

(

int

$a_node_id

)

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

References ilObject\_lookupTitle().

Referenced by getRolesWithContributeOrRedact().

                                                      : int
    {
        foreach ($this->rbac_review->getLocalRoles($a_node_id) as $role_id) {
            if (strpos(ilObject::_lookupTitle($role_id), "il_blog_editor") === 0) {
                return $role_id;
            }
        }
        return 0;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getNotesStatus()

ilObjBlog::getNotesStatus

(

)

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

References $notes.

Referenced by doCloneObject(), and doUpdate().

                                    : bool
    {
        return $this->notes;
    }

Here is the caller graph for this function:

getRolesWithContributeOrRedact()

ilObjBlog::getRolesWithContributeOrRedact

(

int

$a_node_id

)

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

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

                                                                  : array
    {
        $contr_op_id = ilRbacReview::_getOperationIdByName("contribute");
        $redact_op_id = ilRbacReview::_getOperationIdByName("redact");
        $contr_role_id = $this->getLocalContributorRole($a_node_id);
        $editor_role_id = $this->getLocalEditorRole($a_node_id);

        $res = array();
        foreach ($this->rbac_review->getParentRoleIds($a_node_id) as $role_id => $role) {
            if ($role_id != $contr_role_id &&
                $role_id != $editor_role_id) {
                $all_ops = $this->rbac_review->getActiveOperationsOfRole($a_node_id, $role_id);
                if (in_array($contr_op_id, $all_ops) ||
                    in_array($redact_op_id, $all_ops)) {
                    $res[$role_id] = ilObjRole::_getTranslation($role["title"]);
                }
            }
        }

        return $res;
    }

Here is the call graph for this function:

initDefaultRoles()

ilObjBlog::initDefaultRoles

(

)

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

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

                                      : void
    {
        ilObjRole::createDefaultRole(
            'il_blog_contributor_' . $this->getRefId(),
            "Contributor of blog obj_no." . $this->getId(),
            'il_blog_contributor',
            $this->getRefId()
        );

        ilObjRole::createDefaultRole(
            'il_blog_editor_' . $this->getRefId(),
            "Editor of blog obj_no." . $this->getId(),
            'il_blog_editor',
            $this->getRefId()
        );
    }

Here is the call graph for this function:

initType()

ilObjBlog::initType ( )

protected

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

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

sendNotification()

static ilObjBlog::sendNotification ( string  $a_action, bool  $a_in_wsp, int  $a_blog_node_id, int  $a_posting_id, ?string  $a_comment = null  )

static

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

References $DIC.

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

     : void {
        global $DIC;

        $DIC->blog()->internal()->domain()->notification()->sendNotification(
            $a_action,
            $a_in_wsp,
            $a_blog_node_id,
            $a_posting_id,
            $a_comment
        );
    }

Here is the caller graph for this function:

setNotesStatus()

ilObjBlog::setNotesStatus

(

bool

$a_status

)

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

Referenced by doRead().

                                                  : void
    {
        $this->notes = $a_status;
    }

Here is the caller graph for this function:

Field Documentation

$blog_settings

Settings ilObjBlog::$blog_settings = null

protected

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

$content_style_domain

ILIAS Style Content DomainService ilObjBlog::$content_style_domain

protected

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

$notes

bool ilObjBlog::$notes = false

protected

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

Referenced by getNotesStatus().

$notes_service

ILIAS Notes Service ilObjBlog::$notes_service

protected

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

$settings_manager

SettingsManager ilObjBlog::$settings_manager

protected

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

$style

bool ilObjBlog::$style = false

protected

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

ABSTRACT_DEFAULT_IMAGE_HEIGHT

const ilObjBlog::ABSTRACT_DEFAULT_IMAGE_HEIGHT = 144

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

ABSTRACT_DEFAULT_IMAGE_WIDTH

const ilObjBlog::ABSTRACT_DEFAULT_IMAGE_WIDTH = 144

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

ABSTRACT_DEFAULT_SHORTEN_LENGTH

const ilObjBlog::ABSTRACT_DEFAULT_SHORTEN_LENGTH = 500

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

NAV_MODE_LIST

const ilObjBlog::NAV_MODE_LIST = 1

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

Referenced by ILIAS\Blog\Settings\SettingsGUI\getEditForm(), ilObjBlogGUI\renderNavigationByDate(), and ILIAS\Blog\Settings\SettingsGUI\save().

NAV_MODE_LIST_DEFAULT_POSTINGS

const ilObjBlog::NAV_MODE_LIST_DEFAULT_POSTINGS = 10

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

NAV_MODE_MONTH

const ilObjBlog::NAV_MODE_MONTH = 2

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

Referenced by ILIAS\Blog\Settings\SettingsGUI\getEditForm().

---

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

• components/ILIAS/Blog/classes/class.ilObjBlog.php