Function RevisionEngineFiles->add_revision

Definitions

sources/revisions_engine_files.php

  • Add a revision.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No

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 is being revised (=base filename, no extension)
$ext string No No required parameter N/A N/A File extension for revisable files
$original_text ?string No No required parameter N/A N/A Text before revision (null: work out from disk)
$original_timestamp ?TIME No No required parameter N/A N/A The creation timestamp for what was just replaced (null: work out from disk)

Preview

Code (PHP)

/**
 * Add a revision.
 *
 * @param  PATH $directory Directory where revisions are stored
 * @param  string $filename_id ID of what is being revised (=base filename, no extension)
 * @param  string $ext File extension for revisable files
 * @param  ?string $original_text Text before revision (null: work out from disk)
 * @param  ?TIME $original_timestamp The creation timestamp for what was just replaced (null: work out from disk)
 */
public function add_revision(string $directory, string $filename_id, string $ext, ?string $original_text, ?int $original_timestamp)