adding docs

This commit is contained in:
Shikiryu 2015-07-12 20:53:15 +02:00
parent 8426972504
commit 085f9ae152
5 changed files with 59 additions and 45 deletions

View File

@ -54,7 +54,7 @@ class BackupAbstract
* *
* @return $this * @return $this
*/ */
function addDate($format = 'Ymd') public function addDate($format = 'Ymd')
{ {
$tmpFiles = array(); $tmpFiles = array();
foreach ($this->_filesToBackup as $file => $name) { foreach ($this->_filesToBackup as $file => $name) {
@ -82,7 +82,7 @@ class BackupAbstract
* *
* @return $this * @return $this
*/ */
function addTime($format = 'his') public function addTime($format = 'his')
{ {
$tmpFiles = array(); $tmpFiles = array();
foreach ($this->_filesToBackup as $file => $name) { foreach ($this->_filesToBackup as $file => $name) {
@ -108,30 +108,6 @@ class BackupAbstract
} }
/**
* @param $folder
*/
function backupToFolder($folder)
{
if (!empty($folder)) {
$folder = sprintf('%s/', rtrim($folder, '/'));
}
// if($folder != '')
// {
// if(substr($folder, 0, -1) != '/')
// $folder .= '/';
// }
foreach ($this->_filesToBackup as $file => $name) {
copy($file, $folder . $name);
}
foreach ($this->_streamsToBackup as $name => $file) {
if (count(explode('.', $name)) < 2) {
$name = 'backup' . $name . '.txt';
}
file_put_contents($folder . $name, $file);
}
}
/** /**
* Check if all files got the minimum given size. * Check if all files got the minimum given size.
* *
@ -157,10 +133,7 @@ class BackupAbstract
/** /**
* @return bool * @return bool
*/ */
public function isValid() abstract public function isValid();
{
return true;
}
} }

View File

@ -0,0 +1,22 @@
<?php
namespace Shikiryu\Backup\Backup;
class Folder extends BackupAbstract
{
public function __construct(array $config = array())
{
parent::__construct($config);
}
/**
* @return bool
*/
public function isValid()
{
// TODO: Implement isValid() method.
}
}

View File

@ -90,6 +90,13 @@ class Mysql extends BackupAbstract
return $return; return $return;
} }
/**
* @return bool
*/
public function isValid()
{
// TODO: Implement isValid() method.
}
} }
?> ?>

View File

@ -1,14 +0,0 @@
<!--
To change this template, choose Tools | Templates
and open the template in the editor.
-->
<!DOCTYPE html>
<html>
<head>
<title></title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
</head>
<body>
<div>TODO write content</div>
</body>
</html>

View File

@ -1 +1,27 @@
TODO Scenario is based on a json explaining how the backup will work.
It contains 2 bases :
- backup (what you're going to backup)
- transport (how and where you're going to backup)
# backup
- must begin with an uppercase
- a PHP class with the same name must exists in the Backup folder
# transport
- must begin with an uppercase
- a PHP class with the same name must exists in the Transport folder
# configuration of backup and transport
- all protected variable of the aimed class can be used as a configuration
# tips
## JSON
The JSON must be compatible with the [PHP `json_decode`](http://php.net/manual/en/function.json-encode.php) implementation which correspond to [this one](http://www.faqs.org/rfcs/rfc4627.html)
Basically :
- everything surrounded by " and no '
- no comments
- escape escape escape