some rustic debug/profiling tools builtin tables - users page does not autosort
[plewww.git] / plekit / php / table.php
index 481cbc6..bb63155 100644 (file)
@@ -15,41 +15,51 @@ drupal_set_html_head('
 ////////////////////////////////////////
 // table_id: <table>'s id tag - WARNING : do not use '-' in table ids as it's used for generating javascript code
 // headers: an associative array "label"=>"type" 
-// column_sort: the column to sort on at load-time
+// sort_column: the column to sort on at load-time - set to negative number for no onload- sorting
 // options : an associative array to override options 
+//  - bullets1 : set to true if you want decorative bullets in column 1 (need white background)
+//  - stripes : use diferent colors for odd and even rows
+//  - caption : a caption for the table -- never used I'm afraid
 //  - search_area : boolean (default true)
 //  - pagesize_area : boolean (default true)
 //  - notes_area : boolean (default true)
 //  - search_width : size in chars of the search text dialog
-//  - notes : an array of additional notes
 //  - pagesize: the initial pagination size
 //  - pagesize_def: the page size when one clicks the pagesize reset button
 //  - max_pages: the max number of pages to display in the paginator
+//  - notes : an array of additional notes
+//  - debug: enables debug callbacks (prints out on console.log)
 
 class PlekitTable {
   // mandatory
   var $table_id;
   var $headers;
-  var $column_sort;
+  var $sort_column;
   // options
-  var $caption;
+  var $bullets1;      // boolean - default false - display decorative bullets in column 1
+  var $stripes;              // boolean - default true - use different colors for odd and even rows
+  var $caption;              // string - never used so far
   var $search_area;   // boolean (default true)
   var $pagesize_area; // boolean (default true)
   var $notes_area;    // boolean (default true)
   var $search_width;  // size in chars of the search text dialog
-  var $pagesize;       // the initial pagination size
+  var $pagesize;      // the initial pagination size
   var $pagesize_def;  // the page size when one clicks the pagesize reset button
   var $max_pages;     // the max number of pages to display in the paginator
   var $notes;         // an array of additional notes
+  var $debug;        // set to true for enabling various log messages on console.log
+
+  // internal
   var $has_tfoot;
 
-  function PlekitTable ($table_id,$headers,$column_sort,$options=NULL) {
+  function PlekitTable ($table_id,$headers,$sort_column,$options=NULL) {
     $this->table_id = $table_id;
     $this->headers = $headers;
-    $this->column_sort = $column_sort;
-    
-    $this->has_tfoot=false;
+    $this->sort_column = $sort_column;
 
+    $this->bullets1 = true;
+    $this->stripes=true;
+    $this->caption='';
     $this->search_area = true;
     $this->pagesize_area = true;
     $this->notes_area = true;
@@ -58,13 +68,19 @@ class PlekitTable {
     $this->pagesize_def = 999;
     $this->max_pages = 10;
     $this->notes = array();
+    $this->debug = false;
 
     $this->set_options ($options);
+
+    // internal
+    $this->has_tfoot=false;
   }
 
   function set_options ($options) {
     if ( ! $options)
       return;
+    if (array_key_exists('bullets1',$options)) $this->bullets1=$options['bullets1'];
+    if (array_key_exists('stripes',$options)) $this->stripes=$options['stripes'];
     if (array_key_exists('caption',$options)) $this->caption=$options['caption'];
     if (array_key_exists('search_area',$options)) $this->search_area=$options['search_area'];
     if (array_key_exists('pagesize_area',$options)) $this->pagesize_area=$options['pagesize_area'];
@@ -73,8 +89,8 @@ class PlekitTable {
     if (array_key_exists('pagesize',$options)) $this->pagesize=$options['pagesize'];
     if (array_key_exists('pagesize_def',$options)) $this->pagesize_def=$options['pagesize_def'];
     if (array_key_exists('max_pages',$options)) $this->max_pages=$options['max_pages'];
-
     if (array_key_exists('notes',$options)) $this->notes=array_merge($this->notes,$options['notes']);
+    if (array_key_exists('debug',$options)) $this->debug=$options['debug'];
   }
 
   public function columns () {
@@ -87,45 +103,49 @@ class PlekitTable {
     $classname="paginationcallback-".$paginator;
     $classname.=" max-pages-" . $this->max_pages;
     $classname.=" paginate-" . $this->pagesize;
-  // instantiate paginator callback
-    print <<< EOF
-<script type="text/javascript"> 
-function $paginator (opts) { plekit_table_paginator (opts,"$this->table_id"); }
-</script>
-<br/>
-<table id="$this->table_id" cellpadding="0" cellspacing="0" border="0" 
-class="plekit_table sortable-onload-$this->column_sort rowstyle-alt colstyle-alt no-arrow $classname">
-<thead>
-EOF;
+    if ($this->bullets1) { $classname .= " bullets1"; }
+    if ($this->stripes) { $classname .= " rowstyle-alt"; }
+    if ($this->sort_column >= 0) { $classname .= " sortable-onload-$this->sort_column"; }
+
+    // instantiate paginator callback
+    print "<script type='text/javascript'> function $paginator (opts) { plekit_table_paginator (opts,'$this->table_id'); } </script>\n";
+    
+    // instantiate debug hooks if needed
+    if ($this->debug) {
+      $cb_init = $this->table_id."_init";
+      print "<script type='text/javascript'> function $cb_init () { plc_message ('sorting table $this->table_id'); } </script>\n";
+      $classname .= " sortinitiatedcallback-$cb_init";
+      $cb_comp = $this->table_id."_comp";
+      print "<script type='text/javascript'> function $cb_comp () { plc_message ('table $this->table_id sorted'); } </script>\n";
+      $classname .= " sortcompletecallback-$cb_comp";
+    }
+    // start actual table
+    print "<table id='$this->table_id' class='plekit_table colstyle-alt no-arrow $classname'><thead>\n";
 
-  if ($this->pagesize_area)
-    print $this->pagesize_area_html ();
-  if ($this->search_area) 
-    print $this->search_area_html ();
-
-  if ($this->caption) 
-    print "<caption> $this->caption </caption>";
-  print "<tr>";
-  foreach ($this->headers as $label => $type) {
-    switch ($type) {
-    case "none" : 
-      $class=""; break;
-    case "string": case "int": case "float":
-      $class="sortable"; break;
-    case ( strpos($type,"date-") == 0):
-      $class="sortable-" . $type; break;
-    default:
-      $class="sortable-sort" . $type; break;
+    if ($this->pagesize_area)
+      print $this->pagesize_area_html ();
+    if ($this->search_area) 
+      print $this->search_area_html ();
+    
+    if ($this->caption) 
+      print "<caption> $this->caption </caption>";
+    print "<tr>";
+    foreach ($this->headers as $label => $type) {
+      switch ($type) {
+      case "none" : 
+       $class=""; break;
+      case "string": case "int": case "float":
+       $class="sortable"; break;
+      case ( strpos($type,"date-") == 0):
+       $class="sortable-" . $type; break;
+      default:
+       $class="sortable-sort" . $type; break;
+      }
+      printf ('<th class="%s plekit_table">%s</th>',$class,$label);
     }
-    printf ('<th class="%s plekit_table">%s</th>',$class,$label);
-  }
 
-  print <<< EOF
-</tr>
-</thead>
-<tbody>
-EOF;
-}
+    print "</tr></thead><tbody>";
+  }
 
   ////////////////////
   // for convenience, the options that apply to the bottom area can be passed here
@@ -164,7 +184,7 @@ EOF;
     $search_and_id = $this->table_id . "_search_and";
     $result = <<< EOF
 <tr class='search_area'><td class='search_area' colspan='$width'>
-<form class='search' action='satisfy_xhtml_validator'><fieldset>
+<div class='search'><fieldset>
    <label class='search_label'> Search </label> 
    <input class='search_input' type='text' id='$search_text_id'
       onkeyup='plekit_table_filter("$this->table_id","$search_text_id","$search_and_id");'
@@ -175,7 +195,7 @@ EOF;
       onchange='plekit_table_filter("$this->table_id","$search_text_id","$search_and_id");' />
    <img class='reset' src="/planetlab/icons/clear.png" alt="reset search"
       onmousedown='plekit_table_filter_reset("$this->table_id","$search_text_id","$search_and_id");' />
-</fieldset></form></td></tr>
+</fieldset></div></td></tr>
 EOF;
     return $result;
   }
@@ -232,14 +252,24 @@ EOF;
   }
 
   ////////////////////
-  public function cell ($text,$colspan=0,$align=NULL) { print $this->cell_html ($text,$colspan,$align); }
-  public function cell_html ($text,$colspan=0,$align=NULL) {
-    $result="";
-    $result .= "<td";
-    if ($colspan) $result .= " colspan='$colspan'";
-    if ($align) $result .= " style='text-align:$align'";
-    $result .= ">$text</td>";
-    return $result;
+  // supported options:
+  // (*) only-if : if set and false, then print 'n/a' instead of (presumably void) $text
+  // (*) class
+  // (*) columns
+  // (*) hfill
+  // (*) align
+  public function cell ($text,$options=NULL) { print $this->cell_html ($text,$options); }
+  public function cell_html ($text,$options=NULL) {
+    if (isset ($options['only-if']) && ! $options['only-if'] )
+      $text="n/a";
+    $html="";
+    $html .= "<td";
+    $option=$options['class']; if ($option) $html .= " class='$option'";
+    $option=$options['columns'];if ($option) $html .= " colspan='$option'";
+    $option=$options['hfill']; if ($option) $html .= " colspan='" . $this->columns() . "'";
+    $option=$options['align']; if ($option) $html .= " style='text-align:$option'";
+    $html .= ">$text</td>";
+    return $html;
   }
 
 }