git.roojs.org Git - Pman.Core/blob - SimpleExcel.php

   1 <?php
   2
   3 /**
   4  * class to generate excel file from rows of data, and a configuration.
   5  *
   6  * usage :
   7  *   $x = new Pman_Core_SimpleExcel(array())
   8  *   $x->send($fn);
   9  *
  10  *
  11  * cfg:
  12  *     formats
  13  *          name : [ Align : left, .... ]
  14  *
  15  *     workbook : nameof
  16  *
  17  *     head  : [
  18             [ "a", "b" ]
  19             [],
  20             [ "A", "B" ]
  21             [ "a",  ["test", "left"]  ] << sub array [text, formatname]
  22         ],
  23  *     cols :  array(
  24             array(
  25                 'header'=> "Thumbnail",
  26                 'dataIndex'=> 'id',
  27                 'width'=>  75,
  28                 'renderer' => array($this, 'getThumb'),
  29  *              'color' => 'yellow', // set color for the cell which is a header element
  30  *              'fillBlank' => 'gray', // set the color for the cell which is a blank area
  31             ),
  32
  33         // if this is set then it will add a tab foreach one.
  34         workbooks = array(
  35             workbook ->
  36
  37         'leave_open' => false
  38
  39  */
  40
  41
  42
  43
  44
  45 class Pman_Core_SimpleExcel extends Pman
  46 {
  47
  48     var $worksheet_cfg = array();
  49     var $start_row = 0;
  50     var $formats = array();
  51     var $workbook = false;
  52     var $worksheet= false;
  53
  54     function Pman_Core_SimpleExcel($data,$cfg)
  55     {
  56       // print_r($cfg);exit;
  57         require_once 'Spreadsheet/Excel/Writer.php';
  58         // Creating a workbook
  59         $outfile2 = $this->tempName('xls');
  60        // var_dump($outfile2);
  61         $workbook = new Spreadsheet_Excel_Writer($outfile2);
  62         //$workbook = new Spreadsheet_Excel_Writer();
  63         $workbook->setVersion(8);
  64         // sending HTTP headers
  65         $this->workbook = $workbook;
  66
  67         $formats = array();
  68
  69         $cfg['formats'] = isset($cfg['formats']) ? $cfg['formats'] : array();
  70
  71         foreach($cfg['formats'] as $f=>$fcfg) {
  72             $formats[$f] = & $workbook->addFormat();
  73             foreach($fcfg as $k=>$v) {
  74                 $formats[$f]->{'set' . $k}($v);
  75             }
  76
  77         }
  78
  79
  80         if (!isset($cfg['workbooks'])) {
  81             $this->buildpage(   $formats , $data,$cfg);
  82         } elseif (!empty($cfg['workbooks'])) {
  83             foreach($cfg['workbooks'] as $i =>$wcfg) {
  84                 $this->buildpage(   $formats , $data[$i],$wcfg);
  85             }
  86
  87         }
  88         // if workbooks == false - > the user can call buildpage..
  89
  90
  91         if (!empty($cfg['leave_open'])) {
  92             $this->outfile2 = $outfile2;
  93             return;
  94         }
  95
  96         $workbook->close();
  97         $this->outfile2 = $outfile2;
  98
  99     }
 100
 101
 102
 103
 104     static function date($str)
 105     {
 106
 107         return (strtotime($str . ' UTC') +  (86400 *  25569)) / 86400;
 108
 109     }
 110
 111
 112     function buildpage( $formats , $data, $cfg)
 113     {
 114         $workbook = $this->workbook;
 115         //echo '<PRE>';        print_R($cfg);
 116       //  print_r($cfg);exit;
 117         // Creating a worksheet
 118         //print_R($cfg);exit;
 119         // copy the config and alias so that book can be written to..
 120         $this->worksheet_cfg[$cfg['workbook']] = &$cfg;
 121
 122         $this->formats = $formats;
 123
 124         $worksheet =  $workbook->addWorksheet($cfg['workbook']);
 125         if (is_a($worksheet, 'PEAR_Error')) {
 126             die($worksheet->toString());
 127         }
 128         //print_R($worksheet);
 129         $worksheet->setInputEncoding('UTF-8');
 130
 131         $this->worksheet = $worksheet;
 132
 133         $start_row = 0;
 134
 135         if (!empty($cfg['head'])) {
 136             foreach($cfg['head'] as $row) {
 137                 foreach($row as $c => $col) {
 138                     if (is_array($col)) {
 139                         $format = isset($formats[$col[1]] ) ? $formats[$col[1]] : false;
 140                         $worksheet->write($start_row, $c, $col[0], $format);
 141                         continue;
 142                     }
 143
 144                     $worksheet->write($start_row, $c, $col);
 145
 146                 }
 147                 $start_row++;
 148             }
 149             // add a spacer..
 150             if(!isset($cfg['nonspacer'])){ $start_row++; }
 151         }
 152
 153
 154         foreach($cfg['cols'] as $c=>$col_cfg) {
 155             if (is_string($col_cfg)) {
 156                 $cfg['cols'][$c] = array(
 157                     'header' => $col_cfg,
 158                     'dataIndex' => $col_cfg,
 159                     'width' => 50,
 160
 161                 );
 162             }
 163         }
 164
 165
 166         foreach($cfg['cols'] as $c=>$col_cfg) {
 167             $format = isset($col_cfg['color']) ? $formats[$col_cfg['color']] : false;
 168             $worksheet->write($start_row, $c, $col_cfg['header'],$format);
 169             $worksheet->setColumn ( $c, $c, $col_cfg['width'] / 5);
 170
 171         }
 172         $start_row++;
 173         $this->start_row = &$start_row;
 174
 175
 176         $hasRender  = false;
 177
 178
 179         if (is_object($data)) {
 180             while ($data->fetch()) {
 181                 $hasRenderRow = $this->addLine($cfg['workbook'], $data->toArray());
 182                 $hasRender = ($hasRender  || $hasRenderRow) ? true : false;
 183
 184             }
 185            //     DB_DataObject::debugLevel(1);
 186         } else
 187         foreach($data as $r=>$clo) {
 188             $hasRenderRow = $this->addLine($cfg['workbook'], $clo);
 189             $hasRender = ($hasRender  || $hasRenderRow) ? true : false;
 190
 191         }
 192         /// call user render on any that are defined..
 193         if ($hasRender) {
 194             foreach($data as $r=>$cl) {
 195
 196                 foreach($cfg['cols']   as $c=>$col_cfg) {
 197                     $v = isset($cl[$col_cfg['dataIndex']]) ? $cl[$col_cfg['dataIndex']] : '';
 198                     if (empty($cl[$col_cfg['dataIndex']])) {
 199                         continue;
 200                     }
 201                     if (isset($col_cfg['renderer'])) {
 202                         // not sure if row is correct here...!!!?
 203                         call_user_func($col_cfg['renderer'], $cl[$col_cfg['dataIndex']], $worksheet, $r+1, $c, $cl);
 204
 205                     }
 206                   //  echo "<PRE>WRITE: ". htmlspecialchars(print_r(array($r+1, $c, $cl[$col_cfg['dataIndex']]), true));
 207
 208                 }
 209             }
 210         }
 211         $start_row += count($data);
 212
 213         if (!empty($cfg['foot'])) {
 214             foreach($cfg['foot'] as $row) {
 215                 foreach($row as $c => $col) {
 216                     // if it's an array? - formated ???
 217                     if (is_array($col)) {
 218                         $format = isset($formats[$col[1]] ) ? $formats[$col[1]] : false;
 219                         $worksheet->write($start_row, $c, $col[0], $format);
 220                         continue;
 221                     }
 222                     $worksheet->write($start_row, $c, $col);
 223
 224                 }
 225                 $start_row++;
 226             }
 227             // add a spacer..
 228             $start_row++;
 229         }
 230
 231
 232
 233     }
 234
 235     function addLine($worksheet_name, $clo)
 236     {
 237         $cfg        = $this->worksheet_cfg[$worksheet_name];
 238         $start_row  = $this->start_row;
 239         $formats    = $this->formats;
 240         $worksheet  = $this->worksheet;
 241
 242         $hasRender   = false;
 243         $r = 0;
 244
 245         $cl = $clo;
 246         if (is_object($clo)) {
 247             $cl = (array)$clo; // lossless converstion..
 248         }
 249
 250         if (isset($cfg['row_height'])) {
 251             $worksheet->setRow($start_row +$r, $cfg['row_height']);
 252         }
 253
 254         foreach($cfg['cols']  as $c=>$col_cfg) {
 255
 256             if(isset($cl[$col_cfg['dataIndex']])){
 257                 $v = $cl[$col_cfg['dataIndex']];
 258             }else{
 259                 if(isset($col_cfg['fillBlank'])){
 260                     $worksheet->write($start_row+$r, $c, '', $formats[$col_cfg['fillBlank']]);
 261                 }
 262                 continue;
 263             }
 264
 265             if (!isset($cl[$col_cfg['dataIndex']])) {
 266                 continue;
 267             }
 268             if (isset($col_cfg['txtrenderer'])) {
 269                 $v = call_user_func($col_cfg['txtrenderer'],
 270                         $cl[$col_cfg['dataIndex']], $worksheet, $r+1, $c, $clo);
 271                 if ($v === false) {
 272                     continue;
 273                 }
 274               //  var_dump($v);
 275             }
 276             if (isset($col_cfg['renderer'])) {
 277                 $hasRender = true;
 278                 continue;
 279             }
 280
 281             $v = @iconv('UTF-8', 'UTF-8//IGNORE', $v);
 282
 283
 284             $format = isset($col_cfg['format'])  && isset($formats[$col_cfg['format']] )   ? $formats[$col_cfg['format']] : false;
 285           //  print_R(array($start_row+$r, $c, $v, $format));exit;
 286           // handle 0 prefixes..
 287             if (is_numeric($v) &&  strlen($v) > 1 && substr($v,0,1) == '0' && substr($v,1,1) != '.' ) {
 288                 $worksheet->writeString($start_row+$r, $c, $v, $format);
 289             } else {
 290
 291                 $worksheet->write($start_row+$r, $c, $v, $format);
 292             }
 293         }
 294         $this->start_row++;
 295
 296         return $hasRender;
 297     }
 298
 299
 300     function send($fn)
 301     {
 302         if (!empty($this->workbook)) {
 303             $this->workbook->close();
 304             $this->workbook = false;
 305         }
 306
 307         require_once 'File/Convert.php';
 308         $fc=  new File_Convert($this->outfile2, "application/vnd.ms-excel");
 309         $fn = $fc->convert("application/vnd.ms-excel");
 310         $fc->serve('attachment',$fn); // can fix IE Mess
 311     }
 312
 313
 314 }