Doctrine 2 - ORM
  1. Doctrine 2 - ORM
  2. DDC-473

Inadequate description for @MappedSuperclass in Annotations Reference

    Details

    • Type: Improvement Improvement
    • Status: Open
    • Priority: Minor Minor
    • Resolution: Unresolved
    • Affects Version/s: 2.0-ALPHA4
    • Fix Version/s: 2.0
    • Component/s: Documentation
    • Security Level: All
    • Labels:
      None

      Description

      See: http://www.doctrine-project.org/documentation/manual/2_0/en/annotations-reference#ann_mappedsuperclass

      @MappedSuperclass

      An mapped superclass is an abstract or concrete class that provides persistent entity state and mapping information for its subclasses, but which is not itself an entity. This annotation is specified on the Class docblock and has no additional attributes.

      This doesn't adequately communicate how to use it. It took me several minutes of failing before I downloaded the PDF and did a search for @MappedSuperclass to find an example of how it's used.

      Specifically the following were unclear:

      • Is this defined on the superclass or on the children classes?
      • If it's defined on the child classes, does it take parameters? The name of the super class?
      • It was not at all apparent to me that it was mutually exclusive with the @Entity tag

        Activity

        David Abdemoulaie created issue -
        David Abdemoulaie made changes -
        Field Original Value New Value
        Description {quote}
        @MappedSuperclass

        An mapped superclass is an abstract or concrete class that provides persistent entity state and mapping information for its subclasses, but which is not itself an entity. This annotation is specified on the Class docblock and has no additional attributes.
        {quote}

        This doesn't adequately communicate how to use it. It took me several minutes of failing before I downloaded the PDF and did a search for @MappedSuperclass to find an example of how it's used.

        Specifically the following were unclear:

        * Is this defined on the superclass or on the children classes?
        * If it's defined on the child classes, does it take parameters? The name of the super class?
        * It was not at all apparent to me that it was mutually exclusive with the @Entity tag
        See: http://www.doctrine-project.org/documentation/manual/2_0/en/annotations-reference#ann_mappedsuperclass

        {quote}
        @MappedSuperclass

        An mapped superclass is an abstract or concrete class that provides persistent entity state and mapping information for its subclasses, but which is not itself an entity. This annotation is specified on the Class docblock and has no additional attributes.
        {quote}

        This doesn't adequately communicate how to use it. It took me several minutes of failing before I downloaded the PDF and did a search for @MappedSuperclass to find an example of how it's used.

        Specifically the following were unclear:

        * Is this defined on the superclass or on the children classes?
        * If it's defined on the child classes, does it take parameters? The name of the super class?
        * It was not at all apparent to me that it was mutually exclusive with the @Entity tag
        Roman S. Borschel made changes -
        Fix Version/s 2.0-BETA2 [ 10050 ]
        Roman S. Borschel made changes -
        Fix Version/s 2.0 [ 10021 ]
        Fix Version/s 2.0-BETA2 [ 10050 ]
        Roman S. Borschel made changes -
        Assignee Roman S. Borschel [ romanb ] Jonathan H. Wage [ jwage ]
        Benjamin Eberlei made changes -
        Workflow jira [ 11133 ] jira-feedback [ 13846 ]
        Benjamin Eberlei made changes -
        Workflow jira-feedback [ 13846 ] jira-feedback2 [ 15710 ]
        Benjamin Eberlei made changes -
        Workflow jira-feedback2 [ 15710 ] jira-feedback3 [ 17967 ]

          People

          • Assignee:
            Jonathan H. Wage
            Reporter:
            David Abdemoulaie
          • Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

            Dates

            • Created:
              Updated: