Merge pull request mk-j#177 from andrewkesper/auto-filter

AutoFilter support

Author: mk-j

examples/ex09-autofilter.php

@@ -0,0 +1,18 @@
+<?php
+set_include_path( get_include_path().PATH_SEPARATOR."..");
+include_once("xlsxwriter.class.php");
+
+$chars = 'abcdefgh';
+
+$writer = new XLSXWriter();
+$writer->writeSheetHeader('Sheet1', array('col-string'=>'string','col-numbers'=>'integer','col-timestamps'=>'datetime'), ['auto_filter'=>true, 'widths'=>[15,15,30]] );
+for($i=0; $i<1000; $i++)
+{
+    $writer->writeSheetRow('Sheet1', array(
+        str_shuffle($chars),
+        rand()%10000,
+        date('Y-m-d H:i:s',time()-(rand()%31536000))
+    ));
+}
+$writer->writeToFile('xlsx-autofilter.xlsx');
+echo '#'.floor((memory_get_peak_usage())/1024/1024)."MB"."\n";

xlsxwriter.class.php

@@ -116,7 +116,7 @@ public function writeToFile($filename)
 		$zip->close();
 	}
 
-	protected function initializeSheet($sheet_name, $col_widths=array() )
+	protected function initializeSheet($sheet_name, $col_widths=array(), $auto_filter=false)
 	{
 		//if already initialized
 		if ($this->current_sheet==$sheet_name || isset($this->sheets[$sheet_name]))
@@ -134,6 +134,7 @@ protected function initializeSheet($sheet_name, $col_widths=array() )
 			'merge_cells' => array(),
 			'max_cell_tag_start' => 0,
 			'max_cell_tag_end' => 0,
+			'auto_filter' => $auto_filter,
 			'finalized' => false,
 		);
 		$sheet = &$this->sheets[$sheet_name];
@@ -203,7 +204,8 @@ public function writeSheetHeader($sheet_name, array $header_types, $col_options
     $style = &$col_options;
 
 		$col_widths = isset($col_options['widths']) ? (array)$col_options['widths'] : array();
-		self::initializeSheet($sheet_name, $col_widths);
+		$auto_filter = isset($col_options['auto_filter']) ? intval($col_options['auto_filter']) : false;
+		self::initializeSheet($sheet_name, $col_widths, $auto_filter);
 		$sheet = &$this->sheets[$sheet_name];
 		$sheet->columns = $this->initializeColumnTypes($header_types);
 		if (!$suppress_row)
@@ -283,6 +285,12 @@ protected function finalizeSheet($sheet_name)
 			$sheet->file_writer->write(    '</mergeCells>');
 		}
 
+		$max_cell = self::xlsCell($sheet->row_count - 1, count($sheet->columns) - 1);
+
+		if ($sheet->auto_filter) {
+			$sheet->file_writer->write(    '<autoFilter ref="A1:' . $max_cell . '"/>');			
+		}
+
 		$sheet->file_writer->write(    '<printOptions headings="false" gridLines="false" gridLinesSet="true" horizontalCentered="false" verticalCentered="false"/>');
 		$sheet->file_writer->write(    '<pageMargins left="0.5" right="0.5" top="1.0" bottom="1.0" header="0.5" footer="0.5"/>');
 		$sheet->file_writer->write(    '<pageSetup blackAndWhite="false" cellComments="none" copies="1" draft="false" firstPageNumber="1" fitToHeight="1" fitToWidth="1" horizontalDpi="300" orientation="portrait" pageOrder="downThenOver" paperSize="1" scale="100" useFirstPageNumber="true" usePrinterDefaults="false" verticalDpi="300"/>');
@@ -292,7 +300,6 @@ protected function finalizeSheet($sheet_name)
 		$sheet->file_writer->write(    '</headerFooter>');
 		$sheet->file_writer->write('</worksheet>');
 
-		$max_cell = self::xlsCell($sheet->row_count - 1, count($sheet->columns) - 1);
 		$max_cell_tag = '<dimension ref="A1:' . $max_cell . '"/>';
 		$padding_length = $sheet->max_cell_tag_end - $sheet->max_cell_tag_start - strlen($max_cell_tag);
 		$sheet->file_writer->fseek($sheet->max_cell_tag_start);
@@ -635,6 +642,15 @@ protected function buildWorkbookXML()
 			$i++;
 		}
 		$workbook_xml.='</sheets>';
+		$workbook_xml.='<definedNames>';
+		foreach($this->sheets as $sheet_name=>$sheet) {
+			if ($sheet->auto_filter) {
+				$sheetname = self::sanitize_sheetname($sheet->sheetname);
+				$workbook_xml.='<definedName name="_xlnm._FilterDatabase" localSheetId="0" hidden="1">\''.self::xmlspecialchars($sheetname).'\'!$A$1:' . self::xlsCell($sheet->row_count - 1, count($sheet->columns) - 1, true) . '</definedName>';
+				$i++;	
+			}
+		}
+		$workbook_xml.='</definedNames>';
 		$workbook_xml.='<calcPr iterateCount="100" refMode="A1" iterate="false" iterateDelta="0.001"/></workbook>';
 		return $workbook_xml;
 	}
@@ -678,14 +694,18 @@ protected function buildContentTypesXML()
 	/*
 	 * @param $row_number int, zero based
 	 * @param $column_number int, zero based
-	 * @return Cell label/coordinates, ex: A1, C3, AA42
+	 * @param $absolute bool
+	 * @return Cell label/coordinates, ex: A1, C3, AA42 (or if $absolute==true: $A$1, $C$3, $AA$42)
 	 * */
-	public static function xlsCell($row_number, $column_number)
+	public static function xlsCell($row_number, $column_number, $absolute=false)
 	{
 		$n = $column_number;
 		for($r = ""; $n >= 0; $n = intval($n / 26) - 1) {
 			$r = chr($n%26 + 0x41) . $r;
 		}
+		if ($absolute) {
+			return '$' . $r . '$' . ($row_number+1);			
+		}
 		return $r . ($row_number+1);
 	}
 	//------------------------------------------------------------------