ilForumPostDraft Class Reference

Class ilForumPostDraft. More...

Collaboration diagram for ilForumPostDraft:

Public Member Functions
	getPostNotify ()
	setPostNotify ($post_notify)
	getDraftId ()
	setDraftId ($draft_id)
	getPostId ()
	setPostId ($post_id)
	getForumId ()
	setForumId ($forum_id)
	getThreadId ()
	setThreadId ($thread_id)
	getPostSubject ()
	setPostSubject ($post_subject)
	getPostMessage ()
	setPostMessage ($post_message)
	getPostDate ()
	setPostDate ($post_date)
	getPostUpdate ()
	setPostUpdate ($post_update)
	getUpdateUserId ()
	setUpdateUserId ($update_user_id)
	getPostUserAlias ()
	setPostUserAlias ($post_user_alias)
	getPostAuthorId ()
	setPostAuthorId ($post_author_id)
	getPostDisplayUserId ()
	setPostDisplayUserId ($post_display_user_id)
	getNotify ()
	setNotify ($notify)
	__construct ($user_id=0, $post_id=0, $draft_id=0)
	ilForumPostDraft constructor. More...
	saveDraft ()
	updateDraft ()
	deleteDraft ()
	deleteDraftsByPostIds (array $post_ids=array())
	deleteDraftsByDraftIds (array $draft_ids=array())

Static Public Member Functions
static	getSortedDrafts (int $usrId, int $threadId, int $sorting=ilForumProperties::VIEW_DATE_ASC)
static	getDraftInstancesByUserId ($user_id)
static	getInstancesByUserIdAndThreadId ($user_id, $thread_id)
static	newInstanceByDraftId ($draft_id)
static	newInstanceByHistorytId ($history_id)
static	deleteMobsOfDraft ($draft_id)
static	deleteDraftsByUserId ($user_id)
static	isSavePostDraftAllowed ()
static	isAutoSavePostDraftAllowed ()
static	lookupAutosaveInterval ()
static	getDraftsStatisticsByRefId ($ref_id)
static	moveDraftsByMergedThreads ($source_thread_id, $target_thread_id)
static	moveDraftsByMovedThread ($thread_ids, $source_ref_id, $target_ref_id)
static	getThreadDraftData ($post_author_id, $forum_id)
static	createDraftBackup ($draft_id)

Data Fields
const	MEDIAOBJECT_TYPE = 'frm~d:html'

Protected Member Functions
	readDraft ()

Static Protected Member Functions
static	populateWithDatabaseRecord (ilForumPostDraft $draft, array $row)
static	readDrafts ($user_id)

Protected Attributes
	$draft_id = 0
	$post_id = 0
	$forum_id = 0
	$thread_id = 0
	$post_subject = ''
	$post_message = ''
	$post_date = '0000-00-00 00:00:00'
	$post_update = '0000-00-00 00:00:00'
	$update_user_id = 0
	$post_user_alias = ''
	$post_author_id = 0
	$post_display_user_id = 0
	$notify = 0
	$post_notify = 0

Static Protected Attributes
static	$forum_statistics_cache = array()
static	$drafts_settings_cache = array()

Static Private Attributes
static	$instances = array()

Detailed Description

Class ilForumPostDraft.

Author

Nadia Matuschek nmatu.nosp@m.sche.nosp@m.k@dat.nosp@m.abay.nosp@m..de

Definition at line 7 of file class.ilForumPostDraft.php.

Constructor & Destructor Documentation

__construct()

ilForumPostDraft::__construct	(		$user_id = 0,
			$post_id = 0,
			$draft_id = 0
	)

ilForumPostDraft constructor.

Parameters

int	$user_id
int	$post_id

Definition at line 335 of file class.ilForumPostDraft.php.

References $DIC, $draft_id, $post_id, readDraft(), setDraftId(), setPostAuthorId(), and setPostId().

    {
        global $DIC;
        
        $this->db = $DIC->database();
        
        if ($user_id && $post_id && $draft_id) {
            $this->setPostAuthorId($user_id);
            $this->setPostId($post_id);
            $this->setDraftId($draft_id);
            $this->readDraft();
        }
    }

Here is the call graph for this function:

Member Function Documentation

createDraftBackup()

static ilForumPostDraft::createDraftBackup (   $draft_id )

static

Parameters

$draft_id

Definition at line 797 of file class.ilForumPostDraft.php.

References $DIC, $draft_id, $ilDB, $res, ilForumDraftsHistory\MEDIAOBJECT_TYPE, and ilForumUtil\moveMediaObjects().

Referenced by ilObjForumGUI\doHistoryCheck(), and ilObjForumGUI\restoreFromHistoryObject().

    {
        global $DIC;
        $ilDB = $DIC->database();
        
        $res = $ilDB->queryF(
            'SELECT * FROM frm_posts_drafts WHERE draft_id = %s',
            array('integer'),
            array((int) $draft_id)
        );
        
        while ($row = $ilDB->fetchAssoc($res)) {
            $tmp_obj = new self;
            self::populateWithDatabaseRecord($tmp_obj, $row);
        }
        
        $history_obj = new ilForumDraftsHistory();
        $history_obj->deleteHistoryByDraftIds(array($draft_id));
        
        $history_obj->setDraftId($draft_id);
        $history_obj->setPostSubject($tmp_obj->getPostSubject());
        $history_obj->setPostMessage($tmp_obj->getPostMessage());
        $history_obj->addDraftToHistory();
        
        ilForumUtil::moveMediaObjects(
            $tmp_obj->getPostMessage(),
            self::MEDIAOBJECT_TYPE,
            $draft_id,
            ilForumDraftsHistory::MEDIAOBJECT_TYPE,
            $history_obj->getHistoryId()
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

deleteDraft()

ilForumPostDraft::deleteDraft

(

)

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

References getDraftId().

Referenced by ilObjForumGUI\createThread(), and ilObjForumGUI\publishDraftObject().

    {
        $this->db->manipulateF(
            'DELETE FROM frm_posts_drafts WHERE draft_id = %s',
            array('integer'),
            array($this->getDraftId())
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

deleteDraftsByDraftIds()

ilForumPostDraft::deleteDraftsByDraftIds

(

array

$draft_ids = array()

)

Parameters

array

$draft_ids

Definition at line 605 of file class.ilForumPostDraft.php.

References $draft_id.

    {
        foreach ($draft_ids as $draft_id) {
            self::deleteMobsOfDraft($draft_id);
            
            // delete attachments of draft
            $objFileDataForumDrafts = new ilFileDataForumDrafts(0, $draft_id);
            $objFileDataForumDrafts->delete();
        }
        $this->db->manipulate('DELETE FROM frm_drafts_history WHERE ' . $this->db->in('draft_id', $draft_ids, false, 'integer'));
        $this->db->manipulate('DELETE FROM frm_posts_drafts WHERE ' . $this->db->in('draft_id', $draft_ids, false, 'integer'));
    }

deleteDraftsByPostIds()

ilForumPostDraft::deleteDraftsByPostIds

(

array

$post_ids = array()

)

Parameters

array

$post_ids

Definition at line 583 of file class.ilForumPostDraft.php.

References $draft_id, and $res.

    {
        $draft_ids = array();
        $res = $this->db->query('SELECT draft_id FROM frm_posts_drafts WHERE ' . $this->db->in('post_id', $post_ids, false, 'integer'));
        while ($row = $this->db->fetchAssoc($res)) {
            $draft_ids[] = $row['draft_id'];
        }
        
        foreach ($draft_ids as $draft_id) {
            self::deleteMobsOfDraft($draft_id);

            // delete attachments of draft
            $objFileDataForumDrafts = new ilFileDataForumDrafts(0, $draft_id);
            $objFileDataForumDrafts->delete();
        }
        $this->db->manipulate('DELETE FROM frm_drafts_history WHERE ' . $this->db->in('draft_id', $draft_ids, false, 'integer'));
        $this->db->manipulate('DELETE FROM frm_posts_drafts WHERE ' . $this->db->in('draft_id', $draft_ids, false, 'integer'));
    }

deleteDraftsByUserId()

static ilForumPostDraft::deleteDraftsByUserId (   $user_id )

static

Parameters

int

$user_id

Definition at line 621 of file class.ilForumPostDraft.php.

References $DIC, $draft_id, $ilDB, and $res.

    {
        global $DIC;
        $ilDB = $DIC->database();
        
        $res = $ilDB->queryF(
            'SELECT draft_id FROM frm_posts_drafts WHERE post_author_id = %s',
            array('integer'),
            array($user_id)
        );
        
        $draft_ids = array();
        while ($row = $ilDB->fetchAssoc($res)) {
            $draft_ids[] = $row['draft_id'];
        }
        
        foreach ($draft_ids as $draft_id) {
            self::deleteMobsOfDraft($draft_id);
            
            // delete attachments of draft
            $objFileDataForumDrafts = new ilFileDataForumDrafts(0, $draft_id);
            $objFileDataForumDrafts->delete();
        }
        
        $ilDB->manipulate('DELETE FROM frm_drafts_history WHERE ' . $ilDB->in('draft_id', $draft_ids, false, 'integer'));
        $ilDB->manipulateF(
            'DELETE FROM frm_posts_drafts WHERE post_author_id = %s',
            array('integer'),
            array($user_id)
        );
    }

deleteMobsOfDraft()

static ilForumPostDraft::deleteMobsOfDraft (   $draft_id )

static

Parameters

$draft_id

Definition at line 567 of file class.ilForumPostDraft.php.

References $draft_id, ilObjMediaObject\_exists(), ilObjMediaObject\_getMobsOfObject(), and ilObjMediaObject\_removeUsage().

    {
        // delete mobs of draft
        $oldMediaObjects = ilObjMediaObject::_getMobsOfObject('frm~d:html', $draft_id);
        foreach ($oldMediaObjects as $oldMob) {
            if (ilObjMediaObject::_exists($oldMob)) {
                ilObjMediaObject::_removeUsage($oldMob, 'frm~d:html', $draft_id);
                $mob_obj = new ilObjMediaObject($oldMob);
                $mob_obj->delete();
            }
        }
    }

Here is the call graph for this function:

getDraftId()

ilForumPostDraft::getDraftId

(

)

Returns

int

Definition at line 125 of file class.ilForumPostDraft.php.

References $draft_id.

Referenced by ilObjForumGUI\createThread(), ilObjForumGUI\createTopLevelPostObject(), deleteDraft(), readDraft(), and updateDraft().

    {
        return $this->draft_id;
    }

Here is the caller graph for this function:

getDraftInstancesByUserId()

static ilForumPostDraft::getDraftInstancesByUserId (   $user_id )

static

Parameters

int

$user_id

Returns

[]

Definition at line 443 of file class.ilForumPostDraft.php.

Referenced by ilObjForumGUI\confirmDeleteThreadDraftsObject(), ilObjForumGUI\deleteThreadDraftsObject(), and ilForumDraftsDerivedTaskProvider\getTasks().

                                                               : array
    {
        if (!self::$instances[$user_id]) {
            self::readDrafts($user_id);
        }

        return self::$instances[$user_id]['draft_ids'];
    }

Here is the caller graph for this function:

getDraftsStatisticsByRefId()

static ilForumPostDraft::getDraftsStatisticsByRefId (   $ref_id )

static

Parameters

$ref_id

Returns

mixed

Definition at line 695 of file class.ilForumPostDraft.php.

References $DIC, $ilDB, $ilUser, $res, and ilObjForum\lookupForumIdByRefId().

Referenced by ilForumTopicTableGUI\fillRow(), and ilObjForumListGUI\getProperties().

    {
        global $DIC;
        $ilDB = $DIC->database();
        $ilUser = $DIC->user();
        
        if (!isset(self::$forum_statistics_cache[$ref_id][$ilUser->getId()])) {
            $forumId = ilObjForum::lookupForumIdByRefId($ref_id);
            
            $res = $ilDB->queryF(
                '
                                SELECT COUNT(draft_id) num_drafts, thread_id FROM frm_posts_drafts 
                                WHERE forum_id = %s AND post_author_id = %s
                                GROUP BY thread_id',
                array('integer', 'integer'),
                array($forumId, $ilUser->getId())
            );
            
            $num_drafts_total = 0;
            
            while ($row = $ilDB->fetchAssoc($res)) {
                $num_drafts_total += $row['num_drafts'];
                self::$forum_statistics_cache[$ref_id][$ilUser->getId()][$row['thread_id']] = $row['num_drafts'];
            }
            
            self::$forum_statistics_cache[$ref_id][$ilUser->getId()]['total'] = $num_drafts_total;
        }
        return self::$forum_statistics_cache[$ref_id][$ilUser->getId()];
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getForumId()

ilForumPostDraft::getForumId

(

)

Returns

int

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

References $forum_id.

Referenced by saveDraft().

    {
        return $this->forum_id;
    }

Here is the caller graph for this function:

getInstancesByUserIdAndThreadId()

static ilForumPostDraft::getInstancesByUserIdAndThreadId (   $user_id,   $thread_id  )

static

Parameters

$user_id
$thread_id

Returns

[]

Definition at line 457 of file class.ilForumPostDraft.php.

References $thread_id.

                                                                                 : array
    {
        if (!self::$instances[$user_id]) {
            self::readDrafts($user_id);
        }

        if (isset(self::$instances[$user_id][$thread_id])) {
            return self::$instances[$user_id][$thread_id];
        }

        return [];
    }

getNotify()

ilForumPostDraft::getNotify

(

)

Returns

int

Definition at line 317 of file class.ilForumPostDraft.php.

References $notify.

Referenced by ilObjForumGUI\createThread(), and saveDraft().

    {
        return $this->notify;
    }

Here is the caller graph for this function:

getPostAuthorId()

ilForumPostDraft::getPostAuthorId

(

)

Returns

int

Definition at line 285 of file class.ilForumPostDraft.php.

References $post_author_id.

Referenced by ilObjForumGUI\createThread(), readDraft(), and saveDraft().

    {
        return $this->post_author_id;
    }

Here is the caller graph for this function:

getPostDate()

ilForumPostDraft::getPostDate

(

)

Returns

string

Definition at line 221 of file class.ilForumPostDraft.php.

References $post_date.

    {
        return $this->post_date;
    }

getPostDisplayUserId()

ilForumPostDraft::getPostDisplayUserId

(

)

Returns

int

Definition at line 301 of file class.ilForumPostDraft.php.

References $post_display_user_id.

Referenced by ilObjForumGUI\createThread(), and saveDraft().

    {
        return $this->post_display_user_id;
    }

Here is the caller graph for this function:

getPostId()

ilForumPostDraft::getPostId

(

)

Returns

int

Definition at line 141 of file class.ilForumPostDraft.php.

References $post_id.

Referenced by readDraft(), and saveDraft().

    {
        return $this->post_id;
    }

Here is the caller graph for this function:

getPostMessage()

ilForumPostDraft::getPostMessage

(

)

Returns

string

Definition at line 205 of file class.ilForumPostDraft.php.

References $post_message.

Referenced by saveDraft(), and updateDraft().

    {
        return $this->post_message;
    }

Here is the caller graph for this function:

getPostNotify()

ilForumPostDraft::getPostNotify

(

)

Returns

int

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

References $post_notify.

Referenced by ilObjForumGUI\createThread(), and saveDraft().

    {
        return $this->post_notify;
    }

Here is the caller graph for this function:

getPostSubject()

ilForumPostDraft::getPostSubject

(

)

Returns

string

Definition at line 189 of file class.ilForumPostDraft.php.

References $post_subject.

Referenced by saveDraft(), and updateDraft().

    {
        return $this->post_subject;
    }

Here is the caller graph for this function:

getPostUpdate()

ilForumPostDraft::getPostUpdate

(

)

Returns

string

Definition at line 237 of file class.ilForumPostDraft.php.

References $post_update.

    {
        return $this->post_update;
    }

getPostUserAlias()

ilForumPostDraft::getPostUserAlias

(

)

Returns

string

Definition at line 269 of file class.ilForumPostDraft.php.

References $post_user_alias.

Referenced by ilObjForumGUI\createThread(), saveDraft(), and updateDraft().

    {
        return $this->post_user_alias;
    }

Here is the caller graph for this function:

getSortedDrafts()

static ilForumPostDraft::getSortedDrafts ( int  $usrId, int  $threadId, int  $sorting = ilForumProperties::VIEW_DATE_ASC  )

static

Parameters

int	$usrId
int	$threadId
int	$sorting

Returns

ilForumPostDraft[]|array<int, ilForumPostDraft[]>

Definition at line 397 of file class.ilForumPostDraft.php.

References $DIC, $ilDB, $res, ilForumProperties\VIEW_DATE_DESC, and ilForumProperties\VIEW_TREE.

Referenced by ilObjForumGUI\checkUsersViewMode().

      : array {
        global $DIC;
        $ilDB = $DIC->database();

        $drafts = [];

        $orderColumn = ' ';
        $orderDirection = ' ';

        if ($sorting !== ilForumProperties::VIEW_TREE) {
            $orderColumn = ' ORDER BY post_date ';
            $orderDirection = 'ASC';
            if ($sorting === ilForumProperties::VIEW_DATE_DESC) {
                $orderDirection = 'DESC';
            }
        }

        $res = $ilDB->queryF(
            'SELECT * FROM frm_posts_drafts WHERE post_author_id = %s AND thread_id = %s' .
            $orderColumn . $orderDirection,
            ['integer', 'integer'],
            [$usrId, $threadId]
        );

        while ($row = $ilDB->fetchAssoc($res)) {
            $draft = new ilForumPostDraft();
            self::populateWithDatabaseRecord($draft, $row);
            $drafts[] = $draft;
            self::$instances[$usrId][$threadId][$draft->getPostId()][] = $draft;
        }

        if (ilForumProperties::VIEW_TREE === $sorting) {
            return self::$instances[$usrId][$threadId] ?? [];
        }

        return $drafts;
    }

Here is the caller graph for this function:

getThreadDraftData()

static ilForumPostDraft::getThreadDraftData (   $post_author_id,   $forum_id  )

static

Parameters

$post_author_id
$forum_id

Returns

array

Definition at line 770 of file class.ilForumPostDraft.php.

References $DIC, $forum_id, $ilDB, $post_author_id, and $res.

Referenced by ilObjForumGUI\getContent().

    {
        global $DIC;
        $ilDB = $DIC->database();
        
        $res = $ilDB->queryF(
            'SELECT * FROM frm_posts_drafts 
                                WHERE post_author_id = %s
                                AND forum_id = %s 
                                AND thread_id = %s
                                AND post_id = %s
                                ORDER BY post_date DESC',
            array('integer', 'integer', 'integer', 'integer'),
            array($post_author_id, $forum_id, 0, 0)
        );
        $draft_data = array();
        while ($row = $ilDB->fetchAssoc($res)) {
            $tmp_obj = new self;
            self::populateWithDatabaseRecord($tmp_obj, $row);
            $draft_data[] = array('subject' => $tmp_obj->getPostSubject(), 'post_update' => $tmp_obj->getPostUpdate(), 'draft_id' => $tmp_obj->getDraftId());
        }
        return $draft_data;
    }

Here is the caller graph for this function:

getThreadId()

ilForumPostDraft::getThreadId

(

)

Returns

int

Definition at line 173 of file class.ilForumPostDraft.php.

References $thread_id.

Referenced by saveDraft().

    {
        return $this->thread_id;
    }

Here is the caller graph for this function:

getUpdateUserId()

ilForumPostDraft::getUpdateUserId

(

)

Returns

int

Definition at line 253 of file class.ilForumPostDraft.php.

References $update_user_id.

    {
        return $this->update_user_id;
    }

isAutoSavePostDraftAllowed()

static ilForumPostDraft::isAutoSavePostDraftAllowed ( )

static

Returns

bool

Definition at line 668 of file class.ilForumPostDraft.php.

References $DIC.

Referenced by ilObjForumGUI\cancelDraftObject(), ilObjForumGUI\decorateWithAutosave(), ilObjForumGUI\doHistoryCheck(), ilObjForumGUI\editDraftObject(), ilForumAutoSaveAsyncDraftAction\executeAndGetResponseObject(), ilObjForumGUI\getCensorshipFormHTML(), ilObjForumGUI\publishDraftObject(), and ilObjForumGUI\saveTopLevelDraftObject().

    {
        if (!self::isSavePostDraftAllowed()) {
            // feature is globally deactivated
            return false;
        }
        if (!isset(self::$drafts_settings_cache['autosave_drafts'])) {
            global $DIC;
            
            self::$drafts_settings_cache['autosave_drafts'] = (bool) $DIC->settings()->get('autosave_drafts', false);
            self::$drafts_settings_cache['autosave_drafts_ival'] = (int) $DIC->settings()->get('autosave_drafts_ival', 30);
        }
        return self::$drafts_settings_cache['autosave_drafts'];
    }

Here is the caller graph for this function:

isSavePostDraftAllowed()

static ilForumPostDraft::isSavePostDraftAllowed ( )

static

Returns

bool

Definition at line 656 of file class.ilForumPostDraft.php.

References $DIC.

Referenced by ilForumTopicTableGUI\__construct(), ilObjForumGUI\addThreadObject(), ilObjForumGUI\checkUsersViewMode(), ilObjForumGUI\createTopLevelPostObject(), ilObjForumGUI\deleteSelectedDraft(), ilObjForumGUI\editDraftObject(), ilObjForumGUI\editThreadDraftObject(), ilObjForumGUI\getCensorshipFormHTML(), ilObjForumGUI\getContent(), ilObjForumListGUI\getProperties(), ilForumThreadFormGUI\initForm(), ilObjForumGUI\publishDraftObject(), ilObjForumGUI\publishThreadDraftObject(), ilObjForumGUI\saveThreadAsDraftObject(), ilObjForumGUI\saveTopLevelDraftObject(), and ilObjForumGUI\updateThreadDraftObject().

    {
        if (!isset(self::$drafts_settings_cache['save_post_drafts'])) {
            global $DIC;
            self::$drafts_settings_cache['save_post_drafts'] = (bool) $DIC->settings()->get('save_post_drafts', false);
        }
        return self::$drafts_settings_cache['save_post_drafts'];
    }

Here is the caller graph for this function:

lookupAutosaveInterval()

static ilForumPostDraft::lookupAutosaveInterval ( )

static

Definition at line 683 of file class.ilForumPostDraft.php.

Referenced by ilObjForumGUI\decorateWithAutosave(), and ilObjForumGUI\getCensorshipFormHTML().

    {
        if (self::isAutoSavePostDraftAllowed()) {
            return self::$drafts_settings_cache['autosave_drafts_ival'];
        }
        return 0;
    }

Here is the caller graph for this function:

moveDraftsByMergedThreads()

static ilForumPostDraft::moveDraftsByMergedThreads (   $source_thread_id,   $target_thread_id  )

static

Parameters

$source_thread_id
$target_thread_id

Definition at line 729 of file class.ilForumPostDraft.php.

References $DIC, and $ilDB.

    {
        global $DIC;
        $ilDB = $DIC->database();
        
        $ilDB->update(
            'frm_posts_drafts',
            array('thread_id' => array('integer', $target_thread_id)),
            array('thread_id' => array('integer', $source_thread_id))
        );
    }

moveDraftsByMovedThread()

static ilForumPostDraft::moveDraftsByMovedThread (   $thread_ids,   $source_ref_id,   $target_ref_id  )

static

Parameters

array	$thread_ids
int	$source_ref_id
int	$target_ref_id

Definition at line 746 of file class.ilForumPostDraft.php.

References $DIC, $ilDB, and ilObjForum\lookupForumIdByRefId().

    {
        global $DIC;
        $ilDB = $DIC->database();
        
        $source_forum_id = ilObjForum::lookupForumIdByRefId($source_ref_id);
        $target_forum_id = ilObjForum::lookupForumIdByRefId($target_ref_id);
        
        $ilDB->manipulateF(
            '
                        UPDATE  frm_posts_drafts 
                        SET     forum_id = %s 
                        WHERE   forum_id = %s 
                        AND ' . $ilDB->in('thread_id', $thread_ids, false, 'integer'),
            array('integer', 'integer'),
            array($target_forum_id, $source_forum_id)
        );
    }

Here is the call graph for this function:

newInstanceByDraftId()

static ilForumPostDraft::newInstanceByDraftId (   $draft_id )

static

Parameters

$draft_id

Returns

self

Definition at line 474 of file class.ilForumPostDraft.php.

References $DIC, $draft_id, $ilDB, and $res.

Referenced by ilObjForumGUI\addThreadObject(), ilObjForumGUI\cancelDraftObject(), ilObjForumGUI\cancelPostObject(), ilObjMediaObjectAccess\checkAccessMob(), ilObjForumGUI\checkDraftAccess(), ilObjForumGUI\deliverDraftZipFileObject(), ilFileDataForumDrafts\deliverZipFile(), ilForumAutoSaveAsyncDraftAction\executeAndGetResponseObject(), ilObjMediaObject\getParentObjectIdForUsage(), ilForumThreadFormGUI\initForm(), ilObjForumGUI\publishThreadDraftObject(), ilForumDraftsHistory\rollbackAutosave(), ilObjForumGUI\saveThreadAsDraftObject(), ilObjForumGUI\saveTopLevelDraftObject(), and ilObjForumGUI\updateThreadDraftObject().

    {
        global $DIC;
        $ilDB = $DIC->database();

        $res = $ilDB->queryF(
            'SELECT * FROM frm_posts_drafts WHERE draft_id = %s',
            array('integer'),
            array($draft_id)
        );
        
        $tmp_obj = new ilForumPostDraft();
        while ($row = $ilDB->fetchAssoc($res)) {
            self::populateWithDatabaseRecord($tmp_obj, $row);
        }
        return $tmp_obj;
    }

Here is the caller graph for this function:

newInstanceByHistorytId()

static ilForumPostDraft::newInstanceByHistorytId (   $history_id )

static

Parameters

$history_id

Returns

ilForumPostDraft

Exceptions

ilException

Definition at line 497 of file class.ilForumPostDraft.php.

References $DIC, $ilDB, and $res.

    {
        global $DIC;
        $ilDB = $DIC->database();

        $res = $ilDB->queryF(
            'SELECT * FROM frm_drafts_history WHERE history_id = %s',
            array('integer'),
            array($history_id)
        );

        while ($row = $ilDB->fetchAssoc($res)) {
            $tmp_obj = new ilForumPostDraft();
            self::populateWithDatabaseRecord($tmp_obj, $row);
            return $tmp_obj;
        }

        throw new ilException(sprintf("Could not find history object for id %s", $history_id));
    }

populateWithDatabaseRecord()

static ilForumPostDraft::populateWithDatabaseRecord ( ilForumPostDraft  $draft, array  $row  )

staticprotected

Parameters

$draft	ilForumPostDraft
$row	array

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

References setDraftId(), setForumId(), setNotify(), setPostAuthorId(), setPostDate(), setPostDisplayUserId(), setPostId(), setPostMessage(), setPostNotify(), setPostSubject(), setPostUpdate(), setPostUserAlias(), setThreadId(), and setUpdateUserId().

    {
        $draft->setDraftId($row['draft_id']);
        $draft->setForumId($row['forum_id']);
        $draft->setPostAuthorId($row['post_author_id']);
        $draft->setPostDate($row['post_date']);
        $draft->setPostDisplayUserId($row['pos_display_usr_id']);
        $draft->setPostId($row['post_id']);
        $draft->setPostMessage($row['post_message']);
        $draft->setPostSubject($row['post_subject']);
        $draft->setPostUpdate($row['post_update']);
        $draft->setPostUserAlias($row['post_user_alias']);
        $draft->setThreadId($row['thread_id']);
        $draft->setUpdateUserId($row['update_user_id']);
        $draft->setNotify($row['notify']);
        $draft->setPostNotify($row['post_notify']);
    }

Here is the call graph for this function:

readDraft()

ilForumPostDraft::readDraft ( )

protected

Definition at line 352 of file class.ilForumPostDraft.php.

References $res, getDraftId(), getPostAuthorId(), and getPostId().

Referenced by __construct().

    {
        $res = $this->db->queryF(
            'SELECT * FROM frm_posts_drafts WHERE post_author_id = %s AND post_id = %s AND draft_id = %s',
            array('integer', 'integer','integer'),
            array($this->getPostAuthorId(), $this->getPostId(), $this->getDraftId())
        );
        
        while ($row = $this->db->fetchAssoc($res)) {
            self::populateWithDatabaseRecord($this, $row);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

readDrafts()

static ilForumPostDraft::readDrafts (   $user_id )

staticprotected

Parameters

int

$user_id

Definition at line 368 of file class.ilForumPostDraft.php.

References $DIC, $ilDB, and $res.

    {
        global $DIC;
        $ilDB = $DIC->database();
        
        $res = $ilDB->queryF(
            'SELECT * FROM frm_posts_drafts WHERE post_author_id = %s',
            ['integer'],
            [$user_id]
        );

        self::$instances[$user_id] = [
            'draft_ids' => [],
        ];

        while ($row = $ilDB->fetchAssoc($res)) {
            $tmp_obj = new ilForumPostDraft();
            self::populateWithDatabaseRecord($tmp_obj, $row);
            self::$instances[$user_id][$row['thread_id']][$tmp_obj->getPostId()][] = $tmp_obj;
            self::$instances[$user_id]['draft_ids'][$tmp_obj->getDraftId()] = $tmp_obj;
        }
    }

saveDraft()

ilForumPostDraft::saveDraft

(

)

Definition at line 517 of file class.ilForumPostDraft.php.

References $draft_id, $post_date, getForumId(), getNotify(), getPostAuthorId(), getPostDisplayUserId(), getPostId(), getPostMessage(), getPostNotify(), getPostSubject(), getPostUserAlias(), getThreadId(), and setDraftId().

    {
        $draft_id = $this->db->nextId('frm_posts_drafts');
        $post_date = date("Y-m-d H:i:s");
        
        $this->db->insert('frm_posts_drafts', array(
            'draft_id' => array('integer', $draft_id),
            'post_id' => array('integer', $this->getPostId()),
            'thread_id' => array('integer', $this->getThreadId()),
            'forum_id' => array('integer', $this->getForumId()),
            'post_author_id' => array('integer', $this->getPostAuthorId()),
            'post_subject' => array('text', $this->getPostSubject()),
            'post_message' => array('clob', $this->getPostMessage()),
            'notify' => array('integer', $this->getNotify()),
            'post_notify' => array('integer', $this->getPostNotify()),
            'post_date' => array('timestamp', $post_date),
            'post_update' => array('timestamp', $post_date),
//                      'update_user_id' => array('integer', $this->getUpdateUserId()),
            'post_user_alias' => array('text', $this->getPostUserAlias()),
            'pos_display_usr_id' => array('integer', $this->getPostDisplayUserId())
        ));
        $this->setDraftId($draft_id);
        return $draft_id;
    }

Here is the call graph for this function:

setDraftId()

ilForumPostDraft::setDraftId

(

$draft_id

)

Parameters

int

$draft_id

Definition at line 133 of file class.ilForumPostDraft.php.

References $draft_id.

Referenced by __construct(), populateWithDatabaseRecord(), and saveDraft().

    {
        $this->draft_id = $draft_id;
    }

Here is the caller graph for this function:

setForumId()

ilForumPostDraft::setForumId

(

$forum_id

)

Parameters

int

$forum_id

Definition at line 165 of file class.ilForumPostDraft.php.

References $forum_id.

Referenced by populateWithDatabaseRecord().

    {
        $this->forum_id = $forum_id;
    }

Here is the caller graph for this function:

setNotify()

ilForumPostDraft::setNotify

(

$notify

)

Parameters

int

$notify

Definition at line 325 of file class.ilForumPostDraft.php.

References $notify.

Referenced by populateWithDatabaseRecord().

    {
        $this->notify = $notify;
    }

Here is the caller graph for this function:

setPostAuthorId()

ilForumPostDraft::setPostAuthorId

(

$post_author_id

)

Parameters

int

$post_author_id

Definition at line 293 of file class.ilForumPostDraft.php.

References $post_author_id.

Referenced by __construct(), and populateWithDatabaseRecord().

    {
        $this->post_author_id = $post_author_id;
    }

Here is the caller graph for this function:

setPostDate()

ilForumPostDraft::setPostDate

(

$post_date

)

Parameters

string

$post_date

Definition at line 229 of file class.ilForumPostDraft.php.

References $post_date.

Referenced by populateWithDatabaseRecord().

    {
        $this->post_date = $post_date;
    }

Here is the caller graph for this function:

setPostDisplayUserId()

ilForumPostDraft::setPostDisplayUserId

(

$post_display_user_id

)

Parameters

int

$post_display_user_id

Definition at line 309 of file class.ilForumPostDraft.php.

References $post_display_user_id.

Referenced by populateWithDatabaseRecord().

    {
        $this->post_display_user_id = $post_display_user_id;
    }

Here is the caller graph for this function:

setPostId()

ilForumPostDraft::setPostId

(

$post_id

)

Parameters

int

$post_id

Definition at line 149 of file class.ilForumPostDraft.php.

References $post_id.

Referenced by __construct(), and populateWithDatabaseRecord().

    {
        $this->post_id = $post_id;
    }

Here is the caller graph for this function:

setPostMessage()

ilForumPostDraft::setPostMessage

(

$post_message

)

Parameters

string

$post_message

Definition at line 213 of file class.ilForumPostDraft.php.

References $post_message.

Referenced by populateWithDatabaseRecord().

    {
        $this->post_message = $post_message;
    }

Here is the caller graph for this function:

setPostNotify()

ilForumPostDraft::setPostNotify

(

$post_notify

)

Parameters

int

$post_notify

Definition at line 117 of file class.ilForumPostDraft.php.

References $post_notify.

Referenced by populateWithDatabaseRecord().

    {
        $this->post_notify = $post_notify;
    }

Here is the caller graph for this function:

setPostSubject()

ilForumPostDraft::setPostSubject

(

$post_subject

)

Parameters

string

$post_subject

Definition at line 197 of file class.ilForumPostDraft.php.

References $post_subject.

Referenced by populateWithDatabaseRecord().

    {
        $this->post_subject = $post_subject;
    }

Here is the caller graph for this function:

setPostUpdate()

ilForumPostDraft::setPostUpdate

(

$post_update

)

Parameters

string

$post_update

Definition at line 245 of file class.ilForumPostDraft.php.

References $post_update.

Referenced by populateWithDatabaseRecord().

    {
        $this->post_update = $post_update;
    }

Here is the caller graph for this function:

setPostUserAlias()

ilForumPostDraft::setPostUserAlias

(

$post_user_alias

)

Parameters

string

$post_user_alias

Definition at line 277 of file class.ilForumPostDraft.php.

References $post_user_alias.

Referenced by populateWithDatabaseRecord().

    {
        $this->post_user_alias = $post_user_alias;
    }

Here is the caller graph for this function:

setThreadId()

ilForumPostDraft::setThreadId

(

$thread_id

)

Parameters

int

$thread_id

Definition at line 181 of file class.ilForumPostDraft.php.

References $thread_id.

Referenced by populateWithDatabaseRecord().

    {
        $this->thread_id = $thread_id;
    }

Here is the caller graph for this function:

setUpdateUserId()

ilForumPostDraft::setUpdateUserId

(

$update_user_id

)

Parameters

int

$update_user_id

Definition at line 261 of file class.ilForumPostDraft.php.

References $update_user_id.

Referenced by populateWithDatabaseRecord().

    {
        $this->update_user_id = $update_user_id;
    }

Here is the caller graph for this function:

updateDraft()

ilForumPostDraft::updateDraft

(

)

Definition at line 542 of file class.ilForumPostDraft.php.

References getDraftId(), getPostMessage(), getPostSubject(), and getPostUserAlias().

    {
        $this->db->update(
            'frm_posts_drafts',
            array(
            'post_subject' => array('text', $this->getPostSubject()),
            'post_message' => array('clob', $this->getPostMessage()),
            'post_user_alias' => array('text', $this->getPostUserAlias())
        ),
            array('draft_id' => array('integer', $this->getDraftId()))
        );
    }

Here is the call graph for this function:

Field Documentation

$draft_id

ilForumPostDraft::$draft_id = 0

protected

Definition at line 13 of file class.ilForumPostDraft.php.

Referenced by __construct(), createDraftBackup(), deleteDraftsByDraftIds(), deleteDraftsByPostIds(), deleteDraftsByUserId(), deleteMobsOfDraft(), getDraftId(), newInstanceByDraftId(), saveDraft(), and setDraftId().

$drafts_settings_cache

ilForumPostDraft::$drafts_settings_cache = array()

staticprotected

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

$forum_id

ilForumPostDraft::$forum_id = 0

protected

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

Referenced by getForumId(), getThreadDraftData(), and setForumId().

$forum_statistics_cache

ilForumPostDraft::$forum_statistics_cache = array()

staticprotected

Definition at line 77 of file class.ilForumPostDraft.php.

$instances

ilForumPostDraft::$instances = array()

staticprivate

Definition at line 71 of file class.ilForumPostDraft.php.

$notify

ilForumPostDraft::$notify = 0

protected

Definition at line 62 of file class.ilForumPostDraft.php.

Referenced by getNotify(), and setNotify().

$post_author_id

ilForumPostDraft::$post_author_id = 0

protected

Definition at line 53 of file class.ilForumPostDraft.php.

Referenced by getPostAuthorId(), getThreadDraftData(), and setPostAuthorId().

$post_date

ilForumPostDraft::$post_date = '0000-00-00 00:00:00'

protected

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

Referenced by getPostDate(), saveDraft(), and setPostDate().

$post_display_user_id

ilForumPostDraft::$post_display_user_id = 0

protected

Definition at line 57 of file class.ilForumPostDraft.php.

Referenced by getPostDisplayUserId(), and setPostDisplayUserId().

$post_id

ilForumPostDraft::$post_id = 0

protected

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

Referenced by __construct(), getPostId(), and setPostId().

$post_message

ilForumPostDraft::$post_message = ''

protected

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

Referenced by getPostMessage(), and setPostMessage().

$post_notify

ilForumPostDraft::$post_notify = 0

protected

Definition at line 66 of file class.ilForumPostDraft.php.

Referenced by getPostNotify(), and setPostNotify().

$post_subject

ilForumPostDraft::$post_subject = ''

protected

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

Referenced by getPostSubject(), and setPostSubject().

$post_update

ilForumPostDraft::$post_update = '0000-00-00 00:00:00'

protected

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

Referenced by getPostUpdate(), and setPostUpdate().

$post_user_alias

ilForumPostDraft::$post_user_alias = ''

protected

Definition at line 49 of file class.ilForumPostDraft.php.

Referenced by getPostUserAlias(), and setPostUserAlias().

$thread_id

ilForumPostDraft::$thread_id = 0

protected

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

Referenced by getInstancesByUserIdAndThreadId(), getThreadId(), and setThreadId().

$update_user_id

ilForumPostDraft::$update_user_id = 0

protected

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

Referenced by getUpdateUserId(), and setUpdateUserId().

MEDIAOBJECT_TYPE

const ilForumPostDraft::MEDIAOBJECT_TYPE = 'frm~d:html'

Definition at line 9 of file class.ilForumPostDraft.php.

Referenced by ilObjForumGUI\cancelDraftObject(), ilForumAutoSaveAsyncDraftAction\executeAndGetResponseObject(), and ilForumDraftsHistory\rollbackAutosave().

---

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

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