Overview

Packages

  • JAMA
  • None
  • PHP
  • PHPExcel
    • CachedObjectStorage
    • Calculation
    • Cell
    • Chart
      • Renderer
    • Reader
      • Excel2007
      • Excel5
    • RichText
    • Settings
    • Shared
      • Escher
      • OLE
      • Trend
      • ZipArchive
    • Style
    • Worksheet
      • Drawing
    • Writer
      • 2007
      • CSV
      • Excel2007
      • Excel5
      • HTML
      • PDF

Classes

  • PHPExcel_Settings
  • Overview
  • Package
  • Class
  • Tree
  • Deprecated
  • Todo
  • Download

Class PHPExcel_Settings

Package: PHPExcel\Settings
Copyright: Copyright (c) 2006 - 2014 PHPExcel (http://www.codeplex.com/PHPExcel)
License: LGPL
Located at controlador/include/phpexcel/PHPExcel/Settings.php
Methods summary
public static boolean
# setZipClass( string $zipClass )

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

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

Parameters

$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
public 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 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

public static string
# getCacheStorageMethod( )

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

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

Returns

string
Name of the cacheing method
public static string
# getCacheStorageClass( )

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

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
public static boolean
# setCacheStorageMethod( string $method = PHPExcel_CachedObjectStorageFactory::cache_in_memory, array $arguments = array() )

Set the method that should be used for cell cacheing

Set the method that should be used for cell cacheing

Parameters

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

Returns

boolean
Success or failure
public static boolean
# setLocale( string $locale = 'en_us' )

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

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

Parameters

$locale
The locale code to use (e.g. "fr" or "pt_br" or "en_uk")

Returns

boolean
Success or failure
public static boolean
# setChartRenderer( string $libraryName, string $libraryBaseDir )

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

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

Parameters

$libraryName

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

$libraryBaseDir
Directory path to the library's base folder

Returns

boolean
Success or failure
public static boolean
# setChartRendererName( string $libraryName )

Identify to PHPExcel the external library to use for rendering charts

Identify to PHPExcel the external library to use for rendering charts

Parameters

$libraryName

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

Returns

boolean
Success or failure
public static boolean
# setChartRendererPath( string $libraryBaseDir )

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

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

Parameters

$libraryBaseDir
Directory path to the library's base folder

Returns

boolean
Success or failure
public static string|null
# getChartRendererName( )

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

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

public static string|null
# getChartRendererPath( )

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

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

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

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

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

Parameters

$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

$libraryBaseDir
Directory path to the library's base folder

Returns

boolean
Success or failure
public static boolean
# setPdfRendererName( string $libraryName )

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

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

Parameters

$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
public static boolean
# setPdfRendererPath( string $libraryBaseDir )

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

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

Parameters

$libraryBaseDir
Directory path to the library's base folder

Returns

boolean
Success or failure
public static string|null
# getPdfRendererName( )

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

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

public static string|null
# getPdfRendererPath( )

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

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

public static
# setLibXmlLoaderOptions( integer $options = null )

Set default options for libxml loader

Set default options for libxml loader

Parameters

$options
Default options for libxml loader
public static integer
# getLibXmlLoaderOptions( )

Get default options for libxml loader. Defaults to LIBXML_DTDLOAD | LIBXML_DTDATTR when not set explicitly.

Get default options for libxml loader. Defaults to LIBXML_DTDLOAD | LIBXML_DTDATTR when not set explicitly.

Returns

integer
Default options for libxml loader
Constants summary
string PCLZIP

Available Zip library classes

Available Zip library classes

# 'PHPExcel_Shared_ZipArchive'
string ZIPARCHIVE
# 'ZipArchive'
string CHART_RENDERER_JPGRAPH

Optional Chart Rendering libraries

Optional Chart Rendering libraries

# 'jpgraph'
string PDF_RENDERER_TCPDF

Optional PDF Rendering libraries

Optional PDF Rendering libraries

# 'tcPDF'
string PDF_RENDERER_DOMPDF
# 'DomPDF'
string PDF_RENDERER_MPDF
# 'mPDF'
Properties summary
private static array $_chartRenderers
# array( self::CHART_RENDERER_JPGRAPH, )
private static array $_pdfRenderers
# array( self::PDF_RENDERER_TCPDF, self::PDF_RENDERER_DOMPDF, self::PDF_RENDERER_MPDF, )
private static string $_zipClass

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

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

# PHPExcel_Settings::ZIPARCHIVE
private static string $_chartRendererName

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

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

# NULL
private static string $_chartRendererPath

Directory Path to the external Library used for rendering charts

Directory Path to the external Library used for rendering charts

# NULL
private static string $_pdfRendererName

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

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

# NULL
private static string $_pdfRendererPath

Directory Path to the external Library used for rendering PDF files

Directory Path to the external Library used for rendering PDF files

# NULL
private static integer $_libXmlLoaderOptions

Default options for libxml loader

Default options for libxml loader

# null
Autene API documentation generated by ApiGen