rspec/rules/S5332/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

59 lines
1.2 KiB
Plaintext

include::../description.adoc[]
include::../ask-yourself.adoc[]
include::../recommended.adoc[]
== Sensitive Code Example
[source,php]
----
$url = "http://example.com"; // Sensitive
$url = "ftp://anonymous@example.com"; // Sensitive
$url = "telnet://anonymous@example.com"; // Sensitive
$con = ftp_connect('example.com'); // Sensitive
$trans = (new Swift_SmtpTransport('XXX', 1234)); // Sensitive
$mailer = new PHPMailer(true); // Sensitive
define( 'FORCE_SSL_ADMIN', false); // Sensitive
define( 'FORCE_SSL_LOGIN', false); // Sensitive
----
== Compliant Solution
[source,php]
----
$url = "https://example.com";
$url = "sftp://anonymous@example.com";
$url = "ssh://anonymous@example.com";
$con = ftp_ssl_connect('example.com');
$trans = (new Swift_SmtpTransport('smtp.example.org', 1234))
->setEncryption('tls')
;
$mailer = new PHPMailer(true);
$mailer->SMTPSecure = 'tls';
define( 'FORCE_SSL_ADMIN', true);
define( 'FORCE_SSL_LOGIN', true);
----
include::../exceptions.adoc[]
include::../see.adoc[]
ifdef::env-github,rspecator-view[]
'''
== Implementation Specification
(visible only on this page)
include::../message.adoc[]
endif::env-github,rspecator-view[]