Generate a binary format Microsoft Excel file for download. More...

Inheritance diagram for ExcelFile:

Collaboration diagram for ExcelFile:

Public Member Functions
	ExcelFile ($filename)
	Create a new ExcelFile object. More...

	_xlsBOF ()

	_xlsEOF ()

	writeNumber ($row, $col, $value)
	Write a number to the cell at the specified row and column. More...

	writeText ($row, $col, $value, $wrap=false)
	Write text to the cell at the specified row and column. More...

	writeHeading ($row, $col, $value)
	Write text with column heading styles. More...

	writeSubheading ($row, $col, $value)
	Write text with column sub-heading styles. More...

	writeFooter ($row, $col, $value)
	Write text with column footer styles. More...

	writeFooterNumber ($row, $col, $value)
	Write number with column footer styles. More...

	writePercentage ($row, $col, $value)
	Write a number to the cell at the specified row and column and format as a percentage. More...

	writeCurrency ($row, $col, $value)
	Write a number to the cell at the specified row and column with currency formatting. More...

	setWorksheetTitle ($title)
	Set the title of the currently active worksheet. More...

	addWorksheet ($title)
	Adds a new worksheet to the Excel file. More...

	abort ($error)
	Abort processing, output the specified error string. More...

	close ()
	Prevent further output to the spreadsheet. More...

	send ()
	Transmit the spreadsheet to the client. More...

Public Attributes
	$filename

	$open

	$content

Detailed Description

Generate a binary format Microsoft Excel file for download.

The default ExcelFile writer is an extremely limited implementation that outputs BIFF8 format (Excel 97/2000). It is designed to be compact and provide Excel output without incurring any external dependencies.

Author: andy

Definition at line 173 of file excel.inc.

Member Function Documentation

◆ _xlsBOF()

ExcelFile::_xlsBOF ( )

Definition at line 192 of file excel.inc.

      {
      echo pack("ssssss", 0x809, 0x8, 0x0, 0x10, 0x0, 0x0);  
      }

◆ _xlsEOF()

ExcelFile::_xlsEOF ( )

Definition at line 197 of file excel.inc.

      {
      echo pack("ss", 0x0A, 0x00);
      }

◆ abort()

ExcelFile::abort ( $error )

Abort processing, output the specified error string.

Parameters

string $error

Implements IExcelFile.

Definition at line 268 of file excel.inc.

      {
           ob_end_clean();
           ajaxReturn($error);
      }

◆ addWorksheet()

ExcelFile::addWorksheet ( $title )

Adds a new worksheet to the Excel file.

Parameters

string $title the title of the new worksheet

Implements IExcelFile.

Definition at line 263 of file excel.inc.

      {
           throw new Exception("Multiple worksheets are not supported with the built-in Excel writer. Install PHPExcel.");    
      }

◆ close()

ExcelFile::close ( )

Prevent further output to the spreadsheet.

Implements IExcelFile.

Definition at line 274 of file excel.inc.

      {
           $this->_xlsEOF();
           $this->content = ob_get_contents();
           ob_end_clean();
           $this->open = false;
      }

◆ ExcelFile()

ExcelFile::ExcelFile ( $filename )

Create a new ExcelFile object.

Parameters

string $filename the name of the file to generate

Definition at line 183 of file excel.inc.

      {
           $this->filename = $filename;
           ob_start();
           $this->open = true;
           $this->_xlsBOF();
      }

◆ send()

ExcelFile::send ( )

Transmit the spreadsheet to the client.

Implements IExcelFile.

Definition at line 282 of file excel.inc.

      {
           if ($this->open)
           {
                $this->close();
           }
  
           session_cache_limiter("private_no_expire, must-revalidate");
           header("Content-Type: application/vnd.msexcel");
           header("Content-Disposition: attachment;filename=$this->filename");
           header("Pragma: private");
           header("Content-Transfer-Encoding: binary");
           header("Content-Length: ".strlen($this->content));
           
           echo $this->content;
      }

◆ setWorksheetTitle()

ExcelFile::setWorksheetTitle ( $title )

Set the title of the currently active worksheet.

Parameters

string $title the title text.

Implements IExcelFile.

Definition at line 258 of file excel.inc.

      {
           throw new Exception("Multiple worksheets are not supported with the built-in Excel writer. Install PHPExcel.");
      }

◆ writeCurrency()

ExcelFile::writeCurrency	(	$row,
		$col,
		$value
	)

Write a number to the cell at the specified row and column with currency formatting.

Parameters

integer	$row
integer	$col
number	$value

Implements IExcelFile.

Definition at line 253 of file excel.inc.

      {
           $this->writeNumber($row, $col, $value);      
      }

◆ writeFooter()

ExcelFile::writeFooter	(	$row,
		$col,
		$value
	)

Write text with column footer styles.

Parameters

integer	$row
integer	$col
string	$value

Implements IExcelFile.

Definition at line 238 of file excel.inc.

      {
           return $this->writeText($row, $col, $value);
      }

◆ writeFooterNumber()

ExcelFile::writeFooterNumber	(	$row,
		$col,
		$value
	)

Write number with column footer styles.

Parameters

integer	$row
integer	$col
string	$value

Implements IExcelFile.

Definition at line 243 of file excel.inc.

      {
           return $this->writeNumber($row, $col, $value);
      }

◆ writeHeading()

ExcelFile::writeHeading	(	$row,
		$col,
		$value
	)

Write text with column heading styles.

Parameters

integer	$row
integer	$col
string	$value

Implements IExcelFile.

Definition at line 228 of file excel.inc.

      {
           return $this->writeText($row, $col, $value);
      }

◆ writeNumber()

ExcelFile::writeNumber	(	$row,
		$col,
		$value
	)

Write a number to the cell at the specified row and column.

Parameters

integer	$row
integer	$col
number	$value

Implements IExcelFile.

Definition at line 208 of file excel.inc.

      {
      echo pack("sssss", 0x203, 14, $row, $col, 0x0);
      echo pack("d", $value);
      }

◆ writePercentage()

ExcelFile::writePercentage	(	$row,
		$col,
		$value
	)

Write a number to the cell at the specified row and column and format as a percentage.

Parameters

integer	$row
integer	$col
number	$value

Implements IExcelFile.

Definition at line 248 of file excel.inc.

      {
           $this->writeText($row, $col, $value);
      }

◆ writeSubheading()

ExcelFile::writeSubheading	(	$row,
		$col,
		$value
	)

Write text with column sub-heading styles.

Parameters

integer	$row
integer	$col
string	$value

Implements IExcelFile.

Definition at line 233 of file excel.inc.

      {
           return $this->writeText($row, $col, $value);
      }

◆ writeText()

ExcelFile::writeText	(	$row,
		$col,
		$value,
		$wrap = `false`
	)

Write text to the cell at the specified row and column.

Parameters

integer	$row	the cell row number
integer	$col	the cell column number
string	$value	the string to insert
boolean	$wrap	whether to allow text wrapping

Implements IExcelFile.

Definition at line 221 of file excel.inc.

      {
      $len = strlen($value);
      echo pack("ssssss", 0x204, 8 + $len, $row, $col, 0x0, $len);
      echo $value;
      }

Member Data Documentation

◆ $content

ExcelFile::$content

Definition at line 177 of file excel.inc.

◆ $filename

ExcelFile::$filename

Definition at line 175 of file excel.inc.

◆ $open

ExcelFile::$open

Definition at line 176 of file excel.inc.

The documentation for this class was generated from the following file:

C:/code/cms.sonjara.com/framework/excel.inc

Public Member Functions

Public Attributes

Detailed Description

Member Function Documentation

◆ _xlsBOF()

◆ _xlsEOF()

◆ abort()

◆ addWorksheet()

◆ close()

◆ ExcelFile()

◆ send()

◆ setWorksheetTitle()

◆ writeCurrency()

◆ writeFooter()

◆ writeFooterNumber()

◆ writeHeading()

◆ writeNumber()

◆ writePercentage()

◆ writeSubheading()

◆ writeText()

Member Data Documentation

◆ $content

◆ $filename

◆ $open