Uploaded image for project: 'Doctrine 2 - ORM'
  1. Doctrine 2 - ORM
  2. DDC-274

Class and namespace naming inconsistency

    Details

    • Type: Improvement
    • Status: In Progress
    • Priority: Major
    • 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

        darkangel Glen Ainscow created issue -
        guilhermeblanco Guilherme Blanco made changes -
        Field Original Value New Value
        Fix Version/s 2.0-BETA1 [ 10030 ]
        Priority Major [ 3 ] Critical [ 2 ]
        romanb Roman S. Borschel made changes -
        Status Open [ 1 ] In Progress [ 3 ]
        romanb Roman S. Borschel made changes -
        Fix Version/s 2.0-BETA2 [ 10050 ]
        Fix Version/s 2.0-BETA1 [ 10030 ]
        romanb Roman S. Borschel made changes -
        Fix Version/s 2.0-BETA3 [ 10060 ]
        Fix Version/s 2.0-BETA2 [ 10050 ]
        romanb Roman S. Borschel made changes -
        Fix Version/s 2.0-BETA4 [ 10072 ]
        Fix Version/s 2.0-BETA3 [ 10060 ]
        romanb Roman S. Borschel made changes -
        Fix Version/s 2.0-RC1 [ 10091 ]
        Fix Version/s 2.0-BETA4 [ 10072 ]
        beberlei Benjamin Eberlei made changes -
        Workflow jira [ 10769 ] jira-feedback [ 14095 ]
        beberlei Benjamin Eberlei made changes -
        Workflow jira-feedback [ 14095 ] jira-feedback2 [ 15959 ]
        beberlei Benjamin Eberlei made changes -
        Workflow jira-feedback2 [ 15959 ] jira-feedback3 [ 18213 ]
        guilhermeblanco Guilherme Blanco made changes -
        Assignee Roman S. Borschel [ romanb ] Guilherme Blanco [ guilhermeblanco ]
        Fix Version/s 3.0 [ 10129 ]
        Fix Version/s 2.0-RC1 [ 10091 ]
        Affects Version/s 2.0-ALPHA4 [ 10036 ]
        ocramius Marco Pivetta made changes -
        Priority Critical [ 2 ] Major [ 3 ]

          People

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

            Dates

            • Created:
              Updated: