rspec/rules/S836/php/rule.adoc

63 lines
1.2 KiB
Plaintext
Raw Normal View History

== Why is this an issue?
In PHP it is not required to initialize variables before their usage. However, using uninitialized variables is considered bad practice and should be avoided because of the following reasons:
* The value and type of uninitialized variables depend on the context of their first usage. It is better to be explicit about those to avoid confusion.
* The interpreter raises a warning or a notice in many cases.
2020-06-30 12:50:59 +02:00
=== Noncompliant code example
2020-06-30 12:50:59 +02:00
2022-02-04 17:28:24 +01:00
[source,php]
2020-06-30 12:50:59 +02:00
----
<?php
function getText(array $lines): string {
foreach ($lines as $line) {
$text .= $line;
}
return $text;
2020-06-30 12:50:59 +02:00
}
----
=== Compliant solution
2020-06-30 12:50:59 +02:00
2022-02-04 17:28:24 +01:00
[source,php]
2020-06-30 12:50:59 +02:00
----
<?php
function getText(array $lines): string {
$text = "";
foreach ($lines as $line) {
$text .= $line;
}
return $text;
2020-06-30 12:50:59 +02:00
}
----
== Resources
* CWE - https://cwe.mitre.org/data/definitions/457[CWE-457 - Use of Uninitialized Variable]
ifdef::env-github,rspecator-view[]
'''
== Implementation Specification
(visible only on this page)
=== Message
Review the data-flow - use of uninitialized value.
'''
== Comments And Links
(visible only on this page)
include::../comments-and-links.adoc[]
endif::env-github,rspecator-view[]