TYPO3 API  SVNRelease
Public Member Functions | Public Attributes
recordHistory Class Reference

List of all members.

Public Member Functions

 recordHistory ()
 main ()
 toggleHighlight ($uid)
 performRollback ($diff)
 displaySettings ()
 displayHistory ()
 displayMultipleDiff ($diff)
 renderDiff ($entry, $table, $rollbackUid=0)
 createMultipleDiff ()
 createChangeLog ()
 getHistoryData ($table, $uid)
 generateTitle ($table, $uid)
 createRollbackLink ($key, $alt='', $type=0)
 linkPage ($str, $inparams=array(), $anchor='', $title='')
 removeFilefields ($table, $dataArray)
 resolveElement ($table, $uid)
 resolveShUid ()

Public Attributes

 $maxSteps = 20
 $showDiff = 1
 $showSubElements = 1
 $showInsertDelete = 1
 $element
 $lastSyslogId
 $returnUrl
 $changeLog
 $showMarked = FALSE

Detailed Description

Definition at line 45 of file class.show_rechis.inc.


Member Function Documentation

recordHistory::createChangeLog ( )

Creates change log including sub-elements, filling $this->changeLog

Returns:
[type] ...

Definition at line 646 of file class.show_rechis.inc.

References $changeLog, $GLOBALS, $res, $row, $TCA, $value, and getHistoryData().

Referenced by main(), and performRollback().

recordHistory::createMultipleDiff ( )

Creates a diff between the current version of the records and the selected version

Returns:
array diff for many elements

Definition at line 585 of file class.show_rechis.inc.

References $value.

Referenced by main().

recordHistory::createRollbackLink ( key,
alt = '',
type = 0 
)

creates a link for the rollback

Parameters:
stingparameter which is set to rollbackFields
stringoptional, alternative label and title tag of image
integeroptional, type of rollback: 0 - ALL; 1 - element; 2 - field
Returns:
string HTML output

Definition at line 802 of file class.show_rechis.inc.

References linkPage(), and t3lib_iconWorks\skinImg().

Referenced by displayMultipleDiff().

recordHistory::displayHistory ( )
recordHistory::displayMultipleDiff ( diff)

Displays a diff over multiple fields including rollback links

Parameters:
arraydifference array
Returns:
string HTML output

Definition at line 489 of file class.show_rechis.inc.

References $content, $SOBE, createRollbackLink(), generateTitle(), and renderDiff().

Referenced by main().

recordHistory::displaySettings ( )

Displays settings

Returns:
string HTML code to modify settings

Definition at line 269 of file class.show_rechis.inc.

References $BE_USER, $content, $pid, $SOBE, t3lib_div\_GP(), t3lib_BEfunc\getRecordRaw(), and linkPage().

Referenced by main().

recordHistory::generateTitle ( table,
uid 
)

generates the title and puts the record title behind

Parameters:
[type]$table: ...
[type]$uid: ...
Returns:
[type] ...

Definition at line 784 of file class.show_rechis.inc.

References $TCA, and t3lib_BEfunc\getRecordRaw().

Referenced by displayHistory(), and displayMultipleDiff().

recordHistory::getHistoryData ( table,
uid 
)

Gets history and delete/insert data from sys_log and sys_history

Parameters:
stringDB table name
integerUID of record
Returns:
array history data of the record

Definition at line 682 of file class.show_rechis.inc.

References $changeLog, $GLOBALS, $res, $row, $TCA, debug(), and resolveElement().

Referenced by createChangeLog().

recordHistory::linkPage ( str,
inparams = array(),
anchor = '',
title = '' 
)

Creates a link to the same page.

Parameters:
stringString to wrap in tags (must be htmlspecialchars()'ed prior to calling function)
arrayArray of key/value pairs to override the default values with.
stringPossible anchor value.
stringPossible title.
Returns:
string Link. private

Definition at line 818 of file class.show_rechis.inc.

Referenced by createRollbackLink(), displayHistory(), and displaySettings().

recordHistory::main ( )

Main function for the listing of history. It detects incoming variables like element reference, history element uid etc. and renders the correct screen.

Returns:
HTML content for the module

Definition at line 81 of file class.show_rechis.inc.

References $content, $element, $GLOBALS, $res, t3lib_div\_GP(), createChangeLog(), createMultipleDiff(), displayHistory(), displayMultipleDiff(), displaySettings(), performRollback(), t3lib_utility_Http\redirect(), and toggleHighlight().

recordHistory::performRollback ( diff)

perform rollback

Parameters:
arraydiff array to rollback
Returns:
void private

Definition at line 155 of file class.show_rechis.inc.

References $value, createChangeLog(), t3lib_div\makeInstance(), and removeFilefields().

Referenced by main().

recordHistory::recordHistory ( )

Constructor for the class

Returns:
void

Definition at line 65 of file class.show_rechis.inc.

References t3lib_div\_GP(), resolveShUid(), and t3lib_div\sanitizeLocalUrl().

recordHistory::removeFilefields ( table,
dataArray 
)

Will traverse the field names in $dataArray and look in $TCA if the fields are of types which cannot be handled by the sys_history (that is currently group types with internal_type set to "file")

Parameters:
stringTable name
arrayThe data array
Returns:
array The modified data array private

Definition at line 843 of file class.show_rechis.inc.

References $TCA, and t3lib_div\loadTCA().

Referenced by performRollback().

recordHistory::renderDiff ( entry,
table,
rollbackUid = 0 
)

Renders HTML table-rows with the comparison information of an sys_history entry record

Parameters:
arraysys_history entry record.
stringThe table name
integerIf set to UID of record, display rollback links
Returns:
string HTML table private

Definition at line 539 of file class.show_rechis.inc.

References $content, $SOBE, $TCA, t3lib_BEfunc\getItemLabel(), t3lib_BEfunc\getProcessedValue(), t3lib_div\loadTCA(), and t3lib_div\makeInstance().

Referenced by displayHistory(), and displayMultipleDiff().

recordHistory::resolveElement ( table,
uid 
)

Convert input element reference to workspace version if any.

Parameters:
stringtable of input element
integerUID of record
Returns:
integer converted UID of record

Definition at line 865 of file class.show_rechis.inc.

References $GLOBALS, and t3lib_BEfunc\getWorkspaceVersionOfRecord().

Referenced by getHistoryData().

recordHistory::resolveShUid ( )

resolve sh_uid (used from log)

Returns:
[type] ...

Definition at line 879 of file class.show_rechis.inc.

References $GLOBALS, $res, and t3lib_div\_GP().

Referenced by recordHistory().

recordHistory::toggleHighlight ( uid)

toggles highlight state of record

Parameters:
integeruid of sys_history entry
Returns:
[type] ...

Definition at line 136 of file class.show_rechis.inc.

References $GLOBALS, and $res.

Referenced by main().


Member Data Documentation

recordHistory::$changeLog

Definition at line 58 of file class.show_rechis.inc.

Referenced by createChangeLog(), and getHistoryData().

recordHistory::$element

Definition at line 53 of file class.show_rechis.inc.

Referenced by main().

recordHistory::$lastSyslogId

Definition at line 54 of file class.show_rechis.inc.

recordHistory::$maxSteps = 20

Definition at line 47 of file class.show_rechis.inc.

recordHistory::$returnUrl

Definition at line 55 of file class.show_rechis.inc.

recordHistory::$showDiff = 1

Definition at line 48 of file class.show_rechis.inc.

recordHistory::$showInsertDelete = 1

Definition at line 50 of file class.show_rechis.inc.

recordHistory::$showMarked = FALSE

Definition at line 59 of file class.show_rechis.inc.

recordHistory::$showSubElements = 1

Definition at line 49 of file class.show_rechis.inc.


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