Class ilForumDraftHistory. More...

Collaboration diagram for ilForumDraftsHistory:

Public Member Functions
	getHistoryId ()

	setHistoryId ($history_id)

	getDraftId ()

	setDraftId ($draft_id)

	getPostSubject ()

	setPostSubject ($post_subject)

	getPostMessage ()

	setPostMessage ($post_message)

	getDraftDate ()

	setDraftDate ($draft_date)

	__construct ($history_id=0)
	ilForumDraftsHistory constructor. More...

	delete ()

	getFirstAutosaveByDraftId ($draft_id)

	getLastAutosaveByDraftId ($draft_id)

	addDraftToHistory ()

	addMobsToDraftsHistory ($message)

	deleteMobs ()

	rollbackAutosave ()

	deleteHistoryByPostIds ($post_ids=array())

	deleteHistoryByDraftIds ($draft_ids=array())

Static Public Member Functions
static	getInstancesByDraftId ($draft_id)

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

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

Protected Attributes
	$history_id = 0

	$draft_id = 0

	$post_subject = ''

	$post_message = ''

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

Private Member Functions
	readByHistoryId ($history_id)

Detailed Description

Class ilForumDraftHistory.

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

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

Constructor & Destructor Documentation

◆ __construct()

ilForumDraftsHistory::__construct ( $history_id = 0 )

ilForumDraftsHistory constructor.

Parameters

int $history_id

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

        {
                if(isset($history_id) && $history_id > 0 )
                {
                        $this->readByHistoryId($history_id);            
                }       
        }

References $history_id, and readByHistoryId().

Here is the call graph for this function:

Member Function Documentation

◆ addDraftToHistory()

ilForumDraftsHistory::addDraftToHistory ( )

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

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

References $ilDB, date, getDraftId(), getPostMessage(), getPostSubject(), and setHistoryId().

Here is the call graph for this function:

◆ addMobsToDraftsHistory()

ilForumDraftsHistory::addMobsToDraftsHistory ( $message )

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

        {
                // copy temporary media objects (frm~)
                include_once 'Services/MediaObjects/classes/class.ilObjMediaObject.php';
                $mediaObjects = ilRTE::_getMediaObjects($this->getPostMessage(), 0);
                
                $myMediaObjects = ilObjMediaObject::_getMobsOfObject('frm~h:html', $this->getHistoryId());
                foreach($mediaObjects as $mob)
                {
                        foreach($myMediaObjects as $myMob)
                        {
                                if($mob == $myMob)
                                {
                                        // change usage
                                        ilObjMediaObject::_removeUsage($mob, 'frm~h:html', $this->getHistoryId());
                                        break;
                                }
                        }
                        ilObjMediaObject::_saveUsage($mob, 'frm~h:html', $this->getHistoryId());
                }
        }

References ilRTE\_getMediaObjects(), ilObjMediaObject\_getMobsOfObject(), ilObjMediaObject\_removeUsage(), ilObjMediaObject\_saveUsage(), getHistoryId(), and getPostMessage().

Here is the call graph for this function:

◆ delete()

ilForumDraftsHistory::delete ( )

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

        {
                global $ilDB;
                
                $ilDB->manipulatef('DELETE FROM frm_drafts_history WHERE history_id = %s',
                        array('integer'), array($this->getHistoryId()));
        }

References $ilDB, and getHistoryId().

Here is the call graph for this function:

◆ deleteHistoryByDraftIds()

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

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

        {
                global $ilDB;
                
                if(count($draft_ids) > 0)
                {
                        $res  = $ilDB->query('SELECT history_id FROM frm_drafts_history 
                                        WHERE ' . $ilDB->in('draft_id', $draft_ids, false, 'integer'));
                        
                        while($row = $ilDB->fetchAssoc($res))
                        {
                                $this->setHistoryId($row['history_id']);
                                $this->deleteMobs();
                        }
                        
                        $ilDB->manipulate('DELETE FROM frm_drafts_history WHERE '
                                        . $ilDB->in('draft_id', $draft_ids, false, 'integer'));
                }
        }

References $ilDB, $res, $row, deleteMobs(), and setHistoryId().

Referenced by deleteHistoryByPostIds(), and rollbackAutosave().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ deleteHistoryByPostIds()

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

Parameters

array $post_ids

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

        {
                $draft_ids = array();
                if(count($post_ids) > 0)
                {
                        global $ilDB;
                        
                        $res  = $ilDB->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 ' . $ilDB->in('post_id', $post_ids, false, 'integer'));
                        
                        while($row = $ilDB->fetchAssoc($res))
                        {
                                $draft_ids[] = $row['draft_id'];
                        }
                        
                        $this->deleteHistoryByDraftIds($draft_ids);
                }
                return $draft_ids;
        }

References $ilDB, $res, $row, and deleteHistoryByDraftIds().

Here is the call graph for this function:

◆ deleteMobs()

ilForumDraftsHistory::deleteMobs ( )

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

        {
                require_once 'Services/MediaObjects/classes/class.ilObjMediaObject.php';
                // delete mobs of draft history
                $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(), ilObjMediaObject\_removeUsage(), and getHistoryId().

Referenced by deleteHistoryByDraftIds().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getDraftDate()

ilForumDraftsHistory::getDraftDate ( )

Returns: string

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

        {
                return $this->draft_date;
        }

References $draft_date.

◆ getDraftId()

ilForumDraftsHistory::getDraftId ( )

Returns: int

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

        {
                return $this->draft_id;
        }

References $draft_id.

Referenced by addDraftToHistory(), and rollbackAutosave().

Here is the caller graph for this function:

◆ getFirstAutosaveByDraftId()

ilForumDraftsHistory::getFirstAutosaveByDraftId ( $draft_id )

Parameters

$draft_id

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

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

References $draft_id, $ilDB, $res, $row, setDraftId(), setHistoryId(), setPostMessage(), and setPostSubject().

Here is the call graph for this function:

◆ getHistoryId()

ilForumDraftsHistory::getHistoryId ( )

Returns: int

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

        {
                return $this->history_id;
        }

References $history_id.

Referenced by addMobsToDraftsHistory(), delete(), deleteMobs(), and rollbackAutosave().

Here is the caller graph for this function:

◆ getInstancesByDraftId()

static ilForumDraftsHistory::getInstancesByDraftId ( $draft_id )

static

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

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

References $draft_id, $ilDB, $res, $row, 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 ( $draft_id )

Parameters

$draft_id

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

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

References $draft_id, $ilDB, $res, $row, setDraftId(), setHistoryId(), setPostMessage(), and setPostSubject().

Here is the call graph for this function:

◆ getPostMessage()

ilForumDraftsHistory::getPostMessage ( )

Returns: string

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

        {
                return $this->post_message;
        }

References $post_message.

Referenced by addDraftToHistory(), addMobsToDraftsHistory(), and rollbackAutosave().

Here is the caller graph for this function:

◆ getPostSubject()

ilForumDraftsHistory::getPostSubject ( )

Returns: string

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

        {
                return $this->post_subject;
        }

References $post_subject.

Referenced by addDraftToHistory(), and rollbackAutosave().

Here is the caller graph for this function:

◆ populateWithDatabaseRecord()

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

staticprotected

Parameters

$draft	ilForumPostDraft
$row	array

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

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

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

Referenced by getInstancesByDraftId().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readByHistoryId()

ilForumDraftsHistory::readByHistoryId ( $history_id )

private

Parameters

$history_id

Returns: ilForumDraftsHistory

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

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

References $history_id, $ilDB, $res, $row, 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 279 of file class.ilForumDraftsHistory.php.

        {
                $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(array($draft->getDraftId()));
                
                return $draft;
        }

References deleteHistoryByDraftIds(), getDraftId(), getHistoryId(), getPostMessage(), getPostSubject(), ilForumPostDraft\MEDIAOBJECT_TYPE, and ilForumUtil\moveMediaObjects().

Here is the call graph for this function:

◆ setDraftDate()

ilForumDraftsHistory::setDraftDate ( $draft_date )

Parameters

string $draft_date

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

        {
                $this->draft_date = $draft_date;
        }

References $draft_date.

Referenced by populateWithDatabaseRecord(), and readByHistoryId().

Here is the caller graph for this function:

◆ setDraftId()

ilForumDraftsHistory::setDraftId ( $draft_id )

Parameters

int $draft_id

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

        {
                $this->draft_id = $draft_id;
        }

References $draft_id.

Referenced by getFirstAutosaveByDraftId(), getLastAutosaveByDraftId(), populateWithDatabaseRecord(), and readByHistoryId().

Here is the caller graph for this function:

◆ setHistoryId()

ilForumDraftsHistory::setHistoryId ( $history_id )

Parameters

int $history_id

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

        {
                $this->history_id = $history_id;
        }

References $history_id.

Referenced by addDraftToHistory(), deleteHistoryByDraftIds(), getFirstAutosaveByDraftId(), getLastAutosaveByDraftId(), populateWithDatabaseRecord(), and readByHistoryId().

Here is the caller graph for this function:

◆ setPostMessage()

ilForumDraftsHistory::setPostMessage ( $post_message )

Parameters

string $post_message

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

        {
                $this->post_message = $post_message;
        }

References $post_message.

Referenced by getFirstAutosaveByDraftId(), getLastAutosaveByDraftId(), populateWithDatabaseRecord(), and readByHistoryId().

Here is the caller graph for this function:

◆ setPostSubject()

ilForumDraftsHistory::setPostSubject ( $post_subject )

Parameters

string $post_subject

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

        {
                $this->post_subject = $post_subject;
        }

References $post_subject.

Referenced by getFirstAutosaveByDraftId(), getLastAutosaveByDraftId(), populateWithDatabaseRecord(), and readByHistoryId().

Here is the caller graph for this function:

Field Documentation

◆ $draft_date

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

protected

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

Referenced by getDraftDate(), and setDraftDate().

◆ $draft_id

ilForumDraftsHistory::$draft_id = 0

protected

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

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

◆ $history_id

ilForumDraftsHistory::$history_id = 0

protected

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

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

◆ $post_message

ilForumDraftsHistory::$post_message = ''

protected

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

Referenced by getPostMessage(), and setPostMessage().

◆ $post_subject

ilForumDraftsHistory::$post_subject = ''

protected

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

Referenced by getPostSubject(), and setPostSubject().

◆ MEDIAOBJECT_TYPE

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

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

Referenced by ilObjForumGUI\autosaveDraftAsyncObject(), ilObjForumGUI\autosaveThreadDraftAsyncObject(), ilObjForumGUI\cancelDraftObject(), and ilForumPostDraft\createDraftBackup().

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

Modules/Forum/classes/class.ilForumDraftsHistory.php

Public Member Functions

Static Public Member Functions

Data Fields

Static Protected Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addDraftToHistory()

◆ addMobsToDraftsHistory()

◆ delete()

◆ deleteHistoryByDraftIds()

◆ deleteHistoryByPostIds()

◆ deleteMobs()

◆ getDraftDate()

◆ getDraftId()

◆ getFirstAutosaveByDraftId()

◆ getHistoryId()

◆ getInstancesByDraftId()

◆ getLastAutosaveByDraftId()

◆ getPostMessage()

◆ getPostSubject()

◆ populateWithDatabaseRecord()

◆ readByHistoryId()

◆ rollbackAutosave()

◆ setDraftDate()

◆ setDraftId()

◆ setHistoryId()

◆ setPostMessage()

◆ setPostSubject()

Field Documentation

◆ $draft_date

◆ $draft_id

◆ $history_id

◆ $post_message

◆ $post_subject

◆ MEDIAOBJECT_TYPE