Storage: Controller and Model Documentation

bareos · May 24, 2017 · c3965f1 · c3965f1
1 parent b45b2e7
commit c3965f1
Show file tree

Hide file tree

Showing 2 changed files with 142 additions and 2 deletions.
diff --git a/module/Storage/src/Storage/Controller/StorageController.php b/module/Storage/src/Storage/Controller/StorageController.php
@@ -5,7 +5,7 @@
  * bareos-webui - Bareos Web-Frontend
  *
  * @link      https://github.com/bareos/bareos-webui for the canonical source repository
- * @copyright Copyright (c) 2013-2016 Bareos GmbH & Co. KG (http://www.bareos.org/)
+ * @copyright Copyright (c) 2013-2017 Bareos GmbH & Co. KG (http://www.bareos.org/)
  * @license   GNU Affero General Public License (http://www.gnu.org/licenses/)
  *
  * This program is free software: you can redistribute it and/or modify
@@ -34,6 +34,9 @@
 class StorageController extends AbstractActionController
 {
 
+   /**
+    * Variables
+    */
    protected $storageModel = null;
    protected $poolModel = null;
    protected $bsock = null;
@@ -51,6 +54,11 @@ class StorageController extends AbstractActionController
       ".pools"
    );
 
+   /**
+    * Index Action
+    *
+    * @return object
+    */
    public function indexAction()
    {
       $this->RequestURIPlugin()->setRequestURI();
@@ -72,6 +80,11 @@ public function indexAction()
       return new ViewModel(array());
    }
 
+   /**
+    * Details Action
+    *
+    * @return object
+    */
    public function detailsAction()
    {
       $this->RequestURIPlugin()->setRequestURI();
@@ -243,6 +256,11 @@ public function detailsAction()
       }
    }
 
+   /**
+    * Status Action
+    *
+    * @return object
+    */
    public function statusAction()
    {
       $this->RequestURIPlugin()->setRequestURI();
@@ -281,6 +299,11 @@ public function statusAction()
       );
    }
 
+   /**
+    * Get Data Action
+    *
+    * @return object
+    */
    public function getDataAction()
    {
       $this->RequestURIPlugin()->setRequestURI();
@@ -325,6 +348,11 @@ public function getDataAction()
       return $response;
    }
 
+   /**
+    * Get Storage Model
+    *
+    * @return object
+    */
    public function getStorageModel()
    {
       if(!$this->storageModel) {
@@ -334,6 +362,11 @@ public function getStorageModel()
       return $this->storageModel;
    }
 
+   /**
+    * Get Pool Model
+    *
+    * @return object
+    */
    public function getPoolModel()
    {
       if(!$this->poolModel) {

diff --git a/module/Storage/src/Storage/Model/StorageModel.php b/module/Storage/src/Storage/Model/StorageModel.php
@@ -5,7 +5,7 @@
  * bareos-webui - Bareos Web-Frontend
  *
  * @link      https://github.com/bareos/bareos-webui for the canonical source repository
- * @copyright Copyright (c) 2013-2016 Bareos GmbH & Co. KG (http://www.bareos.org/)
+ * @copyright Copyright (c) 2013-2017 Bareos GmbH & Co. KG (http://www.bareos.org/)
  * @license   GNU Affero General Public License (http://www.gnu.org/licenses/)
  *
  * This program is free software: you can redistribute it and/or modify
@@ -28,6 +28,13 @@
 class StorageModel
 {
 
+   /**
+    * Get all Storages
+    *
+    * @param $bsock
+    *
+    * @return array
+    */
    public function getStorages(&$bsock=null)
    {
       if(isset($bsock)) {
@@ -41,6 +48,14 @@ public function getStorages(&$bsock=null)
       }
    }
 
+   /**
+    * Get Status Storage Slots
+    *
+    * @param $bsock
+    * @param $storage
+    *
+    * @return array
+    */
    public function getStatusStorageSlots(&$bsock=null, $storage=null)
    {
       if(isset($bsock, $storage)) {
@@ -54,6 +69,16 @@ public function getStatusStorageSlots(&$bsock=null, $storage=null)
       }
    }
 
+   /**
+    * Import Slots
+    *
+    * @param $bsock
+    * @param $storage
+    * @param $srcslots
+    * @param $dstslots
+    *
+    * @return string
+    */
    public function importSlots(&$bsock=null, $storage=null, $srcslots=null, $dstslots=null)
    {
       if(isset($bsock, $storage)) {
@@ -81,6 +106,15 @@ public function importSlots(&$bsock=null, $storage=null, $srcslots=null, $dstslo
       }
    }
 
+   /**
+    * Export Slots
+    *
+    * @param $bsock
+    * @param $storage
+    * @param $slots
+    *
+    * @return string
+    */
    public function exportSlots(&$bsock=null, $storage=null, $slots=null)
    {
       if(isset($bsock, $storage, $slots)) {
@@ -93,6 +127,16 @@ public function exportSlots(&$bsock=null, $storage=null, $slots=null)
       }
    }
 
+   /**
+    * Mound Slots
+    *
+    * @param $bsock
+    * @param $storage
+    * @param $slot
+    * @param $drive
+    *
+    * @return string
+    */
    public function mountSlot(&$bsock=null, $storage=null, $slot=null, $drive=null)
    {
       if(isset($bsock, $storage, $slot, $drive)) {
@@ -105,6 +149,15 @@ public function mountSlot(&$bsock=null, $storage=null, $slot=null, $drive=null)
       }
    }
 
+   /**
+    * Unmount Slots
+    *
+    * @param $bsock
+    * @param $storage
+    * @param $drive
+    *
+    * @return string
+    */
    public function unmountSlot(&$bsock=null, $storage=null, $drive=null)
    {
       if(isset($bsock, $storage, $drive)) {
@@ -117,6 +170,15 @@ public function unmountSlot(&$bsock=null, $storage=null, $drive=null)
       }
    }
 
+   /**
+    * Release Slot
+    *
+    * @param $bsock
+    * @param $storage
+    * @param $drive
+    *
+    * @return string
+    */
    public function releaseSlot(&$bsock=null, $storage=null, $drive=null)
    {
       if(isset($bsock, $storage, $drive)) {
@@ -129,6 +191,14 @@ public function releaseSlot(&$bsock=null, $storage=null, $drive=null)
       }
    }
 
+   /**
+    * Update Slots
+    *
+    * @param $bsock
+    * @param $storage
+    *
+    * @return string
+    */
    public function updateSlots(&$bsock=null, $storage=null)
    {
       if(isset($bsock, $storage)) {
@@ -141,6 +211,16 @@ public function updateSlots(&$bsock=null, $storage=null)
       }
    }
 
+   /**
+    * Move Slots
+    *
+    * @param $bsock
+    * @param $storage
+    * @param $srcslots
+    * @param $dstslots
+    *
+    * @return json
+    */
    public function moveSlots(&$bsock=null, $storage=null, $srcslots=null, $dstslots=null)
    {
       if(isset($bsock, $storage, $srcslots, $dstslots)) {
@@ -153,6 +233,17 @@ public function moveSlots(&$bsock=null, $storage=null, $srcslots=null, $dstslots
       }
    }
 
+   /**
+    * Label
+    *
+    * @param $bsock
+    * @param $storage
+    * @param $pool
+    * @param $drive
+    * @param $slots
+    *
+    * @return string
+    */
    public function label(&$bsock=null, $storage=null, $pool=null, $drive=null, $slots=null)
    {
       if(isset($bsock, $storage, $pool, $drive)) {
@@ -165,6 +256,14 @@ public function label(&$bsock=null, $storage=null, $pool=null, $drive=null, $slo
       }
    }
 
+   /**
+    * Get Slots
+    *
+    * @param $bsock
+    * @param $storage
+    *
+    * @return array
+    */
    public function getSlots(&$bsock=null, $storage=null)
    {
       if(isset($bsock, $storage)) {
@@ -178,6 +277,14 @@ public function getSlots(&$bsock=null, $storage=null)
       }
    }
 
+   /**
+    * Status Storage
+    *
+    * @param $bsock
+    * @param $storage
+    *
+    * @return string
+    */
    public function statusStorage(&$bsock=null, $storage=null)
    {
       if(isset($bsock, $storage)) {