\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

Summary

Methods
Properties
Constants
setZipClass()
getZipClass()
getCacheStorageMethod()
getCacheStorageClass()
setCacheStorageMethod()
setLocale()
setChartRenderer()
setChartRendererName()
setChartRendererPath()
getChartRendererName()
getChartRendererPath()
setPdfRenderer()
setPdfRendererName()
setPdfRendererPath()
getPdfRendererName()
getPdfRendererPath()
setLibXmlLoaderOptions()
getLibXmlLoaderOptions()
No public properties found
PCLZIP
ZIPARCHIVE
CHART_RENDERER_JPGRAPH
PDF_RENDERER_TCPDF
PDF_RENDERER_DOMPDF
PDF_RENDERER_MPDF
No protected methods found
No protected properties found
N/A
No private methods found
$chartRenderers
$pdfRenderers
$zipClass
$chartRendererName
$chartRendererPath
$pdfRendererName
$pdfRendererPath
$libXmlLoaderOptions
N/A

Constants

PCLZIP

PCLZIP = 'PHPExcel_Shared_ZipArchive'

Available Zip library classes

ZIPARCHIVE

ZIPARCHIVE = 'ZipArchive'

CHART_RENDERER_JPGRAPH

CHART_RENDERER_JPGRAPH = 'jpgraph'

Optional Chart Rendering libraries

PDF_RENDERER_TCPDF

PDF_RENDERER_TCPDF = 'tcPDF'

Optional PDF Rendering libraries

PDF_RENDERER_DOMPDF

PDF_RENDERER_DOMPDF = 'DomPDF'

PDF_RENDERER_MPDF

PDF_RENDERER_MPDF = 'mPDF'

Properties

$chartRenderers

$chartRenderers : 

Type

$pdfRenderers

$pdfRenderers : 

Type

$zipClass

$zipClass : string

Name of the class used for Zip file management e.g.

ZipArchive

Type

string

$chartRendererName

$chartRendererName : string

Name of the external Library used for rendering charts e.g.

jpgraph

Type

string

$chartRendererPath

$chartRendererPath : string

Directory Path to the external Library used for rendering charts

Type

string

$pdfRendererName

$pdfRendererName : string

Name of the external Library used for rendering PDF files e.g.

mPDF

Type

string

$pdfRendererPath

$pdfRendererPath : string

Directory Path to the external Library used for rendering PDF files

Type

string

$libXmlLoaderOptions

$libXmlLoaderOptions : integer

Default options for libxml loader

Type

integer

Methods

setZipClass()

setZipClass(string  $zipClass) : boolean

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. PHPExcel_Settings::PCLZip or PHPExcel_Settings::ZipArchive

Returns

boolean —

Success or failure

getZipClass()

getZipClass() : string

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

Returns

string —

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

getCacheStorageMethod()

getCacheStorageMethod() : string

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

Returns

string —

Name of the cacheing method

getCacheStorageClass()

getCacheStorageClass() : string

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

Returns

string —

Name of the class currently being used for cacheing

setCacheStorageMethod()

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

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

Returns

boolean —

Success or failure

setLocale()

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

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 "pt_br" or "en_uk")

Returns

boolean —

Success or failure

setChartRenderer()

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

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

Parameters

string $libraryName

Internal reference name of the library e.g. PHPExcel_Settings::CHART_RENDERER_JPGRAPH

string $libraryBaseDir

Directory path to the library's base folder

Returns

boolean —

Success or failure

setChartRendererName()

setChartRendererName(string  $libraryName) : boolean

Identify to PHPExcel the external library to use for rendering charts

Parameters

string $libraryName

Internal reference name of the library e.g. PHPExcel_Settings::CHART_RENDERER_JPGRAPH

Returns

boolean —

Success or failure

setChartRendererPath()

setChartRendererPath(string  $libraryBaseDir) : boolean

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

Parameters

string $libraryBaseDir

Directory path to the library's base folder

Returns

boolean —

Success or failure

getChartRendererName()

getChartRendererName() : string|NULL

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

Returns

string|NULL —

Internal reference name of the Chart Rendering Library that PHPExcel is currently configured to use e.g. PHPExcel_Settings::CHART_RENDERER_JPGRAPH

getChartRendererPath()

getChartRendererPath() : string|NULL

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

Returns

string|NULL —

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

setPdfRenderer()

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

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. PHPExcel_Settings::PDF_RENDERER_TCPDF, PHPExcel_Settings::PDF_RENDERER_DOMPDF or PHPExcel_Settings::PDF_RENDERER_MPDF

string $libraryBaseDir

Directory path to the library's base folder

Returns

boolean —

Success or failure

setPdfRendererName()

setPdfRendererName(string  $libraryName) : boolean

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

Parameters

string $libraryName

Internal reference name of the library e.g. PHPExcel_Settings::PDF_RENDERER_TCPDF, PHPExcel_Settings::PDF_RENDERER_DOMPDF or PHPExcel_Settings::PDF_RENDERER_MPDF

Returns

boolean —

Success or failure

setPdfRendererPath()

setPdfRendererPath(string  $libraryBaseDir) : boolean

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

Returns

boolean —

Success or failure

getPdfRendererName()

getPdfRendererName() : string|NULL

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

Returns

string|NULL —

Internal reference name of the PDF Rendering Library that PHPExcel is currently configured to use e.g. PHPExcel_Settings::PDF_RENDERER_TCPDF, PHPExcel_Settings::PDF_RENDERER_DOMPDF or PHPExcel_Settings::PDF_RENDERER_MPDF

getPdfRendererPath()

getPdfRendererPath() : string|NULL

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

Returns

string|NULL —

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

setLibXmlLoaderOptions()

setLibXmlLoaderOptions(integer  $options = null) 

Set options for libxml loader

Parameters

integer $options

Options for libxml loader

getLibXmlLoaderOptions()

getLibXmlLoaderOptions() : integer

Get defined options for libxml loader.

Defaults to LIBXML_DTDLOAD | LIBXML_DTDATTR when not set explicitly.

Returns

integer —

Default options for libxml loader