Source/carbon/libraries/Table.php

   1 <?php
   2 /*------------------------------------------------------------
   3 *  CarbonPHP framework (C) Tom Bell
   4 *  http://tombell.org.uk
   5 *------------------------------------------------------------*/
   6
   7 if (!defined('CARBON_PATH'))
   8 {
   9         exit('Direct script access is not allowed.');
  10 }
  11
  12 class Carbon_Table
  13 {
  14         private $rows = array();
  15         private $heading = array();
  16         private $auto_heading = true;
  17         private $caption = null;
  18         private $template = null;
  19         private $newline = "\n";
  20         private $empty_cells = '';
  21
  22         public function __construct()
  23         {
  24                 log_message('debug', 'Table class initialiased.');
  25         }
  26
  27         public function set_template($template)
  28         {
  29                 if (!is_array($template))
  30                 {
  31                         return false;
  32                 }
  33
  34                 $this->template = $template;
  35
  36                 return true;
  37         }
  38
  39         public function set_heading()
  40         {
  41                 $args = func_get_args();
  42                 $this->heading = (is_array($args[0])) ? $args[0] : $args;
  43         }
  44
  45         public function make_columns($array = array(), $col_limit = 0)
  46         {
  47                 if (!is_array($array) || count($array) == 0)
  48                 {
  49                         return false;
  50                 }
  51
  52                 $this->auto_heading = false;
  53
  54                 if ($col_limit == 0)
  55                 {
  56                         return $array;
  57                 }
  58
  59                 $new = array();
  60
  61                 while (count($array) > 0)
  62                 {
  63                         $temp = array_slice($array, 0, $col_limit);
  64                         $array = array_diff($array, $temp);
  65
  66                         if (count($temp) < $col_limit)
  67                         {
  68                                 for ($i = count($temp); $i < $col_limit; $i++)
  69                                 {
  70                                         $temp[] = '&nbsp';
  71                                 }
  72                         }
  73
  74                         $new[] = $temp;
  75                 }
  76
  77                 return $new;
  78         }
  79
  80         public function set_empty($value)
  81         {
  82                 $this->empty_cells = $value;
  83         }
  84
  85         public function add_row()
  86         {
  87                 $args = func_get_args();
  88                 $this->rows[] = (is_array($args[0])) ? $args[0] : $args;
  89         }
  90
  91         public function set_caption($caption)
  92         {
  93                 $this->caption = $caption;
  94         }
  95
  96         public function generate($table_data = null)
  97         {
  98                 if (!is_null($table_data))
  99                 {
 100                         if (is_object($table_data))
 101                         {
 102                                 $this->c_set_from_object($table_data);
 103                         }
 104                         elseif (is_array($table_data))
 105                         {
 106                                 $set_heading = (count($this->heading) == 0 && $this->auto_heading == false) ? false : true;
 107                                 $this->c_set_from_array($table_data, $set_heading);
 108                         }
 109                 }
 110
 111                 if (count($this->heading) == 0 && count($this->rows) == 0)
 112                 {
 113                         return 'Undefined table data';
 114                 }
 115
 116                 $this->c_compile_template();
 117
 118                 $out = $this->template['table_open'];
 119                 $out .= $this->newline;
 120
 121                 if ($this->caption)
 122                 {
 123                         $out .= $this->newline;
 124                         $out .= '<caption>' . $this->caption . '</caption>';
 125                         $out .= $this->newline;
 126                 }
 127
 128                 if (count($this->heading) > 0)
 129                 {
 130                         $out .= $this->template['heading_row_start'];
 131                         $out .= $this->newline;
 132
 133                         foreach ($this->heading as $heading)
 134                         {
 135                                 $out .= $this->template['heading_cell_start'];
 136                                 $out .= $heading;
 137                                 $out .= $this->template['heading_cell_end'];
 138                         }
 139
 140                         $out .= $this->template['heading_row_end'];
 141                         $out .= $this->newline;
 142                 }
 143
 144                 if (count($this->rows) > 0)
 145                 {
 146                         $i = 1;
 147
 148                         foreach ($this->rows as $row)
 149                         {
 150                                 if (!is_array($row))
 151                                 {
 152                                         break;
 153                                 }
 154
 155                                 $name = (fmod($i++, 2)) ? '' : 'alt_';
 156
 157                                 $out .= $this->template['row_' . $name . 'start'];
 158                                 $out .= $this->newline;
 159
 160                                 foreach ($row as $cell)
 161                                 {
 162                                         $out .= $this->template['cell_' . $name . 'start'];
 163
 164                                         if ($cell == '')
 165                                         {
 166                                                 $out .= $this->empty_cells;
 167                                         }
 168                                         else
 169                                         {
 170                                                 $out .= $cell;
 171                                         }
 172
 173                                         $out .= $this->template['cell_' . $name . 'end'];
 174                                 }
 175
 176                                 $out .= $this->template['row_' . $name . 'end'];
 177                                 $out .= $this->newline;
 178                         }
 179                 }
 180
 181                 $out .= $this->template['table_close'];
 182
 183                 return $out;
 184         }
 185
 186         public function clear()
 187         {
 188                 $this->rows = array();
 189                 $this->heading = array();
 190                 $this->auto_heading = true;
 191         }
 192
 193         private function c_set_from_object($query)
 194         {
 195                 if (!is_object($query))
 196                 {
 197                         return false;
 198                 }
 199
 200                 if (count($this->heading) == 0)
 201                 {
 202                         if (!method_exists($query, 'list_fields'))
 203                         {
 204                                 return false;
 205                         }
 206
 207                         $this->heading = $query->list_fields();
 208                 }
 209
 210                 if ($query->num_rows() > 0)
 211                 {
 212                         foreach ($query->result_array() as $row)
 213                         {
 214                                 $this->rows[] = $row;
 215                         }
 216                 }
 217         }
 218
 219         private function c_set_from_array($data, $set_heading = true)
 220         {
 221                 if (!is_array($data) || count($data) == 0)
 222                 {
 223                         return false;
 224                 }
 225
 226                 $i = 0;
 227
 228                 foreach ($data as $row)
 229                 {
 230                         if (!is_array($row))
 231                         {
 232                                 $this->rows[] = $data;
 233                                 break;
 234                         }
 235
 236                         if ($i == 0 && count($data) > 1 && count($this->heading) == 0 && $set_heading == true)
 237                         {
 238                                 $this->heading = $row;
 239                         }
 240                         else
 241                         {
 242                                 $this->rows[] = $row;
 243                         }
 244
 245                         $i++;
 246                 }
 247         }
 248
 249         private function c_compile_template()
 250         {
 251                 if ($this->template == null)
 252                 {
 253                         $this->template = $this->c_default_template();
 254                         return true;
 255                 }
 256
 257                 $this->temp = $this->c_default_template();
 258                 $template = array(
 259                         'table_open',
 260                         'heading_row_start',
 261                         'heading_row_end',
 262                         'heading_cell_start',
 263                         'heading_cell_end',
 264                         'row_start',
 265                         'row_end',
 266                         'cell_start',
 267                         'cell_end',
 268                         'row_alt_start',
 269                         'row_alt_end',
 270                         'cell_alt_start',
 271                         'call_alt_end',
 272                         'table_close'
 273                 );
 274
 275                 foreach ($template as $value)
 276                 {
 277                         if (!isset($this->template[$value]))
 278                         {
 279                                 $this->template[$value] = $this->temp[$value];
 280                         }
 281                 }
 282         }
 283
 284         private function c_default_template()
 285         {
 286                 $template = array(
 287                         'table_open' => '<table border="0" cellingpadding="4" cellspacing="0">',
 288                         'heading_row_start' => '<tr>',
 289                         'heading_row_end' => '</tr>',
 290                         'heading_cell_start' => '<th>',
 291                         'heading_cell_end' => '</th>',
 292                         'row_start' => '<tr>',
 293                         'row_end' => '</tr>',
 294                         'cell_start' => '<td>',
 295                         'cell_end' => '</td>',
 296                         'row_alt_start' => '<tr>',
 297                         'row_alt_end' => '</tr>',
 298                         'cell_alt_start' => '<td>',
 299                         'cell_alt_end' => '</td>',
 300                         'table_close' => '</table>'
 301                 );
 302
 303                 return $template;
 304         }
 305 }
 306
 307 ?>