rspec/rules/S1144/php/rule.adoc

58 lines
1.3 KiB
Plaintext
Raw Normal View History

== Why is this an issue?
2020-06-30 12:47:33 +02:00
include::../description.adoc[]
This rule also raises on unused protected methods in PHP enumerations. In PHP enumerations private and protected are equivalent because inheritance is not allowed.
=== Noncompliant code example
2020-06-30 12:47:33 +02:00
2022-02-04 17:28:24 +01:00
[source,php]
2020-06-30 12:47:33 +02:00
----
class Foo {
private function __construct() {} // Compliant, private empty constructor intentionally used to prevent any direct instantiation of a class.
2020-06-30 12:47:33 +02:00
public static function doSomething() {
2020-06-30 12:47:33 +02:00
$foo = new Foo();
...
}
private function unusedPrivateFunction() {} // Noncompliant
}
enum ExampleEnum {
case FIRST_CASE;
private function unusedPrivateFunction() {} // Noncompliant
protected function unusedProtectedFunction() {} // Noncompliant
2020-06-30 12:47:33 +02:00
}
----
=== Compliant solution
2020-06-30 12:47:33 +02:00
2022-02-04 17:28:24 +01:00
[source,php]
2020-06-30 12:47:33 +02:00
----
class Foo {
private function __construct() {} // Compliant, private empty constructor intentionally used to prevent any direct instantiation of a class.
2020-06-30 12:47:33 +02:00
public static function doSomething() {
2020-06-30 12:47:33 +02:00
$foo = new Foo();
}
}
----
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[]