\PHPExcel_Settings

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

File: core/class/PHPExcel/Settings.php
Package: PHPExcel\Settings
Class hierarchy: \PHPExcel_Settings
Uses

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

$_pdfRenderers

$_pdfRenderers

$_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 : int

Default options for libxml loader

Type

int —

Methods

setZipClass()

setZipClass(string  $zipClass) : bool

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

bool —

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()) : bool

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

bool —

Success or failure

setLocale()

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

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

bool —

Success or failure

setChartRenderer()

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

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

bool —

Success or failure

setChartRendererName()

setChartRendererName(string  $libraryName) : bool

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

bool —

Success or failure

setChartRendererPath()

setChartRendererPath(string  $libraryBaseDir) : bool

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

bool —

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) : bool

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

bool —

Success or failure

setPdfRendererName()

setPdfRendererName(string  $libraryName) : bool

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

bool —

Success or failure

setPdfRendererPath()

setPdfRendererPath(string  $libraryBaseDir) : bool

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

bool —

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(int  $options = null) : mixed

Set default options for libxml loader

Parameters

int

$options

Default options for libxml loader

Returns

mixed —

getLibXmlLoaderOptions()

getLibXmlLoaderOptions() : int

Get default options for libxml loader.

Defaults to LIBXML_DTDLOAD | LIBXML_DTDATTR when not set explicitly.

Returns

int —

Default options for libxml loader