Documentation

/ Parameters

Parameters Default Description
sql_query null sql query to obtain the data. You must descriminate all fields i.e. SELECT id,rating,title,votes FROM imdbtop250 and not use SELECT * FROM imdbtop250

sql query

table_key null primary key of the table. Boost table performance.

text

data null data in array format

bidimensional array - $arr[rows][columns]

search null search word

text

multiple_search null multiple search by column

an array with the search words by column

items_per_page first value of items_per_page_init selected items per page

integer

sort true sort string

true, false, 1a_2d_t_f

page 1 number of the actual page

integer

total_items null total items of the data

integer

id table id of the table. Usefull for configuring the CSS when using multiples tables on same page

text

class null class of the table. Usefull for configuring the CSS when using multiples tables on same page

text

form_init true includes the html form tag or not

true; false;

form_url null specifies the form action url

text

form_method GET specifies the form method

GET or POST

header true text for the header fields separated by commas i.e. 'ID,Movie Title,Votes,...'

text

table_width null table width

with in % or px i.e. 100%; 700px, ...

width null columns width

integer separated by commas i.e. 50,100,,20,,...

search_init true show or not show the search option. You may also choose wich fields of the BD to search by building a string with t (true) anf f (false) that represent each filed i.e. 'tftf' search 1st and 3rd column only

true, false, ttftt

search_type like to search words that either looks like, it's equal, the beginning looks like or the end beginning looks like the keyword

like, =, beginning_like, end_like

search_html ... html to customize the search box

html

search_placeholder Search text for the search placeholder

text

multiple_search_init hide hide, show all, not show, or show only some columns of multiple search

hide, true, false, ttftt, ttftthide

multiple_search_type like to search words that either looks like, it's equal, the beginning looks like or the end beginning looks like the keyword on the multiple search

like, =, beginning_like, end_like

items_per_page_init 50*$i initialization of select box with the items per page. Values separated by columns or a formula using $i for the iteration.

false; 10,20,50,100; ($i+1)*10

items_per_page_all #TOTAL_ITEMS# show the all option in items per page and define the text to show

text; false

items_per_page_url null javascript code when items per page is changed

text

items_per_page_ids null when using multiple items per page in one table you need to tell the ids to the table

ids separated by commas i.e. ct1,ct2,...

sort_init true show or not to show the sort options. You may also choose wich columns to sort.

true, false ttftt

sort_order adt order of the sort. A string that represents (ascending, descending, true) i.e 'adt' = ascending -> descending -> true normal state

adt, ad, da, dat

sort_url null javascript code when sort column is clicked

text

extra_cols null array containing the information about extra columns

array(array(col,header,width,html),array(...),...)

odd_even true create class odd and even in rows

false, true

no_results No results found. html for the row when no results are returned

html

actions null array containing the value and the text of the actions select box

array(array($value,$text),...)

actions_url ctActions(#ID#) javascript code when actions select box is changed

text

pager null html for the pager

html

pager_ids null when using multiple pagers in one table you need to tell the ids to the table

ids separated by commas i.e. ct1,ct2,...

ajax_url $_SERVER['PHP_SELF'] url to be called by the ajax request

url

format_cols array() array with the new format for the columns

array(html or text,...)

display_cols null show or not show some columns, by building a string with t (true) anf f (false) that represent each column i.e. 'tftt' hide the second column

string composed by "t" or "f", i.e., ttftt or fttt

export_filename creative_table.csv name for the export file

text

csv_delimiter , CSV columns delimiter

text

csv_enclosure null CSV columns enclosure

text

charset UTF-8 chrset used for the table

charset code: UTF-8, ISO-8859-1, ...

extra_vars null ids of the html element to be included in the table

#html_element

debug true show the errors in the table

true, false, 0, 1 or 2

Possible values

In search_html, items_per_page_url, items_per_page_all, extra_col it is possible to use the following tags:

  • #ID#
  • #CLASS#
  • #ROW#
  • #PAGE#
  • #ITEMS_PER_PAGE#
  • #TOTAL_ITEMS#

Also, in format_cols and extra_col it is possible to get the value of a column by using #COL + COLUMN NUMBER + #, ie:

  • #COL2#
  • #COL5#