RetailCRM-Mirror/PHPExcel
1
0
Fork 0
mirror of https://github.com/retailcrm/PHPExcel.git synced 2024-11-26 15:26:03 +03:00
Code Issues Projects Releases Wiki Activity

Doc Block changes

Browse Source 
git-svn-id: https://phpexcel.svn.codeplex.com/svn/trunk@87554 2327b42d-5241-43d6-9e2a-de5ac946f064
This commit is contained in:
Mark Baker 2012-03-10 11:38:35 +00:00
parent 19403c43d8
commit 0de1f6324d
5 changed files with 41 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
Classes/PHPExcel/Writer/Excel2007/Worksheet.php
View File

@ -40,6 +40,7 @@ class PHPExcel_Writer_Excel2007_Worksheet extends PHPExcel_Writer_Excel2007_Writ
* *
* @param PHPExcel_Worksheet $pSheet * @param PHPExcel_Worksheet $pSheet
* @param string[] $pStringTable * @param string[] $pStringTable
* @param boolean $includeCharts Flag indicating if we should write charts
* @return string XML Output * @return string XML Output
* @throws Exception * @throws Exception
*/ */
@ -959,7 +960,7 @@ class PHPExcel_Writer_Excel2007_Worksheet extends PHPExcel_Writer_Excel2007_Writ
* *
* @param PHPExcel_Shared_XMLWriter $objWriter XML Writer * @param PHPExcel_Shared_XMLWriter $objWriter XML Writer
* @param PHPExcel_Worksheet $pSheet Worksheet * @param PHPExcel_Worksheet $pSheet Worksheet
* @param PHPExcel_Cell $pCell Cell * @param PHPExcel_Cell $pCellAddress Cell Address
* @param string[] $pStringTable String table * @param string[] $pStringTable String table
* @param string[] $pFlippedStringTable String table (flipped), for faster index searching * @param string[] $pFlippedStringTable String table (flipped), for faster index searching
* @throws Exception * @throws Exception
@ -1081,8 +1082,9 @@ class PHPExcel_Writer_Excel2007_Worksheet extends PHPExcel_Writer_Excel2007_Writ
/** /**
* Write Drawings * Write Drawings
* *
* @param PHPExcel_Shared_XMLWriter $objWriter XML Writer * @param PHPExcel_Shared_XMLWriter $objWriter XML Writer
* @param PHPExcel_Worksheet $pSheet Worksheet * @param PHPExcel_Worksheet $pSheet Worksheet
* @param boolean $includeCharts Flag indicating if we should include drawing details for charts
* @throws Exception * @throws Exception
*/ */
private function _writeDrawings(PHPExcel_Shared_XMLWriter $objWriter = null, PHPExcel_Worksheet $pSheet = null, $includeCharts = FALSE) private function _writeDrawings(PHPExcel_Shared_XMLWriter $objWriter = null, PHPExcel_Worksheet $pSheet = null, $includeCharts = FALSE)

5
Classes/PHPExcel/Writer/Excel5/Font.php
View File

@ -139,6 +139,11 @@ class PHPExcel_Writer_Excel5_Font
return 0x190; // 400 = Normal font weight return 0x190; // 400 = Normal font weight
} }
/**
* Map of BIFF2-BIFF8 codes for underline styles
* @static array of int
*
*/
private static $_mapUnderline = array( PHPExcel_Style_Font::UNDERLINE_NONE => 0x00, private static $_mapUnderline = array( PHPExcel_Style_Font::UNDERLINE_NONE => 0x00,
PHPExcel_Style_Font::UNDERLINE_SINGLE => 0x01, PHPExcel_Style_Font::UNDERLINE_SINGLE => 0x01,
PHPExcel_Style_Font::UNDERLINE_DOUBLE => 0x02, PHPExcel_Style_Font::UNDERLINE_DOUBLE => 0x02,

41
Classes/PHPExcel/Writer/Excel5/Parser.php
View File

@ -118,8 +118,6 @@ class PHPExcel_Writer_Excel5_Parser
/** /**
* The class constructor * The class constructor
* *
* @param integer $byte_order The byte order (Little endian or Big endian) of the architecture
* (optional). 1 => big endian, 0 (default) little endian.
*/ */
public function __construct() public function __construct()
{ {
@ -634,7 +632,8 @@ class PHPExcel_Writer_Excel5_Parser
* Convert an Excel range such as A1:D4 to a ptgRefV. * Convert an Excel range such as A1:D4 to a ptgRefV.
* *
* @access private * @access private
* @param string $range An Excel range in the A1:A2 * @param string $range An Excel range in the A1:A2
* @param int $class
*/ */
function _convertRange2d($range, $class=0) function _convertRange2d($range, $class=0)
{ {
@ -776,30 +775,31 @@ class PHPExcel_Writer_Excel5_Parser
/** /**
* Convert an error code to a ptgErr * Convert an error code to a ptgErr
* *
* @access private * @access private
* @param mixed $num an error codefor conversion to its ptg value * @param string $errorCode The error code for conversion to its ptg value
* @return string The error code ptgErr
*/ */
function _convertError($errorCode) function _convertError($errorCode)
{ {
switch ($errorCode) { switch ($errorCode) {
case '#NULL!': return pack("C", 0x00); case '#NULL!': return pack("C", 0x00);
case '#DIV/0!': return pack("C", 0x07); case '#DIV/0!': return pack("C", 0x07);
case '#VALUE!': return pack("C", 0x0F); case '#VALUE!': return pack("C", 0x0F);
case '#REF!': return pack("C", 0x17); case '#REF!': return pack("C", 0x17);
case '#NAME?': return pack("C", 0x1D); case '#NAME?': return pack("C", 0x1D);
case '#NUM!': return pack("C", 0x24); case '#NUM!': return pack("C", 0x24);
case '#N/A': return pack("C", 0x2A); case '#N/A': return pack("C", 0x2A);
} }
return pack("C", 0xFF); return pack("C", 0xFF);
} }
/** /**
* Convert the sheet name part of an external reference, for example "Sheet1" or * Convert the sheet name part of an external reference, for example "Sheet1" or
* "Sheet1:Sheet2", to a packed structure. * "Sheet1:Sheet2", to a packed structure.
* *
* @access private * @access private
* @param string $ext_ref The name of the external reference * @param string $ext_ref The name of the external reference
* @return string The reference index in packed() format * @return string The reference index in packed() format
*/ */
function _packExtRef($ext_ref) function _packExtRef($ext_ref)
{ {
@ -902,8 +902,9 @@ class PHPExcel_Writer_Excel5_Parser
* sheet names is updated by the addworksheet() method of the * sheet names is updated by the addworksheet() method of the
* PHPExcel_Writer_Excel5_Workbook class. * PHPExcel_Writer_Excel5_Workbook class.
* *
* @access private * @access private
* @return integer The sheet index, -1 if the sheet was not found * @param string $sheet_name Sheet name
* @return integer The sheet index, -1 if the sheet was not found
*/ */
function _getSheetIndex($sheet_name) function _getSheetIndex($sheet_name)
{ {

15
Classes/PHPExcel/Writer/Excel5/Workbook.php
View File

@ -193,11 +193,12 @@ class PHPExcel_Writer_Excel5_Workbook extends PHPExcel_Writer_Excel5_BIFFwriter
/** /**
* Class constructor * Class constructor
* *
* @param PHPExcel $phpExcel The Workbook * @param PHPExcel $phpExcel The Workbook
* @param int $str_total Total number of strings * @param int &$str_total Total number of strings
* @param int $str_unique Total number of unique strings * @param int &$str_unique Total number of unique strings
* @param array $str_table * @param array &$str_table String Table
* @param mixed $parser The formula parser created for the Workbook * @param array &$colors Colour Table
* @param mixed $parser The formula parser created for the Workbook
*/ */
public function __construct(PHPExcel $phpExcel = null, public function __construct(PHPExcel $phpExcel = null,
&$str_total, &$str_unique, &$str_table, &$colors, &$str_total, &$str_unique, &$str_table, &$colors,
@ -418,8 +419,8 @@ class PHPExcel_Writer_Excel5_Workbook extends PHPExcel_Writer_Excel5_BIFFwriter
* Assemble worksheets into a workbook and send the BIFF data to an OLE * Assemble worksheets into a workbook and send the BIFF data to an OLE
* storage. * storage.
* *
* @param array $worksheetSizes The sizes in bytes of the binary worksheet streams * @param array $pWorksheetSizes The sizes in bytes of the binary worksheet streams
* @return string Binary data for workbook stream * @return string Binary data for workbook stream
*/ */
public function writeWorkbook($pWorksheetSizes = null) public function writeWorkbook($pWorksheetSizes = null)
{ {

4
Classes/PHPExcel/Writer/Excel5/Worksheet.php
View File

@ -204,8 +204,8 @@ class PHPExcel_Writer_Excel5_Worksheet extends PHPExcel_Writer_Excel5_BIFFwriter
* *
* @param int &$str_total Total number of strings * @param int &$str_total Total number of strings
* @param int &$str_unique Total number of unique strings * @param int &$str_unique Total number of unique strings
* @param array &$str_table * @param array &$str_table String Table
* @param array &$colors * @param array &$colors Colour Table
* @param mixed $parser The formula parser created for the Workbook * @param mixed $parser The formula parser created for the Workbook
* @param boolean $preCalculateFormulas Flag indicating whether formulas should be calculated or just written * @param boolean $preCalculateFormulas Flag indicating whether formulas should be calculated or just written
* @param string $phpSheet The worksheet to write * @param string $phpSheet The worksheet to write