View source
<!-- This comment will put IE 6, 7 and 8 in quirks mode -->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Loft Data Grids: XLSXExporter Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javaScript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body onload='searchBox.OnSelectItem(0);'>
<!-- Generated by Doxygen 1.6.1 -->
<script type="text/javascript"><!--
var searchBox = new SearchBox("searchBox", "search",false,'Search');
--></script>
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li class="current"><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<img id="MSearchSelect" src="search/search.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</div>
</li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="classes.html"><span>Data Structure Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Data Fields</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>XLSXExporter Class Reference</h1><!-- doxytag: class="XLSXExporter" --><!-- doxytag: inherits="Exporter,ExporterInterface" --><div class="dynheader">
Inheritance diagram for XLSXExporter:</div>
<div class="dynsection">
<div class="center">
<img src="class_x_l_s_x_exporter.gif" usemap="#XLSXExporter_map" alt=""/>
<map id="XLSXExporter_map" name="XLSXExporter_map">
<area href="class_exporter.html" alt="Exporter" shape="rect" coords="0,56,110,80"/>
<area href="interface_exporter_interface.html" alt="ExporterInterface" shape="rect" coords="120,56,230,80"/>
<area href="interface_exporter_interface.html" alt="ExporterInterface" shape="rect" coords="0,0,110,24"/>
</map>
</div>
</div>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_l_s_x_exporter.html#ad7f780165fbe3d3576295be13e04e8e5">__construct</a> (<a class="el" href="interface_export_data_interface.html">ExportDataInterface</a> $data, $filename= '', $properties=array())</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_l_s_x_exporter.html#a164026f74736817927e1cacd282a2e28">getInfo</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_l_s_x_exporter.html#a884ba9bb0d54bde7839e798db7964476">setTitle</a> ($title)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_l_s_x_exporter.html#ac1b79f5a16bd9e0216a6ac0969ff666e">setProperties</a> ($properties)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_l_s_x_exporter.html#a522bfc5466273da36ddcb2c2b60e0da9">getProperty</a> ($property_name)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_l_s_x_exporter.html#a5b8d2fbc01b6e091448f513bef7b621d">export</a> ($page_id=NULL)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_l_s_x_exporter.html#adb5c3d683b4f3d7b1e1b1e351d2d38b9">compile</a> ($page_id=NULL)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_l_s_x_exporter.html#a21324fcf5d61fde9d0ff271a2d5cac5a">save</a> ($filename= '', $page_id=NULL)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_l_s_x_exporter.html#ab476521895e38f093a459aee2017eaa2">formatColumn</a> ($column, $format_code)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_l_s_x_exporter.html#acd760a0fc1101ced40a02667f239844f">getPHPExcelColumns</a> ()</td></tr>
<tr><td colspan="2"><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_l_s_x_exporter.html#aed02cd2cd0ee08bd99a2ac1ef4f955ce">$extension</a> = '.xlsx'</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_l_s_x_exporter.html#aa3d3eeb94f080f4d5da39e93ab5ded2a">$sheets</a> = array()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_l_s_x_exporter.html#acd6598663bd0d5306c73d89c1934e24d">$excel</a></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Class <a class="el" href="class_x_l_s_x_exporter.html">XLSXExporter</a></p>
<p><a href="http://www.phpexcel.net">http://www.phpexcel.net</a> </p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="ad7f780165fbe3d3576295be13e04e8e5"></a><!-- doxytag: member="XLSXExporter::__construct" ref="ad7f780165fbe3d3576295be13e04e8e5" args="(ExportDataInterface $data, $filename= '', $properties=array())" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">__construct </td>
<td>(</td>
<td class="paramtype"><a class="el" href="interface_export_data_interface.html">ExportDataInterface</a> $ </td>
<td class="paramname"> <em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">$ </td>
<td class="paramname"> <em>filename</em> = <code>''</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">$ </td>
<td class="paramname"> <em>properties</em> = <code>array()</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructor</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em><a class="el" href="interface_export_data_interface.html">ExportDataInterface</a></em> </td><td>$data </td></tr>
<tr><td valign="top"></td><td valign="top"><em>string</em> </td><td>$filename (Optional) Defaults to ''. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>array</em> </td><td>$properties </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="adb5c3d683b4f3d7b1e1b1e351d2d38b9"></a><!-- doxytag: member="XLSXExporter::compile" ref="adb5c3d683b4f3d7b1e1b1e351d2d38b9" args="($page_id=NULL)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">compile </td>
<td>(</td>
<td class="paramtype">$ </td>
<td class="paramname"> <em>page_id</em> = <code>NULL</code></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Build $this->output in prep for export/save</p>
<p>This is the main method to be extended for the different exporters </p>
<p>Reimplemented from <a class="el" href="class_exporter.html#adb5c3d683b4f3d7b1e1b1e351d2d38b9">Exporter</a>.</p>
</div>
</div>
<a class="anchor" id="a5b8d2fbc01b6e091448f513bef7b621d"></a><!-- doxytag: member="XLSXExporter::export" ref="a5b8d2fbc01b6e091448f513bef7b621d" args="($page_id=NULL)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">export </td>
<td>(</td>
<td class="paramtype">$ </td>
<td class="paramname"> <em>page_id</em> = <code>NULL</code></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the PHPExcel object</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>PHPExcel </dd></dl>
<p>Reimplemented from <a class="el" href="class_exporter.html#a5b8d2fbc01b6e091448f513bef7b621d">Exporter</a>.</p>
</div>
</div>
<a class="anchor" id="ab476521895e38f093a459aee2017eaa2"></a><!-- doxytag: member="XLSXExporter::formatColumn" ref="ab476521895e38f093a459aee2017eaa2" args="($column, $format_code)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">formatColumn </td>
<td>(</td>
<td class="paramtype">$ </td>
<td class="paramname"> <em>column</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">$ </td>
<td class="paramname"> <em>format_code</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Format a single column with a number format</p>
<p>You must do this after calling $this->compile!</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>string</em> </td><td>$column </td></tr>
<tr><td valign="top"></td><td valign="top"><em>string</em> </td><td>$format_code</p>
<ul>
<li>USD OR PHPExcel_Style_NumberFormat::setFormatCode()</li>
</ul>
</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>$this </dd></dl>
<p>Reimplemented from <a class="el" href="class_exporter.html#ab476521895e38f093a459aee2017eaa2">Exporter</a>.</p>
</div>
</div>
<a class="anchor" id="a164026f74736817927e1cacd282a2e28"></a><!-- doxytag: member="XLSXExporter::getInfo" ref="a164026f74736817927e1cacd282a2e28" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">getInfo </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return info about this class</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>type</em> </td><td>$string description</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>array<ul>
<li>name string The human name of this exporter</li>
<li>descripttion string A further description</li>
<li>extension string The file extension used by this class </li>
</ul>
</dd></dl>
<p>Reimplemented from <a class="el" href="class_exporter.html#a164026f74736817927e1cacd282a2e28">Exporter</a>.</p>
</div>
</div>
<a class="anchor" id="acd760a0fc1101ced40a02667f239844f"></a><!-- doxytag: member="XLSXExporter::getPHPExcelColumns" ref="acd760a0fc1101ced40a02667f239844f" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">getPHPExcelColumns </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Convert a column key into an excel column, e.g. A, AB, etc.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>string</em> </td><td>$column</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>string </dd></dl>
</div>
</div>
<a class="anchor" id="a522bfc5466273da36ddcb2c2b60e0da9"></a><!-- doxytag: member="XLSXExporter::getProperty" ref="a522bfc5466273da36ddcb2c2b60e0da9" args="($property_name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">getProperty </td>
<td>(</td>
<td class="paramtype">$ </td>
<td class="paramname"> <em>property_name</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the value of a single property or NULL</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>string</em> </td><td>$property_name e.g. Creator</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>mixed </dd></dl>
</div>
</div>
<a class="anchor" id="a21324fcf5d61fde9d0ff271a2d5cac5a"></a><!-- doxytag: member="XLSXExporter::save" ref="a21324fcf5d61fde9d0ff271a2d5cac5a" args="($filename= '', $page_id=NULL)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">save </td>
<td>(</td>
<td class="paramtype">$ </td>
<td class="paramname"> <em>filename</em> = <code>''</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">$ </td>
<td class="paramname"> <em>page_id</em> = <code>NULL</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Save as a file to the server</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>string</em> </td><td>$filename The correct extension will be appended to this string </td></tr>
<tr><td valign="top"></td><td valign="top"><em>mixed</em> </td><td>$page_id (Optional) Defaults to NULL. Set this to export a single page. </td></tr>
</table>
</dd>
</dl>
<p>Reimplemented from <a class="el" href="class_exporter.html#a21324fcf5d61fde9d0ff271a2d5cac5a">Exporter</a>.</p>
</div>
</div>
<a class="anchor" id="ac1b79f5a16bd9e0216a6ac0969ff666e"></a><!-- doxytag: member="XLSXExporter::setProperties" ref="ac1b79f5a16bd9e0216a6ac0969ff666e" args="($properties)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">setProperties </td>
<td>(</td>
<td class="paramtype">$ </td>
<td class="paramname"> <em>properties</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set properties</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>array</em> </td><td>$properties</p>
<ul>
<li>Title</li>
<li>Creator</li>
<li>LastModifiedBy</li>
<li>Description</li>
<li>Keywords</li>
<li>Category</li>
</ul>
</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>$this </dd></dl>
</div>
</div>
<a class="anchor" id="a884ba9bb0d54bde7839e798db7964476"></a><!-- doxytag: member="XLSXExporter::setTitle" ref="a884ba9bb0d54bde7839e798db7964476" args="($title)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">setTitle </td>
<td>(</td>
<td class="paramtype">$ </td>
<td class="paramname"> <em>title</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set a title for the exported document</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>$this </dd></dl>
<p>Reimplemented from <a class="el" href="class_exporter.html#a884ba9bb0d54bde7839e798db7964476">Exporter</a>.</p>
</div>
</div>
<hr/><h2>Field Documentation</h2>
<a class="anchor" id="acd6598663bd0d5306c73d89c1934e24d"></a><!-- doxytag: member="XLSXExporter::$excel" ref="acd6598663bd0d5306c73d89c1934e24d" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">$excel<code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="aed02cd2cd0ee08bd99a2ac1ef4f955ce"></a><!-- doxytag: member="XLSXExporter::$extension" ref="aed02cd2cd0ee08bd99a2ac1ef4f955ce" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">$extension = '.xlsx'<code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reimplemented from <a class="el" href="class_exporter.html#aed02cd2cd0ee08bd99a2ac1ef4f955ce">Exporter</a>.</p>
</div>
</div>
<a class="anchor" id="aa3d3eeb94f080f4d5da39e93ab5ded2a"></a><!-- doxytag: member="XLSXExporter::$sheets" ref="aa3d3eeb94f080f4d5da39e93ab5ded2a" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">$sheets = array()<code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="_x_l_s_x_exporter_8php.html">XLSXExporter.php</a></li>
</ul>
</div>
<!--- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated on Fri Jan 17 20:40:34 2014 for Loft Data Grids by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>
</html>
