rspec/rules/S1192/php/rule.adoc

64 lines
1.2 KiB
Plaintext
Raw Permalink Normal View History

== Why is this an issue?
2020-06-30 12:47:33 +02:00
include::../description.adoc[]
2023-10-11 11:41:24 +02:00
=== Exceptions
No issue will be raised on:
* strings with less than 5 characters
* strings with only letters, numbers, underscores, hyphens and periods
== How to fix it
include::../howtofix.adoc[]
=== Code examples
==== Noncompliant code example
2020-06-30 12:47:33 +02:00
With the default threshold of 3:
2023-10-11 11:41:24 +02:00
[source,php,diff-id=1,diff-type=noncompliant]
2020-06-30 12:47:33 +02:00
----
function run() {
prepare('this is a duplicate'); // Noncompliant - 'this is a duplicate' is duplicated 3 times
execute('this is a duplicate');
release('this is a duplicate');
2020-06-30 12:47:33 +02:00
}
----
2023-10-11 11:41:24 +02:00
==== Compliant solution
2020-06-30 12:47:33 +02:00
2023-10-11 11:41:24 +02:00
[source,php,diff-id=1,diff-type=compliant]
2020-06-30 12:47:33 +02:00
----
MESSAGE = 'this is a duplicate';
2020-06-30 12:47:33 +02:00
function run() {
2023-10-11 11:41:24 +02:00
prepare(MESSAGE); // Compliant - the duplicated string literal is replaced by a constant and can be safely re-used
execute(MESSAGE);
release(MESSAGE);
2020-06-30 12:47:33 +02:00
}
----
[source,php]
----
$severity = $request->getParam('severity-score');
----
ifdef::env-github,rspecator-view[]
'''
== Implementation Specification
(visible only on this page)
include::../message.adoc[]
include::../parameters.adoc[]
include::../highlighting.adoc[]
'''
endif::env-github,rspecator-view[]