Current File : //backups/router/usr/local/opnsense/mvc/app/library/OPNsense/Backup/IBackupProvider.php
<?php
/**
* Copyright (C) 2018 Deciso B.V.
*
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
* INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
* AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
* AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
* OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
*/
namespace OPNsense\Backup;
/**
* Interface for backup connectors
* @package OPNsense\Backup
*/
interface IBackupProvider
{
/**
* get required (user interface) fields for backup connector, ideally these should be stored in a model
* but for backwards compatibility reasons we delegate the decision what to use to the backup class.
* @return array configuration fields, types and description
*/
public function getConfigurationFields();
/**
* validate and set configuration
* @param array $conf configuration array
* @return array of validation errors
*/
public function setConfiguration($conf);
/**
* backup provider name
* @return string user friendly name
*/
public function getName();
/**
* Perform actual backup
* @return array filelist
*/
public function backup();
/**
* Is this provider enabled
* @return boolean enabled status
*/
public function isEnabled();
}
Mini Shell