Doctrine 2 - ORM
  1. Doctrine 2 - ORM
  2. DDC-274

Class and namespace naming inconsistency

    Details

    • Type: Improvement Improvement
    • Status: In Progress
    • Priority: Critical Critical
    • Resolution: Unresolved
    • Affects Version/s: None
    • Fix Version/s: 3.0
    • Component/s: None
    • Security Level: All
    • Labels:
      None

      Description

      There are inconsistencies with some class and namespace names that include acronyms.

      Examples:

      Classes with upper-casing:
      ORMException, DBALException, OCI8Connection, etc.

      Classes with proper-casing:
      RunDqlTask, CliException, MySqlPlatform, etc.

      Namespaces with upper-casing:
      DBAL, ORM, Doctrine\DBAL\Driver\PDOMsSql, etc.

      Namespaces with proper-casing:
      Doctrine\Common\Cli, Doctrine\DBAL\Tools\Cli\, Doctrine\ORM\Id, etc.

      There is more proper-casing than upper-casing. IMHO, proper-casing is better as it's easier to read "SqlException" than it is to read "SQLException" (the "E" looks like part of the acronym), and things like "CLITask" can be avoided.

      I discussed this a bit with Benjamin and Guilherme, and they were unsure and said that the whole team needed to reach consensus.

      I'm leaving the priority as "Major" because this should probably be fixed sooner rather than later to prevent compatibility breaks.

        Activity

          People

          • Assignee:
            Guilherme Blanco
            Reporter:
            Glen Ainscow
          • Votes:
            1 Vote for this issue
            Watchers:
            2 Start watching this issue

            Dates

            • Created:
              Updated: