summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--user_guide_src/source/libraries/table.rst119
1 files changed, 108 insertions, 11 deletions
diff --git a/user_guide_src/source/libraries/table.rst b/user_guide_src/source/libraries/table.rst
index 6ca6bc971..9bc3f3423 100644
--- a/user_guide_src/source/libraries/table.rst
+++ b/user_guide_src/source/libraries/table.rst
@@ -26,7 +26,16 @@ function described in the function reference below).
::
- $this->load->library('table'); $data = array(              array('Name', 'Color', 'Size'),              array('Fred', 'Blue', 'Small'),              array('Mary', 'Red', 'Large'),              array('John', 'Green', 'Medium')              ); echo $this->table->generate($data);
+ $this->load->library('table');
+
+ $data = array(
+ array('Name', 'Color', 'Size'),
+ array('Fred', 'Blue', 'Small'),
+ array('Mary', 'Red', 'Large'),
+ array('John', 'Green', 'Medium')
+ );
+
+ echo $this->table->generate($data);
Here is an example of a table created from a database query result. The
table class will automatically generate the headings based on the table
@@ -35,17 +44,37 @@ function described in the function reference below).
::
- $this->load->library('table'); $query = $this->db->query("SELECT * FROM my_table"); echo $this->table->generate($query);
+ $this->load->library('table');
+
+ $query = $this->db->query("SELECT * FROM my_table");
+
+ echo $this->table->generate($query);
Here is an example showing how you might create a table using discrete
parameters::
- $this->load->library('table'); $this->table->set_heading('Name', 'Color', 'Size'); $this->table->add_row('Fred', 'Blue', 'Small'); $this->table->add_row('Mary', 'Red', 'Large'); $this->table->add_row('John', 'Green', 'Medium'); echo $this->table->generate();
+ $this->load->library('table');
+
+ $this->table->set_heading('Name', 'Color', 'Size');
+
+ $this->table->add_row('Fred', 'Blue', 'Small');
+ $this->table->add_row('Mary', 'Red', 'Large');
+ $this->table->add_row('John', 'Green', 'Medium');
+
+ echo $this->table->generate();
Here is the same example, except instead of individual parameters,
arrays are used::
- $this->load->library('table'); $this->table->set_heading(array('Name', 'Color', 'Size')); $this->table->add_row(array('Fred', 'Blue', 'Small')); $this->table->add_row(array('Mary', 'Red', 'Large')); $this->table->add_row(array('John', 'Green', 'Medium')); echo $this->table->generate();
+ $this->load->library('table');
+
+ $this->table->set_heading(array('Name', 'Color', 'Size'));
+
+ $this->table->add_row(array('Fred', 'Blue', 'Small'));
+ $this->table->add_row(array('Mary', 'Red', 'Large'));
+ $this->table->add_row(array('John', 'Green', 'Medium'));
+
+ echo $this->table->generate();
Changing the Look of Your Table
===============================
@@ -53,7 +82,28 @@ Changing the Look of Your Table
The Table Class permits you to set a table template with which you can
specify the design of your layout. Here is the template prototype::
- $tmpl = array (                     'table_open'          => '<table border="0" cellpadding="4" cellspacing="0">',                     'heading_row_start'   => '<tr>',                     'heading_row_end'     => '</tr>',                     'heading_cell_start'  => '<th>',                     'heading_cell_end'    => '</th>',                     'row_start'           => '<tr>',                     'row_end'             => '</tr>',                     'cell_start'          => '<td>',                     'cell_end'            => '</td>',                     'row_alt_start'       => '<tr>',                     'row_alt_end'         => '</tr>',                     'cell_alt_start'      => '<td>',                     'cell_alt_end'        => '</td>',                     'table_close'         => '</table>'               ); $this->table->set_template($tmpl);
+ $tmpl = array (
+ 'table_open' => '<table border="0" cellpadding="4" cellspacing="0">',
+
+ 'heading_row_start' => '<tr>',
+ 'heading_row_end' => '</tr>',
+ 'heading_cell_start' => '<th>',
+ 'heading_cell_end' => '</th>',
+
+ 'row_start' => '<tr>',
+ 'row_end' => '</tr>',
+ 'cell_start' => '<td>',
+ 'cell_end' => '</td>',
+
+ 'row_alt_start' => '<tr>',
+ 'row_alt_end' => '</tr>',
+ 'cell_alt_start' => '<td>',
+ 'cell_alt_end' => '</td>',
+
+ 'table_close' => '</table>'
+ );
+
+ $this->table->set_template($tmpl);
.. note:: You'll notice there are two sets of "row" blocks in the
template. These permit you to create alternating row colors or design
@@ -63,7 +113,9 @@ You are NOT required to submit a complete template. If you only need to
change parts of the layout you can simply submit those elements. In this
example, only the table opening tag is being changed::
- $tmpl = array ( 'table_open'  => '<table border="1" cellpadding="2" cellspacing="1" class="mytable">' ); $this->table->set_template($tmpl);
+ $tmpl = array ( 'table_open' => '<table border="1" cellpadding="2" cellspacing="1" class="mytable">' );
+
+ $this->table->set_template($tmpl);
******************
Function Reference
@@ -113,7 +165,11 @@ use an associative array for that cell. The associative key 'data'
defines the cell's data. Any other key => val pairs are added as
key='val' attributes to the tag::
- $cell = array('data' => 'Blue', 'class' => 'highlight', 'colspan' => 2); $this->table->add_row($cell, 'Red', 'Green'); // generates // <td class='highlight' colspan='2'>Blue</td><td>Red</td><td>Green</td>
+ $cell = array('data' => 'Blue', 'class' => 'highlight', 'colspan' => 2);
+ $this->table->add_row($cell, 'Red', 'Green');
+
+ // generates
+ // <td class='highlight' colspan='2'>Blue</td><td>Red</td><td>Green</td>
$this->table->make_columns()
=============================
@@ -123,7 +179,24 @@ multi-dimensional array with a depth equal to the number of columns
desired. This allows a single array with many elements to be displayed
in a table that has a fixed column count. Consider this example::
- $list = array('one', 'two', 'three', 'four', 'five', 'six', 'seven', 'eight', 'nine', 'ten', 'eleven', 'twelve'); $new_list = $this->table->make_columns($list, 3); $this->table->generate($new_list); // Generates a table with this prototype <table border="0" cellpadding="4" cellspacing="0"> <tr> <td>one</td><td>two</td><td>three</td> </tr><tr> <td>four</td><td>five</td><td>six</td> </tr><tr> <td>seven</td><td>eight</td><td>nine</td> </tr><tr> <td>ten</td><td>eleven</td><td>twelve</td></tr> </table>
+ $list = array('one', 'two', 'three', 'four', 'five', 'six', 'seven', 'eight', 'nine', 'ten', 'eleven', 'twelve');
+
+ $new_list = $this->table->make_columns($list, 3);
+
+ $this->table->generate($new_list);
+
+ // Generates a table with this prototype
+
+ <table border="0" cellpadding="4" cellspacing="0">
+ <tr>
+ <td>one</td><td>two</td><td>three</td>
+ </tr><tr>
+ <td>four</td><td>five</td><td>six</td>
+ </tr><tr>
+ <td>seven</td><td>eight</td><td>nine</td>
+ </tr><tr>
+ <td>ten</td><td>eleven</td><td>twelve</td></tr>
+ </table>
$this->table->set_template()
=============================
@@ -133,7 +206,9 @@ template.
::
- $tmpl = array ( 'table_open'  => '<table border="1" cellpadding="2" cellspacing="1" class="mytable">' ); $this->table->set_template($tmpl);
+ $tmpl = array ( 'table_open' => '<table border="1" cellpadding="2" cellspacing="1" class="mytable">' );
+
+ $this->table->set_template($tmpl);
$this->table->set_empty()
==========================
@@ -151,7 +226,23 @@ multiple tables with different data you should to call this function
after each table has been generated to empty the previous table
information. Example::
- $this->load->library('table'); $this->table->set_heading('Name', 'Color', 'Size'); $this->table->add_row('Fred', 'Blue', 'Small'); $this->table->add_row('Mary', 'Red', 'Large'); $this->table->add_row('John', 'Green', 'Medium'); echo $this->table->generate(); $this->table->clear(); $this->table->set_heading('Name', 'Day', 'Delivery'); $this->table->add_row('Fred', 'Wednesday', 'Express'); $this->table->add_row('Mary', 'Monday', 'Air'); $this->table->add_row('John', 'Saturday', 'Overnight'); echo $this->table->generate();
+ $this->load->library('table');
+
+ $this->table->set_heading('Name', 'Color', 'Size');
+ $this->table->add_row('Fred', 'Blue', 'Small');
+ $this->table->add_row('Mary', 'Red', 'Large');
+ $this->table->add_row('John', 'Green', 'Medium');
+
+ echo $this->table->generate();
+
+ $this->table->clear();
+
+ $this->table->set_heading('Name', 'Day', 'Delivery');
+ $this->table->add_row('Fred', 'Wednesday', 'Express');
+ $this->table->add_row('Mary', 'Monday', 'Air');
+ $this->table->add_row('John', 'Saturday', 'Overnight');
+
+ echo $this->table->generate();
$this->table->function
======================
@@ -161,7 +252,13 @@ object to be applied to all cell data.
::
- $this->load->library('table'); $this->table->set_heading('Name', 'Color', 'Size'); $this->table->add_row('Fred', '<strong>Blue</strong>', 'Small'); $this->table->function = 'htmlspecialchars'; echo $this->table->generate();
+ $this->load->library('table');
+
+ $this->table->set_heading('Name', 'Color', 'Size');
+ $this->table->add_row('Fred', '<strong>Blue</strong>', 'Small');
+
+ $this->table->function = 'htmlspecialchars';
+ echo $this->table->generate();
In the above example, all cell data would be ran through PHP's
htmlspecialchars() function, resulting in::