003-naming-conventions

Naming Conventions Standards

1.0.0

Context

• These rules apply to all code across the PHP backend
• They ensure consistent and meaningful naming
• They promote code readability and maintainability
• They align with PHP best practices and Domain-Driven Design principles

Requirements

General Principles

• Names should be descriptive and reveal intent
• Names should be searchable and pronounceable
• Avoid abbreviations except for common ones (e.g., ID, HTTP)
• Use consistent terminology across the codebase
• Domain language should be used consistently

Files and Directories

• Use PascalCase for PHP class files (e.g., ProjectFactory.php)
• Use PascalCase for directories representing namespaces (e.g., Project/, Factory/)
• Group files by domain/feature rather than type (e.g., Project/, Player/, Daedalus/)
• File names should match the primary class they contain (e.g., ProjectFactory.php for ProjectFactory class)
• Test files should follow the pattern {ClassUnderTest}Test.php for unit tests
• Functional tests should follow the pattern {Feature}Cest.php

Namespaces

• Use PascalCase for namespace components (e.g., Mush\Project\Factory)
• Namespace structure should follow PSR-4 autoloading standards
• Root namespace should be Mush followed by domain/feature name
• Test namespace should be Mush\tests followed by test type and domain (e.g., Mush\tests\unit\Project)

Classes and Interfaces

• Use PascalCase for class, interface, trait, and enum names (e.g., ProjectFactory, PlayerStatusEnum)
• Use nouns or noun phrases for class names
• Suffix interfaces with Interface (e.g., RoomLogServiceInterface)
• Use descriptive suffixes for specific types:
  • Factory for factory classes
  • Service for service classes
  • Repository for repositories
  • Subscriber or Listener for event listeners
  • Enum for enumeration classes
  • Config for configuration classes
  • Handler for handlers
  • Event for events