Function RevisionEngineFiles->delete_revision

Definitions

sources/revisions_engine_files.php

  • Delete a particular 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
$id TIME No No required parameter N/A N/A Revision ID

Preview

Code (PHP)

/**
 * Delete a particular 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  TIME $id Revision ID
 */
public function delete_revision(string $directory, string $filename_id, string $ext, int $id)