Conventions

This document describes conventions used in the Sylius to make it more consistent and predictable. Any new code delivered to Sylius should comply with the following conventions, we also encourage you to use them in your own projects based on Sylius.

Naming

• Use camelCase for:

  • PHP variables,

  • method names (except PHPSpec and PHPUnit),

  • arguments,

  • Twig templates;

• Use snake_case for:

  • configuration parameters,

  • Twig template variables,

  • fixture fields,

  • YAML files,

  • XML files,

  • Behat feature files,

  • PHPSpec method names,

  • PHPUnit method names;

• Use SCREAMING_SNAKE_CASE for:

  • constants,

  • environment variables;

• Use UpperCamelCase for:

  • classes names,

  • interfaces names,

  • traits names,

  • other PHP file names;

• Prefix abstract classes with Abstract,

• Suffix interfaces with Interface,

• Suffix traits with Trait,

• Use a command name with the Handler suffix to create a name of the command handler,

• Suffix exceptions with Exception,

• Suffix PHPSpec classes with Spec,

• Suffix PHPUnit tests with Test,

• Prefix Twig templates that are partial blocks with _,

• Use the fully qualified class name (FQCN) of an interface as a service name of a newly created service or FQCN of a class if there are multiple implementations of a given interface unless it is inconsistent with the current scope of Sylius.