Allow orderBy to reference associations

[c960657]

If I specify an order-by clause on a to-many association, e.g. @OrderBy({"foo" = "ASC"}), where foo is a to-one-association on the target entity, the collection is sorted by foo_id (this behaviour is implemented in BasicEntityPersister::getOrderBySQL()).

This works fine. However, Doctrine\ORM\Tools\SchemaValidator complains that foo is not a field.

This change makes the validator accept order-by clauses on associations where the target entity is the owning side, and the association is single-valued (AFAICT this is the same restrictions that BasicEntityPersister uses).

[doctrinebot]

Hello,

thank you for creating this pull request. I have automatically opened an issue
on our Jira Bug Tracker for you. See the issue link:

http://www.doctrine-project.org/jira/browse/DDC-3322

We use Jira to track the state of pull requests and the versions they got
included in.

[Ocramius]

@c960657 could you provide relevant test cases?

[c960657]

I have now pushed some tests also.

[stof]

I would actually change the order of the code to avoid doing the check twice:

 if ($targetMetadata->hasAssociation($orderField)) {
    if (!$targetMetadata->isSingleValuedAssociation($orderField)) {
        // ....
        continue;
    }

    if ($targetMetadata->isAssociationInverseSide($orderField)) {
        // ...
    }

    continue;
}

if (!$targetMetadata->hasField($orderField)) {
    // ....
}

[stof]

actually, this can even be simplified:

if (!$targetMetadata->hasField($orderField) && !$targetMetadata->hasAssociation($orderField)) {
    // ....

    continue;
}

if ($targetMetadata->isCollectionValuedAssociation($orderField)) {
    // ....
    continue;
}

if ($targetMetadata->isAssociationInverseSide($orderField)) {
    // ...

    continue;
}

[c960657]

@stof Fixed.

[stof]

👍

[webdevilopers]

Sorry for commenting on a merged PR.

Is there a way to sort by properties of nested entities? E.g. windowTypes.windowType.name?
In my use case the nested entity windowType is indeed sorted but by id by default. Is there away to use name instead? Maybe lookup the __toString() method or some kind of array notation windowType.name or windowType[name]?

class BayWindow
{
    /**
     * @var windowTypes
     *
     * @ORM\OneToMany(targetEntity="BayWindowWindowType", mappedBy="bayWindow")
     * @ORM\OrderBy({"windowType" = "ASC"})
     */
    private $windowTypes;
}

class BayWindowWindowType
{
    /**
     * @var $baywindow;
     *
     * @ORM\ManyToOne(targetEntity="BayWindow", inversedBy="windowTypes")
     * @ORM\JoinColumn(name="bay_window_id", referencedColumnName="id")
     */
    private $bayWindow;

    /**
     * @var $windowType
     *
     * @ORM\ManyToOne(targetEntity="WindowType", inversedBy="bayWindows")
     * @ORM\JoinColumn(name="window_type_id", referencedColumnName="id")
     */
    private $windowType;
}

class WindowType
{
    /**
     * @var string $name
     *
     * @ORM\Column(name="name", type="string", length=100, precision=0, scale=0, nullable=false, unique=false)
     */
    private $name;

    /**
     * @var windowTypes
     *
     * @ORM\OneToMany(targetEntity="BayWindowWindowType", mappedBy="windowType")
     */
    private $bayWindows;

    public function __toString()
    {
        return $this->name;
    }
}

Workaround of course would be using the query builder. But are there any plany for this? Or are there technical downsides?