doctrine-orm-doc 2.4.6-1+deb8u1 / usr / share / doc / php-doctrine-orm / html / tutorials / ordered-associations.html

This file is indexed.

/usr/share/doc/php-doctrine-orm/html/tutorials/ordered-associations.html is in doctrine-orm-doc 2.4.6-1+deb8u1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    
    <title>Ordering To-Many Associations &mdash; Doctrine 2 ORM 2 documentation</title>
    <link rel="stylesheet" href="../_static/bootstrap/css/bootstrap.min.css" type="text/css" />
    <link rel="stylesheet" href="../_static/default.css" type="text/css" />
    <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
    <link rel="stylesheet" href="../_static/layout.css" type="text/css" />
    <link rel="stylesheet" href="../_static/configurationblock.css" type="text/css" />
    <script type="text/javascript">
      var DOCUMENTATION_OPTIONS = {
        URL_ROOT:    '../',
        VERSION:     '2',
        COLLAPSE_MODINDEX: false,
        FILE_SUFFIX: '.html',
        HAS_SOURCE:  true
      };
    </script>

    <script type="text/javascript" src="../_static/jquery.js"></script>
    <script type="text/javascript" src="../_static/configurationblock.js"></script>
    <script type="text/javascript" src="../_static/underscore.js"></script>
    <script type="text/javascript" src="../_static/configurationblock.js"></script>
    <script type="text/javascript" src="../_static/doctools.js"></script>
    <script type="text/javascript" src="../_static/configurationblock.js"></script>
    <script src="../_static/bootstrap/js/bootstrap.min.js"></script>

    <script type="text/javascript">
    <!--
        $(document).ready(function() {
            $("#versions").change(function() {
                var docsUrl = $(this).val();
                window.location.href = docsUrl;
            });
        });
    -->
    </script>
    <link rel="shortcut icon" href="../_static/doctrine.ico"/>
    <link rel="top" title="Doctrine 2 ORM 2 documentation" href="../index.html" />
    <link rel="next" title="Override Field Association Mappings In Subclasses" href="override-field-association-mappings-in-subclasses.html" />
    <link rel="prev" title="Composite and Foreign Keys as Primary Key" href="composite-primary-keys.html" /> 
  </head>
  <body>
    <div id="wrapper">
      <div id="header">
        <h1 id="h1title"></h1>
        <div id="logo">
          <a href="http://www.doctrine-project.org/">Doctrine - PHP Database Libraries</a>
        </div>
      </div>
      <div id="nav" class="cls">
        <div class="tl cls">
          <ul>
            <li><a target="_top" href="/">home</a></li>
            <li><a class="" target="_top" href="http://www.doctrine-project.org/about">about</a></li>
            <li><a class="" target="_top" href="http://www.doctrine-project.org/projects.html">projects</a></li>
            <li><a class="" target="_top" href="http://www.doctrine-project.org/projects/orm">orm</a></li>
            <li><a class="" target="_top" href="http://www.doctrine-project.org/projects/dbal">dbal</a></li>
            <li><a class="" target="_top" href="http://www.doctrine-project.org/blog">blog</a></li>
            <li><a class="" target="_top" href="http://www.doctrine-project.org/jira">development</a></li>
            <li><a class="" target="_top" href="http://www.doctrine-project.org/contribute">contribute</a></li>
            <li><a class="" target="_top" href="http://www.doctrine-project.org/community">community</a></li>
          </ul>
        </div>
      </div>
      <div id="content" class="cls">
    <div class="related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="../genindex.html" title="General Index"
             accesskey="I">index</a></li>
        <li class="right" >
          <a href="override-field-association-mappings-in-subclasses.html" title="Override Field Association Mappings In Subclasses"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="composite-primary-keys.html" title="Composite and Foreign Keys as Primary Key"
             accesskey="P">previous</a> |</li>
        <li><a href="/">Doctrine Homepage</a> &raquo;</li>
        <li><a href="../index.html">Doctrine 2 ORM 2 documentation</a> &raquo;</li> 
      </ul>
    </div>  

        <div class="document">
            <div class="documentwrapper">
                <div class="bodywrapper">

              <div class="body" >
                
  <div class="section" id="ordering-to-many-associations">
<h1>Ordering To-Many Associations<a class="headerlink" href="#ordering-to-many-associations" title="Permalink to this headline">ΒΆ</a></h1>
<p>There are use-cases when you&#8217;ll want to sort collections when they are
retrieved from the database. In userland you do this as long as you
haven&#8217;t initially saved an entity with its associations into the
database. To retrieve a sorted collection from the database you can
use the <tt class="docutils literal"><span class="pre">&#64;OrderBy</span></tt> annotation with an collection that specifies
an DQL snippet that is appended to all queries with this
collection.</p>
<p>Additional to any <tt class="docutils literal"><span class="pre">&#64;OneToMany</span></tt> or <tt class="docutils literal"><span class="pre">&#64;ManyToMany</span></tt> annotation you
can specify the <tt class="docutils literal"><span class="pre">&#64;OrderBy</span></tt> in the following way:</p>
<div class="configuration-block">
<ul class="simple">
<li><em>PHP</em><div class="highlight-php"><div class="highlight"><pre><span class="cp">&lt;?php</span>
<span class="sd">/** @Entity **/</span>
<span class="k">class</span> <span class="nc">User</span>
<span class="p">{</span>
    <span class="c1">// ...</span>

    <span class="sd">/**</span>
<span class="sd">     * @ManyToMany(targetEntity=&quot;Group&quot;)</span>
<span class="sd">     * @OrderBy({&quot;name&quot; = &quot;ASC&quot;})</span>
<span class="sd">     **/</span>
    <span class="k">private</span> <span class="nv">$groups</span><span class="p">;</span>
<span class="p">}</span>
</pre></div>
</div>
</li>
<li><em>XML</em><div class="highlight-xml"><div class="highlight"><pre><span class="nt">&lt;doctrine-mapping&gt;</span>
    <span class="nt">&lt;entity</span> <span class="na">name=</span><span class="s">&quot;User&quot;</span><span class="nt">&gt;</span>
        <span class="nt">&lt;many-to-many</span> <span class="na">field=</span><span class="s">&quot;groups&quot;</span> <span class="na">target-entity=</span><span class="s">&quot;Group&quot;</span><span class="nt">&gt;</span>
            <span class="nt">&lt;order-by&gt;</span>
                <span class="nt">&lt;order-by-field</span> <span class="na">name=</span><span class="s">&quot;name&quot;</span> <span class="na">direction=</span><span class="s">&quot;ASC&quot;</span> <span class="nt">/&gt;</span>
            <span class="nt">&lt;/order-by&gt;</span>
        <span class="nt">&lt;/many-to-many&gt;</span>
    <span class="nt">&lt;/entity&gt;</span>
<span class="nt">&lt;/doctrine-mapping&gt;</span>
</pre></div>
</div>
</li>
<li><em>YAML</em><div class="highlight-yaml"><div class="highlight"><pre><span class="l-Scalar-Plain">User</span><span class="p-Indicator">:</span>
  <span class="l-Scalar-Plain">type</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">entity</span>
  <span class="l-Scalar-Plain">manyToMany</span><span class="p-Indicator">:</span>
    <span class="l-Scalar-Plain">groups</span><span class="p-Indicator">:</span>
      <span class="l-Scalar-Plain">orderBy</span><span class="p-Indicator">:</span> <span class="p-Indicator">{</span> <span class="s">&#39;name&#39;</span><span class="p-Indicator">:</span> <span class="s">&#39;ASC&#39;</span> <span class="p-Indicator">}</span>
      <span class="l-Scalar-Plain">targetEntity</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">Group</span>
      <span class="l-Scalar-Plain">joinTable</span><span class="p-Indicator">:</span>
        <span class="l-Scalar-Plain">name</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">users_groups</span>
        <span class="l-Scalar-Plain">joinColumns</span><span class="p-Indicator">:</span>
          <span class="l-Scalar-Plain">user_id</span><span class="p-Indicator">:</span>
            <span class="l-Scalar-Plain">referencedColumnName</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">id</span>
        <span class="l-Scalar-Plain">inverseJoinColumns</span><span class="p-Indicator">:</span>
          <span class="l-Scalar-Plain">group_id</span><span class="p-Indicator">:</span>
            <span class="l-Scalar-Plain">referencedColumnName</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">id</span>
</pre></div>
</div>
</li>
</ul>
</div>
<p>The DQL Snippet in OrderBy is only allowed to consist of
unqualified, unquoted field names and of an optional ASC/DESC
positional statement. Multiple Fields are separated by a comma (,).
The referenced field names have to exist on the <tt class="docutils literal"><span class="pre">targetEntity</span></tt>
class of the <tt class="docutils literal"><span class="pre">&#64;ManyToMany</span></tt> or <tt class="docutils literal"><span class="pre">&#64;OneToMany</span></tt> annotation.</p>
<p>The semantics of this feature can be described as follows.</p>
<ul class="simple">
<li><tt class="docutils literal"><span class="pre">&#64;OrderBy</span></tt> acts as an implicit ORDER BY clause for the given
fields, that is appended to all the explicitly given ORDER BY
items.</li>
<li>All collections of the ordered type are always retrieved in an
ordered fashion.</li>
<li>To keep the database impact low, these implicit ORDER BY items
are only added to an DQL Query if the collection is fetch joined in
the DQL query.</li>
</ul>
<p>Given our previously defined example, the following would not add
ORDER BY, since g is not fetch joined:</p>
<div class="highlight-sql"><div class="highlight"><pre><span class="k">SELECT</span> <span class="n">u</span> <span class="k">FROM</span> <span class="k">User</span> <span class="n">u</span> <span class="k">JOIN</span> <span class="n">u</span><span class="p">.</span><span class="n">groups</span> <span class="k">g</span> <span class="k">WHERE</span> <span class="k">SIZE</span><span class="p">(</span><span class="k">g</span><span class="p">)</span> <span class="o">&gt;</span> <span class="mi">10</span>
</pre></div>
</div>
<p>However the following:</p>
<div class="highlight-sql"><div class="highlight"><pre><span class="k">SELECT</span> <span class="n">u</span><span class="p">,</span> <span class="k">g</span> <span class="k">FROM</span> <span class="k">User</span> <span class="n">u</span> <span class="k">JOIN</span> <span class="n">u</span><span class="p">.</span><span class="n">groups</span> <span class="k">g</span> <span class="k">WHERE</span> <span class="n">u</span><span class="p">.</span><span class="n">id</span> <span class="o">=</span> <span class="mi">10</span>
</pre></div>
</div>
<p>...would internally be rewritten to:</p>
<div class="highlight-sql"><div class="highlight"><pre><span class="k">SELECT</span> <span class="n">u</span><span class="p">,</span> <span class="k">g</span> <span class="k">FROM</span> <span class="k">User</span> <span class="n">u</span> <span class="k">JOIN</span> <span class="n">u</span><span class="p">.</span><span class="n">groups</span> <span class="k">g</span> <span class="k">WHERE</span> <span class="n">u</span><span class="p">.</span><span class="n">id</span> <span class="o">=</span> <span class="mi">10</span> <span class="k">ORDER</span> <span class="k">BY</span> <span class="k">g</span><span class="p">.</span><span class="n">name</span> <span class="k">ASC</span>
</pre></div>
</div>
<p>You can reverse the order with an explicit DQL ORDER BY:</p>
<div class="highlight-sql"><div class="highlight"><pre><span class="k">SELECT</span> <span class="n">u</span><span class="p">,</span> <span class="k">g</span> <span class="k">FROM</span> <span class="k">User</span> <span class="n">u</span> <span class="k">JOIN</span> <span class="n">u</span><span class="p">.</span><span class="n">groups</span> <span class="k">g</span> <span class="k">WHERE</span> <span class="n">u</span><span class="p">.</span><span class="n">id</span> <span class="o">=</span> <span class="mi">10</span> <span class="k">ORDER</span> <span class="k">BY</span> <span class="k">g</span><span class="p">.</span><span class="n">name</span> <span class="k">DESC</span>
</pre></div>
</div>
<p>...is internally rewritten to:</p>
<div class="highlight-sql"><div class="highlight"><pre><span class="k">SELECT</span> <span class="n">u</span><span class="p">,</span> <span class="k">g</span> <span class="k">FROM</span> <span class="k">User</span> <span class="n">u</span> <span class="k">JOIN</span> <span class="n">u</span><span class="p">.</span><span class="n">groups</span> <span class="k">g</span> <span class="k">WHERE</span> <span class="n">u</span><span class="p">.</span><span class="n">id</span> <span class="o">=</span> <span class="mi">10</span> <span class="k">ORDER</span> <span class="k">BY</span> <span class="k">g</span><span class="p">.</span><span class="n">name</span> <span class="k">DESC</span><span class="p">,</span> <span class="k">g</span><span class="p">.</span><span class="n">name</span> <span class="k">ASC</span>
</pre></div>
</div>
</div>


              </div>
                </div>

            </div>
      <div class="sphinxsidebar">
        <div class="sphinxsidebarwrapper">
             
            <div id="searchbox" style="">
              <h3>Search</h3>
                <form class="search" action="http://readthedocs.org/search/project/" method="get">
                  <input type="text" name="q" size="18">
                  <input type="submit" value="Go">
                  <input type="hidden" name="selected_facets" value="project:">
                </form>
            </div>
            <h4>Previous topic</h4>
            <p class="topless"><a href="composite-primary-keys.html"
                                  title="previous chapter">Composite and Foreign Keys as Primary Key</a></p>
            <h4>Next topic</h4>
            <p class="topless"><a href="override-field-association-mappings-in-subclasses.html"
                                  title="next chapter">Override Field Association Mappings In Subclasses</a></p>
            <h3>This Page</h3>
            <ul class="this-page-menu">
              <li><a href="../_sources/tutorials/ordered-associations.txt"
                     rel="nofollow">Show Source</a></li>
            </ul>
        </div>
      </div>
          <div class="clearer"></div>
        </div>
          <div class="footer">
              &copy; Copyright 2010-12, Doctrine Project Team.
              Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.2.3.
            <br/>
            <a target="_BLANK" href="http://www.servergrove.com"><img src="../_static/servergrove.jpg" /></a>      <br/><br/>
            <form action="https://www.paypal.com/cgi-bin/webscr" method="post">
              <input type="hidden" name="cmd" value="_s-xclick" />
              <input type="hidden" name="hosted_button_id" value="BAE2E3XANQ77Y" />
              <input type="Submit" value="Donate via PayPal" />
            </form>
          </div>
      </div>

      <div id="bot-rcnr">
        <div class="tl"><!-- corner --></div>
      </div>
    </div>

  <a class="githublink" href="http://github.com/doctrine">Fork me on GitHub</a>
  </body>
</html>

APT Browse - Built by Thomas Orozco.