Documentation

Settings

Table of Contents

$cache  : CacheInterface
The cache implementation to be used for cell collection.
$chartRenderer  : string
Class name of the chart renderer used for rendering charts eg: PhpOffice\PhpSpreadsheet\Chart\Renderer\JpGraph.
$httpClient  : null|ClientInterface
The HTTP client implementation to be used for network request.
$libXmlLoaderOptions  : int
Default options for libxml loader.
$requestFactory  : null|RequestFactoryInterface
getCache()  : CacheInterface
Gets the implementation of cache that is being used for cell collection.
getChartRenderer()  : null|string
Return the Chart Rendering Library that PhpSpreadsheet is currently configured to use.
getHttpClient()  : ClientInterface
Get the HTTP client implementation to be used for network request.
getLibXmlDisableEntityLoader()  : bool
Deprecated, has no effect.
getLibXmlLoaderOptions()  : int
Get default options for libxml loader.
getLocale()  : string
getRequestFactory()  : RequestFactoryInterface
Get the HTTP request factory.
htmlEntityFlags()  : int
setCache()  : void
Sets the implementation of cache that should be used for cell collection.
setChartRenderer()  : void
Identify to PhpSpreadsheet the external library to use for rendering charts.
setHttpClient()  : void
Set the HTTP client implementation to be used for network request.
setLibXmlDisableEntityLoader()  : void
Deprecated, has no effect.
setLibXmlLoaderOptions()  : void
Set default options for libxml loader.
setLocale()  : bool
Set the locale code to use for formula translations and any special formatting.
unsetHttpClient()  : void
Unset the HTTP client configuration.
useSimpleCacheVersion3()  : bool
assertHttpClient()  : void

Properties

$cache

The cache implementation to be used for cell collection.

private static CacheInterface $cache

$chartRenderer

Class name of the chart renderer used for rendering charts eg: PhpOffice\PhpSpreadsheet\Chart\Renderer\JpGraph.

private static string $chartRenderer

$httpClient

The HTTP client implementation to be used for network request.

private static null|ClientInterface $httpClient

$libXmlLoaderOptions

Default options for libxml loader.

private static int $libXmlLoaderOptions

$requestFactory

private static null|RequestFactoryInterface $requestFactory

Methods

getCache()

Gets the implementation of cache that is being used for cell collection.

public static getCache() : CacheInterface
Return values
CacheInterface

getChartRenderer()

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

public static getChartRenderer() : null|string
Return values
null|string

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

getHttpClient()

Get the HTTP client implementation to be used for network request.

public static getHttpClient() : ClientInterface
Return values
ClientInterface

getLibXmlDisableEntityLoader()

Deprecated, has no effect.

public static getLibXmlDisableEntityLoader() : bool
Tags
deprecated

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

Return values
bool

$state

getLibXmlLoaderOptions()

Get default options for libxml loader.

public static getLibXmlLoaderOptions() : int

Defaults to LIBXML_DTDLOAD | LIBXML_DTDATTR when not set explicitly.

Return values
int

Default options for libxml loader

getLocale()

public static getLocale() : string
Return values
string

getRequestFactory()

Get the HTTP request factory.

public static getRequestFactory() : RequestFactoryInterface
Return values
RequestFactoryInterface

htmlEntityFlags()

public static htmlEntityFlags() : int
Return values
int

setCache()

Sets the implementation of cache that should be used for cell collection.

public static setCache(CacheInterface $cache) : void
Parameters
$cache : CacheInterface
Return values
void

setChartRenderer()

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

public static setChartRenderer(string $rendererClassName) : void
Parameters
$rendererClassName : string

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

Return values
void

setHttpClient()

Set the HTTP client implementation to be used for network request.

public static setHttpClient(ClientInterface $httpClient, RequestFactoryInterface $requestFactory) : void
Parameters
$httpClient : ClientInterface
$requestFactory : RequestFactoryInterface
Return values
void

setLibXmlDisableEntityLoader()

Deprecated, has no effect.

public static setLibXmlDisableEntityLoader(bool $state) : void
Parameters
$state : bool
Tags
deprecated

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

Return values
void

setLibXmlLoaderOptions()

Set default options for libxml loader.

public static setLibXmlLoaderOptions(int $options) : void
Parameters
$options : int

Default options for libxml loader

Return values
void

setLocale()

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

public static setLocale(string $locale) : bool
Parameters
$locale : string

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

Return values
bool

Success or failure

unsetHttpClient()

Unset the HTTP client configuration.

public static unsetHttpClient() : void
Return values
void

useSimpleCacheVersion3()

public static useSimpleCacheVersion3() : bool
Return values
bool

assertHttpClient()

private static assertHttpClient() : void
Return values
void

Search results