PhpOffice\PhpSpreadsheet\Settings Class Reference

Static Public Member Functions
static	getCache ()
	Gets the implementation of cache that is being used for cell collection.
static	getChartRenderer ()
	Return the Chart Rendering Library that PhpSpreadsheet is currently configured to use.
static	getHttpClient ()
	Get the HTTP client implementation to be used for network request.
static	getLibXmlDisableEntityLoader ()
	Deprecated, has no effect.
static	getLibXmlLoaderOptions ()
	Get default options for libxml loader.
static	getLocale ()
static	getRequestFactory ()
	Get the HTTP request factory.
static	htmlEntityFlags ()
static	setCache (?CacheInterface $cache)
	Sets the implementation of cache that should be used for cell collection.
static	setChartRenderer (string $rendererClassName)
	Identify to PhpSpreadsheet the external library to use for rendering charts.
static	setHttpClient (ClientInterface $httpClient, RequestFactoryInterface $requestFactory)
	Set the HTTP client implementation to be used for network request.
static	setLibXmlDisableEntityLoader ( $state)
	Deprecated, has no effect.
static	setLibXmlLoaderOptions ($options)
	Set default options for libxml loader.
static	setLocale (string $locale)
	Set the locale code to use for formula translations and any special formatting.
static	unsetHttpClient ()
	Unset the HTTP client configuration.
static	useSimpleCacheVersion3 ()

Member Function Documentation

getChartRenderer()

static PhpOffice\PhpSpreadsheet\Settings::getChartRenderer ( )

static

Return the Chart Rendering Library that PhpSpreadsheet is currently configured to use.

Return values

null|string

Class name of the chart renderer eg: PhpOffice\PhpSpreadsheet\Chart\Renderer\JpGraph

getLibXmlDisableEntityLoader()

static PhpOffice\PhpSpreadsheet\Settings::getLibXmlDisableEntityLoader ( )

static

Deprecated, has no effect.

Return values

bool#$state

Deprecated

will be removed without replacement as it is no longer necessary on PHP 7.3.0+

@codeCoverageIgnore

getLibXmlLoaderOptions()

static PhpOffice\PhpSpreadsheet\Settings::getLibXmlLoaderOptions ( )

static

Get default options for libxml loader.

Defaults to LIBXML_DTDLOAD | LIBXML_DTDATTR when not set explicitly.

Return values

int	Default options for libxml loader

setChartRenderer()

static PhpOffice\PhpSpreadsheet\Settings::setChartRenderer ( string $rendererClassName )

static

Identify to PhpSpreadsheet the external library to use for rendering charts.

Parameters

string

$rendererClassName

Class name of the chart renderer eg: PhpOffice\PhpSpreadsheet\Chart\Renderer\JpGraph

setLibXmlDisableEntityLoader()

static PhpOffice\PhpSpreadsheet\Settings::setLibXmlDisableEntityLoader ( $state )

static

Deprecated, has no effect.

Parameters

bool

$state

Deprecated

will be removed without replacement as it is no longer necessary on PHP 7.3.0+

@codeCoverageIgnore

Parameters

$state

@scrutinizer ignore-unused

setLibXmlLoaderOptions()

static PhpOffice\PhpSpreadsheet\Settings::setLibXmlLoaderOptions ( $options )

static

Set default options for libxml loader.

Parameters

?int

$options

Default options for libxml loader

setLocale()

static PhpOffice\PhpSpreadsheet\Settings::setLocale ( string $locale )

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")

Return values

bool	Success or failure

---

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

• lib/phpspreadsheet/phpspreadsheet/src/PhpSpreadsheet/Settings.php