log("my log message") to log things, which greatly helps debugging
* - UpdraftPlus is licenced under the GPLv3 or later. In order to combine your backup method with UpdraftPlus, you will need to licence to anyone and everyone that you distribute it to in a compatible way.
*/
if (!defined('UPDRAFTPLUS_DIR')) die('No direct access allowed.');
if (!class_exists('UpdraftPlus_BackupModule')) updraft_try_include_file('methods/backup-module.php', 'require_once');
class UpdraftPlus_BackupModule_template extends UpdraftPlus_BackupModule {
/**
* backup method: takes an array, and shovels them off to the cloud storage
*
* @param Array $backup_array Array of files (basenames) to sent to remote storage
* @return Mixed - (boolean)false to indicate failure; otherwise, something to be passed back when deleting files
*/
public function backup($backup_array) {// phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable -- This is a template file and can be ignored
global $updraftplus;// phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable -- This is a template file and can be ignored
// foreach ($backup_array as $file) {
// Do our uploading stuff...
// If successful, then you must do this:
// $updraftplus->uploaded_file($file);
// }
}
/**
* This function lists the files found in the configured storage location
*
* @param String $match a substring to require (tested via strpos() !== false)
*
* @return Array - each file is represented by an array with entries 'name' and (optional) 'size'
*/
public function listfiles($match = 'backup_') {// phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable -- This is a template file and can be ignored
// This function needs to return an array of arrays. The keys for the sub-arrays are name (a path-less filename, i.e. a basename), (optional)size, and should be a list of matching files from the storage backend. A WP_Error object can also be returned; and the error code should be no_settings if that is relevant.
return array();
}
/**
* delete method: takes an array of file names (base name) or a single string, and removes them from the cloud storage
*
* @param string $files The specific files
* @param mixed $data Anything passed back from self::backup()
* @param array $sizeinfo Size information
* @return Boolean - whether the operation succeeded or not
*/
public function delete($files, $data = false, $sizeinfo = array()) {// phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable -- This is a template file and can be ignored
global $updraftplus;// phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable -- This is a template file and can be ignored
if (is_string($files)) $files = array($files);
}
/**
* download method: takes a file name (base name), and brings it back from the cloud storage into Updraft's directory
* You can register errors with $updraftplus->log("my error message", 'error')
*
* @param String $file The specific file to be downloaded from the Cloud Storage
*
* @return Boolean - success or failure state
*/
public function download($file) {// phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable -- This is a template file and can be ignored
global $updraftplus;// phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable -- This is a template file and can be ignored
}
public function get_supported_features() {
// This options format is handled via only accessing options via $this->get_options()
return array('multi_options', 'config_templates');
}
/**
* Get the configuration template, in Handlebars format.
* Note that logging is not available from this context; it will do nothing.
*
* @return String - the template, ready for substitutions to be carried out
*/
public function get_configuration_template() {
ob_start();
$classes = $this->get_css_classes();
?>