Skip to content

Commit 3302701

Browse files
author
MarkBaker
committed
Declare a few return datatypes
1 parent 8089c9b commit 3302701

File tree

2 files changed

+64
-1
lines changed

2 files changed

+64
-1
lines changed

README.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,44 @@
1111
PhpSpreadsheet is a library written in pure PHP and offers a set of classes that
1212
allow you to read and write various spreadsheet file formats such as Excel and LibreOffice Calc.
1313

14+
## PHP version support
15+
16+
LTS: Support for PHP versions will only be maintained for a period of six months beyond the
17+
[end of life of that PHP version](https://www.php.net/eol.php).
18+
19+
Currently the required PHP minimum version is PHP __7.3__.
20+
21+
See the `composer.json` for other requirements.
22+
23+
## Installation
24+
25+
Use [composer](https://getcomposer.org) to install PhpSpreadsheet into your project:
26+
27+
```sh
28+
composer require phpoffice/phpspreadsheet
29+
```
30+
31+
If you are building your installation on a development machine that is on a different PHP version to the server where it will be deployed, or if your PHP CLI version is not the same as your run-time such as `php-fpm` or Apache's `mod_php`, then you might want to add the following to your `composer.json` before installing:
32+
```json lines
33+
{
34+
"require": {
35+
"phpoffice/phpspreadsheet": "^1.23"
36+
},
37+
"config": {
38+
"platform": {
39+
"php": "7.3"
40+
}
41+
}
42+
}
43+
```
44+
and then run
45+
```sh
46+
composer install
47+
```
48+
to ensure that the correct dependencies are retrieved to match your deployment environment.
49+
50+
See [CLI vs Application run-time](https://php.watch/articles/composer-platform-check) for more details.
51+
1452
## Documentation
1553

1654
Read more about it, including install instructions, in the [official documentation](https://phpspreadsheet.readthedocs.io). Or check out the [API documentation](https://phpoffice.github.io/PhpSpreadsheet).

docs/index.md

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,14 @@ for details.
3030

3131
### PHP version support
3232

33-
Support for PHP versions will only be maintained for a period of six months beyond the
33+
LTS: Support for PHP versions will only be maintained for a period of six months beyond the
3434
[end of life of that PHP version](https://www.php.net/eol.php).
3535

36+
Currently the required PHP minimum version is PHP 7.3. The last PHP release was 7.3.33 on 6th December 2021, so PhpSpreadsheet will support PHP 7.3 until 6th June 2022.
37+
PHP 7.4 is officially [End of Life](https://www.php.net/supported-versions.php) on 28th November 2022, and PhpSpreadsheet will continue to support PHP 7.4 for six months after that date.
38+
39+
See the `composer.json` for other requirements.
40+
3641
## Installation
3742

3843
Use [composer](https://getcomposer.org) to install PhpSpreadsheet into your project:
@@ -47,6 +52,26 @@ Or also download the documentation and samples if you plan to use them:
4752
composer require phpoffice/phpspreadsheet --prefer-source
4853
```
4954

55+
If you are building your installation on a development machine that is on a different PHP version to the server where it will be deployed, or if your PHP CLI version is not the same as your run-time such as `php-fpm` or Apache's `mod_php`, then you might want to add the following to your `composer.json` before installing:
56+
```json lines
57+
{
58+
"require": {
59+
"phpoffice/phpspreadsheet": "^1.23"
60+
},
61+
"config": {
62+
"platform": {
63+
"php": "7.3"
64+
}
65+
}
66+
}
67+
```
68+
and then run
69+
```sh
70+
composer install
71+
```
72+
to ensure that the correct dependencies are retrieved to match your deployment environment.
73+
74+
See [CLI vs Application run-time](https://php.watch/articles/composer-platform-check) for more details.
5075

5176
## Hello World
5277

0 commit comments

Comments
 (0)