Hape: Added comments

git-svn-id: https://oss.gonicus.de/repositories/gosa/trunk@19925 594d385d-05f5-0310-b6e9-bd551577e9d8

diff --git a/gosa-core/include/class_sortableListing.inc b/gosa-core/include/class_sortableListing.inc
index b134ab1dc06df26e048c867c9568cffa8130b69d..5f3524f93785a4a46e8c23d030cda8c36596481f 100644 (file)
--- a/gosa-core/include/class_sortableListing.inc
+++ b/gosa-core/include/class_sortableListing.inc
@@ -54,6 +54,7 @@ class sortableListing {
     private $acl= "";
     private $modified= false;
 
+       
     public function sortableListing($data= array(), $displayData= null, $reorderable= false)
     {
         global $config;
@@ -100,6 +101,17 @@ class sortableListing {
         $this->sortColumn = $id;
     }
 
+       /*
+       * 
+       * Examples
+       * DatenARray ($data)
+       * @param: array( arbitrary object, arbitrary object)
+       * Datenarray will be manipulated by add, del and sort operations. According to this it will be returned from this widget.
+       * The index of a data entry must correspond to the entry of the "display array" following.
+       * DisplayArray ($displyData)
+       * @param: array("eins" array( "data"=> array("Uno", "2", "x" ) , "zwei" array( "data"=> array("Due", "3", "y" ))) ;
+       * label pointing on a list of columns that will be shown in the list.
+       */
     public function setListData($data, $displayData= null)
     {
         // Save data to display
@@ -113,13 +125,13 @@ class sortableListing {
         $this->setDisplayData($displayData);
     }
 
-
+       //setting flat data 
     private function setData($data)
     {
         $this->data= $data;
     }
 
-
+       // collecting the display data -
     private function setDisplayData($data)
     {
         if (!is_array($data)) {