Media: Controller and Model Documentation

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

Hide file tree

Showing 2 changed files with 46 additions and 0 deletions.
diff --git a/module/Media/src/Media/Controller/MediaController.php b/module/Media/src/Media/Controller/MediaController.php
@@ -31,6 +31,9 @@
 
 class MediaController extends AbstractActionController
 {
+   /**
+    * Variables
+    */
    protected $mediaModel = null;
    protected $bsock = null;
    protected $acl_alert = false;
@@ -40,6 +43,11 @@ class MediaController extends AbstractActionController
       "llist"
    );
 
+   /**
+    * Index Action
+    *
+    * @return object
+    */
    public function indexAction()
    {
       $this->RequestURIPlugin()->setRequestURI();
@@ -74,6 +82,11 @@ public function indexAction()
       );
    }
 
+   /**
+    * Details Action
+    *
+    * @return object
+    */
    public function detailsAction()
    {
       $this->RequestURIPlugin()->setRequestURI();
@@ -99,6 +112,11 @@ public function detailsAction()
       ));
    }
 
+   /**
+    * Get Data Action
+    *
+    * @return object
+    */
    public function getDataAction()
    {
       $this->RequestURIPlugin()->setRequestURI();
@@ -154,6 +172,11 @@ public function getDataAction()
       return $response;
    }
 
+   /**
+    * Get Media Model
+    *
+    * @return object
+    */
    public function getMediaModel()
    {
       if(!$this->mediaModel) {

diff --git a/module/Media/src/Media/Model/MediaModel.php b/module/Media/src/Media/Model/MediaModel.php
@@ -28,6 +28,13 @@
 class MediaModel
 {
 
+   /**
+    * Get all Volumes/Media
+    *
+    * @param $bsock
+    *
+    * @return array
+    */
    public function getVolumes(&$bsock=null)
    {
       if(isset($bsock)) {
@@ -47,6 +54,14 @@ public function getVolumes(&$bsock=null)
       }
    }
 
+   /**
+    * Get a single Volume
+    *
+    * @param $bsock
+    * @param $volume
+    *
+    * @return array
+    */
    public function getVolume(&$bsock=null, $volume=null)
    {
       if(isset($bsock, $volume)) {
@@ -60,6 +75,14 @@ public function getVolume(&$bsock=null, $volume=null)
       }
    }
 
+   /**
+    * Get Volume Jobs
+    *
+    * @param $bsock
+    * @param $volume
+    *
+    * @return array
+    */
    public function getVolumeJobs(&$bsock=null, $volume=null)
    {
       if(isset($bsock, $volume)) {