rspec/rules/S1045/php/rule.adoc

60 lines
1.5 KiB
Plaintext
Raw Permalink Normal View History

== Why is this an issue?
2021-01-27 13:42:22 +01:00
Exceptions handlers (``++catch++``) are evaluated in the order they are written. Once a match is found, the evaluation stops.
2021-02-02 15:02:10 +01:00
2021-01-27 13:42:22 +01:00
In some contexts a ``++catch++`` block is dead code as it will never catch any exception:
* If there is a handler for a base class followed by a handler for class derived from that base class, the second handler will never trigger: the handler for the base class will match the derived class, and will be the only executed handler.
2021-01-27 13:42:22 +01:00
* When multiple ``++catch++`` blocks try to catch the same exception class, only the first one will be executed.
2021-01-27 13:42:22 +01:00
This rule raises an issue when a ``++catch++`` block catches every exception before a later ``++catch++`` block could catch it.
=== Noncompliant code example
2022-02-04 17:28:24 +01:00
[source,php]
----
class MyException extends Exception {}
class MySubException extends MyException {}
try {
doSomething();
} catch (MyException $e) {
echo $e;
} catch (MySubException $e) { // Noncompliant: MySubException is a subclass of MyException
echo "Never executed";
}
----
=== Compliant solution
2022-02-04 17:28:24 +01:00
[source,php]
----
class MyException extends Exception {}
class MySubException extends MyException {}
try {
doSomething();
} catch (MySubException $e) {
echo "Executed";
} catch (MyException $e) {
echo $e;
}
----
ifdef::env-github,rspecator-view[]
'''
== Implementation Specification
(visible only on this page)
include::../highlighting.adoc[]
'''
== Comments And Links
(visible only on this page)
include::../comments-and-links.adoc[]
endif::env-github,rspecator-view[]