Coding Guidelines

Tip

It is recommended to refer to the latest version of this manual to read about TYPO3 coding guidelines.

See ìnformation about the version selector in the TYPO3 documentation usage tips.

• Introduction
  • About this chapter
  • What's new
  • Credits
  • The CGL as a means of quality assurance
  • Conventions used in this document
• File system conventions
  • TYPO3 directory structure
  • TYPO3 files and user files
  • Extension directory structure
  • File names
    • Unit test files
      • Example
• PHP file formatting
  • General requirements for PHP files
    • PHP tags
    • Line breaks
    • Line length
      • Notes
    • Whitespace and indentation
    • Character set
  • File structure
    • Namespace
    • Copyright notice
    • Included files
    • Class information block
    • PHP class
    • Optional module execution code
  • PHP syntax formatting
    • Identifiers
    • Comments
    • Debug output
    • Curly braces
    • Conditions
    • Switch
    • Loops
    • Strings
    • Booleans
    • NULL
    • Arrays
    • PHP features
    • Global variables
    • Functions
  • Using phpDoc
    • Class information block
    • Function information block
      • Short and long description
• PHP architecture
  • Modeling Cross Cutting Concerns
    • Static methods, static classes, utility classes
      • Characteristica
      • Rationale
      • Good examples
      • Bad examples
      • Red Flags
    • Traits
      • Characteristica
      • Rationale
      • Good examples
      • Bad examples
      • Further reading
    • Services
      • Characteristica
      • Rationale
      • Good examples
      • Bad examples
      • Further reading
  • Working with exceptions
    • Introduction
    • Exception types
      • Typical cases for exceptions that are designed to be caught
      • Typical cases for exceptions that should not be caught
    • Typical exception arguments
    • Exception inheritance
    • Extending exceptions
    • Good examples
    • Bad examples
    • Further readings
  • General links
• Coding: Best practices
  • Accessing the database
    • TYPO3 version 8 LTS
    • For TYPO3 versions before 8 LTS
  • Singletons
  • Static methods
    • Example
  • Localization
    • Defining localized strings
    • Using localized strings
  • Unit tests
    • Using unit tests
    • Adding unit tests
    • Conventions for unit tests
  • Handling deprecation
  • Namespaces and class names of user files