Doctrine 2 - ORM

ArrayCollection Key Column @indexBy

Details

  • Type: New Feature New Feature
  • Status: Resolved Resolved
  • Priority: Minor Minor
  • Resolution: Fixed
  • Affects Version/s: None
  • Fix Version/s: 2.1
  • Component/s: Mapping Drivers
  • Security Level: All
  • Labels:
    None

Description

To be honest I feel like I saw this mentioned somewhere, but after looking around I couldn't find it, so I'll just post this anyway.

I'd like the ability to set a property as the associative key on ArrayCollections. This functionality could probably be done in a PostLoad by iterating over the objects, but it seems like ArrayCollection should be able to handle this functionality already, it's just a matter of modifying the mapper/parser.

Example:

/**
 * @Entity
 */
class Object
{
//... $id column and anything else ...
    /**
     * @OneToMany(targetEntity="Param", mappedBy="object")
     */
    protected $params;
//...
    public function getParam($name)
    {
         return $this->params[$name];
    }
}

/**
 * @Entity
 */
class Param
{
    /**
     * @ManyToOne(targetEntity="Object")
     * @JoinColumn(name="object_id", referencedColumnName="id", nullable="false")
     */
    protected $object;
    /**
     * @Column(type="string")
     */
    protected $name;
    /**
     * @Column(type="string")
     */
    protected $value;
}

If you were able to specify an ArrayCollection key column then you would be able to have functions like getParam without having to loop over the objects in the collection. Something like:

 @OneToMany(targetEntity="Param", mappedBy="object", collectionKey="name")

Issue Links

depends on

Bug - A problem which impairs or prevents the functions of the product. DDC-1018 INDEX BY does not work in JOIN clauses

  • Major - Major loss of function.
  • Resolved - A resolution has been taken, and it is awaiting verification by reporter. From here issues are either reopened, or are closed.
relates to

New Feature - A new feature of the product, which has yet to be developed. DDC-213 Persist order of collections

  • Major - Major loss of function.
  • Open - The issue is open and ready for the assignee to start work on it.

Activity

Ascending order - Click to sort in descending order
Hide
Permalink
Marijn Huizendveld added a comment - - edited

As much as I would like this I doubt it is possible feasible. Imagine the name column of your Param object not being unique for you your linked Object..? How could the ArrayCollection know which instance to add to the collection and which one not?

Show
Marijn Huizendveld added a comment - - edited As much as I would like this I doubt it is possible feasible. Imagine the name column of your Param object not being unique for you your linked Object ..? How could the ArrayCollection know which instance to add to the collection and which one not?
Hide
Permalink
Michael Ridgway added a comment -

You are absolutely correct. There is no way to ensure the uniqueness of the collection elements. This is something that would have to be ensured in the domain model and shouldn't have anything to do with Doctrine.

It will certainly work to loop through the collection on PostLoad (once DDC-54 is implemented). For now, I just set the keys the first time I call getParam().

I suppose I should close this (I forgot it was still open).

Show
Michael Ridgway added a comment - You are absolutely correct. There is no way to ensure the uniqueness of the collection elements. This is something that would have to be ensured in the domain model and shouldn't have anything to do with Doctrine. It will certainly work to loop through the collection on PostLoad (once DDC-54 is implemented). For now, I just set the keys the first time I call getParam(). I suppose I should close this (I forgot it was still open).
Hide
Permalink
Michael Ridgway added a comment -

I just noticed that DQL has an INDEX BY keyword to be able to do this during a DQL query. Is this something that could then be possible to set in a oneToMany or manyToMany? It seems like most of the groundwork for being able to do this is already done.

Show
Michael Ridgway added a comment - I just noticed that DQL has an INDEX BY keyword to be able to do this during a DQL query. Is this something that could then be possible to set in a oneToMany or manyToMany? It seems like most of the groundwork for being able to do this is already done.
Hide
Permalink
Benjamin Eberlei added a comment -

Example code:

<?php

class Article
{
    /** @Id @Column(type="integer") @GeneratedValue */
    public $id;

    /** @Column(type="string")
    public $headline;

    /**
     * @OneToMany(targetEntity="Translation", mappedBy="article")
     * @IndexBy("language")
     */
    public $translations;
}

class Translation
{
    /**
     * @Id @Column(type="string")
     */
    public $language;

    /**
     * @Id @ManyToOne(targetEntity="Article", inversedBy="translations")
     */
    public $article;

    /**
     * @Column(type="string")
     */
    public $headline;
}


$article = $em->find("Article", 1);
$article->translations["en"]->headlinle;

In this case @IndexBy uses the Translation::$language as key for the collection.

Show
Benjamin Eberlei added a comment - Example code: <?php class Article { /** @Id @Column(type= "integer" ) @GeneratedValue */ public $id; /** @Column(type= "string" ) public $headline; /** * @OneToMany(targetEntity= "Translation" , mappedBy= "article" ) * @IndexBy( "language" ) */ public $translations; } class Translation { /** * @Id @Column(type= "string" ) */ public $language; /** * @Id @ManyToOne(targetEntity= "Article" , inversedBy= "translations" ) */ public $article; /** * @Column(type= "string" ) */ public $headline; } $article = $em->find( "Article" , 1); $article->translations[ "en" ]->headlinle; In this case @IndexBy uses the Translation::$language as key for the collection.
Hide
Permalink
Benjamin Eberlei added a comment -

Schedule for 2.1

Show
Benjamin Eberlei added a comment - Schedule for 2.1
Benjamin Eberlei made changes -
Field Original Value New Value
Summary ArrayCollection Key Column ArrayCollection Key Column @indexBy
Fix Version/s 2.1 [ 10022 ]
Benjamin Eberlei made changes -
Link This issue relates to DDC-213 [ DDC-213 ]
Benjamin Eberlei made changes -
Link This issue depends on DDC-1018 [ DDC-1018 ]
Hide
Permalink
Benjamin Eberlei added a comment - - edited

This is now in master https://github.com/doctrine/doctrine2/commit/7390030854cdb4b775f6f11f83c970ab2705e924

Syntax is:

@ManyToMany(targetEntity="OtherEntity", indexBy="foreignField")
@OneToMany(targetEntity="OtherEntity", indexBy="foreignField")

<many-to-many index-by="foreignField" />

manyToMany:
  indexBy: foreignField
Show
Benjamin Eberlei added a comment - - edited This is now in master https://github.com/doctrine/doctrine2/commit/7390030854cdb4b775f6f11f83c970ab2705e924 Syntax is: @ManyToMany(targetEntity= "OtherEntity" , indexBy= "foreignField" ) @OneToMany(targetEntity= "OtherEntity" , indexBy= "foreignField" ) <many-to-many index-by= "foreignField" /> manyToMany: indexBy: foreignField
Benjamin Eberlei made changes -
Status Open [ 1 ] Resolved [ 5 ]
Assignee Roman S. Borschel [ romanb ] Benjamin Eberlei [ beberlei ]
Resolution Fixed [ 1 ]
Benjamin Eberlei made changes -
Workflow jira [ 10718 ] jira-feedback [ 14223 ]
Benjamin Eberlei made changes -
Workflow jira-feedback [ 14223 ] jira-feedback2 [ 16087 ]
Benjamin Eberlei made changes -
Workflow jira-feedback2 [ 16087 ] jira-feedback3 [ 18340 ]
Hide
Permalink
Benjamin Eberlei added a comment -

A related Github Pull-Request [GH-470] was opened
https://github.com/doctrine/doctrine2/pull/470

Show
Benjamin Eberlei added a comment - A related Github Pull-Request [GH-470] was opened https://github.com/doctrine/doctrine2/pull/470
This list may be incomplete, as errors occurred whilst retrieving source from linked applications:
  • Request to http://www.doctrine-project.org/fisheye/ failed: Error in remote call to 'FishEye 0 (http://www.doctrine-project.org/fisheye/)' (http://www.doctrine-project.org/fisheye) [AbstractRestCommand{path='/rest-service-fe/search-v1/crossRepositoryQuery', params={query=DDC-250, expand=changesets[-21:-1].revisions[0:29],reviews}, methodType=GET}] : Received status code 503 (Service Temporarily Unavailable)

People

  • Assignee:
    Benjamin Eberlei
    Reporter:
    Michael Ridgway
Vote (1)
Watch (4)

Dates

  • Created:
    Updated:
    Resolved: