Function __global->make_backup

Definitions

sources/backup.php

  • Backend function to do a backup.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: object

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$file string No No required parameter N/A N/A The filename to backup to
$b_type string No No full full incremental N/A The type of backup to do
$max_size integer No No 100 N/A N/A The maximum size of a file to include in the backup
$callback ?mixed No No Null N/A N/A Callback to run on each iteration (null: none)

Returns

  • Success message
  • Type: Tempcode
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Backend function to do a backup.
 *
 * @param  string $file The filename to backup to
 * @param  string $b_type The type of backup to do
 * @set full incremental
 * @param  integer $max_size The maximum size of a file to include in the backup
 * @param  ?mixed $callback Callback to run on each iteration (null: none)
 * @return Tempcode Success message
 */
function make_backup(string $file, string $b_type = 'full', int $max_size = 100, $callback = null) : object