Function RevisionEngineFiles->ui_revisions_controller

Definitions

sources/revisions_engine_files.php

  • Browse revisions to undo one.More details are shown in the actionlog, which is linked from here.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: object

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$directory PATH No No required parameter N/A N/A Directory where revisions are stored
$filename_id string No No required parameter N/A N/A ID of what was revised (=base filename, no extension)
$ext string No No required parameter N/A N/A File extension for revisable files
$action string No No required parameter N/A N/A The action the revision is for, a language string
&$text string Yes No required parameter N/A N/A Current resource text (may be altered by reference)
&$revision_loaded ?boolean Yes No Null N/A N/A Whether a revision was loaded, passed by reference (null: initial value)

Returns

  • UI
  • Type: Tempcode
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Browse revisions to undo one.More details are shown in the actionlog, which is linked from here.
 *
 * @param  PATH $directory Directory where revisions are stored
 * @param  string $filename_id ID of what was revised (=base filename, no extension)
 * @param  string $ext File extension for revisable files
 * @param  string $action The action the revision is for, a language string
 * @param  string $text Current resource text (may be altered by reference)
 * @param  ?boolean $revision_loaded Whether a revision was loaded, passed by reference (null: initial value)
 * @return Tempcode UI
 */
public function ui_revisions_controller(string $directory, string $filename_id, string $ext, string $action, string &$text, ?bool &$revision_loaded = null) : object