PHPExcel_Settings Class Reference

PHPExcel root directory. More...

Collaboration diagram for PHPExcel_Settings:

Static Public Member Functions
static	setZipClass ($zipClass)
	Set the Zip handler Class that PHPExcel should use for Zip file management (PCLZip or ZipArchive) More...
static	getZipClass ()
	Return the name of the Zip handler Class that PHPExcel is configured to use (PCLZip or ZipArchive) or Zip file management. More...
static	getCacheStorageMethod ()
	Return the name of the method that is currently configured for cell cacheing. More...
static	getCacheStorageClass ()
	Return the name of the class that is currently being used for cell cacheing. More...
static	setCacheStorageMethod ( $method=PHPExcel_CachedObjectStorageFactory::cache_in_memory, $arguments=array())
	Set the method that should be used for cell cacheing. More...
static	setLocale ($locale='en_us')
	Set the locale code to use for formula translations and any special formatting. More...
static	setChartRenderer ($libraryName, $libraryBaseDir)
	Set details of the external library that PHPExcel should use for rendering charts. More...
static	setChartRendererName ($libraryName)
	Identify to PHPExcel the external library to use for rendering charts. More...
static	setChartRendererPath ($libraryBaseDir)
	Tell PHPExcel where to find the external library to use for rendering charts. More...
static	getChartRendererName ()
	Return the Chart Rendering Library that PHPExcel is currently configured to use (e.g. More...
static	getChartRendererPath ()
	Return the directory path to the Chart Rendering Library that PHPExcel is currently configured to use. More...
static	setPdfRenderer ($libraryName, $libraryBaseDir)
	Set details of the external library that PHPExcel should use for rendering PDF files. More...
static	setPdfRendererName ($libraryName)
	Identify to PHPExcel the external library to use for rendering PDF files. More...
static	setPdfRendererPath ($libraryBaseDir)
	Tell PHPExcel where to find the external library to use for rendering PDF files. More...
static	getPdfRendererName ()
	Return the PDF Rendering Library that PHPExcel is currently configured to use (e.g. More...
static	getPdfRendererPath ()
	Return the directory path to the PDF Rendering Library that PHPExcel is currently configured to use. More...
static	setLibXmlLoaderOptions ($options=null)
	Set default options for libxml loader. More...
static	getLibXmlLoaderOptions ()
	Get default options for libxml loader. More...

Data Fields
const	PCLZIP = 'PHPExcel_Shared_ZipArchive'
	constants More...
const	ZIPARCHIVE = 'ZipArchive'
const	CHART_RENDERER_JPGRAPH = 'jpgraph'
	Optional Chart Rendering libraries. More...
const	PDF_RENDERER_TCPDF = 'tcPDF'
	Optional PDF Rendering libraries. More...
const	PDF_RENDERER_DOMPDF = 'DomPDF'
const	PDF_RENDERER_MPDF = 'mPDF'

Static Private Attributes
static	$_chartRenderers
static	$_pdfRenderers
static	$_zipClass = self::ZIPARCHIVE
static	$_chartRendererName = NULL
static	$_chartRendererPath = NULL
static	$_pdfRendererName = NULL
static	$_pdfRendererPath = NULL
static	$_libXmlLoaderOptions = null

Detailed Description

PHPExcel root directory.

Definition at line 38 of file Settings.php.

Member Function Documentation

getCacheStorageClass()

static PHPExcel_Settings::getCacheStorageClass ( )

static

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

Definition at line 163 of file Settings.php.

References PHPExcel_CachedObjectStorageFactory\getCacheStorageClass().

    {
        return PHPExcel_CachedObjectStorageFactory::getCacheStorageClass();
    } // function getCacheStorageClass()

Here is the call graph for this function:

getCacheStorageMethod()

static PHPExcel_Settings::getCacheStorageMethod ( )

static

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

Returns

string Name of the cacheing method

Definition at line 152 of file Settings.php.

References PHPExcel_CachedObjectStorageFactory\getCacheStorageMethod().

    {
        return PHPExcel_CachedObjectStorageFactory::getCacheStorageMethod();
    } // function getCacheStorageMethod()

Here is the call graph for this function:

getChartRendererName()

static PHPExcel_Settings::getChartRendererName ( )

static

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

Definition at line 258 of file Settings.php.

Referenced by PHPExcel_Chart\render().

    {
        return self::$_chartRendererName;
    } // function getChartRendererName()

Here is the caller graph for this function:

getChartRendererPath()

static PHPExcel_Settings::getChartRendererPath ( )

static

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

Definition at line 270 of file Settings.php.

Referenced by PHPExcel_Chart_Renderer_jpgraph\_renderAreaChart(), PHPExcel_Chart_Renderer_jpgraph\_renderBarChart(), PHPExcel_Chart_Renderer_jpgraph\_renderBubbleChart(), PHPExcel_Chart_Renderer_jpgraph\_renderCombinationChart(), PHPExcel_Chart_Renderer_jpgraph\_renderContourChart(), PHPExcel_Chart_Renderer_jpgraph\_renderLineChart(), PHPExcel_Chart_Renderer_jpgraph\_renderPieChart(), PHPExcel_Chart_Renderer_jpgraph\_renderRadarChart(), PHPExcel_Chart_Renderer_jpgraph\_renderScatterChart(), PHPExcel_Chart_Renderer_jpgraph\_renderStockChart(), and PHPExcel_Chart\render().

    {
        return self::$_chartRendererPath;
    } // function getChartRendererPath()

Here is the caller graph for this function:

getLibXmlLoaderOptions()

static PHPExcel_Settings::getLibXmlLoaderOptions ( )

static

Get default options for libxml loader.

Defaults to LIBXML_DTDLOAD | LIBXML_DTDATTR when not set explicitly.

Returns

int Default options for libxml loader

Definition at line 381 of file Settings.php.

References defined.

Referenced by PHPExcel_Reader_Excel2007\_readRibbon(), PHPExcel_Reader_OOCalc\canRead(), PHPExcel_Reader_Excel2007\canRead(), PHPExcel_Reader_Gnumeric\listWorksheetInfo(), PHPExcel_Reader_Excel2003XML\listWorksheetInfo(), PHPExcel_Reader_Excel2007\listWorksheetInfo(), PHPExcel_Reader_OOCalc\listWorksheetInfo(), PHPExcel_Reader_Gnumeric\listWorksheetNames(), PHPExcel_Reader_OOCalc\listWorksheetNames(), PHPExcel_Reader_Excel2007\listWorksheetNames(), PHPExcel_Reader_Excel2003XML\listWorksheetNames(), PHPExcel_Reader_Excel2007\load(), PHPExcel_Reader_Gnumeric\loadIntoExisting(), PHPExcel_Reader_Excel2003XML\loadIntoExisting(), and PHPExcel_Reader_OOCalc\loadIntoExisting().

    {
        if (is_null(self::$_libXmlLoaderOptions) && defined(LIBXML_DTDLOAD)) {
            self::setLibXmlLoaderOptions(LIBXML_DTDLOAD | LIBXML_DTDATTR);
        }
        if (version_compare(PHP_VERSION, '5.2.11') >= 0) {
            @libxml_disable_entity_loader(self::$_libXmlLoaderOptions == (LIBXML_DTDLOAD | LIBXML_DTDATTR));
        }
        return self::$_libXmlLoaderOptions;
    } // function getLibXmlLoaderOptions

Here is the caller graph for this function:

getPdfRendererName()

static PHPExcel_Settings::getPdfRendererName ( )

static

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

Definition at line 343 of file Settings.php.

Referenced by PHPExcel_Writer_PDF\__construct().

    {
        return self::$_pdfRendererName;
    } // function getPdfRendererName()

Here is the caller graph for this function:

getPdfRendererPath()

static PHPExcel_Settings::getPdfRendererPath ( )

static

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

Definition at line 354 of file Settings.php.

Referenced by PHPExcel_Writer_PDF\__construct().

    {
        return self::$_pdfRendererPath;
    } // function getPdfRendererPath()

Here is the caller graph for this function:

getZipClass()

static PHPExcel_Settings::getZipClass ( )

static

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

Definition at line 141 of file Settings.php.

Referenced by PHPExcel_Writer_OpenDocument\_createZip(), PHPExcel_Reader_OOCalc\canRead(), PHPExcel_Reader_Excel2007\canRead(), PHPExcel_Reader_Excel2007\listWorksheetInfo(), PHPExcel_Reader_OOCalc\listWorksheetInfo(), PHPExcel_Reader_OOCalc\listWorksheetNames(), PHPExcel_Reader_Excel2007\listWorksheetNames(), PHPExcel_Reader_Excel2007\load(), PHPExcel_Reader_OOCalc\loadIntoExisting(), and PHPExcel_Writer_Excel2007\save().

    {
        return self::$_zipClass;
    } // function getZipClass()

Here is the caller graph for this function:

setCacheStorageMethod()

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

static

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

Definition at line 176 of file Settings.php.

References PHPExcel_CachedObjectStorageFactory\initialize().

    {
        return PHPExcel_CachedObjectStorageFactory::initialize($method, $arguments);
    } // function setCacheStorageMethod()

Here is the call graph for this function:

setChartRenderer()

static PHPExcel_Settings::setChartRenderer (   $libraryName,   $libraryBaseDir  )

static

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

Definition at line 206 of file Settings.php.

    {
        if (!self::setChartRendererName($libraryName))
            return FALSE;
        return self::setChartRendererPath($libraryBaseDir);
    } // function setChartRenderer()

setChartRendererName()

static PHPExcel_Settings::setChartRendererName (   $libraryName )

static

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

Definition at line 222 of file Settings.php.

    {
        if (!in_array($libraryName,self::$_chartRenderers)) {
            return FALSE;
        }

        self::$_chartRendererName = $libraryName;

        return TRUE;
    } // function setChartRendererName()

setChartRendererPath()

static PHPExcel_Settings::setChartRendererPath (   $libraryBaseDir )

static

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

Definition at line 240 of file Settings.php.

    {
        if ((file_exists($libraryBaseDir) === false) || (is_readable($libraryBaseDir) === false)) {
            return FALSE;
        }
        self::$_chartRendererPath = $libraryBaseDir;

        return TRUE;
    } // function setChartRendererPath()

setLibXmlLoaderOptions()

static PHPExcel_Settings::setLibXmlLoaderOptions (   $options = null )

static

Set default options for libxml loader.

Parameters

int

$options

Default options for libxml loader

Definition at line 364 of file Settings.php.

References $options, and defined.

    {
        if (is_null($options) && defined(LIBXML_DTDLOAD)) {
            $options = LIBXML_DTDLOAD | LIBXML_DTDATTR;
        }
        if (version_compare(PHP_VERSION, '5.2.11') >= 0) {
            @libxml_disable_entity_loader($options == (LIBXML_DTDLOAD | LIBXML_DTDATTR)); 
        }
        self::$_libXmlLoaderOptions = $options;
    } // function setLibXmlLoaderOptions

setLocale()

static PHPExcel_Settings::setLocale (   $locale = 'en_us' )

static

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

Definition at line 191 of file Settings.php.

References PHPExcel_Calculation\getInstance().

    {
        return PHPExcel_Calculation::getInstance()->setLocale($locale);
    } // function setLocale()

Here is the call graph for this function:

setPdfRenderer()

static PHPExcel_Settings::setPdfRenderer (   $libraryName,   $libraryBaseDir  )

static

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

Definition at line 287 of file Settings.php.

    {
        if (!self::setPdfRendererName($libraryName))
            return FALSE;
        return self::setPdfRendererPath($libraryBaseDir);
    } // function setPdfRenderer()

setPdfRendererName()

static PHPExcel_Settings::setPdfRendererName (   $libraryName )

static

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

Definition at line 305 of file Settings.php.

    {
        if (!in_array($libraryName,self::$_pdfRenderers)) {
            return FALSE;
        }

        self::$_pdfRendererName = $libraryName;

        return TRUE;
    } // function setPdfRendererName()

setPdfRendererPath()

static PHPExcel_Settings::setPdfRendererPath (   $libraryBaseDir )

static

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

Definition at line 323 of file Settings.php.

    {
        if ((file_exists($libraryBaseDir) === false) || (is_readable($libraryBaseDir) === false)) {
            return FALSE;
        }
        self::$_pdfRendererPath = $libraryBaseDir;

        return TRUE;
    } // function setPdfRendererPath()

setZipClass()

static PHPExcel_Settings::setZipClass (   $zipClass )

static

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

Definition at line 122 of file Settings.php.

    {
        if (($zipClass === self::PCLZIP) ||
            ($zipClass === self::ZIPARCHIVE)) {
            self::$_zipClass = $zipClass;
            return TRUE;
        }
        return FALSE;
    } // function setZipClass()

Field Documentation

$_chartRendererName

PHPExcel_Settings::$_chartRendererName = NULL

staticprivate

Definition at line 82 of file Settings.php.

$_chartRendererPath

PHPExcel_Settings::$_chartRendererPath = NULL

staticprivate

Definition at line 89 of file Settings.php.

$_chartRenderers

PHPExcel_Settings::$_chartRenderers

staticprivate

Initial value:

= array(
        self::CHART_RENDERER_JPGRAPH,
    )

Definition at line 54 of file Settings.php.

$_libXmlLoaderOptions

PHPExcel_Settings::$_libXmlLoaderOptions = null

staticprivate

Definition at line 113 of file Settings.php.

$_pdfRendererName

PHPExcel_Settings::$_pdfRendererName = NULL

staticprivate

Definition at line 99 of file Settings.php.

$_pdfRendererPath

PHPExcel_Settings::$_pdfRendererPath = NULL

staticprivate

Definition at line 106 of file Settings.php.

$_pdfRenderers

PHPExcel_Settings::$_pdfRenderers

staticprivate

Initial value:

= array(
        self::PDF_RENDERER_TCPDF,
        self::PDF_RENDERER_DOMPDF,
        self::PDF_RENDERER_MPDF,
    )

Definition at line 58 of file Settings.php.

$_zipClass

PHPExcel_Settings::$_zipClass = self::ZIPARCHIVE

staticprivate

Definition at line 72 of file Settings.php.

CHART_RENDERER_JPGRAPH

const PHPExcel_Settings::CHART_RENDERER_JPGRAPH = 'jpgraph'

Optional Chart Rendering libraries.

Definition at line 46 of file Settings.php.

PCLZIP

const PHPExcel_Settings::PCLZIP = 'PHPExcel_Shared_ZipArchive'

constants

Available Zip library classes

Definition at line 42 of file Settings.php.

PDF_RENDERER_DOMPDF

const PHPExcel_Settings::PDF_RENDERER_DOMPDF = 'DomPDF'

Definition at line 50 of file Settings.php.

PDF_RENDERER_MPDF

const PHPExcel_Settings::PDF_RENDERER_MPDF = 'mPDF'

Definition at line 51 of file Settings.php.

PDF_RENDERER_TCPDF

const PHPExcel_Settings::PDF_RENDERER_TCPDF = 'tcPDF'

Optional PDF Rendering libraries.

Definition at line 49 of file Settings.php.

ZIPARCHIVE

const PHPExcel_Settings::ZIPARCHIVE = 'ZipArchive'

Definition at line 43 of file Settings.php.

---

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

• libs/composer/vendor/phpoffice/phpexcel/Classes/PHPExcel/Settings.php