rspec/rules/S100/php/rule.adoc

50 lines
1.0 KiB
Plaintext
Raw Normal View History

2020-06-30 10:16:44 +02:00
include::../description.adoc[]
== Noncompliant Code Example
2021-01-27 13:42:22 +01:00
With default provided regular expression: ``++^[a-z][a-zA-Z0-9]*$++``:
2022-02-04 17:28:24 +01:00
[source,php]
2020-06-30 10:16:44 +02:00
----
function DoSomething(){...}
----
== Compliant Solution
2022-02-04 17:28:24 +01:00
[source,php]
2020-06-30 10:16:44 +02:00
----
function doSomething(){...}
----
== Exceptions
Methods with an ``++@inheritdoc++`` annotation, as well as magic methods (``++__construct()++``, ``++__destruct()++``, ``++__call()++``, ``++__callStatic()++``, ``++__get()++``, ``++__set()++``, ``++__isset()++``, ``++__unset()++``, ``++__sleep()++``, ``++__wakeup()++``, ``++__toString()++``, ``++__invoke()++``, ``++__set_state()++``, ``++__clone()++``, ``++__debugInfo()++``) are ignored.
2020-06-30 10:16:44 +02:00
2021-02-02 15:02:10 +01:00
2020-06-30 10:16:44 +02:00
----
function __construct(){...}
function __destruct(){...}
/**
* {@inheritdoc}
*/
function myFunc(){...}
----
ifdef::env-github,rspecator-view[]
'''
== Implementation Specification
(visible only on this page)
include::../message.adoc[]
include::parameters.adoc[]
'''
== Comments And Links
(visible only on this page)
include::../comments-and-links.adoc[]
endif::env-github,rspecator-view[]