Doctrine Project

[DDC-585] Create a coding standards document

Mon, 11 Feb 2013 17:04:20 +0000

We need a new coding standards document for Doctrine 2.

[DDC-536] Remove the _ prefix from private and protected members

Fri, 19 Nov 2010 00:00:39 +0000

The reasoning is simple: The prefix "_" is usually either used for easier distinction of instance variables from other, i.e. local variables, instead of always using "this." (often seen in C#), or it is used to signal that a member is not meant to be accessed from outside of the class when the language does not have visibility modifiers (PHP4).

Since you always have to use "$this->" in PHP5+ when accessing instance members and there are visibility modifiers, the "_" is largely superfluous and just makes the verbose OO code even more verbose.

Maybe the following find/replace steps will do the job almost completely:

"private $_" => "private $"
"protected $_" => "protected $"
"$this->_" => "$this->"

[DDC-530] Create tests and documentation for possibilities of mixing inheritance mapping strategies

Mon, 19 Apr 2010 05:37:55 +0000

It is (theoretically) possible to use different inheritance mapping strategies in the same class hierarchy as long as the different subtrees that use different mapping strategies do not have a common ancestor entity. We should add some tests for that and mention it in the docs about inheritance mapping in a new subsection "Mixing Inheritance Mapping Strategies".

[DDC-473] Inadequate description for @MappedSuperclass in Annotations Reference

Thu, 26 Aug 2010 08:02:03 +0000

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