dbHtmlTable (PHP class)

dbHtmlTable is a PHP class that returns or echoes an html table from a database query result.

• Requires PHP5 or later (but could be converted for use with PHP4)
• Requires an existing database connection
• Currently supports MySQL only, but easily modified for other data sources (see dbHtmlTable.class.extend.php)

See also: more usage examples and the dbHtmlTable download page

PUBLIC METHODS

createTable ..... return or echo the html table (depending on EchoHtml option)
getRowCount ..... return the number of rows (only after calling createTable)
getColumnCount .. return the number of columns (only after calling createTable)
setQuery ........ change the SQL query string
setOption ....... set a single option
setOptions ...... set one or more options
resetOptions .... reset all options to defaults

USAGE

After connecting to your database, a table can be generated as follows:

$HtmlTable = new dbHtmlTable(sqlString, optionsArray);
$HtmlTable->createTable();

or

$HtmlTable = new dbHtmlTable(sqlString);
$HtmlTable->setOptions(optionsArray);
$HtmlTable->createTable();

or

$HtmlTable = new dbHtmlTable(sqlString);
$HtmlTable->setOption(optionName, optionValue);
$HtmlTable->setOption(optionName, optionValue);
$HtmlTable->setOption(optionName, optionValue);
$HtmlTable->createTable();

or some combination thereof. It's also possible (though not necessarily recommended!) to set everything at once and echo the table in one line, by adding a third "force" parameter:

$HtmlTable = new dbHtmlTable(sqlString, optionsArray, true);

The class object can be re-used simply by calling the setQuery() method:

$HtmlTable->setQuery('select MORE from anothertable');
$HtmlTable->createTable();

Calling setQuery() automatically resets some options (those that apply to fields in the previous query, eg field alignment, etc)

See more usage examples

OPTIONS

The following table documents all the options supported by dbHtmlTable.

• Option names are NOT case sensitive.
• Some options accept a comma-separated list of fields (HideFields, AlignRight, CellClass, etc). For these:
  • fields can be specified either by their numerical position or fieldname
  • fieldnames ARE case sensitive
  • the special keyword FIRST (any case) means the first field in the row
  • the special keyword LAST (any case) means the last field in the row
• Some option names have aliases/shortcuts, as noted in the Alias column.

Class is a classname (or space separated class names)
Cond  is a comparison operator. Equals sign is not allowed; use @ instead.
          equal to .......... @
          not equal to ...... ! or !@ or <>
          greater than ...... >
          greater or equal .. >@
          less than ......... <
          less or equal ..... <@
Value is compared with the current value of the field. It can be a static string, or
      a fieldname in square brackets (the value of that field in the current row will be
      substituted). Value can NOT be an expression; if you need something more complex, 
      you could add a calculated field to the SQL as a hidden field and use a comparison 
      with that field.

       Amount=neg<0

       Amount=neg<0|big>[Average]

       Tmst=grey@,Id=me@6

    Href~||~Title~||~LinkAttrib

    Href ........ location href for the link destination
    Title ....... text to be used as a tooltip (on mouseover)
    LinkAttrib .. any other a attributes, eg 'onclick="doThing();"'

    array('AuthorRef' => 'edit.php?id=[AuthorId]~||~Update this author'

    $Url = 'mailto:[email]?subject=Subs%20renewal&body=';
    $Url .= rawurlencode("[firstname] [lastname]\r\n\r\nRenew at http://domain.com/renew?qr=[Hash]\r\n");
    // but don't urlencode square brackets!..
    $Url=str_replace(array('%5B', '%5D'), array('[', ']'), $Url);
    $HtmlTable->setOption('LinkFields', array('Hash'=>$Url));

More usage examples | dbHtmlTable download page