Baike.dev
All toolsOnline toolsAI codingTrendingOpen sourceNewsSubmit
Log in
< Back to tools
P

phpcs-calisthenics-rules

> 编程语言
Open source

[DEPRECATED] Object Calisthenics rules for PHP_CodeSniffer

595 stars0 likes0 views
WebsiteGitHub

About

[DEPRECATED] Object Calisthenics rules for PHP_CodeSniffer

Object Calisthenics rules for PHP_CodeSniffer

DEPRECATED: PHP_CodeSniffer is great for handling spaces and char positions. Yet these rules are about code architecture and structure. In 2020, there is tool that suits this perfectly - PHPStan.

**Saying that, object calisthenics were implemented as PHPStan rules in a symplify/phpstan-rules package. Use it instead **

includes:
    - vendor/symplify/phpstan-rules/packages/object-calisthenics/config/object-calisthenics-rules.neon
    - vendor/symplify/phpstan-rules/packages/object-calisthenics/config/object-calisthenics-services.neon

Object Calisthenics are set of rules in object-oriented code, that focuses of maintainability, readability, testability and comprehensibility. We're pragmatic first - they are easy to use all together or one by one.

Why Should You Use This in Your Project?

Read post by William Durand or check presentation by Guilherme Blanco.

Install

bash
composer require object-calisthenics/phpcs-calisthenics-rules --dev

Usage

If you know what you want, jump right to the specific rule:

  • 1. Only X Level of Indentation per Method
  • 2. Do Not Use "else" Keyword
  • 5. Use Only One Object Operator (->) per Statement
  • 6. Do not Abbreviate
  • 7. Keep Your Classes Small
  • 9. Do not Use Getters and Setters

How to quickly check 1 rule?

In PHP_CodeSniffer

bash
vendor/bin/phpcs src tests -sp \
--standard=vendor/object-calisthenics/phpcs-calisthenics-rules/src/ObjectCalisthenics/ruleset.xml \
--sniffs=ObjectCalisthenics.Classes.ForbiddenPublicProperty

In EasyCodingStandard

yaml
# ecs.yaml
services:
    ObjectCalisthenics\Sniffs\Classes\ForbiddenPublicPropertySniff: ~

then

bash
vendor/bin/ecs check src

Implemented Rule Sniffs

1. Only X Level of Indentation per Method

:x:

php
foreach ($sniffGroups as $sniffGroup) {
    foreach ($sniffGroup as $sniffKey => $sniffClass) {
        if (! $sniffClass instanceof Sniff) {
            throw new InvalidClassTypeException;
        }
    }
}

:+1:

php
foreach ($sniffGroups as $sniffGroup) {
    $this->ensureIsAllInstanceOf($sniffGroup, Sniff::class);
}

// ...
private function ensureIsAllInstanceOf(array $objects, string $type)
{
    // ...
}

Use Only This Rule?

In PHP_CodeSniffer:

bash
vendor/bin/phpcs ... --sniffs=ObjectCalisthenics.Metrics.MaxNestingLevel

In ECS:

yaml
# ecs.yaml
services:
    ObjectCalisthenics\Sniffs\Metrics\MaxNestingLevelSniff: ~

:wrench: Configurable

In PHP_CodeSniffer:

xml

    
        
            
        
    

In ECS:

yaml
services:
    ObjectCalisthenics\Sniffs\Metrics\MaxNestingLevelSniff:
        maxNestingLevel: 2

2. Do Not Use "else" Keyword

:x:

php
if ($status === self::DONE) {
    $this->finish();
} else {
    $this->advance();
}

:+1:

php
if ($status === self::DONE) {
    $this->finish();
    return;
}

$this->advance();

Use Only This Rule?

In PHP_CodeSniffer:

bash
vendor/bin/phpcs ... --sniffs=ObjectCalisthenics.ControlStructures.NoElse

In ECS:

yaml
# ecs.yaml
services:
    ObjectCalisthenics\Sniffs\ControlStructures\NoElseSniff: ~

5. Use Only One Object Operator (->) per Statement

:x:

php
$this->container->getBuilder()->addDefinition(SniffRunner::class);

:+1:

php
$containerBuilder = $this->getContainerBuilder();
$containerBuilder->addDefinition(SniffRunner::class);

Use Only This Rule?

In PHP_CodeSniffer:

bash
vendor/bin/phpcs ... --sniffs=ObjectCalisthenics.CodeAnalysis.OneObjectOperatorPerLine

In ECS:

yaml
# ecs.yaml
services:
    ObjectCalisthenics\Sniffs\CodeAnalysis\OneObjectOperatorPerLineSniff: ~

:wrench: Configurable

In PHP_CodeSniffer:

xml

    
        
            
            
            
        
    

In ECS:

yaml
services:
    ObjectCalisthenics\Sniffs\CodeAnalysis\OneObjectOperatorPerLineSniff:
        variablesHoldingAFluentInterface: ["$queryBuilder", "$containerBuilder"]
        methodsStartingAFluentInterface: ["createQueryBuilder"]
        methodsEndingAFluentInterface: ["execute", "getQuery"]

6. Do not Abbreviate

This is related to class, trait, interface, constant, function and variable names.

:x:

php
class EM
{
    // ...
}

:+1:

php
class EntityMailer
{
    // ...
}

Use Only This Rule?

In PHP_CodeSniffer:

bash
vendor/bin/phpcs ... --sniffs=ObjectCalisthenics.NamingConventions.ElementNameMinimalLength

In ECS:

yaml
# ecs.yaml
services:
    ObjectCalisthenics\Sniffs\NamingConventions\ElementNameMinimalLengthSniff: ~

:wrench: Configurable

In PHP_CodeSniffer:

xml

    
        
            
            
        
    

In ECS:

yaml
# ecs.yaml
services:
    ObjectCalisthenics\Sniffs\NamingConventions\ElementNameMinimalLengthSniff:
        minLength: 3
        allowedShortNames: ["i", "id", "to", "up"]

7. Keep Your Classes Small

:x:

php
class SimpleStartupController
{
    // 300 lines of code
}

:+1:

php
class SimpleStartupController
{
    // 50 lines of code
}

:x:

php
class SomeClass
{
    public function simpleLogic()
    {
        // 30 lines of code
    }
}

:+1:

php
class SomeClass
{
    public function simpleLogic()
    {
        // 10 lines of code
    }
}

:x:

php
class SomeClass
{
    // 20 properties
}

:+1:

php
class SomeClass
{
    // 5 properties
}

:x:

php
class SomeClass
{
    // 20 methods
}

:+1:

php
class SomeClass
{
    // 5 methods
}

Use Only This Rule?

In PHP_CodeSniffer:

bash
vendor/bin/phpcs ... --sniffs=ObjectCalisthenics.Files.ClassTraitAndInterfaceLength,ObjectCalisthenics.Files.FunctionLength,ObjectCalisthenics.Metrics.MethodPerClassLimit,ObjectCalisthenics.Metrics.PropertyPerClassLimit

In ECS:

yaml
# ecs.yaml
services:
    ObjectCalisthenics\Sniffs\Files\ClassTraitAndInterfaceLengthSniff: ~
    ObjectCalisthenics\Sniffs\Files\FunctionLengthSniff: ~
    ObjectCalisthenics\Sniffs\Metrics\MethodPerClassLimitSniff: ~
    ObjectCalisthenics\Sniffs\Metrics\PropertyPerClassLimitSniff: ~

:wrench: Configurable

In PHP_CodeSniffer:

xml

    
        
            
        
    
    
        
            
        
    
    
        
            
        
    
    
        
            
        
    

In ECS:

yaml
# ecs.yaml
services:
    ObjectCalisthenics\Sniffs\Files\ClassTraitAndInterfaceLengthSniff:
        maxLength: 200
    ObjectCalisthenics\Sniffs\Files\FunctionLengthSniff:
        maxLength: 20
    ObjectCalisthenics\Sniffs\Metrics\PropertyPerClassLimitSniff:
        maxCount: 10
    ObjectCalisthenics\Sniffs\Metrics\MethodPerClassLimitSniff:
        maxCount: 10

9. Do not Use Getters and Setters

This rules is partially related to Domain Driven Design.

  • Classes should not contain public properties.
  • Method should represent behavior, not set values.

:x:

php
class ImmutableBankAccount
{
    public $currency = 'USD';
php
    private $amount;

    public function setAmount(int $amount)
    {
        $this->amount = $amount;
    }
}

:+1:

php
class ImmutableBankAccount
{
    private $currency = 'USD';
php
    private $amount;

    public function withdrawAmount(int $withdrawnAmount)
    {
        $this->amount -= $withdrawnAmount;
    }
}

Use Only This Rule?

In PHP_CodeSniffer:

bash
vendor/bin/phpcs ... --sniffs=ObjectCalisthenics.Classes.ForbiddenPublicProperty,ObjectCalisthenics.NamingConventions.NoSetter

In ECS:

yaml
# ecs.yaml
services:
    ObjectCalisthenics\Sniffs\Classes\ForbiddenPublicPropertySniff: ~
    ObjectCalisthenics\Sniffs\NamingConventions\NoSetterSniff: ~

:wrench: Configurable

In PHP_CodeSniffer:

xml

    
        
            
        
    

In ECS:

yaml
# ecs.yaml
services:
    ObjectCalisthenics\Sniffs\NamingConventions\NoSetterSniff:
        allowedClasses: 
            - '*\DataObject'

Not Implemented Rules - Too Strict, Vague or Annoying

While using in practice, we found these rule to be too strict, vague or even annoying, rather than helping to write cleaner and more pragmatic code. They're also closely related with Domain Driven Design.

3. Wrap Primitive Types and Strings - Since PHP 7, you can use define(strict_types=1) and scalar type hints. For other cases, e.g. email, you can deal with that in your Domain via Value Objects.

4. Use First Class Collections - This rule makes sense, yet is too strict to be useful in practice. Even our code didn't pass it at all.

8. Do Not Use Classes With More Than Two Instance Variables - This depends on individual domain of each project. It doesn't make sense to make a rule for that.


3 Rules for Contributing

  • 1 feature per PR

  • every new feature must be covered by tests

  • all tests and style checks must pass

    bash
    composer complete-check

We will be happy to merge your feature then.

Issues· 0 open

View all issuesOpen on GitHub

No open issues yet, or sync has not completed.

> Tags

PHPcalisthenics-rulescoding-standardphpphp-codesniffer

No comments yet. Be the first to share.

> Details

PublishedAug 1, 2026
UpdatedSep 17, 2026
Category编程语言
PricingOpen source

> Related tools

T
TypeScript
JavaScript 的超集,为前端与全栈提供静态类型
P
Python
通用编程语言,广泛用于 Web、数据与 AI
G
Go
Google 推出的简洁高效系统语言