class PHPExcel_Settings

PHPExcel_Settings

Copyright (c) 2006 - 2015 PHPExcel

This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA

Constants

PCLZIP

Available Zip library classes

ZIPARCHIVE

CHART_RENDERER_JPGRAPH

Optional Chart Rendering libraries

PDF_RENDERER_TCPDF

Optional PDF Rendering libraries

PDF_RENDERER_DOMPDF

PDF_RENDERER_MPDF

Methods

static boolean
setZipClass(string $zipClass)

Set the Zip handler Class that PHPExcel should use for Zip file management (PCLZip or ZipArchive)

static string
getZipClass()

Return the name of the Zip handler Class that PHPExcel is configured to use (PCLZip or ZipArchive) or Zip file management

static string
getCacheStorageMethod()

Return the name of the method that is currently configured for cell cacheing

static string
getCacheStorageClass()

Return the name of the class that is currently being used for cell cacheing

static boolean
setCacheStorageMethod(string $method = PHPExcel_CachedObjectStorageFactory::cache_in_memory, array $arguments = array())

Set the method that should be used for cell cacheing

static boolean
setLocale(string $locale = 'en_us')

Set the locale code to use for formula translations and any special formatting

static boolean
setChartRenderer(string $libraryName, string $libraryBaseDir)

Set details of the external library that PHPExcel should use for rendering charts

static boolean
setChartRendererName(string $libraryName)

Identify to PHPExcel the external library to use for rendering charts

static boolean
setChartRendererPath(string $libraryBaseDir)

Tell PHPExcel where to find the external library to use for rendering charts

static string|NULL
getChartRendererName()

Return the Chart Rendering Library that PHPExcel is currently configured to use (e.g. jpgraph)

static string|NULL
getChartRendererPath()

Return the directory path to the Chart Rendering Library that PHPExcel is currently configured to use

static boolean
setPdfRenderer(string $libraryName, string $libraryBaseDir)

Set details of the external library that PHPExcel should use for rendering PDF files

static boolean
setPdfRendererName(string $libraryName)

Identify to PHPExcel the external library to use for rendering PDF files

static boolean
setPdfRendererPath(string $libraryBaseDir)

Tell PHPExcel where to find the external library to use for rendering PDF files

static string|NULL
getPdfRendererName()

Return the PDF Rendering Library that PHPExcel is currently configured to use (e.g. dompdf)

static string|NULL
getPdfRendererPath()

Return the directory path to the PDF Rendering Library that PHPExcel is currently configured to use

static 
setLibXmlLoaderOptions(int $options = null)

Set options for libxml loader

static int
getLibXmlLoaderOptions()

Get defined options for libxml loader.

Details

at line 141
static boolean setZipClass(string $zipClass)

Set the Zip handler Class that PHPExcel should use for Zip file management (PCLZip or ZipArchive)

Parameters

string $zipClass The Zip handler class that PHPExcel should use for Zip file management e.g. PHPExcelSettings::PCLZip or PHPExcelSettings::ZipArchive

Return Value

boolean Success or failure

at line 160
static string getZipClass()

Return the name of the Zip handler Class that PHPExcel is configured to use (PCLZip or ZipArchive) or Zip file management

Return Value

string Name of the Zip handler Class that PHPExcel is configured to use for Zip file management e.g. PHPExcelSettings::PCLZip or PHPExcelSettings::ZipArchive

at line 171
static string getCacheStorageMethod()

Return the name of the method that is currently configured for cell cacheing

Return Value

string Name of the cacheing method

at line 182
static string getCacheStorageClass()

Return the name of the class that is currently being used for cell cacheing

Return Value

string Name of the class currently being used for cacheing

at line 195
static boolean setCacheStorageMethod(string $method = PHPExcel_CachedObjectStorageFactory::cache_in_memory, array $arguments = array())

Set the method that should be used for cell cacheing

Parameters

string $method Name of the cacheing method
array $arguments Optional configuration arguments for the cacheing method

Return Value

boolean Success or failure

at line 207
static boolean setLocale(string $locale = 'en_us')

Set the locale code to use for formula translations and any special formatting

Parameters

string $locale The locale code to use (e.g. "fr" or "ptbr" or "enuk")

Return Value

boolean Success or failure

at line 222
static boolean setChartRenderer(string $libraryName, string $libraryBaseDir)

Set details of the external library that PHPExcel should use for rendering charts

Parameters

string $libraryName Internal reference name of the library e.g. PHPExcelSettings::CHARTRENDERER_JPGRAPH
string $libraryBaseDir Directory path to the library's base folder

Return Value

boolean Success or failure

at line 239
static boolean setChartRendererName(string $libraryName)

Identify to PHPExcel the external library to use for rendering charts

Parameters

string $libraryName Internal reference name of the library e.g. PHPExcelSettings::CHARTRENDERER_JPGRAPH

Return Value

boolean Success or failure

at line 256
static boolean setChartRendererPath(string $libraryBaseDir)

Tell PHPExcel where to find the external library to use for rendering charts

Parameters

string $libraryBaseDir Directory path to the library's base folder

Return Value

boolean Success or failure

at line 274
static string|NULL getChartRendererName()

Return the Chart Rendering Library that PHPExcel is currently configured to use (e.g. jpgraph)

Return Value

string|NULL Internal reference name of the Chart Rendering Library that PHPExcel is currently configured to use e.g. PHPExcelSettings::CHARTRENDERER_JPGRAPH

at line 286
static string|NULL getChartRendererPath()

Return the directory path to the Chart Rendering Library that PHPExcel is currently configured to use

Return Value

string|NULL Directory Path to the Chart Rendering Library that PHPExcel is currently configured to use

at line 303
static boolean setPdfRenderer(string $libraryName, string $libraryBaseDir)

Set details of the external library that PHPExcel should use for rendering PDF files

Parameters

string $libraryName Internal reference name of the library e.g. PHPExcelSettings::PDFRENDERERTCPDF, PHPExcelSettings::PDFRENDERERDOMPDF or PHPExcelSettings::PDFRENDERER_MPDF
string $libraryBaseDir Directory path to the library's base folder

Return Value

boolean Success or failure

at line 322
static boolean setPdfRendererName(string $libraryName)

Identify to PHPExcel the external library to use for rendering PDF files

Parameters

string $libraryName Internal reference name of the library e.g. PHPExcelSettings::PDFRENDERERTCPDF, PHPExcelSettings::PDFRENDERERDOMPDF or PHPExcelSettings::PDFRENDERER_MPDF

Return Value

boolean Success or failure

at line 339
static boolean setPdfRendererPath(string $libraryBaseDir)

Tell PHPExcel where to find the external library to use for rendering PDF files

Parameters

string $libraryBaseDir Directory path to the library's base folder

Return Value

boolean Success or failure

at line 359
static string|NULL getPdfRendererName()

Return the PDF Rendering Library that PHPExcel is currently configured to use (e.g. dompdf)

Return Value

string|NULL Internal reference name of the PDF Rendering Library that PHPExcel is currently configured to use e.g. PHPExcelSettings::PDFRENDERERTCPDF, PHPExcelSettings::PDFRENDERERDOMPDF or PHPExcelSettings::PDFRENDERER_MPDF

at line 370
static string|NULL getPdfRendererPath()

Return the directory path to the PDF Rendering Library that PHPExcel is currently configured to use

Return Value

string|NULL Directory Path to the PDF Rendering Library that PHPExcel is currently configured to use

at line 380
static setLibXmlLoaderOptions(int $options = null)

Set options for libxml loader

Parameters

int $options Options for libxml loader

at line 397
static int getLibXmlLoaderOptions()

Get defined options for libxml loader.

Defaults to LIBXMLDTDLOAD | LIBXMLDTDATTR when not set explicitly.

Return Value

int Default options for libxml loader