alex
/
PhpSpreadsheet
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
PhpSpreadsheet/docs/topics/settings.md

63 lines
1.9 KiB
Markdown
Raw Normal View History

Reorganise documentation We aim for long pages instead of several small one, to make `CTRL+F`ing easier and URL less prone to changes in the future. There is still way to improve it though...
2016-12-03 13:16:45 +00:00
# Configuration Settings
documentation markdown
2013-05-16 20:59:54 +00:00
Wrap lines to 80 We wrapped lines to make easier the source easier to read, and to have more manageable diffs. This was done with something like: ```sh pandoc --wrap=auto --atx-headers -f markdown -t markdown-fenced_code_attributes+pipe_tables+raw_html+intraword_underscores` ```
2016-12-03 15:00:54 +00:00
Once you have included the PhpSpreadsheet files in your script, but
before instantiating a `Spreadsheet` object or loading a workbook file,
there are a number of configuration options that can be set which will
affect the subsequent behaviour of the script.
documentation markdown
2013-05-16 20:59:54 +00:00
Refactor CachedObjectStorage to PSR-16 This drop a lot of non-core features code and delegate their maintainance to third parties. Also it open the door to any missing implementation out of the box, such as Redis for the moment. Finally this consistently enforce a constraint where there can be one and only one active cell at any point in time in code. This used to be true for non-default implementation of cache, but it was not true for default implementation where all cells were kept in-memory and thus were never detached from their worksheet and thus were all kept functionnal at any point in time. This inconsistency of behavior between in-memory and off-memory could lead to bugs when changing cache system if the end-user code was badly written. Now end-user will never be able to write buggy code in the first place, avoiding future headache when introducing caching. Closes #3
2017-04-14 05:22:33 +00:00
## Cell collection caching
documentation markdown
2013-05-16 20:59:54 +00:00
Refactor CachedObjectStorage to PSR-16 This drop a lot of non-core features code and delegate their maintainance to third parties. Also it open the door to any missing implementation out of the box, such as Redis for the moment. Finally this consistently enforce a constraint where there can be one and only one active cell at any point in time in code. This used to be true for non-default implementation of cache, but it was not true for default implementation where all cells were kept in-memory and thus were never detached from their worksheet and thus were all kept functionnal at any point in time. This inconsistency of behavior between in-memory and off-memory could lead to bugs when changing cache system if the end-user code was badly written. Now end-user will never be able to write buggy code in the first place, avoiding future headache when introducing caching. Closes #3
2017-04-14 05:22:33 +00:00
By default, PhpSpreadsheet holds all cell objects in memory, but
you can specify alternatives to reduce memory consumption at the cost of speed.
Read more about [memory saving](./memory_saving.md).
documentation markdown
2013-05-16 20:59:54 +00:00
Refactor CachedObjectStorage to PSR-16 This drop a lot of non-core features code and delegate their maintainance to third parties. Also it open the door to any missing implementation out of the box, such as Redis for the moment. Finally this consistently enforce a constraint where there can be one and only one active cell at any point in time in code. This used to be true for non-default implementation of cache, but it was not true for default implementation where all cells were kept in-memory and thus were never detached from their worksheet and thus were all kept functionnal at any point in time. This inconsistency of behavior between in-memory and off-memory could lead to bugs when changing cache system if the end-user code was badly written. Now end-user will never be able to write buggy code in the first place, avoiding future headache when introducing caching. Closes #3
2017-04-14 05:22:33 +00:00
To enable cell caching, you must provide your own implementation of cache like so:
documentation markdown
2013-05-16 20:59:54 +00:00
Code highlight in docs for PhpStorm
2020-05-31 13:41:05 +00:00
```php
Refactor CachedObjectStorage to PSR-16 This drop a lot of non-core features code and delegate their maintainance to third parties. Also it open the door to any missing implementation out of the box, such as Redis for the moment. Finally this consistently enforce a constraint where there can be one and only one active cell at any point in time in code. This used to be true for non-default implementation of cache, but it was not true for default implementation where all cells were kept in-memory and thus were never detached from their worksheet and thus were all kept functionnal at any point in time. This inconsistency of behavior between in-memory and off-memory could lead to bugs when changing cache system if the end-user code was badly written. Now end-user will never be able to write buggy code in the first place, avoiding future headache when introducing caching. Closes #3
2017-04-14 05:22:33 +00:00
$cache = new MyCustomPsr16Implementation();
documentation markdown
2013-05-16 20:59:54 +00:00
Refactor CachedObjectStorage to PSR-16 This drop a lot of non-core features code and delegate their maintainance to third parties. Also it open the door to any missing implementation out of the box, such as Redis for the moment. Finally this consistently enforce a constraint where there can be one and only one active cell at any point in time in code. This used to be true for non-default implementation of cache, but it was not true for default implementation where all cells were kept in-memory and thus were never detached from their worksheet and thus were all kept functionnal at any point in time. This inconsistency of behavior between in-memory and off-memory could lead to bugs when changing cache system if the end-user code was badly written. Now end-user will never be able to write buggy code in the first place, avoiding future headache when introducing caching. Closes #3
2017-04-14 05:22:33 +00:00
\PhpOffice\PhpSpreadsheet\Settings::setCache($cache);
documentation markdown
2013-05-16 20:59:54 +00:00
```
Reorganise documentation We aim for long pages instead of several small one, to make `CTRL+F`ing easier and URL less prone to changes in the future. There is still way to improve it though...
2016-12-03 13:16:45 +00:00
## Language/Locale
documentation markdown
2013-05-16 20:59:54 +00:00
Wrap lines to 80 We wrapped lines to make easier the source easier to read, and to have more manageable diffs. This was done with something like: ```sh pandoc --wrap=auto --atx-headers -f markdown -t markdown-fenced_code_attributes+pipe_tables+raw_html+intraword_underscores` ```
2016-12-03 15:00:54 +00:00
Some localisation elements have been included in PhpSpreadsheet. You can
set a locale by changing the settings. To set the locale to Brazilian
Portuguese you would use:
documentation markdown
2013-05-16 20:59:54 +00:00
Code highlight in docs for PhpStorm
2020-05-31 13:41:05 +00:00
```php
documentation markdown
2013-05-16 20:59:54 +00:00
$locale = 'pt_br';
Convert docs with our migrator
2016-11-27 15:51:44 +00:00
$validLocale = \PhpOffice\PhpSpreadsheet\Settings::setLocale($locale);
documentation markdown
2013-05-16 20:59:54 +00:00
if (!$validLocale) {
documentation markdown
2013-05-19 21:14:52 +00:00
echo 'Unable to set locale to ' . $locale . " - reverting to en_us" . PHP_EOL;
documentation markdown
2013-05-16 20:59:54 +00:00
}
```
Split sentences for better readability Closes https://github.com/PHPOffice/PHPExcel/pull/1147
2017-03-12 02:02:43 +00:00
- If Brazilian Portuguese language files aren't available, then Portuguese
will be enabled instead
- If Portuguese language files aren't available,
Improve doc formatting with backticks
2017-03-13 05:57:37 +00:00
then the `setLocale()` method will return an error, and American English
Wrap lines to 80 We wrapped lines to make easier the source easier to read, and to have more manageable diffs. This was done with something like: ```sh pandoc --wrap=auto --atx-headers -f markdown -t markdown-fenced_code_attributes+pipe_tables+raw_html+intraword_underscores` ```
2016-12-03 15:00:54 +00:00
(en\_us) settings will be used throughout.
documentation markdown
2013-05-16 20:59:54 +00:00
Wrap lines to 80 We wrapped lines to make easier the source easier to read, and to have more manageable diffs. This was done with something like: ```sh pandoc --wrap=auto --atx-headers -f markdown -t markdown-fenced_code_attributes+pipe_tables+raw_html+intraword_underscores` ```
2016-12-03 15:00:54 +00:00
More details of the features available once a locale has been set,
including a list of the languages and locales currently supported, can
Split sentences for better readability Closes https://github.com/PHPOffice/PHPExcel/pull/1147
2017-03-12 02:02:43 +00:00
be found in [Locale Settings for
Formulae](./recipes.md#locale-settings-for-formulae).
WEBSERVICE is HTTP client agnostic HTTP client must be configured via `Settings::setHttpClient()`. This is a small breaking change, but only for the very few people who started using WEBSERVICE from last version. Fixes #1562 Closes #1568
2020-07-19 02:33:01 +00:00
## HTTP client
In order to use the `WEBSERVICE` function in formulae, you must configure an
HTTP client. Assuming you chose Guzzle 7, this can be done like:
```php
use GuzzleHttp\Client;
use Http\Factory\Guzzle\RequestFactory;
use PhpOffice\PhpSpreadsheet\Settings;
$client = new Client();
$requestFactory = new RequestFactory();
Settings::setHttpClient($client, $requestFactory);
```