Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Integrate Exceptions Better with PhpStorm #3765

Merged
merged 2 commits into from
Nov 7, 2023

Conversation

oleibman
Copy link
Collaborator

Fix #3754. Because PhpSpreadsheetException extends Exception, PhpStorm warns that calls to setValueExplicit and setValue, among others, do not handle the exception, because PhpStorm treats Exception, by default, as "checked". On the other hand, PhpStorm treats RunTimeException as "unchecked" so won't flag such calls. It is reasonable to let PhpSpreadsheetException extend RuntTimeException, and will eliminate the problem, without having to wrap code in all-but-useless try-catch blocks (e.g. for setValue, the code would raise an exception only if you try to set the cell's value to an unstringable object).

This is:

  • a bugfix
  • a new feature
  • refactoring
  • additional unit tests
  • IDE integration

Checklist:

  • Changes are covered by unit tests
    • Changes are covered by existing unit tests
    • New unit tests have been added
  • Code style is respected
  • Commit message explains why the change is made (see https://github.com/erlang/otp/wiki/Writing-good-commit-messages)
  • CHANGELOG.md contains a short summary of the change and a link to the pull request if applicable
  • Documentation is updated as necessary

Why this change is needed?

Provide an explanation of why this change is needed, with links to any Issues (if appropriate).
If this is a bugfix or a new feature, and there are no existing Issues, then please also create an issue that will make it easier to track progress with this PR.

Fix PHPOffice#3754. Because `PhpSpreadsheetException` extends `Exception`, PhpStorm warns that calls to `setValueExplicit` and `setValue`, among others, do not handle the exception, because PhpStorm treats `Exception`, by default, as "checked". On the other hand, PhpStorm treats `RunTimeException` as "unchecked" so won't flag such calls. It is reasonable to let `PhpSpreadsheetException` extend `RuntTimeException`, and will eliminate the problem, without having to wrap code in all-but-useless try-catch blocks (e.g. for `setValue`, the code would raise an exception only if you try to set the cell's value to an unstringable object).
@oleibman oleibman merged commit ef3890a into PHPOffice:master Nov 7, 2023
11 checks passed
@oleibman oleibman deleted the issue3754 branch November 7, 2023 17:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

Cell::setValueExplicit raises "Unhandled Exception" warning
1 participant