rspec/rules/S4823/php/rule.adoc
Fred Tingaud 51369b610e
Make sure that includes are always surrounded by empty lines (#2270)
When an include is not surrounded by empty lines, its content is inlined
on the same line as the adjacent content. That can lead to broken tags
and other display issues.
This PR fixes all such includes and introduces a validation step that
forbids introducing the same problem again.
2023-06-22 10:38:01 +02:00

79 lines
1.5 KiB
Plaintext

include::../description.adoc[]
include::../ask-yourself.adoc[]
include::../recommended.adoc[]
== Sensitive Code Example
Builtin access to ``++$argv++``
----
function globfunc() {
global $argv; // Sensitive. Reference to global $argv
foreach ($argv as $arg) { // Sensitive.
// ...
}
}
function myfunc($argv) {
$param = $argv[0]; // OK. Reference to local $argv parameter
// ...
}
foreach ($argv as $arg) { // Sensitive. Reference to $argv.
// ...
}
$myargv = $_SERVER['argv']; // Sensitive. Equivalent to $argv.
function serve() {
$myargv = $_SERVER['argv']; // Sensitive.
// ...
}
myfunc($argv); // Sensitive
$myvar = $HTTP_SERVER_VARS[0]; // Sensitive. Note: HTTP_SERVER_VARS has ben removed since PHP 5.4.
$options = getopt('a:b:'); // Sensitive. Parsing arguments.
$GLOBALS["argv"]; // Sensitive. Equivalent to $argv.
function myglobals() {
$GLOBALS["argv"]; // Sensitive
}
$argv = [1,2,3]; // Sensitive. It is a bad idea to override argv.
----
Zend Console
----
new Zend\Console\Getopt(['myopt|m' => 'this is an option']); // Sensitive
----
Getopt-php library
----
new \GetOpt\Option('m', 'myoption', \GetOpt\GetOpt::REQUIRED_ARGUMENT); // Sensitive
----
include::../see.adoc[]
ifdef::env-github,rspecator-view[]
'''
== Implementation Specification
(visible only on this page)
include::../message.adoc[]
'''
== Comments And Links
(visible only on this page)
include::../comments-and-links.adoc[]
endif::env-github,rspecator-view[]