[Current Sniffs] Naming Conventions

[wickedOne]

this issue lists all sniffs currently implemented in this repository as described in the naming conventions segment of the symfony coding standard.

this issue can be marked as resolved once the example class at the bottom triggers all mentioned errors when checked with this standard (be sure to remove all comment lines before checking and ignore the multiple classes per file error).

Naming Conventions

• [x] Use camelCase, not underscores, for variable, function and method names, arguments.
• [ ] Use underscores for option names and parameter names.
• [x] Use namespaces for all classes.
• [x] Prefix abstract classes with Abstract.
• [x] Suffix interfaces with Interface.
• [x] Suffix traits with Trait.
• [x] Suffix exceptions with Exception.
• [x] Use alphanumeric characters and underscores for file names.
• [x] For type-hinting in PHPDocs and casting, use bool (instead of boolean or Boolean), int (instead of integer), float (instead of double or real).

<?php

// Use namespaces for all classes

// Prefix abstract classes with Abstract.
abstract class Foo
{
}

// Suffix traits with Trait
trait Bar
{
}

// Suffix exceptions with Exception
class Baz extends \Exception
{
}

// Suffix interfaces with Interface
interface Qux
{
}

class Corge
{
    /**
     * For type-hinting in PHPDocs and casting, use bool, int, float
     * @var boolean $a
     */
    private $a;

    // Use camelCase, not underscores, for variable, function and method names, arguments
    private $foo_bar;

    // Use underscores for option names and parameter names
    private $baz = [
        'fooBar' => 'baz',
    ];

    public function __construct($a)
    {
        // For type-hinting in PHPDocs and casting, use bool, int, float
        $this->a = (boolean) $a;
    }

    // Use camelCase, not underscores, for variable, function and method names, arguments
    public function foo_bar($foo_bar)
    {
        $this->foo_bar = $foo_bar;
    }
}

[wickedOne]

@djoos i don't think i can come up with something nifty for the Use underscores for option names and parameter names. rule...

unfortunately it isn't as straight forward to, for instance, do a check on array keys as there are plenty of use cases where using camel caps is valid.

  $this->findOneBy([
    'propertyName' => $value,
  ]);

for example is likely to be present in many repository classes.

so unless you can come up with something clever to determine whether or not something is a parameter or an option, i'm afraid we have to skip that one

[wickedOne]

i'm going to close this one as well. nevertheless, if someone is able to come up with some logic to detect a Use underscores for option names and parameter names. violation, i'll be happy to work on that...