ilObjForum Class Reference

Class ilObjForum. More...

Inheritance diagram for ilObjForum:

Collaboration diagram for ilObjForum:

Public Member Functions
	__construct ($a_id=0, $a_call_by_reference=true)
	Constructor public. More...
	create ()
	getDiskUsage ()
	Gets the disk usage of the object in bytes. More...
	initDefaultRoles ()
	init default roles settings public More...
	createSettings ()
	setThreadSorting ($a_thr_pk, $a_sorting_value)
Public Member Functions inherited from ilObject
	__construct ($a_id=0, $a_reference=true)
	Constructor public. More...
	withReferences ()
	determines wehter objects are referenced or not (got ref ids or not) More...
	read ()
	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 ()
	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...
	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...
	putInTree ($a_parent_ref)
	maybe this method should be in tree object!? More...
	setPermissions ($a_parent_ref)
	set permissions of object More...
	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. 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...
	applyDidacticTemplate ($a_tpl_id)
	Apply template. 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...
	getPossibleSubObjects ($a_filter=true)
	get all possible subobjects of this type the object can decide which types of subobjects are possible jut in time overwrite if the decision distinguish from standard model More...

Static Public Member Functions
static	lookupForumIdByObjId ($obj_id)
static	lookupForumIdByRefId ($ref_id)
static	mergeForumUserRead ($merge_source_thread_id, $merge_target_thread_id)
Static Public Member Functions inherited from ilObject
static	_lookupObjIdByImportId ($a_import_id)
static	_lookupImportId ($a_obj_id)
static	_lookupOwnerName ($a_owner_id)
	lookup owner name for owner id More...
static	_getIdForImportId ($a_import_id)
	get current object id for import id (static) More...
static	_getAllReferences ($a_id)
	get all reference ids of object More...
static	_lookupTitle ($a_id)
	lookup object title More...
static	_lookupOwner ($a_id)
	lookup object owner More...
static	_getIdsForTitle ($title, $type='', $partialmatch=false)
static	_lookupDescription ($a_id)
	lookup object description More...
static	_lookupLastUpdate ($a_id, $a_as_string=false)
	lookup last update More...
static	_getLastUpdateOfObjects ($a_objs)
	Get last update for a set of media objects. More...
static	_lookupObjId ($a_id)
static	_setDeletedDate ($a_ref_id)
	only called in ilTree::saveSubTree More...
static	setDeletedDates ($a_ref_ids)
	Set deleted date type $ilDB. More...
static	_resetDeletedDate ($a_ref_id)
	only called in ilObjectGUI::insertSavedNodes More...
static	_lookupDeletedDate ($a_ref_id)
	only called in ilObjectGUI::insertSavedNodes More...
static	_writeTitle ($a_obj_id, $a_title)
	write title to db (static) More...
static	_writeDescription ($a_obj_id, $a_desc)
	write description to db (static) More...
static	_writeImportId ($a_obj_id, $a_import_id)
	write import id to db (static) More...
static	_lookupType ($a_id, $a_reference=false)
	lookup object type More...
static	_isInTrash ($a_ref_id)
	checks wether object is in trash More...
static	_hasUntrashedReference ($a_obj_id)
	checks wether an object has at least one reference that is not in trash More...
static	_lookupObjectId ($a_ref_id)
	lookup object id More...
static	_getObjectsDataForType ($a_type, $a_omit_trash=false)
	get all objects of a certain type 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	fixMissingTitles ($a_type, array &$a_obj_title_map)
	Try to fix missing object titles. More...
static	_lookupCreationDate ($a_id)
	Lookup creation date. More...
static	hasAutoRating ($a_type, $a_ref_id)
	Check if auto rating is active for parent group/course. More...

Data Fields
	$Forum
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

Static Protected Attributes
static	$obj_id_to_forum_id_cache = array()
static	$ref_id_to_forum_id_cache = array()
static	$forum_statistics_cache = array()
static	$forum_last_post_cache = array()

Private Member Functions
	deleteDraftsByForumId ($forum_id)

Detailed Description

Class ilObjForum.

Author

Wolfgang Merkens wmerk.nosp@m.ens@.nosp@m.datab.nosp@m.ay.d.nosp@m.e

Version

$Id$

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

Constructor & Destructor Documentation

__construct()

ilObjForum::__construct	(		$a_id = 0,
			$a_call_by_reference = true
	)

Constructor public.

Parameters

integer	$a_id	reference_id or object_id
boolean	$a_call_by_reference	treat the id as reference_id (true) or object_id (false)

Definition at line 59 of file class.ilObjForum.php.

References time.

        {
                $this->type = 'frm';
                parent::__construct($a_id, $a_call_by_reference);

                /*
                 * this constant is used for the information if a single post is marked as new
                 * All threads/posts created before this date are never marked as new
                 * Default is 8 weeks
                 *
                 */
                $new_deadline = time() - 60 * 60 * 24 * 7 * ($this->ilias->getSetting('frm_store_new') ?
                        $this->ilias->getSetting('frm_store_new') :
                        8);
                define('NEW_DEADLINE', $new_deadline);

                // TODO: needs to rewrite scripts that are using Forum outside this class
                $this->Forum = new ilForum();
        }

Member Function Documentation

create()

ilObjForum::create

(

)

Returns

int

Definition at line 82 of file class.ilObjForum.php.

References ilObject\$id, $ilDB, array, createSettings(), ilObject\getId(), ilForumProperties\getInstance(), ilObject\getOwner(), ilObject\getRefId(), and ilObject\setPermissions().

        {
                $id = parent::create();

                require_once 'Modules/Forum/classes/class.ilForumProperties.php';
                $properties = ilForumProperties::getInstance($this->getId());
                $properties->setDefaultView(1);
                $properties->setAnonymisation(0);
                $properties->setStatisticsStatus(0);
                $properties->setPostActivation(0);
                $properties->setThreadSorting(0);
                $properties->insert();

                $this->createSettings();

                $this->saveData();

                return $id;
        }

Here is the call graph for this function:

createSettings()

ilObjForum::createSettings

(

)

Definition at line 800 of file class.ilObjForum.php.

References $_GET, $ilDB, $ilUser, ilNewsItem\_getDefaultVisibilityForRefId(), ilBlockSetting\_write(), array, ilObject\getDescription(), ilObject\getId(), ilObject\getTitle(), and ilUtil\now().

Referenced by create().

        {
                // news settings (public notifications yes/no)
                include_once("./Services/News/classes/class.ilNewsItem.php");
                $default_visibility = ilNewsItem::_getDefaultVisibilityForRefId($_GET["ref_id"]);
                if($default_visibility == "public")
                {
                        ilBlockSetting::_write("news", "public_notifications", 1, 0, $this->getId());
                }

                return true;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

deleteDraftsByForumId()

ilObjForum::deleteDraftsByForumId (   $forum_id )

private

Parameters

int

$forum_id

Definition at line 731 of file class.ilObjForum.php.

References $ilDB, $res, $row, and array.

Referenced by getDiskUsage().

        {
                global $ilDB;
                $res = $ilDB->queryF('SELECT draft_id FROM frm_posts_drafts WHERE forum_id = %s',
                        array('integer'), array((int)$forum_id));
                
                $draft_ids = array();
                while($row = $ilDB->fetchAssoc($res))
                {
                        $draft_ids[] = $row['draft_id'];
                }

                if(count($draft_ids) > 0)
                {
                        require_once 'Modules/Forum/classes/class.ilForumDraftsHistory.php';
                        $historyObj = new ilForumDraftsHistory();
                        $historyObj->deleteHistoryByDraftIds($draft_ids);
                        
                        require_once 'Modules/Forum/classes/class.ilForumPostDraft.php';
                        $draftObj = new ilForumPostDraft();
                        $draftObj->deleteDraftsByDraftIds($draft_ids);
                }
        }

Here is the caller graph for this function:

getDiskUsage()

ilObjForum::getDiskUsage

(

)

Gets the disk usage of the object in bytes.

public

Returns

integer the disk usage in bytes

Definition at line 138 of file class.ilObjForum.php.

References $data, $GLOBALS, $ilBench, $ilDB, ilObject\$ilias, $ilLog, $options, $res, $row, ilCopyWizardOptions\_getInstance(), ilForum\_lookupPostMessage(), array, ilObject\cloneObject(), date, deleteDraftsByForumId(), ilObject\getDescription(), ilObject\getId(), ilForumProperties\getInstance(), ilObject\getOwner(), ilObject\getRefId(), ilObject\getTitle(), time, and ilObject\update().

        {
                require_once("./Modules/File/classes/class.ilObjFileAccess.php");
                return ilObjForumAccess::_lookupDiskUsage($this->id);
        }

Here is the call graph for this function:

initDefaultRoles()

ilObjForum::initDefaultRoles

(

)

init default roles settings public

Returns

array object IDs of created local roles.

Definition at line 760 of file class.ilObjForum.php.

References $ilDB, $res, $row, array, ilObjRole\createDefaultRole(), ilObject\getId(), and ilObject\getRefId().

        {
                include_once './Services/AccessControl/classes/class.ilObjRole.php';
                $role = ilObjRole::createDefaultRole(
                                'il_frm_moderator_'.$this->getRefId(),
                                "Moderator of forum obj_no.".$this->getId(),
                                'il_frm_moderator',
                                $this->getRefId()
                );
                return array();
        }

Here is the call graph for this function:

lookupForumIdByObjId()

static ilObjForum::lookupForumIdByObjId (   $obj_id )

static

Parameters

int

$obj_id

Returns

int

Definition at line 880 of file class.ilObjForum.php.

References array.

Referenced by ilForumExportGUI\ensureThreadBelongsToForum(), ilObjForumGUI\ensureThreadBelongsToForum(), and ilObjForumGUI\getSubTabs().

        {
                if(array_key_exists($obj_id, self::$obj_id_to_forum_id_cache))
                {
                        return (int)self::$obj_id_to_forum_id_cache[$obj_id];
                }

                self::preloadForumIdsByObjIds(array($obj_id));

                return (int)self::$obj_id_to_forum_id_cache[$obj_id];
        }

Here is the caller graph for this function:

lookupForumIdByRefId()

static ilObjForum::lookupForumIdByRefId (   $ref_id )

static

Parameters

int

$ref_id

Returns

int

Definition at line 897 of file class.ilObjForum.php.

References $data, $ilDB, $ilSetting, $ilUser, $in, $query, ilObject\$ref_id, $res, $row, ilObject\_lookupObjectId(), array, date, ilForumProperties\FORUM_OVERVIEW_WITH_NEW_POSTS, ilForumProperties\getInstance(), and time.

Referenced by ilObjForumGUI\autosaveDraftAsyncObject(), ilObjForumGUI\autosaveThreadDraftAsyncObject(), ilForumPostDraft\getDraftsStatisticsByRefId(), and ilForumPostDraft\moveDraftsByMovedThread().

        {
                if(array_key_exists($ref_id, self::$ref_id_to_forum_id_cache))
                {
                        return (int)self::$ref_id_to_forum_id_cache[$ref_id];
                }

                self::preloadForumIdsByRefIds(array($ref_id));

                return (int)self::$ref_id_to_forum_id_cache[$ref_id];
        }

Here is the call graph for this function:

Here is the caller graph for this function:

mergeForumUserRead()

static ilObjForum::mergeForumUserRead (   $merge_source_thread_id,   $merge_target_thread_id  )

static

Definition at line 1235 of file class.ilObjForum.php.

References $ilDB, and array.

Referenced by ilForum\mergeThreads().

        {
                global $ilDB;
                
                $ilDB->update('frm_user_read',
                        array('thread_id' => array('integer', $merge_target_thread_id)),
                        array('thread_id' => array('integer',$merge_source_thread_id)));
        }

Here is the caller graph for this function:

setThreadSorting()

ilObjForum::setThreadSorting	(		$a_thr_pk,
			$a_sorting_value
	)

Definition at line 865 of file class.ilObjForum.php.

References $ilDB, and array.

        {
                global $ilDB;

                $ilDB->update('frm_threads',
                        array('thread_sorting' => array('integer',$a_sorting_value)),
                        array('thr_pk' => array('integer', $a_thr_pk)));
        }

Field Documentation

$Forum

ilObjForum::$Forum

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

$forum_last_post_cache

ilObjForum::$forum_last_post_cache = array()

staticprotected

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

$forum_statistics_cache

ilObjForum::$forum_statistics_cache = array()

staticprotected

Definition at line 45 of file class.ilObjForum.php.

$obj_id_to_forum_id_cache

ilObjForum::$obj_id_to_forum_id_cache = array()

staticprotected

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

$ref_id_to_forum_id_cache

ilObjForum::$ref_id_to_forum_id_cache = array()

staticprotected

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

---

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

• Modules/Forum/classes/class.ilObjForum.php