Standardizing the comment blocks, cleaning up notes. (all classes) [c…

…i skip]
tmarois · Feb 24, 2019 · e847412 · e847412
1 parent b64f8af
commit e847412
Show file tree

Hide file tree

Showing 11 changed files with 12 additions and 366 deletions.
diff --git a/src/Backup.php b/src/Backup.php
@@ -12,10 +12,6 @@ class Backup
     */
     protected $backupLocation;
 
-
-    //--------------------------------------------------------------------
-
-
     /**
     * $config
     *
@@ -24,21 +20,13 @@ class Backup
     */
     protected $config;
 
-
-    //--------------------------------------------------------------------
-
-
     /**
     * $database
     *
     * \Filebase\Database
     */
     protected $database;
 
-
-    //--------------------------------------------------------------------
-
-
     /**
     * __construct
     *
@@ -63,10 +51,6 @@ public function __construct($backupLocation = '', Database $database)
         }
     }
 
-
-    //--------------------------------------------------------------------
-
-
     /**
     * save()
     *
@@ -84,10 +68,6 @@ public function create()
         throw new \Exception('Error backing up database.');
     }
 
-
-    //--------------------------------------------------------------------
-
-
     /**
     * find()
     *
@@ -109,10 +89,6 @@ public function find()
         return $backups;
     }
 
-
-    //--------------------------------------------------------------------
-
-
     /**
     * clean()
     *
@@ -124,10 +100,6 @@ public function clean()
         return array_map('unlink', glob(realpath($this->backupLocation)."/*.zip"));
     }
 
-
-    //--------------------------------------------------------------------
-
-
     /**
     * rollback()
     *
@@ -144,10 +116,6 @@ public function rollback()
         return $this->extract($restore, $this->config->dir);
     }
 
-
-    //--------------------------------------------------------------------
-
-
     /**
      * extract()
      *
@@ -172,10 +140,6 @@ protected function extract($source = '', $target = '')
         return false;
     }
 
-
-    //--------------------------------------------------------------------
-
-
     /**
     * zip()
     *
@@ -218,13 +182,11 @@ protected function zip($source = '', $target = '')
                     $zip->addFromString(str_replace($source . '/', '', $file), file_get_contents($file));
                 }
             }
-        
+
         }
 
         return $zip->close();
-
-    }
-
 
+    }
 
 }
diff --git a/src/Cache.php b/src/Cache.php
@@ -26,9 +26,6 @@ class Cache
     */
     protected $key;
 
-
-    //--------------------------------------------------------------------
-
     /**
     * __construct()
     *
@@ -44,10 +41,6 @@ public function __construct(Database $database)
     	]);
     }
 
-
-    //--------------------------------------------------------------------
-
-
     /**
     * setKey()
     *
@@ -60,10 +53,6 @@ public function setKey($key)
         $this->key = md5($key);
     }
 
-
-    //--------------------------------------------------------------------
-
-
     /**
     * getKey()
     *
@@ -73,10 +62,6 @@ public function getKey()
         return $this->key;
     }
 
-
-    //--------------------------------------------------------------------
-
-
     /**
     * flush()
     *
@@ -86,10 +71,6 @@ public function flush()
         $this->cache_database->flush(true);
     }
 
-
-    //--------------------------------------------------------------------
-
-
     /**
     * expired()
     *
@@ -106,10 +87,6 @@ public function expired($time)
         return true;
     }
 
-
-    //--------------------------------------------------------------------
-
-
     /**
     * getDocuments()
     *
@@ -125,10 +102,6 @@ public function getDocuments($documents)
         return $d;
     }
 
-
-    //--------------------------------------------------------------------
-
-
     /**
     * get()
     *
@@ -155,10 +128,6 @@ public function get()
         return $this->getDocuments($cache_doc->toArray());
     }
 
-
-    //--------------------------------------------------------------------
-
-
     /**
     * store()
     *
@@ -173,8 +142,4 @@ public function store($data)
         return $this->cache_database->get( $this->getKey() )->set($data)->save();
     }
 
-
-    //--------------------------------------------------------------------
-
-
 }
diff --git a/src/Config.php b/src/Config.php
@@ -11,15 +11,13 @@ class Config
     */
     public $dir = __DIR__;
 
-
     /**
     * $format
     * Format Class
     * Must implement Format\FormatInterface
     */
     public $format = \Filebase\Format\Json::class;
 
-
     /**
     * $cache
     * Caching for queries
@@ -28,7 +26,6 @@ class Config
     */
     public $cache = true;
 
-
     /**
     * $cache_time
     * When should cache be cleared?
@@ -37,7 +34,6 @@ class Config
     */
     public $cache_expires = 1800;
 
-
     /**
     * $safe_filename
     * (if true) Be sure to automatically change the file name if it does not fit validation
@@ -47,7 +43,6 @@ class Config
     */
     public $safe_filename = true;
 
-
     /**
     * $read_only
     * (if true) We will not attempt to create the database directory or allow the user to create anything
@@ -57,7 +52,6 @@ class Config
     */
     public $read_only = false;
 
-
     /**
     * $backupLocation
     * The location to store backups
@@ -66,7 +60,6 @@ class Config
     */
     public $backupLocation = '';
 
-
     /**
     * $pretty
     *
@@ -77,17 +70,12 @@ class Config
     */
     public $pretty = true;
 
-
     /**
     * $validate
     *
     */
     public $validate = [];
 
-
-    //--------------------------------------------------------------------
-
-
     /**
     * __construct
     *
@@ -110,10 +98,6 @@ public function __construct($config)
         $this->validateFormatClass();
     }
 
-
-    //--------------------------------------------------------------------
-
-
     /**
     * format
     *
@@ -138,8 +122,4 @@ protected function validateFormatClass()
             throw new \Exception('Filebase Error: Format Class must be an instance of Filebase\Format\FormatInterface');
         }
     }
-
-
-    //--------------------------------------------------------------------
-
 }