Class ilForumDraftHistory. More...

Collaboration diagram for ilForumDraftsHistory:

Public Member Functions
	getHistoryId ()

	setHistoryId (int $history_id)

	getDraftId ()

	setDraftId (int $draft_id)

	getPostSubject ()

	setPostSubject (string $post_subject)

	getPostMessage ()

	setPostMessage (string $post_message)

	getDraftDate ()

	setDraftDate (string $draft_date)

	__construct (int $history_id=0)

	delete ()

	populateWithFirstAutosaveByDraftId (int $draft_id)

	getLastAutosaveByDraftId (int $draft_id)

	addDraftToHistory ()

	deleteMobs ()

	rollbackAutosave ()

	deleteHistoryByPostIds (array $post_ids=[])

	deleteHistoryByDraftIds (array $draft_ids=[])

Static Public Member Functions
static	getInstancesByDraftId (int $draft_id)

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

Static Protected Member Functions
static	populateWithDatabaseRecord (ilForumDraftsHistory $history_draft, array $row)

Protected Attributes
string	$draft_date = '0000-00-00 00:00:00'

Private Member Functions
	readByHistoryId (int $history_id)

Private Attributes
readonly ilDBInterface	$db

int	$history_id = 0

int	$draft_id = 0

string	$post_subject = ''

string	$post_message = ''

Detailed Description

Class ilForumDraftHistory.

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

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

Constructor & Destructor Documentation

◆ __construct()

ilForumDraftsHistory::__construct ( int $history_id = 0 )

Definition at line 86 of file class.ilForumDraftsHistory.php.

    {
        global $DIC;
 
        $this->db = $DIC->database();
 
        if ($history_id > 0) {
            $this->readByHistoryId($history_id);
        }
    }

References $DIC, $history_id, and readByHistoryId().

Here is the call graph for this function:

Member Function Documentation

◆ addDraftToHistory()

ilForumDraftsHistory::addDraftToHistory ( )

Definition at line 195 of file class.ilForumDraftsHistory.php.

                                       : void
    {
        $next_id = $this->db->nextId('frm_drafts_history');
        $this->db->insert(
            'frm_drafts_history',
            [
                'history_id' => ['integer', $next_id],
                'draft_id' => ['integer', $this->getDraftId()],
                'post_subject' => ['text', $this->getPostSubject()],
                'post_message' => ['text', $this->getPostMessage()],
                'draft_date' => ['timestamp', date("Y-m-d H:i:s")]
            ]
        );
        $this->setHistoryId($next_id);
    }

◆ delete()

ilForumDraftsHistory::delete ( )

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

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

◆ deleteHistoryByDraftIds()

ilForumDraftsHistory::deleteHistoryByDraftIds ( array $draft_ids = [] )

Parameters

int[] $draft_ids

Definition at line 270 of file class.ilForumDraftsHistory.php.

                                                                  : void
    {
        if ($draft_ids !== []) {
            $res = $this->db->query(
                'SELECT history_id FROM frm_drafts_history  WHERE ' . $this->db->in('draft_id', $draft_ids, false, 'integer')
            );
 
            while ($row = $this->db->fetchAssoc($res)) {
                $this->setHistoryId((int) $row['history_id']);
                $this->deleteMobs();
            }
 
            $this->db->manipulate(
                'DELETE FROM frm_drafts_history WHERE ' . $this->db->in('draft_id', $draft_ids, false, 'integer')
            );
        }
    }

References $res.

◆ deleteHistoryByPostIds()

ilForumDraftsHistory::deleteHistoryByPostIds ( array $post_ids = [] )

Parameters

int[] $post_ids

Returns: int[] A list of deleted draft ids

Definition at line 247 of file class.ilForumDraftsHistory.php.

                                                                : array
    {
        $draft_ids = [];
        if ($post_ids !== []) {
            $res = $this->db->query('
                        SELECT frm_drafts_history.history_id, frm_drafts_history.draft_id 
                        FROM frm_posts_drafts 
                        INNER JOIN frm_drafts_history ON frm_posts_drafts.draft_id
                        WHERE ' . $this->db->in('post_id', $post_ids, false, 'integer'));
 
            while ($row = $this->db->fetchAssoc($res)) {
                $draft_ids[] = (int) $row['draft_id'];
            }
 
            $this->deleteHistoryByDraftIds($draft_ids);
        }
 
        return $draft_ids;
    }

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

Here is the call graph for this function:

◆ deleteMobs()

ilForumDraftsHistory::deleteMobs ( )

Definition at line 211 of file class.ilForumDraftsHistory.php.

                                : void
    {
        $oldMediaObjects = ilObjMediaObject::_getMobsOfObject('frm~h:html', $this->getHistoryId());
        foreach ($oldMediaObjects as $oldMob) {
            if (ilObjMediaObject::_exists($oldMob)) {
                ilObjMediaObject::_removeUsage($oldMob, 'frm~h:html', $this->getHistoryId());
                $mob_obj = new ilObjMediaObject($oldMob);
                $mob_obj->delete();
            }
        }
    }

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

Here is the call graph for this function:

◆ getDraftDate()

ilForumDraftsHistory::getDraftDate ( )

Definition at line 76 of file class.ilForumDraftsHistory.php.

                                  : string
    {
        return $this->draft_date;
    }

References $draft_date.

◆ getDraftId()

ilForumDraftsHistory::getDraftId ( )

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

                                : int
    {
        return $this->draft_id;
    }

References $draft_id.

◆ getHistoryId()

ilForumDraftsHistory::getHistoryId ( )

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

                                  : int
    {
        return $this->history_id;
    }

References $history_id.

◆ getInstancesByDraftId()

static ilForumDraftsHistory::getInstancesByDraftId ( int $draft_id )

static

Returns: ilForumDraftsHistory[]

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

                                                               : array
    {
        global $DIC;
 
        $ilDB = $DIC->database();
 
        $res = $ilDB->queryF(
            'SELECT * FROM frm_drafts_history WHERE draft_id = %s ORDER BY draft_date DESC',
            ['integer'],
            [$draft_id]
        );
        $instances = [];
        while ($row = $ilDB->fetchAssoc($res)) {
            $draftHistory = new self();
            $draftHistory = self::populateWithDatabaseRecord($draftHistory, $row);
 
            $instances[] = $draftHistory;
        }
 
        return $instances;
    }

References $DIC, $draft_id, $ilDB, $res, and populateWithDatabaseRecord().

Referenced by ilObjForumGUI\doHistoryCheck().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getLastAutosaveByDraftId()

ilForumDraftsHistory::getLastAutosaveByDraftId ( int $draft_id )

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

                                                           : void
    {
        $this->db->setLimit(1);
        $res = $this->db->queryF(
            'SELECT * FROM frm_drafts_history WHERE draft_id = %s ORDER BY history_id DESC',
            ['integer'],
            [$draft_id]
        );
 
        while ($row = $this->db->fetchAssoc($res)) {
            $this->setHistoryId((int) $row['history_id']);
            $this->setDraftId((int) $row['draft_id']);
            $this->setPostSubject($row['post_subject']);
            $this->setPostMessage($row['post_message']);
        }
    }

References $res.

◆ getPostMessage()

ilForumDraftsHistory::getPostMessage ( )

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

                                    : string
    {
        return $this->post_message;
    }

References $post_message.

◆ getPostSubject()

ilForumDraftsHistory::getPostSubject ( )

Definition at line 56 of file class.ilForumDraftsHistory.php.

                                    : string
    {
        return $this->post_subject;
    }

References $post_subject.

◆ populateWithDatabaseRecord()

static ilForumDraftsHistory::populateWithDatabaseRecord	(	ilForumDraftsHistory	$history_draft,
		array	$row
	)

staticprotected

Definition at line 139 of file class.ilForumDraftsHistory.php.

     : ilForumDraftsHistory {
        $history_draft->setHistoryId((int) $row['history_id']);
        $history_draft->setDraftId((int) $row['draft_id']);
        $history_draft->setPostMessage($row['post_message']);
        $history_draft->setPostSubject($row['post_subject']);
        $history_draft->setDraftDate($row['draft_date']);
 
        return $history_draft;
    }

Referenced by getInstancesByDraftId().

Here is the caller graph for this function:

◆ populateWithFirstAutosaveByDraftId()

ilForumDraftsHistory::populateWithFirstAutosaveByDraftId ( int $draft_id )

Definition at line 161 of file class.ilForumDraftsHistory.php.

                                                                     : void
    {
        $this->db->setLimit(1);
        $res = $this->db->queryF(
            'SELECT * FROM frm_drafts_history WHERE draft_id = %s ORDER BY history_id ASC',
            ['integer'],
            [$draft_id]
        );
 
        if ($row = $this->db->fetchAssoc($res)) {
            $this->setHistoryId((int) $row['history_id']);
            $this->setDraftId((int) $row['draft_id']);
            $this->setPostSubject($row['post_subject']);
            $this->setPostMessage($row['post_message']);
        }
    }

References $res.

◆ readByHistoryId()

ilForumDraftsHistory::readByHistoryId ( int $history_id )

private

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

                                                     : void
    {
        $res = $this->db->queryF(
            'SELECT * FROM frm_drafts_history WHERE history_id = %s',
            ['integer'],
            [$history_id]
        );
 
        while ($row = $this->db->fetchAssoc($res)) {
            $this->setHistoryId((int) $row['history_id']);
            $this->setDraftId((int) $row['draft_id']);
            $this->setPostMessage($row['post_message']);
            $this->setPostSubject($row['post_subject']);
            $this->setDraftDate($row['draft_date']);
        }
    }

References $history_id, $res, setDraftDate(), setDraftId(), setHistoryId(), setPostMessage(), and setPostSubject().

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ rollbackAutosave()

ilForumDraftsHistory::rollbackAutosave ( )

Definition at line 223 of file class.ilForumDraftsHistory.php.

                                      : ilForumPostDraft
    {
        $draft = ilForumPostDraft::newInstanceByDraftId($this->getDraftId());
        $draft->setPostSubject($this->getPostSubject());
        $draft->setPostMessage($this->getPostMessage());
 
        ilForumUtil::moveMediaObjects(
            $this->getPostMessage(),
            self::MEDIAOBJECT_TYPE,
            $this->getHistoryId(),
            ilForumPostDraft::MEDIAOBJECT_TYPE,
            $draft->getDraftId()
        );
 
        $draft->updateDraft();
        $this->deleteHistoryByDraftIds([$draft->getDraftId()]);
 
        return $draft;
    }

References ilForumPostDraft\MEDIAOBJECT_TYPE, ilForumUtil\moveMediaObjects(), and ilForumPostDraft\newInstanceByDraftId().

Here is the call graph for this function:

◆ setDraftDate()

ilForumDraftsHistory::setDraftDate ( string $draft_date )

Definition at line 81 of file class.ilForumDraftsHistory.php.

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

References $draft_date.

Referenced by readByHistoryId().

Here is the caller graph for this function:

◆ setDraftId()

ilForumDraftsHistory::setDraftId ( int $draft_id )

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

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

References $draft_id.

Referenced by readByHistoryId().

Here is the caller graph for this function:

◆ setHistoryId()

ilForumDraftsHistory::setHistoryId ( int $history_id )

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

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

References $history_id.

Referenced by readByHistoryId().

Here is the caller graph for this function:

◆ setPostMessage()

ilForumDraftsHistory::setPostMessage ( string $post_message )

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

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

References $post_message.

Referenced by readByHistoryId().

Here is the caller graph for this function:

◆ setPostSubject()

ilForumDraftsHistory::setPostSubject ( string $post_subject )

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

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

References $post_subject.

Referenced by readByHistoryId().

Here is the caller graph for this function:

Field Documentation

◆ $db

readonly ilDBInterface ilForumDraftsHistory::$db

private

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

◆ $draft_date

string ilForumDraftsHistory::$draft_date = '0000-00-00 00:00:00'

protected

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

Referenced by getDraftDate(), and setDraftDate().

◆ $draft_id

int ilForumDraftsHistory::$draft_id = 0

private

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

Referenced by getDraftId(), getInstancesByDraftId(), and setDraftId().

◆ $history_id

int ilForumDraftsHistory::$history_id = 0

private

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

Referenced by __construct(), getHistoryId(), readByHistoryId(), and setHistoryId().

◆ $post_message

string ilForumDraftsHistory::$post_message = ''

private

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

Referenced by getPostMessage(), and setPostMessage().

◆ $post_subject

string ilForumDraftsHistory::$post_subject = ''

private

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

Referenced by getPostSubject(), and setPostSubject().

◆ MEDIAOBJECT_TYPE

const ilForumDraftsHistory::MEDIAOBJECT_TYPE = 'frm~h:html'

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

Referenced by ilObjForumGUI\cancelDraftObject(), ilForumPostDraft\createDraftBackup(), and ilForumAutoSaveAsyncDraftAction\executeAndGetResponseObject().

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

components/ILIAS/Forum/classes/class.ilForumDraftsHistory.php

Public Member Functions

Static Public Member Functions

Data Fields

Static Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addDraftToHistory()

◆ delete()

◆ deleteHistoryByDraftIds()

◆ deleteHistoryByPostIds()

◆ deleteMobs()

◆ getDraftDate()

◆ getDraftId()

◆ getHistoryId()

◆ getInstancesByDraftId()

◆ getLastAutosaveByDraftId()

◆ getPostMessage()

◆ getPostSubject()

◆ populateWithDatabaseRecord()

◆ populateWithFirstAutosaveByDraftId()

◆ readByHistoryId()

◆ rollbackAutosave()

◆ setDraftDate()

◆ setDraftId()

◆ setHistoryId()

◆ setPostMessage()

◆ setPostSubject()

Field Documentation

◆ $db

◆ $draft_date

◆ $draft_id

◆ $history_id

◆ $post_message

◆ $post_subject

◆ MEDIAOBJECT_TYPE