Pool: Controller and Model Documentation

bareos · May 24, 2017 · 55e470d · 55e470d
1 parent 2709676
commit 55e470d
Show file tree

Hide file tree

Showing 2 changed files with 56 additions and 2 deletions.
diff --git a/module/Pool/src/Pool/Controller/PoolController.php b/module/Pool/src/Pool/Controller/PoolController.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-2015 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
@@ -31,6 +31,9 @@
 
 class PoolController extends AbstractActionController
 {
+   /**
+    * Variables
+    */
    protected $poolModel = null;
    protected $bsock = null;
    protected $acl_alert = false;
@@ -40,6 +43,11 @@ class PoolController extends AbstractActionController
       "llist"
    );
 
+   /**
+    * Get Index Action
+    *
+    * @return object
+    */
    public function indexAction()
    {
       $this->RequestURIPlugin()->setRequestURI();
@@ -74,6 +82,11 @@ public function indexAction()
       );
    }
 
+   /**
+    * Get Details Action
+    *
+    * @return object
+    */
    public function detailsAction()
    {
       $this->RequestURIPlugin()->setRequestURI();
@@ -110,6 +123,11 @@ public function detailsAction()
       );
    }
 
+   /**
+    * Get Data Action
+    *
+    * @return object
+    */
    public function getDataAction()
    {
       $this->RequestURIPlugin()->setRequestURI();
@@ -164,6 +182,11 @@ public function getDataAction()
       return $response;
    }
 
+   /**
+    * Get Pool Model
+    *
+    * @return object
+    */
    public function getPoolModel()
    {
       if(!$this->poolModel) {

diff --git a/module/Pool/src/Pool/Model/PoolModel.php b/module/Pool/src/Pool/Model/PoolModel.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 PoolModel
 {
 
+   /**
+    * Get all Pools by llist command
+    *
+    * @param $bsock
+    *
+    * @return array
+    */
    public function getPools(&$bsock=null)
    {
       if(isset($bsock)) {
@@ -41,6 +48,14 @@ public function getPools(&$bsock=null)
       }
    }
 
+   /**
+    * Get all Pools by .pools command
+    *
+    * @param $bsock
+    * @param $type
+    *
+    * @return array
+    */
    public function getDotPools(&$bsock=null, $type=null)
    {
       if(isset($bsock)) {
@@ -59,6 +74,14 @@ public function getDotPools(&$bsock=null, $type=null)
       }
    }
 
+   /**
+    * Get a single Pool
+    *
+    * @param $bsock
+    * @param $pool
+    *
+    * @return array
+    */
    public function getPool(&$bsock=null, $pool=null)
    {
       if(isset($bsock, $pool)) {
@@ -72,6 +95,14 @@ public function getPool(&$bsock=null, $pool=null)
       }
    }
 
+   /**
+    * Get Pool Media by llist media command
+    *
+    * @param $bsock
+    * @param $pool
+    *
+    * @return array
+    */
    public function getPoolMedia(&$bsock=null, $pool=null)
    {
       if(isset($bsock, $pool)) {