"TYPO3 4.0.1: recordHistory Class Reference", "datetime" => "Sat Dec 2 19:25:24 2006", "date" => "2 Dec 2006", "doxygenversion" => "1.4.6", "projectname" => "TYPO3 4.0.1", "projectnumber" => "4.0.1" ); get_header($doxygen_vars); ?>

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.

Constructor & Destructor Documentation

recordHistory::recordHistory (   ) 
 

Constructor for the class

Returns:
void

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

References t3lib_div::_GP(), and resolveShUid().

Member Function Documentation

recordHistory::createChangeLog (   ) 
 

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

Returns:
[type] ...

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

References $changeLog, 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 579 of file class.show_rechis.inc.

Referenced by main().

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

creates a link for the rollback

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

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

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

Referenced by displayMultipleDiff().

recordHistory::displayHistory (   ) 
 

Shows the full change log

Returns:
string HTML for list, wrapped in a table.

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

References t3lib_BEfunc::calcAge(), t3lib_BEfunc::cshItem(), t3lib_BEfunc::datetime(), generateTitle(), t3lib_BEfunc::getItemLabel(), t3lib_BEfunc::getPagesTSconfig(), t3lib_BEfunc::getRecordRaw(), t3lib_BEfunc::getUserNames(), linkPage(), renderDiff(), and t3lib_iconWorks::skinImg().

Referenced by main().

recordHistory::displayMultipleDiff (  $  diff  ) 
 

Displays a diff over multiple fields including rollback links

Parameters:
array difference array
Returns:
string HTML output

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

References createRollbackLink(), generateTitle(), and renderDiff().

Referenced by main().

recordHistory::displaySettings (   ) 
 

Displays settings

Returns:
string HTML code to modify settings

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

References 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 778 of file class.show_rechis.inc.

References 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:
string DB table name
integer UID of record
Returns:
array history data of the record

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

References $changeLog, and resolveElement().

Referenced by createChangeLog().

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

Creates a link to the same page.

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

Definition at line 814 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 $element, t3lib_div::_GP(), createChangeLog(), createMultipleDiff(), displayHistory(), displayMultipleDiff(), displaySettings(), t3lib_div::locationHeaderUrl(), performRollback(), and toggleHighlight().

recordHistory::performRollback (  $  diff  ) 
 

perform rollback

Parameters:
array diff array to rollback
Returns:
void private

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

References createChangeLog(), t3lib_div::makeInstance(), and removeFilefields().

Referenced by main().

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:
string Table name
array The data array
Returns:
array The modified data array private

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

References 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:
array sys_history entry record.
string The table name
integer If set to UID of record, display rollback links
Returns:
string HTML table private

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

References 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:
string table of input element
integer UID of record
Returns:
integer converted UID of record

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

References t3lib_BEfunc::getWorkspaceVersionOfRecord().

Referenced by getHistoryData().

recordHistory::resolveShUid (   ) 
 

resolve sh_uid (used from log)

Returns:
[type] ...

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

References t3lib_div::_GP().

Referenced by recordHistory().

recordHistory::toggleHighlight (  $  uid  ) 
 

toggles highlight state of record

Parameters:
integer uid of sys_history entry
Returns:
[type] ...

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

Referenced by main().

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