rspec/rules/S100/php/rule.adoc

52 lines
1.1 KiB
Plaintext

== Why is this an issue?
include::../description.adoc[]
=== Noncompliant code example
With default provided regular expression: ``++^[a-z][a-zA-Z0-9]*$++``:
[source,php]
----
function DoSomething(){...}
----
=== Compliant solution
[source,php]
----
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.
----
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[]