ilForumPostDraft Class Reference

Class ilForumPostDraft. More...

Collaboration diagram for ilForumPostDraft:

Public Member Functions
	__construct (int $user_id=0, int $post_id=0, int $draft_id=0)
	isPostNotificationEnabled ()
	setPostNotificationStatus (bool $post_notify)
	isNotificationEnabled ()
	setNotificationStatus (bool $notify)
	getDraftId ()
	setDraftId (int $draft_id)
	getPostId ()
	setPostId (int $post_id)
	getForumId ()
	setForumId (int $forum_id)
	getThreadId ()
	setThreadId (int $thread_id)
	getPostSubject ()
	setPostSubject (string $post_subject)
	getPostMessage ()
	setPostMessage (string $post_message)
	getPostDate ()
	setPostDate (string $post_date)
	getPostUpdate ()
	setPostUpdate (string $post_update)
	getUpdateUserId ()
	setUpdateUserId (int $update_user_id)
	getPostUserAlias ()
	setPostUserAlias (string $post_user_alias)
	getPostAuthorId ()
	setPostAuthorId (int $post_author_id)
	getPostDisplayUserId ()
	setPostDisplayUserId (int $post_display_user_id)
	saveDraft ()
	updateDraft ()
	deleteDraft ()
	deleteDraftsByPostIds (array $post_ids=[])
	deleteDraftsByDraftIds (array $draft_ids=[])

Static Public Member Functions
static	getSortedDrafts (int $usrId, int $threadId, int $sorting=ilForumProperties::VIEW_DATE_ASC)
static	getDraftInstancesByUserId (int $user_id)
static	newInstanceByDraftId (int $draft_id)
static	deleteMobsOfDraft (int $draft_id)
static	deleteDraftsByUserId (int $user_id)
static	isSavePostDraftAllowed ()
static	isAutoSavePostDraftAllowed ()
static	lookupAutosaveInterval ()
static	getDraftsStatisticsByRefId (int $ref_id)
static	moveDraftsByMergedThreads (int $source_thread_id, int $target_thread_id)
static	getThreadDraftData (int $post_author_id, int $forum_id)
static	createDraftBackup (int $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 (int $user_id)

Private Attributes
ilDBInterface	$db
int	$draft_id = 0
int	$post_id = 0
int	$forum_id = 0
int	$thread_id = 0
string	$post_subject = ''
string	$post_message = ''
string	$post_date = '0000-00-00 00:00:00'
string	$post_update = '0000-00-00 00:00:00'
int	$update_user_id = 0
string	$post_user_alias = ''
int	$post_author_id = 0
int	$post_display_user_id = 0
bool	$notify = false
bool	$post_notify = false

Static Private Attributes
static array	$instances = []
static array	$forum_statistics_cache = []
static array	$drafts_settings_cache = []

Detailed Description

Class ilForumPostDraft.

Author

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

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

Constructor & Destructor Documentation

__construct()

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

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

References $DIC, 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 ( int  $draft_id )

static

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

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

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

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

        $res = $ilDB->queryF(
            'SELECT * FROM frm_posts_drafts WHERE draft_id = %s',
            ['integer'],
            [$draft_id]
        );

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

        $history_obj = new ilForumDraftsHistory();
        $history_obj->deleteHistoryByDraftIds([$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 372 of file class.ilForumPostDraft.php.

References getDraftId().

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

deleteDraftsByDraftIds()

ilForumPostDraft::deleteDraftsByDraftIds

(

array

$draft_ids = []

)

Parameters

int[]

$draft_ids

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

                                                                 : void
    {
        foreach ($draft_ids as $draft_id) {
            self::deleteMobsOfDraft($draft_id);

            $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 = []

)

Parameters

int[]

$post_ids

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

References $res, and ILIAS\Repository\int().

                                                               : void
    {
        $draft_ids = [];
        $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[] = (int) $row['draft_id'];
        }

        foreach ($draft_ids as $draft_id) {
            self::deleteMobsOfDraft($draft_id);

            $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'
        ));
    }

Here is the call graph for this function:

deleteDraftsByUserId()

static ilForumPostDraft::deleteDraftsByUserId ( int  $user_id )

static

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

References $DIC, $ilDB, $res, and ILIAS\Repository\int().

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

        $res = $ilDB->queryF(
            'SELECT draft_id FROM frm_posts_drafts WHERE post_author_id = %s',
            ['integer'],
            [$user_id]
        );

        $draft_ids = [];
        while ($row = $ilDB->fetchAssoc($res)) {
            $draft_ids[] = (int) $row['draft_id'];
        }

        foreach ($draft_ids as $draft_id) {
            self::deleteMobsOfDraft($draft_id);

            $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',
            ['integer'],
            [$user_id]
        );
    }

Here is the call graph for this function:

deleteMobsOfDraft()

static ilForumPostDraft::deleteMobsOfDraft ( int  $draft_id )

static

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

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

                                                           : void
    {
        $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

(

)

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

References $draft_id.

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

                                : int
    {
        return $this->draft_id;
    }

Here is the caller graph for this function:

getDraftInstancesByUserId()

static ilForumPostDraft::getDraftInstancesByUserId ( int  $user_id )

static

Returns

ilForumPostDraft[]

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

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

                                                                  : array
    {
        if (!isset(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 ( int  $ref_id )

static

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

References $DIC, $ilDB, $ilUser, $ref_id, $res, ILIAS\Repository\int(), and ilObjForum\lookupForumIdByRefId().

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

                                                                  : array
    {
        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',
                ['integer', 'integer'],
                [$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()][(int) $row['thread_id']] = (int) $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

(

)

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

References $forum_id.

Referenced by saveDraft().

                                : int
    {
        return $this->forum_id;
    }

Here is the caller graph for this function:

getPostAuthorId()

ilForumPostDraft::getPostAuthorId

(

)

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

References $post_author_id.

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

                                     : int
    {
        return $this->post_author_id;
    }

Here is the caller graph for this function:

getPostDate()

ilForumPostDraft::getPostDate

(

)

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

References $post_date.

                                 : string
    {
        return $this->post_date;
    }

getPostDisplayUserId()

ilForumPostDraft::getPostDisplayUserId

(

)

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

References $post_display_user_id.

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

                                          : int
    {
        return $this->post_display_user_id;
    }

Here is the caller graph for this function:

getPostId()

ilForumPostDraft::getPostId

(

)

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

References $post_id.

Referenced by saveDraft().

                               : int
    {
        return $this->post_id;
    }

Here is the caller graph for this function:

getPostMessage()

ilForumPostDraft::getPostMessage

(

)

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

References $post_message.

Referenced by saveDraft(), and updateDraft().

                                    : string
    {
        return $this->post_message;
    }

Here is the caller graph for this function:

getPostSubject()

ilForumPostDraft::getPostSubject

(

)

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

References $post_subject.

Referenced by saveDraft(), and updateDraft().

                                    : string
    {
        return $this->post_subject;
    }

Here is the caller graph for this function:

getPostUpdate()

ilForumPostDraft::getPostUpdate

(

)

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

References $post_update.

                                   : string
    {
        return $this->post_update;
    }

getPostUserAlias()

ilForumPostDraft::getPostUserAlias

(

)

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

References $post_user_alias.

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

                                      : string
    {
        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

Returns

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

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

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

Referenced by ilObjForumGUI\viewThreadObject().

     : 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 ( int  $post_author_id, int  $forum_id  )

static

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

References $DIC, $ilDB, and $res.

Referenced by ilObjForumGUI\getContent().

                                                                                 : array
    {
        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',
            ['integer', 'integer', 'integer', 'integer'],
            [$post_author_id, $forum_id, 0, 0]
        );
        $draft_data = [];
        while ($row = $ilDB->fetchAssoc($res)) {
            $tmp_obj = new self();
            self::populateWithDatabaseRecord($tmp_obj, $row);
            $draft_data[] = ['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

(

)

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

References $thread_id.

Referenced by saveDraft().

                                 : int
    {
        return $this->thread_id;
    }

Here is the caller graph for this function:

getUpdateUserId()

ilForumPostDraft::getUpdateUserId

(

)

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

References $update_user_id.

Referenced by updateDraft().

                                     : int
    {
        return $this->update_user_id;
    }

Here is the caller graph for this function:

isAutoSavePostDraftAllowed()

static ilForumPostDraft::isAutoSavePostDraftAllowed ( )

static

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

References $DIC, and ILIAS\Repository\int().

Referenced by ilObjForumGUI\cancelDraftObject(), ilObjForumGUI\decorateWithAutosave(), ilObjForumGUI\doHistoryCheck(), ilObjForumGUI\editDraftObject(), ilForumAutoSaveAsyncDraftAction\executeAndGetResponseObject(), ilObjForumGUI\initReplyEditForm(), ilObjForumGUI\saveAsDraftObject(), and ilObjForumGUI\savePostObject().

                                                       : bool
    {
        if (!self::isSavePostDraftAllowed()) {
            return false;
        }

        if (!isset(self::$drafts_settings_cache['autosave_drafts'])) {
            global $DIC;

            self::$drafts_settings_cache['autosave_drafts'] = (bool) $DIC->settings()->get('autosave_drafts', '0');
            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 call graph for this function:

Here is the caller graph for this function:

isNotificationEnabled()

ilForumPostDraft::isNotificationEnabled

(

)

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

References $notify.

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

                                           : bool
    {
        return $this->notify;
    }

Here is the caller graph for this function:

isPostNotificationEnabled()

ilForumPostDraft::isPostNotificationEnabled

(

)

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

References $post_notify.

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

                                               : bool
    {
        return $this->post_notify;
    }

Here is the caller graph for this function:

isSavePostDraftAllowed()

static ilForumPostDraft::isSavePostDraftAllowed ( )

static

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

References $DIC.

Referenced by ilForumTopicTableGUI\__construct(), ilObjForumGUI\addEmptyThreadObject(), ilObjForumGUI\addThreadObject(), ilObjForumGUI\createTopLevelPostObject(), ilObjForumGUI\deleteSelectedDraft(), ilObjForumGUI\editThreadDraftObject(), ilForumThreadFormGUI\generateDefaultForm(), ilObjForumGUI\getContent(), ilObjForumListGUI\getProperties(), ilObjForumGUI\initReplyEditForm(), ilObjForumGUI\publishDraftObject(), ilObjForumGUI\publishThreadDraftObject(), ilObjForumGUI\saveAsDraftObject(), ilObjForumGUI\savePostObject(), ilObjForumGUI\saveThreadAsDraftObject(), ilObjForumGUI\updateDraftObject(), ilObjForumGUI\updateThreadDraftObject(), and ilObjForumGUI\viewThreadObject().

                                                   : bool
    {
        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', '0');
        }

        return self::$drafts_settings_cache['save_post_drafts'];
    }

Here is the caller graph for this function:

lookupAutosaveInterval()

static ilForumPostDraft::lookupAutosaveInterval ( )

static

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

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

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

Here is the caller graph for this function:

moveDraftsByMergedThreads()

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

static

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

References $DIC, and $ilDB.

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

        $ilDB->update(
            'frm_posts_drafts',
            ['thread_id' => ['integer', $target_thread_id]],
            ['thread_id' => ['integer', $source_thread_id]]
        );
    }

newInstanceByDraftId()

static ilForumPostDraft::newInstanceByDraftId ( int  $draft_id )

static

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

References $DIC, $ilDB, and $res.

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

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

        $res = $ilDB->queryF(
            'SELECT * FROM frm_posts_drafts WHERE draft_id = %s',
            ['integer'],
            [$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:

populateWithDatabaseRecord()

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

staticprotected

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

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

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

Here is the call graph for this function:

readDraft()

ilForumPostDraft::readDraft ( )

protected

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

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

Referenced by __construct().

                                  : void
    {
        $res = $this->db->queryF(
            'SELECT * FROM frm_posts_drafts WHERE post_author_id = %s AND draft_id = %s',
            ['integer', 'integer'],
            [$this->getPostAuthorId(), $this->getDraftId()]
        );

        if ($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 ( int  $user_id )

staticprotected

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

References $DIC, $ilDB, and $res.

                                                      : void
    {
        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 333 of file class.ilForumPostDraft.php.

References $draft_id, getForumId(), getPostAuthorId(), getPostDisplayUserId(), getPostId(), getPostMessage(), getPostSubject(), getPostUserAlias(), getThreadId(), isNotificationEnabled(), isPostNotificationEnabled(), and setDraftId().

                               : int
    {
        $draft_id = $this->db->nextId('frm_posts_drafts');
        $post_date = date("Y-m-d H:i:s");

        $this->db->insert('frm_posts_drafts', [
            'draft_id' => ['integer', $draft_id],
            'post_id' => ['integer', $this->getPostId()],
            'thread_id' => ['integer', $this->getThreadId()],
            'forum_id' => ['integer', $this->getForumId()],
            'post_author_id' => ['integer', $this->getPostAuthorId()],
            'post_subject' => ['text', $this->getPostSubject()],
            'post_message' => ['clob', $this->getPostMessage()],
            'notify' => ['integer', (int) $this->isNotificationEnabled()],
            'post_notify' => ['integer', (int) $this->isPostNotificationEnabled()],
            'post_date' => ['timestamp', $post_date],
            'post_update' => ['timestamp', $post_date],
            'post_user_alias' => ['text', $this->getPostUserAlias()],
            'pos_display_usr_id' => ['integer', $this->getPostDisplayUserId()]
        ]);
        $this->setDraftId($draft_id);
        return $draft_id;
    }

Here is the call graph for this function:

setDraftId()

ilForumPostDraft::setDraftId

(

int

$draft_id

)

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

References $draft_id.

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

                                             : void
    {
        $this->draft_id = $draft_id;
    }

Here is the caller graph for this function:

setForumId()

ilForumPostDraft::setForumId

(

int

$forum_id

)

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

References $forum_id.

Referenced by populateWithDatabaseRecord().

                                             : void
    {
        $this->forum_id = $forum_id;
    }

Here is the caller graph for this function:

setNotificationStatus()

ilForumPostDraft::setNotificationStatus

(

bool

$notify

)

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

References $notify.

Referenced by populateWithDatabaseRecord().

                                                       : void
    {
        $this->notify = $notify;
    }

Here is the caller graph for this function:

setPostAuthorId()

ilForumPostDraft::setPostAuthorId

(

int

$post_author_id

)

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

References $post_author_id.

Referenced by __construct(), and populateWithDatabaseRecord().

                                                        : void
    {
        $this->post_author_id = $post_author_id;
    }

Here is the caller graph for this function:

setPostDate()

ilForumPostDraft::setPostDate

(

string

$post_date

)

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

References $post_date.

Referenced by populateWithDatabaseRecord().

                                                  : void
    {
        $this->post_date = $post_date;
    }

Here is the caller graph for this function:

setPostDisplayUserId()

ilForumPostDraft::setPostDisplayUserId

(

int

$post_display_user_id

)

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

References $post_display_user_id.

Referenced by populateWithDatabaseRecord().

                                                                   : void
    {
        $this->post_display_user_id = $post_display_user_id;
    }

Here is the caller graph for this function:

setPostId()

ilForumPostDraft::setPostId

(

int

$post_id

)

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

References $post_id.

Referenced by __construct(), and populateWithDatabaseRecord().

                                           : void
    {
        $this->post_id = $post_id;
    }

Here is the caller graph for this function:

setPostMessage()

ilForumPostDraft::setPostMessage

(

string

$post_message

)

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

References $post_message.

Referenced by populateWithDatabaseRecord().

                                                        : void
    {
        $this->post_message = $post_message;
    }

Here is the caller graph for this function:

setPostNotificationStatus()

ilForumPostDraft::setPostNotificationStatus

(

bool

$post_notify

)

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

References $post_notify.

Referenced by populateWithDatabaseRecord().

                                                                : void
    {
        $this->post_notify = $post_notify;
    }

Here is the caller graph for this function:

setPostSubject()

ilForumPostDraft::setPostSubject

(

string

$post_subject

)

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

References $post_subject.

Referenced by populateWithDatabaseRecord(), and ilObjForumGUI\updateDraftObject().

                                                        : void
    {
        $this->post_subject = $post_subject;
    }

Here is the caller graph for this function:

setPostUpdate()

ilForumPostDraft::setPostUpdate

(

string

$post_update

)

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

References $post_update.

Referenced by populateWithDatabaseRecord().

                                                      : void
    {
        $this->post_update = $post_update;
    }

Here is the caller graph for this function:

setPostUserAlias()

ilForumPostDraft::setPostUserAlias

(

string

$post_user_alias

)

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

References $post_user_alias.

Referenced by populateWithDatabaseRecord().

                                                             : void
    {
        $this->post_user_alias = $post_user_alias;
    }

Here is the caller graph for this function:

setThreadId()

ilForumPostDraft::setThreadId

(

int

$thread_id

)

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

References $thread_id.

Referenced by populateWithDatabaseRecord().

                                               : void
    {
        $this->thread_id = $thread_id;
    }

Here is the caller graph for this function:

setUpdateUserId()

ilForumPostDraft::setUpdateUserId

(

int

$update_user_id

)

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

References $update_user_id.

Referenced by populateWithDatabaseRecord().

                                                        : void
    {
        $this->update_user_id = $update_user_id;
    }

Here is the caller graph for this function:

updateDraft()

ilForumPostDraft::updateDraft

(

)

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

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

                                 : void
    {
        $this->db->update(
            'frm_posts_drafts',
            [
                'post_subject' => ['text', $this->getPostSubject()],
                'post_message' => ['clob', $this->getPostMessage()],
                'post_user_alias' => ['text', $this->getPostUserAlias()],
                'post_update' => ['timestamp', date("Y-m-d H:i:s")],
                'update_user_id' => ['integer', $this->getUpdateUserId()],
            ],
            ['draft_id' => ['integer', $this->getDraftId()]]
        );
    }

Here is the call graph for this function:

Field Documentation

$db

ilDBInterface ilForumPostDraft::$db

private

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

$draft_id

int ilForumPostDraft::$draft_id = 0

private

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

Referenced by createDraftBackup(), getDraftId(), saveDraft(), and setDraftId().

$drafts_settings_cache

array ilForumPostDraft::$drafts_settings_cache = []

staticprivate

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

$forum_id

int ilForumPostDraft::$forum_id = 0

private

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

Referenced by getForumId(), and setForumId().

$forum_statistics_cache

array ilForumPostDraft::$forum_statistics_cache = []

staticprivate

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

$instances

array ilForumPostDraft::$instances = []

staticprivate

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

$notify

bool ilForumPostDraft::$notify = false

private

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

Referenced by isNotificationEnabled(), and setNotificationStatus().

$post_author_id

int ilForumPostDraft::$post_author_id = 0

private

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

Referenced by getPostAuthorId(), and setPostAuthorId().

$post_date

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

private

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

Referenced by getPostDate(), and setPostDate().

$post_display_user_id

int ilForumPostDraft::$post_display_user_id = 0

private

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

Referenced by getPostDisplayUserId(), and setPostDisplayUserId().

$post_id

int ilForumPostDraft::$post_id = 0

private

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

Referenced by getPostId(), and setPostId().

$post_message

string ilForumPostDraft::$post_message = ''

private

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

Referenced by getPostMessage(), and setPostMessage().

$post_notify

bool ilForumPostDraft::$post_notify = false

private

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

Referenced by isPostNotificationEnabled(), and setPostNotificationStatus().

$post_subject

string ilForumPostDraft::$post_subject = ''

private

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

Referenced by getPostSubject(), and setPostSubject().

$post_update

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

private

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

Referenced by getPostUpdate(), and setPostUpdate().

$post_user_alias

string ilForumPostDraft::$post_user_alias = ''

private

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

Referenced by getPostUserAlias(), and setPostUserAlias().

$thread_id

int ilForumPostDraft::$thread_id = 0

private

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

Referenced by getThreadId(), and setThreadId().

$update_user_id

int ilForumPostDraft::$update_user_id = 0

private

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

Referenced by getUpdateUserId(), and setUpdateUserId().

MEDIAOBJECT_TYPE

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

Definition at line 27 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