rspec/rules/S3699/php/rule.adoc
2023-08-04 12:58:46 +02:00

45 lines
1.1 KiB
Plaintext

This rule raises an issue when a function call result is used, even though the function does not return anything.
== Why is this an issue?
If a function does not return anything, it makes no sense to use its output. Specifically, passing it to another function, or assigning its "result" to a variable is probably a bug because such functions return nothing, which is probably not what was intended.
=== Code examples
==== Noncompliant code example
[source,php,diff-id=1,diff-type=noncompliant]
----
$result = closedir($dir_handle); // Noncompliant, "closedir" does not return anything.
----
==== Compliant solution
[source,php,diff-id=1,diff-type=compliant]
----
closedir($dir_handle);
----
== Resources
=== Documentation
* PHP documentation - https://www.php.net/manual/en/functions.returning-values.php[Returning values]
ifdef::env-github,rspecator-view[]
'''
== Implementation Specification
(visible only on this page)
include::../message.adoc[]
include::../highlighting.adoc[]
'''
== Comments And Links
(visible only on this page)
include::../comments-and-links.adoc[]
endif::env-github,rspecator-view[]