alex
/
PhpSpreadsheet
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Merge pull request #2 from PHPOffice/master 

Sync with Base
This commit is contained in:
oleibman 2020-05-18 21:14:57 -07:00 committed by GitHub
parent 1861412d60 be415fab56
commit 7d58ba8c86
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
560 changed files with 7195 additions and 6256 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
.gitattributes vendored
View File

@ -1,4 +1,16 @@
/tests export-ignore
README.md export-ignore
*.min.js binary *.min.js binary
/.gitattributes export-ignore
/.github export-ignore /.github export-ignore
/.gitignore export-ignore
/.php_cs.dist export-ignore
/.sami.php export-ignore
/.scrutinizer.yml export-ignore
/.travis.yml export-ignore
/CHANGELOG.PHPExcel.md export-ignore
/bin export-ignore
/composer.lock export-ignore
/docs export-ignore
/mkdocs.yml export-ignore
/phpunit.xml.dist export-ignore
/samples export-ignore
/tests export-ignore

119
.php_cs.dist
View File

@ -1,11 +1,8 @@
<?php <?php
$finder = PhpCsFixer\Finder::create() $finder = PhpCsFixer\Finder::create()
->exclude(['vendor', 'tests/data/Calculation']) ->exclude('vendor')
->in('samples') ->in(__DIR__);
->in('src')
->in('tests/PhpSpreadsheetTests')
;
return PhpCsFixer\Config::create() return PhpCsFixer\Config::create()
->setRiskyAllowed(true) ->setRiskyAllowed(true)
@ -13,21 +10,27 @@ return PhpCsFixer\Config::create()
->setCacheFile(sys_get_temp_dir() . '/php-cs-fixer' . preg_replace('~\W~', '-', __DIR__)) ->setCacheFile(sys_get_temp_dir() . '/php-cs-fixer' . preg_replace('~\W~', '-', __DIR__))
->setRules([ ->setRules([
'align_multiline_comment' => true, 'align_multiline_comment' => true,
'array_indentation' => true,
'array_syntax' => ['syntax' => 'short'], 'array_syntax' => ['syntax' => 'short'],
'backtick_to_shell_exec' => true, 'backtick_to_shell_exec' => true,
'binary_operator_spaces' => true, 'binary_operator_spaces' => true,
'blank_line_after_namespace' => true, 'blank_line_after_namespace' => true,
'blank_line_after_opening_tag' => true, 'blank_line_after_opening_tag' => true,
'blank_line_before_return' => false, // Deprecated
'blank_line_before_statement' => true, 'blank_line_before_statement' => true,
'braces' => true, 'braces' => true,
'cast_spaces' => true, 'cast_spaces' => true,
'class_attributes_separation' => ['elements' => ['method', 'property']], // const are often grouped with other related const 'class_attributes_separation' => ['elements' => ['method', 'property']], // const are often grouped with other related const
'class_definition' => true, 'class_definition' => true,
'class_keyword_remove' => false, // ::class keyword gives us beter support in IDE 'class_keyword_remove' => false, // ::class keyword gives us better support in IDE
'combine_consecutive_issets' => true, 'combine_consecutive_issets' => true,
'combine_consecutive_unsets' => true, 'combine_consecutive_unsets' => true,
'combine_nested_dirname' => true,
'comment_to_phpdoc' => true,
'compact_nullable_typehint' => true, 'compact_nullable_typehint' => true,
'concat_space' => ['spacing' => 'one'], 'concat_space' => ['spacing' => 'one'],
'constant_case' => true,
'date_time_immutable' => false, // Break our unit tests
'declare_equal_normalize' => true, 'declare_equal_normalize' => true,
'declare_strict_types' => false, // Too early to adopt strict types 'declare_strict_types' => false, // Too early to adopt strict types
'dir_constant' => true, 'dir_constant' => true,
@ -38,39 +41,57 @@ return PhpCsFixer\Config::create()
'elseif' => true, 'elseif' => true,
'encoding' => true, 'encoding' => true,
'ereg_to_preg' => true, 'ereg_to_preg' => true,
'error_suppression' => true,
'escape_implicit_backslashes' => true, 'escape_implicit_backslashes' => true,
'explicit_indirect_variable' => false, // I feel it makes the code actually harder to read 'explicit_indirect_variable' => false, // I feel it makes the code actually harder to read
'explicit_string_variable' => false, // I feel it makes the code actually harder to read 'explicit_string_variable' => false, // I feel it makes the code actually harder to read
'final_class' => false, // We need non-final classes
'final_internal_class' => true, 'final_internal_class' => true,
'final_public_method_for_abstract_class' => false, // We need non-final methods
'final_static_access' => true,
'fopen_flag_order' => true,
'fopen_flags' => true,
'full_opening_tag' => true, 'full_opening_tag' => true,
'fully_qualified_strict_types' => true,
'function_declaration' => true, 'function_declaration' => true,
'function_to_constant' => true, 'function_to_constant' => true,
'function_typehint_space' => true, 'function_typehint_space' => true,
'general_phpdoc_annotation_remove' => false, // No use for that 'general_phpdoc_annotation_remove' => ['access', 'category', 'copyright', 'method', 'throws'],
'hash_to_slash_comment' => true, 'global_namespace_import' => true,
'hash_to_slash_comment' => false, // Deprecated
'header_comment' => false, // We don't use common header in all our files 'header_comment' => false, // We don't use common header in all our files
'heredoc_indentation' => false, // Requires PHP >= 7.3
'heredoc_to_nowdoc' => false, // Not sure about this one 'heredoc_to_nowdoc' => false, // Not sure about this one
'implode_call' => true,
'include' => true, 'include' => true,
'increment_style' => true, 'increment_style' => true,
'indentation_type' => true, 'indentation_type' => true,
'is_null' => ['use_yoda_style' => false], 'is_null' => true,
'linebreak_after_opening_tag' => true,
'line_ending' => true, 'line_ending' => true,
'linebreak_after_opening_tag' => true,
'list_syntax' => ['syntax' => 'short'], 'list_syntax' => ['syntax' => 'short'],
'logical_operators' => true,
'lowercase_cast' => true, 'lowercase_cast' => true,
'lowercase_constants' => true, 'lowercase_constants' => false, // Deprecated
'lowercase_keywords' => true, 'lowercase_keywords' => true,
'lowercase_static_reference' => true,
'magic_constant_casing' => true, 'magic_constant_casing' => true,
'magic_method_casing' => true,
'mb_str_functions' => false, // No, too dangerous to change that 'mb_str_functions' => false, // No, too dangerous to change that
'method_argument_space' => true, 'method_argument_space' => true,
'method_chaining_indentation' => true, 'method_chaining_indentation' => true,
'method_separation' => true, 'method_separation' => false, // Deprecated
'modernize_types_casting' => true, 'modernize_types_casting' => true,
'multiline_comment_opening_closing' => true, 'multiline_comment_opening_closing' => true,
'multiline_whitespace_before_semicolons' => true,
'native_constant_invocation' => false, // Micro optimization that look messy
'native_function_casing' => true, 'native_function_casing' => true,
'native_function_invocation' => false, // This is risky and seems to be micro-optimization that make code uglier so not worth it, at least for now 'native_function_invocation' => false, // I suppose this would be best, but I am still unconvinced about the visual aspect of it
'native_function_type_declaration_casing' => true,
'new_with_braces' => true, 'new_with_braces' => true,
'no_alias_functions' => true, 'no_alias_functions' => true,
'no_alternative_syntax' => true,
'no_binary_string' => true,
'no_blank_lines_after_class_opening' => true, 'no_blank_lines_after_class_opening' => true,
'no_blank_lines_after_phpdoc' => true, 'no_blank_lines_after_phpdoc' => true,
'no_blank_lines_before_namespace' => false, // we want 1 blank line before namespace 'no_blank_lines_before_namespace' => false, // we want 1 blank line before namespace
@ -80,16 +101,15 @@ return PhpCsFixer\Config::create()
'no_empty_phpdoc' => true, 'no_empty_phpdoc' => true,
'no_empty_statement' => true, 'no_empty_statement' => true,
'no_extra_blank_lines' => true, 'no_extra_blank_lines' => true,
'no_extra_consecutive_blank_lines' => false, // Deprecated
'no_homoglyph_names' => true, 'no_homoglyph_names' => true,
'no_leading_import_slash' => true, 'no_leading_import_slash' => true,
'no_leading_namespace_whitespace' => true, 'no_leading_namespace_whitespace' => true,
'no_mixed_echo_print' => true, 'no_mixed_echo_print' => true,
'no_multiline_whitespace_around_double_arrow' => true, 'no_multiline_whitespace_around_double_arrow' => true,
'no_multiline_whitespace_before_semicolons' => true, 'no_multiline_whitespace_before_semicolons' => false, // Deprecated
'non_printable_character' => true,
'no_null_property_initialization' => true, 'no_null_property_initialization' => true,
'no_php4_constructor' => true, 'no_php4_constructor' => true,
'normalize_index_brace' => true,
'no_short_bool_cast' => true, 'no_short_bool_cast' => true,
'no_short_echo_tag' => true, 'no_short_echo_tag' => true,
'no_singleline_whitespace_before_semicolons' => true, 'no_singleline_whitespace_before_semicolons' => true,
@ -97,29 +117,55 @@ return PhpCsFixer\Config::create()
'no_spaces_around_offset' => true, 'no_spaces_around_offset' => true,
'no_spaces_inside_parenthesis' => true, 'no_spaces_inside_parenthesis' => true,
'no_superfluous_elseif' => false, // Might be risky on a huge code base 'no_superfluous_elseif' => false, // Might be risky on a huge code base
'not_operator_with_space' => false, // No we prefer to keep '!' without spaces 'no_superfluous_phpdoc_tags' => ['allow_mixed' => true],
'not_operator_with_successor_space' => false, // idem
'no_trailing_comma_in_list_call' => true, 'no_trailing_comma_in_list_call' => true,
'no_trailing_comma_in_singleline_array' => true, 'no_trailing_comma_in_singleline_array' => true,
'no_trailing_whitespace_in_comment' => true,
'no_trailing_whitespace' => true, 'no_trailing_whitespace' => true,
'no_trailing_whitespace_in_comment' => true,
'no_unneeded_control_parentheses' => true, 'no_unneeded_control_parentheses' => true,
'no_unneeded_curly_braces' => true, 'no_unneeded_curly_braces' => true,
'no_unneeded_final_method' => true, 'no_unneeded_final_method' => true,
'no_unreachable_default_argument_value' => true, 'no_unreachable_default_argument_value' => true,
'no_unset_cast' => true,
'no_unset_on_property' => true,
'no_unused_imports' => true, 'no_unused_imports' => true,
'no_useless_else' => true, 'no_useless_else' => true,
'no_useless_return' => true, 'no_useless_return' => true,
'no_whitespace_before_comma_in_array' => true, 'no_whitespace_before_comma_in_array' => true,
'no_whitespace_in_blank_line' => true, 'no_whitespace_in_blank_line' => true,
'non_printable_character' => true,
'normalize_index_brace' => true,
'not_operator_with_space' => false, // No we prefer to keep '!' without spaces
'not_operator_with_successor_space' => false, // idem
'nullable_type_declaration_for_default_null_value' => true,
'object_operator_without_whitespace' => true, 'object_operator_without_whitespace' => true,
'ordered_class_elements' => false, // We prefer to keep some freedom 'ordered_class_elements' => false, // We prefer to keep some freedom
'ordered_imports' => true, 'ordered_imports' => true,
'ordered_interfaces' => true,
'php_unit_construct' => true,
'php_unit_dedicate_assert' => true,
'php_unit_dedicate_assert_internal_type' => true,
'php_unit_expectation' => true,
'php_unit_fqcn_annotation' => true,
'php_unit_internal_class' => false, // Because tests are excluded from package
'php_unit_method_casing' => true,
'php_unit_mock' => true,
'php_unit_mock_short_will_return' => true,
'php_unit_namespaced' => true,
'php_unit_no_expectation_annotation' => true,
'php_unit_ordered_covers' => true,
'php_unit_set_up_tear_down_visibility' => true,
'php_unit_size_class' => false, // That seems extra work to maintain for little benefits
'php_unit_strict' => false, // We sometime actually need assertEquals
'php_unit_test_annotation' => true,
'php_unit_test_case_static_method_calls' => ['call_type' => 'self'],
'php_unit_test_class_requires_covers' => false, // We don't care as much as we should about coverage
'phpdoc_add_missing_param_annotation' => true, 'phpdoc_add_missing_param_annotation' => true,
'phpdoc_align' => false, // Waste of time 'phpdoc_align' => false, // Waste of time
'phpdoc_annotation_without_dot' => true, 'phpdoc_annotation_without_dot' => true,
'phpdoc_indent' => true, 'phpdoc_indent' => true,
'phpdoc_inline_tag' => true, 'phpdoc_inline_tag' => true,
'phpdoc_line_span' => false, // Unfortunately our old comments turn even uglier with this
'phpdoc_no_access' => true, 'phpdoc_no_access' => true,
'phpdoc_no_alias_tag' => true, 'phpdoc_no_alias_tag' => true,
'phpdoc_no_empty_return' => true, 'phpdoc_no_empty_return' => true,
@ -132,43 +178,46 @@ return PhpCsFixer\Config::create()
'phpdoc_single_line_var_spacing' => true, 'phpdoc_single_line_var_spacing' => true,
'phpdoc_summary' => true, 'phpdoc_summary' => true,
'phpdoc_to_comment' => true, 'phpdoc_to_comment' => true,
'phpdoc_to_param_type' => false, // Because experimental, but interesting for one shot use
'phpdoc_to_return_type' => false, // idem
'phpdoc_trim' => true, 'phpdoc_trim' => true,
'phpdoc_types_order' => true, 'phpdoc_trim_consecutive_blank_line_separation' => true,
'phpdoc_types' => true, 'phpdoc_types' => true,
'phpdoc_types_order' => true,
'phpdoc_var_annotation_correct_order' => true,
'phpdoc_var_without_name' => true, 'phpdoc_var_without_name' => true,
'php_unit_construct' => true, 'pow_to_exponentiation' => true,
'php_unit_dedicate_assert' => true, 'pre_increment' => false, // Deprecated
'php_unit_expectation' => true,
'php_unit_fqcn_annotation' => true,
'php_unit_mock' => true,
'php_unit_namespaced' => true,
'php_unit_no_expectation_annotation' => true,
'php_unit_strict' => false, // We sometime actually need assertEquals
'php_unit_test_annotation' => true,
'php_unit_test_class_requires_covers' => false, // We don't care as much as we should about coverage
'pow_to_exponentiation' => false,
'protected_to_private' => true, 'protected_to_private' => true,
'psr0' => true, 'psr0' => true,
'psr4' => true, 'psr4' => true,
'random_api_migration' => false, // This breaks our unit tests 'random_api_migration' => true,
'return_assignment' => false, // Sometimes useful for clarity or debug
'return_type_declaration' => true, 'return_type_declaration' => true,
'self_accessor' => true, 'self_accessor' => true,
'self_static_accessor' => true,
'semicolon_after_instruction' => false, // Buggy in `samples/index.php` 'semicolon_after_instruction' => false, // Buggy in `samples/index.php`
'set_type_to_cast' => true,
'short_scalar_cast' => true, 'short_scalar_cast' => true,
'silenced_deprecation_error' => true, 'silenced_deprecation_error' => false, // Deprecated
'simplified_null_return' => false, // While technically correct we prefer to be explicit when returning null 'simple_to_complex_string_variable' => false, // Would differ from TypeScript without obvious advantages
'simplified_null_return' => false, // Even if technically correct we prefer to be explicit
'single_blank_line_at_eof' => true, 'single_blank_line_at_eof' => true,
'single_blank_line_before_namespace' => true, 'single_blank_line_before_namespace' => true,
'single_class_element_per_statement' => true, 'single_class_element_per_statement' => true,
'single_import_per_statement' => true, 'single_import_per_statement' => true,
'single_line_after_imports' => true, 'single_line_after_imports' => true,
'single_line_comment_style' => true, 'single_line_comment_style' => true,
'single_line_throw' => false, // I don't see any reason for having a special case for Exception
'single_quote' => true, 'single_quote' => true,
'single_trait_insert_per_statement' => true,
'space_after_semicolon' => true, 'space_after_semicolon' => true,
'standardize_increment' => true,
'standardize_not_equals' => true, 'standardize_not_equals' => true,
'static_lambda' => false, // Risky if we can't guarantee nobody use `bindTo()` 'static_lambda' => false, // Risky if we can't guarantee nobody use `bindTo()`
'strict_comparison' => false, // No, too dangerous to change that 'strict_comparison' => false, // No, too dangerous to change that
'strict_param' => false, // No, too dangerous to change that 'strict_param' => false, // No, too dangerous to change that
'string_line_ending' => true,
'switch_case_semicolon_to_colon' => true, 'switch_case_semicolon_to_colon' => true,
'switch_case_space' => true, 'switch_case_space' => true,
'ternary_operator_spaces' => true, 'ternary_operator_spaces' => true,
@ -177,7 +226,7 @@ return PhpCsFixer\Config::create()
'trim_array_spaces' => true, 'trim_array_spaces' => true,
'unary_operator_spaces' => true, 'unary_operator_spaces' => true,
'visibility_required' => true, 'visibility_required' => true,
'void_return' => false, // Cannot use that with PHP 5.6 'void_return' => true,
'whitespace_after_comma_in_array' => true, 'whitespace_after_comma_in_array' => true,
'yoda_style' => false, 'yoda_style' => false,
]); ]);

2
.travis.yml
View File

@ -41,7 +41,7 @@ jobs:
if: tag is present AND branch = master if: tag is present AND branch = master
php: 7.4 php: 7.4
before_script: before_script:
- curl -O https://github.com/phpDocumentor/phpDocumentor/releases/download/v3.0.0-rc/phpDocumentor.phar - curl -LO https://github.com/phpDocumentor/phpDocumentor/releases/download/v3.0.0-rc/phpDocumentor.phar
script: script:
- php phpDocumentor.phar --directory src/ --target docs/api - php phpDocumentor.phar --directory src/ --target docs/api
deploy: deploy:

15
CHANGELOG.md
View File

@ -7,9 +7,24 @@ and this project adheres to [Semantic Versioning](https://semver.org).
## [Unreleased] ## [Unreleased]
### Added
- Support writing to streams in all writers [#1292](https://github.com/PHPOffice/PhpSpreadsheet/issues/1292)
- Support CSV files with data wrapping a lot of lines [#1468](https://github.com/PHPOffice/PhpSpreadsheet/pull/1468)
### Fixed
- Fix Chart samples by updating chart parameter from 0 to DataSeries::EMPTY_AS_GAP [#1448](https://github.com/PHPOffice/PhpSpreadsheet/pull/1448)
- Fix return type in docblock for the Cells::get() [#1398](https://github.com/PHPOffice/PhpSpreadsheet/pull/1398)
- Fix RATE, PRICE, XIRR, and XNPV Functions [#1456](https://github.com/PHPOffice/PhpSpreadsheet/pull/1456)
- Save Excel 2010+ functions properly in XLSX [#1461](https://github.com/PHPOffice/PhpSpreadsheet/pull/1461)
- Several improvements in HTML writer [#1464](https://github.com/PHPOffice/PhpSpreadsheet/pull/1464)
### Changed ### Changed
- Drop support for PHP 7.1, according to https://phpspreadsheet.readthedocs.io/en/latest/#php-version-support - Drop support for PHP 7.1, according to https://phpspreadsheet.readthedocs.io/en/latest/#php-version-support
- Drop partial migration tool in favor of complete migration via RectorPHP [#1445](https://github.com/PHPOffice/PhpSpreadsheet/issues/1445)
- Limit composer package to `src/` [#1424](https://github.com/PHPOffice/PhpSpreadsheet/pull/1424)
## [1.12.0] - 2020-04-27 ## [1.12.0] - 2020-04-27

2
README.md
View File

@ -22,6 +22,8 @@ PhpSpreadsheet is the next version of PHPExcel. It breaks compatibility to drama
Because all efforts have shifted to PhpSpreadsheet, PHPExcel will no longer be maintained. All contributions for PHPExcel, patches and new features, should target PhpSpreadsheet `master` branch. Because all efforts have shifted to PhpSpreadsheet, PHPExcel will no longer be maintained. All contributions for PHPExcel, patches and new features, should target PhpSpreadsheet `master` branch.
Do you need to migrate? There is [an automated tool](/docs/topics/migration-from-PHPExcel.md) for that.
## License ## License
PhpSpreadsheet is licensed under [MIT](https://github.com/PHPOffice/PhpSpreadsheet/blob/master/LICENSE). PhpSpreadsheet is licensed under [MIT](https://github.com/PHPOffice/PhpSpreadsheet/blob/master/LICENSE).

4
bin/generate-document
View File

@ -4,7 +4,7 @@
use PhpOffice\PhpSpreadsheet\Calculation\Calculation; use PhpOffice\PhpSpreadsheet\Calculation\Calculation;
use PhpOffice\PhpSpreadsheet\DocumentGenerator; use PhpOffice\PhpSpreadsheet\DocumentGenerator;
require_once __DIR__ . '/../src/Bootstrap.php'; require_once 'vendor/autoload.php';
try { try {
$phpSpreadsheetFunctionsProperty = (new ReflectionClass(Calculation::class))->getProperty('phpSpreadsheetFunctions'); $phpSpreadsheetFunctionsProperty = (new ReflectionClass(Calculation::class))->getProperty('phpSpreadsheetFunctions');
@ -19,6 +19,6 @@ try {
DocumentGenerator::generateFunctionListByName($phpSpreadsheetFunctions) DocumentGenerator::generateFunctionListByName($phpSpreadsheetFunctions)
); );
} catch (ReflectionException $e) { } catch (ReflectionException $e) {
fwrite(STDERR, (string)$e); fwrite(STDERR, (string) $e);
exit(1); exit(1);
} }

8
bin/migrate-from-phpexcel
View File

@ -1,8 +0,0 @@
#!/usr/bin/env php
<?php
use PhpOffice\PhpSpreadsheet\Helper\Migrator;
require_once __DIR__ . '/../src/Bootstrap.php';
$migrator = new Migrator();
$migrator->migrate();

3
composer.json
View File

@ -55,7 +55,8 @@
"ext-zlib": "*", "ext-zlib": "*",
"markbaker/complex": "^1.4", "markbaker/complex": "^1.4",
"markbaker/matrix": "^1.2", "markbaker/matrix": "^1.2",
"psr/simple-cache": "^1.0" "psr/simple-cache": "^1.0",
"maennchen/zipstream-php": "^2.0"
}, },
"require-dev": { "require-dev": {
"dompdf/dompdf": "^0.8.5", "dompdf/dompdf": "^0.8.5",

344
composer.lock generated
View File

@ -4,8 +4,69 @@
"Read more about it at https://getcomposer.org/doc/01-basic-usage.md#installing-dependencies", "Read more about it at https://getcomposer.org/doc/01-basic-usage.md#installing-dependencies",
"This file is @generated automatically" "This file is @generated automatically"
], ],
"content-hash": "9c60146d8c78c13d2610a2cec23339a2", "content-hash": "ab06908c3ff8187971def16c578f1ced",
"packages": [ "packages": [
{
"name": "maennchen/zipstream-php",
"version": "2.0.0",
"source": {
"type": "git",
"url": "https://github.com/maennchen/ZipStream-PHP.git",
"reference": "9ceee828f9620b2e5c075e551ec7ed8a7035ac95"
},
"dist": {
"type": "zip",
"url": "https://api.github.com/repos/maennchen/ZipStream-PHP/zipball/9ceee828f9620b2e5c075e551ec7ed8a7035ac95",
"reference": "9ceee828f9620b2e5c075e551ec7ed8a7035ac95",
"shasum": ""
},
"require": {
"ext-mbstring": "*",
"myclabs/php-enum": "^1.5",
"php": ">= 7.1",
"psr/http-message": "^1.0"
},
"require-dev": {
"ext-zip": "*",
"guzzlehttp/guzzle": ">= 6.3",
"mikey179/vfsstream": "^1.6",
"phpunit/phpunit": ">= 7.5"
},
"type": "library",
"autoload": {
"psr-4": {
"ZipStream\\": "src/"
}
},
"notification-url": "https://packagist.org/downloads/",
"license": [
"MIT"
],
"authors": [
{
"name": "Paul Duncan",
"email": "pabs@pablotron.org"
},
{
"name": "Jonatan Männchen",
"email": "jonatan@maennchen.ch"
},
{
"name": "Jesse Donat",
"email": "donatj@gmail.com"
},
{
"name": "András Kolesár",
"email": "kolesar@kolesar.hu"
}
],
"description": "ZipStream is a library for dynamically streaming dynamic zip files from PHP without writing to the disk at all on the server.",
"keywords": [
"stream",
"zip"
],
"time": "2020-02-23T01:48:39+00:00"
},
{ {
"name": "markbaker/complex", "name": "markbaker/complex",
"version": "1.4.8", "version": "1.4.8",
@ -170,6 +231,102 @@
], ],
"time": "2019-10-06T11:29:25+00:00" "time": "2019-10-06T11:29:25+00:00"
}, },
{
"name": "myclabs/php-enum",
"version": "1.7.6",
"source": {
"type": "git",
"url": "https://github.com/myclabs/php-enum.git",
"reference": "5f36467c7a87e20fbdc51e524fd8f9d1de80187c"
},
"dist": {
"type": "zip",
"url": "https://api.github.com/repos/myclabs/php-enum/zipball/5f36467c7a87e20fbdc51e524fd8f9d1de80187c",
"reference": "5f36467c7a87e20fbdc51e524fd8f9d1de80187c",
"shasum": ""
},
"require": {
"ext-json": "*",
"php": ">=7.1"
},
"require-dev": {
"phpunit/phpunit": "^7",
"squizlabs/php_codesniffer": "1.*",
"vimeo/psalm": "^3.8"
},
"type": "library",
"autoload": {
"psr-4": {
"MyCLabs\\Enum\\": "src/"
}
},
"notification-url": "https://packagist.org/downloads/",
"license": [
"MIT"
],
"authors": [
{
"name": "PHP Enum contributors",
"homepage": "https://github.com/myclabs/php-enum/graphs/contributors"
}
],
"description": "PHP Enum implementation",
"homepage": "http://github.com/myclabs/php-enum",
"keywords": [
"enum"
],
"time": "2020-02-14T08:15:52+00:00"
},
{
"name": "psr/http-message",
"version": "1.0.1",
"source": {
"type": "git",
"url": "https://github.com/php-fig/http-message.git",
"reference": "f6561bf28d520154e4b0ec72be95418abe6d9363"
},
"dist": {
"type": "zip",
"url": "https://api.github.com/repos/php-fig/http-message/zipball/f6561bf28d520154e4b0ec72be95418abe6d9363",
"reference": "f6561bf28d520154e4b0ec72be95418abe6d9363",
"shasum": ""
},
"require": {
"php": ">=5.3.0"
},
"type": "library",
"extra": {
"branch-alias": {
"dev-master": "1.0.x-dev"
}
},
"autoload": {
"psr-4": {
"Psr\\Http\\Message\\": "src/"
}
},
"notification-url": "https://packagist.org/downloads/",
"license": [
"MIT"
],
"authors": [
{
"name": "PHP-FIG",
"homepage": "http://www.php-fig.org/"
}
],
"description": "Common interface for HTTP messages",
"homepage": "https://github.com/php-fig/http-message",
"keywords": [
"http",
"http-message",
"psr",
"psr-7",
"request",
"response"
],
"time": "2016-08-06T14:39:51+00:00"
},
{ {
"name": "psr/simple-cache", "name": "psr/simple-cache",
"version": "1.0.1", "version": "1.0.1",
@ -323,6 +480,12 @@
"Xdebug", "Xdebug",
"performance" "performance"
], ],
"funding": [
{
"url": "https://packagist.com",
"type": "custom"
}
],
"time": "2020-03-01T12:26:26+00:00" "time": "2020-03-01T12:26:26+00:00"
}, },
{ {
@ -667,6 +830,12 @@
} }
], ],
"description": "A tool to automatically fix PHP code style", "description": "A tool to automatically fix PHP code style",
"funding": [
{
"url": "https://github.com/keradus",
"type": "github"
}
],
"time": "2020-04-15T18:51:10+00:00" "time": "2020-04-15T18:51:10+00:00"
}, },
{ {
@ -1703,6 +1872,16 @@
"testing", "testing",
"xunit" "xunit"
], ],
"funding": [
{
"url": "https://phpunit.de/donate.html",
"type": "custom"
},
{
"url": "https://github.com/sebastianbergmann",
"type": "github"
}
],
"time": "2020-04-23T04:39:42+00:00" "time": "2020-04-23T04:39:42+00:00"
}, },
{ {
@ -2566,6 +2745,12 @@
"fpdi", "fpdi",
"pdf" "pdf"
], ],
"funding": [
{
"url": "https://tidelift.com/funding/github/packagist/setasign/fpdi",
"type": "tidelift"
}
],
"time": "2020-03-23T15:53:59+00:00" "time": "2020-03-23T15:53:59+00:00"
}, },
{ {
@ -2693,6 +2878,20 @@
], ],
"description": "Symfony Console Component", "description": "Symfony Console Component",
"homepage": "https://symfony.com", "homepage": "https://symfony.com",
"funding": [
{
"url": "https://symfony.com/sponsor",
"type": "custom"
},
{
"url": "https://github.com/fabpot",
"type": "github"
},
{
"url": "https://tidelift.com/funding/github/packagist/symfony/symfony",
"type": "tidelift"
}
],
"time": "2020-03-30T11:42:42+00:00" "time": "2020-03-30T11:42:42+00:00"
}, },
{ {
@ -2763,6 +2962,20 @@
], ],
"description": "Symfony EventDispatcher Component", "description": "Symfony EventDispatcher Component",
"homepage": "https://symfony.com", "homepage": "https://symfony.com",
"funding": [
{
"url": "https://symfony.com/sponsor",
"type": "custom"
},
{
"url": "https://github.com/fabpot",
"type": "github"
},
{
"url": "https://tidelift.com/funding/github/packagist/symfony/symfony",
"type": "tidelift"
}
],
"time": "2020-03-27T16:56:45+00:00" "time": "2020-03-27T16:56:45+00:00"
}, },
{ {
@ -2871,6 +3084,20 @@
], ],
"description": "Symfony Filesystem Component", "description": "Symfony Filesystem Component",
"homepage": "https://symfony.com", "homepage": "https://symfony.com",
"funding": [
{
"url": "https://symfony.com/sponsor",
"type": "custom"
},
{
"url": "https://github.com/fabpot",
"type": "github"
},
{
"url": "https://tidelift.com/funding/github/packagist/symfony/symfony",
"type": "tidelift"
}
],
"time": "2020-03-27T16:56:45+00:00" "time": "2020-03-27T16:56:45+00:00"
}, },
{ {
@ -2920,6 +3147,20 @@
], ],
"description": "Symfony Finder Component", "description": "Symfony Finder Component",
"homepage": "https://symfony.com", "homepage": "https://symfony.com",
"funding": [
{
"url": "https://symfony.com/sponsor",
"type": "custom"
},
{
"url": "https://github.com/fabpot",
"type": "github"
},
{
"url": "https://tidelift.com/funding/github/packagist/symfony/symfony",
"type": "tidelift"
}
],
"time": "2020-03-27T16:56:45+00:00" "time": "2020-03-27T16:56:45+00:00"
}, },
{ {
@ -2974,6 +3215,20 @@
"configuration", "configuration",
"options" "options"
], ],
"funding": [
{
"url": "https://symfony.com/sponsor",
"type": "custom"
},
{
"url": "https://github.com/fabpot",
"type": "github"
},
{
"url": "https://tidelift.com/funding/github/packagist/symfony/symfony",
"type": "tidelift"
}
],
"time": "2020-03-27T16:56:45+00:00" "time": "2020-03-27T16:56:45+00:00"
}, },
{ {
@ -3032,6 +3287,20 @@
"polyfill", "polyfill",
"portable" "portable"
], ],
"funding": [
{
"url": "https://symfony.com/sponsor",
"type": "custom"
},
{
"url": "https://github.com/fabpot",
"type": "github"
},
{
"url": "https://tidelift.com/funding/github/packagist/symfony/symfony",
"type": "tidelift"
}
],
"time": "2020-02-27T09:26:54+00:00" "time": "2020-02-27T09:26:54+00:00"
}, },
{ {
@ -3091,6 +3360,20 @@
"portable", "portable",
"shim" "shim"
], ],
"funding": [
{
"url": "https://symfony.com/sponsor",
"type": "custom"
},
{
"url": "https://github.com/fabpot",
"type": "github"
},
{
"url": "https://tidelift.com/funding/github/packagist/symfony/symfony",
"type": "tidelift"
}
],
"time": "2020-03-09T19:04:49+00:00" "time": "2020-03-09T19:04:49+00:00"
}, },
{ {
@ -3205,6 +3488,20 @@
"portable", "portable",
"shim" "shim"
], ],
"funding": [
{
"url": "https://symfony.com/sponsor",
"type": "custom"
},
{
"url": "https://github.com/fabpot",
"type": "github"
},
{
"url": "https://tidelift.com/funding/github/packagist/symfony/symfony",
"type": "tidelift"
}
],
"time": "2020-02-27T09:26:54+00:00" "time": "2020-02-27T09:26:54+00:00"
}, },
{ {
@ -3263,6 +3560,20 @@
"portable", "portable",
"shim" "shim"
], ],
"funding": [
{
"url": "https://symfony.com/sponsor",
"type": "custom"
},
{
"url": "https://github.com/fabpot",
"type": "github"
},
{
"url": "https://tidelift.com/funding/github/packagist/symfony/symfony",
"type": "tidelift"
}
],
"time": "2020-02-27T09:26:54+00:00" "time": "2020-02-27T09:26:54+00:00"
}, },
{ {
@ -3312,6 +3623,20 @@
], ],
"description": "Symfony Process Component", "description": "Symfony Process Component",
"homepage": "https://symfony.com", "homepage": "https://symfony.com",
"funding": [
{
"url": "https://symfony.com/sponsor",
"type": "custom"
},
{
"url": "https://github.com/fabpot",
"type": "github"
},
{
"url": "https://tidelift.com/funding/github/packagist/symfony/symfony",
"type": "tidelift"
}
],
"time": "2020-03-27T16:56:45+00:00" "time": "2020-03-27T16:56:45+00:00"
}, },
{ {
@ -3420,6 +3745,20 @@
], ],
"description": "Symfony Stopwatch Component", "description": "Symfony Stopwatch Component",
"homepage": "https://symfony.com", "homepage": "https://symfony.com",
"funding": [
{
"url": "https://symfony.com/sponsor",
"type": "custom"
},
{
"url": "https://github.com/fabpot",
"type": "github"
},
{
"url": "https://tidelift.com/funding/github/packagist/symfony/symfony",
"type": "tidelift"
}
],
"time": "2020-03-27T16:56:45+00:00" "time": "2020-03-27T16:56:45+00:00"
}, },
{ {
@ -3594,5 +3933,6 @@
"ext-zip": "*", "ext-zip": "*",
"ext-zlib": "*" "ext-zlib": "*"
}, },
"platform-dev": [] "platform-dev": [],
"plugin-api-version": "1.1.0"
} }

11
docs/index.md
View File

@ -42,6 +42,13 @@ Use [composer](https://getcomposer.org) to install PhpSpreadsheet into your proj
composer require phpoffice/phpspreadsheet composer require phpoffice/phpspreadsheet
``` ```
Or also download the documentation and samples if you plan to use them:
```sh
composer require phpoffice/phpspreadsheet --prefer-source
```
## Hello World ## Hello World
This would be the simplest way to write a spreadsheet: This would be the simplest way to write a spreadsheet:
@ -64,8 +71,8 @@ $writer->save('hello world.xlsx');
## Learn by example ## Learn by example
A good way to get started is to run some of the samples. Serve the samples via A good way to get started is to run some of the samples. Don't forget to download them via `--prefer-source` composer
PHP built-in webserver: flag. And then serve them via PHP built-in webserver:
```sh ```sh
php -S localhost:8000 -t vendor/phpoffice/phpspreadsheet/samples php -S localhost:8000 -t vendor/phpoffice/phpspreadsheet/samples

4
docs/references/function-list-by-category.md
View File

@ -200,6 +200,8 @@ ISREF | **Not yet Implemented**
ISTEXT | \PhpOffice\PhpSpreadsheet\Calculation\Functions::isText ISTEXT | \PhpOffice\PhpSpreadsheet\Calculation\Functions::isText
N | \PhpOffice\PhpSpreadsheet\Calculation\Functions::n N | \PhpOffice\PhpSpreadsheet\Calculation\Functions::n
NA | \PhpOffice\PhpSpreadsheet\Calculation\Functions::NA NA | \PhpOffice\PhpSpreadsheet\Calculation\Functions::NA
SHEET | **Not yet Implemented**
SHEETS | **Not yet Implemented**
TYPE | \PhpOffice\PhpSpreadsheet\Calculation\Functions::TYPE TYPE | \PhpOffice\PhpSpreadsheet\Calculation\Functions::TYPE
## CATEGORY_LOGICAL ## CATEGORY_LOGICAL
@ -272,6 +274,8 @@ EXP | exp
FACT | \PhpOffice\PhpSpreadsheet\Calculation\MathTrig::FACT FACT | \PhpOffice\PhpSpreadsheet\Calculation\MathTrig::FACT
FACTDOUBLE | \PhpOffice\PhpSpreadsheet\Calculation\MathTrig::FACTDOUBLE FACTDOUBLE | \PhpOffice\PhpSpreadsheet\Calculation\MathTrig::FACTDOUBLE
FLOOR | \PhpOffice\PhpSpreadsheet\Calculation\MathTrig::FLOOR FLOOR | \PhpOffice\PhpSpreadsheet\Calculation\MathTrig::FLOOR
FLOOR.MATH | \PhpOffice\PhpSpreadsheet\Calculation\MathTrig::FLOORMATH
FLOOR.PRECISE | \PhpOffice\PhpSpreadsheet\Calculation\MathTrig::FLOORPRECISE
GCD | \PhpOffice\PhpSpreadsheet\Calculation\MathTrig::GCD GCD | \PhpOffice\PhpSpreadsheet\Calculation\MathTrig::GCD
INT | \PhpOffice\PhpSpreadsheet\Calculation\MathTrig::INT INT | \PhpOffice\PhpSpreadsheet\Calculation\MathTrig::INT
LCM | \PhpOffice\PhpSpreadsheet\Calculation\MathTrig::LCM LCM | \PhpOffice\PhpSpreadsheet\Calculation\MathTrig::LCM

4
docs/references/function-list-by-name.md
View File

@ -170,6 +170,8 @@ FISHER | CATEGORY_STATISTICAL | \PhpOffice\PhpSpreadsheet
FISHERINV | CATEGORY_STATISTICAL | \PhpOffice\PhpSpreadsheet\Calculation\Statistical::FISHERINV FISHERINV | CATEGORY_STATISTICAL | \PhpOffice\PhpSpreadsheet\Calculation\Statistical::FISHERINV
FIXED | CATEGORY_TEXT_AND_DATA | \PhpOffice\PhpSpreadsheet\Calculation\TextData::FIXEDFORMAT FIXED | CATEGORY_TEXT_AND_DATA | \PhpOffice\PhpSpreadsheet\Calculation\TextData::FIXEDFORMAT
FLOOR | CATEGORY_MATH_AND_TRIG | \PhpOffice\PhpSpreadsheet\Calculation\MathTrig::FLOOR FLOOR | CATEGORY_MATH_AND_TRIG | \PhpOffice\PhpSpreadsheet\Calculation\MathTrig::FLOOR
FLOOR.MATH | CATEGORY_MATH_AND_TRIG | \PhpOffice\PhpSpreadsheet\Calculation\MathTrig::FLOORMATH
FLOOR.PRECISE | CATEGORY_MATH_AND_TRIG | \PhpOffice\PhpSpreadsheet\Calculation\MathTrig::FLOORPRECISE
FORECAST | CATEGORY_STATISTICAL | \PhpOffice\PhpSpreadsheet\Calculation\Statistical::FORECAST FORECAST | CATEGORY_STATISTICAL | \PhpOffice\PhpSpreadsheet\Calculation\Statistical::FORECAST
FORMULATEXT | CATEGORY_LOOKUP_AND_REFERENCE | \PhpOffice\PhpSpreadsheet\Calculation\LookupRef::FORMULATEXT FORMULATEXT | CATEGORY_LOOKUP_AND_REFERENCE | \PhpOffice\PhpSpreadsheet\Calculation\LookupRef::FORMULATEXT
FREQUENCY | CATEGORY_STATISTICAL | **Not yet Implemented** FREQUENCY | CATEGORY_STATISTICAL | **Not yet Implemented**
@ -419,6 +421,8 @@ SEC | CATEGORY_MATH_AND_TRIG | \PhpOffice\PhpSpreadsheet
SECH | CATEGORY_MATH_AND_TRIG | \PhpOffice\PhpSpreadsheet\Calculation\MathTrig::SECH SECH | CATEGORY_MATH_AND_TRIG | \PhpOffice\PhpSpreadsheet\Calculation\MathTrig::SECH
SECOND | CATEGORY_DATE_AND_TIME | \PhpOffice\PhpSpreadsheet\Calculation\DateTime::SECOND SECOND | CATEGORY_DATE_AND_TIME | \PhpOffice\PhpSpreadsheet\Calculation\DateTime::SECOND
SERIESSUM | CATEGORY_MATH_AND_TRIG | \PhpOffice\PhpSpreadsheet\Calculation\MathTrig::SERIESSUM SERIESSUM | CATEGORY_MATH_AND_TRIG | \PhpOffice\PhpSpreadsheet\Calculation\MathTrig::SERIESSUM
SHEET | CATEGORY_INFORMATION | **Not yet Implemented**
SHEETS | CATEGORY_INFORMATION | **Not yet Implemented**
SIGN | CATEGORY_MATH_AND_TRIG | \PhpOffice\PhpSpreadsheet\Calculation\MathTrig::SIGN SIGN | CATEGORY_MATH_AND_TRIG | \PhpOffice\PhpSpreadsheet\Calculation\MathTrig::SIGN
SIN | CATEGORY_MATH_AND_TRIG | sin SIN | CATEGORY_MATH_AND_TRIG | sin
SINH | CATEGORY_MATH_AND_TRIG | sinh SINH | CATEGORY_MATH_AND_TRIG | sinh

427
docs/topics/migration-from-PHPExcel.md
View File

@ -8,426 +8,15 @@ need to be done.
## Automated tool ## Automated tool
The tool is included in PhpSpreadsheet. It scans recursively all files [RectorPHP](https://github.com/rectorphp/rector) can be used to migrate
and directories, starting from the current directory. Assuming it was automatically your codebase. Assuming your files to be migrated lives
installed with composer, it can be run like so: in `src/`, you can run the migration like so:
``` sh ``` sh
cd /project/to/migrate/src composer require rector/rector --dev
php /project/to/migrate/vendor/phpoffice/phpspreadsheet/bin/migrate-from-phpexcel vendor/bin/rector process src --set phpexcel-to-phpspreadsheet
composer remove rector/rector
``` ```
**Important** The tool will irreversibly modify your sources, be sure to For more details, see
backup everything, and double check the result before committing. [RectorPHP blog post](https://getrector.org/blog/2020/04/16/how-to-migrate-from-phpexcel-to-phpspreadsheet-with-rector-in-30-minutes).
## Manual changes
In addition to automated changes, a few things need to be migrated manually.
### Renamed readers and writers
When using `IOFactory::createReader()`, `IOFactory::createWriter()` and
`IOFactory::identify()`, the reader/writer short names are used. Those were
changed, along as their corresponding class, to remove ambiguity:
Before | After
-----------------|---------
`'CSV'` | `'Csv'`
`'Excel2003XML'` | `'Xml'`
`'Excel2007'` | `'Xlsx'`
`'Excel5'` | `'Xls'`
`'Gnumeric'` | `'Gnumeric'`
`'HTML'` | `'Html'`
`'OOCalc'` | `'Ods'`
`'OpenDocument'` | `'Ods'`
`'PDF'` | `'Pdf'`
`'SYLK'` | `'Slk'`
### Simplified IOFactory
The following methods :
- `PHPExcel_IOFactory::getSearchLocations()`
- `PHPExcel_IOFactory::setSearchLocations()`
- `PHPExcel_IOFactory::addSearchLocation()`
were replaced by `IOFactory::registerReader()` and `IOFactory::registerWriter()`. That means
IOFactory now relies on classes autoloading.
Before:
```php
\PHPExcel_IOFactory::addSearchLocation($type, $location, $classname);
```
After:
```php
\PhpOffice\PhpSpreadsheet\IOFactory::registerReader($type, $classname);
```
### Removed deprecated things
#### Worksheet::duplicateStyleArray()
``` php
// Before
$worksheet->duplicateStyleArray($styles, $range, $advanced);
// After
$worksheet->getStyle($range)->applyFromArray($styles, $advanced);
```
#### DataType::dataTypeForValue()
``` php
// Before
DataType::dataTypeForValue($value);
// After
DefaultValueBinder::dataTypeForValue($value);
```
#### Conditional::getCondition()
``` php
// Before
$conditional->getCondition();
// After
$conditional->getConditions()[0];
```
#### Conditional::setCondition()
``` php
// Before
$conditional->setCondition($value);
// After
$conditional->setConditions($value);
```
#### Worksheet::getDefaultStyle()
``` php
// Before
$worksheet->getDefaultStyle();
// After
$worksheet->getParent()->getDefaultStyle();
```
#### Worksheet::setDefaultStyle()
``` php
// Before
$worksheet->setDefaultStyle($value);
// After
$worksheet->getParent()->getDefaultStyle()->applyFromArray([
'font' => [
'name' => $pValue->getFont()->getName(),
'size' => $pValue->getFont()->getSize(),
],
]);
```
#### Worksheet::setSharedStyle()
``` php
// Before
$worksheet->setSharedStyle($sharedStyle, $range);
// After
$worksheet->duplicateStyle($sharedStyle, $range);
```
#### Worksheet::getSelectedCell()
``` php
// Before
$worksheet->getSelectedCell();
// After
$worksheet->getSelectedCells();
```
#### Writer\Xls::setTempDir()
``` php
// Before
$writer->setTempDir();
// After, there is no way to set temporary storage directory anymore
```
### Autoloader
The class `PHPExcel_Autoloader` was removed entirely and is replaced by composer
autoloading mechanism.
### Writing PDF
PDF libraries must be installed via composer. And the following methods were removed
and are replaced by `IOFactory::registerWriter()` instead:
- `PHPExcel_Settings::getPdfRenderer()`
- `PHPExcel_Settings::setPdfRenderer()`
- `PHPExcel_Settings::getPdfRendererName()`
- `PHPExcel_Settings::setPdfRendererName()`
Before:
```php
\PHPExcel_Settings::setPdfRendererName(PHPExcel_Settings::PDF_RENDERER_MPDF);
\PHPExcel_Settings::setPdfRenderer($somePath);
$writer = \PHPExcel_IOFactory::createWriter($spreadsheet, 'PDF');
```
After:
```php
$writer = \PhpOffice\PhpSpreadsheet\IOFactory::createWriter($spreadsheet, 'Mpdf');
// Or alternatively
\PhpOffice\PhpSpreadsheet\IOFactory::registerWriter('Pdf', \PhpOffice\PhpSpreadsheet\Writer\Pdf\Mpdf::class);
$writer = \PhpOffice\PhpSpreadsheet\IOFactory::createWriter($spreadsheet, 'Pdf');
// Or alternatively
$writer = new \PhpOffice\PhpSpreadsheet\Writer\Pdf\Mpdf($spreadsheet);
```
### Rendering charts
When rendering charts for HTML or PDF outputs, the process was also simplified. And while
JpGraph support is still available, it is unfortunately not up to date for latest PHP versions
and it will generate various warnings.
If you rely on this feature, please consider
contributing either patches to JpGraph or another `IRenderer` implementation (a good
candidate might be [CpChart](https://github.com/szymach/c-pchart)).
Before:
```php
$rendererName = \PHPExcel_Settings::CHART_RENDERER_JPGRAPH;
$rendererLibrary = 'jpgraph3.5.0b1/src/';
$rendererLibraryPath = '/php/libraries/Charts/' . $rendererLibrary;
\PHPExcel_Settings::setChartRenderer($rendererName, $rendererLibraryPath);
```
After:
Require the dependency via composer:
```sh
composer require jpgraph/jpgraph
```
And then:
```php
Settings::setChartRenderer(\PhpOffice\PhpSpreadsheet\Chart\Renderer\JpGraph::class);
```
### PclZip and ZipArchive
Support for PclZip were dropped in favor of the more complete and modern
[PHP extension ZipArchive](https://php.net/manual/en/book.zip.php).
So the following were removed:
- `PclZip`
- `PHPExcel_Settings::setZipClass()`
- `PHPExcel_Settings::getZipClass()`
- `PHPExcel_Shared_ZipArchive`
- `PHPExcel_Shared_ZipStreamWrapper`
### Cell caching
Cell caching was heavily refactored to leverage
[PSR-16](https://www.php-fig.org/psr/psr-16/). That means most classes
related to that feature were removed:
- `PHPExcel_CachedObjectStorage_APC`
- `PHPExcel_CachedObjectStorage_DiscISAM`
- `PHPExcel_CachedObjectStorage_ICache`
- `PHPExcel_CachedObjectStorage_Igbinary`
- `PHPExcel_CachedObjectStorage_Memcache`
- `PHPExcel_CachedObjectStorage_Memory`
- `PHPExcel_CachedObjectStorage_MemoryGZip`
- `PHPExcel_CachedObjectStorage_MemorySerialized`
- `PHPExcel_CachedObjectStorage_PHPTemp`
- `PHPExcel_CachedObjectStorage_SQLite`
- `PHPExcel_CachedObjectStorage_SQLite3`
- `PHPExcel_CachedObjectStorage_Wincache`
In addition to that, `\PhpOffice\PhpSpreadsheet::getCellCollection()` was renamed
to `\PhpOffice\PhpSpreadsheet::getCoordinates()` and
`\PhpOffice\PhpSpreadsheet::getCellCacheController()` to
`\PhpOffice\PhpSpreadsheet::getCellCollection()` for clarity.
Refer to [the new documentation](./memory_saving.md) to see how to migrate.
### Dropped conditionally returned cell
For all the following methods, it is no more possible to change the type of
returned value. It always return the Worksheet and never the Cell or Rule:
- Worksheet::setCellValue()
- Worksheet::setCellValueByColumnAndRow()
- Worksheet::setCellValueExplicit()
- Worksheet::setCellValueExplicitByColumnAndRow()
- Worksheet::addRule()
Migration would be similar to:
``` php
// Before
$cell = $worksheet->setCellValue('A1', 'value', true);
// After
$cell = $worksheet->getCell('A1')->setValue('value');
```
### Standardized keys for styling
Array keys used for styling have been standardized for a more coherent experience.
It now uses the same wording and casing as the getter and setter:
```php
// Before
$style = [
'numberformat' => [
'code' => NumberFormat::FORMAT_CURRENCY_EUR_SIMPLE,
],
'font' => [
'strike' => true,
'superScript' => true,
'subScript' => true,
],
'alignment' => [
'rotation' => 90,
'readorder' => Alignment::READORDER_RTL,
'wrap' => true,
],
'borders' => [
'diagonaldirection' => Borders::DIAGONAL_BOTH,
'allborders' => [
'style' => Border::BORDER_THIN,
],
],
'fill' => [
'type' => Fill::FILL_GRADIENT_LINEAR,
'startcolor' => [
'argb' => 'FFA0A0A0',
],
'endcolor' => [
'argb' => 'FFFFFFFF',
],
],
];
// After
$style = [
'numberFormat' => [
'formatCode' => NumberFormat::FORMAT_CURRENCY_EUR_SIMPLE,
],
'font' => [
'strikethrough' => true,
'superscript' => true,
'subscript' => true,
],
'alignment' => [
'textRotation' => 90,
'readOrder' => Alignment::READORDER_RTL,
'wrapText' => true,
],
'borders' => [
'diagonalDirection' => Borders::DIAGONAL_BOTH,
'allBorders' => [
'borderStyle' => Border::BORDER_THIN,
],
],
'fill' => [
'fillType' => Fill::FILL_GRADIENT_LINEAR,
'startColor' => [
'argb' => 'FFA0A0A0',
],
'endColor' => [
'argb' => 'FFFFFFFF',
],
],
];
```
### Dedicated class to manipulate coordinates
Methods to manipulate coordinates that used to exists in `PHPExcel_Cell` were extracted
to a dedicated new class `\PhpOffice\PhpSpreadsheet\Cell\Coordinate`. The methods are:
- `absoluteCoordinate()`
- `absoluteReference()`
- `buildRange()`
- `columnIndexFromString()`
- `coordinateFromString()`
- `extractAllCellReferencesInRange()`
- `getRangeBoundaries()`
- `mergeRangesInCollection()`
- `rangeBoundaries()`
- `rangeDimension()`
- `splitRange()`
- `stringFromColumnIndex()`
### Column index based on 1
Column indexes are now based on 1. So column `A` is the index `1`. This is consistent
with rows starting at 1 and Excel function `COLUMN()` that returns `1` for column `A`.
So the code must be adapted with something like:
```php
// Before
$cell = $worksheet->getCellByColumnAndRow($column, $row);
for ($column = 0; $column < $max; $column++) {
$worksheet->setCellValueByColumnAndRow($column, $row, 'value ' . $column);
}
// After
$cell = $worksheet->getCellByColumnAndRow($column + 1, $row);
for ($column = 1; $column <= $max; $column++) {
$worksheet->setCellValueByColumnAndRow($column, $row, 'value ' . $column);
}
```
All the following methods are affected:
- `PHPExcel_Worksheet::cellExistsByColumnAndRow()`
- `PHPExcel_Worksheet::freezePaneByColumnAndRow()`
- `PHPExcel_Worksheet::getCellByColumnAndRow()`
- `PHPExcel_Worksheet::getColumnDimensionByColumn()`
- `PHPExcel_Worksheet::getCommentByColumnAndRow()`
- `PHPExcel_Worksheet::getStyleByColumnAndRow()`
- `PHPExcel_Worksheet::insertNewColumnBeforeByIndex()`
- `PHPExcel_Worksheet::mergeCellsByColumnAndRow()`
- `PHPExcel_Worksheet::protectCellsByColumnAndRow()`
- `PHPExcel_Worksheet::removeColumnByIndex()`
- `PHPExcel_Worksheet::setAutoFilterByColumnAndRow()`
- `PHPExcel_Worksheet::setBreakByColumnAndRow()`
- `PHPExcel_Worksheet::setCellValueByColumnAndRow()`
- `PHPExcel_Worksheet::setCellValueExplicitByColumnAndRow()`
- `PHPExcel_Worksheet::setSelectedCellByColumnAndRow()`
- `PHPExcel_Worksheet::stringFromColumnIndex()`
- `PHPExcel_Worksheet::unmergeCellsByColumnAndRow()`
- `PHPExcel_Worksheet::unprotectCellsByColumnAndRow()`
- `PHPExcel_Worksheet_PageSetup::addPrintAreaByColumnAndRow()`
- `PHPExcel_Worksheet_PageSetup::setPrintAreaByColumnAndRow()`
### Removed default values
Default values for many methods were removed when it did not make sense. Typically,
setter methods should not have default values. For a complete list of methods and
their original default values, see [that commit](https://github.com/PHPOffice/PhpSpreadsheet/commit/033a4bdad56340795a5bf7ec3c8a2fde005cda24).

35
docs/topics/reading-and-writing-to-file.md
View File

@ -535,8 +535,12 @@ $writer->save("05featuredemo.csv");
#### Writing UTF-8 CSV files #### Writing UTF-8 CSV files
A CSV file can be marked as UTF-8 by writing a BOM file header. This can CSV files are written in UTF-8. If they do not contain characters
be enabled by using the following code: outside the ASCII range, nothing else need be done.
However, if such characters are in the file,
it should explicitly include a BOM file header;
if it doesn't, Excel will not interpret those characters correctly.
This can be enabled by using the following code:
``` php ``` php
$writer = new \PhpOffice\PhpSpreadsheet\Writer\Csv($spreadsheet); $writer = new \PhpOffice\PhpSpreadsheet\Writer\Csv($spreadsheet);
@ -677,35 +681,26 @@ Supported methods:
- `generateStyles()` - `generateStyles()`
- `generateSheetData()` - `generateSheetData()`
- `generateHTMLFooter()` - `generateHTMLFooter()`
- `generateHTMLAll()`
Here's an example which retrieves all parts independently and merges Here's an example which retrieves all parts independently and merges
them into a resulting HTML page: them into a resulting HTML page:
``` php ``` php
<?php
$writer = new \PhpOffice\PhpSpreadsheet\Writer\Html($spreadsheet); $writer = new \PhpOffice\PhpSpreadsheet\Writer\Html($spreadsheet);
echo $writer->generateHTMLHeader(); $hdr = $writer->generateHTMLHeader();
?> $sty = $writer->generateStyles(false); // do not write <style> and </style>
$newstyle = <<<EOF
<style> <style type='text/css'>
<!-- $sty
html { html {
font-family: Times New Roman; background-color: yellow;
font-size: 9pt;
background-color: white;
} }
<?php
echo $writer->generateStyles(false); // do not write <style> and </style>
?>
-->
</style> </style>
EOF;
<?php echo preg_replace('@</head>@', "$newstyle\n</head>", $hdr);
echo $writer->generateSheetData(); echo $writer->generateSheetData();
echo $writer->generateHTMLFooter(); echo $writer->generateHTMLFooter();
?>
``` ```
#### Writing UTF-8 HTML files #### Writing UTF-8 HTML files

4
phpunit.xml.dist
View File

@ -1,7 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?> <?xml version="1.0" encoding="UTF-8"?>
<phpunit <phpunit
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/7.5/phpunit.xsd" xsi:noNamespaceSchemaLocation="vendor/phpunit/phpunit/phpunit.xsd"
bootstrap="./tests/bootstrap.php" bootstrap="./tests/bootstrap.php"
backupGlobals="true" backupGlobals="true"
colors="true" colors="true"
@ -11,7 +11,7 @@
<ini name="memory_limit" value="2048M"/> <ini name="memory_limit" value="2048M"/>
</php> </php>
<testsuite name="PhpSpreadsheet Unit Test Suite"> <testsuite name="PhpSpreadsheet Unit Test Suite">
<directory suffix="Test.php">./tests/PhpSpreadsheetTests</directory> <directory>./tests/PhpSpreadsheetTests</directory>
</testsuite> </testsuite>
<filter> <filter>
<whitelist> <whitelist>

12
samples/Autofilter/10_Autofilter_selection_1.php
View File

@ -59,18 +59,18 @@ foreach ($years as $year) {
$period, $period,
$i $i
); );
$value = rand(500, 1000) * (1 + (rand(-1, 1) / 4)); $value = mt_rand(500, 1000) * (1 + (mt_rand(-1, 1) / 4));
$salesValue = $invoiceValue = null; $salesValue = $invoiceValue = null;
$incomeOrExpenditure = rand(-1, 1); $incomeOrExpenditure = mt_rand(-1, 1);
if ($incomeOrExpenditure == -1) { if ($incomeOrExpenditure == -1) {
$expenditure = rand(-500, -1000) * (1 + (rand(-1, 1) / 4)); $expenditure = mt_rand(-1000, -500) * (1 + (mt_rand(-1, 1) / 4));
$income = null; $income = null;
} elseif ($incomeOrExpenditure == 1) { } elseif ($incomeOrExpenditure == 1) {
$expenditure = rand(-500, -1000) * (1 + (rand(-1, 1) / 4)); $expenditure = mt_rand(-1000, -500) * (1 + (mt_rand(-1, 1) / 4));
$income = rand(500, 1000) * (1 + (rand(-1, 1) / 4)); $income = mt_rand(500, 1000) * (1 + (mt_rand(-1, 1) / 4));
} else { } else {
$expenditure = null; $expenditure = null;
$income = rand(500, 1000) * (1 + (rand(-1, 1) / 4)); $income = mt_rand(500, 1000) * (1 + (mt_rand(-1, 1) / 4));
} }
$dataArray = [$year, $dataArray = [$year,
$period, $period,

12
samples/Autofilter/10_Autofilter_selection_2.php
View File

@ -59,18 +59,18 @@ foreach ($years as $year) {
$period, $period,
$i $i
); );
$value = rand(500, 1000) * (1 + (rand(-1, 1) / 4)); $value = mt_rand(500, 1000) * (1 + (mt_rand(-1, 1) / 4));
$salesValue = $invoiceValue = null; $salesValue = $invoiceValue = null;
$incomeOrExpenditure = rand(-1, 1); $incomeOrExpenditure = mt_rand(-1, 1);
if ($incomeOrExpenditure == -1) { if ($incomeOrExpenditure == -1) {
$expenditure = rand(-500, -1000) * (1 + (rand(-1, 1) / 4)); $expenditure = mt_rand(-1000, -500) * (1 + (mt_rand(-1, 1) / 4));
$income = null; $income = null;
} elseif ($incomeOrExpenditure == 1) { } elseif ($incomeOrExpenditure == 1) {
$expenditure = rand(-500, -1000) * (1 + (rand(-1, 1) / 4)); $expenditure = mt_rand(-1000, -500) * (1 + (mt_rand(-1, 1) / 4));
$income = rand(500, 1000) * (1 + (rand(-1, 1) / 4)); $income = mt_rand(500, 1000) * (1 + (mt_rand(-1, 1) / 4));
} else { } else {
$expenditure = null; $expenditure = null;
$income = rand(500, 1000) * (1 + (rand(-1, 1) / 4)); $income = mt_rand(500, 1000) * (1 + (mt_rand(-1, 1) / 4));
} }
$dataArray = [$year, $dataArray = [$year,
$period, $period,

12
samples/Autofilter/10_Autofilter_selection_display.php
View File

@ -59,18 +59,18 @@ foreach ($years as $year) {
$period, $period,
$i $i
); );
$value = rand(500, 1000) * (1 + (rand(-1, 1) / 4)); $value = mt_rand(500, 1000) * (1 + (mt_rand(-1, 1) / 4));
$salesValue = $invoiceValue = null; $salesValue = $invoiceValue = null;
$incomeOrExpenditure = rand(-1, 1); $incomeOrExpenditure = mt_rand(-1, 1);
if ($incomeOrExpenditure == -1) { if ($incomeOrExpenditure == -1) {
$expenditure = rand(-500, -1000) * (1 + (rand(-1, 1) / 4)); $expenditure = mt_rand(-1000, -500) * (1 + (mt_rand(-1, 1) / 4));
$income = null; $income = null;
} elseif ($incomeOrExpenditure == 1) { } elseif ($incomeOrExpenditure == 1) {
$expenditure = rand(-500, -1000) * (1 + (rand(-1, 1) / 4)); $expenditure = mt_rand(-1000, -500) * (1 + (mt_rand(-1, 1) / 4));
$income = rand(500, 1000) * (1 + (rand(-1, 1) / 4)); $income = mt_rand(500, 1000) * (1 + (mt_rand(-1, 1) / 4));
} else { } else {
$expenditure = null; $expenditure = null;
$income = rand(500, 1000) * (1 + (rand(-1, 1) / 4)); $income = mt_rand(500, 1000) * (1 + (mt_rand(-1, 1) / 4));
} }
$dataArray = [$year, $dataArray = [$year,
$period, $period,

2
samples/Basic/01_Simple_download_ods.php
View File

@ -4,7 +4,7 @@ use PhpOffice\PhpSpreadsheet\Helper\Sample;
use PhpOffice\PhpSpreadsheet\IOFactory; use PhpOffice\PhpSpreadsheet\IOFactory;
use PhpOffice\PhpSpreadsheet\Spreadsheet; use PhpOffice\PhpSpreadsheet\Spreadsheet;
require_once __DIR__ . '/../../src/Bootstrap.php'; require_once __DIR__ . '/../Bootstrap.php';
$helper = new Sample(); $helper = new Sample();
if ($helper->isCli()) { if ($helper->isCli()) {

2
samples/Basic/01_Simple_download_pdf.php
View File

@ -4,7 +4,7 @@ use PhpOffice\PhpSpreadsheet\Helper\Sample;
use PhpOffice\PhpSpreadsheet\IOFactory; use PhpOffice\PhpSpreadsheet\IOFactory;
use PhpOffice\PhpSpreadsheet\Spreadsheet; use PhpOffice\PhpSpreadsheet\Spreadsheet;
require_once __DIR__ . '/../../src/Bootstrap.php'; require_once __DIR__ . '/../Bootstrap.php';
$helper = new Sample(); $helper = new Sample();
if ($helper->isCli()) { if ($helper->isCli()) {

2
samples/Basic/01_Simple_download_xls.php
View File

@ -4,7 +4,7 @@ use PhpOffice\PhpSpreadsheet\Helper\Sample;
use PhpOffice\PhpSpreadsheet\IOFactory; use PhpOffice\PhpSpreadsheet\IOFactory;
use PhpOffice\PhpSpreadsheet\Spreadsheet; use PhpOffice\PhpSpreadsheet\Spreadsheet;
require_once __DIR__ . '/../../src/Bootstrap.php'; require_once __DIR__ . '/../Bootstrap.php';
$helper = new Sample(); $helper = new Sample();
if ($helper->isCli()) { if ($helper->isCli()) {

2
samples/Basic/01_Simple_download_xlsx.php
View File

@ -4,7 +4,7 @@ use PhpOffice\PhpSpreadsheet\Helper\Sample;
use PhpOffice\PhpSpreadsheet\IOFactory; use PhpOffice\PhpSpreadsheet\IOFactory;
use PhpOffice\PhpSpreadsheet\Spreadsheet; use PhpOffice\PhpSpreadsheet\Spreadsheet;
require_once __DIR__ . '/../../src/Bootstrap.php'; require_once __DIR__ . '/../Bootstrap.php';
$helper = new Sample(); $helper = new Sample();
if ($helper->isCli()) { if ($helper->isCli()) {

2
samples/Basic/13_CalculationCyclicFormulae.php
View File

@ -16,7 +16,7 @@ $spreadsheet->getActiveSheet()->setCellValue('A1', '=B1')
->setCellValue('B1', '=A1+1') ->setCellValue('B1', '=A1+1')
->setCellValue('B2', '=A2'); ->setCellValue('B2', '=A2');
Calculation::getInstance($spreadsheet)->cyclicFormulaCount = 100; Calculation::getInstance($spreadsheet)->cyclicFormulaCount = 15;
// Calculated data // Calculated data
$helper->log('Calculated data'); $helper->log('Calculated data');

14
samples/Basic/17a_Html.php Normal file
View File

@ -0,0 +1,14 @@
<?php
use PhpOffice\PhpSpreadsheet\Writer\Html;
require __DIR__ . '/../Header.php';
$spreadsheet = require __DIR__ . '/../templates/sampleSpreadsheet.php';
$filename = $helper->getFilename(__FILE__, 'html');
$writer = new Html($spreadsheet);
$callStartTime = microtime(true);
$writer->setEmbedImages(true);
$writer->save($filename);
$helper->logWrite($writer, $filename, $callStartTime);

7
samples/Basic/25_In_memory_image.php
View File

@ -21,7 +21,11 @@ $spreadsheet->getProperties()->setCreator('Maarten Balliauw')
// Generate an image // Generate an image
$helper->log('Generate an image'); $helper->log('Generate an image');
$gdImage = @imagecreatetruecolor(120, 20) or die('Cannot Initialize new GD image stream'); $gdImage = @imagecreatetruecolor(120, 20);
if (!$gdImage) {
die('Cannot Initialize new GD image stream');
}
$textColor = imagecolorallocate($gdImage, 255, 255, 255); $textColor = imagecolorallocate($gdImage, 255, 255, 255);
imagestring($gdImage, 1, 5, 5, 'Created with PhpSpreadsheet', $textColor); imagestring($gdImage, 1, 5, 5, 'Created with PhpSpreadsheet', $textColor);
@ -35,6 +39,7 @@ $drawing->setRenderingFunction(MemoryDrawing::RENDERING_JPEG);
$drawing->setMimeType(MemoryDrawing::MIMETYPE_DEFAULT); $drawing->setMimeType(MemoryDrawing::MIMETYPE_DEFAULT);
$drawing->setHeight(36); $drawing->setHeight(36);
$drawing->setWorksheet($spreadsheet->getActiveSheet()); $drawing->setWorksheet($spreadsheet->getActiveSheet());
$drawing->setCoordinates('C5');
// Save // Save
$helper->write($spreadsheet, __FILE__, ['Xlsx', 'Html']); $helper->write($spreadsheet, __FILE__, ['Xlsx', 'Html']);

2
samples/Basic/30_Template.php
View File

@ -13,7 +13,7 @@ $helper->log('Add new data to the template');
$data = [['title' => 'Excel for dummies', $data = [['title' => 'Excel for dummies',
'price' => 17.99, 'price' => 17.99,
'quantity' => 2, 'quantity' => 2,
], ],
['title' => 'PHP for dummies', ['title' => 'PHP for dummies',
'price' => 15.99, 'price' => 15.99,
'quantity' => 1, 'quantity' => 1,

0
src/Bootstrap.php → samples/Bootstrap.php
View File

2
samples/Chart/33_Chart_create_area.php
View File

@ -83,7 +83,7 @@ $chart = new Chart(
$legend, // legend $legend, // legend
$plotArea, // plotArea $plotArea, // plotArea
true, // plotVisibleOnly true, // plotVisibleOnly
0, // displayBlanksAs DataSeries::EMPTY_AS_GAP, // displayBlanksAs
null, // xAxisLabel null, // xAxisLabel
$yAxisLabel // yAxisLabel $yAxisLabel // yAxisLabel
); );

2
samples/Chart/33_Chart_create_bar_stacked.php
View File

@ -86,7 +86,7 @@ $chart = new Chart(
$legend, // legend $legend, // legend
$plotArea, // plotArea $plotArea, // plotArea
true, // plotVisibleOnly true, // plotVisibleOnly
0, // displayBlanksAs DataSeries::EMPTY_AS_GAP, // displayBlanksAs
null, // xAxisLabel null, // xAxisLabel
$yAxisLabel // yAxisLabel $yAxisLabel // yAxisLabel
); );

2
samples/Chart/33_Chart_create_column.php
View File

@ -86,7 +86,7 @@ $chart = new Chart(
$legend, // legend $legend, // legend
$plotArea, // plotArea $plotArea, // plotArea
true, // plotVisibleOnly true, // plotVisibleOnly
0, // displayBlanksAs DataSeries::EMPTY_AS_GAP, // displayBlanksAs
null, // xAxisLabel null, // xAxisLabel
$yAxisLabel // yAxisLabel $yAxisLabel // yAxisLabel
); );

2
samples/Chart/33_Chart_create_column_2.php
View File

@ -95,7 +95,7 @@ $chart = new Chart(
$legend, // legend $legend, // legend
$plotArea, // plotArea $plotArea, // plotArea
true, // plotVisibleOnly true, // plotVisibleOnly
0, // displayBlanksAs DataSeries::EMPTY_AS_GAP, // displayBlanksAs
$xAxisLabel, // xAxisLabel $xAxisLabel, // xAxisLabel
$yAxisLabel // yAxisLabel $yAxisLabel // yAxisLabel
); );

2
samples/Chart/33_Chart_create_composite.php
View File

@ -139,7 +139,7 @@ $chart = new Chart(
$legend, // legend $legend, // legend
$plotArea, // plotArea $plotArea, // plotArea
true, // plotVisibleOnly true, // plotVisibleOnly
0, // displayBlanksAs DataSeries::EMPTY_AS_GAP, // displayBlanksAs
null, // xAxisLabel null, // xAxisLabel
null // yAxisLabel null // yAxisLabel
); );

2
samples/Chart/33_Chart_create_line.php
View File

@ -84,7 +84,7 @@ $chart = new Chart(
$legend, // legend $legend, // legend
$plotArea, // plotArea $plotArea, // plotArea
true, // plotVisibleOnly true, // plotVisibleOnly
0, // displayBlanksAs DataSeries::EMPTY_AS_GAP, // displayBlanksAs
null, // xAxisLabel null, // xAxisLabel
$yAxisLabel // yAxisLabel $yAxisLabel // yAxisLabel
); );

4
samples/Chart/33_Chart_create_multiple_charts.php
View File

@ -83,7 +83,7 @@ $chart1 = new Chart(
$legend1, // legend $legend1, // legend
$plotArea1, // plotArea $plotArea1, // plotArea
true, // plotVisibleOnly true, // plotVisibleOnly
0, // displayBlanksAs DataSeries::EMPTY_AS_GAP, // displayBlanksAs
null, // xAxisLabel null, // xAxisLabel
$yAxisLabel1 // yAxisLabel $yAxisLabel1 // yAxisLabel
); );
@ -158,7 +158,7 @@ $chart2 = new Chart(
$legend2, // legend $legend2, // legend
$plotArea2, // plotArea $plotArea2, // plotArea
true, // plotVisibleOnly true, // plotVisibleOnly
0, // displayBlanksAs DataSeries::EMPTY_AS_GAP, // displayBlanksAs
null, // xAxisLabel null, // xAxisLabel
$yAxisLabel2 // yAxisLabel $yAxisLabel2 // yAxisLabel
); );

4
samples/Chart/33_Chart_create_pie.php
View File

@ -84,7 +84,7 @@ $chart1 = new Chart(
$legend1, // legend $legend1, // legend
$plotArea1, // plotArea $plotArea1, // plotArea
true, // plotVisibleOnly true, // plotVisibleOnly
0, // displayBlanksAs DataSeries::EMPTY_AS_GAP, // displayBlanksAs
null, // xAxisLabel null, // xAxisLabel
null // yAxisLabel - Pie charts don't have a Y-Axis null // yAxisLabel - Pie charts don't have a Y-Axis
); );
@ -154,7 +154,7 @@ $chart2 = new Chart(
null, // legend null, // legend
$plotArea2, // plotArea $plotArea2, // plotArea
true, // plotVisibleOnly true, // plotVisibleOnly
0, // displayBlanksAs DataSeries::EMPTY_AS_GAP, // displayBlanksAs
null, // xAxisLabel null, // xAxisLabel
null // yAxisLabel - Like Pie charts, Donut charts don't have a Y-Axis null // yAxisLabel - Like Pie charts, Donut charts don't have a Y-Axis
); );

4
samples/Chart/33_Chart_create_pie_custom_colors.php
View File

@ -90,7 +90,7 @@ $chart1 = new Chart(
$legend1, // legend $legend1, // legend
$plotArea1, // plotArea $plotArea1, // plotArea
true, // plotVisibleOnly true, // plotVisibleOnly
0, // displayBlanksAs DataSeries::EMPTY_AS_GAP, // displayBlanksAs
null, // xAxisLabel null, // xAxisLabel
null // yAxisLabel - Pie charts don't have a Y-Axis null // yAxisLabel - Pie charts don't have a Y-Axis
); );
@ -162,7 +162,7 @@ $chart2 = new Chart(
null, // legend null, // legend
$plotArea2, // plotArea $plotArea2, // plotArea
true, // plotVisibleOnly true, // plotVisibleOnly
0, // displayBlanksAs DataSeries::EMPTY_AS_GAP, // displayBlanksAs
null, // xAxisLabel null, // xAxisLabel
null // yAxisLabel - Like Pie charts, Donut charts don't have a Y-Axis null // yAxisLabel - Like Pie charts, Donut charts don't have a Y-Axis
); );

2
samples/Chart/33_Chart_create_radar.php
View File

@ -96,7 +96,7 @@ $chart = new Chart(
$legend, // legend $legend, // legend
$plotArea, // plotArea $plotArea, // plotArea
true, // plotVisibleOnly true, // plotVisibleOnly
0, // displayBlanksAs DataSeries::EMPTY_AS_GAP, // displayBlanksAs
null, // xAxisLabel null, // xAxisLabel
null // yAxisLabel - Radar charts don't have a Y-Axis null // yAxisLabel - Radar charts don't have a Y-Axis
); );

2
samples/Chart/33_Chart_create_scatter.php
View File

@ -80,7 +80,7 @@ $chart = new Chart(
$legend, // legend $legend, // legend
$plotArea, // plotArea $plotArea, // plotArea
true, // plotVisibleOnly true, // plotVisibleOnly
0, // displayBlanksAs DataSeries::EMPTY_AS_GAP, // displayBlanksAs
null, // xAxisLabel null, // xAxisLabel
$yAxisLabel // yAxisLabel $yAxisLabel // yAxisLabel
); );

2
samples/Chart/33_Chart_create_stock.php
View File

@ -92,7 +92,7 @@ $chart = new Chart(
$legend, // legend $legend, // legend
$plotArea, // plotArea $plotArea, // plotArea
true, // plotVisibleOnly true, // plotVisibleOnly
0, // displayBlanksAs DataSeries::EMPTY_AS_GAP, // displayBlanksAs
$xAxisLabel, // xAxisLabel $xAxisLabel, // xAxisLabel
$yAxisLabel // yAxisLabel $yAxisLabel // yAxisLabel
); );

2
samples/Header.php
View File

@ -6,7 +6,7 @@ use PhpOffice\PhpSpreadsheet\Helper\Sample;
error_reporting(E_ALL); error_reporting(E_ALL);
require_once __DIR__ . '/../src/Bootstrap.php'; require_once __DIR__ . '/Bootstrap.php';
$helper = new Sample(); $helper = new Sample();

2
samples/Reader/12_Reading_a_workbook_in_chunks_using_a_configurable_read_filter_(version_2).php
View File

@ -23,7 +23,7 @@ class ChunkReadFilter implements IReadFilter
* @param mixed $startRow * @param mixed $startRow
* @param mixed $chunkSize * @param mixed $chunkSize
*/ */
public function setRows($startRow, $chunkSize) public function setRows($startRow, $chunkSize): void
{ {
$this->startRow = $startRow; $this->startRow = $startRow;
$this->endRow = $startRow + $chunkSize; $this->endRow = $startRow + $chunkSize;

2
samples/Reader/14_Reading_a_large_CSV_file_in_chunks_to_split_across_multiple_worksheets.php
View File

@ -24,7 +24,7 @@ class ChunkReadFilter implements IReadFilter
* @param mixed $startRow * @param mixed $startRow
* @param mixed $chunkSize * @param mixed $chunkSize
*/ */
public function setRows($startRow, $chunkSize) public function setRows($startRow, $chunkSize): void
{ {
$this->startRow = $startRow; $this->startRow = $startRow;
$this->endRow = $startRow + $chunkSize; $this->endRow = $startRow + $chunkSize;

2
samples/templates/chartSpreadsheet.php
View File

@ -83,7 +83,7 @@ $chart = new Chart(
$legend, // legend $legend, // legend
$plotArea, // plotArea $plotArea, // plotArea
true, // plotVisibleOnly true, // plotVisibleOnly
0, // displayBlanksAs DataSeries::EMPTY_AS_GAP, // displayBlanksAs
null, // xAxisLabel null, // xAxisLabel
$yAxisLabel // yAxisLabel $yAxisLabel // yAxisLabel
); );

109
src/PhpSpreadsheet/Calculation/Calculation.php
View File

@ -11,6 +11,7 @@ use PhpOffice\PhpSpreadsheet\NamedRange;
use PhpOffice\PhpSpreadsheet\Shared; use PhpOffice\PhpSpreadsheet\Shared;
use PhpOffice\PhpSpreadsheet\Spreadsheet; use PhpOffice\PhpSpreadsheet\Spreadsheet;
use PhpOffice\PhpSpreadsheet\Worksheet\Worksheet; use PhpOffice\PhpSpreadsheet\Worksheet\Worksheet;
use ReflectionMethod;
class Calculation class Calculation
{ {
@ -1853,6 +1854,16 @@ class Calculation
'functionCall' => [MathTrig::class, 'SERIESSUM'], 'functionCall' => [MathTrig::class, 'SERIESSUM'],
'argumentCount' => '4', 'argumentCount' => '4',
], ],
'SHEET' => [
'category' => Category::CATEGORY_INFORMATION,
'functionCall' => [Functions::class, 'DUMMY'],
'argumentCount' => '0,1',
],
'SHEETS' => [
'category' => Category::CATEGORY_INFORMATION,
'functionCall' => [Functions::class, 'DUMMY'],
'argumentCount' => '0,1',
],
'SIGN' => [ 'SIGN' => [
'category' => Category::CATEGORY_MATH_AND_TRIG, 'category' => Category::CATEGORY_MATH_AND_TRIG,
'functionCall' => [MathTrig::class, 'SIGN'], 'functionCall' => [MathTrig::class, 'SIGN'],
@ -2247,18 +2258,22 @@ class Calculation
'argumentCount' => '*', 'argumentCount' => '*',
'functionCall' => [__CLASS__, 'mkMatrix'], 'functionCall' => [__CLASS__, 'mkMatrix'],
], ],
'NAME.ERROR' => [
'argumentCount' => '*',
'functionCall' => [Functions::class, 'NAME'],
],
]; ];
public function __construct(Spreadsheet $spreadsheet = null) public function __construct(?Spreadsheet $spreadsheet = null)
{ {
$this->delta = 1 * pow(10, 0 - ini_get('precision')); $this->delta = 1 * 10 ** (0 - ini_get('precision'));
$this->spreadsheet = $spreadsheet; $this->spreadsheet = $spreadsheet;
$this->cyclicReferenceStack = new CyclicReferenceStack(); $this->cyclicReferenceStack = new CyclicReferenceStack();
$this->debugLog = new Logger($this->cyclicReferenceStack); $this->debugLog = new Logger($this->cyclicReferenceStack);
} }
private static function loadLocales() private static function loadLocales(): void
{ {
$localeFileDirectory = __DIR__ . '/locale/'; $localeFileDirectory = __DIR__ . '/locale/';
foreach (glob($localeFileDirectory . '*', GLOB_ONLYDIR) as $filename) { foreach (glob($localeFileDirectory . '*', GLOB_ONLYDIR) as $filename) {
@ -2277,7 +2292,7 @@ class Calculation
* *
* @return Calculation * @return Calculation
*/ */
public static function getInstance(Spreadsheet $spreadsheet = null) public static function getInstance(?Spreadsheet $spreadsheet = null)
{ {
if ($spreadsheet !== null) { if ($spreadsheet !== null) {
$instance = $spreadsheet->getCalculationEngine(); $instance = $spreadsheet->getCalculationEngine();
@ -2297,7 +2312,7 @@ class Calculation
* Flush the calculation cache for any existing instance of this class * Flush the calculation cache for any existing instance of this class
* but only if a Calculation instance exists. * but only if a Calculation instance exists.
*/ */
public function flushInstance() public function flushInstance(): void
{ {
$this->clearCalculationCache(); $this->clearCalculationCache();
$this->clearBranchStore(); $this->clearBranchStore();
@ -2315,8 +2330,6 @@ class Calculation
/** /**
* __clone implementation. Cloning should not be allowed in a Singleton! * __clone implementation. Cloning should not be allowed in a Singleton!
*
* @throws Exception
*/ */
final public function __clone() final public function __clone()
{ {
@ -2388,7 +2401,7 @@ class Calculation
* *
* @param bool $pValue * @param bool $pValue
*/ */
public function setCalculationCacheEnabled($pValue) public function setCalculationCacheEnabled($pValue): void
{ {
$this->calculationCacheEnabled = $pValue; $this->calculationCacheEnabled = $pValue;
$this->clearCalculationCache(); $this->clearCalculationCache();
@ -2397,7 +2410,7 @@ class Calculation
/** /**
* Enable calculation cache. * Enable calculation cache.
*/ */
public function enableCalculationCache() public function enableCalculationCache(): void
{ {
$this->setCalculationCacheEnabled(true); $this->setCalculationCacheEnabled(true);
} }
@ -2405,7 +2418,7 @@ class Calculation
/** /**
* Disable calculation cache. * Disable calculation cache.
*/ */
public function disableCalculationCache() public function disableCalculationCache(): void
{ {
$this->setCalculationCacheEnabled(false); $this->setCalculationCacheEnabled(false);
} }
@ -2413,7 +2426,7 @@ class Calculation
/** /**
* Clear calculation cache. * Clear calculation cache.
*/ */
public function clearCalculationCache() public function clearCalculationCache(): void
{ {
$this->calculationCache = []; $this->calculationCache = [];
} }
@ -2423,7 +2436,7 @@ class Calculation
* *
* @param string $worksheetName * @param string $worksheetName
*/ */
public function clearCalculationCacheForWorksheet($worksheetName) public function clearCalculationCacheForWorksheet($worksheetName): void
{ {
if (isset($this->calculationCache[$worksheetName])) { if (isset($this->calculationCache[$worksheetName])) {
unset($this->calculationCache[$worksheetName]); unset($this->calculationCache[$worksheetName]);
@ -2436,7 +2449,7 @@ class Calculation
* @param string $fromWorksheetName * @param string $fromWorksheetName
* @param string $toWorksheetName * @param string $toWorksheetName
*/ */
public function renameCalculationCacheForWorksheet($fromWorksheetName, $toWorksheetName) public function renameCalculationCacheForWorksheet($fromWorksheetName, $toWorksheetName): void
{ {
if (isset($this->calculationCache[$fromWorksheetName])) { if (isset($this->calculationCache[$fromWorksheetName])) {
$this->calculationCache[$toWorksheetName] = &$this->calculationCache[$fromWorksheetName]; $this->calculationCache[$toWorksheetName] = &$this->calculationCache[$fromWorksheetName];
@ -2447,25 +2460,24 @@ class Calculation
/** /**
* Enable/disable calculation cache. * Enable/disable calculation cache.
* *
* @param bool $pValue
* @param mixed $enabled * @param mixed $enabled
*/ */
public function setBranchPruningEnabled($enabled) public function setBranchPruningEnabled($enabled): void
{ {
$this->branchPruningEnabled = $enabled; $this->branchPruningEnabled = $enabled;
} }
public function enableBranchPruning() public function enableBranchPruning(): void
{ {
$this->setBranchPruningEnabled(true); $this->setBranchPruningEnabled(true);
} }
public function disableBranchPruning() public function disableBranchPruning(): void
{ {
$this->setBranchPruningEnabled(false); $this->setBranchPruningEnabled(false);
} }
public function clearBranchStore() public function clearBranchStore(): void
{ {
$this->branchStoreKeyCounter = 0; $this->branchStoreKeyCounter = 0;
} }
@ -2765,11 +2777,9 @@ class Calculation
* *
* @param Cell $pCell Cell to calculate * @param Cell $pCell Cell to calculate
* *
* @throws Exception
*
* @return mixed * @return mixed
*/ */
public function calculate(Cell $pCell = null) public function calculate(?Cell $pCell = null)
{ {
try { try {
return $this->calculateCellValue($pCell); return $this->calculateCellValue($pCell);
@ -2784,11 +2794,9 @@ class Calculation
* @param Cell $pCell Cell to calculate * @param Cell $pCell Cell to calculate
* @param bool $resetLog Flag indicating whether the debug log should be reset or not * @param bool $resetLog Flag indicating whether the debug log should be reset or not
* *
* @throws \PhpOffice\PhpSpreadsheet\Exception
*
* @return mixed * @return mixed
*/ */
public function calculateCellValue(Cell $pCell = null, $resetLog = true) public function calculateCellValue(?Cell $pCell = null, $resetLog = true)
{ {
if ($pCell === null) { if ($pCell === null) {
return null; return null;
@ -2888,11 +2896,9 @@ class Calculation
* @param string $cellID Address of the cell to calculate * @param string $cellID Address of the cell to calculate
* @param Cell $pCell Cell to calculate * @param Cell $pCell Cell to calculate
* *
* @throws \PhpOffice\PhpSpreadsheet\Exception
*
* @return mixed * @return mixed
*/ */
public function calculateFormula($formula, $cellID = null, Cell $pCell = null) public function calculateFormula($formula, $cellID = null, ?Cell $pCell = null)
{ {
// Initialise the logging settings // Initialise the logging settings
$this->formulaError = null; $this->formulaError = null;
@ -2951,7 +2957,7 @@ class Calculation
* @param string $cellReference * @param string $cellReference
* @param mixed $cellValue * @param mixed $cellValue
*/ */
public function saveValueToCache($cellReference, $cellValue) public function saveValueToCache($cellReference, $cellValue): void
{ {
if ($this->calculationCacheEnabled) { if ($this->calculationCacheEnabled) {
$this->calculationCache[$cellReference] = $cellValue; $this->calculationCache[$cellReference] = $cellValue;
@ -2965,11 +2971,9 @@ class Calculation
* @param string $cellID The ID (e.g. A3) of the cell that we are calculating * @param string $cellID The ID (e.g. A3) of the cell that we are calculating
* @param Cell $pCell Cell to calculate * @param Cell $pCell Cell to calculate
* *
* @throws Exception
*
* @return mixed * @return mixed
*/ */
public function _calculateFormulaValue($formula, $cellID = null, Cell $pCell = null) public function _calculateFormulaValue($formula, $cellID = null, ?Cell $pCell = null)
{ {
$cellValue = null; $cellValue = null;
@ -3115,7 +3119,7 @@ class Calculation
* @param int $matrix2Rows Row size of second matrix operand * @param int $matrix2Rows Row size of second matrix operand
* @param int $matrix2Columns Column size of second matrix operand * @param int $matrix2Columns Column size of second matrix operand
*/ */
private static function resizeMatricesShrink(&$matrix1, &$matrix2, $matrix1Rows, $matrix1Columns, $matrix2Rows, $matrix2Columns) private static function resizeMatricesShrink(&$matrix1, &$matrix2, $matrix1Rows, $matrix1Columns, $matrix2Rows, $matrix2Columns): void
{ {
if (($matrix2Columns < $matrix1Columns) || ($matrix2Rows < $matrix1Rows)) { if (($matrix2Columns < $matrix1Columns) || ($matrix2Rows < $matrix1Rows)) {
if ($matrix2Rows < $matrix1Rows) { if ($matrix2Rows < $matrix1Rows) {
@ -3158,7 +3162,7 @@ class Calculation
* @param int $matrix2Rows Row size of second matrix operand * @param int $matrix2Rows Row size of second matrix operand
* @param int $matrix2Columns Column size of second matrix operand * @param int $matrix2Columns Column size of second matrix operand
*/ */
private static function resizeMatricesExtend(&$matrix1, &$matrix2, $matrix1Rows, $matrix1Columns, $matrix2Rows, $matrix2Columns) private static function resizeMatricesExtend(&$matrix1, &$matrix2, $matrix1Rows, $matrix1Columns, $matrix2Rows, $matrix2Columns): void
{ {
if (($matrix2Columns < $matrix1Columns) || ($matrix2Rows < $matrix1Rows)) { if (($matrix2Columns < $matrix1Columns) || ($matrix2Rows < $matrix1Rows)) {
if ($matrix2Columns < $matrix1Columns) { if ($matrix2Columns < $matrix1Columns) {
@ -3367,11 +3371,10 @@ class Calculation
/** /**
* @param string $formula * @param string $formula
* @param null|\PhpOffice\PhpSpreadsheet\Cell\Cell $pCell
* *
* @return bool * @return bool
*/ */
private function _parseFormula($formula, Cell $pCell = null) private function _parseFormula($formula, ?Cell $pCell = null)
{ {
if (($formula = $this->convertMatrixReferences(trim($formula))) === false) { if (($formula = $this->convertMatrixReferences(trim($formula))) === false) {
return false; return false;
@ -3465,7 +3468,7 @@ class Calculation
++$index; // Drop the redundant plus symbol ++$index; // Drop the redundant plus symbol
} elseif ((($opCharacter == '~') || ($opCharacter == '|')) && (!$isOperandOrFunction)) { // We have to explicitly deny a tilde or pipe, because they are legal } elseif ((($opCharacter == '~') || ($opCharacter == '|')) && (!$isOperandOrFunction)) { // We have to explicitly deny a tilde or pipe, because they are legal
return $this->raiseFormulaError("Formula Error: Illegal character '~'"); // on the stack but not in the input expression return $this->raiseFormulaError("Formula Error: Illegal character '~'"); // on the stack but not in the input expression
} elseif ((isset(self::$operators[$opCharacter]) or $isOperandOrFunction) && $expectingOperator) { // Are we putting an operator on the stack? } elseif ((isset(self::$operators[$opCharacter]) || $isOperandOrFunction) && $expectingOperator) { // Are we putting an operator on the stack?
while ($stack->count() > 0 && while ($stack->count() > 0 &&
($o2 = $stack->last()) && ($o2 = $stack->last()) &&
isset(self::$operators[$o2['value']]) && isset(self::$operators[$o2['value']]) &&
@ -3491,7 +3494,7 @@ class Calculation
// Branch pruning we decrease the depth whether is it a function // Branch pruning we decrease the depth whether is it a function
// call or a parenthesis // call or a parenthesis
if (!empty($pendingStoreKey)) { if (!empty($pendingStoreKey)) {
$parenthesisDepthMap[$pendingStoreKey] -= 1; --$parenthesisDepthMap[$pendingStoreKey];
} }
if (is_array($d) && preg_match('/^' . self::CALCULATION_REGEXP_FUNCTION . '$/i', $d['value'], $matches)) { // Did this parenthesis just close a function? if (is_array($d) && preg_match('/^' . self::CALCULATION_REGEXP_FUNCTION . '$/i', $d['value'], $matches)) { // Did this parenthesis just close a function?
@ -3505,7 +3508,7 @@ class Calculation
} }
$expectingThenMap[$pendingStoreKey] = false; $expectingThenMap[$pendingStoreKey] = false;
$expectingElseMap[$pendingStoreKey] = false; $expectingElseMap[$pendingStoreKey] = false;
$parenthesisDepthMap[$pendingStoreKey] -= 1; --$parenthesisDepthMap[$pendingStoreKey];
array_pop($pendingStoreKeysStack); array_pop($pendingStoreKeysStack);
unset($pendingStoreKey); unset($pendingStoreKey);
} }
@ -3611,7 +3614,7 @@ class Calculation
++$index; ++$index;
} elseif ($opCharacter == '(' && !$expectingOperator) { } elseif ($opCharacter == '(' && !$expectingOperator) {
if (!empty($pendingStoreKey)) { // Branch pruning: we go deeper if (!empty($pendingStoreKey)) { // Branch pruning: we go deeper
$parenthesisDepthMap[$pendingStoreKey] += 1; ++$parenthesisDepthMap[$pendingStoreKey];
} }
$stack->push('Brace', '(', null, $currentCondition, $currentOnlyIf, $currentOnlyIf); $stack->push('Brace', '(', null, $currentCondition, $currentOnlyIf, $currentOnlyIf);
++$index; ++$index;
@ -3625,6 +3628,9 @@ class Calculation
$val = preg_replace('/\s/u', '', $val); $val = preg_replace('/\s/u', '', $val);
if (isset(self::$phpSpreadsheetFunctions[strtoupper($matches[1])]) || isset(self::$controlFunctions[strtoupper($matches[1])])) { // it's a function if (isset(self::$phpSpreadsheetFunctions[strtoupper($matches[1])]) || isset(self::$controlFunctions[strtoupper($matches[1])])) { // it's a function
$valToUpper = strtoupper($val); $valToUpper = strtoupper($val);
} else {
$valToUpper = 'NAME.ERROR(';
}
// here $matches[1] will contain values like "IF" // here $matches[1] will contain values like "IF"
// and $val "IF(" // and $val "IF("
if ($this->branchPruningEnabled && ($valToUpper == 'IF(')) { // we handle a new if if ($this->branchPruningEnabled && ($valToUpper == 'IF(')) { // we handle a new if
@ -3632,15 +3638,15 @@ class Calculation
$pendingStoreKeysStack[] = $pendingStoreKey; $pendingStoreKeysStack[] = $pendingStoreKey;
$expectingConditionMap[$pendingStoreKey] = true; $expectingConditionMap[$pendingStoreKey] = true;
$parenthesisDepthMap[$pendingStoreKey] = 0; $parenthesisDepthMap[$pendingStoreKey] = 0;
} else { // this is not a if but we good deeper } else { // this is not an if but we go deeper
if (!empty($pendingStoreKey) && array_key_exists($pendingStoreKey, $parenthesisDepthMap)) { if (!empty($pendingStoreKey) && array_key_exists($pendingStoreKey, $parenthesisDepthMap)) {
$parenthesisDepthMap[$pendingStoreKey] += 1; ++$parenthesisDepthMap[$pendingStoreKey];
} }
} }
$stack->push('Function', $valToUpper, null, $currentCondition, $currentOnlyIf, $currentOnlyIfNot); $stack->push('Function', $valToUpper, null, $currentCondition, $currentOnlyIf, $currentOnlyIfNot);
// tests if the function is closed right after opening // tests if the function is closed right after opening
$ax = preg_match('/^\s*(\s*\))/ui', substr($formula, $index + $length), $amatch); $ax = preg_match('/^\s*\)/u', substr($formula, $index + $length));
if ($ax) { if ($ax) {
$stack->push('Operand Count for Function ' . $valToUpper . ')', 0, null, $currentCondition, $currentOnlyIf, $currentOnlyIfNot); $stack->push('Operand Count for Function ' . $valToUpper . ')', 0, null, $currentCondition, $currentOnlyIf, $currentOnlyIfNot);
$expectingOperator = true; $expectingOperator = true;
@ -3649,9 +3655,6 @@ class Calculation
$expectingOperator = false; $expectingOperator = false;
} }
$stack->push('Brace', '('); $stack->push('Brace', '(');
} else { // it's a var w/ implicit multiplication
$output[] = ['type' => 'Value', 'value' => $matches[1], 'reference' => null];
}
} elseif (preg_match('/^' . self::CALCULATION_REGEXP_CELLREF . '$/i', $val, $matches)) { } elseif (preg_match('/^' . self::CALCULATION_REGEXP_CELLREF . '$/i', $val, $matches)) {
// Watch for this case-change when modifying to allow cell references in different worksheets... // Watch for this case-change when modifying to allow cell references in different worksheets...
// Should only be applied to the actual cell column, not the worksheet name // Should only be applied to the actual cell column, not the worksheet name
@ -3814,11 +3817,10 @@ class Calculation
/** /**
* @param mixed $tokens * @param mixed $tokens
* @param null|string $cellID * @param null|string $cellID
* @param null|Cell $pCell
* *
* @return bool * @return bool
*/ */
private function processTokenStack($tokens, $cellID = null, Cell $pCell = null) private function processTokenStack($tokens, $cellID = null, ?Cell $pCell = null)
{ {
if ($tokens == false) { if ($tokens == false) {
return false; return false;
@ -4357,7 +4359,6 @@ class Calculation
* @param mixed $operand1 * @param mixed $operand1
* @param mixed $operand2 * @param mixed $operand2
* @param string $operation * @param string $operation
* @param Stack $stack
* @param bool $recursingArrays * @param bool $recursingArrays
* *
* @return mixed * @return mixed
@ -4579,7 +4580,7 @@ class Calculation
break; break;
// Power // Power
case '^': case '^':
$result = pow($operand1, $operand2); $result = $operand1 ** $operand2;
break; break;
} }
@ -4616,7 +4617,7 @@ class Calculation
* *
* @return mixed Array of values in range if range contains more than one element. Otherwise, a single value is returned. * @return mixed Array of values in range if range contains more than one element. Otherwise, a single value is returned.
*/ */
public function extractCellRange(&$pRange = 'A1', Worksheet $pSheet = null, $resetLog = true) public function extractCellRange(&$pRange = 'A1', ?Worksheet $pSheet = null, $resetLog = true)
{ {
// Return value // Return value
$returnValue = []; $returnValue = [];
@ -4669,7 +4670,7 @@ class Calculation
* *
* @return mixed Array of values in range if range contains more than one element. Otherwise, a single value is returned. * @return mixed Array of values in range if range contains more than one element. Otherwise, a single value is returned.
*/ */
public function extractNamedRange(&$pRange = 'A1', Worksheet $pSheet = null, $resetLog = true) public function extractNamedRange(&$pRange = 'A1', ?Worksheet $pSheet = null, $resetLog = true)
{ {
// Return value // Return value
$returnValue = []; $returnValue = [];
@ -4769,21 +4770,19 @@ class Calculation
/** /**
* Add cell reference if needed while making sure that it is the last argument. * Add cell reference if needed while making sure that it is the last argument.
* *
* @param array $args
* @param bool $passCellReference * @param bool $passCellReference
* @param array|string $functionCall * @param array|string $functionCall
* @param null|Cell $pCell
* *
* @return array * @return array
*/ */
private function addCellReference(array $args, $passCellReference, $functionCall, Cell $pCell = null) private function addCellReference(array $args, $passCellReference, $functionCall, ?Cell $pCell = null)
{ {
if ($passCellReference) { if ($passCellReference) {
if (is_array($functionCall)) { if (is_array($functionCall)) {
$className = $functionCall[0]; $className = $functionCall[0];
$methodName = $functionCall[1]; $methodName = $functionCall[1];
$reflectionMethod = new \ReflectionMethod($className, $methodName); $reflectionMethod = new ReflectionMethod($className, $methodName);
$argumentCount = count($reflectionMethod->getParameters()); $argumentCount = count($reflectionMethod->getParameters());
while (count($args) < $argumentCount - 1) { while (count($args) < $argumentCount - 1) {
$args[] = null; $args[] = null;

24
src/PhpSpreadsheet/Calculation/Database.php
View File

@ -130,8 +130,6 @@ class Database
* Excel Function: * Excel Function:
* DAVERAGE(database,field,criteria) * DAVERAGE(database,field,criteria)
* *
* @category Database Functions
*
* @param mixed[] $database The range of cells that makes up the list or database. * @param mixed[] $database The range of cells that makes up the list or database.
* A database is a list of related data in which rows of related * A database is a list of related data in which rows of related
* information are records, and columns of data are fields. The * information are records, and columns of data are fields. The
@ -174,8 +172,6 @@ class Database
* Excel Function: * Excel Function:
* DAVERAGE(database,field,criteria) * DAVERAGE(database,field,criteria)
* *
* @category Database Functions
*
* @param mixed[] $database The range of cells that makes up the list or database. * @param mixed[] $database The range of cells that makes up the list or database.
* A database is a list of related data in which rows of related * A database is a list of related data in which rows of related
* information are records, and columns of data are fields. The * information are records, and columns of data are fields. The
@ -217,8 +213,6 @@ class Database
* Excel Function: * Excel Function:
* DCOUNTA(database,[field],criteria) * DCOUNTA(database,[field],criteria)
* *
* @category Database Functions
*
* @param mixed[] $database The range of cells that makes up the list or database. * @param mixed[] $database The range of cells that makes up the list or database.
* A database is a list of related data in which rows of related * A database is a list of related data in which rows of related
* information are records, and columns of data are fields. The * information are records, and columns of data are fields. The
@ -269,8 +263,6 @@ class Database
* Excel Function: * Excel Function:
* DGET(database,field,criteria) * DGET(database,field,criteria)
* *
* @category Database Functions
*
* @param mixed[] $database The range of cells that makes up the list or database. * @param mixed[] $database The range of cells that makes up the list or database.
* A database is a list of related data in which rows of related * A database is a list of related data in which rows of related
* information are records, and columns of data are fields. The * information are records, and columns of data are fields. The
@ -313,8 +305,6 @@ class Database
* Excel Function: * Excel Function:
* DMAX(database,field,criteria) * DMAX(database,field,criteria)
* *
* @category Database Functions
*
* @param mixed[] $database The range of cells that makes up the list or database. * @param mixed[] $database The range of cells that makes up the list or database.
* A database is a list of related data in which rows of related * A database is a list of related data in which rows of related
* information are records, and columns of data are fields. The * information are records, and columns of data are fields. The
@ -354,8 +344,6 @@ class Database
* Excel Function: * Excel Function:
* DMIN(database,field,criteria) * DMIN(database,field,criteria)
* *
* @category Database Functions
*
* @param mixed[] $database The range of cells that makes up the list or database. * @param mixed[] $database The range of cells that makes up the list or database.
* A database is a list of related data in which rows of related * A database is a list of related data in which rows of related
* information are records, and columns of data are fields. The * information are records, and columns of data are fields. The
@ -394,8 +382,6 @@ class Database
* Excel Function: * Excel Function:
* DPRODUCT(database,field,criteria) * DPRODUCT(database,field,criteria)
* *
* @category Database Functions
*
* @param mixed[] $database The range of cells that makes up the list or database. * @param mixed[] $database The range of cells that makes up the list or database.
* A database is a list of related data in which rows of related * A database is a list of related data in which rows of related
* information are records, and columns of data are fields. The * information are records, and columns of data are fields. The
@ -435,8 +421,6 @@ class Database
* Excel Function: * Excel Function:
* DSTDEV(database,field,criteria) * DSTDEV(database,field,criteria)
* *
* @category Database Functions
*
* @param mixed[] $database The range of cells that makes up the list or database. * @param mixed[] $database The range of cells that makes up the list or database.
* A database is a list of related data in which rows of related * A database is a list of related data in which rows of related
* information are records, and columns of data are fields. The * information are records, and columns of data are fields. The
@ -476,8 +460,6 @@ class Database
* Excel Function: * Excel Function:
* DSTDEVP(database,field,criteria) * DSTDEVP(database,field,criteria)
* *
* @category Database Functions
*
* @param mixed[] $database The range of cells that makes up the list or database. * @param mixed[] $database The range of cells that makes up the list or database.
* A database is a list of related data in which rows of related * A database is a list of related data in which rows of related
* information are records, and columns of data are fields. The * information are records, and columns of data are fields. The
@ -516,8 +498,6 @@ class Database
* Excel Function: * Excel Function:
* DSUM(database,field,criteria) * DSUM(database,field,criteria)
* *
* @category Database Functions
*
* @param mixed[] $database The range of cells that makes up the list or database. * @param mixed[] $database The range of cells that makes up the list or database.
* A database is a list of related data in which rows of related * A database is a list of related data in which rows of related
* information are records, and columns of data are fields. The * information are records, and columns of data are fields. The
@ -557,8 +537,6 @@ class Database
* Excel Function: * Excel Function:
* DVAR(database,field,criteria) * DVAR(database,field,criteria)
* *
* @category Database Functions
*
* @param mixed[] $database The range of cells that makes up the list or database. * @param mixed[] $database The range of cells that makes up the list or database.
* A database is a list of related data in which rows of related * A database is a list of related data in which rows of related
* information are records, and columns of data are fields. The * information are records, and columns of data are fields. The
@ -598,8 +576,6 @@ class Database
* Excel Function: * Excel Function:
* DVARP(database,field,criteria) * DVARP(database,field,criteria)
* *
* @category Database Functions
*
* @param mixed[] $database The range of cells that makes up the list or database. * @param mixed[] $database The range of cells that makes up the list or database.
* A database is a list of related data in which rows of related * A database is a list of related data in which rows of related
* information are records, and columns of data are fields. The * information are records, and columns of data are fields. The

36
src/PhpSpreadsheet/Calculation/DateTime.php
View File

@ -2,6 +2,8 @@
namespace PhpOffice\PhpSpreadsheet\Calculation; namespace PhpOffice\PhpSpreadsheet\Calculation;
use DateTimeImmutable;
use DateTimeInterface;
use PhpOffice\PhpSpreadsheet\Shared\Date; use PhpOffice\PhpSpreadsheet\Shared\Date;
use PhpOffice\PhpSpreadsheet\Shared\StringHelper; use PhpOffice\PhpSpreadsheet\Shared\StringHelper;
@ -59,18 +61,14 @@ class DateTime
/** /**
* getDateValue. * getDateValue.
* *
* @param string $dateValue * @param mixed $dateValue
* *
* @return mixed Excel date/time serial value, or string if error * @return mixed Excel date/time serial value, or string if error
*/ */
public static function getDateValue($dateValue) public static function getDateValue($dateValue)
{ {
if (!is_numeric($dateValue)) { if (!is_numeric($dateValue)) {
if ((is_string($dateValue)) && if ((is_object($dateValue)) && ($dateValue instanceof DateTimeInterface)) {
(Functions::getCompatibilityMode() == Functions::COMPATIBILITY_GNUMERIC)) {
return Functions::VALUE();
}
if ((is_object($dateValue)) && ($dateValue instanceof \DateTimeInterface)) {
$dateValue = Date::PHPToExcel($dateValue); $dateValue = Date::PHPToExcel($dateValue);
} else { } else {
$saveReturnDateType = Functions::getReturnDateType(); $saveReturnDateType = Functions::getReturnDateType();
@ -141,8 +139,6 @@ class DateTime
* Excel Function: * Excel Function:
* NOW() * NOW()
* *
* @category Date/Time Functions
*
* @return mixed Excel date/time serial value, PHP date/time serial value or PHP date/time object, * @return mixed Excel date/time serial value, PHP date/time serial value or PHP date/time object,
* depending on the value of the ReturnDateType flag * depending on the value of the ReturnDateType flag
*/ */
@ -184,8 +180,6 @@ class DateTime
* Excel Function: * Excel Function:
* TODAY() * TODAY()
* *
* @category Date/Time Functions
*
* @return mixed Excel date/time serial value, PHP date/time serial value or PHP date/time object, * @return mixed Excel date/time serial value, PHP date/time serial value or PHP date/time object,
* depending on the value of the ReturnDateType flag * depending on the value of the ReturnDateType flag
*/ */
@ -229,8 +223,6 @@ class DateTime
* A Month name or abbreviation (English only at this point) such as 'January' or 'Jan' will still be accepted, * A Month name or abbreviation (English only at this point) such as 'January' or 'Jan' will still be accepted,
* as will a day value with a suffix (e.g. '21st' rather than simply 21); again only English language. * as will a day value with a suffix (e.g. '21st' rather than simply 21); again only English language.
* *
* @category Date/Time Functions
*
* @param int $year The value of the year argument can include one to four digits. * @param int $year The value of the year argument can include one to four digits.
* Excel interprets the year argument according to the configured * Excel interprets the year argument according to the configured
* date system: 1900 or 1904. * date system: 1900 or 1904.
@ -343,8 +335,6 @@ class DateTime
* Excel Function: * Excel Function:
* TIME(hour,minute,second) * TIME(hour,minute,second)
* *
* @category Date/Time Functions
*
* @param int $hour A number from 0 (zero) to 32767 representing the hour. * @param int $hour A number from 0 (zero) to 32767 representing the hour.
* Any value greater than 23 will be divided by 24 and the remainder * Any value greater than 23 will be divided by 24 and the remainder
* will be treated as the hour value. For example, TIME(27,0,0) = * will be treated as the hour value. For example, TIME(27,0,0) =
@ -456,8 +446,6 @@ class DateTime
* Excel Function: * Excel Function:
* DATEVALUE(dateValue) * DATEVALUE(dateValue)
* *
* @category Date/Time Functions
*
* @param string $dateValue Text that represents a date in a Microsoft Excel date format. * @param string $dateValue Text that represents a date in a Microsoft Excel date format.
* For example, "1/30/2008" or "30-Jan-2008" are text strings within * For example, "1/30/2008" or "30-Jan-2008" are text strings within
* quotation marks that represent dates. Using the default date * quotation marks that represent dates. Using the default date
@ -591,8 +579,6 @@ class DateTime
* Excel Function: * Excel Function:
* TIMEVALUE(timeValue) * TIMEVALUE(timeValue)
* *
* @category Date/Time Functions
*
* @param string $timeValue A text string that represents a time in any one of the Microsoft * @param string $timeValue A text string that represents a time in any one of the Microsoft
* Excel time formats; for example, "6:45 PM" and "18:45" text strings * Excel time formats; for example, "6:45 PM" and "18:45" text strings
* within quotation marks that represent time. * within quotation marks that represent time.
@ -770,11 +756,9 @@ class DateTime
* Excel Function: * Excel Function:
* DAYS(endDate, startDate) * DAYS(endDate, startDate)
* *
* @category Date/Time Functions * @param DateTimeImmutable|float|int|string $endDate Excel date serial value (float),
*
* @param \DateTimeImmutable|float|int|string $endDate Excel date serial value (float),
* PHP date timestamp (integer), PHP DateTime object, or a standard date string * PHP date timestamp (integer), PHP DateTime object, or a standard date string
* @param \DateTimeImmutable|float|int|string $startDate Excel date serial value (float), * @param DateTimeImmutable|float|int|string $startDate Excel date serial value (float),
* PHP date timestamp (integer), PHP DateTime object, or a standard date string * PHP date timestamp (integer), PHP DateTime object, or a standard date string
* *
* @return int|string Number of days between start date and end date or an error * @return int|string Number of days between start date and end date or an error
@ -818,8 +802,6 @@ class DateTime
* Excel Function: * Excel Function:
* DAYS360(startDate,endDate[,method]) * DAYS360(startDate,endDate[,method])
* *
* @category Date/Time Functions
*
* @param mixed $startDate Excel date serial value (float), PHP date timestamp (integer), * @param mixed $startDate Excel date serial value (float), PHP date timestamp (integer),
* PHP DateTime object, or a standard date string * PHP DateTime object, or a standard date string
* @param mixed $endDate Excel date serial value (float), PHP date timestamp (integer), * @param mixed $endDate Excel date serial value (float), PHP date timestamp (integer),
@ -881,8 +863,6 @@ class DateTime
* See https://lists.oasis-open.org/archives/office-formula/200806/msg00039.html * See https://lists.oasis-open.org/archives/office-formula/200806/msg00039.html
* for description of algorithm used in Excel * for description of algorithm used in Excel
* *
* @category Date/Time Functions
*
* @param mixed $startDate Excel date serial value (float), PHP date timestamp (integer), * @param mixed $startDate Excel date serial value (float), PHP date timestamp (integer),
* PHP DateTime object, or a standard date string * PHP DateTime object, or a standard date string
* @param mixed $endDate Excel date serial value (float), PHP date timestamp (integer), * @param mixed $endDate Excel date serial value (float), PHP date timestamp (integer),
@ -983,8 +963,6 @@ class DateTime
* Excel Function: * Excel Function:
* NETWORKDAYS(startDate,endDate[,holidays[,holiday[,...]]]) * NETWORKDAYS(startDate,endDate[,holidays[,holiday[,...]]])
* *
* @category Date/Time Functions
*
* @param mixed $startDate Excel date serial value (float), PHP date timestamp (integer), * @param mixed $startDate Excel date serial value (float), PHP date timestamp (integer),
* PHP DateTime object, or a standard date string * PHP DateTime object, or a standard date string
* @param mixed $endDate Excel date serial value (float), PHP date timestamp (integer), * @param mixed $endDate Excel date serial value (float), PHP date timestamp (integer),
@ -1063,8 +1041,6 @@ class DateTime
* Excel Function: * Excel Function:
* WORKDAY(startDate,endDays[,holidays[,holiday[,...]]]) * WORKDAY(startDate,endDays[,holidays[,holiday[,...]]])
* *
* @category Date/Time Functions
*
* @param mixed $startDate Excel date serial value (float), PHP date timestamp (integer), * @param mixed $startDate Excel date serial value (float), PHP date timestamp (integer),
* PHP DateTime object, or a standard date string * PHP DateTime object, or a standard date string
* @param int $endDays The number of nonweekend and nonholiday days before or after * @param int $endDays The number of nonweekend and nonholiday days before or after

4
src/PhpSpreadsheet/Calculation/Engine/CyclicReferenceStack.php
View File

@ -26,7 +26,7 @@ class CyclicReferenceStack
* *
* @param mixed $value * @param mixed $value
*/ */
public function push($value) public function push($value): void
{ {
$this->stack[$value] = $value; $this->stack[$value] = $value;
} }
@ -56,7 +56,7 @@ class CyclicReferenceStack
/** /**
* Clear the stack. * Clear the stack.
*/ */
public function clear() public function clear(): void
{ {
$this->stack = []; $this->stack = [];
} }

12
src/PhpSpreadsheet/Calculation/Engine/Logger.php
View File

@ -39,8 +39,6 @@ class Logger
/** /**
* Instantiate a Calculation engine logger. * Instantiate a Calculation engine logger.
*
* @param CyclicReferenceStack $stack
*/ */
public function __construct(CyclicReferenceStack $stack) public function __construct(CyclicReferenceStack $stack)
{ {
@ -52,7 +50,7 @@ class Logger
* *
* @param bool $pValue * @param bool $pValue
*/ */
public function setWriteDebugLog($pValue) public function setWriteDebugLog($pValue): void
{ {
$this->writeDebugLog = $pValue; $this->writeDebugLog = $pValue;
} }
@ -72,7 +70,7 @@ class Logger
* *
* @param bool $pValue * @param bool $pValue
*/ */
public function setEchoDebugLog($pValue) public function setEchoDebugLog($pValue): void
{ {
$this->echoDebugLog = $pValue; $this->echoDebugLog = $pValue;
} }
@ -90,11 +88,11 @@ class Logger
/** /**
* Write an entry to the calculation engine debug log. * Write an entry to the calculation engine debug log.
*/ */
public function writeDebugLog(...$args) public function writeDebugLog(...$args): void
{ {
// Only write the debug log if logging is enabled // Only write the debug log if logging is enabled
if ($this->writeDebugLog) { if ($this->writeDebugLog) {
$message = implode($args); $message = implode('', $args);
$cellReference = implode(' -> ', $this->cellStack->showStack()); $cellReference = implode(' -> ', $this->cellStack->showStack());
if ($this->echoDebugLog) { if ($this->echoDebugLog) {
echo $cellReference, echo $cellReference,
@ -111,7 +109,7 @@ class Logger
/** /**
* Clear the calculation engine debug log. * Clear the calculation engine debug log.
*/ */
public function clearLog() public function clearLog(): void
{ {
$this->debugLog = []; $this->debugLog = [];
} }

58
src/PhpSpreadsheet/Calculation/Engineering.php
View File

@ -776,8 +776,6 @@ class Engineering
* Excel Function: * Excel Function:
* BESSELI(x,ord) * BESSELI(x,ord)
* *
* @category Engineering Functions
*
* @param float $x The value at which to evaluate the function. * @param float $x The value at which to evaluate the function.
* If x is nonnumeric, BESSELI returns the #VALUE! error value. * If x is nonnumeric, BESSELI returns the #VALUE! error value.
* @param int $ord The order of the Bessel function. * @param int $ord The order of the Bessel function.
@ -799,7 +797,7 @@ class Engineering
} }
if (abs($x) <= 30) { if (abs($x) <= 30) {
$fResult = $fTerm = pow($x / 2, $ord) / MathTrig::FACT($ord); $fResult = $fTerm = ($x / 2) ** $ord / MathTrig::FACT($ord);
$ordK = 1; $ordK = 1;
$fSqrX = ($x * $x) / 4; $fSqrX = ($x * $x) / 4;
do { do {
@ -831,8 +829,6 @@ class Engineering
* Excel Function: * Excel Function:
* BESSELJ(x,ord) * BESSELJ(x,ord)
* *
* @category Engineering Functions
*
* @param float $x The value at which to evaluate the function. * @param float $x The value at which to evaluate the function.
* If x is nonnumeric, BESSELJ returns the #VALUE! error value. * If x is nonnumeric, BESSELJ returns the #VALUE! error value.
* @param int $ord The order of the Bessel function. If n is not an integer, it is truncated. * @param int $ord The order of the Bessel function. If n is not an integer, it is truncated.
@ -854,7 +850,7 @@ class Engineering
$fResult = 0; $fResult = 0;
if (abs($x) <= 30) { if (abs($x) <= 30) {
$fResult = $fTerm = pow($x / 2, $ord) / MathTrig::FACT($ord); $fResult = $fTerm = ($x / 2) ** $ord / MathTrig::FACT($ord);
$ordK = 1; $ordK = 1;
$fSqrX = ($x * $x) / -4; $fSqrX = ($x * $x) / -4;
do { do {
@ -924,8 +920,6 @@ class Engineering
* Excel Function: * Excel Function:
* BESSELK(x,ord) * BESSELK(x,ord)
* *
* @category Engineering Functions
*
* @param float $x The value at which to evaluate the function. * @param float $x The value at which to evaluate the function.
* If x is nonnumeric, BESSELK returns the #VALUE! error value. * If x is nonnumeric, BESSELK returns the #VALUE! error value.
* @param int $ord The order of the Bessel function. If n is not an integer, it is truncated. * @param int $ord The order of the Bessel function. If n is not an integer, it is truncated.
@ -1013,8 +1007,6 @@ class Engineering
* Excel Function: * Excel Function:
* BESSELY(x,ord) * BESSELY(x,ord)
* *
* @category Engineering Functions
*
* @param float $x The value at which to evaluate the function. * @param float $x The value at which to evaluate the function.
* If x is nonnumeric, BESSELK returns the #VALUE! error value. * If x is nonnumeric, BESSELK returns the #VALUE! error value.
* @param int $ord The order of the Bessel function. If n is not an integer, it is truncated. * @param int $ord The order of the Bessel function. If n is not an integer, it is truncated.
@ -1067,8 +1059,6 @@ class Engineering
* Excel Function: * Excel Function:
* BIN2DEC(x) * BIN2DEC(x)
* *
* @category Engineering Functions
*
* @param string $x The binary number (as a string) that you want to convert. The number * @param string $x The binary number (as a string) that you want to convert. The number
* cannot contain more than 10 characters (10 bits). The most significant * cannot contain more than 10 characters (10 bits). The most significant
* bit of number is the sign bit. The remaining 9 bits are magnitude bits. * bit of number is the sign bit. The remaining 9 bits are magnitude bits.
@ -1116,8 +1106,6 @@ class Engineering
* Excel Function: * Excel Function:
* BIN2HEX(x[,places]) * BIN2HEX(x[,places])
* *
* @category Engineering Functions
*
* @param string $x The binary number (as a string) that you want to convert. The number * @param string $x The binary number (as a string) that you want to convert. The number
* cannot contain more than 10 characters (10 bits). The most significant * cannot contain more than 10 characters (10 bits). The most significant
* bit of number is the sign bit. The remaining 9 bits are magnitude bits. * bit of number is the sign bit. The remaining 9 bits are magnitude bits.
@ -1172,8 +1160,6 @@ class Engineering
* Excel Function: * Excel Function:
* BIN2OCT(x[,places]) * BIN2OCT(x[,places])
* *
* @category Engineering Functions
*
* @param string $x The binary number (as a string) that you want to convert. The number * @param string $x The binary number (as a string) that you want to convert. The number
* cannot contain more than 10 characters (10 bits). The most significant * cannot contain more than 10 characters (10 bits). The most significant
* bit of number is the sign bit. The remaining 9 bits are magnitude bits. * bit of number is the sign bit. The remaining 9 bits are magnitude bits.
@ -1227,8 +1213,6 @@ class Engineering
* Excel Function: * Excel Function:
* DEC2BIN(x[,places]) * DEC2BIN(x[,places])
* *
* @category Engineering Functions
*
* @param string $x The decimal integer you want to convert. If number is negative, * @param string $x The decimal integer you want to convert. If number is negative,
* valid place values are ignored and DEC2BIN returns a 10-character * valid place values are ignored and DEC2BIN returns a 10-character
* (10-bit) binary number in which the most significant bit is the sign * (10-bit) binary number in which the most significant bit is the sign
@ -1288,8 +1272,6 @@ class Engineering
* Excel Function: * Excel Function:
* DEC2HEX(x[,places]) * DEC2HEX(x[,places])
* *
* @category Engineering Functions
*
* @param string $x The decimal integer you want to convert. If number is negative, * @param string $x The decimal integer you want to convert. If number is negative,
* places is ignored and DEC2HEX returns a 10-character (40-bit) * places is ignored and DEC2HEX returns a 10-character (40-bit)
* hexadecimal number in which the most significant bit is the sign * hexadecimal number in which the most significant bit is the sign
@ -1343,8 +1325,6 @@ class Engineering
* Excel Function: * Excel Function:
* DEC2OCT(x[,places]) * DEC2OCT(x[,places])
* *
* @category Engineering Functions
*
* @param string $x The decimal integer you want to convert. If number is negative, * @param string $x The decimal integer you want to convert. If number is negative,
* places is ignored and DEC2OCT returns a 10-character (30-bit) * places is ignored and DEC2OCT returns a 10-character (30-bit)
* octal number in which the most significant bit is the sign bit. * octal number in which the most significant bit is the sign bit.
@ -1399,8 +1379,6 @@ class Engineering
* Excel Function: * Excel Function:
* HEX2BIN(x[,places]) * HEX2BIN(x[,places])
* *
* @category Engineering Functions
*
* @param string $x the hexadecimal number you want to convert. * @param string $x the hexadecimal number you want to convert.
* Number cannot contain more than 10 characters. * Number cannot contain more than 10 characters.
* The most significant bit of number is the sign bit (40th bit from the right). * The most significant bit of number is the sign bit (40th bit from the right).
@ -1444,8 +1422,6 @@ class Engineering
* Excel Function: * Excel Function:
* HEX2DEC(x) * HEX2DEC(x)
* *
* @category Engineering Functions
*
* @param string $x The hexadecimal number you want to convert. This number cannot * @param string $x The hexadecimal number you want to convert. This number cannot
* contain more than 10 characters (40 bits). The most significant * contain more than 10 characters (40 bits). The most significant
* bit of number is the sign bit. The remaining 39 bits are magnitude * bit of number is the sign bit. The remaining 39 bits are magnitude
@ -1495,8 +1471,6 @@ class Engineering
* Excel Function: * Excel Function:
* HEX2OCT(x[,places]) * HEX2OCT(x[,places])
* *
* @category Engineering Functions
*
* @param string $x The hexadecimal number you want to convert. Number cannot * @param string $x The hexadecimal number you want to convert. Number cannot
* contain more than 10 characters. The most significant bit of * contain more than 10 characters. The most significant bit of
* number is the sign bit. The remaining 39 bits are magnitude * number is the sign bit. The remaining 39 bits are magnitude
@ -1549,8 +1523,6 @@ class Engineering
* Excel Function: * Excel Function:
* OCT2BIN(x[,places]) * OCT2BIN(x[,places])
* *
* @category Engineering Functions
*
* @param string $x The octal number you want to convert. Number may not * @param string $x The octal number you want to convert. Number may not
* contain more than 10 characters. The most significant * contain more than 10 characters. The most significant
* bit of number is the sign bit. The remaining 29 bits * bit of number is the sign bit. The remaining 29 bits
@ -1600,8 +1572,6 @@ class Engineering
* Excel Function: * Excel Function:
* OCT2DEC(x) * OCT2DEC(x)
* *
* @category Engineering Functions
*
* @param string $x The octal number you want to convert. Number may not contain * @param string $x The octal number you want to convert. Number may not contain
* more than 10 octal characters (30 bits). The most significant * more than 10 octal characters (30 bits). The most significant
* bit of number is the sign bit. The remaining 29 bits are * bit of number is the sign bit. The remaining 29 bits are
@ -1646,8 +1616,6 @@ class Engineering
* Excel Function: * Excel Function:
* OCT2HEX(x[,places]) * OCT2HEX(x[,places])
* *
* @category Engineering Functions
*
* @param string $x The octal number you want to convert. Number may not contain * @param string $x The octal number you want to convert. Number may not contain
* more than 10 octal characters (30 bits). The most significant * more than 10 octal characters (30 bits). The most significant
* bit of number is the sign bit. The remaining 29 bits are * bit of number is the sign bit. The remaining 29 bits are
@ -1693,8 +1661,6 @@ class Engineering
* Excel Function: * Excel Function:
* COMPLEX(realNumber,imaginary[,suffix]) * COMPLEX(realNumber,imaginary[,suffix])
* *
* @category Engineering Functions
*
* @param float $realNumber the real coefficient of the complex number * @param float $realNumber the real coefficient of the complex number
* @param float $imaginary the imaginary coefficient of the complex number * @param float $imaginary the imaginary coefficient of the complex number
* @param string $suffix The suffix for the imaginary component of the complex number. * @param string $suffix The suffix for the imaginary component of the complex number.
@ -1727,8 +1693,6 @@ class Engineering
* Excel Function: * Excel Function:
* IMAGINARY(complexNumber) * IMAGINARY(complexNumber)
* *
* @category Engineering Functions
*
* @param string $complexNumber the complex number for which you want the imaginary * @param string $complexNumber the complex number for which you want the imaginary
* coefficient * coefficient
* *
@ -1749,8 +1713,6 @@ class Engineering
* Excel Function: * Excel Function:
* IMREAL(complexNumber) * IMREAL(complexNumber)
* *
* @category Engineering Functions
*
* @param string $complexNumber the complex number for which you want the real coefficient * @param string $complexNumber the complex number for which you want the real coefficient
* *
* @return float * @return float
@ -2346,8 +2308,6 @@ class Engineering
* *
* @param mixed $value * @param mixed $value
* *
* @throws Exception
*
* @return int * @return int
*/ */
private static function validateBitwiseArgument($value) private static function validateBitwiseArgument($value)
@ -2359,7 +2319,7 @@ class Engineering
} elseif (is_numeric($value)) { } elseif (is_numeric($value)) {
if ($value == (int) ($value)) { if ($value == (int) ($value)) {
$value = (int) ($value); $value = (int) ($value);
if (($value > pow(2, 48) - 1) || ($value < 0)) { if (($value > 2 ** 48 - 1) || ($value < 0)) {
throw new Exception(Functions::NAN()); throw new Exception(Functions::NAN());
} }
@ -2380,8 +2340,6 @@ class Engineering
* Excel Function: * Excel Function:
* BITAND(number1, number2) * BITAND(number1, number2)
* *
* @category Engineering Functions
*
* @param int $number1 * @param int $number1
* @param int $number2 * @param int $number2
* *
@ -2407,8 +2365,6 @@ class Engineering
* Excel Function: * Excel Function:
* BITOR(number1, number2) * BITOR(number1, number2)
* *
* @category Engineering Functions
*
* @param int $number1 * @param int $number1
* @param int $number2 * @param int $number2
* *
@ -2434,8 +2390,6 @@ class Engineering
* Excel Function: * Excel Function:
* BITXOR(number1, number2) * BITXOR(number1, number2)
* *
* @category Engineering Functions
*
* @param int $number1 * @param int $number1
* @param int $number2 * @param int $number2
* *
@ -2461,8 +2415,6 @@ class Engineering
* Excel Function: * Excel Function:
* BITLSHIFT(number, shift_amount) * BITLSHIFT(number, shift_amount)
* *
* @category Engineering Functions
*
* @param int $number * @param int $number
* @param int $shiftAmount * @param int $shiftAmount
* *
@ -2479,7 +2431,7 @@ class Engineering
$shiftAmount = Functions::flattenSingleValue($shiftAmount); $shiftAmount = Functions::flattenSingleValue($shiftAmount);
$result = $number << $shiftAmount; $result = $number << $shiftAmount;
if ($result > pow(2, 48) - 1) { if ($result > 2 ** 48 - 1) {
return Functions::NAN(); return Functions::NAN();
} }
@ -2494,8 +2446,6 @@ class Engineering
* Excel Function: * Excel Function:
* BITRSHIFT(number, shift_amount) * BITRSHIFT(number, shift_amount)
* *
* @category Engineering Functions
*
* @param int $number * @param int $number
* @param int $shiftAmount * @param int $shiftAmount
* *

2
src/PhpSpreadsheet/Calculation/Exception.php
View File

@ -15,7 +15,7 @@ class Exception extends PhpSpreadsheetException
* @param mixed $line * @param mixed $line
* @param mixed $context * @param mixed $context
*/ */
public static function errorHandlerCallback($code, $string, $file, $line, $context) public static function errorHandlerCallback($code, $string, $file, $line, $context): void
{ {
$e = new self($string, $code); $e = new self($string, $code);
$e->line = $line; $e->line = $line;

438
src/PhpSpreadsheet/Calculation/Financial.php
View File

@ -6,7 +6,7 @@ use PhpOffice\PhpSpreadsheet\Shared\Date;
class Financial class Financial
{ {
const FINANCIAL_MAX_ITERATIONS = 32; const FINANCIAL_MAX_ITERATIONS = 128;
const FINANCIAL_PRECISION = 1.0e-08; const FINANCIAL_PRECISION = 1.0e-08;
@ -50,10 +50,6 @@ class Financial
if (($frequency == 1) || ($frequency == 2) || ($frequency == 4)) { if (($frequency == 1) || ($frequency == 2) || ($frequency == 4)) {
return true; return true;
} }
if ((Functions::getCompatibilityMode() == Functions::COMPATIBILITY_GNUMERIC) &&
(($frequency == 6) || ($frequency == 12))) {
return true;
}
return false; return false;
} }
@ -118,8 +114,6 @@ class Financial
* Excel Function: * Excel Function:
* ACCRINT(issue,firstinterest,settlement,rate,par,frequency[,basis]) * ACCRINT(issue,firstinterest,settlement,rate,par,frequency[,basis])
* *
* @category Financial Functions
*
* @param mixed $issue the security's issue date * @param mixed $issue the security's issue date
* @param mixed $firstinterest the security's first interest date * @param mixed $firstinterest the security's first interest date
* @param mixed $settlement The security's settlement date. * @param mixed $settlement The security's settlement date.
@ -133,10 +127,6 @@ class Financial
* 1 Annual * 1 Annual
* 2 Semi-Annual * 2 Semi-Annual
* 4 Quarterly * 4 Quarterly
* If working in Gnumeric Mode, the following frequency options are
* also available
* 6 Bimonthly
* 12 Monthly
* @param int $basis The type of day count to use. * @param int $basis The type of day count to use.
* 0 or omitted US (NASD) 30/360 * 0 or omitted US (NASD) 30/360
* 1 Actual/actual * 1 Actual/actual
@ -183,8 +173,6 @@ class Financial
* Excel Function: * Excel Function:
* ACCRINTM(issue,settlement,rate[,par[,basis]]) * ACCRINTM(issue,settlement,rate[,par[,basis]])
* *
* @category Financial Functions
*
* @param mixed $issue The security's issue date * @param mixed $issue The security's issue date
* @param mixed $settlement The security's settlement (or maturity) date * @param mixed $settlement The security's settlement (or maturity) date
* @param float $rate The security's annual coupon rate * @param float $rate The security's annual coupon rate
@ -241,8 +229,6 @@ class Financial
* Excel Function: * Excel Function:
* AMORDEGRC(cost,purchased,firstPeriod,salvage,period,rate[,basis]) * AMORDEGRC(cost,purchased,firstPeriod,salvage,period,rate[,basis])
* *
* @category Financial Functions
*
* @param float $cost The cost of the asset * @param float $cost The cost of the asset
* @param mixed $purchased Date of the purchase of the asset * @param mixed $purchased Date of the purchase of the asset
* @param mixed $firstPeriod Date of the end of the first period * @param mixed $firstPeriod Date of the end of the first period
@ -319,8 +305,6 @@ class Financial
* Excel Function: * Excel Function:
* AMORLINC(cost,purchased,firstPeriod,salvage,period,rate[,basis]) * AMORLINC(cost,purchased,firstPeriod,salvage,period,rate[,basis])
* *
* @category Financial Functions
*
* @param float $cost The cost of the asset * @param float $cost The cost of the asset
* @param mixed $purchased Date of the purchase of the asset * @param mixed $purchased Date of the purchase of the asset
* @param mixed $firstPeriod Date of the end of the first period * @param mixed $firstPeriod Date of the end of the first period
@ -378,8 +362,6 @@ class Financial
* Excel Function: * Excel Function:
* COUPDAYBS(settlement,maturity,frequency[,basis]) * COUPDAYBS(settlement,maturity,frequency[,basis])
* *
* @category Financial Functions
*
* @param mixed $settlement The security's settlement date. * @param mixed $settlement The security's settlement date.
* The security settlement date is the date after the issue * The security settlement date is the date after the issue
* date when the security is traded to the buyer. * date when the security is traded to the buyer.
@ -390,10 +372,6 @@ class Financial
* 1 Annual * 1 Annual
* 2 Semi-Annual * 2 Semi-Annual
* 4 Quarterly * 4 Quarterly
* If working in Gnumeric Mode, the following frequency options are
* also available
* 6 Bimonthly
* 12 Monthly
* @param int $basis The type of day count to use. * @param int $basis The type of day count to use.
* 0 or omitted US (NASD) 30/360 * 0 or omitted US (NASD) 30/360
* 1 Actual/actual * 1 Actual/actual
@ -426,6 +404,10 @@ class Financial
$daysPerYear = self::daysPerYear(DateTime::YEAR($settlement), $basis); $daysPerYear = self::daysPerYear(DateTime::YEAR($settlement), $basis);
$prev = self::couponFirstPeriodDate($settlement, $maturity, $frequency, false); $prev = self::couponFirstPeriodDate($settlement, $maturity, $frequency, false);
if ($basis == 1) {
return abs(DateTime::DAYS($prev, $settlement));
}
return DateTime::YEARFRAC($prev, $settlement, $basis) * $daysPerYear; return DateTime::YEARFRAC($prev, $settlement, $basis) * $daysPerYear;
} }
@ -437,8 +419,6 @@ class Financial
* Excel Function: * Excel Function:
* COUPDAYS(settlement,maturity,frequency[,basis]) * COUPDAYS(settlement,maturity,frequency[,basis])
* *
* @category Financial Functions
*
* @param mixed $settlement The security's settlement date. * @param mixed $settlement The security's settlement date.
* The security settlement date is the date after the issue * The security settlement date is the date after the issue
* date when the security is traded to the buyer. * date when the security is traded to the buyer.
@ -449,10 +429,6 @@ class Financial
* 1 Annual * 1 Annual
* 2 Semi-Annual * 2 Semi-Annual
* 4 Quarterly * 4 Quarterly
* If working in Gnumeric Mode, the following frequency options are
* also available
* 6 Bimonthly
* 12 Monthly
* @param int $basis The type of day count to use. * @param int $basis The type of day count to use.
* 0 or omitted US (NASD) 30/360 * 0 or omitted US (NASD) 30/360
* 1 Actual/actual * 1 Actual/actual
@ -511,8 +487,6 @@ class Financial
* Excel Function: * Excel Function:
* COUPDAYSNC(settlement,maturity,frequency[,basis]) * COUPDAYSNC(settlement,maturity,frequency[,basis])
* *
* @category Financial Functions
*
* @param mixed $settlement The security's settlement date. * @param mixed $settlement The security's settlement date.
* The security settlement date is the date after the issue * The security settlement date is the date after the issue
* date when the security is traded to the buyer. * date when the security is traded to the buyer.
@ -523,10 +497,6 @@ class Financial
* 1 Annual * 1 Annual
* 2 Semi-Annual * 2 Semi-Annual
* 4 Quarterly * 4 Quarterly
* If working in Gnumeric Mode, the following frequency options are
* also available
* 6 Bimonthly
* 12 Monthly
* @param int $basis The type of day count to use. * @param int $basis The type of day count to use.
* 0 or omitted US (NASD) 30/360 * 0 or omitted US (NASD) 30/360
* 1 Actual/actual * 1 Actual/actual
@ -570,8 +540,6 @@ class Financial
* Excel Function: * Excel Function:
* COUPNCD(settlement,maturity,frequency[,basis]) * COUPNCD(settlement,maturity,frequency[,basis])
* *
* @category Financial Functions
*
* @param mixed $settlement The security's settlement date. * @param mixed $settlement The security's settlement date.
* The security settlement date is the date after the issue * The security settlement date is the date after the issue
* date when the security is traded to the buyer. * date when the security is traded to the buyer.
@ -582,10 +550,6 @@ class Financial
* 1 Annual * 1 Annual
* 2 Semi-Annual * 2 Semi-Annual
* 4 Quarterly * 4 Quarterly
* If working in Gnumeric Mode, the following frequency options are
* also available
* 6 Bimonthly
* 12 Monthly
* @param int $basis The type of day count to use. * @param int $basis The type of day count to use.
* 0 or omitted US (NASD) 30/360 * 0 or omitted US (NASD) 30/360
* 1 Actual/actual * 1 Actual/actual
@ -628,8 +592,6 @@ class Financial
* Excel Function: * Excel Function:
* COUPNUM(settlement,maturity,frequency[,basis]) * COUPNUM(settlement,maturity,frequency[,basis])
* *
* @category Financial Functions
*
* @param mixed $settlement The security's settlement date. * @param mixed $settlement The security's settlement date.
* The security settlement date is the date after the issue * The security settlement date is the date after the issue
* date when the security is traded to the buyer. * date when the security is traded to the buyer.
@ -640,10 +602,6 @@ class Financial
* 1 Annual * 1 Annual
* 2 Semi-Annual * 2 Semi-Annual
* 4 Quarterly * 4 Quarterly
* If working in Gnumeric Mode, the following frequency options are
* also available
* 6 Bimonthly
* 12 Monthly
* @param int $basis The type of day count to use. * @param int $basis The type of day count to use.
* 0 or omitted US (NASD) 30/360 * 0 or omitted US (NASD) 30/360
* 1 Actual/actual * 1 Actual/actual
@ -673,19 +631,9 @@ class Financial
return Functions::NAN(); return Functions::NAN();
} }
$daysPerYear = self::daysPerYear(DateTime::YEAR($settlement), $basis); $yearsBetweenSettlementAndMaturity = DateTime::YEARFRAC($settlement, $maturity, 0);
$daysBetweenSettlementAndMaturity = DateTime::YEARFRAC($settlement, $maturity, $basis) * $daysPerYear;
switch ($frequency) { return ceil($yearsBetweenSettlementAndMaturity * $frequency);
case 1: // annual payments
case 2: // half-yearly
case 4: // quarterly
case 6: // bimonthly
case 12: // monthly
return ceil($daysBetweenSettlementAndMaturity / $daysPerYear * $frequency);
}
return Functions::VALUE();
} }
/** /**
@ -696,8 +644,6 @@ class Financial
* Excel Function: * Excel Function:
* COUPPCD(settlement,maturity,frequency[,basis]) * COUPPCD(settlement,maturity,frequency[,basis])
* *
* @category Financial Functions
*
* @param mixed $settlement The security's settlement date. * @param mixed $settlement The security's settlement date.
* The security settlement date is the date after the issue * The security settlement date is the date after the issue
* date when the security is traded to the buyer. * date when the security is traded to the buyer.
@ -708,10 +654,6 @@ class Financial
* 1 Annual * 1 Annual
* 2 Semi-Annual * 2 Semi-Annual
* 4 Quarterly * 4 Quarterly
* If working in Gnumeric Mode, the following frequency options are
* also available
* 6 Bimonthly
* 12 Monthly
* @param int $basis The type of day count to use. * @param int $basis The type of day count to use.
* 0 or omitted US (NASD) 30/360 * 0 or omitted US (NASD) 30/360
* 1 Actual/actual * 1 Actual/actual
@ -753,8 +695,6 @@ class Financial
* Excel Function: * Excel Function:
* CUMIPMT(rate,nper,pv,start,end[,type]) * CUMIPMT(rate,nper,pv,start,end[,type])
* *
* @category Financial Functions
*
* @param float $rate The Interest rate * @param float $rate The Interest rate
* @param int $nper The total number of payment periods * @param int $nper The total number of payment periods
* @param float $pv Present Value * @param float $pv Present Value
@ -801,8 +741,6 @@ class Financial
* Excel Function: * Excel Function:
* CUMPRINC(rate,nper,pv,start,end[,type]) * CUMPRINC(rate,nper,pv,start,end[,type])
* *
* @category Financial Functions
*
* @param float $rate The Interest rate * @param float $rate The Interest rate
* @param int $nper The total number of payment periods * @param int $nper The total number of payment periods
* @param float $pv Present Value * @param float $pv Present Value
@ -854,8 +792,6 @@ class Financial
* Excel Function: * Excel Function:
* DB(cost,salvage,life,period[,month]) * DB(cost,salvage,life,period[,month])
* *
* @category Financial Functions
*
* @param float $cost Initial cost of the asset * @param float $cost Initial cost of the asset
* @param float $salvage Value at the end of the depreciation. * @param float $salvage Value at the end of the depreciation.
* (Sometimes called the salvage value of the asset) * (Sometimes called the salvage value of the asset)
@ -889,11 +825,12 @@ class Financial
return Functions::NAN(); return Functions::NAN();
} }
// Set Fixed Depreciation Rate // Set Fixed Depreciation Rate
$fixedDepreciationRate = 1 - pow(($salvage / $cost), (1 / $life)); $fixedDepreciationRate = 1 - ($salvage / $cost) ** (1 / $life);
$fixedDepreciationRate = round($fixedDepreciationRate, 3); $fixedDepreciationRate = round($fixedDepreciationRate, 3);
// Loop through each period calculating the depreciation // Loop through each period calculating the depreciation
$previousDepreciation = 0; $previousDepreciation = 0;
$depreciation = 0;
for ($per = 1; $per <= $period; ++$per) { for ($per = 1; $per <= $period; ++$per) {
if ($per == 1) { if ($per == 1) {
$depreciation = $cost * $fixedDepreciationRate * $month / 12; $depreciation = $cost * $fixedDepreciationRate * $month / 12;
@ -904,9 +841,6 @@ class Financial
} }
$previousDepreciation += $depreciation; $previousDepreciation += $depreciation;
} }
if (Functions::getCompatibilityMode() == Functions::COMPATIBILITY_GNUMERIC) {
$depreciation = round($depreciation, 2);
}
return $depreciation; return $depreciation;
} }
@ -923,8 +857,6 @@ class Financial
* Excel Function: * Excel Function:
* DDB(cost,salvage,life,period[,factor]) * DDB(cost,salvage,life,period[,factor])
* *
* @category Financial Functions
*
* @param float $cost Initial cost of the asset * @param float $cost Initial cost of the asset
* @param float $salvage Value at the end of the depreciation. * @param float $salvage Value at the end of the depreciation.
* (Sometimes called the salvage value of the asset) * (Sometimes called the salvage value of the asset)
@ -957,18 +889,16 @@ class Financial
return Functions::NAN(); return Functions::NAN();
} }
// Set Fixed Depreciation Rate // Set Fixed Depreciation Rate
$fixedDepreciationRate = 1 - pow(($salvage / $cost), (1 / $life)); $fixedDepreciationRate = 1 - ($salvage / $cost) ** (1 / $life);
$fixedDepreciationRate = round($fixedDepreciationRate, 3); $fixedDepreciationRate = round($fixedDepreciationRate, 3);
// Loop through each period calculating the depreciation // Loop through each period calculating the depreciation
$previousDepreciation = 0; $previousDepreciation = 0;
$depreciation = 0;
for ($per = 1; $per <= $period; ++$per) { for ($per = 1; $per <= $period; ++$per) {
$depreciation = min(($cost - $previousDepreciation) * ($factor / $life), ($cost - $salvage - $previousDepreciation)); $depreciation = min(($cost - $previousDepreciation) * ($factor / $life), ($cost - $salvage - $previousDepreciation));
$previousDepreciation += $depreciation; $previousDepreciation += $depreciation;
} }
if (Functions::getCompatibilityMode() == Functions::COMPATIBILITY_GNUMERIC) {
$depreciation = round($depreciation, 2);
}
return $depreciation; return $depreciation;
} }
@ -984,8 +914,6 @@ class Financial
* Excel Function: * Excel Function:
* DISC(settlement,maturity,price,redemption[,basis]) * DISC(settlement,maturity,price,redemption[,basis])
* *
* @category Financial Functions
*
* @param mixed $settlement The security's settlement date. * @param mixed $settlement The security's settlement date.
* The security settlement date is the date after the issue * The security settlement date is the date after the issue
* date when the security is traded to the buyer. * date when the security is traded to the buyer.
@ -1040,8 +968,6 @@ class Financial
* Excel Function: * Excel Function:
* DOLLARDE(fractional_dollar,fraction) * DOLLARDE(fractional_dollar,fraction)
* *
* @category Financial Functions
*
* @param float $fractional_dollar Fractional Dollar * @param float $fractional_dollar Fractional Dollar
* @param int $fraction Fraction * @param int $fraction Fraction
* *
@ -1063,7 +989,7 @@ class Financial
$dollars = floor($fractional_dollar); $dollars = floor($fractional_dollar);
$cents = fmod($fractional_dollar, 1); $cents = fmod($fractional_dollar, 1);
$cents /= $fraction; $cents /= $fraction;
$cents *= pow(10, ceil(log10($fraction))); $cents *= 10 ** ceil(log10($fraction));
return $dollars + $cents; return $dollars + $cents;
} }
@ -1078,8 +1004,6 @@ class Financial
* Excel Function: * Excel Function:
* DOLLARFR(decimal_dollar,fraction) * DOLLARFR(decimal_dollar,fraction)
* *
* @category Financial Functions
*
* @param float $decimal_dollar Decimal Dollar * @param float $decimal_dollar Decimal Dollar
* @param int $fraction Fraction * @param int $fraction Fraction
* *
@ -1101,7 +1025,7 @@ class Financial
$dollars = floor($decimal_dollar); $dollars = floor($decimal_dollar);
$cents = fmod($decimal_dollar, 1); $cents = fmod($decimal_dollar, 1);
$cents *= $fraction; $cents *= $fraction;
$cents *= pow(10, -ceil(log10($fraction))); $cents *= 10 ** (-ceil(log10($fraction)));
return $dollars + $cents; return $dollars + $cents;
} }
@ -1115,8 +1039,6 @@ class Financial
* Excel Function: * Excel Function:
* EFFECT(nominal_rate,npery) * EFFECT(nominal_rate,npery)
* *
* @category Financial Functions
*
* @param float $nominal_rate Nominal interest rate * @param float $nominal_rate Nominal interest rate
* @param int $npery Number of compounding payments per year * @param int $npery Number of compounding payments per year
* *
@ -1132,7 +1054,7 @@ class Financial
return Functions::NAN(); return Functions::NAN();
} }
return pow((1 + $nominal_rate / $npery), $npery) - 1; return (1 + $nominal_rate / $npery) ** $npery - 1;
} }
/** /**
@ -1143,8 +1065,6 @@ class Financial
* Excel Function: * Excel Function:
* FV(rate,nper,pmt[,pv[,type]]) * FV(rate,nper,pmt[,pv[,type]])
* *
* @category Financial Functions
*
* @param float $rate The interest rate per period * @param float $rate The interest rate per period
* @param int $nper Total number of payment periods in an annuity * @param int $nper Total number of payment periods in an annuity
* @param float $pmt The payment made each period: it cannot change over the * @param float $pmt The payment made each period: it cannot change over the
@ -1173,7 +1093,7 @@ class Financial
// Calculate // Calculate
if ($rate !== null && $rate != 0) { if ($rate !== null && $rate != 0) {
return -$pv * pow(1 + $rate, $nper) - $pmt * (1 + $rate * $type) * (pow(1 + $rate, $nper) - 1) / $rate; return -$pv * (1 + $rate) ** $nper - $pmt * (1 + $rate * $type) * ((1 + $rate) ** $nper - 1) / $rate;
} }
return -$pv - $pmt * $nper; return -$pv - $pmt * $nper;
@ -1442,9 +1362,9 @@ class Financial
$npv_pos = $npv_neg = 0.0; $npv_pos = $npv_neg = 0.0;
foreach ($values as $i => $v) { foreach ($values as $i => $v) {
if ($v >= 0) { if ($v >= 0) {
$npv_pos += $v / pow($rr, $i); $npv_pos += $v / $rr ** $i;
} else { } else {
$npv_neg += $v / pow($fr, $i); $npv_neg += $v / $fr ** $i;
} }
} }
@ -1452,8 +1372,8 @@ class Financial
return Functions::VALUE(); return Functions::VALUE();
} }
$mirr = pow((-$npv_pos * pow($rr, $n)) $mirr = ((-$npv_pos * $rr ** $n)
/ ($npv_neg * ($rr)), (1.0 / ($n - 1))) - 1.0; / ($npv_neg * ($rr))) ** (1.0 / ($n - 1)) - 1.0;
return is_finite($mirr) ? $mirr : Functions::VALUE(); return is_finite($mirr) ? $mirr : Functions::VALUE();
} }
@ -1479,7 +1399,7 @@ class Financial
} }
// Calculate // Calculate
return $npery * (pow($effect_rate + 1, 1 / $npery) - 1); return $npery * (($effect_rate + 1) ** (1 / $npery) - 1);
} }
/** /**
@ -1544,7 +1464,7 @@ class Financial
for ($i = 1; $i <= $countArgs; ++$i) { for ($i = 1; $i <= $countArgs; ++$i) {
// Is it a numeric value? // Is it a numeric value?
if (is_numeric($aArgs[$i - 1])) { if (is_numeric($aArgs[$i - 1])) {
$returnValue += $aArgs[$i - 1] / pow(1 + $rate, $i); $returnValue += $aArgs[$i - 1] / (1 + $rate) ** $i;
} }
} }
@ -1607,7 +1527,7 @@ class Financial
// Calculate // Calculate
if ($rate !== null && $rate != 0) { if ($rate !== null && $rate != 0) {
return (-$fv - $pv * pow(1 + $rate, $nper)) / (1 + $rate * $type) / ((pow(1 + $rate, $nper) - 1) / $rate); return (-$fv - $pv * (1 + $rate) ** $nper) / (1 + $rate * $type) / (((1 + $rate) ** $nper - 1) / $rate);
} }
return (-$pv - $fv) / $nper; return (-$pv - $fv) / $nper;
@ -1650,22 +1570,54 @@ class Financial
return $interestAndPrincipal[1]; return $interestAndPrincipal[1];
} }
private static function validatePrice($settlement, $maturity, $rate, $yield, $redemption, $frequency, $basis)
{
if (is_string($settlement)) {
return Functions::VALUE();
}
if (is_string($maturity)) {
return Functions::VALUE();
}
if (!is_numeric($rate)) {
return Functions::VALUE();
}
if (!is_numeric($yield)) {
return Functions::VALUE();
}
if (!is_numeric($redemption)) {
return Functions::VALUE();
}
if (!is_numeric($frequency)) {
return Functions::VALUE();
}
if (!is_numeric($basis)) {
return Functions::VALUE();
}
return '';
}
public static function PRICE($settlement, $maturity, $rate, $yield, $redemption, $frequency, $basis = 0) public static function PRICE($settlement, $maturity, $rate, $yield, $redemption, $frequency, $basis = 0)
{ {
$settlement = Functions::flattenSingleValue($settlement); $settlement = Functions::flattenSingleValue($settlement);
$maturity = Functions::flattenSingleValue($maturity); $maturity = Functions::flattenSingleValue($maturity);
$rate = (float) Functions::flattenSingleValue($rate); $rate = Functions::flattenSingleValue($rate);
$yield = (float) Functions::flattenSingleValue($yield); $yield = Functions::flattenSingleValue($yield);
$redemption = (float) Functions::flattenSingleValue($redemption); $redemption = Functions::flattenSingleValue($redemption);
$frequency = (int) Functions::flattenSingleValue($frequency); $frequency = Functions::flattenSingleValue($frequency);
$basis = ($basis === null) ? 0 : (int) Functions::flattenSingleValue($basis); $basis = Functions::flattenSingleValue($basis);
if (is_string($settlement = DateTime::getDateValue($settlement))) { $settlement = DateTime::getDateValue($settlement);
return Functions::VALUE(); $maturity = DateTime::getDateValue($maturity);
} $rslt = self::validatePrice($settlement, $maturity, $rate, $yield, $redemption, $frequency, $basis);
if (is_string($maturity = DateTime::getDateValue($maturity))) { if ($rslt) {
return Functions::VALUE(); return $rslt;
} }
$rate = (float) $rate;
$yield = (float) $yield;
$redemption = (float) $redemption;
$frequency = (int) $frequency;
$basis = (int) $basis;
if (($settlement > $maturity) || if (($settlement > $maturity) ||
(!self::isValidFrequency($frequency)) || (!self::isValidFrequency($frequency)) ||
@ -1682,9 +1634,9 @@ class Financial
$rfp = 100 * ($rate / $frequency); $rfp = 100 * ($rate / $frequency);
$de = $dsc / $e; $de = $dsc / $e;
$result = $redemption / pow($baseYF, (--$n + $de)); $result = $redemption / $baseYF ** (--$n + $de);
for ($k = 0; $k <= $n; ++$k) { for ($k = 0; $k <= $n; ++$k) {
$result += $rfp / (pow($baseYF, ($k + $de))); $result += $rfp / ($baseYF ** ($k + $de));
} }
$result -= $rfp * ($a / $e); $result -= $rfp * ($a / $e);
@ -1830,7 +1782,7 @@ class Financial
// Calculate // Calculate
if ($rate !== null && $rate != 0) { if ($rate !== null && $rate != 0) {
return (-$pmt * (1 + $rate * $type) * ((pow(1 + $rate, $nper) - 1) / $rate) - $fv) / pow(1 + $rate, $nper); return (-$pmt * (1 + $rate * $type) * (((1 + $rate) ** $nper - 1) / $rate) - $fv) / (1 + $rate) ** $nper;
} }
return -$fv - $pmt * $nper; return -$fv - $pmt * $nper;
@ -1847,8 +1799,6 @@ class Financial
* Excel Function: * Excel Function:
* RATE(nper,pmt,pv[,fv[,type[,guess]]]) * RATE(nper,pmt,pv[,fv[,type[,guess]]])
* *
* @category Financial Functions
*
* @param float $nper The total number of payment periods in an annuity * @param float $nper The total number of payment periods in an annuity
* @param float $pmt The payment made each period and cannot change over the life * @param float $pmt The payment made each period and cannot change over the life
* of the annuity. * of the annuity.
@ -1865,7 +1815,7 @@ class Financial
* @param float $guess Your guess for what the rate will be. * @param float $guess Your guess for what the rate will be.
* If you omit guess, it is assumed to be 10 percent. * If you omit guess, it is assumed to be 10 percent.
* *
* @return float * @return float|string
*/ */
public static function RATE($nper, $pmt, $pv, $fv = 0.0, $type = 0, $guess = 0.1) public static function RATE($nper, $pmt, $pv, $fv = 0.0, $type = 0, $guess = 0.1)
{ {
@ -1877,38 +1827,39 @@ class Financial
$guess = ($guess === null) ? 0.1 : Functions::flattenSingleValue($guess); $guess = ($guess === null) ? 0.1 : Functions::flattenSingleValue($guess);
$rate = $guess; $rate = $guess;
if (abs($rate) < self::FINANCIAL_PRECISION) { // rest of code adapted from python/numpy
$y = $pv * (1 + $nper * $rate) + $pmt * (1 + $rate * $type) * $nper + $fv; $close = false;
} else { $iter = 0;
$f = exp($nper * log(1 + $rate)); while (!$close && $iter < self::FINANCIAL_MAX_ITERATIONS) {
$y = $pv * $f + $pmt * (1 / $rate + $type) * ($f - 1) + $fv; $nextdiff = self::rateNextGuess($rate, $nper, $pmt, $pv, $fv, $type);
if (!is_numeric($nextdiff)) {
break;
} }
$y0 = $pv + $pmt * $nper + $fv; $rate1 = $rate - $nextdiff;
$y1 = $pv * $f + $pmt * (1 / $rate + $type) * ($f - 1) + $fv; $close = abs($rate1 - $rate) < self::FINANCIAL_PRECISION;
++$iter;
// find root by secant method $rate = $rate1;
$i = $x0 = 0.0;
$x1 = $rate;
while ((abs($y0 - $y1) > self::FINANCIAL_PRECISION) && ($i < self::FINANCIAL_MAX_ITERATIONS)) {
$rate = ($y1 * $x0 - $y0 * $x1) / ($y1 - $y0);
$x0 = $x1;
$x1 = $rate;
if (($nper * abs($pmt)) > ($pv - $fv)) {
$x1 = abs($x1);
}
if (abs($rate) < self::FINANCIAL_PRECISION) {
$y = $pv * (1 + $nper * $rate) + $pmt * (1 + $rate * $type) * $nper + $fv;
} else {
$f = exp($nper * log(1 + $rate));
$y = $pv * $f + $pmt * (1 / $rate + $type) * ($f - 1) + $fv;
} }
$y0 = $y1; return $close ? $rate : Functions::NAN();
$y1 = $y;
++$i;
} }
return $rate; private static function rateNextGuess($rate, $nper, $pmt, $pv, $fv, $type)
{
if ($rate == 0) {
return Functions::NAN();
}
$tt1 = ($rate + 1) ** $nper;
$tt2 = ($rate + 1) ** ($nper - 1);
$numerator = $fv + $tt1 * $pv + $pmt * ($tt1 - 1) * ($rate * $type + 1) / $rate;
$denominator = $nper * $tt2 * $pv - $pmt * ($tt1 - 1) * ($rate * $type + 1) / ($rate * $rate)
+ $nper * $pmt * $tt2 * ($rate * $type + 1) / $rate
+ $pmt * ($tt1 - 1) * $type / $rate;
if ($denominator == 0) {
return Functions::NAN();
}
return $numerator / $denominator;
} }
/** /**
@ -1980,7 +1931,7 @@ class Financial
return Functions::NAN(); return Functions::NAN();
} }
return pow($fv / $pv, 1 / $nper) - 1; return ($fv / $pv) ** (1 / $nper) - 1;
} }
/** /**
@ -2183,6 +2134,84 @@ class Financial
return Functions::VALUE(); return Functions::VALUE();
} }
private static function bothNegAndPos($neg, $pos)
{
return $neg && $pos;
}
private static function xirrPart2(&$values)
{
$valCount = count($values);
$foundpos = false;
$foundneg = false;
for ($i = 0; $i < $valCount; ++$i) {
$fld = $values[$i];
if (!is_numeric($fld)) {
return Functions::VALUE();
} elseif ($fld > 0) {
$foundpos = true;
} elseif ($fld < 0) {
$foundneg = true;
}
}
if (!self::bothNegAndPos($foundneg, $foundpos)) {
return Functions::NAN();
}
return '';
}
private static function xirrPart1(&$values, &$dates)
{
if ((!is_array($values)) && (!is_array($dates))) {
return Functions::NA();
}
$values = Functions::flattenArray($values);
$dates = Functions::flattenArray($dates);
if (count($values) != count($dates)) {
return Functions::NAN();
}
$datesCount = count($dates);
for ($i = 0; $i < $datesCount; ++$i) {
$dates[$i] = DateTime::getDateValue($dates[$i]);
if (!is_numeric($dates[$i])) {
return Functions::VALUE();
}
}
return self::xirrPart2($values);
}
private static function xirrPart3($values, $dates, $x1, $x2)
{
$f = self::xnpvOrdered($x1, $values, $dates, false);
if ($f < 0.0) {
$rtb = $x1;
$dx = $x2 - $x1;
} else {
$rtb = $x2;
$dx = $x1 - $x2;
}
$rslt = Functions::VALUE();
for ($i = 0; $i < self::FINANCIAL_MAX_ITERATIONS; ++$i) {
$dx *= 0.5;
$x_mid = $rtb + $dx;
$f_mid = self::xnpvOrdered($x_mid, $values, $dates, false);
if ($f_mid <= 0.0) {
$rtb = $x_mid;
}
if ((abs($f_mid) < self::FINANCIAL_PRECISION) || (abs($dx) < self::FINANCIAL_PRECISION)) {
$rslt = $x_mid;
break;
}
}
return $rslt;
}
/** /**
* XIRR. * XIRR.
* *
@ -2202,73 +2231,37 @@ class Financial
*/ */
public static function XIRR($values, $dates, $guess = 0.1) public static function XIRR($values, $dates, $guess = 0.1)
{ {
if ((!is_array($values)) && (!is_array($dates))) { $rslt = self::xirrPart1($values, $dates);
return Functions::VALUE(); if ($rslt) {
} return $rslt;
$values = Functions::flattenArray($values);
$dates = Functions::flattenArray($dates);
$guess = Functions::flattenSingleValue($guess);
if (count($values) != count($dates)) {
return Functions::NAN();
}
$datesCount = count($dates);
for ($i = 0; $i < $datesCount; ++$i) {
$dates[$i] = DateTime::getDateValue($dates[$i]);
if (!is_numeric($dates[$i])) {
return Functions::VALUE();
}
}
if (min($dates) != $dates[0]) {
return Functions::NAN();
} }
// create an initial range, with a root somewhere between 0 and guess // create an initial range, with a root somewhere between 0 and guess
$guess = Functions::flattenSingleValue($guess);
$x1 = 0.0; $x1 = 0.0;
$x2 = $guess; $x2 = $guess ? $guess : 0.1;
$f1 = self::XNPV($x1, $values, $dates); $f1 = self::xnpvOrdered($x1, $values, $dates, false);
if (!is_numeric($f1)) { $f2 = self::xnpvOrdered($x2, $values, $dates, false);
return $f1; $found = false;
}
$f2 = self::XNPV($x2, $values, $dates);
if (!is_numeric($f2)) {
return $f2;
}
for ($i = 0; $i < self::FINANCIAL_MAX_ITERATIONS; ++$i) { for ($i = 0; $i < self::FINANCIAL_MAX_ITERATIONS; ++$i) {
if (!is_numeric($f1) || !is_numeric($f2)) {
break;
}
if (($f1 * $f2) < 0.0) { if (($f1 * $f2) < 0.0) {
$found = true;
break; break;
} elseif (abs($f1) < abs($f2)) { } elseif (abs($f1) < abs($f2)) {
$f1 = self::XNPV($x1 += 1.6 * ($x1 - $x2), $values, $dates); $f1 = self::xnpvOrdered($x1 += 1.6 * ($x1 - $x2), $values, $dates, false);
} else { } else {
$f2 = self::XNPV($x2 += 1.6 * ($x2 - $x1), $values, $dates); $f2 = self::xnpvOrdered($x2 += 1.6 * ($x2 - $x1), $values, $dates, false);
} }
} }
if (($f1 * $f2) > 0.0) { if (!$found) {
return Functions::NAN(); return Functions::NAN();
} }
$f = self::XNPV($x1, $values, $dates); return self::xirrPart3($values, $dates, $x1, $x2);
if ($f < 0.0) {
$rtb = $x1;
$dx = $x2 - $x1;
} else {
$rtb = $x2;
$dx = $x1 - $x2;
}
for ($i = 0; $i < self::FINANCIAL_MAX_ITERATIONS; ++$i) {
$dx *= 0.5;
$x_mid = $rtb + $dx;
$f_mid = self::XNPV($x_mid, $values, $dates);
if ($f_mid <= 0.0) {
$rtb = $x_mid;
}
if ((abs($f_mid) < self::FINANCIAL_PRECISION) || (abs($dx) < self::FINANCIAL_PRECISION)) {
return $x_mid;
}
}
return Functions::VALUE();
} }
/** /**
@ -2293,32 +2286,61 @@ class Financial
*/ */
public static function XNPV($rate, $values, $dates) public static function XNPV($rate, $values, $dates)
{ {
$rate = Functions::flattenSingleValue($rate); return self::xnpvOrdered($rate, $values, $dates, true);
}
private static function validateXnpv($rate, $values, $dates)
{
if (!is_numeric($rate)) { if (!is_numeric($rate)) {
return Functions::VALUE(); return Functions::VALUE();
} }
if ((!is_array($values)) || (!is_array($dates))) {
return Functions::VALUE();
}
$values = Functions::flattenArray($values);
$dates = Functions::flattenArray($dates);
$valCount = count($values); $valCount = count($values);
if ($valCount != count($dates)) { if ($valCount != count($dates)) {
return Functions::NAN(); return Functions::NAN();
} }
if ((min($values) > 0) || (max($values) < 0)) { if ($valCount > 1 && ((min($values) > 0) || (max($values) < 0))) {
return Functions::NAN(); return Functions::NAN();
} }
$date0 = DateTime::getDateValue($dates[0]);
if (is_string($date0)) {
return Functions::VALUE();
}
return '';
}
private static function xnpvOrdered($rate, $values, $dates, $ordered = true)
{
$rate = Functions::flattenSingleValue($rate);
$values = Functions::flattenArray($values);
$dates = Functions::flattenArray($dates);
$valCount = count($values);
$date0 = DateTime::getDateValue($dates[0]);
$rslt = self::validateXnpv($rate, $values, $dates);
if ($rslt) {
return $rslt;
}
$xnpv = 0.0; $xnpv = 0.0;
for ($i = 0; $i < $valCount; ++$i) { for ($i = 0; $i < $valCount; ++$i) {
if (!is_numeric($values[$i])) { if (!is_numeric($values[$i])) {
return Functions::VALUE(); return Functions::VALUE();
} }
$xnpv += $values[$i] / pow(1 + $rate, DateTime::DATEDIF($dates[0], $dates[$i], 'd') / 365); $datei = DateTime::getDateValue($dates[$i]);
if (is_string($datei)) {
return Functions::VALUE();
}
if ($date0 > $datei) {
$dif = $ordered ? Functions::NAN() : -DateTime::DATEDIF($datei, $date0, 'd');
} else {
$dif = DateTime::DATEDIF($date0, $datei, 'd');
}
if (!is_numeric($dif)) {
return $dif;
}
$xnpv += $values[$i] / (1 + $rate) ** ($dif / 365);
} }
return (is_finite($xnpv)) ? $xnpv : Functions::VALUE(); return is_finite($xnpv) ? $xnpv : Functions::VALUE();
} }
/** /**

6
src/PhpSpreadsheet/Calculation/FormulaParser.php
View File

@ -62,8 +62,6 @@ class FormulaParser
* Create a new FormulaParser. * Create a new FormulaParser.
* *
* @param string $pFormula Formula to parse * @param string $pFormula Formula to parse
*
* @throws Exception
*/ */
public function __construct($pFormula = '') public function __construct($pFormula = '')
{ {
@ -93,8 +91,6 @@ class FormulaParser
* *
* @param int $pId Token id * @param int $pId Token id
* *
* @throws Exception
*
* @return string * @return string
*/ */
public function getToken($pId = 0) public function getToken($pId = 0)
@ -129,7 +125,7 @@ class FormulaParser
/** /**
* Parse to tokens. * Parse to tokens.
*/ */
private function parseToTokens() private function parseToTokens(): void
{ {
// No attempt is made to verify formulas; assumes formulas are derived from Excel, where // No attempt is made to verify formulas; assumes formulas are derived from Excel, where
// they can only exist if valid; stack overflows/underflows sunk as nulls without exceptions. // they can only exist if valid; stack overflows/underflows sunk as nulls without exceptions.

6
src/PhpSpreadsheet/Calculation/FormulaToken.php
View File

@ -103,7 +103,7 @@ class FormulaToken
* *
* @param string $value * @param string $value
*/ */
public function setValue($value) public function setValue($value): void
{ {
$this->value = $value; $this->value = $value;
} }
@ -123,7 +123,7 @@ class FormulaToken
* *
* @param string $value * @param string $value
*/ */
public function setTokenType($value) public function setTokenType($value): void
{ {
$this->tokenType = $value; $this->tokenType = $value;
} }
@ -143,7 +143,7 @@ class FormulaToken
* *
* @param string $value * @param string $value
*/ */
public function setTokenSubType($value) public function setTokenSubType($value): void
{ {
$this->tokenSubType = $value; $this->tokenSubType = $value;
} }

26
src/PhpSpreadsheet/Calculation/Functions.php
View File

@ -57,8 +57,6 @@ class Functions
/** /**
* Set the Compatibility Mode. * Set the Compatibility Mode.
* *
* @category Function Configuration
*
* @param string $compatibilityMode Compatibility Mode * @param string $compatibilityMode Compatibility Mode
* Permitted values are: * Permitted values are:
* Functions::COMPATIBILITY_EXCEL 'Excel' * Functions::COMPATIBILITY_EXCEL 'Excel'
@ -84,8 +82,6 @@ class Functions
/** /**
* Return the current Compatibility Mode. * Return the current Compatibility Mode.
* *
* @category Function Configuration
*
* @return string Compatibility Mode * @return string Compatibility Mode
* Possible Return values are: * Possible Return values are:
* Functions::COMPATIBILITY_EXCEL 'Excel' * Functions::COMPATIBILITY_EXCEL 'Excel'
@ -100,8 +96,6 @@ class Functions
/** /**
* Set the Return Date Format used by functions that return a date/time (Excel, PHP Serialized Numeric or PHP Object). * Set the Return Date Format used by functions that return a date/time (Excel, PHP Serialized Numeric or PHP Object).
* *
* @category Function Configuration
*
* @param string $returnDateType Return Date Format * @param string $returnDateType Return Date Format
* Permitted values are: * Permitted values are:
* Functions::RETURNDATE_UNIX_TIMESTAMP 'P' * Functions::RETURNDATE_UNIX_TIMESTAMP 'P'
@ -127,8 +121,6 @@ class Functions
/** /**
* Return the current Return Date Format for functions that return a date/time (Excel, PHP Serialized Numeric or PHP Object). * Return the current Return Date Format for functions that return a date/time (Excel, PHP Serialized Numeric or PHP Object).
* *
* @category Function Configuration
*
* @return string Return Date Format * @return string Return Date Format
* Possible Return values are: * Possible Return values are:
* Functions::RETURNDATE_UNIX_TIMESTAMP 'P' * Functions::RETURNDATE_UNIX_TIMESTAMP 'P'
@ -143,8 +135,6 @@ class Functions
/** /**
* DUMMY. * DUMMY.
* *
* @category Error Returns
*
* @return string #Not Yet Implemented * @return string #Not Yet Implemented
*/ */
public static function DUMMY() public static function DUMMY()
@ -155,8 +145,6 @@ class Functions
/** /**
* DIV0. * DIV0.
* *
* @category Error Returns
*
* @return string #Not Yet Implemented * @return string #Not Yet Implemented
*/ */
public static function DIV0() public static function DIV0()
@ -173,8 +161,6 @@ class Functions
* Returns the error value #N/A * Returns the error value #N/A
* #N/A is the error value that means "no value is available." * #N/A is the error value that means "no value is available."
* *
* @category Logical Functions
*
* @return string #N/A! * @return string #N/A!
*/ */
public static function NA() public static function NA()
@ -187,8 +173,6 @@ class Functions
* *
* Returns the error value #NUM! * Returns the error value #NUM!
* *
* @category Error Returns
*
* @return string #NUM! * @return string #NUM!
*/ */
public static function NAN() public static function NAN()
@ -201,8 +185,6 @@ class Functions
* *
* Returns the error value #NAME? * Returns the error value #NAME?
* *
* @category Error Returns
*
* @return string #NAME? * @return string #NAME?
*/ */
public static function NAME() public static function NAME()
@ -215,8 +197,6 @@ class Functions
* *
* Returns the error value #REF! * Returns the error value #REF!
* *
* @category Error Returns
*
* @return string #REF! * @return string #REF!
*/ */
public static function REF() public static function REF()
@ -229,8 +209,6 @@ class Functions
* *
* Returns the error value #NULL! * Returns the error value #NULL!
* *
* @category Error Returns
*
* @return string #NULL! * @return string #NULL!
*/ */
public static function null() public static function null()
@ -243,8 +221,6 @@ class Functions
* *
* Returns the error value #VALUE! * Returns the error value #VALUE!
* *
* @category Error Returns
*
* @return string #VALUE! * @return string #VALUE!
*/ */
public static function VALUE() public static function VALUE()
@ -660,7 +636,7 @@ class Functions
* *
* @return bool|string * @return bool|string
*/ */
public static function isFormula($cellReference = '', Cell $pCell = null) public static function isFormula($cellReference = '', ?Cell $pCell = null)
{ {
if ($pCell === null) { if ($pCell === null) {
return self::REF(); return self::REF();

20
src/PhpSpreadsheet/Calculation/Logical.php
View File

@ -12,8 +12,6 @@ class Logical
* Excel Function: * Excel Function:
* =TRUE() * =TRUE()
* *
* @category Logical Functions
*
* @return bool True * @return bool True
*/ */
public static function true() public static function true()
@ -29,8 +27,6 @@ class Logical
* Excel Function: * Excel Function:
* =FALSE() * =FALSE()
* *
* @category Logical Functions
*
* @return bool False * @return bool False
*/ */
public static function false() public static function false()
@ -80,8 +76,6 @@ class Logical
* If any argument value is a string, or a Null, the function returns a #VALUE! error, unless the string holds * If any argument value is a string, or a Null, the function returns a #VALUE! error, unless the string holds
* the value TRUE or FALSE, in which case it is evaluated as the corresponding boolean value * the value TRUE or FALSE, in which case it is evaluated as the corresponding boolean value
* *
* @category Logical Functions
*
* @param mixed ...$args Data values * @param mixed ...$args Data values
* *
* @return bool|string the logical AND of the arguments * @return bool|string the logical AND of the arguments
@ -123,8 +117,6 @@ class Logical
* If any argument value is a string, or a Null, the function returns a #VALUE! error, unless the string holds * If any argument value is a string, or a Null, the function returns a #VALUE! error, unless the string holds
* the value TRUE or FALSE, in which case it is evaluated as the corresponding boolean value * the value TRUE or FALSE, in which case it is evaluated as the corresponding boolean value
* *
* @category Logical Functions
*
* @param mixed $args Data values * @param mixed $args Data values
* *
* @return bool|string the logical OR of the arguments * @return bool|string the logical OR of the arguments
@ -166,8 +158,6 @@ class Logical
* If any argument value is a string, or a Null, the function returns a #VALUE! error, unless the string holds * If any argument value is a string, or a Null, the function returns a #VALUE! error, unless the string holds
* the value TRUE or FALSE, in which case it is evaluated as the corresponding boolean value * the value TRUE or FALSE, in which case it is evaluated as the corresponding boolean value
* *
* @category Logical Functions
*
* @param mixed $args Data values * @param mixed $args Data values
* *
* @return bool|string the logical XOR of the arguments * @return bool|string the logical XOR of the arguments
@ -207,8 +197,6 @@ class Logical
* If any argument value is a string, or a Null, the function returns a #VALUE! error, unless the string holds * If any argument value is a string, or a Null, the function returns a #VALUE! error, unless the string holds
* the value TRUE or FALSE, in which case it is evaluated as the corresponding boolean value * the value TRUE or FALSE, in which case it is evaluated as the corresponding boolean value
* *
* @category Logical Functions
*
* @param mixed $logical A value or expression that can be evaluated to TRUE or FALSE * @param mixed $logical A value or expression that can be evaluated to TRUE or FALSE
* *
* @return bool|string the boolean inverse of the argument * @return bool|string the boolean inverse of the argument
@ -256,8 +244,6 @@ class Logical
* If condition is FALSE and ReturnIfFalse is blank, then the value 0 (zero) is returned. * If condition is FALSE and ReturnIfFalse is blank, then the value 0 (zero) is returned.
* ReturnIfFalse can be another formula. * ReturnIfFalse can be another formula.
* *
* @category Logical Functions
*
* @param mixed $condition Condition to evaluate * @param mixed $condition Condition to evaluate
* @param mixed $returnIfTrue Value to return when condition is true * @param mixed $returnIfTrue Value to return when condition is true
* @param mixed $returnIfFalse Optional value to return when condition is false * @param mixed $returnIfFalse Optional value to return when condition is false
@ -294,8 +280,6 @@ class Logical
* default * default
* Optional. It is the default to return if expression does not match any of the values (value1, value2, ... value_n). * Optional. It is the default to return if expression does not match any of the values (value1, value2, ... value_n).
* *
* @category Logical Functions
*
* @param mixed $arguments Statement arguments * @param mixed $arguments Statement arguments
* *
* @return mixed The value of matched expression * @return mixed The value of matched expression
@ -337,8 +321,6 @@ class Logical
* Excel Function: * Excel Function:
* =IFERROR(testValue,errorpart) * =IFERROR(testValue,errorpart)
* *
* @category Logical Functions
*
* @param mixed $testValue Value to check, is also the value returned when no error * @param mixed $testValue Value to check, is also the value returned when no error
* @param mixed $errorpart Value to return when testValue is an error condition * @param mixed $errorpart Value to return when testValue is an error condition
* *
@ -358,8 +340,6 @@ class Logical
* Excel Function: * Excel Function:
* =IFNA(testValue,napart) * =IFNA(testValue,napart)
* *
* @category Logical Functions
*
* @param mixed $testValue Value to check, is also the value returned when not an NA * @param mixed $testValue Value to check, is also the value returned when not an NA
* @param mixed $napart Value to return when testValue is an NA condition * @param mixed $napart Value to return when testValue is an NA condition
* *

21
src/PhpSpreadsheet/Calculation/LookupRef.php
View File

@ -230,15 +230,13 @@ class LookupRef
* Excel Function: * Excel Function:
* =HYPERLINK(linkURL,displayName) * =HYPERLINK(linkURL,displayName)
* *
* @category Logical Functions
*
* @param string $linkURL Value to check, is also the value returned when no error * @param string $linkURL Value to check, is also the value returned when no error
* @param string $displayName Value to return when testValue is an error condition * @param string $displayName Value to return when testValue is an error condition
* @param Cell $pCell The cell to set the hyperlink in * @param Cell $pCell The cell to set the hyperlink in
* *
* @return mixed The value of $displayName (or $linkURL if $displayName was blank) * @return mixed The value of $displayName (or $linkURL if $displayName was blank)
*/ */
public static function HYPERLINK($linkURL = '', $displayName = null, Cell $pCell = null) public static function HYPERLINK($linkURL = '', $displayName = null, ?Cell $pCell = null)
{ {
$linkURL = ($linkURL === null) ? '' : Functions::flattenSingleValue($linkURL); $linkURL = ($linkURL === null) ? '' : Functions::flattenSingleValue($linkURL);
$displayName = ($displayName === null) ? '' : Functions::flattenSingleValue($displayName); $displayName = ($displayName === null) ? '' : Functions::flattenSingleValue($displayName);
@ -273,9 +271,9 @@ class LookupRef
* *
* @return mixed The cells referenced by cellAddress * @return mixed The cells referenced by cellAddress
* *
* @todo Support for the optional a1 parameter introduced in Excel 2010 * @TODO Support for the optional a1 parameter introduced in Excel 2010
*/ */
public static function INDIRECT($cellAddress = null, Cell $pCell = null) public static function INDIRECT($cellAddress = null, ?Cell $pCell = null)
{ {
$cellAddress = Functions::flattenSingleValue($cellAddress); $cellAddress = Functions::flattenSingleValue($cellAddress);
if ($cellAddress === null || $cellAddress === '') { if ($cellAddress === null || $cellAddress === '') {
@ -339,11 +337,10 @@ class LookupRef
* starting reference). * starting reference).
* @param mixed $height The height, in number of rows, that you want the returned reference to be. Height must be a positive number. * @param mixed $height The height, in number of rows, that you want the returned reference to be. Height must be a positive number.
* @param mixed $width The width, in number of columns, that you want the returned reference to be. Width must be a positive number. * @param mixed $width The width, in number of columns, that you want the returned reference to be. Width must be a positive number.
* @param null|Cell $pCell
* *
* @return string A reference to a cell or range of cells * @return string A reference to a cell or range of cells
*/ */
public static function OFFSET($cellAddress = null, $rows = 0, $columns = 0, $height = null, $width = null, Cell $pCell = null) public static function OFFSET($cellAddress = null, $rows = 0, $columns = 0, $height = null, $width = null, ?Cell $pCell = null)
{ {
$rows = Functions::flattenSingleValue($rows); $rows = Functions::flattenSingleValue($rows);
$columns = Functions::flattenSingleValue($columns); $columns = Functions::flattenSingleValue($columns);
@ -419,14 +416,6 @@ class LookupRef
* Excel Function: * Excel Function:
* =CHOOSE(index_num, value1, [value2], ...) * =CHOOSE(index_num, value1, [value2], ...)
* *
* @param mixed $index_num Specifies which value argument is selected.
* Index_num must be a number between 1 and 254, or a formula or reference to a cell containing a number
* between 1 and 254.
* @param mixed $value1 ... Value1 is required, subsequent values are optional.
* Between 1 to 254 value arguments from which CHOOSE selects a value or an action to perform based on
* index_num. The arguments can be numbers, cell references, defined names, formulas, functions, or
* text.
*
* @return mixed The selected value * @return mixed The selected value
*/ */
public static function CHOOSE(...$chooseArgs) public static function CHOOSE(...$chooseArgs)
@ -945,7 +934,7 @@ class LookupRef
* *
* @return string * @return string
*/ */
public static function FORMULATEXT($cellReference = '', Cell $pCell = null) public static function FORMULATEXT($cellReference = '', ?Cell $pCell = null)
{ {
if ($pCell === null) { if ($pCell === null) {
return Functions::REF(); return Functions::REF();

74
src/PhpSpreadsheet/Calculation/MathTrig.php
View File

@ -2,6 +2,7 @@
namespace PhpOffice\PhpSpreadsheet\Calculation; namespace PhpOffice\PhpSpreadsheet\Calculation;
use Exception;
use Matrix\Exception as MatrixException; use Matrix\Exception as MatrixException;
use Matrix\Matrix; use Matrix\Matrix;
@ -46,8 +47,6 @@ class MathTrig
* Excel Function: * Excel Function:
* ARABIC(text) * ARABIC(text)
* *
* @category Mathematical and Trigonometric Functions
*
* @param string $roman * @param string $roman
* *
* @return int|string the arabic numberal contrived from the roman numeral * @return int|string the arabic numberal contrived from the roman numeral
@ -68,7 +67,7 @@ class MathTrig
try { try {
$arabic = self::calculateArabic(str_split($roman)); $arabic = self::calculateArabic(str_split($roman));
} catch (\Exception $e) { } catch (Exception $e) {
return Functions::VALUE(); // Invalid character detected return Functions::VALUE(); // Invalid character detected
} }
@ -82,7 +81,6 @@ class MathTrig
/** /**
* Recursively calculate the arabic value of a roman numeral. * Recursively calculate the arabic value of a roman numeral.
* *
* @param array $roman
* @param int $sum * @param int $sum
* @param int $subtract * @param int $subtract
* *
@ -102,7 +100,7 @@ class MathTrig
$numeral = array_shift($roman); $numeral = array_shift($roman);
if (!isset($lookup[$numeral])) { if (!isset($lookup[$numeral])) {
throw new \Exception('Invalid character detected'); throw new Exception('Invalid character detected');
} }
$arabic = $lookup[$numeral]; $arabic = $lookup[$numeral];
@ -136,8 +134,6 @@ class MathTrig
* Excel Function: * Excel Function:
* ATAN2(xCoordinate,yCoordinate) * ATAN2(xCoordinate,yCoordinate)
* *
* @category Mathematical and Trigonometric Functions
*
* @param float $xCoordinate the x-coordinate of the point * @param float $xCoordinate the x-coordinate of the point
* @param float $yCoordinate the y-coordinate of the point * @param float $yCoordinate the y-coordinate of the point
* *
@ -174,8 +170,6 @@ class MathTrig
* Excel Function: * Excel Function:
* BASE(Number, Radix [Min_length]) * BASE(Number, Radix [Min_length])
* *
* @category Mathematical and Trigonometric Functions
*
* @param float $number * @param float $number
* @param float $radix * @param float $radix
* @param int $minLength * @param int $minLength
@ -220,8 +214,6 @@ class MathTrig
* Excel Function: * Excel Function:
* CEILING(number[,significance]) * CEILING(number[,significance])
* *
* @category Mathematical and Trigonometric Functions
*
* @param float $number the number you want to round * @param float $number the number you want to round
* @param float $significance the multiple to which you want to round * @param float $significance the multiple to which you want to round
* *
@ -259,8 +251,6 @@ class MathTrig
* Excel Function: * Excel Function:
* COMBIN(numObjs,numInSet) * COMBIN(numObjs,numInSet)
* *
* @category Mathematical and Trigonometric Functions
*
* @param int $numObjs Number of different objects * @param int $numObjs Number of different objects
* @param int $numInSet Number of objects in each combination * @param int $numInSet Number of objects in each combination
* *
@ -296,8 +286,6 @@ class MathTrig
* Excel Function: * Excel Function:
* EVEN(number) * EVEN(number)
* *
* @category Mathematical and Trigonometric Functions
*
* @param float $number Number to round * @param float $number Number to round
* *
* @return int|string Rounded Number, or a string containing an error * @return int|string Rounded Number, or a string containing an error
@ -330,8 +318,6 @@ class MathTrig
* Excel Function: * Excel Function:
* FACT(factVal) * FACT(factVal)
* *
* @category Mathematical and Trigonometric Functions
*
* @param float $factVal Factorial Value * @param float $factVal Factorial Value
* *
* @return int|string Factorial, or a string containing an error * @return int|string Factorial, or a string containing an error
@ -369,8 +355,6 @@ class MathTrig
* Excel Function: * Excel Function:
* FACTDOUBLE(factVal) * FACTDOUBLE(factVal)
* *
* @category Mathematical and Trigonometric Functions
*
* @param float $factVal Factorial Value * @param float $factVal Factorial Value
* *
* @return int|string Double Factorial, or a string containing an error * @return int|string Double Factorial, or a string containing an error
@ -404,8 +388,6 @@ class MathTrig
* Excel Function: * Excel Function:
* FLOOR(number[,significance]) * FLOOR(number[,significance])
* *
* @category Mathematical and Trigonometric Functions
*
* @param float $number Number to round * @param float $number Number to round
* @param float $significance Significance * @param float $significance Significance
* *
@ -446,8 +428,6 @@ class MathTrig
* Excel Function: * Excel Function:
* FLOOR.MATH(number[,significance[,mode]]) * FLOOR.MATH(number[,significance[,mode]])
* *
* @category Mathematical and Trigonometric Functions
*
* @param float $number Number to round * @param float $number Number to round
* @param float $significance Significance * @param float $significance Significance
* @param int $mode direction to round negative numbers * @param int $mode direction to round negative numbers
@ -487,8 +467,6 @@ class MathTrig
* Excel Function: * Excel Function:
* FLOOR.PRECISE(number[,significance]) * FLOOR.PRECISE(number[,significance])
* *
* @category Mathematical and Trigonometric Functions
*
* @param float $number Number to round * @param float $number Number to round
* @param float $significance Significance * @param float $significance Significance
* *
@ -527,8 +505,6 @@ class MathTrig
* Excel Function: * Excel Function:
* GCD(number1[,number2[, ...]]) * GCD(number1[,number2[, ...]])
* *
* @category Mathematical and Trigonometric Functions
*
* @param mixed ...$args Data values * @param mixed ...$args Data values
* *
* @return int|mixed|string Greatest Common Divisor, or a string containing an error * @return int|mixed|string Greatest Common Divisor, or a string containing an error
@ -561,8 +537,6 @@ class MathTrig
* Excel Function: * Excel Function:
* INT(number) * INT(number)
* *
* @category Mathematical and Trigonometric Functions
*
* @param float $number Number to cast to an integer * @param float $number Number to cast to an integer
* *
* @return int|string Integer value, or a string containing an error * @return int|string Integer value, or a string containing an error
@ -594,8 +568,6 @@ class MathTrig
* Excel Function: * Excel Function:
* LCM(number1[,number2[, ...]]) * LCM(number1[,number2[, ...]])
* *
* @category Mathematical and Trigonometric Functions
*
* @param mixed ...$args Data values * @param mixed ...$args Data values
* *
* @return int|string Lowest Common Multiplier, or a string containing an error * @return int|string Lowest Common Multiplier, or a string containing an error
@ -618,7 +590,7 @@ class MathTrig
$myCountedFactors = array_count_values($myFactors); $myCountedFactors = array_count_values($myFactors);
$myPoweredFactors = []; $myPoweredFactors = [];
foreach ($myCountedFactors as $myCountedFactor => $myCountedPower) { foreach ($myCountedFactors as $myCountedFactor => $myCountedPower) {
$myPoweredFactors[$myCountedFactor] = pow($myCountedFactor, $myCountedPower); $myPoweredFactors[$myCountedFactor] = $myCountedFactor ** $myCountedPower;
} }
foreach ($myPoweredFactors as $myPoweredValue => $myPoweredFactor) { foreach ($myPoweredFactors as $myPoweredValue => $myPoweredFactor) {
if (isset($allPoweredFactors[$myPoweredValue])) { if (isset($allPoweredFactors[$myPoweredValue])) {
@ -645,8 +617,6 @@ class MathTrig
* Excel Function: * Excel Function:
* LOG(number[,base]) * LOG(number[,base])
* *
* @category Mathematical and Trigonometric Functions
*
* @param float $number The positive real number for which you want the logarithm * @param float $number The positive real number for which you want the logarithm
* @param float $base The base of the logarithm. If base is omitted, it is assumed to be 10. * @param float $base The base of the logarithm. If base is omitted, it is assumed to be 10.
* *
@ -675,8 +645,6 @@ class MathTrig
* Excel Function: * Excel Function:
* MDETERM(array) * MDETERM(array)
* *
* @category Mathematical and Trigonometric Functions
*
* @param array $matrixValues A matrix of values * @param array $matrixValues A matrix of values
* *
* @return float|string The result, or a string containing an error * @return float|string The result, or a string containing an error
@ -727,8 +695,6 @@ class MathTrig
* Excel Function: * Excel Function:
* MINVERSE(array) * MINVERSE(array)
* *
* @category Mathematical and Trigonometric Functions
*
* @param array $matrixValues A matrix of values * @param array $matrixValues A matrix of values
* *
* @return array|string The result, or a string containing an error * @return array|string The result, or a string containing an error
@ -986,7 +952,7 @@ class MathTrig
} }
// Return // Return
$result = pow($x, $y); $result = $x ** $y;
return (!is_nan($result) && !is_infinite($result)) ? $result : Functions::NAN(); return (!is_nan($result) && !is_infinite($result)) ? $result : Functions::NAN();
} }
@ -999,8 +965,6 @@ class MathTrig
* Excel Function: * Excel Function:
* PRODUCT(value1[,value2[, ...]]) * PRODUCT(value1[,value2[, ...]])
* *
* @category Mathematical and Trigonometric Functions
*
* @param mixed ...$args Data values * @param mixed ...$args Data values
* *
* @return float * @return float
@ -1039,8 +1003,6 @@ class MathTrig
* Excel Function: * Excel Function:
* QUOTIENT(value1[,value2[, ...]]) * QUOTIENT(value1[,value2[, ...]])
* *
* @category Mathematical and Trigonometric Functions
*
* @param mixed ...$args Data values * @param mixed ...$args Data values
* *
* @return float * @return float
@ -1139,10 +1101,10 @@ class MathTrig
if ((is_numeric($number)) && (is_numeric($digits))) { if ((is_numeric($number)) && (is_numeric($digits))) {
if ($number < 0.0) { if ($number < 0.0) {
return round($number - 0.5 * pow(0.1, $digits), $digits, PHP_ROUND_HALF_DOWN); return round($number - 0.5 * 0.1 ** $digits, $digits, PHP_ROUND_HALF_DOWN);
} }
return round($number + 0.5 * pow(0.1, $digits), $digits, PHP_ROUND_HALF_DOWN); return round($number + 0.5 * 0.1 ** $digits, $digits, PHP_ROUND_HALF_DOWN);
} }
return Functions::VALUE(); return Functions::VALUE();
@ -1165,10 +1127,10 @@ class MathTrig
if ((is_numeric($number)) && (is_numeric($digits))) { if ((is_numeric($number)) && (is_numeric($digits))) {
if ($number < 0.0) { if ($number < 0.0) {
return round($number + 0.5 * pow(0.1, $digits), $digits, PHP_ROUND_HALF_UP); return round($number + 0.5 * 0.1 ** $digits, $digits, PHP_ROUND_HALF_UP);
} }
return round($number - 0.5 * pow(0.1, $digits), $digits, PHP_ROUND_HALF_UP); return round($number - 0.5 * 0.1 ** $digits, $digits, PHP_ROUND_HALF_UP);
} }
return Functions::VALUE(); return Functions::VALUE();
@ -1179,9 +1141,6 @@ class MathTrig
* *
* Returns the sum of a power series * Returns the sum of a power series
* *
* @param float $x Input value to the power series
* @param float $n Initial power to which you want to raise $x
* @param float $m Step by which to increase $n for each term in the series
* @param array of mixed Data Series * @param array of mixed Data Series
* *
* @return float|string The result, or a string containing an error * @return float|string The result, or a string containing an error
@ -1203,7 +1162,7 @@ class MathTrig
foreach ($aArgs as $arg) { foreach ($aArgs as $arg) {
// Is it a numeric value? // Is it a numeric value?
if ((is_numeric($arg)) && (!is_string($arg))) { if ((is_numeric($arg)) && (!is_string($arg))) {
$returnValue += $arg * pow($x, $n + ($m * $i++)); $returnValue += $arg * $x ** ($n + ($m * $i++));
} else { } else {
return Functions::VALUE(); return Functions::VALUE();
} }
@ -1367,8 +1326,6 @@ class MathTrig
* Excel Function: * Excel Function:
* SUM(value1[,value2[, ...]]) * SUM(value1[,value2[, ...]])
* *
* @category Mathematical and Trigonometric Functions
*
* @param mixed ...$args Data values * @param mixed ...$args Data values
* *
* @return float * @return float
@ -1396,8 +1353,6 @@ class MathTrig
* Excel Function: * Excel Function:
* SUMIF(value1[,value2[, ...]],condition) * SUMIF(value1[,value2[, ...]],condition)
* *
* @category Mathematical and Trigonometric Functions
*
* @param mixed $aArgs Data values * @param mixed $aArgs Data values
* @param string $condition the criteria that defines which cells will be summed * @param string $condition the criteria that defines which cells will be summed
* @param mixed $sumArgs * @param mixed $sumArgs
@ -1442,10 +1397,7 @@ class MathTrig
* Excel Function: * Excel Function:
* SUMIFS(value1[,value2[, ...]],condition) * SUMIFS(value1[,value2[, ...]],condition)
* *
* @category Mathematical and Trigonometric Functions
*
* @param mixed $args Data values * @param mixed $args Data values
* @param string $condition the criteria that defines which cells will be summed
* *
* @return float * @return float
*/ */
@ -1500,8 +1452,6 @@ class MathTrig
* Excel Function: * Excel Function:
* SUMPRODUCT(value1[,value2[, ...]]) * SUMPRODUCT(value1[,value2[, ...]])
* *
* @category Mathematical and Trigonometric Functions
*
* @param mixed ...$args Data values * @param mixed ...$args Data values
* *
* @return float|string The result, or a string containing an error * @return float|string The result, or a string containing an error
@ -1545,8 +1495,6 @@ class MathTrig
* Excel Function: * Excel Function:
* SUMSQ(value1[,value2[, ...]]) * SUMSQ(value1[,value2[, ...]])
* *
* @category Mathematical and Trigonometric Functions
*
* @param mixed ...$args Data values * @param mixed ...$args Data values
* *
* @return float * @return float
@ -1663,7 +1611,7 @@ class MathTrig
$digits = floor($digits); $digits = floor($digits);
// Truncate // Truncate
$adjust = pow(10, $digits); $adjust = 10 ** $digits;
if (($digits > 0) && (rtrim((int) ((abs($value) - abs((int) $value)) * $adjust), '0') < $adjust / 10)) { if (($digits > 0) && (rtrim((int) ((abs($value) - abs((int) $value)) * $adjust), '0') < $adjust / 10)) {
return $value; return $value;

154
src/PhpSpreadsheet/Calculation/Statistical.php
View File

@ -397,10 +397,10 @@ class Statistical
for ($i = 1; $i <= $n; ++$i) { for ($i = 1; $i <= $n; ++$i) {
$divisor *= ($a + $i); $divisor *= ($a + $i);
} }
$summer += (pow($x, $n) / $divisor); $summer += ($x ** $n / $divisor);
} }
return pow($x, $a) * exp(0 - $x) * $summer; return $x ** $a * exp(0 - $x) * $summer;
} }
// //
@ -565,8 +565,6 @@ class Statistical
* Excel Function: * Excel Function:
* AVEDEV(value1[,value2[, ...]]) * AVEDEV(value1[,value2[, ...]])
* *
* @category Statistical Functions
*
* @param mixed ...$args Data values * @param mixed ...$args Data values
* *
* @return float|string * @return float|string
@ -616,8 +614,6 @@ class Statistical
* Excel Function: * Excel Function:
* AVERAGE(value1[,value2[, ...]]) * AVERAGE(value1[,value2[, ...]])
* *
* @category Statistical Functions
*
* @param mixed ...$args Data values * @param mixed ...$args Data values
* *
* @return float|string * @return float|string
@ -657,8 +653,6 @@ class Statistical
* Excel Function: * Excel Function:
* AVERAGEA(value1[,value2[, ...]]) * AVERAGEA(value1[,value2[, ...]])
* *
* @category Statistical Functions
*
* @param mixed ...$args Data values * @param mixed ...$args Data values
* *
* @return float|string * @return float|string
@ -700,8 +694,6 @@ class Statistical
* Excel Function: * Excel Function:
* AVERAGEIF(value1[,value2[, ...]],condition) * AVERAGEIF(value1[,value2[, ...]],condition)
* *
* @category Mathematical and Trigonometric Functions
*
* @param mixed $aArgs Data values * @param mixed $aArgs Data values
* @param string $condition the criteria that defines which cells will be checked * @param string $condition the criteria that defines which cells will be checked
* @param mixed[] $averageArgs Data values * @param mixed[] $averageArgs Data values
@ -874,13 +866,13 @@ class Statistical
if ($cumulative) { if ($cumulative) {
$summer = 0; $summer = 0;
for ($i = 0; $i <= $value; ++$i) { for ($i = 0; $i <= $value; ++$i) {
$summer += MathTrig::COMBIN($trials, $i) * pow($probability, $i) * pow(1 - $probability, $trials - $i); $summer += MathTrig::COMBIN($trials, $i) * $probability ** $i * (1 - $probability) ** ($trials - $i);
} }
return $summer; return $summer;
} }
return MathTrig::COMBIN($trials, $value) * pow($probability, $value) * pow(1 - $probability, $trials - $value); return MathTrig::COMBIN($trials, $value) * $probability ** $value * (1 - $probability) ** ($trials - $value);
} }
} }
@ -1053,8 +1045,6 @@ class Statistical
* Excel Function: * Excel Function:
* COUNT(value1[,value2[, ...]]) * COUNT(value1[,value2[, ...]])
* *
* @category Statistical Functions
*
* @param mixed ...$args Data values * @param mixed ...$args Data values
* *
* @return int * @return int
@ -1086,8 +1076,6 @@ class Statistical
* Excel Function: * Excel Function:
* COUNTA(value1[,value2[, ...]]) * COUNTA(value1[,value2[, ...]])
* *
* @category Statistical Functions
*
* @param mixed ...$args Data values * @param mixed ...$args Data values
* *
* @return int * @return int
@ -1116,8 +1104,6 @@ class Statistical
* Excel Function: * Excel Function:
* COUNTBLANK(value1[,value2[, ...]]) * COUNTBLANK(value1[,value2[, ...]])
* *
* @category Statistical Functions
*
* @param mixed ...$args Data values * @param mixed ...$args Data values
* *
* @return int * @return int
@ -1146,8 +1132,6 @@ class Statistical
* Excel Function: * Excel Function:
* COUNTIF(value1[,value2[, ...]],condition) * COUNTIF(value1[,value2[, ...]],condition)
* *
* @category Statistical Functions
*
* @param mixed $aArgs Data values * @param mixed $aArgs Data values
* @param string $condition the criteria that defines which cells will be counted * @param string $condition the criteria that defines which cells will be counted
* *
@ -1188,8 +1172,6 @@ class Statistical
* Excel Function: * Excel Function:
* COUNTIFS(criteria_range1, criteria1, [criteria_range2, criteria2]…) * COUNTIFS(criteria_range1, criteria1, [criteria_range2, criteria2]…)
* *
* @category Statistical Functions
*
* @param mixed $args Criterias * @param mixed $args Criterias
* *
* @return int * @return int
@ -1295,7 +1277,7 @@ class Statistical
* *
* @return int|string * @return int|string
* *
* @todo Warning. This implementation differs from the algorithm detailed on the MS * @TODO Warning. This implementation differs from the algorithm detailed on the MS
* web site in that $CumPGuessMinus1 = $CumPGuess - 1 rather than $CumPGuess - $PGuess * web site in that $CumPGuessMinus1 = $CumPGuess - 1 rather than $CumPGuess - $PGuess
* This eliminates a potential endless loop error, but may have an adverse affect on the * This eliminates a potential endless loop error, but may have an adverse affect on the
* accuracy of the function (although all my tests have so far returned correct results). * accuracy of the function (although all my tests have so far returned correct results).
@ -1320,7 +1302,7 @@ class Statistical
$t = sqrt(log(1 / ($alpha * $alpha))); $t = sqrt(log(1 / ($alpha * $alpha)));
$trialsApprox = 0 - ($t + (2.515517 + 0.802853 * $t + 0.010328 * $t * $t) / (1 + 1.432788 * $t + 0.189269 * $t * $t + 0.001308 * $t * $t * $t)); $trialsApprox = 0 - ($t + (2.515517 + 0.802853 * $t + 0.010328 * $t * $t) / (1 + 1.432788 * $t + 0.189269 * $t * $t + 0.001308 * $t * $t * $t));
} else { } else {
$t = sqrt(log(1 / pow(1 - $alpha, 2))); $t = sqrt(log(1 / (1 - $alpha) ** 2));
$trialsApprox = $t - (2.515517 + 0.802853 * $t + 0.010328 * $t * $t) / (1 + 1.432788 * $t + 0.189269 * $t * $t + 0.001308 * $t * $t * $t); $trialsApprox = $t - (2.515517 + 0.802853 * $t + 0.010328 * $t * $t) / (1 + 1.432788 * $t + 0.189269 * $t * $t + 0.001308 * $t * $t * $t);
} }
@ -1416,8 +1398,6 @@ class Statistical
* Excel Function: * Excel Function:
* DEVSQ(value1[,value2[, ...]]) * DEVSQ(value1[,value2[, ...]])
* *
* @category Statistical Functions
*
* @param mixed ...$args Data values * @param mixed ...$args Data values
* *
* @return float|string * @return float|string
@ -1441,9 +1421,9 @@ class Statistical
} }
if ((is_numeric($arg)) && (!is_string($arg))) { if ((is_numeric($arg)) && (!is_string($arg))) {
if ($returnValue === null) { if ($returnValue === null) {
$returnValue = pow(($arg - $aMean), 2); $returnValue = ($arg - $aMean) ** 2;
} else { } else {
$returnValue += pow(($arg - $aMean), 2); $returnValue += ($arg - $aMean) ** 2;
} }
++$aCount; ++$aCount;
} }
@ -1603,7 +1583,7 @@ class Statistical
return self::incompleteGamma($a, $value / $b) / self::gamma($a); return self::incompleteGamma($a, $value / $b) / self::gamma($a);
} }
return (1 / (pow($b, $a) * self::gamma($a))) * pow($value, $a - 1) * exp(0 - ($value / $b)); return (1 / ($b ** $a * self::gamma($a))) * $value ** ($a - 1) * exp(0 - ($value / $b));
} }
} }
@ -1707,8 +1687,6 @@ class Statistical
* Excel Function: * Excel Function:
* GEOMEAN(value1[,value2[, ...]]) * GEOMEAN(value1[,value2[, ...]])
* *
* @category Statistical Functions
*
* @param mixed ...$args Data values * @param mixed ...$args Data values
* *
* @return float|string * @return float|string
@ -1721,7 +1699,7 @@ class Statistical
if (is_numeric($aMean) && ($aMean > 0)) { if (is_numeric($aMean) && ($aMean > 0)) {
$aCount = self::COUNT($aArgs); $aCount = self::COUNT($aArgs);
if (self::MIN($aArgs) > 0) { if (self::MIN($aArgs) > 0) {
return pow($aMean, (1 / $aCount)); return $aMean ** (1 / $aCount);
} }
} }
@ -1769,8 +1747,6 @@ class Statistical
* Excel Function: * Excel Function:
* HARMEAN(value1[,value2[, ...]]) * HARMEAN(value1[,value2[, ...]])
* *
* @category Statistical Functions
*
* @param mixed ...$args Data values * @param mixed ...$args Data values
* *
* @return float|string * @return float|string
@ -1900,7 +1876,7 @@ class Statistical
} else { } else {
// Is it a numeric value? // Is it a numeric value?
if ((is_numeric($arg)) && (!is_string($arg))) { if ((is_numeric($arg)) && (!is_string($arg))) {
$summer += pow((($arg - $mean) / $stdDev), 4); $summer += (($arg - $mean) / $stdDev) ** 4;
++$count; ++$count;
} }
} }
@ -1908,7 +1884,7 @@ class Statistical
// Return // Return
if ($count > 3) { if ($count > 3) {
return $summer * ($count * ($count + 1) / (($count - 1) * ($count - 2) * ($count - 3))) - (3 * pow($count - 1, 2) / (($count - 2) * ($count - 3))); return $summer * ($count * ($count + 1) / (($count - 1) * ($count - 2) * ($count - 3))) - (3 * ($count - 1) ** 2 / (($count - 2) * ($count - 3)));
} }
} }
@ -1924,10 +1900,7 @@ class Statistical
* Excel Function: * Excel Function:
* LARGE(value1[,value2[, ...]],entry) * LARGE(value1[,value2[, ...]],entry)
* *
* @category Statistical Functions
*
* @param mixed $args Data values * @param mixed $args Data values
* @param int $entry Position (ordered from the largest) in the array or range of data to return
* *
* @return float|string The result, or a string containing an error * @return float|string The result, or a string containing an error
*/ */
@ -2094,7 +2067,7 @@ class Statistical
* *
* @return float|string The result, or a string containing an error * @return float|string The result, or a string containing an error
* *
* @todo Try implementing P J Acklam's refinement algorithm for greater * @TODO Try implementing P J Acklam's refinement algorithm for greater
* accuracy if I can get my head round the mathematics * accuracy if I can get my head round the mathematics
* (as described at) http://home.online.no/~pjacklam/notes/invnorm/ * (as described at) http://home.online.no/~pjacklam/notes/invnorm/
*/ */
@ -2153,8 +2126,6 @@ class Statistical
* Excel Function: * Excel Function:
* MAX(value1[,value2[, ...]]) * MAX(value1[,value2[, ...]])
* *
* @category Statistical Functions
*
* @param mixed ...$args Data values * @param mixed ...$args Data values
* *
* @return float * @return float
@ -2189,8 +2160,6 @@ class Statistical
* Excel Function: * Excel Function:
* MAXA(value1[,value2[, ...]]) * MAXA(value1[,value2[, ...]])
* *
* @category Statistical Functions
*
* @param mixed ...$args Data values * @param mixed ...$args Data values
* *
* @return float * @return float
@ -2230,8 +2199,6 @@ class Statistical
* Excel Function: * Excel Function:
* MAXIFS(max_range, criteria_range1, criteria1, [criteria_range2, criteria2], ...) * MAXIFS(max_range, criteria_range1, criteria1, [criteria_range2, criteria2], ...)
* *
* @category Statistical Functions
*
* @param mixed $args Data range and criterias * @param mixed $args Data range and criterias
* *
* @return float * @return float
@ -2289,8 +2256,6 @@ class Statistical
* Excel Function: * Excel Function:
* MEDIAN(value1[,value2[, ...]]) * MEDIAN(value1[,value2[, ...]])
* *
* @category Statistical Functions
*
* @param mixed ...$args Data values * @param mixed ...$args Data values
* *
* @return float|string The result, or a string containing an error * @return float|string The result, or a string containing an error
@ -2333,8 +2298,6 @@ class Statistical
* Excel Function: * Excel Function:
* MIN(value1[,value2[, ...]]) * MIN(value1[,value2[, ...]])
* *
* @category Statistical Functions
*
* @param mixed ...$args Data values * @param mixed ...$args Data values
* *
* @return float * @return float
@ -2369,8 +2332,6 @@ class Statistical
* Excel Function: * Excel Function:
* MINA(value1[,value2[, ...]]) * MINA(value1[,value2[, ...]])
* *
* @category Statistical Functions
*
* @param mixed ...$args Data values * @param mixed ...$args Data values
* *
* @return float * @return float
@ -2410,8 +2371,6 @@ class Statistical
* Excel Function: * Excel Function:
* MINIFS(min_range, criteria_range1, criteria1, [criteria_range2, criteria2], ...) * MINIFS(min_range, criteria_range1, criteria1, [criteria_range2, criteria2], ...)
* *
* @category Statistical Functions
*
* @param mixed $args Data range and criterias * @param mixed $args Data range and criterias
* *
* @return float * @return float
@ -2468,11 +2427,27 @@ class Statistical
private static function modeCalc($data) private static function modeCalc($data)
{ {
$frequencyArray = []; $frequencyArray = [];
$index = 0;
$maxfreq = 0;
$maxfreqkey = '';
$maxfreqdatum = '';
foreach ($data as $datum) { foreach ($data as $datum) {
$found = false; $found = false;
++$index;
foreach ($frequencyArray as $key => $value) { foreach ($frequencyArray as $key => $value) {
if ((string) $value['value'] == (string) $datum) { if ((string) $value['value'] == (string) $datum) {
++$frequencyArray[$key]['frequency']; ++$frequencyArray[$key]['frequency'];
$freq = $frequencyArray[$key]['frequency'];
if ($freq > $maxfreq) {
$maxfreq = $freq;
$maxfreqkey = $key;
$maxfreqdatum = $datum;
} elseif ($freq == $maxfreq) {
if ($frequencyArray[$key]['index'] < $frequencyArray[$maxfreqkey]['index']) {
$maxfreqkey = $key;
$maxfreqdatum = $datum;
}
}
$found = true; $found = true;
break; break;
@ -2482,21 +2457,16 @@ class Statistical
$frequencyArray[] = [ $frequencyArray[] = [
'value' => $datum, 'value' => $datum,
'frequency' => 1, 'frequency' => 1,
'index' => $index,
]; ];
} }
} }
foreach ($frequencyArray as $key => $value) { if ($maxfreq <= 1) {
$frequencyList[$key] = $value['frequency'];
$valueList[$key] = $value['value'];
}
array_multisort($frequencyList, SORT_DESC, $valueList, SORT_ASC, SORT_NUMERIC, $frequencyArray);
if ($frequencyArray[0]['frequency'] == 1) {
return Functions::NA(); return Functions::NA();
} }
return $frequencyArray[0]['value']; return $maxfreqdatum;
} }
/** /**
@ -2507,8 +2477,6 @@ class Statistical
* Excel Function: * Excel Function:
* MODE(value1[,value2[, ...]]) * MODE(value1[,value2[, ...]])
* *
* @category Statistical Functions
*
* @param mixed ...$args Data values * @param mixed ...$args Data values
* *
* @return float|string The result, or a string containing an error * @return float|string The result, or a string containing an error
@ -2568,7 +2536,7 @@ class Statistical
} }
} }
return (MathTrig::COMBIN($failures + $successes - 1, $successes - 1)) * (pow($probability, $successes)) * (pow(1 - $probability, $failures)); return (MathTrig::COMBIN($failures + $successes - 1, $successes - 1)) * ($probability ** $successes) * ((1 - $probability) ** $failures);
} }
return Functions::VALUE(); return Functions::VALUE();
@ -2603,7 +2571,7 @@ class Statistical
return 0.5 * (1 + Engineering::erfVal(($value - $mean) / ($stdDev * sqrt(2)))); return 0.5 * (1 + Engineering::erfVal(($value - $mean) / ($stdDev * sqrt(2))));
} }
return (1 / (self::SQRT2PI * $stdDev)) * exp(0 - (pow($value - $mean, 2) / (2 * ($stdDev * $stdDev)))); return (1 / (self::SQRT2PI * $stdDev)) * exp(0 - (($value - $mean) ** 2 / (2 * ($stdDev * $stdDev))));
} }
} }
@ -2681,10 +2649,7 @@ class Statistical
* Excel Function: * Excel Function:
* PERCENTILE(value1[,value2[, ...]],entry) * PERCENTILE(value1[,value2[, ...]],entry)
* *
* @category Statistical Functions
*
* @param mixed $args Data values * @param mixed $args Data values
* @param float $entry Percentile value in the range 0..1, inclusive.
* *
* @return float|string The result, or a string containing an error * @return float|string The result, or a string containing an error
*/ */
@ -2830,13 +2795,13 @@ class Statistical
$summer = 0; $summer = 0;
$floor = floor($value); $floor = floor($value);
for ($i = 0; $i <= $floor; ++$i) { for ($i = 0; $i <= $floor; ++$i) {
$summer += pow($mean, $i) / MathTrig::FACT($i); $summer += $mean ** $i / MathTrig::FACT($i);
} }
return exp(0 - $mean) * $summer; return exp(0 - $mean) * $summer;
} }
return (exp(0 - $mean) * pow($mean, $value)) / MathTrig::FACT($value); return (exp(0 - $mean) * $mean ** $value) / MathTrig::FACT($value);
} }
} }
@ -2851,10 +2816,7 @@ class Statistical
* Excel Function: * Excel Function:
* QUARTILE(value1[,value2[, ...]],entry) * QUARTILE(value1[,value2[, ...]],entry)
* *
* @category Statistical Functions
*
* @param mixed $args Data values * @param mixed $args Data values
* @param int $entry Quartile value in the range 1..3, inclusive.
* *
* @return float|string The result, or a string containing an error * @return float|string The result, or a string containing an error
*/ */
@ -2968,7 +2930,7 @@ class Statistical
} else { } else {
// Is it a numeric value? // Is it a numeric value?
if ((is_numeric($arg)) && (!is_string($arg))) { if ((is_numeric($arg)) && (!is_string($arg))) {
$summer += pow((($arg - $mean) / $stdDev), 3); $summer += (($arg - $mean) / $stdDev) ** 3;
++$count; ++$count;
} }
} }
@ -3019,10 +2981,7 @@ class Statistical
* Excel Function: * Excel Function:
* SMALL(value1[,value2[, ...]],entry) * SMALL(value1[,value2[, ...]],entry)
* *
* @category Statistical Functions
*
* @param mixed $args Data values * @param mixed $args Data values
* @param int $entry Position (ordered from the smallest) in the array or range of data to return
* *
* @return float|string The result, or a string containing an error * @return float|string The result, or a string containing an error
*/ */
@ -3091,8 +3050,6 @@ class Statistical
* Excel Function: * Excel Function:
* STDEV(value1[,value2[, ...]]) * STDEV(value1[,value2[, ...]])
* *
* @category Statistical Functions
*
* @param mixed ...$args Data values * @param mixed ...$args Data values
* *
* @return float|string The result, or a string containing an error * @return float|string The result, or a string containing an error
@ -3115,9 +3072,9 @@ class Statistical
// Is it a numeric value? // Is it a numeric value?
if ((is_numeric($arg)) && (!is_string($arg))) { if ((is_numeric($arg)) && (!is_string($arg))) {
if ($returnValue === null) { if ($returnValue === null) {
$returnValue = pow(($arg - $aMean), 2); $returnValue = ($arg - $aMean) ** 2;
} else { } else {
$returnValue += pow(($arg - $aMean), 2); $returnValue += ($arg - $aMean) ** 2;
} }
++$aCount; ++$aCount;
} }
@ -3140,8 +3097,6 @@ class Statistical
* Excel Function: * Excel Function:
* STDEVA(value1[,value2[, ...]]) * STDEVA(value1[,value2[, ...]])
* *
* @category Statistical Functions
*
* @param mixed ...$args Data values * @param mixed ...$args Data values
* *
* @return float|string * @return float|string
@ -3167,9 +3122,9 @@ class Statistical
$arg = 0; $arg = 0;
} }
if ($returnValue === null) { if ($returnValue === null) {
$returnValue = pow(($arg - $aMean), 2); $returnValue = ($arg - $aMean) ** 2;
} else { } else {
$returnValue += pow(($arg - $aMean), 2); $returnValue += ($arg - $aMean) ** 2;
} }
++$aCount; ++$aCount;
} }
@ -3192,8 +3147,6 @@ class Statistical
* Excel Function: * Excel Function:
* STDEVP(value1[,value2[, ...]]) * STDEVP(value1[,value2[, ...]])
* *
* @category Statistical Functions
*
* @param mixed ...$args Data values * @param mixed ...$args Data values
* *
* @return float|string * @return float|string
@ -3215,9 +3168,9 @@ class Statistical
// Is it a numeric value? // Is it a numeric value?
if ((is_numeric($arg)) && (!is_string($arg))) { if ((is_numeric($arg)) && (!is_string($arg))) {
if ($returnValue === null) { if ($returnValue === null) {
$returnValue = pow(($arg - $aMean), 2); $returnValue = ($arg - $aMean) ** 2;
} else { } else {
$returnValue += pow(($arg - $aMean), 2); $returnValue += ($arg - $aMean) ** 2;
} }
++$aCount; ++$aCount;
} }
@ -3239,8 +3192,6 @@ class Statistical
* Excel Function: * Excel Function:
* STDEVPA(value1[,value2[, ...]]) * STDEVPA(value1[,value2[, ...]])
* *
* @category Statistical Functions
*
* @param mixed ...$args Data values * @param mixed ...$args Data values
* *
* @return float|string * @return float|string
@ -3266,9 +3217,9 @@ class Statistical
$arg = 0; $arg = 0;
} }
if ($returnValue === null) { if ($returnValue === null) {
$returnValue = pow(($arg - $aMean), 2); $returnValue = ($arg - $aMean) ** 2;
} else { } else {
$returnValue += pow(($arg - $aMean), 2); $returnValue += ($arg - $aMean) ** 2;
} }
++$aCount; ++$aCount;
} }
@ -3477,10 +3428,7 @@ class Statistical
* Excel Function: * Excel Function:
* TRIMEAN(value1[,value2[, ...]], $discard) * TRIMEAN(value1[,value2[, ...]], $discard)
* *
* @category Statistical Functions
*
* @param mixed $args Data values * @param mixed $args Data values
* @param float $discard Percentage to discard
* *
* @return float|string * @return float|string
*/ */
@ -3523,8 +3471,6 @@ class Statistical
* Excel Function: * Excel Function:
* VAR(value1[,value2[, ...]]) * VAR(value1[,value2[, ...]])
* *
* @category Statistical Functions
*
* @param mixed ...$args Data values * @param mixed ...$args Data values
* *
* @return float * @return float
@ -3567,8 +3513,6 @@ class Statistical
* Excel Function: * Excel Function:
* VARA(value1[,value2[, ...]]) * VARA(value1[,value2[, ...]])
* *
* @category Statistical Functions
*
* @param mixed ...$args Data values * @param mixed ...$args Data values
* *
* @return float * @return float
@ -3620,8 +3564,6 @@ class Statistical
* Excel Function: * Excel Function:
* VARP(value1[,value2[, ...]]) * VARP(value1[,value2[, ...]])
* *
* @category Statistical Functions
*
* @param mixed ...$args Data values * @param mixed ...$args Data values
* *
* @return float * @return float
@ -3665,8 +3607,6 @@ class Statistical
* Excel Function: * Excel Function:
* VARPA(value1[,value2[, ...]]) * VARPA(value1[,value2[, ...]])
* *
* @category Statistical Functions
*
* @param mixed ...$args Data values * @param mixed ...$args Data values
* *
* @return float * @return float
@ -3735,10 +3675,10 @@ class Statistical
} }
if ((is_numeric($cumulative)) || (is_bool($cumulative))) { if ((is_numeric($cumulative)) || (is_bool($cumulative))) {
if ($cumulative) { if ($cumulative) {
return 1 - exp(0 - pow($value / $beta, $alpha)); return 1 - exp(0 - ($value / $beta) ** $alpha);
} }
return ($alpha / pow($beta, $alpha)) * pow($value, $alpha - 1) * exp(0 - pow($value / $beta, $alpha)); return ($alpha / $beta ** $alpha) * $value ** ($alpha - 1) * exp(0 - ($value / $beta) ** $alpha);
} }
} }

4
src/PhpSpreadsheet/Calculation/TextData.php
View File

@ -167,7 +167,7 @@ class TextData
if ($decimals > 0) { if ($decimals > 0) {
$mask .= '.' . str_repeat('0', $decimals); $mask .= '.' . str_repeat('0', $decimals);
} else { } else {
$round = pow(10, abs($decimals)); $round = 10 ** abs($decimals);
if ($value < 0) { if ($value < 0) {
$round = 0 - $round; $round = 0 - $round;
} }
@ -623,7 +623,7 @@ class TextData
$percentageAdjustment = strlen($value) - strlen($percentageString); $percentageAdjustment = strlen($value) - strlen($percentageString);
if ($percentageAdjustment) { if ($percentageAdjustment) {
$value = (float) $percentageString; $value = (float) $percentageString;
$value /= pow(10, $percentageAdjustment * 2); $value /= 10 ** ($percentageAdjustment * 2);
} }
} }

4
src/PhpSpreadsheet/Calculation/Token/Stack.php
View File

@ -49,7 +49,7 @@ class Stack
$storeKey = null, $storeKey = null,
$onlyIf = null, $onlyIf = null,
$onlyIfNot = null $onlyIfNot = null
) { ): void {
$stackItem = $this->getStackItem($type, $value, $reference, $storeKey, $onlyIf, $onlyIfNot); $stackItem = $this->getStackItem($type, $value, $reference, $storeKey, $onlyIf, $onlyIfNot);
$this->stack[$this->count++] = $stackItem; $this->stack[$this->count++] = $stackItem;
@ -124,7 +124,7 @@ class Stack
/** /**
* Clear the stack. * Clear the stack.
*/ */
public function clear() public function clear(): void
{ {
$this->stack = []; $this->stack = [];
$this->count = 0; $this->count = 0;

2
src/PhpSpreadsheet/Calculation/functionlist.txt
View File

@ -316,6 +316,8 @@ SEC
SECH SECH
SECOND SECOND
SERIESSUM SERIESSUM
SHEET
SHEETS
SIGN SIGN
SIN SIN
SINH SINH

2
src/PhpSpreadsheet/Cell/AdvancedValueBinder.php
View File

@ -16,8 +16,6 @@ class AdvancedValueBinder extends DefaultValueBinder implements IValueBinder
* @param Cell $cell Cell to bind value to * @param Cell $cell Cell to bind value to
* @param mixed $value Value to bind in cell * @param mixed $value Value to bind in cell
* *
* @throws \PhpOffice\PhpSpreadsheet\Exception
*
* @return bool * @return bool
*/ */
public function bindValue(Cell $cell, $value = null) public function bindValue(Cell $cell, $value = null)

35
src/PhpSpreadsheet/Cell/Cell.php
View File

@ -76,12 +76,12 @@ class Cell
return $this; return $this;
} }
public function detach() public function detach(): void
{ {
$this->parent = null; $this->parent = null;
} }
public function attach(Cells $parent) public function attach(Cells $parent): void
{ {
$this->parent = $parent; $this->parent = $parent;
} }
@ -91,9 +91,6 @@ class Cell
* *
* @param mixed $pValue * @param mixed $pValue
* @param string $pDataType * @param string $pDataType
* @param Worksheet $pSheet
*
* @throws Exception
*/ */
public function __construct($pValue, $pDataType, Worksheet $pSheet) public function __construct($pValue, $pDataType, Worksheet $pSheet)
{ {
@ -175,8 +172,6 @@ class Cell
* *
* @param mixed $pValue Value * @param mixed $pValue Value
* *
* @throws Exception
*
* @return $this * @return $this
*/ */
public function setValue($pValue) public function setValue($pValue)
@ -194,8 +189,6 @@ class Cell
* @param mixed $pValue Value * @param mixed $pValue Value
* @param string $pDataType Explicit data type, see DataType::TYPE_* * @param string $pDataType Explicit data type, see DataType::TYPE_*
* *
* @throws Exception
*
* @return Cell * @return Cell
*/ */
public function setValueExplicit($pValue, $pDataType) public function setValueExplicit($pValue, $pDataType)
@ -252,8 +245,6 @@ class Cell
* *
* @param bool $resetLog Whether the calculation engine logger should be reset or not * @param bool $resetLog Whether the calculation engine logger should be reset or not
* *
* @throws Exception
*
* @return mixed * @return mixed
*/ */
public function getCalculatedValue($resetLog = true) public function getCalculatedValue($resetLog = true)
@ -362,8 +353,6 @@ class Cell
/** /**
* Does this cell contain Data validation rules? * Does this cell contain Data validation rules?
* *
* @throws Exception
*
* @return bool * @return bool
*/ */
public function hasDataValidation() public function hasDataValidation()
@ -378,8 +367,6 @@ class Cell
/** /**
* Get Data validation rules. * Get Data validation rules.
* *
* @throws Exception
*
* @return DataValidation * @return DataValidation
*/ */
public function getDataValidation() public function getDataValidation()
@ -396,11 +383,9 @@ class Cell
* *
* @param DataValidation $pDataValidation * @param DataValidation $pDataValidation
* *
* @throws Exception
*
* @return Cell * @return Cell
*/ */
public function setDataValidation(DataValidation $pDataValidation = null) public function setDataValidation(?DataValidation $pDataValidation = null)
{ {
if (!isset($this->parent)) { if (!isset($this->parent)) {
throw new Exception('Cannot set data validation for cell that is not bound to a worksheet'); throw new Exception('Cannot set data validation for cell that is not bound to a worksheet');
@ -426,8 +411,6 @@ class Cell
/** /**
* Does this cell contain a Hyperlink? * Does this cell contain a Hyperlink?
* *
* @throws Exception
*
* @return bool * @return bool
*/ */
public function hasHyperlink() public function hasHyperlink()
@ -442,8 +425,6 @@ class Cell
/** /**
* Get Hyperlink. * Get Hyperlink.
* *
* @throws Exception
*
* @return Hyperlink * @return Hyperlink
*/ */
public function getHyperlink() public function getHyperlink()
@ -460,11 +441,9 @@ class Cell
* *
* @param Hyperlink $pHyperlink * @param Hyperlink $pHyperlink
* *
* @throws Exception
*
* @return Cell * @return Cell
*/ */
public function setHyperlink(Hyperlink $pHyperlink = null) public function setHyperlink(?Hyperlink $pHyperlink = null)
{ {
if (!isset($this->parent)) { if (!isset($this->parent)) {
throw new Exception('Cannot set hyperlink for cell that is not bound to a worksheet'); throw new Exception('Cannot set hyperlink for cell that is not bound to a worksheet');
@ -552,8 +531,6 @@ class Cell
/** /**
* Re-bind parent. * Re-bind parent.
* *
* @param Worksheet $parent
*
* @return Cell * @return Cell
*/ */
public function rebindParent(Worksheet $parent) public function rebindParent(Worksheet $parent)
@ -620,10 +597,8 @@ class Cell
/** /**
* Set value binder to use. * Set value binder to use.
*
* @param IValueBinder $binder
*/ */
public static function setValueBinder(IValueBinder $binder) public static function setValueBinder(IValueBinder $binder): void
{ {
self::$valueBinder = $binder; self::$valueBinder = $binder;
} }

10
src/PhpSpreadsheet/Cell/Coordinate.php
View File

@ -25,8 +25,6 @@ abstract class Coordinate
* *
* @param string $pCoordinateString eg: 'A1' * @param string $pCoordinateString eg: 'A1'
* *
* @throws Exception
*
* @return string[] Array containing column and row (indexes 0 and 1) * @return string[] Array containing column and row (indexes 0 and 1)
*/ */
public static function coordinateFromString($pCoordinateString) public static function coordinateFromString($pCoordinateString)
@ -60,8 +58,6 @@ abstract class Coordinate
* @param string $pCoordinateString e.g. 'A' or '1' or 'A1' * @param string $pCoordinateString e.g. 'A' or '1' or 'A1'
* Note that this value can be a row or column reference as well as a cell reference * Note that this value can be a row or column reference as well as a cell reference
* *
* @throws Exception
*
* @return string Absolute coordinate e.g. '$A' or '$1' or '$A$1' * @return string Absolute coordinate e.g. '$A' or '$1' or '$A$1'
*/ */
public static function absoluteReference($pCoordinateString) public static function absoluteReference($pCoordinateString)
@ -91,8 +87,6 @@ abstract class Coordinate
* *
* @param string $pCoordinateString e.g. 'A1' * @param string $pCoordinateString e.g. 'A1'
* *
* @throws Exception
*
* @return string Absolute coordinate e.g. '$A$1' * @return string Absolute coordinate e.g. '$A$1'
*/ */
public static function absoluteCoordinate($pCoordinateString) public static function absoluteCoordinate($pCoordinateString)
@ -145,8 +139,6 @@ abstract class Coordinate
* *
* @param array $pRange Array containg one or more arrays containing one or two coordinate strings * @param array $pRange Array containg one or more arrays containing one or two coordinate strings
* *
* @throws Exception
*
* @return string String representation of $pRange * @return string String representation of $pRange
*/ */
public static function buildRange(array $pRange) public static function buildRange(array $pRange)
@ -511,7 +503,7 @@ abstract class Coordinate
* @param int $currentRow * @param int $currentRow
* @param int $endRow * @param int $endRow
*/ */
private static function validateRange($cellBlock, $startColumnIndex, $endColumnIndex, $currentRow, $endRow) private static function validateRange($cellBlock, $startColumnIndex, $endColumnIndex, $currentRow, $endRow): void
{ {
if ($startColumnIndex >= $endColumnIndex || $currentRow > $endRow) { if ($startColumnIndex >= $endColumnIndex || $currentRow > $endRow) {
throw new Exception('Invalid range: "' . $cellBlock . '"'); throw new Exception('Invalid range: "' . $cellBlock . '"');

2
src/PhpSpreadsheet/Cell/DefaultValueBinder.php
View File

@ -14,8 +14,6 @@ class DefaultValueBinder implements IValueBinder
* @param Cell $cell Cell to bind value to * @param Cell $cell Cell to bind value to
* @param mixed $value Value to bind in cell * @param mixed $value Value to bind in cell
* *
* @throws \PhpOffice\PhpSpreadsheet\Exception
*
* @return bool * @return bool
*/ */
public function bindValue(Cell $cell, $value) public function bindValue(Cell $cell, $value)

2
src/PhpSpreadsheet/Cell/StringValueBinder.php
View File

@ -12,8 +12,6 @@ class StringValueBinder implements IValueBinder
* @param Cell $cell Cell to bind value to * @param Cell $cell Cell to bind value to
* @param mixed $value Value to bind in cell * @param mixed $value Value to bind in cell
* *
* @throws \PhpOffice\PhpSpreadsheet\Exception
*
* @return bool * @return bool
*/ */
public function bindValue(Cell $cell, $value) public function bindValue(Cell $cell, $value)

17
src/PhpSpreadsheet/Chart/Axis.php
View File

@ -178,7 +178,7 @@ class Axis extends Properties
* @param string $major_unit * @param string $major_unit
* @param string $minor_unit * @param string $minor_unit
*/ */
public function setAxisOptionsProperties($axis_labels, $horizontal_crosses_value = null, $horizontal_crosses = null, $axis_orientation = null, $major_tmt = null, $minor_tmt = null, $minimum = null, $maximum = null, $major_unit = null, $minor_unit = null) public function setAxisOptionsProperties($axis_labels, $horizontal_crosses_value = null, $horizontal_crosses = null, $axis_orientation = null, $major_tmt = null, $minor_tmt = null, $minimum = null, $maximum = null, $major_unit = null, $minor_unit = null): void
{ {
$this->axisOptions['axis_labels'] = (string) $axis_labels; $this->axisOptions['axis_labels'] = (string) $axis_labels;
($horizontal_crosses_value !== null) ? $this->axisOptions['horizontal_crosses_value'] = (string) $horizontal_crosses_value : null; ($horizontal_crosses_value !== null) ? $this->axisOptions['horizontal_crosses_value'] = (string) $horizontal_crosses_value : null;
@ -210,7 +210,7 @@ class Axis extends Properties
* *
* @param string $orientation * @param string $orientation
*/ */
public function setAxisOrientation($orientation) public function setAxisOrientation($orientation): void
{ {
$this->axisOptions['orientation'] = (string) $orientation; $this->axisOptions['orientation'] = (string) $orientation;
} }
@ -222,7 +222,7 @@ class Axis extends Properties
* @param int $alpha * @param int $alpha
* @param string $type * @param string $type
*/ */
public function setFillParameters($color, $alpha = 0, $type = self::EXCEL_COLOR_TYPE_ARGB) public function setFillParameters($color, $alpha = 0, $type = self::EXCEL_COLOR_TYPE_ARGB): void
{ {
$this->fillProperties = $this->setColorProperties($color, $alpha, $type); $this->fillProperties = $this->setColorProperties($color, $alpha, $type);
} }
@ -234,7 +234,7 @@ class Axis extends Properties
* @param int $alpha * @param int $alpha
* @param string $type * @param string $type
*/ */
public function setLineParameters($color, $alpha = 0, $type = self::EXCEL_COLOR_TYPE_ARGB) public function setLineParameters($color, $alpha = 0, $type = self::EXCEL_COLOR_TYPE_ARGB): void
{ {
$this->lineProperties = $this->setColorProperties($color, $alpha, $type); $this->lineProperties = $this->setColorProperties($color, $alpha, $type);
} }
@ -276,7 +276,7 @@ class Axis extends Properties
* @param string $end_arrow_type * @param string $end_arrow_type
* @param string $end_arrow_size * @param string $end_arrow_size
*/ */
public function setLineStyleProperties($line_width = null, $compound_type = null, $dash_type = null, $cap_type = null, $join_type = null, $head_arrow_type = null, $head_arrow_size = null, $end_arrow_type = null, $end_arrow_size = null) public function setLineStyleProperties($line_width = null, $compound_type = null, $dash_type = null, $cap_type = null, $join_type = null, $head_arrow_type = null, $head_arrow_size = null, $end_arrow_type = null, $end_arrow_size = null): void
{ {
($line_width !== null) ? $this->lineStyleProperties['width'] = $this->getExcelPointsWidth((float) $line_width) : null; ($line_width !== null) ? $this->lineStyleProperties['width'] = $this->getExcelPointsWidth((float) $line_width) : null;
($compound_type !== null) ? $this->lineStyleProperties['compound'] = (string) $compound_type : null; ($compound_type !== null) ? $this->lineStyleProperties['compound'] = (string) $compound_type : null;
@ -336,7 +336,7 @@ class Axis extends Properties
* @param int $sh_angle * @param int $sh_angle
* @param float $sh_distance * @param float $sh_distance
*/ */
public function setShadowProperties($sh_presets, $sh_color_value = null, $sh_color_type = null, $sh_color_alpha = null, $sh_blur = null, $sh_angle = null, $sh_distance = null) public function setShadowProperties($sh_presets, $sh_color_value = null, $sh_color_type = null, $sh_color_alpha = null, $sh_blur = null, $sh_angle = null, $sh_distance = null): void
{ {
$this->setShadowPresetsProperties((int) $sh_presets) $this->setShadowPresetsProperties((int) $sh_presets)
->setShadowColor( ->setShadowColor(
@ -367,7 +367,6 @@ class Axis extends Properties
/** /**
* Set Shadow Properties from Mapped Values. * Set Shadow Properties from Mapped Values.
* *
* @param array $properties_map
* @param mixed &$reference * @param mixed &$reference
* *
* @return $this * @return $this
@ -479,7 +478,7 @@ class Axis extends Properties
* @param int $color_alpha * @param int $color_alpha
* @param string $color_type * @param string $color_type
*/ */
public function setGlowProperties($size, $color_value = null, $color_alpha = null, $color_type = null) public function setGlowProperties($size, $color_value = null, $color_alpha = null, $color_type = null): void
{ {
$this->setGlowSize($size) $this->setGlowSize($size)
->setGlowColor( ->setGlowColor(
@ -538,7 +537,7 @@ class Axis extends Properties
* *
* @param float $size * @param float $size
*/ */
public function setSoftEdges($size) public function setSoftEdges($size): void
{ {
if ($size !== null) { if ($size !== null) {
$softEdges['size'] = (string) $this->getExcelPointsWidth($size); $softEdges['size'] = (string) $this->getExcelPointsWidth($size);

27
src/PhpSpreadsheet/Chart/Chart.php
View File

@ -68,7 +68,7 @@ class Chart
* *
* @var string * @var string
*/ */
private $displayBlanksAs = '0'; private $displayBlanksAs = DataSeries::EMPTY_AS_GAP;
/** /**
* Chart Asix Y as. * Chart Asix Y as.
@ -144,19 +144,10 @@ class Chart
* Create a new Chart. * Create a new Chart.
* *
* @param mixed $name * @param mixed $name
* @param null|Title $title
* @param null|Legend $legend
* @param null|PlotArea $plotArea
* @param mixed $plotVisibleOnly * @param mixed $plotVisibleOnly
* @param mixed $displayBlanksAs * @param string $displayBlanksAs
* @param null|Title $xAxisLabel
* @param null|Title $yAxisLabel
* @param null|Axis $xAxis
* @param null|Axis $yAxis
* @param null|GridLines $majorGridlines
* @param null|GridLines $minorGridlines
*/ */
public function __construct($name, Title $title = null, Legend $legend = null, PlotArea $plotArea = null, $plotVisibleOnly = true, $displayBlanksAs = 'gap', Title $xAxisLabel = null, Title $yAxisLabel = null, Axis $xAxis = null, Axis $yAxis = null, GridLines $majorGridlines = null, GridLines $minorGridlines = null) public function __construct($name, ?Title $title = null, ?Legend $legend = null, ?PlotArea $plotArea = null, $plotVisibleOnly = true, $displayBlanksAs = DataSeries::EMPTY_AS_GAP, ?Title $xAxisLabel = null, ?Title $yAxisLabel = null, ?Axis $xAxis = null, ?Axis $yAxis = null, ?GridLines $majorGridlines = null, ?GridLines $minorGridlines = null)
{ {
$this->name = $name; $this->name = $name;
$this->title = $title; $this->title = $title;
@ -199,7 +190,7 @@ class Chart
* *
* @return $this * @return $this
*/ */
public function setWorksheet(Worksheet $pValue = null) public function setWorksheet(?Worksheet $pValue = null)
{ {
$this->worksheet = $pValue; $this->worksheet = $pValue;
@ -219,8 +210,6 @@ class Chart
/** /**
* Set Title. * Set Title.
* *
* @param Title $title
*
* @return $this * @return $this
*/ */
public function setTitle(Title $title) public function setTitle(Title $title)
@ -243,8 +232,6 @@ class Chart
/** /**
* Set Legend. * Set Legend.
* *
* @param Legend $legend
*
* @return $this * @return $this
*/ */
public function setLegend(Legend $legend) public function setLegend(Legend $legend)
@ -267,8 +254,6 @@ class Chart
/** /**
* Set X-Axis Label. * Set X-Axis Label.
* *
* @param Title $label
*
* @return $this * @return $this
*/ */
public function setXAxisLabel(Title $label) public function setXAxisLabel(Title $label)
@ -291,8 +276,6 @@ class Chart
/** /**
* Set Y-Axis Label. * Set Y-Axis Label.
* *
* @param Title $label
*
* @return $this * @return $this
*/ */
public function setYAxisLabel(Title $label) public function setYAxisLabel(Title $label)
@ -645,7 +628,7 @@ class Chart
return $this->bottomRightYOffset; return $this->bottomRightYOffset;
} }
public function refresh() public function refresh(): void
{ {
if ($this->worksheet !== null) { if ($this->worksheet !== null) {
$this->plotArea->refresh($this->worksheet); $this->plotArea->refresh($this->worksheet);

6
src/PhpSpreadsheet/Chart/DataSeries.php
View File

@ -40,6 +40,10 @@ class DataSeries
const STYLE_MARKER = 'marker'; const STYLE_MARKER = 'marker';
const STYLE_FILLED = 'filled'; const STYLE_FILLED = 'filled';
const EMPTY_AS_GAP = 'gap';
const EMPTY_AS_ZERO = 'zero';
const EMPTY_AS_SPAN = 'span';
/** /**
* Series Plot Type. * Series Plot Type.
* *
@ -369,7 +373,7 @@ class DataSeries
return $this; return $this;
} }
public function refresh(Worksheet $worksheet) public function refresh(Worksheet $worksheet): void
{ {
foreach ($this->plotValues as $plotValues) { foreach ($this->plotValues as $plotValues) {
if ($plotValues !== null) { if ($plotValues !== null) {

6
src/PhpSpreadsheet/Chart/DataSeriesValues.php
View File

@ -115,8 +115,6 @@ class DataSeriesValues
* DataSeriesValues::DATASERIES_TYPE_NUMBER * DataSeriesValues::DATASERIES_TYPE_NUMBER
* Normally used for chart data values * Normally used for chart data values
* *
* @throws Exception
*
* @return $this * @return $this
*/ */
public function setDataType($dataType) public function setDataType($dataType)
@ -247,8 +245,6 @@ class DataSeriesValues
* *
* @param string $color value for color * @param string $color value for color
* *
* @throws \Exception thrown if color is invalid
*
* @return bool true if validation was successful * @return bool true if validation was successful
*/ */
private function validateColor($color) private function validateColor($color)
@ -356,7 +352,7 @@ class DataSeriesValues
return $this; return $this;
} }
public function refresh(Worksheet $worksheet, $flatten = true) public function refresh(Worksheet $worksheet, $flatten = true): void
{ {
if ($this->dataSource !== null) { if ($this->dataSource !== null) {
$calcEngine = Calculation::getInstance($worksheet->getParent()); $calcEngine = Calculation::getInstance($worksheet->getParent());

11
src/PhpSpreadsheet/Chart/GridLines.php
View File

@ -107,7 +107,7 @@ class GridLines extends Properties
* @param int $alpha * @param int $alpha
* @param string $type * @param string $type
*/ */
public function setLineColorProperties($value, $alpha = 0, $type = self::EXCEL_COLOR_TYPE_STANDARD) public function setLineColorProperties($value, $alpha = 0, $type = self::EXCEL_COLOR_TYPE_STANDARD): void
{ {
$this->activateObject() $this->activateObject()
->lineProperties['color'] = $this->setColorProperties( ->lineProperties['color'] = $this->setColorProperties(
@ -130,7 +130,7 @@ class GridLines extends Properties
* @param string $end_arrow_type * @param string $end_arrow_type
* @param string $end_arrow_size * @param string $end_arrow_size
*/ */
public function setLineStyleProperties($line_width = null, $compound_type = null, $dash_type = null, $cap_type = null, $join_type = null, $head_arrow_type = null, $head_arrow_size = null, $end_arrow_type = null, $end_arrow_size = null) public function setLineStyleProperties($line_width = null, $compound_type = null, $dash_type = null, $cap_type = null, $join_type = null, $head_arrow_type = null, $head_arrow_size = null, $end_arrow_type = null, $end_arrow_size = null): void
{ {
$this->activateObject(); $this->activateObject();
($line_width !== null) ($line_width !== null)
@ -194,7 +194,7 @@ class GridLines extends Properties
* @param int $color_alpha * @param int $color_alpha
* @param string $color_type * @param string $color_type
*/ */
public function setGlowProperties($size, $color_value = null, $color_alpha = null, $color_type = null) public function setGlowProperties($size, $color_value = null, $color_alpha = null, $color_type = null): void
{ {
$this $this
->activateObject() ->activateObject()
@ -286,7 +286,7 @@ class GridLines extends Properties
* @param int $sh_angle * @param int $sh_angle
* @param float $sh_distance * @param float $sh_distance
*/ */
public function setShadowProperties($sh_presets, $sh_color_value = null, $sh_color_type = null, $sh_color_alpha = null, $sh_blur = null, $sh_angle = null, $sh_distance = null) public function setShadowProperties($sh_presets, $sh_color_value = null, $sh_color_type = null, $sh_color_alpha = null, $sh_blur = null, $sh_angle = null, $sh_distance = null): void
{ {
$this->activateObject() $this->activateObject()
->setShadowPresetsProperties((int) $sh_presets) ->setShadowPresetsProperties((int) $sh_presets)
@ -318,7 +318,6 @@ class GridLines extends Properties
/** /**
* Set Shadow Properties Values. * Set Shadow Properties Values.
* *
* @param array $properties_map
* @param mixed &$reference * @param mixed &$reference
* *
* @return $this * @return $this
@ -435,7 +434,7 @@ class GridLines extends Properties
* *
* @param float $size * @param float $size
*/ */
public function setSoftEdgesSize($size) public function setSoftEdgesSize($size): void
{ {
if ($size !== null) { if ($size !== null) {
$this->activateObject(); $this->activateObject();

2
src/PhpSpreadsheet/Chart/Layout.php
View File

@ -110,8 +110,6 @@ class Layout
/** /**
* Create a new Layout. * Create a new Layout.
*
* @param array $layout
*/ */
public function __construct(array $layout = []) public function __construct(array $layout = [])
{ {

3
src/PhpSpreadsheet/Chart/Legend.php
View File

@ -52,10 +52,9 @@ class Legend
* Create a new Legend. * Create a new Legend.
* *
* @param string $position * @param string $position
* @param null|Layout $layout
* @param bool $overlay * @param bool $overlay
*/ */
public function __construct($position = self::POSITION_RIGHT, Layout $layout = null, $overlay = false) public function __construct($position = self::POSITION_RIGHT, ?Layout $layout = null, $overlay = false)
{ {
$this->setPosition($position); $this->setPosition($position);
$this->layout = $layout; $this->layout = $layout;

5
src/PhpSpreadsheet/Chart/PlotArea.php
View File

@ -23,10 +23,9 @@ class PlotArea
/** /**
* Create a new PlotArea. * Create a new PlotArea.
* *
* @param null|Layout $layout
* @param DataSeries[] $plotSeries * @param DataSeries[] $plotSeries
*/ */
public function __construct(Layout $layout = null, array $plotSeries = []) public function __construct(?Layout $layout = null, array $plotSeries = [])
{ {
$this->layout = $layout; $this->layout = $layout;
$this->plotSeries = $plotSeries; $this->plotSeries = $plotSeries;
@ -103,7 +102,7 @@ class PlotArea
return $this; return $this;
} }
public function refresh(Worksheet $worksheet) public function refresh(Worksheet $worksheet): void
{ {
foreach ($this->plotSeries as $plotSeries) { foreach ($this->plotSeries as $plotSeries) {
$plotSeries->refresh($worksheet); $plotSeries->refresh($worksheet);

2
src/PhpSpreadsheet/Chart/Renderer/IRenderer.php
View File

@ -8,8 +8,6 @@ interface IRenderer
{ {
/** /**
* IRenderer constructor. * IRenderer constructor.
*
* @param \PhpOffice\PhpSpreadsheet\Chart\Chart $chart
*/ */
public function __construct(Chart $chart); public function __construct(Chart $chart);

96
src/PhpSpreadsheet/Chart/Renderer/JpGraph.php
View File

@ -2,8 +2,24 @@
namespace PhpOffice\PhpSpreadsheet\Chart\Renderer; namespace PhpOffice\PhpSpreadsheet\Chart\Renderer;
use AccBarPlot;
use AccLinePlot;
use BarPlot;
use ContourPlot;
use Graph;
use GroupBarPlot;
use LinePlot;
use PhpOffice\PhpSpreadsheet\Chart\Chart; use PhpOffice\PhpSpreadsheet\Chart\Chart;
use PhpOffice\PhpSpreadsheet\Style\NumberFormat; use PhpOffice\PhpSpreadsheet\Style\NumberFormat;
use PieGraph;
use PiePlot;
use PiePlot3D;
use PiePlotC;
use RadarGraph;
use RadarPlot;
use ScatterPlot;
use Spline;
use StockPlot;
require_once __DIR__ . '/Polyfill.php'; require_once __DIR__ . '/Polyfill.php';
@ -33,8 +49,6 @@ class JpGraph implements IRenderer
/** /**
* Create a new jpgraph. * Create a new jpgraph.
*
* @param Chart $chart
*/ */
public function __construct(Chart $chart) public function __construct(Chart $chart)
{ {
@ -43,7 +57,7 @@ class JpGraph implements IRenderer
$this->chart = $chart; $this->chart = $chart;
} }
private static function init() private static function init(): void
{ {
static $loaded = false; static $loaded = false;
if ($loaded) { if ($loaded) {
@ -179,7 +193,7 @@ class JpGraph implements IRenderer
return $caption; return $caption;
} }
private function renderTitle() private function renderTitle(): void
{ {
$title = $this->getCaption($this->chart->getTitle()); $title = $this->getCaption($this->chart->getTitle());
if ($title !== null) { if ($title !== null) {
@ -187,7 +201,7 @@ class JpGraph implements IRenderer
} }
} }
private function renderLegend() private function renderLegend(): void
{ {
$legend = $this->chart->getLegend(); $legend = $this->chart->getLegend();
if ($legend !== null) { if ($legend !== null) {
@ -220,9 +234,9 @@ class JpGraph implements IRenderer
} }
} }
private function renderCartesianPlotArea($type = 'textlin') private function renderCartesianPlotArea($type = 'textlin'): void
{ {
$this->graph = new \Graph(self::$width, self::$height); $this->graph = new Graph(self::$width, self::$height);
$this->graph->SetScale($type); $this->graph->SetScale($type);
$this->renderTitle(); $this->renderTitle();
@ -257,22 +271,22 @@ class JpGraph implements IRenderer
} }
} }
private function renderPiePlotArea() private function renderPiePlotArea(): void
{ {
$this->graph = new \PieGraph(self::$width, self::$height); $this->graph = new PieGraph(self::$width, self::$height);
$this->renderTitle(); $this->renderTitle();
} }
private function renderRadarPlotArea() private function renderRadarPlotArea(): void
{ {
$this->graph = new \RadarGraph(self::$width, self::$height); $this->graph = new RadarGraph(self::$width, self::$height);
$this->graph->SetScale('lin'); $this->graph->SetScale('lin');
$this->renderTitle(); $this->renderTitle();
} }
private function renderPlotLine($groupID, $filled = false, $combination = false, $dimensions = '2d') private function renderPlotLine($groupID, $filled = false, $combination = false, $dimensions = '2d'): void
{ {
$grouping = $this->chart->getPlotArea()->getPlotGroupByIndex($groupID)->getPlotGrouping(); $grouping = $this->chart->getPlotArea()->getPlotGroupByIndex($groupID)->getPlotGrouping();
@ -308,7 +322,7 @@ class JpGraph implements IRenderer
++$testCurrentIndex; ++$testCurrentIndex;
} }
$seriesPlot = new \LinePlot($dataValues); $seriesPlot = new LinePlot($dataValues);
if ($combination) { if ($combination) {
$seriesPlot->SetBarCenter(); $seriesPlot->SetBarCenter();
} }
@ -330,12 +344,12 @@ class JpGraph implements IRenderer
if ($grouping == 'standard') { if ($grouping == 'standard') {
$groupPlot = $seriesPlots; $groupPlot = $seriesPlots;
} else { } else {
$groupPlot = new \AccLinePlot($seriesPlots); $groupPlot = new AccLinePlot($seriesPlots);
} }
$this->graph->Add($groupPlot); $this->graph->Add($groupPlot);
} }
private function renderPlotBar($groupID, $dimensions = '2d') private function renderPlotBar($groupID, $dimensions = '2d'): void
{ {
$rotation = $this->chart->getPlotArea()->getPlotGroupByIndex($groupID)->getPlotDirection(); $rotation = $this->chart->getPlotArea()->getPlotGroupByIndex($groupID)->getPlotDirection();
// Rotate for bar rather than column chart // Rotate for bar rather than column chart
@ -385,7 +399,7 @@ class JpGraph implements IRenderer
if ($rotation == 'bar') { if ($rotation == 'bar') {
$dataValues = array_reverse($dataValues); $dataValues = array_reverse($dataValues);
} }
$seriesPlot = new \BarPlot($dataValues); $seriesPlot = new BarPlot($dataValues);
$seriesPlot->SetColor('black'); $seriesPlot->SetColor('black');
$seriesPlot->SetFillColor(self::$colourSet[self::$plotColour++]); $seriesPlot->SetFillColor(self::$colourSet[self::$plotColour++]);
if ($dimensions == '3d') { if ($dimensions == '3d') {
@ -406,11 +420,11 @@ class JpGraph implements IRenderer
} }
if ($grouping == 'clustered') { if ($grouping == 'clustered') {
$groupPlot = new \GroupBarPlot($seriesPlots); $groupPlot = new GroupBarPlot($seriesPlots);
} elseif ($grouping == 'standard') { } elseif ($grouping == 'standard') {
$groupPlot = new \GroupBarPlot($seriesPlots); $groupPlot = new GroupBarPlot($seriesPlots);
} else { } else {
$groupPlot = new \AccBarPlot($seriesPlots); $groupPlot = new AccBarPlot($seriesPlots);
if ($dimensions == '3d') { if ($dimensions == '3d') {
$groupPlot->SetShadow(); $groupPlot->SetShadow();
} }
@ -419,7 +433,7 @@ class JpGraph implements IRenderer
$this->graph->Add($groupPlot); $this->graph->Add($groupPlot);
} }
private function renderPlotScatter($groupID, $bubble) private function renderPlotScatter($groupID, $bubble): void
{ {
$grouping = $this->chart->getPlotArea()->getPlotGroupByIndex($groupID)->getPlotGrouping(); $grouping = $this->chart->getPlotArea()->getPlotGroupByIndex($groupID)->getPlotGrouping();
$scatterStyle = $bubbleSize = $this->chart->getPlotArea()->getPlotGroupByIndex($groupID)->getPlotStyle(); $scatterStyle = $bubbleSize = $this->chart->getPlotArea()->getPlotGroupByIndex($groupID)->getPlotStyle();
@ -436,14 +450,14 @@ class JpGraph implements IRenderer
$dataValuesY[$k] = $k; $dataValuesY[$k] = $k;
} }
$seriesPlot = new \ScatterPlot($dataValuesX, $dataValuesY); $seriesPlot = new ScatterPlot($dataValuesX, $dataValuesY);
if ($scatterStyle == 'lineMarker') { if ($scatterStyle == 'lineMarker') {
$seriesPlot->SetLinkPoints(); $seriesPlot->SetLinkPoints();
$seriesPlot->link->SetColor(self::$colourSet[self::$plotColour]); $seriesPlot->link->SetColor(self::$colourSet[self::$plotColour]);
} elseif ($scatterStyle == 'smoothMarker') { } elseif ($scatterStyle == 'smoothMarker') {
$spline = new \Spline($dataValuesY, $dataValuesX); $spline = new Spline($dataValuesY, $dataValuesX);
[$splineDataY, $splineDataX] = $spline->Get(count($dataValuesX) * self::$width / 20); [$splineDataY, $splineDataX] = $spline->Get(count($dataValuesX) * self::$width / 20);
$lplot = new \LinePlot($splineDataX, $splineDataY); $lplot = new LinePlot($splineDataX, $splineDataY);
$lplot->SetColor(self::$colourSet[self::$plotColour]); $lplot->SetColor(self::$colourSet[self::$plotColour]);
$this->graph->Add($lplot); $this->graph->Add($lplot);
@ -464,7 +478,7 @@ class JpGraph implements IRenderer
} }
} }
private function renderPlotRadar($groupID) private function renderPlotRadar($groupID): void
{ {
$radarStyle = $this->chart->getPlotArea()->getPlotGroupByIndex($groupID)->getPlotStyle(); $radarStyle = $this->chart->getPlotArea()->getPlotGroupByIndex($groupID)->getPlotStyle();
@ -488,7 +502,7 @@ class JpGraph implements IRenderer
$this->graph->SetTitles(array_reverse($dataValues)); $this->graph->SetTitles(array_reverse($dataValues));
$seriesPlot = new \RadarPlot(array_reverse($dataValuesX)); $seriesPlot = new RadarPlot(array_reverse($dataValuesX));
$dataLabel = $this->chart->getPlotArea()->getPlotGroupByIndex($groupID)->getPlotLabelByIndex($i)->getDataValue(); $dataLabel = $this->chart->getPlotArea()->getPlotGroupByIndex($groupID)->getPlotLabelByIndex($i)->getDataValue();
$seriesPlot->SetColor(self::$colourSet[self::$plotColour++]); $seriesPlot->SetColor(self::$colourSet[self::$plotColour++]);
@ -502,7 +516,7 @@ class JpGraph implements IRenderer
} }
} }
private function renderPlotContour($groupID) private function renderPlotContour($groupID): void
{ {
$contourStyle = $this->chart->getPlotArea()->getPlotGroupByIndex($groupID)->getPlotStyle(); $contourStyle = $this->chart->getPlotArea()->getPlotGroupByIndex($groupID)->getPlotStyle();
@ -517,12 +531,12 @@ class JpGraph implements IRenderer
$dataValues[$i] = $dataValuesX; $dataValues[$i] = $dataValuesX;
} }
$seriesPlot = new \ContourPlot($dataValues); $seriesPlot = new ContourPlot($dataValues);
$this->graph->Add($seriesPlot); $this->graph->Add($seriesPlot);
} }
private function renderPlotStock($groupID) private function renderPlotStock($groupID): void
{ {
$seriesCount = $this->chart->getPlotArea()->getPlotGroupByIndex($groupID)->getPlotSeriesCount(); $seriesCount = $this->chart->getPlotArea()->getPlotGroupByIndex($groupID)->getPlotSeriesCount();
$plotOrder = $this->chart->getPlotArea()->getPlotGroupByIndex($groupID)->getPlotOrder(); $plotOrder = $this->chart->getPlotArea()->getPlotGroupByIndex($groupID)->getPlotOrder();
@ -556,13 +570,13 @@ class JpGraph implements IRenderer
$this->graph->xaxis->SetTickLabels($datasetLabels); $this->graph->xaxis->SetTickLabels($datasetLabels);
} }
$seriesPlot = new \StockPlot($dataValuesPlot); $seriesPlot = new StockPlot($dataValuesPlot);
$seriesPlot->SetWidth(20); $seriesPlot->SetWidth(20);
$this->graph->Add($seriesPlot); $this->graph->Add($seriesPlot);
} }
private function renderAreaChart($groupCount, $dimensions = '2d') private function renderAreaChart($groupCount, $dimensions = '2d'): void
{ {
$this->renderCartesianPlotArea(); $this->renderCartesianPlotArea();
@ -571,7 +585,7 @@ class JpGraph implements IRenderer
} }
} }
private function renderLineChart($groupCount, $dimensions = '2d') private function renderLineChart($groupCount, $dimensions = '2d'): void
{ {
$this->renderCartesianPlotArea(); $this->renderCartesianPlotArea();
@ -580,7 +594,7 @@ class JpGraph implements IRenderer
} }
} }
private function renderBarChart($groupCount, $dimensions = '2d') private function renderBarChart($groupCount, $dimensions = '2d'): void
{ {
$this->renderCartesianPlotArea(); $this->renderCartesianPlotArea();
@ -589,7 +603,7 @@ class JpGraph implements IRenderer
} }
} }
private function renderScatterChart($groupCount) private function renderScatterChart($groupCount): void
{ {
$this->renderCartesianPlotArea('linlin'); $this->renderCartesianPlotArea('linlin');
@ -598,7 +612,7 @@ class JpGraph implements IRenderer
} }
} }
private function renderBubbleChart($groupCount) private function renderBubbleChart($groupCount): void
{ {
$this->renderCartesianPlotArea('linlin'); $this->renderCartesianPlotArea('linlin');
@ -607,7 +621,7 @@ class JpGraph implements IRenderer
} }
} }
private function renderPieChart($groupCount, $dimensions = '2d', $doughnut = false, $multiplePlots = false) private function renderPieChart($groupCount, $dimensions = '2d', $doughnut = false, $multiplePlots = false): void
{ {
$this->renderPiePlotArea(); $this->renderPiePlotArea();
@ -643,12 +657,12 @@ class JpGraph implements IRenderer
} }
if ($dimensions == '3d') { if ($dimensions == '3d') {
$seriesPlot = new \PiePlot3D($dataValues); $seriesPlot = new PiePlot3D($dataValues);
} else { } else {
if ($doughnut) { if ($doughnut) {
$seriesPlot = new \PiePlotC($dataValues); $seriesPlot = new PiePlotC($dataValues);
} else { } else {
$seriesPlot = new \PiePlot($dataValues); $seriesPlot = new PiePlot($dataValues);
} }
} }
@ -679,7 +693,7 @@ class JpGraph implements IRenderer
} }
} }
private function renderRadarChart($groupCount) private function renderRadarChart($groupCount): void
{ {
$this->renderRadarPlotArea(); $this->renderRadarPlotArea();
@ -688,7 +702,7 @@ class JpGraph implements IRenderer
} }
} }
private function renderStockChart($groupCount) private function renderStockChart($groupCount): void
{ {
$this->renderCartesianPlotArea('intint'); $this->renderCartesianPlotArea('intint');
@ -697,7 +711,7 @@ class JpGraph implements IRenderer
} }
} }
private function renderContourChart($groupCount, $dimensions) private function renderContourChart($groupCount, $dimensions): void
{ {
$this->renderCartesianPlotArea('intint'); $this->renderCartesianPlotArea('intint');

2
src/PhpSpreadsheet/Chart/Renderer/Polyfill.php
View File

@ -2,7 +2,7 @@
// This is a dirty workaround to output JpGraph charts even when antialiasing is not available // This is a dirty workaround to output JpGraph charts even when antialiasing is not available
if (!function_exists('imageantialias')) { if (!function_exists('imageantialias')) {
function imageantialias(...$args) function imageantialias(...$args): void
{ {
// Do nothing // Do nothing
} }

3
src/PhpSpreadsheet/Chart/Title.php
View File

@ -22,9 +22,8 @@ class Title
* Create a new Title. * Create a new Title.
* *
* @param null|mixed $caption * @param null|mixed $caption
* @param null|Layout $layout
*/ */
public function __construct($caption = null, Layout $layout = null) public function __construct($caption = null, ?Layout $layout = null)
{ {
$this->caption = $caption; $this->caption = $caption;
$this->layout = $layout; $this->layout = $layout;

24
src/PhpSpreadsheet/Collection/Cells.php
View File

@ -2,6 +2,7 @@
namespace PhpOffice\PhpSpreadsheet\Collection; namespace PhpOffice\PhpSpreadsheet\Collection;
use Generator;
use PhpOffice\PhpSpreadsheet\Cell\Cell; use PhpOffice\PhpSpreadsheet\Cell\Cell;
use PhpOffice\PhpSpreadsheet\Cell\Coordinate; use PhpOffice\PhpSpreadsheet\Cell\Coordinate;
use PhpOffice\PhpSpreadsheet\Exception as PhpSpreadsheetException; use PhpOffice\PhpSpreadsheet\Exception as PhpSpreadsheetException;
@ -61,7 +62,6 @@ class Cells
* Initialise this new cell collection. * Initialise this new cell collection.
* *
* @param Worksheet $parent The worksheet for this cell collection * @param Worksheet $parent The worksheet for this cell collection
* @param CacheInterface $cache
*/ */
public function __construct(Worksheet $parent, CacheInterface $cache) public function __construct(Worksheet $parent, CacheInterface $cache)
{ {
@ -105,8 +105,6 @@ class Cells
* *
* @param Cell $cell Cell to update * @param Cell $cell Cell to update
* *
* @throws PhpSpreadsheetException
*
* @return Cell * @return Cell
*/ */
public function update(Cell $cell) public function update(Cell $cell)
@ -119,7 +117,7 @@ class Cells
* *
* @param string $pCoord Coordinate of the cell to delete * @param string $pCoord Coordinate of the cell to delete
*/ */
public function delete($pCoord) public function delete($pCoord): void
{ {
if ($pCoord === $this->currentCoordinate && $this->currentCell !== null) { if ($pCoord === $this->currentCoordinate && $this->currentCell !== null) {
$this->currentCell->detach(); $this->currentCell->detach();
@ -348,7 +346,7 @@ class Cells
* *
* @param string $row Row number to remove * @param string $row Row number to remove
*/ */
public function removeRow($row) public function removeRow($row): void
{ {
foreach ($this->getCoordinates() as $coord) { foreach ($this->getCoordinates() as $coord) {
$c = ''; $c = '';
@ -366,7 +364,7 @@ class Cells
* *
* @param string $column Column ID to remove * @param string $column Column ID to remove
*/ */
public function removeColumn($column) public function removeColumn($column): void
{ {
foreach ($this->getCoordinates() as $coord) { foreach ($this->getCoordinates() as $coord) {
$c = ''; $c = '';
@ -382,10 +380,8 @@ class Cells
/** /**
* Store cell data in cache for the current cell object if it's "dirty", * Store cell data in cache for the current cell object if it's "dirty",
* and the 'nullify' the current cell object. * and the 'nullify' the current cell object.
*
* @throws PhpSpreadsheetException
*/ */
private function storeCurrentCell() private function storeCurrentCell(): void
{ {
if ($this->currentCellIsDirty && !empty($this->currentCoordinate)) { if ($this->currentCellIsDirty && !empty($this->currentCoordinate)) {
$this->currentCell->detach(); $this->currentCell->detach();
@ -409,8 +405,6 @@ class Cells
* @param string $pCoord Coordinate of the cell to update * @param string $pCoord Coordinate of the cell to update
* @param Cell $cell Cell to update * @param Cell $cell Cell to update
* *
* @throws PhpSpreadsheetException
*
* @return \PhpOffice\PhpSpreadsheet\Cell\Cell * @return \PhpOffice\PhpSpreadsheet\Cell\Cell
*/ */
public function add($pCoord, Cell $cell) public function add($pCoord, Cell $cell)
@ -432,9 +426,7 @@ class Cells
* *
* @param string $pCoord Coordinate of the cell * @param string $pCoord Coordinate of the cell
* *
* @throws PhpSpreadsheetException * @return null|\PhpOffice\PhpSpreadsheet\Cell\Cell Cell that was found, or null if not found
*
* @return \PhpOffice\PhpSpreadsheet\Cell\Cell Cell that was found, or null if not found
*/ */
public function get($pCoord) public function get($pCoord)
{ {
@ -467,7 +459,7 @@ class Cells
/** /**
* Clear the cell collection and disconnect from our parent. * Clear the cell collection and disconnect from our parent.
*/ */
public function unsetWorksheetCells() public function unsetWorksheetCells(): void
{ {
if ($this->currentCell !== null) { if ($this->currentCell !== null) {
$this->currentCell->detach(); $this->currentCell->detach();
@ -495,7 +487,7 @@ class Cells
/** /**
* Returns all known cache keys. * Returns all known cache keys.
* *
* @return \Generator|string[] * @return Generator|string[]
*/ */
private function getAllCacheKeys() private function getAllCacheKeys()
{ {

2
src/PhpSpreadsheet/Comment.php
View File

@ -118,8 +118,6 @@ class Comment implements IComparable
/** /**
* Set Rich text comment. * Set Rich text comment.
* *
* @param RichText $pValue
*
* @return $this * @return $this
*/ */
public function setText(RichText $pValue) public function setText(RichText $pValue)

16
src/PhpSpreadsheet/DocumentGenerator.php
View File

@ -5,17 +5,12 @@ namespace PhpOffice\PhpSpreadsheet;
use PhpOffice\PhpSpreadsheet\Calculation\Category; use PhpOffice\PhpSpreadsheet\Calculation\Category;
use PhpOffice\PhpSpreadsheet\Calculation\Functions; use PhpOffice\PhpSpreadsheet\Calculation\Functions;
use ReflectionClass; use ReflectionClass;
use ReflectionException;
use UnexpectedValueException; use UnexpectedValueException;
class DocumentGenerator class DocumentGenerator
{ {
/** /**
* @param array[] $phpSpreadsheetFunctions * @param array[] $phpSpreadsheetFunctions
*
* @throws ReflectionException
*
* @return string
*/ */
public static function generateFunctionListByCategory(array $phpSpreadsheetFunctions): string public static function generateFunctionListByCategory(array $phpSpreadsheetFunctions): string
{ {
@ -38,17 +33,12 @@ class DocumentGenerator
return $result; return $result;
} }
/**
* @throws ReflectionException
*
* @return array
*/
private static function getCategories(): array private static function getCategories(): array
{ {
return (new ReflectionClass(Category::class))->getConstants(); return (new ReflectionClass(Category::class))->getConstants();
} }
private static function tableRow(array $lengths, array $values = null): string private static function tableRow(array $lengths, ?array $values = null): string
{ {
$result = ''; $result = '';
foreach (array_map(null, $lengths, $values ?? []) as $i => [$length, $value]) { foreach (array_map(null, $lengths, $values ?? []) as $i => [$length, $value]) {
@ -81,10 +71,6 @@ class DocumentGenerator
/** /**
* @param array[] $phpSpreadsheetFunctions * @param array[] $phpSpreadsheetFunctions
*
* @throws ReflectionException
*
* @return string
*/ */
public static function generateFunctionListByName(array $phpSpreadsheetFunctions): string public static function generateFunctionListByName(array $phpSpreadsheetFunctions): string
{ {

12
src/PhpSpreadsheet/HashTable.php
View File

@ -22,8 +22,6 @@ class HashTable
* Create a new \PhpOffice\PhpSpreadsheet\HashTable. * Create a new \PhpOffice\PhpSpreadsheet\HashTable.
* *
* @param IComparable[] $pSource Optional source array to create HashTable from * @param IComparable[] $pSource Optional source array to create HashTable from
*
* @throws Exception
*/ */
public function __construct($pSource = null) public function __construct($pSource = null)
{ {
@ -37,10 +35,8 @@ class HashTable
* Add HashTable items from source. * Add HashTable items from source.
* *
* @param IComparable[] $pSource Source array to create HashTable from * @param IComparable[] $pSource Source array to create HashTable from
*
* @throws Exception
*/ */
public function addFromSource(array $pSource = null) public function addFromSource(?array $pSource = null): void
{ {
// Check if an array was passed // Check if an array was passed
if ($pSource == null) { if ($pSource == null) {
@ -57,7 +53,7 @@ class HashTable
* *
* @param IComparable $pSource Item to add * @param IComparable $pSource Item to add
*/ */
public function add(IComparable $pSource) public function add(IComparable $pSource): void
{ {
$hash = $pSource->getHashCode(); $hash = $pSource->getHashCode();
if (!isset($this->items[$hash])) { if (!isset($this->items[$hash])) {
@ -71,7 +67,7 @@ class HashTable
* *
* @param IComparable $pSource Item to remove * @param IComparable $pSource Item to remove
*/ */
public function remove(IComparable $pSource) public function remove(IComparable $pSource): void
{ {
$hash = $pSource->getHashCode(); $hash = $pSource->getHashCode();
if (isset($this->items[$hash])) { if (isset($this->items[$hash])) {
@ -94,7 +90,7 @@ class HashTable
/** /**
* Clear HashTable. * Clear HashTable.
*/ */
public function clear() public function clear(): void
{ {
$this->items = []; $this->items = [];
$this->keyMap = []; $this->keyMap = [];

48
src/PhpSpreadsheet/Helper/Html.php
View File

@ -593,7 +593,7 @@ class Html
*/ */
protected $richTextObject; protected $richTextObject;
protected function initialise() protected function initialise(): void
{ {
$this->face = $this->size = $this->color = null; $this->face = $this->size = $this->color = null;
$this->bold = $this->italic = $this->underline = $this->superscript = $this->subscript = $this->strikethrough = false; $this->bold = $this->italic = $this->underline = $this->superscript = $this->subscript = $this->strikethrough = false;
@ -632,7 +632,7 @@ class Html
return $this->richTextObject; return $this->richTextObject;
} }
protected function cleanWhitespace() protected function cleanWhitespace(): void
{ {
foreach ($this->richTextObject->getRichTextElements() as $key => $element) { foreach ($this->richTextObject->getRichTextElements() as $key => $element) {
$text = $element->getText(); $text = $element->getText();
@ -646,7 +646,7 @@ class Html
} }
} }
protected function buildTextRun() protected function buildTextRun(): void
{ {
$text = $this->stringData; $text = $this->stringData;
if (trim($text) === '') { if (trim($text) === '') {
@ -691,7 +691,7 @@ class Html
$value = str_pad(dechex($value), 2, '0', STR_PAD_LEFT); $value = str_pad(dechex($value), 2, '0', STR_PAD_LEFT);
} }
return implode($values[0]); return implode('', $values[0]);
} }
protected function colourNameLookup($rgb) protected function colourNameLookup($rgb)
@ -699,7 +699,7 @@ class Html
return self::$colourMap[$rgb]; return self::$colourMap[$rgb];
} }
protected function startFontTag($tag) protected function startFontTag($tag): void
{ {
foreach ($tag->attributes as $attribute) { foreach ($tag->attributes as $attribute) {
$attributeName = strtolower($attribute->name); $attributeName = strtolower($attribute->name);
@ -719,77 +719,77 @@ class Html
} }
} }
protected function endFontTag() protected function endFontTag(): void
{ {
$this->face = $this->size = $this->color = null; $this->face = $this->size = $this->color = null;
} }
protected function startBoldTag() protected function startBoldTag(): void
{ {
$this->bold = true; $this->bold = true;
} }
protected function endBoldTag() protected function endBoldTag(): void
{ {
$this->bold = false; $this->bold = false;
} }
protected function startItalicTag() protected function startItalicTag(): void
{ {
$this->italic = true; $this->italic = true;
} }
protected function endItalicTag() protected function endItalicTag(): void
{ {
$this->italic = false; $this->italic = false;
} }
protected function startUnderlineTag() protected function startUnderlineTag(): void
{ {
$this->underline = true; $this->underline = true;
} }
protected function endUnderlineTag() protected function endUnderlineTag(): void
{ {
$this->underline = false; $this->underline = false;
} }
protected function startSubscriptTag() protected function startSubscriptTag(): void
{ {
$this->subscript = true; $this->subscript = true;
} }
protected function endSubscriptTag() protected function endSubscriptTag(): void
{ {
$this->subscript = false; $this->subscript = false;
} }
protected function startSuperscriptTag() protected function startSuperscriptTag(): void
{ {
$this->superscript = true; $this->superscript = true;
} }
protected function endSuperscriptTag() protected function endSuperscriptTag(): void
{ {
$this->superscript = false; $this->superscript = false;
} }
protected function startStrikethruTag() protected function startStrikethruTag(): void
{ {
$this->strikethrough = true; $this->strikethrough = true;
} }
protected function endStrikethruTag() protected function endStrikethruTag(): void
{ {
$this->strikethrough = false; $this->strikethrough = false;
} }
protected function breakTag() protected function breakTag(): void
{ {
$this->stringData .= "\n"; $this->stringData .= "\n";
} }
protected function parseTextNode(DOMText $textNode) protected function parseTextNode(DOMText $textNode): void
{ {
$domText = preg_replace( $domText = preg_replace(
'/\s+/u', '/\s+/u',
@ -801,11 +801,9 @@ class Html
} }
/** /**
* @param DOMElement $element
* @param string $callbackTag * @param string $callbackTag
* @param array $callbacks
*/ */
protected function handleCallback(DOMElement $element, $callbackTag, array $callbacks) protected function handleCallback(DOMElement $element, $callbackTag, array $callbacks): void
{ {
if (isset($callbacks[$callbackTag])) { if (isset($callbacks[$callbackTag])) {
$elementHandler = $callbacks[$callbackTag]; $elementHandler = $callbacks[$callbackTag];
@ -815,7 +813,7 @@ class Html
} }
} }
protected function parseElementNode(DOMElement $element) protected function parseElementNode(DOMElement $element): void
{ {
$callbackTag = strtolower($element->nodeName); $callbackTag = strtolower($element->nodeName);
$this->stack[] = $callbackTag; $this->stack[] = $callbackTag;
@ -828,7 +826,7 @@ class Html
$this->handleCallback($element, $callbackTag, $this->endTagCallbacks); $this->handleCallback($element, $callbackTag, $this->endTagCallbacks);
} }
protected function parseElements(DOMNode $element) protected function parseElements(DOMNode $element): void
{ {
foreach ($element->childNodes as $child) { foreach ($element->childNodes as $child) {
if ($child instanceof DOMText) { if ($child instanceof DOMText) {

333
src/PhpSpreadsheet/Helper/Migrator.php
View File

@ -1,333 +0,0 @@
<?php
namespace PhpOffice\PhpSpreadsheet\Helper;
class Migrator
{
/**
* @var string[]
*/
private $from;
/**
* @var string[]
*/
private $to;
public function __construct()
{
$this->from = array_keys($this->getMapping());
$this->to = array_values($this->getMapping());
}
/**
* Return the ordered mapping from old PHPExcel class names to new PhpSpreadsheet one.
*
* @return string[]
*/
public function getMapping()
{
// Order matters here, we should have the deepest namespaces first (the most "unique" strings)
$classes = [
'PHPExcel_Shared_Escher_DggContainer_BstoreContainer_BSE_Blip' => \PhpOffice\PhpSpreadsheet\Shared\Escher\DggContainer\BstoreContainer\BSE\Blip::class,
'PHPExcel_Shared_Escher_DgContainer_SpgrContainer_SpContainer' => \PhpOffice\PhpSpreadsheet\Shared\Escher\DgContainer\SpgrContainer\SpContainer::class,
'PHPExcel_Shared_Escher_DggContainer_BstoreContainer_BSE' => \PhpOffice\PhpSpreadsheet\Shared\Escher\DggContainer\BstoreContainer\BSE::class,
'PHPExcel_Shared_Escher_DgContainer_SpgrContainer' => \PhpOffice\PhpSpreadsheet\Shared\Escher\DgContainer\SpgrContainer::class,
'PHPExcel_Shared_Escher_DggContainer_BstoreContainer' => \PhpOffice\PhpSpreadsheet\Shared\Escher\DggContainer\BstoreContainer::class,
'PHPExcel_Shared_OLE_PPS_File' => \PhpOffice\PhpSpreadsheet\Shared\OLE\PPS\File::class,
'PHPExcel_Shared_OLE_PPS_Root' => \PhpOffice\PhpSpreadsheet\Shared\OLE\PPS\Root::class,
'PHPExcel_Worksheet_AutoFilter_Column_Rule' => \PhpOffice\PhpSpreadsheet\Worksheet\AutoFilter\Column\Rule::class,
'PHPExcel_Writer_OpenDocument_Cell_Comment' => \PhpOffice\PhpSpreadsheet\Writer\Ods\Cell\Comment::class,
'PHPExcel_Calculation_Token_Stack' => \PhpOffice\PhpSpreadsheet\Calculation\Token\Stack::class,
'PHPExcel_Chart_Renderer_jpgraph' => \PhpOffice\PhpSpreadsheet\Chart\Renderer\JpGraph::class,
'PHPExcel_Reader_Excel5_Escher' => \PhpOffice\PhpSpreadsheet\Reader\Xls\Escher::class,
'PHPExcel_Reader_Excel5_MD5' => \PhpOffice\PhpSpreadsheet\Reader\Xls\MD5::class,
'PHPExcel_Reader_Excel5_RC4' => \PhpOffice\PhpSpreadsheet\Reader\Xls\RC4::class,
'PHPExcel_Reader_Excel2007_Chart' => \PhpOffice\PhpSpreadsheet\Reader\Xlsx\Chart::class,
'PHPExcel_Reader_Excel2007_Theme' => \PhpOffice\PhpSpreadsheet\Reader\Xlsx\Theme::class,
'PHPExcel_Shared_Escher_DgContainer' => \PhpOffice\PhpSpreadsheet\Shared\Escher\DgContainer::class,
'PHPExcel_Shared_Escher_DggContainer' => \PhpOffice\PhpSpreadsheet\Shared\Escher\DggContainer::class,
'CholeskyDecomposition' => \PhpOffice\PhpSpreadsheet\Shared\JAMA\CholeskyDecomposition::class,
'EigenvalueDecomposition' => \PhpOffice\PhpSpreadsheet\Shared\JAMA\EigenvalueDecomposition::class,
'PHPExcel_Shared_JAMA_LUDecomposition' => \PhpOffice\PhpSpreadsheet\Shared\JAMA\LUDecomposition::class,
'PHPExcel_Shared_JAMA_Matrix' => \PhpOffice\PhpSpreadsheet\Shared\JAMA\Matrix::class,
'QRDecomposition' => \PhpOffice\PhpSpreadsheet\Shared\JAMA\QRDecomposition::class,
'PHPExcel_Shared_JAMA_QRDecomposition' => \PhpOffice\PhpSpreadsheet\Shared\JAMA\QRDecomposition::class,
'SingularValueDecomposition' => \PhpOffice\PhpSpreadsheet\Shared\JAMA\SingularValueDecomposition::class,
'PHPExcel_Shared_OLE_ChainedBlockStream' => \PhpOffice\PhpSpreadsheet\Shared\OLE\ChainedBlockStream::class,
'PHPExcel_Shared_OLE_PPS' => \PhpOffice\PhpSpreadsheet\Shared\OLE\PPS::class,
'PHPExcel_Best_Fit' => \PhpOffice\PhpSpreadsheet\Shared\Trend\BestFit::class,
'PHPExcel_Exponential_Best_Fit' => \PhpOffice\PhpSpreadsheet\Shared\Trend\ExponentialBestFit::class,
'PHPExcel_Linear_Best_Fit' => \PhpOffice\PhpSpreadsheet\Shared\Trend\LinearBestFit::class,
'PHPExcel_Logarithmic_Best_Fit' => \PhpOffice\PhpSpreadsheet\Shared\Trend\LogarithmicBestFit::class,
'polynomialBestFit' => \PhpOffice\PhpSpreadsheet\Shared\Trend\PolynomialBestFit::class,
'PHPExcel_Polynomial_Best_Fit' => \PhpOffice\PhpSpreadsheet\Shared\Trend\PolynomialBestFit::class,
'powerBestFit' => \PhpOffice\PhpSpreadsheet\Shared\Trend\PowerBestFit::class,
'PHPExcel_Power_Best_Fit' => \PhpOffice\PhpSpreadsheet\Shared\Trend\PowerBestFit::class,
'trendClass' => \PhpOffice\PhpSpreadsheet\Shared\Trend\Trend::class,
'PHPExcel_Worksheet_AutoFilter_Column' => \PhpOffice\PhpSpreadsheet\Worksheet\AutoFilter\Column::class,
'PHPExcel_Worksheet_Drawing_Shadow' => \PhpOffice\PhpSpreadsheet\Worksheet\Drawing\Shadow::class,
'PHPExcel_Writer_OpenDocument_Content' => \PhpOffice\PhpSpreadsheet\Writer\Ods\Content::class,
'PHPExcel_Writer_OpenDocument_Meta' => \PhpOffice\PhpSpreadsheet\Writer\Ods\Meta::class,
'PHPExcel_Writer_OpenDocument_MetaInf' => \PhpOffice\PhpSpreadsheet\Writer\Ods\MetaInf::class,
'PHPExcel_Writer_OpenDocument_Mimetype' => \PhpOffice\PhpSpreadsheet\Writer\Ods\Mimetype::class,
'PHPExcel_Writer_OpenDocument_Settings' => \PhpOffice\PhpSpreadsheet\Writer\Ods\Settings::class,
'PHPExcel_Writer_OpenDocument_Styles' => \PhpOffice\PhpSpreadsheet\Writer\Ods\Styles::class,
'PHPExcel_Writer_OpenDocument_Thumbnails' => \PhpOffice\PhpSpreadsheet\Writer\Ods\Thumbnails::class,
'PHPExcel_Writer_OpenDocument_WriterPart' => \PhpOffice\PhpSpreadsheet\Writer\Ods\WriterPart::class,
'PHPExcel_Writer_PDF_Core' => \PhpOffice\PhpSpreadsheet\Writer\Pdf::class,
'PHPExcel_Writer_PDF_DomPDF' => \PhpOffice\PhpSpreadsheet\Writer\Pdf\Dompdf::class,
'PHPExcel_Writer_PDF_mPDF' => \PhpOffice\PhpSpreadsheet\Writer\Pdf\Mpdf::class,
'PHPExcel_Writer_PDF_tcPDF' => \PhpOffice\PhpSpreadsheet\Writer\Pdf\Tcpdf::class,
'PHPExcel_Writer_Excel5_BIFFwriter' => \PhpOffice\PhpSpreadsheet\Writer\Xls\BIFFwriter::class,
'PHPExcel_Writer_Excel5_Escher' => \PhpOffice\PhpSpreadsheet\Writer\Xls\Escher::class,
'PHPExcel_Writer_Excel5_Font' => \PhpOffice\PhpSpreadsheet\Writer\Xls\Font::class,
'PHPExcel_Writer_Excel5_Parser' => \PhpOffice\PhpSpreadsheet\Writer\Xls\Parser::class,
'PHPExcel_Writer_Excel5_Workbook' => \PhpOffice\PhpSpreadsheet\Writer\Xls\Workbook::class,
'PHPExcel_Writer_Excel5_Worksheet' => \PhpOffice\PhpSpreadsheet\Writer\Xls\Worksheet::class,
'PHPExcel_Writer_Excel5_Xf' => \PhpOffice\PhpSpreadsheet\Writer\Xls\Xf::class,
'PHPExcel_Writer_Excel2007_Chart' => \PhpOffice\PhpSpreadsheet\Writer\Xlsx\Chart::class,
'PHPExcel_Writer_Excel2007_Comments' => \PhpOffice\PhpSpreadsheet\Writer\Xlsx\Comments::class,
'PHPExcel_Writer_Excel2007_ContentTypes' => \PhpOffice\PhpSpreadsheet\Writer\Xlsx\ContentTypes::class,
'PHPExcel_Writer_Excel2007_DocProps' => \PhpOffice\PhpSpreadsheet\Writer\Xlsx\DocProps::class,
'PHPExcel_Writer_Excel2007_Drawing' => \PhpOffice\PhpSpreadsheet\Writer\Xlsx\Drawing::class,
'PHPExcel_Writer_Excel2007_Rels' => \PhpOffice\PhpSpreadsheet\Writer\Xlsx\Rels::class,
'PHPExcel_Writer_Excel2007_RelsRibbon' => \PhpOffice\PhpSpreadsheet\Writer\Xlsx\RelsRibbon::class,
'PHPExcel_Writer_Excel2007_RelsVBA' => \PhpOffice\PhpSpreadsheet\Writer\Xlsx\RelsVBA::class,
'PHPExcel_Writer_Excel2007_StringTable' => \PhpOffice\PhpSpreadsheet\Writer\Xlsx\StringTable::class,
'PHPExcel_Writer_Excel2007_Style' => \PhpOffice\PhpSpreadsheet\Writer\Xlsx\Style::class,
'PHPExcel_Writer_Excel2007_Theme' => \PhpOffice\PhpSpreadsheet\Writer\Xlsx\Theme::class,
'PHPExcel_Writer_Excel2007_Workbook' => \PhpOffice\PhpSpreadsheet\Writer\Xlsx\Workbook::class,
'PHPExcel_Writer_Excel2007_Worksheet' => \PhpOffice\PhpSpreadsheet\Writer\Xlsx\Worksheet::class,
'PHPExcel_Writer_Excel2007_WriterPart' => \PhpOffice\PhpSpreadsheet\Writer\Xlsx\WriterPart::class,
'PHPExcel_CachedObjectStorage_CacheBase' => \PhpOffice\PhpSpreadsheet\Collection\Cells::class,
'PHPExcel_CalcEngine_CyclicReferenceStack' => \PhpOffice\PhpSpreadsheet\Calculation\Engine\CyclicReferenceStack::class,
'PHPExcel_CalcEngine_Logger' => \PhpOffice\PhpSpreadsheet\Calculation\Engine\Logger::class,
'PHPExcel_Calculation_Functions' => \PhpOffice\PhpSpreadsheet\Calculation\Functions::class,
'PHPExcel_Calculation_Function' => \PhpOffice\PhpSpreadsheet\Calculation\Category::class,
'PHPExcel_Calculation_Database' => \PhpOffice\PhpSpreadsheet\Calculation\Database::class,
'PHPExcel_Calculation_DateTime' => \PhpOffice\PhpSpreadsheet\Calculation\DateTime::class,
'PHPExcel_Calculation_Engineering' => \PhpOffice\PhpSpreadsheet\Calculation\Engineering::class,
'PHPExcel_Calculation_Exception' => \PhpOffice\PhpSpreadsheet\Calculation\Exception::class,
'PHPExcel_Calculation_ExceptionHandler' => \PhpOffice\PhpSpreadsheet\Calculation\ExceptionHandler::class,
'PHPExcel_Calculation_Financial' => \PhpOffice\PhpSpreadsheet\Calculation\Financial::class,
'PHPExcel_Calculation_FormulaParser' => \PhpOffice\PhpSpreadsheet\Calculation\FormulaParser::class,
'PHPExcel_Calculation_FormulaToken' => \PhpOffice\PhpSpreadsheet\Calculation\FormulaToken::class,
'PHPExcel_Calculation_Logical' => \PhpOffice\PhpSpreadsheet\Calculation\Logical::class,
'PHPExcel_Calculation_LookupRef' => \PhpOffice\PhpSpreadsheet\Calculation\LookupRef::class,
'PHPExcel_Calculation_MathTrig' => \PhpOffice\PhpSpreadsheet\Calculation\MathTrig::class,
'PHPExcel_Calculation_Statistical' => \PhpOffice\PhpSpreadsheet\Calculation\Statistical::class,
'PHPExcel_Calculation_TextData' => \PhpOffice\PhpSpreadsheet\Calculation\TextData::class,
'PHPExcel_Cell_AdvancedValueBinder' => \PhpOffice\PhpSpreadsheet\Cell\AdvancedValueBinder::class,
'PHPExcel_Cell_DataType' => \PhpOffice\PhpSpreadsheet\Cell\DataType::class,
'PHPExcel_Cell_DataValidation' => \PhpOffice\PhpSpreadsheet\Cell\DataValidation::class,
'PHPExcel_Cell_DefaultValueBinder' => \PhpOffice\PhpSpreadsheet\Cell\DefaultValueBinder::class,
'PHPExcel_Cell_Hyperlink' => \PhpOffice\PhpSpreadsheet\Cell\Hyperlink::class,
'PHPExcel_Cell_IValueBinder' => \PhpOffice\PhpSpreadsheet\Cell\IValueBinder::class,
'PHPExcel_Chart_Axis' => \PhpOffice\PhpSpreadsheet\Chart\Axis::class,
'PHPExcel_Chart_DataSeries' => \PhpOffice\PhpSpreadsheet\Chart\DataSeries::class,
'PHPExcel_Chart_DataSeriesValues' => \PhpOffice\PhpSpreadsheet\Chart\DataSeriesValues::class,
'PHPExcel_Chart_Exception' => \PhpOffice\PhpSpreadsheet\Chart\Exception::class,
'PHPExcel_Chart_GridLines' => \PhpOffice\PhpSpreadsheet\Chart\GridLines::class,
'PHPExcel_Chart_Layout' => \PhpOffice\PhpSpreadsheet\Chart\Layout::class,
'PHPExcel_Chart_Legend' => \PhpOffice\PhpSpreadsheet\Chart\Legend::class,
'PHPExcel_Chart_PlotArea' => \PhpOffice\PhpSpreadsheet\Chart\PlotArea::class,
'PHPExcel_Properties' => \PhpOffice\PhpSpreadsheet\Chart\Properties::class,
'PHPExcel_Chart_Title' => \PhpOffice\PhpSpreadsheet\Chart\Title::class,
'PHPExcel_DocumentProperties' => \PhpOffice\PhpSpreadsheet\Document\Properties::class,
'PHPExcel_DocumentSecurity' => \PhpOffice\PhpSpreadsheet\Document\Security::class,
'PHPExcel_Helper_HTML' => \PhpOffice\PhpSpreadsheet\Helper\Html::class,
'PHPExcel_Reader_Abstract' => \PhpOffice\PhpSpreadsheet\Reader\BaseReader::class,
'PHPExcel_Reader_CSV' => \PhpOffice\PhpSpreadsheet\Reader\Csv::class,
'PHPExcel_Reader_DefaultReadFilter' => \PhpOffice\PhpSpreadsheet\Reader\DefaultReadFilter::class,
'PHPExcel_Reader_Excel2003XML' => \PhpOffice\PhpSpreadsheet\Reader\Xml::class,
'PHPExcel_Reader_Exception' => \PhpOffice\PhpSpreadsheet\Reader\Exception::class,
'PHPExcel_Reader_Gnumeric' => \PhpOffice\PhpSpreadsheet\Reader\Gnumeric::class,
'PHPExcel_Reader_HTML' => \PhpOffice\PhpSpreadsheet\Reader\Html::class,
'PHPExcel_Reader_IReadFilter' => \PhpOffice\PhpSpreadsheet\Reader\IReadFilter::class,
'PHPExcel_Reader_IReader' => \PhpOffice\PhpSpreadsheet\Reader\IReader::class,
'PHPExcel_Reader_OOCalc' => \PhpOffice\PhpSpreadsheet\Reader\Ods::class,
'PHPExcel_Reader_SYLK' => \PhpOffice\PhpSpreadsheet\Reader\Slk::class,
'PHPExcel_Reader_Excel5' => \PhpOffice\PhpSpreadsheet\Reader\Xls::class,
'PHPExcel_Reader_Excel2007' => \PhpOffice\PhpSpreadsheet\Reader\Xlsx::class,
'PHPExcel_RichText_ITextElement' => \PhpOffice\PhpSpreadsheet\RichText\ITextElement::class,
'PHPExcel_RichText_Run' => \PhpOffice\PhpSpreadsheet\RichText\Run::class,
'PHPExcel_RichText_TextElement' => \PhpOffice\PhpSpreadsheet\RichText\TextElement::class,
'PHPExcel_Shared_CodePage' => \PhpOffice\PhpSpreadsheet\Shared\CodePage::class,
'PHPExcel_Shared_Date' => \PhpOffice\PhpSpreadsheet\Shared\Date::class,
'PHPExcel_Shared_Drawing' => \PhpOffice\PhpSpreadsheet\Shared\Drawing::class,
'PHPExcel_Shared_Escher' => \PhpOffice\PhpSpreadsheet\Shared\Escher::class,
'PHPExcel_Shared_File' => \PhpOffice\PhpSpreadsheet\Shared\File::class,
'PHPExcel_Shared_Font' => \PhpOffice\PhpSpreadsheet\Shared\Font::class,
'PHPExcel_Shared_OLE' => \PhpOffice\PhpSpreadsheet\Shared\OLE::class,
'PHPExcel_Shared_OLERead' => \PhpOffice\PhpSpreadsheet\Shared\OLERead::class,
'PHPExcel_Shared_PasswordHasher' => \PhpOffice\PhpSpreadsheet\Shared\PasswordHasher::class,
'PHPExcel_Shared_String' => \PhpOffice\PhpSpreadsheet\Shared\StringHelper::class,
'PHPExcel_Shared_TimeZone' => \PhpOffice\PhpSpreadsheet\Shared\TimeZone::class,
'PHPExcel_Shared_XMLWriter' => \PhpOffice\PhpSpreadsheet\Shared\XMLWriter::class,
'PHPExcel_Shared_Excel5' => \PhpOffice\PhpSpreadsheet\Shared\Xls::class,
'PHPExcel_Style_Alignment' => \PhpOffice\PhpSpreadsheet\Style\Alignment::class,
'PHPExcel_Style_Border' => \PhpOffice\PhpSpreadsheet\Style\Border::class,
'PHPExcel_Style_Borders' => \PhpOffice\PhpSpreadsheet\Style\Borders::class,
'PHPExcel_Style_Color' => \PhpOffice\PhpSpreadsheet\Style\Color::class,
'PHPExcel_Style_Conditional' => \PhpOffice\PhpSpreadsheet\Style\Conditional::class,
'PHPExcel_Style_Fill' => \PhpOffice\PhpSpreadsheet\Style\Fill::class,
'PHPExcel_Style_Font' => \PhpOffice\PhpSpreadsheet\Style\Font::class,
'PHPExcel_Style_NumberFormat' => \PhpOffice\PhpSpreadsheet\Style\NumberFormat::class,
'PHPExcel_Style_Protection' => \PhpOffice\PhpSpreadsheet\Style\Protection::class,
'PHPExcel_Style_Supervisor' => \PhpOffice\PhpSpreadsheet\Style\Supervisor::class,
'PHPExcel_Worksheet_AutoFilter' => \PhpOffice\PhpSpreadsheet\Worksheet\AutoFilter::class,
'PHPExcel_Worksheet_BaseDrawing' => \PhpOffice\PhpSpreadsheet\Worksheet\BaseDrawing::class,
'PHPExcel_Worksheet_CellIterator' => \PhpOffice\PhpSpreadsheet\Worksheet\CellIterator::class,
'PHPExcel_Worksheet_Column' => \PhpOffice\PhpSpreadsheet\Worksheet\Column::class,
'PHPExcel_Worksheet_ColumnCellIterator' => \PhpOffice\PhpSpreadsheet\Worksheet\ColumnCellIterator::class,
'PHPExcel_Worksheet_ColumnDimension' => \PhpOffice\PhpSpreadsheet\Worksheet\ColumnDimension::class,
'PHPExcel_Worksheet_ColumnIterator' => \PhpOffice\PhpSpreadsheet\Worksheet\ColumnIterator::class,
'PHPExcel_Worksheet_Drawing' => \PhpOffice\PhpSpreadsheet\Worksheet\Drawing::class,
'PHPExcel_Worksheet_HeaderFooter' => \PhpOffice\PhpSpreadsheet\Worksheet\HeaderFooter::class,
'PHPExcel_Worksheet_HeaderFooterDrawing' => \PhpOffice\PhpSpreadsheet\Worksheet\HeaderFooterDrawing::class,
'PHPExcel_WorksheetIterator' => \PhpOffice\PhpSpreadsheet\Worksheet\Iterator::class,
'PHPExcel_Worksheet_MemoryDrawing' => \PhpOffice\PhpSpreadsheet\Worksheet\MemoryDrawing::class,
'PHPExcel_Worksheet_PageMargins' => \PhpOffice\PhpSpreadsheet\Worksheet\PageMargins::class,
'PHPExcel_Worksheet_PageSetup' => \PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::class,
'PHPExcel_Worksheet_Protection' => \PhpOffice\PhpSpreadsheet\Worksheet\Protection::class,
'PHPExcel_Worksheet_Row' => \PhpOffice\PhpSpreadsheet\Worksheet\Row::class,
'PHPExcel_Worksheet_RowCellIterator' => \PhpOffice\PhpSpreadsheet\Worksheet\RowCellIterator::class,
'PHPExcel_Worksheet_RowDimension' => \PhpOffice\PhpSpreadsheet\Worksheet\RowDimension::class,
'PHPExcel_Worksheet_RowIterator' => \PhpOffice\PhpSpreadsheet\Worksheet\RowIterator::class,
'PHPExcel_Worksheet_SheetView' => \PhpOffice\PhpSpreadsheet\Worksheet\SheetView::class,
'PHPExcel_Writer_Abstract' => \PhpOffice\PhpSpreadsheet\Writer\BaseWriter::class,
'PHPExcel_Writer_CSV' => \PhpOffice\PhpSpreadsheet\Writer\Csv::class,
'PHPExcel_Writer_Exception' => \PhpOffice\PhpSpreadsheet\Writer\Exception::class,
'PHPExcel_Writer_HTML' => \PhpOffice\PhpSpreadsheet\Writer\Html::class,
'PHPExcel_Writer_IWriter' => \PhpOffice\PhpSpreadsheet\Writer\IWriter::class,
'PHPExcel_Writer_OpenDocument' => \PhpOffice\PhpSpreadsheet\Writer\Ods::class,
'PHPExcel_Writer_PDF' => \PhpOffice\PhpSpreadsheet\Writer\Pdf::class,
'PHPExcel_Writer_Excel5' => \PhpOffice\PhpSpreadsheet\Writer\Xls::class,
'PHPExcel_Writer_Excel2007' => \PhpOffice\PhpSpreadsheet\Writer\Xlsx::class,
'PHPExcel_CachedObjectStorageFactory' => \PhpOffice\PhpSpreadsheet\Collection\CellsFactory::class,
'PHPExcel_Calculation' => \PhpOffice\PhpSpreadsheet\Calculation\Calculation::class,
'PHPExcel_Cell' => \PhpOffice\PhpSpreadsheet\Cell\Cell::class,
'PHPExcel_Chart' => \PhpOffice\PhpSpreadsheet\Chart\Chart::class,
'PHPExcel_Comment' => \PhpOffice\PhpSpreadsheet\Comment::class,
'PHPExcel_Exception' => \PhpOffice\PhpSpreadsheet\Exception::class,
'PHPExcel_HashTable' => \PhpOffice\PhpSpreadsheet\HashTable::class,
'PHPExcel_IComparable' => \PhpOffice\PhpSpreadsheet\IComparable::class,
'PHPExcel_IOFactory' => \PhpOffice\PhpSpreadsheet\IOFactory::class,
'PHPExcel_NamedRange' => \PhpOffice\PhpSpreadsheet\NamedRange::class,
'PHPExcel_ReferenceHelper' => \PhpOffice\PhpSpreadsheet\ReferenceHelper::class,
'PHPExcel_RichText' => \PhpOffice\PhpSpreadsheet\RichText\RichText::class,
'PHPExcel_Settings' => \PhpOffice\PhpSpreadsheet\Settings::class,
'PHPExcel_Style' => \PhpOffice\PhpSpreadsheet\Style\Style::class,
'PHPExcel_Worksheet' => \PhpOffice\PhpSpreadsheet\Worksheet\Worksheet::class,
];
$methods = [
'MINUTEOFHOUR' => 'MINUTE',
'SECONDOFMINUTE' => 'SECOND',
'DAYOFWEEK' => 'WEEKDAY',
'WEEKOFYEAR' => 'WEEKNUM',
'ExcelToPHPObject' => 'excelToDateTimeObject',
'ExcelToPHP' => 'excelToTimestamp',
'FormattedPHPToExcel' => 'formattedPHPToExcel',
'Cell::absoluteCoordinate' => 'Coordinate::absoluteCoordinate',
'Cell::absoluteReference' => 'Coordinate::absoluteReference',
'Cell::buildRange' => 'Coordinate::buildRange',
'Cell::columnIndexFromString' => 'Coordinate::columnIndexFromString',
'Cell::coordinateFromString' => 'Coordinate::coordinateFromString',
'Cell::extractAllCellReferencesInRange' => 'Coordinate::extractAllCellReferencesInRange',
'Cell::getRangeBoundaries' => 'Coordinate::getRangeBoundaries',
'Cell::mergeRangesInCollection' => 'Coordinate::mergeRangesInCollection',
'Cell::rangeBoundaries' => 'Coordinate::rangeBoundaries',
'Cell::rangeDimension' => 'Coordinate::rangeDimension',
'Cell::splitRange' => 'Coordinate::splitRange',
'Cell::stringFromColumnIndex' => 'Coordinate::stringFromColumnIndex',
];
// Keep '\' prefix for class names
$prefixedClasses = [];
foreach ($classes as $key => &$value) {
$value = str_replace('PhpOffice\\', '\\PhpOffice\\', $value);
$prefixedClasses['\\' . $key] = $value;
}
$mapping = $prefixedClasses + $classes + $methods;
return $mapping;
}
/**
* Search in all files in given directory.
*
* @param string $path
*/
private function recursiveReplace($path)
{
$patterns = [
'/*.md',
'/*.txt',
'/*.TXT',
'/*.php',
'/*.phpt',
'/*.php3',
'/*.php4',
'/*.php5',
'/*.phtml',
];
foreach ($patterns as $pattern) {
foreach (glob($path . $pattern) as $file) {
if (strpos($path, '/vendor/') !== false) {
echo $file . " skipped\n";
continue;
}
$original = file_get_contents($file);
$converted = $this->replace($original);
if ($original !== $converted) {
echo $file . " converted\n";
file_put_contents($file, $converted);
}
}
}
// Do the recursion in subdirectory
foreach (glob($path . '/*', GLOB_ONLYDIR) as $subpath) {
if (strpos($subpath, $path . '/') === 0) {
$this->recursiveReplace($subpath);
}
}
}
public function migrate()
{
$path = realpath(getcwd());
echo 'This will search and replace recursively in ' . $path . PHP_EOL;
echo 'You MUST backup your files first, or you risk losing data.' . PHP_EOL;
echo 'Are you sure ? (y/n)';
$confirm = fread(STDIN, 1);
if ($confirm === 'y') {
$this->recursiveReplace($path);
}
}
/**
* Migrate the given code from PHPExcel to PhpSpreadsheet.
*
* @param string $original
*
* @return string
*/
public function replace($original)
{
$converted = str_replace($this->from, $this->to, $original);
// The string "PHPExcel" gets special treatment because of how common it might be.
// This regex requires a word boundary around the string, and it can't be
// preceded by $ or -> (goal is to filter out cases where a variable is named $PHPExcel or similar)
$converted = preg_replace('~(?<!\$|->)(\b|\\\\)PHPExcel\b~', '\\' . \PhpOffice\PhpSpreadsheet\Spreadsheet::class, $converted);
return $converted;
}
}

15
src/PhpSpreadsheet/Helper/Sample.php
View File

@ -11,6 +11,7 @@ use RecursiveIteratorIterator;
use RecursiveRegexIterator; use RecursiveRegexIterator;
use ReflectionClass; use ReflectionClass;
use RegexIterator; use RegexIterator;
use RuntimeException;
/** /**
* Helper class to be used in sample code. * Helper class to be used in sample code.
@ -106,11 +107,10 @@ class Sample
/** /**
* Write documents. * Write documents.
* *
* @param Spreadsheet $spreadsheet
* @param string $filename * @param string $filename
* @param string[] $writers * @param string[] $writers
*/ */
public function write(Spreadsheet $spreadsheet, $filename, array $writers = ['Xlsx', 'Xls']) public function write(Spreadsheet $spreadsheet, $filename, array $writers = ['Xlsx', 'Xls']): void
{ {
// Set active sheet index to the first sheet, so Excel opens this as the first sheet // Set active sheet index to the first sheet, so Excel opens this as the first sheet
$spreadsheet->setActiveSheetIndex(0); $spreadsheet->setActiveSheetIndex(0);
@ -142,7 +142,7 @@ class Sample
$tempFolder = sys_get_temp_dir() . '/phpspreadsheet'; $tempFolder = sys_get_temp_dir() . '/phpspreadsheet';
if (!is_dir($tempFolder)) { if (!is_dir($tempFolder)) {
if (!mkdir($tempFolder) && !is_dir($tempFolder)) { if (!mkdir($tempFolder) && !is_dir($tempFolder)) {
throw new \RuntimeException(sprintf('Directory "%s" was not created', $tempFolder)); throw new RuntimeException(sprintf('Directory "%s" was not created', $tempFolder));
} }
} }
@ -179,7 +179,7 @@ class Sample
return $temporaryFilename . '.' . $extension; return $temporaryFilename . '.' . $extension;
} }
public function log($message) public function log($message): void
{ {
$eol = $this->isCli() ? PHP_EOL : '<br />'; $eol = $this->isCli() ? PHP_EOL : '<br />';
echo date('H:i:s ') . $message . $eol; echo date('H:i:s ') . $message . $eol;
@ -188,7 +188,7 @@ class Sample
/** /**
* Log ending notes. * Log ending notes.
*/ */
public function logEndingNotes() public function logEndingNotes(): void
{ {
// Do not show execution time for index // Do not show execution time for index
$this->log('Peak memory usage: ' . (memory_get_peak_usage(true) / 1024 / 1024) . 'MB'); $this->log('Peak memory usage: ' . (memory_get_peak_usage(true) / 1024 / 1024) . 'MB');
@ -197,11 +197,10 @@ class Sample
/** /**
* Log a line about the write operation. * Log a line about the write operation.
* *
* @param IWriter $writer
* @param string $path * @param string $path
* @param float $callStartTime * @param float $callStartTime
*/ */
public function logWrite(IWriter $writer, $path, $callStartTime) public function logWrite(IWriter $writer, $path, $callStartTime): void
{ {
$callEndTime = microtime(true); $callEndTime = microtime(true);
$callTime = $callEndTime - $callStartTime; $callTime = $callEndTime - $callStartTime;
@ -219,7 +218,7 @@ class Sample
* @param string $path * @param string $path
* @param float $callStartTime * @param float $callStartTime
*/ */
public function logRead($format, $path, $callStartTime) public function logRead($format, $path, $callStartTime): void
{ {
$callEndTime = microtime(true); $callEndTime = microtime(true);
$callTime = $callEndTime - $callStartTime; $callTime = $callEndTime - $callStartTime;

15
src/PhpSpreadsheet/IOFactory.php
View File

@ -37,11 +37,8 @@ abstract class IOFactory
/** /**
* Create Writer\IWriter. * Create Writer\IWriter.
* *
* @param Spreadsheet $spreadsheet
* @param string $writerType Example: Xlsx * @param string $writerType Example: Xlsx
* *
* @throws Writer\Exception
*
* @return Writer\IWriter * @return Writer\IWriter
*/ */
public static function createWriter(Spreadsheet $spreadsheet, $writerType) public static function createWriter(Spreadsheet $spreadsheet, $writerType)
@ -61,8 +58,6 @@ abstract class IOFactory
* *
* @param string $readerType Example: Xlsx * @param string $readerType Example: Xlsx
* *
* @throws Reader\Exception
*
* @return Reader\IReader * @return Reader\IReader
*/ */
public static function createReader($readerType) public static function createReader($readerType)
@ -82,8 +77,6 @@ abstract class IOFactory
* *
* @param string $pFilename The name of the spreadsheet file * @param string $pFilename The name of the spreadsheet file
* *
* @throws Reader\Exception
*
* @return Spreadsheet * @return Spreadsheet
*/ */
public static function load($pFilename) public static function load($pFilename)
@ -98,8 +91,6 @@ abstract class IOFactory
* *
* @param string $pFilename The name of the spreadsheet file to identify * @param string $pFilename The name of the spreadsheet file to identify
* *
* @throws Reader\Exception
*
* @return string * @return string
*/ */
public static function identify($pFilename) public static function identify($pFilename)
@ -117,8 +108,6 @@ abstract class IOFactory
* *
* @param string $filename The name of the spreadsheet file * @param string $filename The name of the spreadsheet file
* *
* @throws Reader\Exception
*
* @return Reader\IReader * @return Reader\IReader
*/ */
public static function createReaderForFile($filename) public static function createReaderForFile($filename)
@ -202,7 +191,7 @@ abstract class IOFactory
* @param string $writerType * @param string $writerType
* @param string $writerClass * @param string $writerClass
*/ */
public static function registerWriter($writerType, $writerClass) public static function registerWriter($writerType, $writerClass): void
{ {
if (!is_a($writerClass, Writer\IWriter::class, true)) { if (!is_a($writerClass, Writer\IWriter::class, true)) {
throw new Writer\Exception('Registered writers must implement ' . Writer\IWriter::class); throw new Writer\Exception('Registered writers must implement ' . Writer\IWriter::class);
@ -217,7 +206,7 @@ abstract class IOFactory
* @param string $readerType * @param string $readerType
* @param string $readerClass * @param string $readerClass
*/ */
public static function registerReader($readerType, $readerClass) public static function registerReader($readerType, $readerClass): void
{ {
if (!is_a($readerClass, Reader\IReader::class, true)) { if (!is_a($readerClass, Reader\IReader::class, true)) {
throw new Reader\Exception('Registered readers must implement ' . Reader\IReader::class); throw new Reader\Exception('Registered readers must implement ' . Reader\IReader::class);

9
src/PhpSpreadsheet/NamedRange.php
View File

@ -45,12 +45,9 @@ class NamedRange
* Create a new NamedRange. * Create a new NamedRange.
* *
* @param string $pName * @param string $pName
* @param Worksheet $pWorksheet
* @param string $pRange * @param string $pRange
* @param bool $pLocalOnly * @param bool $pLocalOnly
* @param null|Worksheet $pScope Scope. Only applies when $pLocalOnly = true. Null for global scope. * @param null|Worksheet $pScope Scope. Only applies when $pLocalOnly = true. Null for global scope.
*
* @throws Exception
*/ */
public function __construct($pName, Worksheet $pWorksheet, $pRange = 'A1', $pLocalOnly = false, $pScope = null) public function __construct($pName, Worksheet $pWorksheet, $pRange = 'A1', $pLocalOnly = false, $pScope = null)
{ {
@ -125,7 +122,7 @@ class NamedRange
* *
* @return $this * @return $this
*/ */
public function setWorksheet(Worksheet $value = null) public function setWorksheet(?Worksheet $value = null)
{ {
if ($value !== null) { if ($value !== null) {
$this->worksheet = $value; $this->worksheet = $value;
@ -198,11 +195,9 @@ class NamedRange
/** /**
* Set scope. * Set scope.
* *
* @param null|Worksheet $value
*
* @return $this * @return $this
*/ */
public function setScope(Worksheet $value = null) public function setScope(?Worksheet $value = null)
{ {
$this->scope = $value; $this->scope = $value;
$this->localOnly = $value != null; $this->localOnly = $value != null;

6
src/PhpSpreadsheet/Reader/BaseReader.php
View File

@ -144,15 +144,13 @@ abstract class BaseReader implements IReader
* Open file for reading. * Open file for reading.
* *
* @param string $pFilename * @param string $pFilename
*
* @throws Exception
*/ */
protected function openFile($pFilename) protected function openFile($pFilename): void
{ {
File::assertFile($pFilename); File::assertFile($pFilename);
// Open file // Open file
$this->fileHandle = fopen($pFilename, 'r'); $this->fileHandle = fopen($pFilename, 'rb');
if ($this->fileHandle === false) { if ($this->fileHandle === false) {
throw new Exception('Could not open file ' . $pFilename . ' for reading.'); throw new Exception('Could not open file ' . $pFilename . ' for reading.');
} }

116
src/PhpSpreadsheet/Reader/Csv.php
View File

@ -2,6 +2,7 @@
namespace PhpOffice\PhpSpreadsheet\Reader; namespace PhpOffice\PhpSpreadsheet\Reader;
use InvalidArgumentException;
use PhpOffice\PhpSpreadsheet\Cell\Coordinate; use PhpOffice\PhpSpreadsheet\Cell\Coordinate;
use PhpOffice\PhpSpreadsheet\Shared\StringHelper; use PhpOffice\PhpSpreadsheet\Shared\StringHelper;
use PhpOffice\PhpSpreadsheet\Spreadsheet; use PhpOffice\PhpSpreadsheet\Spreadsheet;
@ -43,13 +44,6 @@ class Csv extends BaseReader
*/ */
private $contiguous = false; private $contiguous = false;
/**
* Row counter for loading rows contiguously.
*
* @var int
*/
private $contiguousRow = -1;
/** /**
* The character that can escape the enclosure. * The character that can escape the enclosure.
* *
@ -92,7 +86,7 @@ class Csv extends BaseReader
/** /**
* Move filepointer past any BOM marker. * Move filepointer past any BOM marker.
*/ */
protected function skipBOM() protected function skipBOM(): void
{ {
rewind($this->fileHandle); rewind($this->fileHandle);
@ -101,28 +95,6 @@ class Csv extends BaseReader
fgets($this->fileHandle, 4) == "\xEF\xBB\xBF" ? fgets($this->fileHandle, 4) == "\xEF\xBB\xBF" ?
fseek($this->fileHandle, 3) : fseek($this->fileHandle, 0); fseek($this->fileHandle, 3) : fseek($this->fileHandle, 0);
break;
case 'UTF-16LE':
fgets($this->fileHandle, 3) == "\xFF\xFE" ?
fseek($this->fileHandle, 2) : fseek($this->fileHandle, 0);
break;
case 'UTF-16BE':
fgets($this->fileHandle, 3) == "\xFE\xFF" ?
fseek($this->fileHandle, 2) : fseek($this->fileHandle, 0);
break;
case 'UTF-32LE':
fgets($this->fileHandle, 5) == "\xFF\xFE\x00\x00" ?
fseek($this->fileHandle, 4) : fseek($this->fileHandle, 0);
break;
case 'UTF-32BE':
fgets($this->fileHandle, 5) == "\x00\x00\xFE\xFF" ?
fseek($this->fileHandle, 4) : fseek($this->fileHandle, 0);
break;
default:
break; break;
} }
} }
@ -130,7 +102,7 @@ class Csv extends BaseReader
/** /**
* Identify any separator that is explicitly set in the file. * Identify any separator that is explicitly set in the file.
*/ */
protected function checkSeparator() protected function checkSeparator(): void
{ {
$line = fgets($this->fileHandle); $line = fgets($this->fileHandle);
if ($line === false) { if ($line === false) {
@ -149,7 +121,7 @@ class Csv extends BaseReader
/** /**
* Infer the separator if it isn't explicitly set in the file or specified by the user. * Infer the separator if it isn't explicitly set in the file or specified by the user.
*/ */
protected function inferSeparator() protected function inferSeparator(): void
{ {
if ($this->delimiter !== null) { if ($this->delimiter !== null) {
return; return;
@ -207,7 +179,7 @@ class Csv extends BaseReader
$meanSquareDeviations[$delimiter] = array_reduce( $meanSquareDeviations[$delimiter] = array_reduce(
$series, $series,
function ($sum, $value) use ($median) { function ($sum, $value) use ($median) {
return $sum + pow($value - $median, 2); return $sum + ($value - $median) ** 2;
} }
) / count($series); ) / count($series);
} }
@ -236,12 +208,14 @@ class Csv extends BaseReader
/** /**
* Get the next full line from the file. * Get the next full line from the file.
* *
* @param string $line * @return false|string
*
* @return bool|string
*/ */
private function getNextLine($line = '') private function getNextLine()
{ {
$line = '';
$enclosure = '(?<!' . preg_quote($this->escapeCharacter, '/') . ')' . preg_quote($this->enclosure, '/');
do {
// Get the next line in the file // Get the next line in the file
$newLine = fgets($this->fileHandle); $newLine = fgets($this->fileHandle);
@ -254,15 +228,11 @@ class Csv extends BaseReader
$line = $line . $newLine; $line = $line . $newLine;
// Drop everything that is enclosed to avoid counting false positives in enclosures // Drop everything that is enclosed to avoid counting false positives in enclosures
$enclosure = '(?<!' . preg_quote($this->escapeCharacter, '/') . ')'
. preg_quote($this->enclosure, '/');
$line = preg_replace('/(' . $enclosure . '.*' . $enclosure . ')/Us', '', $line); $line = preg_replace('/(' . $enclosure . '.*' . $enclosure . ')/Us', '', $line);
// See if we have any enclosures left in the line // See if we have any enclosures left in the line
// if we still have an enclosure then we need to read the next line as well // if we still have an enclosure then we need to read the next line as well
if (preg_match('/(' . $enclosure . ')/', $line) > 0) { } while (preg_match('/(' . $enclosure . ')/', $line) > 0);
$line = $this->getNextLine($line);
}
return $line; return $line;
} }
@ -272,17 +242,12 @@ class Csv extends BaseReader
* *
* @param string $pFilename * @param string $pFilename
* *
* @throws Exception
*
* @return array * @return array
*/ */
public function listWorksheetInfo($pFilename) public function listWorksheetInfo($pFilename)
{ {
// Open file // Open file
if (!$this->canRead($pFilename)) { $this->openFileOrMemory($pFilename);
throw new Exception($pFilename . ' is an Invalid Spreadsheet file.');
}
$this->openFile($pFilename);
$fileHandle = $this->fileHandle; $fileHandle = $this->fileHandle;
// Skip BOM, if any // Skip BOM, if any
@ -317,8 +282,6 @@ class Csv extends BaseReader
* *
* @param string $pFilename * @param string $pFilename
* *
* @throws Exception
*
* @return Spreadsheet * @return Spreadsheet
*/ */
public function load($pFilename) public function load($pFilename)
@ -330,13 +293,28 @@ class Csv extends BaseReader
return $this->loadIntoExisting($pFilename, $spreadsheet); return $this->loadIntoExisting($pFilename, $spreadsheet);
} }
private function openFileOrMemory($pFilename): void
{
// Open file
$fhandle = $this->canRead($pFilename);
if (!$fhandle) {
throw new Exception($pFilename . ' is an Invalid Spreadsheet file.');
}
$this->openFile($pFilename);
if ($this->inputEncoding !== 'UTF-8') {
fclose($this->fileHandle);
$entireFile = file_get_contents($pFilename);
$this->fileHandle = fopen('php://memory', 'r+b');
$data = StringHelper::convertEncoding($entireFile, 'UTF-8', $this->inputEncoding);
fwrite($this->fileHandle, $data);
rewind($this->fileHandle);
}
}
/** /**
* Loads PhpSpreadsheet from file into PhpSpreadsheet instance. * Loads PhpSpreadsheet from file into PhpSpreadsheet instance.
* *
* @param string $pFilename * @param string $pFilename
* @param Spreadsheet $spreadsheet
*
* @throws Exception
* *
* @return Spreadsheet * @return Spreadsheet
*/ */
@ -346,10 +324,7 @@ class Csv extends BaseReader
ini_set('auto_detect_line_endings', true); ini_set('auto_detect_line_endings', true);
// Open file // Open file
if (!$this->canRead($pFilename)) { $this->openFileOrMemory($pFilename);
throw new Exception($pFilename . ' is an Invalid Spreadsheet file.');
}
$this->openFile($pFilename);
$fileHandle = $this->fileHandle; $fileHandle = $this->fileHandle;
// Skip BOM, if any // Skip BOM, if any
@ -365,22 +340,24 @@ class Csv extends BaseReader
// Set our starting row based on whether we're in contiguous mode or not // Set our starting row based on whether we're in contiguous mode or not
$currentRow = 1; $currentRow = 1;
if ($this->contiguous) { $outRow = 0;
$currentRow = ($this->contiguousRow == -1) ? $sheet->getHighestRow() : $this->contiguousRow;
}
// Loop through each line of the file in turn // Loop through each line of the file in turn
while (($rowData = fgetcsv($fileHandle, 0, $this->delimiter, $this->enclosure, $this->escapeCharacter)) !== false) { while (($rowData = fgetcsv($fileHandle, 0, $this->delimiter, $this->enclosure, $this->escapeCharacter)) !== false) {
$noOutputYet = true;
$columnLetter = 'A'; $columnLetter = 'A';
foreach ($rowData as $rowDatum) { foreach ($rowData as $rowDatum) {
if ($rowDatum != '' && $this->readFilter->readCell($columnLetter, $currentRow)) { if ($rowDatum != '' && $this->readFilter->readCell($columnLetter, $currentRow)) {
// Convert encoding if necessary if ($this->contiguous) {
if ($this->inputEncoding !== 'UTF-8') { if ($noOutputYet) {
$rowDatum = StringHelper::convertEncoding($rowDatum, 'UTF-8', $this->inputEncoding); $noOutputYet = false;
++$outRow;
}
} else {
$outRow = $currentRow;
} }
// Set cell value // Set cell value
$sheet->getCell($columnLetter . $currentRow)->setValue($rowDatum); $sheet->getCell($columnLetter . $outRow)->setValue($rowDatum);
} }
++$columnLetter; ++$columnLetter;
} }
@ -390,10 +367,6 @@ class Csv extends BaseReader
// Close file // Close file
fclose($fileHandle); fclose($fileHandle);
if ($this->contiguous) {
$this->contiguousRow = $currentRow;
}
ini_set('auto_detect_line_endings', $lineEnding); ini_set('auto_detect_line_endings', $lineEnding);
// Return // Return
@ -485,9 +458,6 @@ class Csv extends BaseReader
public function setContiguous($contiguous) public function setContiguous($contiguous)
{ {
$this->contiguous = (bool) $contiguous; $this->contiguous = (bool) $contiguous;
if (!$contiguous) {
$this->contiguousRow = -1;
}
return $this; return $this;
} }
@ -538,7 +508,7 @@ class Csv extends BaseReader
// Check if file exists // Check if file exists
try { try {
$this->openFile($pFilename); $this->openFile($pFilename);
} catch (Exception $e) { } catch (InvalidArgumentException $e) {
return false; return false;
} }

11
src/PhpSpreadsheet/Reader/Gnumeric.php
View File

@ -46,8 +46,6 @@ class Gnumeric extends BaseReader
* *
* @param string $pFilename * @param string $pFilename
* *
* @throws Exception
*
* @return bool * @return bool
*/ */
public function canRead($pFilename) public function canRead($pFilename)
@ -60,7 +58,7 @@ class Gnumeric extends BaseReader
} }
// Read signature data (first 3 bytes) // Read signature data (first 3 bytes)
$fh = fopen($pFilename, 'r'); $fh = fopen($pFilename, 'rb');
$data = fread($fh, 2); $data = fread($fh, 2);
fclose($fh); fclose($fh);
@ -169,8 +167,6 @@ class Gnumeric extends BaseReader
* *
* @param string $pFilename * @param string $pFilename
* *
* @throws Exception
*
* @return Spreadsheet * @return Spreadsheet
*/ */
public function load($pFilename) public function load($pFilename)
@ -186,9 +182,6 @@ class Gnumeric extends BaseReader
* Loads from file into Spreadsheet instance. * Loads from file into Spreadsheet instance.
* *
* @param string $pFilename * @param string $pFilename
* @param Spreadsheet $spreadsheet
*
* @throws Exception
* *
* @return Spreadsheet * @return Spreadsheet
*/ */
@ -479,7 +472,7 @@ class Gnumeric extends BaseReader
$endColumn = ($styleAttributes['endCol'] > $maxCol) ? $maxCol : (int) $styleAttributes['endCol']; $endColumn = ($styleAttributes['endCol'] > $maxCol) ? $maxCol : (int) $styleAttributes['endCol'];
$endColumn = Coordinate::stringFromColumnIndex($endColumn + 1); $endColumn = Coordinate::stringFromColumnIndex($endColumn + 1);
$endRow = ($styleAttributes['endRow'] > $maxRow) ? $maxRow : $styleAttributes['endRow']; $endRow = ($styleAttributes['endRow'] > $maxRow) ? $maxRow : $styleAttributes['endRow'];
$endRow += 1; ++$endRow;
$cellRange = $startColumn . $startRow . ':' . $endColumn . $endRow; $cellRange = $startColumn . $startRow . ':' . $endColumn . $endRow;
$styleAttributes = $styleRegion->Style->attributes(); $styleAttributes = $styleRegion->Style->attributes();

32
src/PhpSpreadsheet/Reader/Html.php
View File

@ -205,8 +205,6 @@ class Html extends BaseReader
* *
* @param string $pFilename * @param string $pFilename
* *
* @throws Exception
*
* @return Spreadsheet * @return Spreadsheet
*/ */
public function load($pFilename) public function load($pFilename)
@ -272,7 +270,7 @@ class Html extends BaseReader
return array_pop($this->nestedColumn); return array_pop($this->nestedColumn);
} }
protected function flushCell(Worksheet $sheet, $column, $row, &$cellContent) protected function flushCell(Worksheet $sheet, $column, $row, &$cellContent): void
{ {
if (is_string($cellContent)) { if (is_string($cellContent)) {
// Simple String content // Simple String content
@ -292,13 +290,11 @@ class Html extends BaseReader
} }
/** /**
* @param DOMNode $element
* @param Worksheet $sheet
* @param int $row * @param int $row
* @param string $column * @param string $column
* @param string $cellContent * @param string $cellContent
*/ */
protected function processDomElement(DOMNode $element, Worksheet $sheet, &$row, &$column, &$cellContent) protected function processDomElement(DOMNode $element, Worksheet $sheet, &$row, &$column, &$cellContent): void
{ {
foreach ($element->childNodes as $child) { foreach ($element->childNodes as $child) {
if ($child instanceof DOMText) { if ($child instanceof DOMText) {
@ -579,9 +575,6 @@ class Html extends BaseReader
* Loads PhpSpreadsheet from file into PhpSpreadsheet instance. * Loads PhpSpreadsheet from file into PhpSpreadsheet instance.
* *
* @param string $pFilename * @param string $pFilename
* @param Spreadsheet $spreadsheet
*
* @throws Exception
* *
* @return Spreadsheet * @return Spreadsheet
*/ */
@ -607,9 +600,6 @@ class Html extends BaseReader
* Spreadsheet from content. * Spreadsheet from content.
* *
* @param string $content * @param string $content
* @param null|Spreadsheet $spreadsheet
*
* @return Spreadsheet
*/ */
public function loadFromString($content, ?Spreadsheet $spreadsheet = null): Spreadsheet public function loadFromString($content, ?Spreadsheet $spreadsheet = null): Spreadsheet
{ {
@ -626,13 +616,6 @@ class Html extends BaseReader
/** /**
* Loads PhpSpreadsheet from DOMDocument into PhpSpreadsheet instance. * Loads PhpSpreadsheet from DOMDocument into PhpSpreadsheet instance.
*
* @param DOMDocument $document
* @param Spreadsheet $spreadsheet
*
* @throws \PhpOffice\PhpSpreadsheet\Exception
*
* @return Spreadsheet
*/ */
private function loadDocument(DOMDocument $document, Spreadsheet $spreadsheet): Spreadsheet private function loadDocument(DOMDocument $document, Spreadsheet $spreadsheet): Spreadsheet
{ {
@ -693,7 +676,7 @@ class Html extends BaseReader
* @param string $column * @param string $column
* @param array $attributeArray * @param array $attributeArray
*/ */
private function applyInlineStyle(&$sheet, $row, $column, $attributeArray) private function applyInlineStyle(&$sheet, $row, $column, $attributeArray): void
{ {
if (!isset($attributeArray['style'])) { if (!isset($attributeArray['style'])) {
return; return;
@ -858,14 +841,10 @@ class Html extends BaseReader
} }
/** /**
* @param Worksheet $sheet
* @param string $column * @param string $column
* @param int $row * @param int $row
* @param array $attributes
*
* @throws \PhpOffice\PhpSpreadsheet\Exception
*/ */
private function insertImage(Worksheet $sheet, $column, $row, array $attributes) private function insertImage(Worksheet $sheet, $column, $row, array $attributes): void
{ {
if (!isset($attributes['src'])) { if (!isset($attributes['src'])) {
return; return;
@ -949,11 +928,10 @@ class Html extends BaseReader
} }
/** /**
* @param Style $cellStyle
* @param string $styleValue * @param string $styleValue
* @param string $type * @param string $type
*/ */
private function setBorderStyle(Style $cellStyle, $styleValue, $type) private function setBorderStyle(Style $cellStyle, $styleValue, $type): void
{ {
[, $borderStyle, $color] = explode(' ', $styleValue); [, $borderStyle, $color] = explode(' ', $styleValue);

4
src/PhpSpreadsheet/Reader/IReader.php
View File

@ -118,8 +118,6 @@ interface IReader
/** /**
* Set read filter. * Set read filter.
* *
* @param IReadFilter $pValue
*
* @return IReader * @return IReader
*/ */
public function setReadFilter(IReadFilter $pValue); public function setReadFilter(IReadFilter $pValue);
@ -129,8 +127,6 @@ interface IReader
* *
* @param string $pFilename * @param string $pFilename
* *
* @throws Exception
*
* @return \PhpOffice\PhpSpreadsheet\Spreadsheet * @return \PhpOffice\PhpSpreadsheet\Spreadsheet
*/ */
public function load($pFilename); public function load($pFilename);

37
src/PhpSpreadsheet/Reader/Ods.php
View File

@ -4,6 +4,10 @@ namespace PhpOffice\PhpSpreadsheet\Reader;
use DateTime; use DateTime;
use DateTimeZone; use DateTimeZone;
use DOMAttr;
use DOMDocument;
use DOMElement;
use DOMNode;
use PhpOffice\PhpSpreadsheet\Calculation\Calculation; use PhpOffice\PhpSpreadsheet\Calculation\Calculation;
use PhpOffice\PhpSpreadsheet\Cell\Coordinate; use PhpOffice\PhpSpreadsheet\Cell\Coordinate;
use PhpOffice\PhpSpreadsheet\Cell\DataType; use PhpOffice\PhpSpreadsheet\Cell\DataType;
@ -34,8 +38,6 @@ class Ods extends BaseReader
* *
* @param string $pFilename * @param string $pFilename
* *
* @throws Exception
*
* @return bool * @return bool
*/ */
public function canRead($pFilename) public function canRead($pFilename)
@ -85,8 +87,6 @@ class Ods extends BaseReader
* *
* @param string $pFilename * @param string $pFilename
* *
* @throws Exception
*
* @return string[] * @return string[]
*/ */
public function listWorksheetNames($pFilename) public function listWorksheetNames($pFilename)
@ -139,8 +139,6 @@ class Ods extends BaseReader
* *
* @param string $pFilename * @param string $pFilename
* *
* @throws Exception
*
* @return array * @return array
*/ */
public function listWorksheetInfo($pFilename) public function listWorksheetInfo($pFilename)
@ -233,8 +231,6 @@ class Ods extends BaseReader
* *
* @param string $pFilename * @param string $pFilename
* *
* @throws Exception
*
* @return Spreadsheet * @return Spreadsheet
*/ */
public function load($pFilename) public function load($pFilename)
@ -250,9 +246,6 @@ class Ods extends BaseReader
* Loads PhpSpreadsheet from file into PhpSpreadsheet instance. * Loads PhpSpreadsheet from file into PhpSpreadsheet instance.
* *
* @param string $pFilename * @param string $pFilename
* @param Spreadsheet $spreadsheet
*
* @throws Exception
* *
* @return Spreadsheet * @return Spreadsheet
*/ */
@ -261,7 +254,7 @@ class Ods extends BaseReader
File::assertFile($pFilename); File::assertFile($pFilename);
$timezoneObj = new DateTimeZone('Europe/London'); $timezoneObj = new DateTimeZone('Europe/London');
$GMT = new \DateTimeZone('UTC'); $GMT = new DateTimeZone('UTC');
$zip = new ZipArchive(); $zip = new ZipArchive();
if (!$zip->open($pFilename)) { if (!$zip->open($pFilename)) {
@ -285,7 +278,7 @@ class Ods extends BaseReader
// Content // Content
$dom = new \DOMDocument('1.01', 'UTF-8'); $dom = new DOMDocument('1.01', 'UTF-8');
$dom->loadXML( $dom->loadXML(
$this->securityScanner->scan($zip->getFromName('content.xml')), $this->securityScanner->scan($zip->getFromName('content.xml')),
Settings::getLibXmlLoaderOptions() Settings::getLibXmlLoaderOptions()
@ -301,12 +294,12 @@ class Ods extends BaseReader
->getElementsByTagNameNS($officeNs, 'spreadsheet'); ->getElementsByTagNameNS($officeNs, 'spreadsheet');
foreach ($spreadsheets as $workbookData) { foreach ($spreadsheets as $workbookData) {
/** @var \DOMElement $workbookData */ /** @var DOMElement $workbookData */
$tables = $workbookData->getElementsByTagNameNS($tableNs, 'table'); $tables = $workbookData->getElementsByTagNameNS($tableNs, 'table');
$worksheetID = 0; $worksheetID = 0;
foreach ($tables as $worksheetDataSet) { foreach ($tables as $worksheetDataSet) {
/** @var \DOMElement $worksheetDataSet */ /** @var DOMElement $worksheetDataSet */
$worksheetName = $worksheetDataSet->getAttributeNS($tableNs, 'name'); $worksheetName = $worksheetDataSet->getAttributeNS($tableNs, 'name');
// Check loadSheetsOnly // Check loadSheetsOnly
@ -332,7 +325,7 @@ class Ods extends BaseReader
// Go through every child of table element // Go through every child of table element
$rowID = 1; $rowID = 1;
foreach ($worksheetDataSet->childNodes as $childNode) { foreach ($worksheetDataSet->childNodes as $childNode) {
/** @var \DOMElement $childNode */ /** @var DOMElement $childNode */
// Filter elements which are not under the "table" ns // Filter elements which are not under the "table" ns
if ($childNode->namespaceURI != $tableNs) { if ($childNode->namespaceURI != $tableNs) {
@ -405,11 +398,11 @@ class Ods extends BaseReader
// Content // Content
/** @var \DOMElement[] $paragraphs */ /** @var DOMElement[] $paragraphs */
$paragraphs = []; $paragraphs = [];
foreach ($cellData->childNodes as $item) { foreach ($cellData->childNodes as $item) {
/** @var \DOMElement $item */ /** @var DOMElement $item */
// Filter text:p elements // Filter text:p elements
if ($item->nodeName == 'text:p') { if ($item->nodeName == 'text:p') {
@ -659,22 +652,20 @@ class Ods extends BaseReader
/** /**
* Recursively scan element. * Recursively scan element.
* *
* @param \DOMNode $element
*
* @return string * @return string
*/ */
protected function scanElementForText(\DOMNode $element) protected function scanElementForText(DOMNode $element)
{ {
$str = ''; $str = '';
foreach ($element->childNodes as $child) { foreach ($element->childNodes as $child) {
/** @var \DOMNode $child */ /** @var DOMNode $child */
if ($child->nodeType == XML_TEXT_NODE) { if ($child->nodeType == XML_TEXT_NODE) {
$str .= $child->nodeValue; $str .= $child->nodeValue;
} elseif ($child->nodeType == XML_ELEMENT_NODE && $child->nodeName == 'text:s') { } elseif ($child->nodeType == XML_ELEMENT_NODE && $child->nodeName == 'text:s') {
// It's a space // It's a space
// Multiple spaces? // Multiple spaces?
/** @var \DOMAttr $cAttr */ /** @var DOMAttr $cAttr */
$cAttr = $child->attributes->getNamedItem('c'); $cAttr = $child->attributes->getNamedItem('c');
if ($cAttr) { if ($cAttr) {
$multiplier = (int) $cAttr->nodeValue; $multiplier = (int) $cAttr->nodeValue;

11
src/PhpSpreadsheet/Reader/Ods/Properties.php
View File

@ -4,6 +4,7 @@ namespace PhpOffice\PhpSpreadsheet\Reader\Ods;
use PhpOffice\PhpSpreadsheet\Document\Properties as DocumentProperties; use PhpOffice\PhpSpreadsheet\Document\Properties as DocumentProperties;
use PhpOffice\PhpSpreadsheet\Spreadsheet; use PhpOffice\PhpSpreadsheet\Spreadsheet;
use SimpleXMLElement;
class Properties class Properties
{ {
@ -14,7 +15,7 @@ class Properties
$this->spreadsheet = $spreadsheet; $this->spreadsheet = $spreadsheet;
} }
public function load(\SimpleXMLElement $xml, $namespacesMeta) public function load(SimpleXMLElement $xml, $namespacesMeta): void
{ {
$docProps = $this->spreadsheet->getProperties(); $docProps = $this->spreadsheet->getProperties();
$officeProperty = $xml->children($namespacesMeta['office']); $officeProperty = $xml->children($namespacesMeta['office']);
@ -35,7 +36,7 @@ class Properties
} }
} }
private function setCoreProperties(DocumentProperties $docProps, \SimpleXMLElement $officePropertyDC) private function setCoreProperties(DocumentProperties $docProps, SimpleXMLElement $officePropertyDC): void
{ {
foreach ($officePropertyDC as $propertyName => $propertyValue) { foreach ($officePropertyDC as $propertyName => $propertyValue) {
$propertyValue = (string) $propertyValue; $propertyValue = (string) $propertyValue;
@ -73,10 +74,10 @@ class Properties
private function setMetaProperties( private function setMetaProperties(
$namespacesMeta, $namespacesMeta,
\SimpleXMLElement $propertyValue, SimpleXMLElement $propertyValue,
$propertyName, $propertyName,
DocumentProperties $docProps DocumentProperties $docProps
) { ): void {
$propertyValueAttributes = $propertyValue->attributes($namespacesMeta['meta']); $propertyValueAttributes = $propertyValue->attributes($namespacesMeta['meta']);
$propertyValue = (string) $propertyValue; $propertyValue = (string) $propertyValue;
switch ($propertyName) { switch ($propertyName) {
@ -100,7 +101,7 @@ class Properties
} }
} }
private function setUserDefinedProperty($propertyValueAttributes, $propertyValue, DocumentProperties $docProps) private function setUserDefinedProperty($propertyValueAttributes, $propertyValue, DocumentProperties $docProps): void
{ {
$propertyValueName = ''; $propertyValueName = '';
$propertyValueType = DocumentProperties::PROPERTY_TYPE_STRING; $propertyValueType = DocumentProperties::PROPERTY_TYPE_STRING;

10
src/PhpSpreadsheet/Reader/Security/XmlScanner.php
View File

@ -61,7 +61,7 @@ class XmlScanner
return false; return false;
} }
private function disableEntityLoaderCheck() private function disableEntityLoaderCheck(): void
{ {
if (Settings::getLibXmlDisableEntityLoader()) { if (Settings::getLibXmlDisableEntityLoader()) {
$libxmlDisableEntityLoaderValue = libxml_disable_entity_loader(true); $libxmlDisableEntityLoaderValue = libxml_disable_entity_loader(true);
@ -72,7 +72,7 @@ class XmlScanner
} }
} }
public static function shutdown() public static function shutdown(): void
{ {
if (self::$libxmlDisableEntityLoaderValue !== null) { if (self::$libxmlDisableEntityLoaderValue !== null) {
libxml_disable_entity_loader(self::$libxmlDisableEntityLoaderValue); libxml_disable_entity_loader(self::$libxmlDisableEntityLoaderValue);
@ -85,7 +85,7 @@ class XmlScanner
self::shutdown(); self::shutdown();
} }
public function setAdditionalCallback(callable $callback) public function setAdditionalCallback(callable $callback): void
{ {
$this->callback = $callback; $this->callback = $callback;
} }
@ -114,8 +114,6 @@ class XmlScanner
* *
* @param mixed $xml * @param mixed $xml
* *
* @throws Reader\Exception
*
* @return string * @return string
*/ */
public function scan($xml) public function scan($xml)
@ -143,8 +141,6 @@ class XmlScanner
* *
* @param string $filestream * @param string $filestream
* *
* @throws Reader\Exception
*
* @return string * @return string
*/ */
public function scanFile($filestream) public function scanFile($filestream)

7
src/PhpSpreadsheet/Reader/Slk.php
View File

@ -107,8 +107,6 @@ class Slk extends BaseReader
* *
* @param string $pFilename * @param string $pFilename
* *
* @throws Exception
*
* @return array * @return array
*/ */
public function listWorksheetInfo($pFilename) public function listWorksheetInfo($pFilename)
@ -177,8 +175,6 @@ class Slk extends BaseReader
* *
* @param string $pFilename * @param string $pFilename
* *
* @throws Exception
*
* @return Spreadsheet * @return Spreadsheet
*/ */
public function load($pFilename) public function load($pFilename)
@ -194,9 +190,6 @@ class Slk extends BaseReader
* Loads PhpSpreadsheet from file into PhpSpreadsheet instance. * Loads PhpSpreadsheet from file into PhpSpreadsheet instance.
* *
* @param string $pFilename * @param string $pFilename
* @param Spreadsheet $spreadsheet
*
* @throws Exception
* *
* @return Spreadsheet * @return Spreadsheet
*/ */

190
src/PhpSpreadsheet/Reader/Xls.php
View File

@ -444,8 +444,6 @@ class Xls extends BaseReader
* *
* @param string $pFilename * @param string $pFilename
* *
* @throws Exception
*
* @return array * @return array
*/ */
public function listWorksheetNames($pFilename) public function listWorksheetNames($pFilename)
@ -504,8 +502,6 @@ class Xls extends BaseReader
* *
* @param string $pFilename * @param string $pFilename
* *
* @throws Exception
*
* @return array * @return array
*/ */
public function listWorksheetInfo($pFilename) public function listWorksheetInfo($pFilename)
@ -618,8 +614,6 @@ class Xls extends BaseReader
* *
* @param string $pFilename * @param string $pFilename
* *
* @throws Exception
*
* @return Spreadsheet * @return Spreadsheet
*/ */
public function load($pFilename) public function load($pFilename)
@ -1254,10 +1248,10 @@ class Xls extends BaseReader
[$firstColumn, $firstRow] = Coordinate::coordinateFromString($coordinateStrings[0]); [$firstColumn, $firstRow] = Coordinate::coordinateFromString($coordinateStrings[0]);
[$lastColumn, $lastRow] = Coordinate::coordinateFromString($coordinateStrings[1]); [$lastColumn, $lastRow] = Coordinate::coordinateFromString($coordinateStrings[1]);
if ($firstColumn == 'A' and $lastColumn == 'IV') { if ($firstColumn == 'A' && $lastColumn == 'IV') {
// then we have repeating rows // then we have repeating rows
$docSheet->getPageSetup()->setRowsToRepeatAtTop([$firstRow, $lastRow]); $docSheet->getPageSetup()->setRowsToRepeatAtTop([$firstRow, $lastRow]);
} elseif ($firstRow == 1 and $lastRow == 65536) { } elseif ($firstRow == 1 && $lastRow == 65536) {
// then we have repeating columns // then we have repeating columns
$docSheet->getPageSetup()->setColumnsToRepeatAtLeft([$firstColumn, $lastColumn]); $docSheet->getPageSetup()->setColumnsToRepeatAtLeft([$firstColumn, $lastColumn]);
} }
@ -1354,7 +1348,7 @@ class Xls extends BaseReader
* *
* @param string $pFilename * @param string $pFilename
*/ */
private function loadOLE($pFilename) private function loadOLE($pFilename): void
{ {
// OLE reader // OLE reader
$ole = new OLERead(); $ole = new OLERead();
@ -1371,7 +1365,7 @@ class Xls extends BaseReader
/** /**
* Read summary information. * Read summary information.
*/ */
private function readSummaryInformation() private function readSummaryInformation(): void
{ {
if (!isset($this->summaryInformation)) { if (!isset($this->summaryInformation)) {
return; return;
@ -1518,7 +1512,7 @@ class Xls extends BaseReader
/** /**
* Read additional document summary information. * Read additional document summary information.
*/ */
private function readDocumentSummaryInformation() private function readDocumentSummaryInformation(): void
{ {
if (!isset($this->documentSummaryInformation)) { if (!isset($this->documentSummaryInformation)) {
return; return;
@ -1656,7 +1650,7 @@ class Xls extends BaseReader
/** /**
* Reads a general type of BIFF record. Does nothing except for moving stream pointer forward to next record. * Reads a general type of BIFF record. Does nothing except for moving stream pointer forward to next record.
*/ */
private function readDefault() private function readDefault(): void
{ {
$length = self::getUInt2d($this->data, $this->pos + 2); $length = self::getUInt2d($this->data, $this->pos + 2);
@ -1668,7 +1662,7 @@ class Xls extends BaseReader
* The NOTE record specifies a comment associated with a particular cell. In Excel 95 (BIFF7) and earlier versions, * The NOTE record specifies a comment associated with a particular cell. In Excel 95 (BIFF7) and earlier versions,
* this record stores a note (cell note). This feature was significantly enhanced in Excel 97. * this record stores a note (cell note). This feature was significantly enhanced in Excel 97.
*/ */
private function readNote() private function readNote(): void
{ {
$length = self::getUInt2d($this->data, $this->pos + 2); $length = self::getUInt2d($this->data, $this->pos + 2);
$recordData = $this->readRecordData($this->data, $this->pos + 4, $length); $recordData = $this->readRecordData($this->data, $this->pos + 4, $length);
@ -1721,7 +1715,7 @@ class Xls extends BaseReader
/** /**
* The TEXT Object record contains the text associated with a cell annotation. * The TEXT Object record contains the text associated with a cell annotation.
*/ */
private function readTextObject() private function readTextObject(): void
{ {
$length = self::getUInt2d($this->data, $this->pos + 2); $length = self::getUInt2d($this->data, $this->pos + 2);
$recordData = $this->readRecordData($this->data, $this->pos + 4, $length); $recordData = $this->readRecordData($this->data, $this->pos + 4, $length);
@ -1768,7 +1762,7 @@ class Xls extends BaseReader
/** /**
* Read BOF. * Read BOF.
*/ */
private function readBof() private function readBof(): void
{ {
$length = self::getUInt2d($this->data, $this->pos + 2); $length = self::getUInt2d($this->data, $this->pos + 2);
$recordData = substr($this->data, $this->pos + 4, $length); $recordData = substr($this->data, $this->pos + 4, $length);
@ -1819,7 +1813,7 @@ class Xls extends BaseReader
* are based on the source of Spreadsheet-ParseExcel: * are based on the source of Spreadsheet-ParseExcel:
* https://metacpan.org/release/Spreadsheet-ParseExcel * https://metacpan.org/release/Spreadsheet-ParseExcel
*/ */
private function readFilepass() private function readFilepass(): void
{ {
$length = self::getUInt2d($this->data, $this->pos + 2); $length = self::getUInt2d($this->data, $this->pos + 2);
@ -1969,7 +1963,7 @@ class Xls extends BaseReader
* -- "OpenOffice.org's Documentation of the Microsoft * -- "OpenOffice.org's Documentation of the Microsoft
* Excel File Format" * Excel File Format"
*/ */
private function readCodepage() private function readCodepage(): void
{ {
$length = self::getUInt2d($this->data, $this->pos + 2); $length = self::getUInt2d($this->data, $this->pos + 2);
$recordData = $this->readRecordData($this->data, $this->pos + 4, $length); $recordData = $this->readRecordData($this->data, $this->pos + 4, $length);
@ -1995,7 +1989,7 @@ class Xls extends BaseReader
* -- "OpenOffice.org's Documentation of the Microsoft * -- "OpenOffice.org's Documentation of the Microsoft
* Excel File Format" * Excel File Format"
*/ */
private function readDateMode() private function readDateMode(): void
{ {
$length = self::getUInt2d($this->data, $this->pos + 2); $length = self::getUInt2d($this->data, $this->pos + 2);
$recordData = $this->readRecordData($this->data, $this->pos + 4, $length); $recordData = $this->readRecordData($this->data, $this->pos + 4, $length);
@ -2013,7 +2007,7 @@ class Xls extends BaseReader
/** /**
* Read a FONT record. * Read a FONT record.
*/ */
private function readFont() private function readFont(): void
{ {
$length = self::getUInt2d($this->data, $this->pos + 2); $length = self::getUInt2d($this->data, $this->pos + 2);
$recordData = $this->readRecordData($this->data, $this->pos + 4, $length); $recordData = $this->readRecordData($this->data, $this->pos + 4, $length);
@ -2121,7 +2115,7 @@ class Xls extends BaseReader
* -- "OpenOffice.org's Documentation of the Microsoft * -- "OpenOffice.org's Documentation of the Microsoft
* Excel File Format" * Excel File Format"
*/ */
private function readFormat() private function readFormat(): void
{ {
$length = self::getUInt2d($this->data, $this->pos + 2); $length = self::getUInt2d($this->data, $this->pos + 2);
$recordData = $this->readRecordData($this->data, $this->pos + 4, $length); $recordData = $this->readRecordData($this->data, $this->pos + 4, $length);
@ -2158,7 +2152,7 @@ class Xls extends BaseReader
* -- "OpenOffice.org's Documentation of the Microsoft * -- "OpenOffice.org's Documentation of the Microsoft
* Excel File Format" * Excel File Format"
*/ */
private function readXf() private function readXf(): void
{ {
$length = self::getUInt2d($this->data, $this->pos + 2); $length = self::getUInt2d($this->data, $this->pos + 2);
$recordData = $this->readRecordData($this->data, $this->pos + 4, $length); $recordData = $this->readRecordData($this->data, $this->pos + 4, $length);
@ -2455,7 +2449,7 @@ class Xls extends BaseReader
} }
} }
private function readXfExt() private function readXfExt(): void
{ {
$length = self::getUInt2d($this->data, $this->pos + 2); $length = self::getUInt2d($this->data, $this->pos + 2);
$recordData = $this->readRecordData($this->data, $this->pos + 4, $length); $recordData = $this->readRecordData($this->data, $this->pos + 4, $length);
@ -2504,7 +2498,7 @@ class Xls extends BaseReader
if (isset($this->mapCellXfIndex[$ixfe])) { if (isset($this->mapCellXfIndex[$ixfe])) {
$fill = $this->spreadsheet->getCellXfByIndex($this->mapCellXfIndex[$ixfe])->getFill(); $fill = $this->spreadsheet->getCellXfByIndex($this->mapCellXfIndex[$ixfe])->getFill();
$fill->getStartColor()->setRGB($rgb); $fill->getStartColor()->setRGB($rgb);
unset($fill->startcolorIndex); // normal color index does not apply, discard $fill->startcolorIndex = null; // normal color index does not apply, discard
} }
} }
@ -2520,7 +2514,7 @@ class Xls extends BaseReader
if (isset($this->mapCellXfIndex[$ixfe])) { if (isset($this->mapCellXfIndex[$ixfe])) {
$fill = $this->spreadsheet->getCellXfByIndex($this->mapCellXfIndex[$ixfe])->getFill(); $fill = $this->spreadsheet->getCellXfByIndex($this->mapCellXfIndex[$ixfe])->getFill();
$fill->getEndColor()->setRGB($rgb); $fill->getEndColor()->setRGB($rgb);
unset($fill->endcolorIndex); // normal color index does not apply, discard $fill->endcolorIndex = null; // normal color index does not apply, discard
} }
} }
@ -2536,7 +2530,7 @@ class Xls extends BaseReader
if (isset($this->mapCellXfIndex[$ixfe])) { if (isset($this->mapCellXfIndex[$ixfe])) {
$top = $this->spreadsheet->getCellXfByIndex($this->mapCellXfIndex[$ixfe])->getBorders()->getTop(); $top = $this->spreadsheet->getCellXfByIndex($this->mapCellXfIndex[$ixfe])->getBorders()->getTop();
$top->getColor()->setRGB($rgb); $top->getColor()->setRGB($rgb);
unset($top->colorIndex); // normal color index does not apply, discard $top->colorIndex = null; // normal color index does not apply, discard
} }
} }
@ -2552,7 +2546,7 @@ class Xls extends BaseReader
if (isset($this->mapCellXfIndex[$ixfe])) { if (isset($this->mapCellXfIndex[$ixfe])) {
$bottom = $this->spreadsheet->getCellXfByIndex($this->mapCellXfIndex[$ixfe])->getBorders()->getBottom(); $bottom = $this->spreadsheet->getCellXfByIndex($this->mapCellXfIndex[$ixfe])->getBorders()->getBottom();
$bottom->getColor()->setRGB($rgb); $bottom->getColor()->setRGB($rgb);
unset($bottom->colorIndex); // normal color index does not apply, discard $bottom->colorIndex = null; // normal color index does not apply, discard
} }
} }
@ -2568,7 +2562,7 @@ class Xls extends BaseReader
if (isset($this->mapCellXfIndex[$ixfe])) { if (isset($this->mapCellXfIndex[$ixfe])) {
$left = $this->spreadsheet->getCellXfByIndex($this->mapCellXfIndex[$ixfe])->getBorders()->getLeft(); $left = $this->spreadsheet->getCellXfByIndex($this->mapCellXfIndex[$ixfe])->getBorders()->getLeft();
$left->getColor()->setRGB($rgb); $left->getColor()->setRGB($rgb);
unset($left->colorIndex); // normal color index does not apply, discard $left->colorIndex = null; // normal color index does not apply, discard
} }
} }
@ -2584,7 +2578,7 @@ class Xls extends BaseReader
if (isset($this->mapCellXfIndex[$ixfe])) { if (isset($this->mapCellXfIndex[$ixfe])) {
$right = $this->spreadsheet->getCellXfByIndex($this->mapCellXfIndex[$ixfe])->getBorders()->getRight(); $right = $this->spreadsheet->getCellXfByIndex($this->mapCellXfIndex[$ixfe])->getBorders()->getRight();
$right->getColor()->setRGB($rgb); $right->getColor()->setRGB($rgb);
unset($right->colorIndex); // normal color index does not apply, discard $right->colorIndex = null; // normal color index does not apply, discard
} }
} }
@ -2600,7 +2594,7 @@ class Xls extends BaseReader
if (isset($this->mapCellXfIndex[$ixfe])) { if (isset($this->mapCellXfIndex[$ixfe])) {
$diagonal = $this->spreadsheet->getCellXfByIndex($this->mapCellXfIndex[$ixfe])->getBorders()->getDiagonal(); $diagonal = $this->spreadsheet->getCellXfByIndex($this->mapCellXfIndex[$ixfe])->getBorders()->getDiagonal();
$diagonal->getColor()->setRGB($rgb); $diagonal->getColor()->setRGB($rgb);
unset($diagonal->colorIndex); // normal color index does not apply, discard $diagonal->colorIndex = null; // normal color index does not apply, discard
} }
} }
@ -2616,7 +2610,7 @@ class Xls extends BaseReader
if (isset($this->mapCellXfIndex[$ixfe])) { if (isset($this->mapCellXfIndex[$ixfe])) {
$font = $this->spreadsheet->getCellXfByIndex($this->mapCellXfIndex[$ixfe])->getFont(); $font = $this->spreadsheet->getCellXfByIndex($this->mapCellXfIndex[$ixfe])->getFont();
$font->getColor()->setRGB($rgb); $font->getColor()->setRGB($rgb);
unset($font->colorIndex); // normal color index does not apply, discard $font->colorIndex = null; // normal color index does not apply, discard
} }
} }
@ -2631,7 +2625,7 @@ class Xls extends BaseReader
/** /**
* Read STYLE record. * Read STYLE record.
*/ */
private function readStyle() private function readStyle(): void
{ {
$length = self::getUInt2d($this->data, $this->pos + 2); $length = self::getUInt2d($this->data, $this->pos + 2);
$recordData = $this->readRecordData($this->data, $this->pos + 4, $length); $recordData = $this->readRecordData($this->data, $this->pos + 4, $length);
@ -2668,7 +2662,7 @@ class Xls extends BaseReader
/** /**
* Read PALETTE record. * Read PALETTE record.
*/ */
private function readPalette() private function readPalette(): void
{ {
$length = self::getUInt2d($this->data, $this->pos + 2); $length = self::getUInt2d($this->data, $this->pos + 2);
$recordData = $this->readRecordData($this->data, $this->pos + 4, $length); $recordData = $this->readRecordData($this->data, $this->pos + 4, $length);
@ -2700,7 +2694,7 @@ class Xls extends BaseReader
* -- "OpenOffice.org's Documentation of the Microsoft * -- "OpenOffice.org's Documentation of the Microsoft
* Excel File Format" * Excel File Format"
*/ */
private function readSheet() private function readSheet(): void
{ {
$length = self::getUInt2d($this->data, $this->pos + 2); $length = self::getUInt2d($this->data, $this->pos + 2);
$recordData = $this->readRecordData($this->data, $this->pos + 4, $length); $recordData = $this->readRecordData($this->data, $this->pos + 4, $length);
@ -2755,7 +2749,7 @@ class Xls extends BaseReader
/** /**
* Read EXTERNALBOOK record. * Read EXTERNALBOOK record.
*/ */
private function readExternalBook() private function readExternalBook(): void
{ {
$length = self::getUInt2d($this->data, $this->pos + 2); $length = self::getUInt2d($this->data, $this->pos + 2);
$recordData = $this->readRecordData($this->data, $this->pos + 4, $length); $recordData = $this->readRecordData($this->data, $this->pos + 4, $length);
@ -2817,7 +2811,7 @@ class Xls extends BaseReader
/** /**
* Read EXTERNNAME record. * Read EXTERNNAME record.
*/ */
private function readExternName() private function readExternName(): void
{ {
$length = self::getUInt2d($this->data, $this->pos + 2); $length = self::getUInt2d($this->data, $this->pos + 2);
$recordData = $this->readRecordData($this->data, $this->pos + 4, $length); $recordData = $this->readRecordData($this->data, $this->pos + 4, $length);
@ -2851,7 +2845,7 @@ class Xls extends BaseReader
/** /**
* Read EXTERNSHEET record. * Read EXTERNSHEET record.
*/ */
private function readExternSheet() private function readExternSheet(): void
{ {
$length = self::getUInt2d($this->data, $this->pos + 2); $length = self::getUInt2d($this->data, $this->pos + 2);
$recordData = $this->readRecordData($this->data, $this->pos + 4, $length); $recordData = $this->readRecordData($this->data, $this->pos + 4, $length);
@ -2887,7 +2881,7 @@ class Xls extends BaseReader
* -- "OpenOffice.org's Documentation of the Microsoft * -- "OpenOffice.org's Documentation of the Microsoft
* Excel File Format" * Excel File Format"
*/ */
private function readDefinedName() private function readDefinedName(): void
{ {
$length = self::getUInt2d($this->data, $this->pos + 2); $length = self::getUInt2d($this->data, $this->pos + 2);
$recordData = $this->readRecordData($this->data, $this->pos + 4, $length); $recordData = $this->readRecordData($this->data, $this->pos + 4, $length);
@ -2941,7 +2935,7 @@ class Xls extends BaseReader
/** /**
* Read MSODRAWINGGROUP record. * Read MSODRAWINGGROUP record.
*/ */
private function readMsoDrawingGroup() private function readMsoDrawingGroup(): void
{ {
$length = self::getUInt2d($this->data, $this->pos + 2); $length = self::getUInt2d($this->data, $this->pos + 2);
@ -2963,7 +2957,7 @@ class Xls extends BaseReader
* -- "OpenOffice.org's Documentation of the Microsoft * -- "OpenOffice.org's Documentation of the Microsoft
* Excel File Format" * Excel File Format"
*/ */
private function readSst() private function readSst(): void
{ {
// offset within (spliced) record data // offset within (spliced) record data
$pos = 0; $pos = 0;
@ -3144,7 +3138,7 @@ class Xls extends BaseReader
/** /**
* Read PRINTGRIDLINES record. * Read PRINTGRIDLINES record.
*/ */
private function readPrintGridlines() private function readPrintGridlines(): void
{ {
$length = self::getUInt2d($this->data, $this->pos + 2); $length = self::getUInt2d($this->data, $this->pos + 2);
$recordData = $this->readRecordData($this->data, $this->pos + 4, $length); $recordData = $this->readRecordData($this->data, $this->pos + 4, $length);
@ -3162,7 +3156,7 @@ class Xls extends BaseReader
/** /**
* Read DEFAULTROWHEIGHT record. * Read DEFAULTROWHEIGHT record.
*/ */
private function readDefaultRowHeight() private function readDefaultRowHeight(): void
{ {
$length = self::getUInt2d($this->data, $this->pos + 2); $length = self::getUInt2d($this->data, $this->pos + 2);
$recordData = $this->readRecordData($this->data, $this->pos + 4, $length); $recordData = $this->readRecordData($this->data, $this->pos + 4, $length);
@ -3179,7 +3173,7 @@ class Xls extends BaseReader
/** /**
* Read SHEETPR record. * Read SHEETPR record.
*/ */
private function readSheetPr() private function readSheetPr(): void
{ {
$length = self::getUInt2d($this->data, $this->pos + 2); $length = self::getUInt2d($this->data, $this->pos + 2);
$recordData = $this->readRecordData($this->data, $this->pos + 4, $length); $recordData = $this->readRecordData($this->data, $this->pos + 4, $length);
@ -3205,7 +3199,7 @@ class Xls extends BaseReader
/** /**
* Read HORIZONTALPAGEBREAKS record. * Read HORIZONTALPAGEBREAKS record.
*/ */
private function readHorizontalPageBreaks() private function readHorizontalPageBreaks(): void
{ {
$length = self::getUInt2d($this->data, $this->pos + 2); $length = self::getUInt2d($this->data, $this->pos + 2);
$recordData = $this->readRecordData($this->data, $this->pos + 4, $length); $recordData = $this->readRecordData($this->data, $this->pos + 4, $length);
@ -3232,7 +3226,7 @@ class Xls extends BaseReader
/** /**
* Read VERTICALPAGEBREAKS record. * Read VERTICALPAGEBREAKS record.
*/ */
private function readVerticalPageBreaks() private function readVerticalPageBreaks(): void
{ {
$length = self::getUInt2d($this->data, $this->pos + 2); $length = self::getUInt2d($this->data, $this->pos + 2);
$recordData = $this->readRecordData($this->data, $this->pos + 4, $length); $recordData = $this->readRecordData($this->data, $this->pos + 4, $length);
@ -3259,7 +3253,7 @@ class Xls extends BaseReader
/** /**
* Read HEADER record. * Read HEADER record.
*/ */
private function readHeader() private function readHeader(): void
{ {
$length = self::getUInt2d($this->data, $this->pos + 2); $length = self::getUInt2d($this->data, $this->pos + 2);
$recordData = $this->readRecordData($this->data, $this->pos + 4, $length); $recordData = $this->readRecordData($this->data, $this->pos + 4, $length);
@ -3286,7 +3280,7 @@ class Xls extends BaseReader
/** /**
* Read FOOTER record. * Read FOOTER record.
*/ */
private function readFooter() private function readFooter(): void
{ {
$length = self::getUInt2d($this->data, $this->pos + 2); $length = self::getUInt2d($this->data, $this->pos + 2);
$recordData = $this->readRecordData($this->data, $this->pos + 4, $length); $recordData = $this->readRecordData($this->data, $this->pos + 4, $length);
@ -3312,7 +3306,7 @@ class Xls extends BaseReader
/** /**
* Read HCENTER record. * Read HCENTER record.
*/ */
private function readHcenter() private function readHcenter(): void
{ {
$length = self::getUInt2d($this->data, $this->pos + 2); $length = self::getUInt2d($this->data, $this->pos + 2);
$recordData = $this->readRecordData($this->data, $this->pos + 4, $length); $recordData = $this->readRecordData($this->data, $this->pos + 4, $length);
@ -3331,7 +3325,7 @@ class Xls extends BaseReader
/** /**
* Read VCENTER record. * Read VCENTER record.
*/ */
private function readVcenter() private function readVcenter(): void
{ {
$length = self::getUInt2d($this->data, $this->pos + 2); $length = self::getUInt2d($this->data, $this->pos + 2);
$recordData = $this->readRecordData($this->data, $this->pos + 4, $length); $recordData = $this->readRecordData($this->data, $this->pos + 4, $length);
@ -3350,7 +3344,7 @@ class Xls extends BaseReader
/** /**
* Read LEFTMARGIN record. * Read LEFTMARGIN record.
*/ */
private function readLeftMargin() private function readLeftMargin(): void
{ {
$length = self::getUInt2d($this->data, $this->pos + 2); $length = self::getUInt2d($this->data, $this->pos + 2);
$recordData = $this->readRecordData($this->data, $this->pos + 4, $length); $recordData = $this->readRecordData($this->data, $this->pos + 4, $length);
@ -3367,7 +3361,7 @@ class Xls extends BaseReader
/** /**
* Read RIGHTMARGIN record. * Read RIGHTMARGIN record.
*/ */
private function readRightMargin() private function readRightMargin(): void
{ {
$length = self::getUInt2d($this->data, $this->pos + 2); $length = self::getUInt2d($this->data, $this->pos + 2);
$recordData = $this->readRecordData($this->data, $this->pos + 4, $length); $recordData = $this->readRecordData($this->data, $this->pos + 4, $length);
@ -3384,7 +3378,7 @@ class Xls extends BaseReader
/** /**
* Read TOPMARGIN record. * Read TOPMARGIN record.
*/ */
private function readTopMargin() private function readTopMargin(): void
{ {
$length = self::getUInt2d($this->data, $this->pos + 2); $length = self::getUInt2d($this->data, $this->pos + 2);
$recordData = $this->readRecordData($this->data, $this->pos + 4, $length); $recordData = $this->readRecordData($this->data, $this->pos + 4, $length);
@ -3401,7 +3395,7 @@ class Xls extends BaseReader
/** /**
* Read BOTTOMMARGIN record. * Read BOTTOMMARGIN record.
*/ */
private function readBottomMargin() private function readBottomMargin(): void
{ {
$length = self::getUInt2d($this->data, $this->pos + 2); $length = self::getUInt2d($this->data, $this->pos + 2);
$recordData = $this->readRecordData($this->data, $this->pos + 4, $length); $recordData = $this->readRecordData($this->data, $this->pos + 4, $length);
@ -3418,7 +3412,7 @@ class Xls extends BaseReader
/** /**
* Read PAGESETUP record. * Read PAGESETUP record.
*/ */
private function readPageSetup() private function readPageSetup(): void
{ {
$length = self::getUInt2d($this->data, $this->pos + 2); $length = self::getUInt2d($this->data, $this->pos + 2);
$recordData = $this->readRecordData($this->data, $this->pos + 4, $length); $recordData = $this->readRecordData($this->data, $this->pos + 4, $length);
@ -3481,7 +3475,7 @@ class Xls extends BaseReader
* PROTECT - Sheet protection (BIFF2 through BIFF8) * PROTECT - Sheet protection (BIFF2 through BIFF8)
* if this record is omitted, then it also means no sheet protection. * if this record is omitted, then it also means no sheet protection.
*/ */
private function readProtect() private function readProtect(): void
{ {
$length = self::getUInt2d($this->data, $this->pos + 2); $length = self::getUInt2d($this->data, $this->pos + 2);
$recordData = $this->readRecordData($this->data, $this->pos + 4, $length); $recordData = $this->readRecordData($this->data, $this->pos + 4, $length);
@ -3503,7 +3497,7 @@ class Xls extends BaseReader
/** /**
* SCENPROTECT. * SCENPROTECT.
*/ */
private function readScenProtect() private function readScenProtect(): void
{ {
$length = self::getUInt2d($this->data, $this->pos + 2); $length = self::getUInt2d($this->data, $this->pos + 2);
$recordData = $this->readRecordData($this->data, $this->pos + 4, $length); $recordData = $this->readRecordData($this->data, $this->pos + 4, $length);
@ -3526,7 +3520,7 @@ class Xls extends BaseReader
/** /**
* OBJECTPROTECT. * OBJECTPROTECT.
*/ */
private function readObjectProtect() private function readObjectProtect(): void
{ {
$length = self::getUInt2d($this->data, $this->pos + 2); $length = self::getUInt2d($this->data, $this->pos + 2);
$recordData = $this->readRecordData($this->data, $this->pos + 4, $length); $recordData = $this->readRecordData($this->data, $this->pos + 4, $length);
@ -3549,7 +3543,7 @@ class Xls extends BaseReader
/** /**
* PASSWORD - Sheet protection (hashed) password (BIFF2 through BIFF8). * PASSWORD - Sheet protection (hashed) password (BIFF2 through BIFF8).
*/ */
private function readPassword() private function readPassword(): void
{ {
$length = self::getUInt2d($this->data, $this->pos + 2); $length = self::getUInt2d($this->data, $this->pos + 2);
$recordData = $this->readRecordData($this->data, $this->pos + 4, $length); $recordData = $this->readRecordData($this->data, $this->pos + 4, $length);
@ -3567,7 +3561,7 @@ class Xls extends BaseReader
/** /**
* Read DEFCOLWIDTH record. * Read DEFCOLWIDTH record.
*/ */
private function readDefColWidth() private function readDefColWidth(): void
{ {
$length = self::getUInt2d($this->data, $this->pos + 2); $length = self::getUInt2d($this->data, $this->pos + 2);
$recordData = $this->readRecordData($this->data, $this->pos + 4, $length); $recordData = $this->readRecordData($this->data, $this->pos + 4, $length);
@ -3585,7 +3579,7 @@ class Xls extends BaseReader
/** /**
* Read COLINFO record. * Read COLINFO record.
*/ */
private function readColInfo() private function readColInfo(): void
{ {
$length = self::getUInt2d($this->data, $this->pos + 2); $length = self::getUInt2d($this->data, $this->pos + 2);
$recordData = $this->readRecordData($this->data, $this->pos + 4, $length); $recordData = $this->readRecordData($this->data, $this->pos + 4, $length);
@ -3643,7 +3637,7 @@ class Xls extends BaseReader
* -- "OpenOffice.org's Documentation of the Microsoft * -- "OpenOffice.org's Documentation of the Microsoft
* Excel File Format" * Excel File Format"
*/ */
private function readRow() private function readRow(): void
{ {
$length = self::getUInt2d($this->data, $this->pos + 2); $length = self::getUInt2d($this->data, $this->pos + 2);
$recordData = $this->readRecordData($this->data, $this->pos + 4, $length); $recordData = $this->readRecordData($this->data, $this->pos + 4, $length);
@ -3712,7 +3706,7 @@ class Xls extends BaseReader
* -- "OpenOffice.org's Documentation of the Microsoft * -- "OpenOffice.org's Documentation of the Microsoft
* Excel File Format" * Excel File Format"
*/ */
private function readRk() private function readRk(): void
{ {
$length = self::getUInt2d($this->data, $this->pos + 2); $length = self::getUInt2d($this->data, $this->pos + 2);
$recordData = $this->readRecordData($this->data, $this->pos + 4, $length); $recordData = $this->readRecordData($this->data, $this->pos + 4, $length);
@ -3756,7 +3750,7 @@ class Xls extends BaseReader
* -- "OpenOffice.org's Documentation of the Microsoft * -- "OpenOffice.org's Documentation of the Microsoft
* Excel File Format" * Excel File Format"
*/ */
private function readLabelSst() private function readLabelSst(): void
{ {
$length = self::getUInt2d($this->data, $this->pos + 2); $length = self::getUInt2d($this->data, $this->pos + 2);
$recordData = $this->readRecordData($this->data, $this->pos + 4, $length); $recordData = $this->readRecordData($this->data, $this->pos + 4, $length);
@ -3840,7 +3834,7 @@ class Xls extends BaseReader
* -- "OpenOffice.org's Documentation of the Microsoft * -- "OpenOffice.org's Documentation of the Microsoft
* Excel File Format" * Excel File Format"
*/ */
private function readMulRk() private function readMulRk(): void
{ {
$length = self::getUInt2d($this->data, $this->pos + 2); $length = self::getUInt2d($this->data, $this->pos + 2);
$recordData = $this->readRecordData($this->data, $this->pos + 4, $length); $recordData = $this->readRecordData($this->data, $this->pos + 4, $length);
@ -3893,7 +3887,7 @@ class Xls extends BaseReader
* -- "OpenOffice.org's Documentation of the Microsoft * -- "OpenOffice.org's Documentation of the Microsoft
* Excel File Format" * Excel File Format"
*/ */
private function readNumber() private function readNumber(): void
{ {
$length = self::getUInt2d($this->data, $this->pos + 2); $length = self::getUInt2d($this->data, $this->pos + 2);
$recordData = $this->readRecordData($this->data, $this->pos + 4, $length); $recordData = $this->readRecordData($this->data, $this->pos + 4, $length);
@ -3934,7 +3928,7 @@ class Xls extends BaseReader
* -- "OpenOffice.org's Documentation of the Microsoft * -- "OpenOffice.org's Documentation of the Microsoft
* Excel File Format" * Excel File Format"
*/ */
private function readFormula() private function readFormula(): void
{ {
$length = self::getUInt2d($this->data, $this->pos + 2); $length = self::getUInt2d($this->data, $this->pos + 2);
$recordData = $this->readRecordData($this->data, $this->pos + 4, $length); $recordData = $this->readRecordData($this->data, $this->pos + 4, $length);
@ -4060,7 +4054,7 @@ class Xls extends BaseReader
* which usually contains relative references. * which usually contains relative references.
* These will be used to construct the formula in each shared formula part after the sheet is read. * These will be used to construct the formula in each shared formula part after the sheet is read.
*/ */
private function readSharedFmla() private function readSharedFmla(): void
{ {
$length = self::getUInt2d($this->data, $this->pos + 2); $length = self::getUInt2d($this->data, $this->pos + 2);
$recordData = $this->readRecordData($this->data, $this->pos + 4, $length); $recordData = $this->readRecordData($this->data, $this->pos + 4, $length);
@ -4118,7 +4112,7 @@ class Xls extends BaseReader
* -- "OpenOffice.org's Documentation of the Microsoft * -- "OpenOffice.org's Documentation of the Microsoft
* Excel File Format" * Excel File Format"
*/ */
private function readBoolErr() private function readBoolErr(): void
{ {
$length = self::getUInt2d($this->data, $this->pos + 2); $length = self::getUInt2d($this->data, $this->pos + 2);
$recordData = $this->readRecordData($this->data, $this->pos + 4, $length); $recordData = $this->readRecordData($this->data, $this->pos + 4, $length);
@ -4177,7 +4171,7 @@ class Xls extends BaseReader
* -- "OpenOffice.org's Documentation of the Microsoft * -- "OpenOffice.org's Documentation of the Microsoft
* Excel File Format" * Excel File Format"
*/ */
private function readMulBlank() private function readMulBlank(): void
{ {
$length = self::getUInt2d($this->data, $this->pos + 2); $length = self::getUInt2d($this->data, $this->pos + 2);
$recordData = $this->readRecordData($this->data, $this->pos + 4, $length); $recordData = $this->readRecordData($this->data, $this->pos + 4, $length);
@ -4218,7 +4212,7 @@ class Xls extends BaseReader
* -- "OpenOffice.org's Documentation of the Microsoft * -- "OpenOffice.org's Documentation of the Microsoft
* Excel File Format" * Excel File Format"
*/ */
private function readLabel() private function readLabel(): void
{ {
$length = self::getUInt2d($this->data, $this->pos + 2); $length = self::getUInt2d($this->data, $this->pos + 2);
$recordData = $this->readRecordData($this->data, $this->pos + 4, $length); $recordData = $this->readRecordData($this->data, $this->pos + 4, $length);
@ -4262,7 +4256,7 @@ class Xls extends BaseReader
/** /**
* Read BLANK record. * Read BLANK record.
*/ */
private function readBlank() private function readBlank(): void
{ {
$length = self::getUInt2d($this->data, $this->pos + 2); $length = self::getUInt2d($this->data, $this->pos + 2);
$recordData = $this->readRecordData($this->data, $this->pos + 4, $length); $recordData = $this->readRecordData($this->data, $this->pos + 4, $length);
@ -4292,7 +4286,7 @@ class Xls extends BaseReader
/** /**
* Read MSODRAWING record. * Read MSODRAWING record.
*/ */
private function readMsoDrawing() private function readMsoDrawing(): void
{ {
$length = self::getUInt2d($this->data, $this->pos + 2); $length = self::getUInt2d($this->data, $this->pos + 2);
@ -4306,7 +4300,7 @@ class Xls extends BaseReader
/** /**
* Read OBJ record. * Read OBJ record.
*/ */
private function readObj() private function readObj(): void
{ {
$length = self::getUInt2d($this->data, $this->pos + 2); $length = self::getUInt2d($this->data, $this->pos + 2);
$recordData = $this->readRecordData($this->data, $this->pos + 4, $length); $recordData = $this->readRecordData($this->data, $this->pos + 4, $length);
@ -4346,7 +4340,7 @@ class Xls extends BaseReader
/** /**
* Read WINDOW2 record. * Read WINDOW2 record.
*/ */
private function readWindow2() private function readWindow2(): void
{ {
$length = self::getUInt2d($this->data, $this->pos + 2); $length = self::getUInt2d($this->data, $this->pos + 2);
$recordData = $this->readRecordData($this->data, $this->pos + 4, $length); $recordData = $this->readRecordData($this->data, $this->pos + 4, $length);
@ -4417,7 +4411,7 @@ class Xls extends BaseReader
/** /**
* Read PLV Record(Created by Excel2007 or upper). * Read PLV Record(Created by Excel2007 or upper).
*/ */
private function readPageLayoutView() private function readPageLayoutView(): void
{ {
$length = self::getUInt2d($this->data, $this->pos + 2); $length = self::getUInt2d($this->data, $this->pos + 2);
$recordData = $this->readRecordData($this->data, $this->pos + 4, $length); $recordData = $this->readRecordData($this->data, $this->pos + 4, $length);
@ -4454,7 +4448,7 @@ class Xls extends BaseReader
/** /**
* Read SCL record. * Read SCL record.
*/ */
private function readScl() private function readScl(): void
{ {
$length = self::getUInt2d($this->data, $this->pos + 2); $length = self::getUInt2d($this->data, $this->pos + 2);
$recordData = $this->readRecordData($this->data, $this->pos + 4, $length); $recordData = $this->readRecordData($this->data, $this->pos + 4, $length);
@ -4475,7 +4469,7 @@ class Xls extends BaseReader
/** /**
* Read PANE record. * Read PANE record.
*/ */
private function readPane() private function readPane(): void
{ {
$length = self::getUInt2d($this->data, $this->pos + 2); $length = self::getUInt2d($this->data, $this->pos + 2);
$recordData = $this->readRecordData($this->data, $this->pos + 4, $length); $recordData = $this->readRecordData($this->data, $this->pos + 4, $length);
@ -4509,7 +4503,7 @@ class Xls extends BaseReader
/** /**
* Read SELECTION record. There is one such record for each pane in the sheet. * Read SELECTION record. There is one such record for each pane in the sheet.
*/ */
private function readSelection() private function readSelection(): void
{ {
$length = self::getUInt2d($this->data, $this->pos + 2); $length = self::getUInt2d($this->data, $this->pos + 2);
$recordData = $this->readRecordData($this->data, $this->pos + 4, $length); $recordData = $this->readRecordData($this->data, $this->pos + 4, $length);
@ -4586,7 +4580,7 @@ class Xls extends BaseReader
* -- "OpenOffice.org's Documentation of the Microsoft * -- "OpenOffice.org's Documentation of the Microsoft
* Excel File Format" * Excel File Format"
*/ */
private function readMergedCells() private function readMergedCells(): void
{ {
$length = self::getUInt2d($this->data, $this->pos + 2); $length = self::getUInt2d($this->data, $this->pos + 2);
$recordData = $this->readRecordData($this->data, $this->pos + 4, $length); $recordData = $this->readRecordData($this->data, $this->pos + 4, $length);
@ -4608,7 +4602,7 @@ class Xls extends BaseReader
/** /**
* Read HYPERLINK record. * Read HYPERLINK record.
*/ */
private function readHyperLink() private function readHyperLink(): void
{ {
$length = self::getUInt2d($this->data, $this->pos + 2); $length = self::getUInt2d($this->data, $this->pos + 2);
$recordData = $this->readRecordData($this->data, $this->pos + 4, $length); $recordData = $this->readRecordData($this->data, $this->pos + 4, $length);
@ -4781,7 +4775,7 @@ class Xls extends BaseReader
/** /**
* Read DATAVALIDATIONS record. * Read DATAVALIDATIONS record.
*/ */
private function readDataValidations() private function readDataValidations(): void
{ {
$length = self::getUInt2d($this->data, $this->pos + 2); $length = self::getUInt2d($this->data, $this->pos + 2);
$recordData = $this->readRecordData($this->data, $this->pos + 4, $length); $recordData = $this->readRecordData($this->data, $this->pos + 4, $length);
@ -4793,7 +4787,7 @@ class Xls extends BaseReader
/** /**
* Read DATAVALIDATION record. * Read DATAVALIDATION record.
*/ */
private function readDataValidation() private function readDataValidation(): void
{ {
$length = self::getUInt2d($this->data, $this->pos + 2); $length = self::getUInt2d($this->data, $this->pos + 2);
$recordData = $this->readRecordData($this->data, $this->pos + 4, $length); $recordData = $this->readRecordData($this->data, $this->pos + 4, $length);
@ -5003,7 +4997,7 @@ class Xls extends BaseReader
/** /**
* Read SHEETLAYOUT record. Stores sheet tab color information. * Read SHEETLAYOUT record. Stores sheet tab color information.
*/ */
private function readSheetLayout() private function readSheetLayout(): void
{ {
$length = self::getUInt2d($this->data, $this->pos + 2); $length = self::getUInt2d($this->data, $this->pos + 2);
$recordData = $this->readRecordData($this->data, $this->pos + 4, $length); $recordData = $this->readRecordData($this->data, $this->pos + 4, $length);
@ -5043,7 +5037,7 @@ class Xls extends BaseReader
/** /**
* Read SHEETPROTECTION record (FEATHEADR). * Read SHEETPROTECTION record (FEATHEADR).
*/ */
private function readSheetProtection() private function readSheetProtection(): void
{ {
$length = self::getUInt2d($this->data, $this->pos + 2); $length = self::getUInt2d($this->data, $this->pos + 2);
$recordData = $this->readRecordData($this->data, $this->pos + 4, $length); $recordData = $this->readRecordData($this->data, $this->pos + 4, $length);
@ -5143,7 +5137,7 @@ class Xls extends BaseReader
* Reading of this record is based on Microsoft Office Excel 97-2000 Binary File Format Specification, * Reading of this record is based on Microsoft Office Excel 97-2000 Binary File Format Specification,
* where it is referred to as FEAT record. * where it is referred to as FEAT record.
*/ */
private function readRangeProtection() private function readRangeProtection(): void
{ {
$length = self::getUInt2d($this->data, $this->pos + 2); $length = self::getUInt2d($this->data, $this->pos + 2);
$recordData = $this->readRecordData($this->data, $this->pos + 4, $length); $recordData = $this->readRecordData($this->data, $this->pos + 4, $length);
@ -5205,7 +5199,7 @@ class Xls extends BaseReader
* When MSODRAWING data on a sheet exceeds 8224 bytes, CONTINUE records are used instead. Undocumented. * When MSODRAWING data on a sheet exceeds 8224 bytes, CONTINUE records are used instead. Undocumented.
* In this case, we must treat the CONTINUE record as a MSODRAWING record. * In this case, we must treat the CONTINUE record as a MSODRAWING record.
*/ */
private function readContinue() private function readContinue(): void
{ {
$length = self::getUInt2d($this->data, $this->pos + 2); $length = self::getUInt2d($this->data, $this->pos + 2);
$recordData = $this->readRecordData($this->data, $this->pos + 4, $length); $recordData = $this->readRecordData($this->data, $this->pos + 4, $length);
@ -5325,7 +5319,7 @@ class Xls extends BaseReader
// start parsing the formula data // start parsing the formula data
$tokens = []; $tokens = [];
while (strlen($formulaData) > 0 and $token = $this->getNextToken($formulaData, $baseCell)) { while (strlen($formulaData) > 0 && $token = $this->getNextToken($formulaData, $baseCell)) {
$tokens[] = $token; $tokens[] = $token;
$formulaData = substr($formulaData, $token['size']); $formulaData = substr($formulaData, $token['size']);
} }
@ -5516,8 +5510,6 @@ class Xls extends BaseReader
* @param string $formulaData Formula data * @param string $formulaData Formula data
* @param string $baseCell Base cell, only needed when formula contains tRefN tokens, e.g. with shared formulas * @param string $baseCell Base cell, only needed when formula contains tRefN tokens, e.g. with shared formulas
* *
* @throws Exception
*
* @return array * @return array
*/ */
private function getNextToken($formulaData, $baseCell = 'A1') private function getNextToken($formulaData, $baseCell = 'A1')
@ -7186,8 +7178,6 @@ class Xls extends BaseReader
* *
* @param string $subData * @param string $subData
* *
* @throws Exception
*
* @return string * @return string
*/ */
private function readBIFF5CellRangeAddressFixed($subData) private function readBIFF5CellRangeAddressFixed($subData)
@ -7213,7 +7203,7 @@ class Xls extends BaseReader
$fc = Coordinate::stringFromColumnIndex($fc + 1); $fc = Coordinate::stringFromColumnIndex($fc + 1);
$lc = Coordinate::stringFromColumnIndex($lc + 1); $lc = Coordinate::stringFromColumnIndex($lc + 1);
if ($fr == $lr and $fc == $lc) { if ($fr == $lr && $fc == $lc) {
return "$fc$fr"; return "$fc$fr";
} }
@ -7227,8 +7217,6 @@ class Xls extends BaseReader
* *
* @param string $subData * @param string $subData
* *
* @throws Exception
*
* @return string * @return string
*/ */
private function readBIFF8CellRangeAddressFixed($subData) private function readBIFF8CellRangeAddressFixed($subData)
@ -7254,7 +7242,7 @@ class Xls extends BaseReader
$fc = Coordinate::stringFromColumnIndex($fc + 1); $fc = Coordinate::stringFromColumnIndex($fc + 1);
$lc = Coordinate::stringFromColumnIndex($lc + 1); $lc = Coordinate::stringFromColumnIndex($lc + 1);
if ($fr == $lr and $fc == $lc) { if ($fr == $lr && $fc == $lc) {
return "$fc$fr"; return "$fc$fr";
} }
@ -7465,8 +7453,6 @@ class Xls extends BaseReader
* *
* @param int $index * @param int $index
* *
* @throws Exception
*
* @return false|string * @return false|string
*/ */
private function readSheetRangeByRefIndex($index) private function readSheetRangeByRefIndex($index)
@ -7477,7 +7463,7 @@ class Xls extends BaseReader
switch ($type) { switch ($type) {
case 'internal': case 'internal':
// check if we have a deleted 3d reference // check if we have a deleted 3d reference
if ($this->ref[$index]['firstSheetIndex'] == 0xFFFF or $this->ref[$index]['lastSheetIndex'] == 0xFFFF) { if ($this->ref[$index]['firstSheetIndex'] == 0xFFFF || $this->ref[$index]['lastSheetIndex'] == 0xFFFF) {
throw new Exception('Deleted sheet reference'); throw new Exception('Deleted sheet reference');
} }
@ -7702,7 +7688,7 @@ class Xls extends BaseReader
$string = self::readUnicodeString(substr($subData, 1), $characterCount); $string = self::readUnicodeString(substr($subData, 1), $characterCount);
// add 1 for the string length // add 1 for the string length
$string['size'] += 1; ++$string['size'];
return $string; return $string;
} }
@ -7795,13 +7781,13 @@ class Xls extends BaseReader
$mantissa = (0x100000 | ($rknumhigh & 0x000fffff)); $mantissa = (0x100000 | ($rknumhigh & 0x000fffff));
$mantissalow1 = ($rknumlow & 0x80000000) >> 31; $mantissalow1 = ($rknumlow & 0x80000000) >> 31;
$mantissalow2 = ($rknumlow & 0x7fffffff); $mantissalow2 = ($rknumlow & 0x7fffffff);
$value = $mantissa / pow(2, (20 - $exp)); $value = $mantissa / 2 ** (20 - $exp);
if ($mantissalow1 != 0) { if ($mantissalow1 != 0) {
$value += 1 / pow(2, (21 - $exp)); $value += 1 / 2 ** (21 - $exp);
} }
$value += $mantissalow2 / pow(2, (52 - $exp)); $value += $mantissalow2 / 2 ** (52 - $exp);
if ($sign) { if ($sign) {
$value *= -1; $value *= -1;
} }
@ -7827,7 +7813,7 @@ class Xls extends BaseReader
$sign = ($rknum & 0x80000000) >> 31; $sign = ($rknum & 0x80000000) >> 31;
$exp = ($rknum & 0x7ff00000) >> 20; $exp = ($rknum & 0x7ff00000) >> 20;
$mantissa = (0x100000 | ($rknum & 0x000ffffc)); $mantissa = (0x100000 | ($rknum & 0x000ffffc));
$value = $mantissa / pow(2, (20 - ($exp - 1023))); $value = $mantissa / 2 ** (20 - ($exp - 1023));
if ($sign) { if ($sign) {
$value = -1 * $value; $value = -1 * $value;
} }

44
src/PhpSpreadsheet/Reader/Xls/Escher.php
View File

@ -178,7 +178,7 @@ class Escher
/** /**
* Read a generic record. * Read a generic record.
*/ */
private function readDefault() private function readDefault(): void
{ {
// offset 0; size: 2; recVer and recInstance // offset 0; size: 2; recVer and recInstance
$verInstance = Xls::getUInt2d($this->data, $this->pos); $verInstance = Xls::getUInt2d($this->data, $this->pos);
@ -199,7 +199,7 @@ class Escher
/** /**
* Read DggContainer record (Drawing Group Container). * Read DggContainer record (Drawing Group Container).
*/ */
private function readDggContainer() private function readDggContainer(): void
{ {
$length = Xls::getInt4d($this->data, $this->pos + 4); $length = Xls::getInt4d($this->data, $this->pos + 4);
$recordData = substr($this->data, $this->pos + 8, $length); $recordData = substr($this->data, $this->pos + 8, $length);
@ -217,7 +217,7 @@ class Escher
/** /**
* Read Dgg record (Drawing Group). * Read Dgg record (Drawing Group).
*/ */
private function readDgg() private function readDgg(): void
{ {
$length = Xls::getInt4d($this->data, $this->pos + 4); $length = Xls::getInt4d($this->data, $this->pos + 4);
$recordData = substr($this->data, $this->pos + 8, $length); $recordData = substr($this->data, $this->pos + 8, $length);
@ -229,7 +229,7 @@ class Escher
/** /**
* Read BstoreContainer record (Blip Store Container). * Read BstoreContainer record (Blip Store Container).
*/ */
private function readBstoreContainer() private function readBstoreContainer(): void
{ {
$length = Xls::getInt4d($this->data, $this->pos + 4); $length = Xls::getInt4d($this->data, $this->pos + 4);
$recordData = substr($this->data, $this->pos + 8, $length); $recordData = substr($this->data, $this->pos + 8, $length);
@ -247,7 +247,7 @@ class Escher
/** /**
* Read BSE record. * Read BSE record.
*/ */
private function readBSE() private function readBSE(): void
{ {
// offset: 0; size: 2; recVer and recInstance // offset: 0; size: 2; recVer and recInstance
@ -313,7 +313,7 @@ class Escher
/** /**
* Read BlipJPEG record. Holds raw JPEG image data. * Read BlipJPEG record. Holds raw JPEG image data.
*/ */
private function readBlipJPEG() private function readBlipJPEG(): void
{ {
// offset: 0; size: 2; recVer and recInstance // offset: 0; size: 2; recVer and recInstance
@ -340,7 +340,7 @@ class Escher
// offset: var; size: 1; tag // offset: var; size: 1; tag
$tag = ord($recordData[$pos]); $tag = ord($recordData[$pos]);
$pos += 1; ++$pos;
// offset: var; size: var; the raw image data // offset: var; size: var; the raw image data
$data = substr($recordData, $pos); $data = substr($recordData, $pos);
@ -354,7 +354,7 @@ class Escher
/** /**
* Read BlipPNG record. Holds raw PNG image data. * Read BlipPNG record. Holds raw PNG image data.
*/ */
private function readBlipPNG() private function readBlipPNG(): void
{ {
// offset: 0; size: 2; recVer and recInstance // offset: 0; size: 2; recVer and recInstance
@ -381,7 +381,7 @@ class Escher
// offset: var; size: 1; tag // offset: var; size: 1; tag
$tag = ord($recordData[$pos]); $tag = ord($recordData[$pos]);
$pos += 1; ++$pos;
// offset: var; size: var; the raw image data // offset: var; size: var; the raw image data
$data = substr($recordData, $pos); $data = substr($recordData, $pos);
@ -395,7 +395,7 @@ class Escher
/** /**
* Read OPT record. This record may occur within DggContainer record or SpContainer. * Read OPT record. This record may occur within DggContainer record or SpContainer.
*/ */
private function readOPT() private function readOPT(): void
{ {
// offset: 0; size: 2; recVer and recInstance // offset: 0; size: 2; recVer and recInstance
@ -414,7 +414,7 @@ class Escher
/** /**
* Read TertiaryOPT record. * Read TertiaryOPT record.
*/ */
private function readTertiaryOPT() private function readTertiaryOPT(): void
{ {
// offset: 0; size: 2; recVer and recInstance // offset: 0; size: 2; recVer and recInstance
@ -431,7 +431,7 @@ class Escher
/** /**
* Read SplitMenuColors record. * Read SplitMenuColors record.
*/ */
private function readSplitMenuColors() private function readSplitMenuColors(): void
{ {
$length = Xls::getInt4d($this->data, $this->pos + 4); $length = Xls::getInt4d($this->data, $this->pos + 4);
$recordData = substr($this->data, $this->pos + 8, $length); $recordData = substr($this->data, $this->pos + 8, $length);
@ -443,7 +443,7 @@ class Escher
/** /**
* Read DgContainer record (Drawing Container). * Read DgContainer record (Drawing Container).
*/ */
private function readDgContainer() private function readDgContainer(): void
{ {
$length = Xls::getInt4d($this->data, $this->pos + 4); $length = Xls::getInt4d($this->data, $this->pos + 4);
$recordData = substr($this->data, $this->pos + 8, $length); $recordData = substr($this->data, $this->pos + 8, $length);
@ -461,7 +461,7 @@ class Escher
/** /**
* Read Dg record (Drawing). * Read Dg record (Drawing).
*/ */
private function readDg() private function readDg(): void
{ {
$length = Xls::getInt4d($this->data, $this->pos + 4); $length = Xls::getInt4d($this->data, $this->pos + 4);
$recordData = substr($this->data, $this->pos + 8, $length); $recordData = substr($this->data, $this->pos + 8, $length);
@ -473,7 +473,7 @@ class Escher
/** /**
* Read SpgrContainer record (Shape Group Container). * Read SpgrContainer record (Shape Group Container).
*/ */
private function readSpgrContainer() private function readSpgrContainer(): void
{ {
// context is either context DgContainer or SpgrContainer // context is either context DgContainer or SpgrContainer
@ -501,7 +501,7 @@ class Escher
/** /**
* Read SpContainer record (Shape Container). * Read SpContainer record (Shape Container).
*/ */
private function readSpContainer() private function readSpContainer(): void
{ {
$length = Xls::getInt4d($this->data, $this->pos + 4); $length = Xls::getInt4d($this->data, $this->pos + 4);
$recordData = substr($this->data, $this->pos + 8, $length); $recordData = substr($this->data, $this->pos + 8, $length);
@ -521,7 +521,7 @@ class Escher
/** /**
* Read Spgr record (Shape Group). * Read Spgr record (Shape Group).
*/ */
private function readSpgr() private function readSpgr(): void
{ {
$length = Xls::getInt4d($this->data, $this->pos + 4); $length = Xls::getInt4d($this->data, $this->pos + 4);
$recordData = substr($this->data, $this->pos + 8, $length); $recordData = substr($this->data, $this->pos + 8, $length);
@ -533,7 +533,7 @@ class Escher
/** /**
* Read Sp record (Shape). * Read Sp record (Shape).
*/ */
private function readSp() private function readSp(): void
{ {
// offset: 0; size: 2; recVer and recInstance // offset: 0; size: 2; recVer and recInstance
@ -550,7 +550,7 @@ class Escher
/** /**
* Read ClientTextbox record. * Read ClientTextbox record.
*/ */
private function readClientTextbox() private function readClientTextbox(): void
{ {
// offset: 0; size: 2; recVer and recInstance // offset: 0; size: 2; recVer and recInstance
@ -567,7 +567,7 @@ class Escher
/** /**
* Read ClientAnchor record. This record holds information about where the shape is anchored in worksheet. * Read ClientAnchor record. This record holds information about where the shape is anchored in worksheet.
*/ */
private function readClientAnchor() private function readClientAnchor(): void
{ {
$length = Xls::getInt4d($this->data, $this->pos + 4); $length = Xls::getInt4d($this->data, $this->pos + 4);
$recordData = substr($this->data, $this->pos + 8, $length); $recordData = substr($this->data, $this->pos + 8, $length);
@ -621,7 +621,7 @@ class Escher
/** /**
* Read ClientData record. * Read ClientData record.
*/ */
private function readClientData() private function readClientData(): void
{ {
$length = Xls::getInt4d($this->data, $this->pos + 4); $length = Xls::getInt4d($this->data, $this->pos + 4);
$recordData = substr($this->data, $this->pos + 8, $length); $recordData = substr($this->data, $this->pos + 8, $length);
@ -636,7 +636,7 @@ class Escher
* @param string $data Binary data * @param string $data Binary data
* @param int $n Number of properties * @param int $n Number of properties
*/ */
private function readOfficeArtRGFOPTE($data, $n) private function readOfficeArtRGFOPTE($data, $n): void
{ {
$splicedComplexData = substr($data, 6 * $n); $splicedComplexData = substr($data, 6 * $n);

6
src/PhpSpreadsheet/Reader/Xls/MD5.php
View File

@ -24,7 +24,7 @@ class MD5
/** /**
* Reset the MD5 stream context. * Reset the MD5 stream context.
*/ */
public function reset() public function reset(): void
{ {
$this->a = 0x67452301; $this->a = 0x67452301;
$this->b = 0xEFCDAB89; $this->b = 0xEFCDAB89;
@ -56,7 +56,7 @@ class MD5
* *
* @param string $data Data to add * @param string $data Data to add
*/ */
public function add($data) public function add($data): void
{ {
$words = array_values(unpack('V16', $data)); $words = array_values(unpack('V16', $data));
@ -168,7 +168,7 @@ class MD5
return $Y ^ ($X | (~$Z)); // Y XOR (X OR NOT Z) return $Y ^ ($X | (~$Z)); // Y XOR (X OR NOT Z)
} }
private static function step($func, &$A, $B, $C, $D, $M, $s, $t) private static function step($func, &$A, $B, $C, $D, $M, $s, $t): void
{ {
$A = ($A + call_user_func($func, $B, $C, $D) + $M + $t) & 0xffffffff; $A = ($A + call_user_func($func, $B, $C, $D) + $M + $t) & 0xffffffff;
$A = self::rotate($A, $s); $A = self::rotate($A, $s);

44
src/PhpSpreadsheet/Reader/Xlsx.php
View File

@ -35,6 +35,8 @@ use PhpOffice\PhpSpreadsheet\Style\Style;
use PhpOffice\PhpSpreadsheet\Worksheet\HeaderFooterDrawing; use PhpOffice\PhpSpreadsheet\Worksheet\HeaderFooterDrawing;
use PhpOffice\PhpSpreadsheet\Worksheet\Worksheet; use PhpOffice\PhpSpreadsheet\Worksheet\Worksheet;
use SimpleXMLElement; use SimpleXMLElement;
use stdClass;
use Throwable;
use XMLReader; use XMLReader;
use ZipArchive; use ZipArchive;
@ -69,8 +71,6 @@ class Xlsx extends BaseReader
* *
* @param string $pFilename * @param string $pFilename
* *
* @throws Exception
*
* @return bool * @return bool
*/ */
public function canRead($pFilename) public function canRead($pFilename)
@ -95,8 +95,6 @@ class Xlsx extends BaseReader
* *
* @param string $pFilename * @param string $pFilename
* *
* @throws Exception
*
* @return array * @return array
*/ */
public function listWorksheetNames($pFilename) public function listWorksheetNames($pFilename)
@ -140,8 +138,6 @@ class Xlsx extends BaseReader
* *
* @param string $pFilename * @param string $pFilename
* *
* @throws Exception
*
* @return array * @return array
*/ */
public function listWorksheetInfo($pFilename) public function listWorksheetInfo($pFilename)
@ -262,7 +258,7 @@ class Xlsx extends BaseReader
return isset($c->v) ? (string) $c->v : null; return isset($c->v) ? (string) $c->v : null;
} }
private function castToFormula($c, $r, &$cellDataType, &$value, &$calculatedValue, &$sharedFormulas, $castBaseType) private function castToFormula($c, $r, &$cellDataType, &$value, &$calculatedValue, &$sharedFormulas, $castBaseType): void
{ {
$cellDataType = 'f'; $cellDataType = 'f';
$value = "={$c->f}"; $value = "={$c->f}";
@ -288,7 +284,6 @@ class Xlsx extends BaseReader
} }
/** /**
* @param ZipArchive $archive
* @param string $fileName * @param string $fileName
* *
* @return string * @return string
@ -318,8 +313,6 @@ class Xlsx extends BaseReader
* *
* @param string $pFilename * @param string $pFilename
* *
* @throws Exception
*
* @return Spreadsheet * @return Spreadsheet
*/ */
public function load($pFilename) public function load($pFilename)
@ -666,7 +659,7 @@ class Xlsx extends BaseReader
$coordinates = Coordinate::coordinateFromString($r); $coordinates = Coordinate::coordinateFromString($r);
if (!$this->getReadFilter()->readCell($coordinates[0], (int) $coordinates[1], $docSheet->getTitle())) { if (!$this->getReadFilter()->readCell($coordinates[0], (int) $coordinates[1], $docSheet->getTitle())) {
$rowIndex += 1; ++$rowIndex;
continue; continue;
} }
@ -752,9 +745,9 @@ class Xlsx extends BaseReader
(int) ($c['s']) : 0); (int) ($c['s']) : 0);
} }
} }
$rowIndex += 1; ++$rowIndex;
} }
$cIndex += 1; ++$cIndex;
} }
} }
@ -899,7 +892,7 @@ class Xlsx extends BaseReader
Settings::getLibXmlLoaderOptions() Settings::getLibXmlLoaderOptions()
); );
$vmlCommentsFile->registerXPathNamespace('v', 'urn:schemas-microsoft-com:vml'); $vmlCommentsFile->registerXPathNamespace('v', 'urn:schemas-microsoft-com:vml');
} catch (\Throwable $ex) { } catch (Throwable $ex) {
//Ignore unparsable vmlDrawings. Later they will be moved from $unparsedVmlDrawings to $unparsedLoadedData //Ignore unparsable vmlDrawings. Later they will be moved from $unparsedVmlDrawings to $unparsedLoadedData
continue; continue;
} }
@ -1123,7 +1116,7 @@ class Xlsx extends BaseReader
$xfrm = $oneCellAnchor->pic->spPr->children('http://schemas.openxmlformats.org/drawingml/2006/main')->xfrm; $xfrm = $oneCellAnchor->pic->spPr->children('http://schemas.openxmlformats.org/drawingml/2006/main')->xfrm;
/** @var SimpleXMLElement $outerShdw */ /** @var SimpleXMLElement $outerShdw */
$outerShdw = $oneCellAnchor->pic->spPr->children('http://schemas.openxmlformats.org/drawingml/2006/main')->effectLst->outerShdw; $outerShdw = $oneCellAnchor->pic->spPr->children('http://schemas.openxmlformats.org/drawingml/2006/main')->effectLst->outerShdw;
/** @var \SimpleXMLElement $hlinkClick */ /** @var SimpleXMLElement $hlinkClick */
$hlinkClick = $oneCellAnchor->pic->nvPicPr->cNvPr->children('http://schemas.openxmlformats.org/drawingml/2006/main')->hlinkClick; $hlinkClick = $oneCellAnchor->pic->nvPicPr->cNvPr->children('http://schemas.openxmlformats.org/drawingml/2006/main')->hlinkClick;
$objDrawing = new \PhpOffice\PhpSpreadsheet\Worksheet\Drawing(); $objDrawing = new \PhpOffice\PhpSpreadsheet\Worksheet\Drawing();
@ -1564,10 +1557,9 @@ class Xlsx extends BaseReader
} }
/** /**
* @param Style $docStyle * @param SimpleXMLElement|stdClass $style
* @param SimpleXMLElement|\stdClass $style
*/ */
private static function readStyle(Style $docStyle, $style) private static function readStyle(Style $docStyle, $style): void
{ {
$docStyle->getNumberFormat()->setFormatCode($style->numFmt); $docStyle->getNumberFormat()->setFormatCode($style->numFmt);
@ -1692,10 +1684,9 @@ class Xlsx extends BaseReader
} }
/** /**
* @param Border $docBorder
* @param SimpleXMLElement $eleBorder * @param SimpleXMLElement $eleBorder
*/ */
private static function readBorder(Border $docBorder, $eleBorder) private static function readBorder(Border $docBorder, $eleBorder): void
{ {
if (isset($eleBorder['style'])) { if (isset($eleBorder['style'])) {
$docBorder->setBorderStyle((string) $eleBorder['style']); $docBorder->setBorderStyle((string) $eleBorder['style']);
@ -1768,11 +1759,10 @@ class Xlsx extends BaseReader
} }
/** /**
* @param Spreadsheet $excel
* @param mixed $customUITarget * @param mixed $customUITarget
* @param mixed $zip * @param mixed $zip
*/ */
private function readRibbon(Spreadsheet $excel, $customUITarget, $zip) private function readRibbon(Spreadsheet $excel, $customUITarget, $zip): void
{ {
$baseDir = dirname($customUITarget); $baseDir = dirname($customUITarget);
$nameCustomUI = basename($customUITarget); $nameCustomUI = basename($customUITarget);
@ -1874,10 +1864,10 @@ class Xlsx extends BaseReader
/** /**
* @param \PhpOffice\PhpSpreadsheet\Worksheet\Drawing $objDrawing * @param \PhpOffice\PhpSpreadsheet\Worksheet\Drawing $objDrawing
* @param \SimpleXMLElement $cellAnchor * @param SimpleXMLElement $cellAnchor
* @param array $hyperlinks * @param array $hyperlinks
*/ */
private function readHyperLinkDrawing($objDrawing, $cellAnchor, $hyperlinks) private function readHyperLinkDrawing($objDrawing, $cellAnchor, $hyperlinks): void
{ {
$hlinkClick = $cellAnchor->pic->nvPicPr->cNvPr->children('http://schemas.openxmlformats.org/drawingml/2006/main')->hlinkClick; $hlinkClick = $cellAnchor->pic->nvPicPr->cNvPr->children('http://schemas.openxmlformats.org/drawingml/2006/main')->hlinkClick;
@ -1893,7 +1883,7 @@ class Xlsx extends BaseReader
$objDrawing->setHyperlink($hyperlink); $objDrawing->setHyperlink($hyperlink);
} }
private function readProtection(Spreadsheet $excel, SimpleXMLElement $xmlWorkbook) private function readProtection(Spreadsheet $excel, SimpleXMLElement $xmlWorkbook): void
{ {
if (!$xmlWorkbook->workbookProtection) { if (!$xmlWorkbook->workbookProtection) {
return; return;
@ -1920,7 +1910,7 @@ class Xlsx extends BaseReader
} }
} }
private function readFormControlProperties(Spreadsheet $excel, ZipArchive $zip, $dir, $fileWorksheet, $docSheet, array &$unparsedLoadedData) private function readFormControlProperties(Spreadsheet $excel, ZipArchive $zip, $dir, $fileWorksheet, $docSheet, array &$unparsedLoadedData): void
{ {
if (!$zip->locateName(dirname("$dir/$fileWorksheet") . '/_rels/' . basename($fileWorksheet) . '.rels')) { if (!$zip->locateName(dirname("$dir/$fileWorksheet") . '/_rels/' . basename($fileWorksheet) . '.rels')) {
return; return;
@ -1952,7 +1942,7 @@ class Xlsx extends BaseReader
unset($unparsedCtrlProps); unset($unparsedCtrlProps);
} }
private function readPrinterSettings(Spreadsheet $excel, ZipArchive $zip, $dir, $fileWorksheet, $docSheet, array &$unparsedLoadedData) private function readPrinterSettings(Spreadsheet $excel, ZipArchive $zip, $dir, $fileWorksheet, $docSheet, array &$unparsedLoadedData): void
{ {
if (!$zip->locateName(dirname("$dir/$fileWorksheet") . '/_rels/' . basename($fileWorksheet) . '.rels')) { if (!$zip->locateName(dirname("$dir/$fileWorksheet") . '/_rels/' . basename($fileWorksheet) . '.rels')) {
return; return;

Some files were not shown because too many files have changed in this diff Show More