Fileset: Controller and Model Documentation

bareos · May 24, 2017 · bcc5d77 · bcc5d77
1 parent 3744cd6
commit bcc5d77
Show file tree

Hide file tree

Showing 2 changed files with 47 additions and 3 deletions.
diff --git a/module/Fileset/src/Fileset/Controller/FilesetController.php b/module/Fileset/src/Fileset/Controller/FilesetController.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
@@ -32,9 +32,17 @@
 class FilesetController extends AbstractActionController
 {
 
+   /**
+    * Variables
+    */
    protected $filesetModel = null;
    protected $bsock = null;
 
+   /**
+    * Index Action
+    *
+    * @return object
+    */
    public function indexAction()
    {
       $this->RequestURIPlugin()->setRequestURI();
@@ -59,6 +67,11 @@ public function indexAction()
       );
    }
 
+   /**
+    * Details Action
+    *
+    * @return object
+    */
    public function detailsAction()
    {
       $this->RequestURIPlugin()->setRequestURI();
@@ -85,6 +98,11 @@ public function detailsAction()
       );
    }
 
+   /**
+    * Get Data Action
+    *
+    * @return object
+    */
    public function getDataAction()
    {
       $this->RequestURIPlugin()->setRequestURI();
@@ -129,6 +147,11 @@ public function getDataAction()
       return $response;
    }
 
+   /**
+    * Get Fileset Model
+    *
+    * @return object
+    */
    public function getFilesetModel()
    {
       if(!$this->filesetModel) {
@@ -139,4 +162,3 @@ public function getFilesetModel()
    }
 
 }
-
diff --git a/module/Fileset/src/Fileset/Model/FilesetModel.php b/module/Fileset/src/Fileset/Model/FilesetModel.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 FilesetModel
 {
 
+   /**
+    * Get all Filesets
+    *
+    * @param $bsock
+    *
+    * @return array
+    */
    public function getFilesets(&$bsock=null)
    {
       if(isset($bsock)) {
@@ -41,6 +48,14 @@ public function getFilesets(&$bsock=null)
       }
    }
 
+   /**
+    * Get a single Fileset
+    *
+    * @param $bsock
+    * @param $id
+    *
+    * @return array
+    */
    public function getFileset(&$bsock=null, $id)
    {
       if(isset($bsock, $id)) {
@@ -54,6 +69,13 @@ public function getFileset(&$bsock=null, $id)
       }
    }
 
+   /**
+    * Get all Filesets by .filesets command
+    *
+    * @param $bsock
+    *
+    * @return array
+    */
    public function getDotFilesets(&$bsock=null)
    {
       if(isset($bsock)) {