Documentation

Settings
in package

Table of Contents

Properties

$cache  : CacheInterface|null
The cache implementation to be used for cell collection.
$chartRenderer  : null|IRenderer>
Class name of the chart renderer used for rendering charts eg: PhpOffice\PhpSpreadsheet\Chart\Renderer\JpGraph.
$httpClient  : ClientInterface|null
The HTTP client implementation to be used for network request.
$libXmlLoaderOptions  : int|null
Default options for libxml loader.
$requestFactory  : RequestFactoryInterface|null

Methods

getCache()  : CacheInterface
Gets the implementation of cache that is being used for cell collection.
getChartRenderer()  : null|IRenderer>
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.
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.
setLibXmlLoaderOptions()  : int
Set default options for libxml loader.
setLocale()  : bool
Set the locale code to use for formula translations and any special formatting.
unsetChartRenderer()  : void
unsetHttpClient()  : void
Unset the HTTP client configuration.
useSimpleCacheVersion3()  : bool

Properties

$cache

The cache implementation to be used for cell collection.

private static CacheInterface|null $cache = null

$chartRenderer

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

private static null|IRenderer> $chartRenderer = null

$httpClient

The HTTP client implementation to be used for network request.

private static ClientInterface|null $httpClient = null

$libXmlLoaderOptions

Default options for libxml loader.

private static int|null $libXmlLoaderOptions = null

$requestFactory

private static RequestFactoryInterface|null $requestFactory = null

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|IRenderer>
Return values
null|IRenderer>

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

getLibXmlLoaderOptions()

Get default options for libxml loader.

public static getLibXmlLoaderOptions() : int

Defaults to LIBXML_DTDLOAD | LIBXML_DTDATTR when not set explicitly.

Tags
deprecated
3.5.0

no longer needed

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|null $cache) : void
Parameters
$cache : CacheInterface|null

setChartRenderer()

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

public static setChartRenderer(IRenderer> $rendererClassName) : void
Parameters
$rendererClassName : IRenderer>

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

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

setLibXmlLoaderOptions()

Set default options for libxml loader.

public static setLibXmlLoaderOptions(int|null $options) : int
Parameters
$options : int|null

Default options for libxml loader

Tags
deprecated
3.5.0

no longer needed

Return values
int

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

unsetChartRenderer()

public static unsetChartRenderer() : void

unsetHttpClient()

Unset the HTTP client configuration.

public static unsetHttpClient() : void

useSimpleCacheVersion3()

public static useSimpleCacheVersion3() : bool
Return values
bool

        
On this page

Search results