details can be updated inline - old forms still to be cleaned up
[plewww.git] / planetlab / includes / plc_tables.php
index 7bdcf51..3a15e0f 100644 (file)
@@ -8,94 +8,107 @@ drupal_set_html_head('
 <link href="/planetlab/css/plc_tables.css" rel="stylesheet" type="text/css" />
 ');
 
-
-////////////////////////////////////////
-function plc_table_cell($cell) {
-  printf ('<td class="plc_table"> %s </td>',$cell);
-}
-
 ////////////////////////////////////////
-// table_id: <table>'s id tag
+// 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
-// search_area : boolean
-// 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
-function plc_table_start ($table_id, $headers, $column_sort,
-                         $search_area=true,$max_pages="10",$pagesize="25",$pagesize_def="999") {
-  if ($search_area) {
-    plc_table_search_area($table_id,$pagesize,$pagesize_def);
+// options : an associative array to override options 
+//  - 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
+
+class PlcTable {
+  // mandatory
+  var $table_id;
+  var $headers;
+  var $column_sort;
+  // options
+  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_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 $has_tfoot;
+
+  function PlcTable ($table_id,$headers,$column_sort,$options=NULL) {
+    $this->table_id = $table_id;
+    $this->headers = $headers;
+    $this->column_sort = $column_sort;
+    
+    $this->has_tfoot=false;
+
+    $this->search_area = true;
+    $this->pagesize_area = true;
+    $this->notes_area = true;
+    $this->search_width = 40;
+    $this->pagesize = 25;
+    $this->pagesize_def = 999;
+    $this->max_pages = 10;
+    $this->notes = array();
+
+    $this->set_options ($options);
   }
-  plc_table_head($table_id,$headers,$column_sort,$max_pages,$pagesize);
-}
 
-function plc_table_end () {
-  plc_table_foot();
-}
-                   
-////////////////////
-function plc_table_search_area ($table_id,$pagesize,$pagesize_def) {
-  $pagesize_text_id = $table_id . "_pagesize";
-  $search_text_id = $table_id . "_search";
-  $search_reset_id = $table_id . "_search_reset";
-  $search_and_id = $table_id . "_search_and";
-  print <<< EOF
-<table class='table_dialogs'> <tr>
-<td class='table_flushleft'>
-<form class='pagesize'>
-   <input class='pagesize_input' type='text' id="$pagesize_text_id" value=$pagesize 
-      onkeyup='plc_pagesize_set("$table_id","$pagesize_text_id", $pagesize);' 
-      size=3 maxlength=3 /> 
-  <label class='pagesize_label'> items/page </label>   
-  <img class='table_reset' src="/planetlab/icons/clear.png" 
-      onmousedown='plc_pagesize_reset("$table_id","$pagesize_text_id",$pagesize_def);'>
-</form>
-</td>
+  function set_options ($options) {
+    if ( ! $options)
+      return;
+    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'];
+    if (array_key_exists('notes_area',$options)) $this->notes_area=$options['notes_area'];
+    if (array_key_exists('search_width',$options)) $this->search_width=$options['search_width'];
+    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'];
 
-<td class='table_flushright'> 
-<form class='table_search'>
-   <label class='table_search_label'> Search </label> 
-   <input class='table_search_input' type='text' id='$search_text_id'
-      onkeyup='plc_table_filter("$table_id","$search_text_id","$search_and_id");'
-      size=40 maxlength=256 />
-   <label>and</label>
-   <input id='$search_and_id' class='table_search_and' 
-      type='checkbox' checked='checked' 
-      onchange='plc_table_filter("$table_id","$search_text_id","$search_and_id");' />
-   <img class='table_reset' src="/planetlab/icons/clear.png" 
-      onmousedown='plc_table_filter_reset("$table_id","$search_text_id","$search_and_id");'>
-</form>
-</td>
-</tr></table>
-EOF;
-}
+    if (array_key_exists('notes',$options)) $this->notes=array_merge($this->notes,$options['notes']);
+  }
 
-////////////////////////////////////////
-function plc_table_head ($table_id,$headers,$column_sort,$max_pages,$pagesize) {
-  $paginator=$table_id."_paginator";
-  $classname="paginationcallback-".$paginator;
-  $classname.=" max-pages-" . $max_pages;
-  $classname.=" paginate-" . $pagesize;
-  print <<< EOF
-<!-- instantiate paginator callback -->
-<script type"text/javascript"> 
-function $paginator (opts) { plc_table_paginator (opts,"$table_id"); }
+  public function columns () {
+    return count ($this->headers);
+  }
+
+  ////////////////////
+  public function start () {
+    $paginator=$this->table_id."_paginator";
+    $classname="paginationcallback-".$paginator;
+    $classname.=" max-pages-" . $max_pages;
+    $classname.=" paginate-" . $pagesize;
+  // instantiate paginator callback
+    print <<< EOF
+<script type="text/javascript"> 
+function $paginator (opts) { plc_table_paginator (opts,"$this->table_id"); }
 </script>
 <br/>
-<table id="$table_id" cellpadding="0" cellspacing="0" border="0" 
-class="plc_table sortable-onload-$column_sort rowstyle-alt colstyle-alt no-arrow $classname">
+<table id="$this->table_id" cellpadding="0" cellspacing="0" border="0" 
+class="plc_table sortable-onload-$this->column_sort rowstyle-alt colstyle-alt no-arrow $classname">
 <thead>
-<tr>
 EOF;
 
-  foreach ($headers as $label => $type) {
-    if ($type == "string") $type="";
-    if ($type == "int") $type="";
-    if ($type == "float") $type="";
-    $class="sortable";
-    if ( ! empty($type)) $class .= "-" . $type;
-    print '<th class="' . $class . ' plc_table">' . $label . "</th>\n";
+  if ($this->pagesize_area)
+    print $this->pagesize_area_html ();
+  if ($this->search_area) 
+    print $this->search_area_html ();
+
+  print "<tr>";
+  foreach ($this->headers as $label => $type) {
+    if ($type == "none" ) {
+      $class="";
+    } else {
+      if ($type == "string") $type="";
+      if ($type == "int") $type="";
+      if ($type == "float") $type="";
+      $class="sortable";
+      if ( ! empty($type)) $class .= "-sort" . $type;
+    }
+    printf ('<th class="%s plc_table">%s</th>',$class,$label);
   }
 
   print <<< EOF
@@ -105,27 +118,119 @@ EOF;
 EOF;
 }
 
-////////////////////////////////////////
-function plc_table_foot () {
-  print <<< EOF
-</tbody>
-<tfoot>
-</tfoot>
-</table>
+  ////////////////////
+  // for convenience, the options that apply to the bottom area can be passed here
+  // typically notes will add up to the ones provided so far, and to the default ones 
+  // xxx default should be used only if applicable
+  function end ($options=NULL) {
+    $this->set_options($options);
+    print $this->bottom_html();
+    if ($this->notes_area) 
+      print $this->notes_area_html();
+  }
+                   
+  ////////////////////
+  function pagesize_area_html () {
+    $width=count($this->headers);
+    $pagesize_text_id = $this->table_id . "_pagesize";
+    $result= <<< EOF
+<tr class=pagesize_area><td class=pagesize_area colspan=$width><form class='pagesize'>
+   <input class='pagesize_input' type='text' id="$pagesize_text_id" value=$this->pagesize 
+      onkeyup='plc_pagesize_set("$this->table_id","$this->pagesize_text_id", $this->pagesize);' 
+      size=3 maxlength=3 /> 
+  <label class='pagesize_label'> items/page </label>   
+  <img class='table_reset' src="/planetlab/icons/clear.png" 
+      onmousedown='plc_pagesize_reset("$this->table_id","$pagesize_text_id",$this->pagesize_def);' />
+</form></td></tr>
 EOF;
+    return $result;
 }
 
-////////////////////////////////////////
-function plc_table_notes () {
-  print <<< EOF
-<p class='plc_filter_note'> 
-Notes: Enter & or | in the search area to alternate between <bold>AND</bold> and <bold>OR</bold> search modes
-<br/> 
-Hold down the shift key to select multiple columns to sort 
-</p>
+  ////////////////////
+  function search_area_html () {
+    $width=count($this->headers);
+    $search_text_id = $this->table_id . "_search";
+    $search_reset_id = $this->table_id . "_search_reset";
+    $search_and_id = $this->table_id . "_search_and";
+    $result = <<< EOF
+<tr class=search_area><td class=search_area colspan=$width><form class='table_search'>
+   <label class='table_search_label'> Search </label> 
+   <input class='table_search_input' type='text' id='$search_text_id'
+      onkeyup='plc_table_filter("$this->table_id","$search_text_id","$search_and_id");'
+      size=$this->search_width maxlength=256 />
+   <label>and</label>
+   <input id='$search_and_id' class='table_search_and' 
+      type='checkbox' checked='checked' 
+      onchange='plc_table_filter("$this->table_id","$search_text_id","$search_and_id");' />
+   <img class='table_reset' src="/planetlab/icons/clear.png" 
+      onmousedown='plc_table_filter_reset("$this->table_id","$search_text_id","$search_and_id");'>
+</form></td></tr>
 EOF;
-}
+    return $result;
+  }
 
+  //////////////////// start a <tfoot> section
+  function tfoot_start () { print $this->tfoot_start_html(); }
+  function tfoot_start_html () {
+    $this->has_tfoot=true;
+    return "</tbody><tfoot>";
+  }
 
-?>
+  ////////////////////////////////////////
+  function bottom_html () {
+    $result="";
+    if ($this->has_tfoot)
+      $result .= "</tfoot>";
+    else
+      $result .= "</tbody>";
+    $result .= "</table>\n";
+    return $result;
+  }
+
+  ////////////////////////////////////////
+  function notes_area_html () {
+    $default_notes =  array(
+       "Enter & or | in the search area to alternate between <bold>AND</bold> and <bold>OR</bold> search modes",
+       "Hold down the shift key to select multiple columns to sort");
+
+    if ($this->notes)
+      $notes=$this->notes;
+    else
+      $notes=array();
+    $notes=array_merge($notes,$default_notes);
+    if (! $notes)
+      return "";
+    $result = "";
+    $result .= "<p class='plc_table_note'> <span class='plc_table_note_title'>Notes</span>\n";
+    foreach ($notes as $note) 
+      $result .= "<br/>$note\n";
+    $result .= "</p>";
+    return $result;
+  }
+
+  ////////////////////////////////////////
+  function row_start ($id=NULL,$class=NULL) {
+    print "<tr";
+    if ( $id) print (" id=\"$id\"");
+    if ( $class) print (" class=\"$class\"");
+    print ">\n";
+  }
 
+  function row_end () {
+    print "</tr>\n";
+  }
+
+  ////////////////////
+  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;
+  }
+
+}
+
+?>