ILIAS  release_5-2 Revision v5.2.25-18-g3f80b828510
PHPExcel_Writer_Abstract Class Reference
+ Inheritance diagram for PHPExcel_Writer_Abstract:
+ Collaboration diagram for PHPExcel_Writer_Abstract:

Public Member Functions

 getIncludeCharts ()
 Write charts in workbook? If this is true, then the Writer will write definitions for any charts that exist in the PHPExcel object. More...
 
 setIncludeCharts ($pValue=FALSE)
 Set write charts in workbook Set to true, to advise the Writer to include any charts that exist in the PHPExcel object. More...
 
 getPreCalculateFormulas ()
 Get Pre-Calculate Formulas flag If this is true (the default), then the writer will recalculate all formulae in a workbook when saving, so that the pre-calculated values are immediately available to MS Excel or other office spreadsheet viewer when opening the file If false, then formulae are not calculated on save. More...
 
 setPreCalculateFormulas ($pValue=TRUE)
 Set Pre-Calculate Formulas Set to true (the default) to advise the Writer to calculate all formulae on save Set to false to prevent precalculation of formulae on save. More...
 
 getUseDiskCaching ()
 Get use disk caching where possible? More...
 
 setUseDiskCaching ($pValue=FALSE, $pDirectory=NULL)
 Set use disk caching where possible? More...
 
 getDiskCachingDirectory ()
 Get disk caching directory. More...
 
- Public Member Functions inherited from PHPExcel_Writer_IWriter
 save ($pFilename=NULL)
 Save PHPExcel to file. More...
 

Protected Attributes

 $_includeCharts = FALSE
 
 $_preCalculateFormulas = TRUE
 
 $_useDiskCaching = FALSE
 
 $_diskCachingDirectory = './'
 

Detailed Description

Definition at line 36 of file Abstract.php.

Member Function Documentation

◆ getDiskCachingDirectory()

PHPExcel_Writer_Abstract::getDiskCachingDirectory ( )

Get disk caching directory.

Returns
string

Definition at line 155 of file Abstract.php.

References $_diskCachingDirectory.

155  {
157  }

◆ getIncludeCharts()

PHPExcel_Writer_Abstract::getIncludeCharts ( )

Write charts in workbook? If this is true, then the Writer will write definitions for any charts that exist in the PHPExcel object.

If false (the default) it will ignore any charts defined in the PHPExcel object.

Returns
boolean

Definition at line 76 of file Abstract.php.

References $_includeCharts.

76  {
77  return $this->_includeCharts;
78  }

◆ getPreCalculateFormulas()

PHPExcel_Writer_Abstract::getPreCalculateFormulas ( )

Get Pre-Calculate Formulas flag If this is true (the default), then the writer will recalculate all formulae in a workbook when saving, so that the pre-calculated values are immediately available to MS Excel or other office spreadsheet viewer when opening the file If false, then formulae are not calculated on save.

This is faster for saving in PHPExcel, but slower when opening the resulting file in MS Excel, because Excel has to recalculate the formulae itself

Returns
boolean

Definition at line 103 of file Abstract.php.

References $_preCalculateFormulas.

103  {
105  }

◆ getUseDiskCaching()

PHPExcel_Writer_Abstract::getUseDiskCaching ( )

Get use disk caching where possible?

Returns
boolean

Definition at line 125 of file Abstract.php.

References $_useDiskCaching.

125  {
126  return $this->_useDiskCaching;
127  }

◆ setIncludeCharts()

PHPExcel_Writer_Abstract::setIncludeCharts (   $pValue = FALSE)

Set write charts in workbook Set to true, to advise the Writer to include any charts that exist in the PHPExcel object.

Set to false (the default) to ignore charts.

Parameters
boolean$pValue
Returns
PHPExcel_Writer_IWriter

Definition at line 88 of file Abstract.php.

88  {
89  $this->_includeCharts = (boolean) $pValue;
90  return $this;
91  }

◆ setPreCalculateFormulas()

PHPExcel_Writer_Abstract::setPreCalculateFormulas (   $pValue = TRUE)

Set Pre-Calculate Formulas Set to true (the default) to advise the Writer to calculate all formulae on save Set to false to prevent precalculation of formulae on save.

Parameters
boolean$pValuePre-Calculate Formulas?
Returns
PHPExcel_Writer_IWriter

Definition at line 115 of file Abstract.php.

115  {
116  $this->_preCalculateFormulas = (boolean) $pValue;
117  return $this;
118  }

◆ setUseDiskCaching()

PHPExcel_Writer_Abstract::setUseDiskCaching (   $pValue = FALSE,
  $pDirectory = NULL 
)

Set use disk caching where possible?

Parameters
boolean$pValue
string$pDirectoryDisk caching directory
Exceptions
PHPExcel_Writer_Exceptionwhen directory does not exist
Returns
PHPExcel_Writer_Excel2007

Definition at line 137 of file Abstract.php.

137  {
138  $this->_useDiskCaching = $pValue;
139 
140  if ($pDirectory !== NULL) {
141  if (is_dir($pDirectory)) {
142  $this->_diskCachingDirectory = $pDirectory;
143  } else {
144  throw new PHPExcel_Writer_Exception("Directory does not exist: $pDirectory");
145  }
146  }
147  return $this;
148  }

Field Documentation

◆ $_diskCachingDirectory

PHPExcel_Writer_Abstract::$_diskCachingDirectory = './'
protected

Definition at line 67 of file Abstract.php.

Referenced by getDiskCachingDirectory().

◆ $_includeCharts

PHPExcel_Writer_Abstract::$_includeCharts = FALSE
protected

Definition at line 44 of file Abstract.php.

Referenced by getIncludeCharts(), and PHPExcel_Writer_Excel2007\save().

◆ $_preCalculateFormulas

PHPExcel_Writer_Abstract::$_preCalculateFormulas = TRUE
protected

Definition at line 53 of file Abstract.php.

Referenced by getPreCalculateFormulas().

◆ $_useDiskCaching

PHPExcel_Writer_Abstract::$_useDiskCaching = FALSE
protected

Definition at line 60 of file Abstract.php.

Referenced by getUseDiskCaching().


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