Schedule: Controller and Model Documentation

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

Hide file tree

Showing 2 changed files with 79 additions and 1 deletion.
diff --git a/module/Schedule/src/Schedule/Controller/ScheduleController.php b/module/Schedule/src/Schedule/Controller/ScheduleController.php
@@ -32,6 +32,9 @@
 class ScheduleController extends AbstractActionController
 {
 
+   /**
+    * Variables
+    */
    protected $scheduleModel = null;
    protected $bsock = null;
    protected $acl_alert = false;
@@ -44,6 +47,11 @@ class ScheduleController extends AbstractActionController
       "disable"
    );
 
+   /**
+    * Index Action
+    *
+    * @return object
+    */
    public function indexAction()
    {
       $this->RequestURIPlugin()->setRequestURI();
@@ -124,6 +132,11 @@ public function indexAction()
       }
    }
 
+   /**
+    * Overview Action
+    *
+    * @return object
+    */
    public function overviewAction()
    {
       $this->RequestURIPlugin()->setRequestURI();
@@ -160,6 +173,11 @@ public function overviewAction()
       );
    }
 
+   /**
+    * Status Action
+    *
+    * @return object
+    */
    public function statusAction()
    {
       $this->RequestURIPlugin()->setRequestURI();
@@ -196,6 +214,11 @@ public function statusAction()
       );
    }
 
+   /**
+    * Details Action
+    *
+    * @return object
+    */
    public function detailsAction()
    {
       $this->RequestURIPlugin()->setRequestURI();
@@ -234,6 +257,11 @@ public function detailsAction()
       );
    }
 
+   /**
+    * Get Data Action
+    *
+    * @return object
+    */
    public function getDataAction()
    {
       $this->RequestURIPlugin()->setRequestURI();
@@ -278,6 +306,11 @@ public function getDataAction()
       return $response;
    }
 
+   /**
+    * Get Schedule Model
+    *
+    * @return object
+    */
    public function getScheduleModel()
    {
       if(!$this->scheduleModel) {

diff --git a/module/Schedule/src/Schedule/Model/ScheduleModel.php b/module/Schedule/src/Schedule/Model/ScheduleModel.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
@@ -31,6 +31,13 @@
 class ScheduleModel
 {
 
+   /**
+    * Get Schedules
+    *
+    * @param $bsock
+    *
+    * @return array
+    */
    public function getSchedules(&$bsock=null)
    {
       if(isset($bsock)) {
@@ -44,6 +51,13 @@ public function getSchedules(&$bsock=null)
       }
    }
 
+   /**
+    * Show Schedules
+    *
+    * @param $bsock
+    *
+    * @return string
+    */
    public function showSchedules(&$bsock=null)
    {
       if(isset($bsock)) {
@@ -56,6 +70,13 @@ public function showSchedules(&$bsock=null)
       }
    }
 
+   /**
+    * Get Full Schedule Status
+    *
+    * @param $bsock
+    *
+    * @return string
+    */
    public function getFullScheduleStatus(&$bsock=null)
    {
       if(isset($bsock)) {
@@ -68,6 +89,14 @@ public function getFullScheduleStatus(&$bsock=null)
       }
    }
 
+   /**
+    * Get Schedule Status
+    *
+    * @param $bsock
+    * @param $name
+    *
+    * @return string
+    */
    public function getScheduleStatus(&$bsock=null, $name=null)
    {
       if(isset($bsock, $name)) {
@@ -80,6 +109,14 @@ public function getScheduleStatus(&$bsock=null, $name=null)
       }
    }
 
+   /**
+    * Enable Schedule
+    *
+    * @param $bsock
+    * @param $name
+    *
+    * @return string
+    */
    public function enableSchedule(&$bsock=null, $name=null)
    {
       if(isset($bsock, $name)) {
@@ -92,6 +129,14 @@ public function enableSchedule(&$bsock=null, $name=null)
       }
    }
 
+   /**
+    * Disable Schedule
+    *
+    * @param $bsock
+    * @param $name
+    *
+    * @return string
+    */
    public function disableSchedule(&$bsock=null, $name=null)
    {
       if(isset($bsock, $name)) {