Custom Sniffs

Table of Contents

• Abstract class must be prefixed with Abstract
• Class and Namespace must be in PascalCase
• Interface must be postfixed with Interface
• No vertical whitespace between use statements
• Only one use statement per line
• Protected properties are not allowed
• Trait must be postfixed with Trait
• Use statements alphabetically ordered
• Variable and property must be in snake case
• @covers fully qualified name
• @covers counter part
• File comment copyright
• Declares strict
• Return type declaration
• Method name starts with 'getis'
• PHPUnit Namespace

Abstract class must be prefixed with Abstract

• Related class: Hostnet\Sniffs\Classes\AbstractClassMustBePrefixedWithAbstractSniff
• Name of the sniff: Hostnet.Classes.AbstractClassMustBePrefixedWithAbstract

Incorrect example ❌

abstract class MyClass
{
    public abstract function getEntityManager();
}

Correct example 👍

abstract class AbstractMyClass
{
    public abstract function getEntityManager();
}

Class and Namespace must be in PascalCase

• Related class: Hostnet\Sniffs\Classes\ClassAndNamespaceMustBeInPascalCaseSniff
• Name of the sniff: Hostnet.Classes.ClassAndNamespaceMustBeInPascalCase

Incorrect example ❌

namespace This\IS\a\BAD\namespaceE;

class MyClassIs09LookingFaULty
{
}

Correct example 👍

namespace This\Is\A\Good\NameSpaceE;

class MyClassIsLookingGood
{
}

Interface must be postfixed with Interface

• Related class: Hostnet\Sniffs\Classes\InterfaceMustBePostfixedWithInterfaceSniff
• Name of the sniff: Hostnet.Classes.InterfaceMustBePostfixedWithInterface

Incorrect example ❌

interface MyClass
{
}

Correct example 👍

interface MyClassInterface
{
}

No vertical whitespace between use statements

• Related class: Hostnet\Sniffs\Classes\NoVerticalWhitespaceBetweenUseStatementsSniff
• Name of the sniff: Hostnet.Classes.NoVerticalWhitespaceBetweenUseStatements

Incorrect example ❌

use SomeSpace; // comment
use MoreSpace;

use  LostIn\Space;

Correct example 👍

use SomeSpace; // comment
use MoreSpace;
use  LostIn\Space;

Only one use statement per line

• Related class: Hostnet\Sniffs\Classes\OnlyOneUseStatementPerLineSniff
• Name of the sniff: Hostnet.Classes.OnlyOneUseStatementPerLine

Incorrect example ❌

use SomeOtherSpace as Hello, ThisShouldNotBeHere;

Correct example 👍

use SomeOtherSpace as Hello;

Protected properties are not allowed

• Related class: Hostnet\Sniffs\Classes\ProtectedPropertiesAreNotAllowedSniff
• Name of the sniff: Hostnet.Classes.ProtectedPropertiesAreNotAllowed

Incorrect example ❌

    private $bar;

    protected $foo;

    public $public_variable;

Correct example 👍

    private $bar;

    public $public_variable;

Trait must be postfixed with Trait

• Related class: Hostnet\Sniffs\Classes\TraitMustBePostfixedWithTraitSniff
• Name of the sniff: Hostnet.Classes.TraitMustBePostfixedWithTrait

Incorrect example ❌

trait MyClass
{
}

Correct example 👍

trait MyClassTrait
{
}

Use statements alphabetically ordered

• Related class: Hostnet\Sniffs\Classes\UseStatementsAlphabeticallyOrderedSniff
• Name of the sniff: Hostnet.Classes.UseStatementsAlphabeticallyOrdered

Incorrect example ❌

use A;
use C;
use B;

Correct example 👍

use A;
use B;
use C;

Variable and property must be in snake case

• Related class: Hostnet\Sniffs\Classes\VariableAndPropertyMustBeInSnakeCaseSniff
• Name of the sniff: Hostnet.Classes.VariableAndPropertyMustBeInSnakeCase

Incorrect example ❌

private $badProperty;

Correct example 👍

private $good_property;

@covers fully qualified name

• Related class: Hostnet\Sniffs\Commenting\AtCoversFullyQualifiedNameSniff
• Name of the sniff: Hostnet.Commenting.AtCoversFullyQualifiedName

Incorrect example ❌

/**
 * @covers Hostnet\Test\TestUnit\Bad
 */

Correct example 👍

/**
 * @covers \Hostnet\Test\TestUnit\Good
 */

@covers counter part

• Related class: Hostnet\Sniffs\Commenting\AtCoversCounterPartSniff
• Name of the sniff: Hostnet.Commenting.AtCoversCounterPart

Incorrect example ❌

namespace Foo;

class Bar
{
}

namespace Foo;

class BarTest
{
}

Correct example 👍

namespace Foo;

class Bar
{
}

namespace Foo;

/**
 * @covers \Foo\Bar
 */
class BarTest
{
}

File comment copyright

• Related class: Hostnet\Sniffs\Commenting\FileCommentCopyrightSniff
• Name of the sniff: Hostnet.Commenting.FileCommentCopyright
• Parameters:
  • years: Which years should be noted for the copyright, if not configured the _years is 'calculated'
  • copyright_holder: The legal holder of the copyright.
  • copyright_tag: The 'name' of the tag to search for. phpDocumenter uses @copyright.

Incorrect example ❌

<?php
/**
 * Test1234
 */
class abc {

}

Correct example 👍

/**
 * @copyright 2017 Hostnet B.V.
 */

/**
 * Test1234
 */
class abc {

}

Declares strict

• Related class: Hostnet\Sniffs\Declares\StrictSniff
• Name of the sniff: Hostnet.Declares.Strict

Incorrect example ❌

<?php
    echo 'hi there';
?>

Correct example 👍

<?php
declare(strict_types=1);

Return type declaration

• Related class: Hostnet\Sniffs\Functions\ReturnTypeDeclarationSniff
• Name of the sniff: Hostnet.Functions.ReturnTypeDeclaration
• Parameters:
  • closing_parenthesis_colon_spacing: spacing between the function's closing parenthesis and colon.
  • colon_return_type_spacing: spacing between the colon and the return type.

Incorrect example ❌

    public function this() : string
    {
        return;
    }

Correct example 👍

    public function this(): string
    {
        return;
    }

Method name starts with 'getis'

• Related class: Hostnet\Sniffs\NamingConventions\MethodNameStartsWithGetIsSniff
• Name of the sniff: Hostnet.NamingConventions.MethodNameStartsWithGetIs

Incorrect example ❌

  protected function getIsStuff()
  {
  }

Correct example 👍

  protected function isStuff()
  {
  }

PHPUnit Namespace

This test was added during the transition between PHPUnit 6 and 7 to ensure that the right TestCase-file is being used.

• Related class: Hostnet\Sniffs\PhpUnit\NamespaceSniff
• Name of the sniff: Hostnet.PhpUnit.Namespace

Incorrect example ❌

class NamespaceTest extends PHPUnit_Framework_TestCase

Correct example 👍

class NamespaceTest extends TestCase