/usr/share/doc/php-doctrine-orm/html/reference/query-builder.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 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 | <!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>16. The QueryBuilder — 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="17. Native SQL" href="native-sql.html" />
<link rel="prev" title="15. Doctrine Query Language" href="dql-doctrine-query-language.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="native-sql.html" title="17. Native SQL"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="dql-doctrine-query-language.html" title="15. Doctrine Query Language"
accesskey="P">previous</a> |</li>
<li><a href="/">Doctrine Homepage</a> »</li>
<li><a href="../index.html">Doctrine 2 ORM 2 documentation</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" >
<div class="section" id="the-querybuilder">
<h1>16. The QueryBuilder<a class="headerlink" href="#the-querybuilder" title="Permalink to this headline">¶</a></h1>
<p>A <tt class="docutils literal"><span class="pre">QueryBuilder</span></tt> provides an API that is designed for
conditionally constructing a DQL query in several steps.</p>
<p>It provides a set of classes and methods that is able to
programmatically build queries, and also provides a fluent API.
This means that you can change between one methodology to the other
as you want, and also pick one if you prefer.</p>
<div class="section" id="constructing-a-new-querybuilder-object">
<h2>16.1. Constructing a new QueryBuilder object<a class="headerlink" href="#constructing-a-new-querybuilder-object" title="Permalink to this headline">¶</a></h2>
<p>The same way you build a normal Query, you build a <tt class="docutils literal"><span class="pre">QueryBuilder</span></tt>
object, just providing the correct method name. Here is an example
how to build a <tt class="docutils literal"><span class="pre">QueryBuilder</span></tt> object:</p>
<div class="highlight-php"><div class="highlight"><pre><span class="cp"><?php</span>
<span class="c1">// $em instanceof EntityManager</span>
<span class="c1">// example1: creating a QueryBuilder instance</span>
<span class="nv">$qb</span> <span class="o">=</span> <span class="nv">$em</span><span class="o">-></span><span class="na">createQueryBuilder</span><span class="p">();</span>
</pre></div>
</div>
<p>Once you have created an instance of QueryBuilder, it provides a
set of useful informative functions that you can use. One good
example is to inspect what type of object the <tt class="docutils literal"><span class="pre">QueryBuilder</span></tt> is.</p>
<div class="highlight-php"><div class="highlight"><pre><span class="cp"><?php</span>
<span class="c1">// $qb instanceof QueryBuilder</span>
<span class="c1">// example2: retrieving type of QueryBuilder</span>
<span class="k">echo</span> <span class="nv">$qb</span><span class="o">-></span><span class="na">getType</span><span class="p">();</span> <span class="c1">// Prints: 0</span>
</pre></div>
</div>
<p>There’re currently 3 possible return values for <tt class="docutils literal"><span class="pre">getType()</span></tt>:</p>
<ul class="simple">
<li><tt class="docutils literal"><span class="pre">QueryBuilder::SELECT</span></tt>, which returns value 0</li>
<li><tt class="docutils literal"><span class="pre">QueryBuilder::DELETE</span></tt>, returning value 1</li>
<li><tt class="docutils literal"><span class="pre">QueryBuilder::UPDATE</span></tt>, which returns value 2</li>
</ul>
<p>It is possible to retrieve the associated <tt class="docutils literal"><span class="pre">EntityManager</span></tt> of the
current <tt class="docutils literal"><span class="pre">QueryBuilder</span></tt>, its DQL and also a <tt class="docutils literal"><span class="pre">Query</span></tt> object when
you finish building your DQL.</p>
<div class="highlight-php"><div class="highlight"><pre><span class="cp"><?php</span>
<span class="c1">// $qb instanceof QueryBuilder</span>
<span class="c1">// example3: retrieve the associated EntityManager</span>
<span class="nv">$em</span> <span class="o">=</span> <span class="nv">$qb</span><span class="o">-></span><span class="na">getEntityManager</span><span class="p">();</span>
<span class="c1">// example4: retrieve the DQL string of what was defined in QueryBuilder</span>
<span class="nv">$dql</span> <span class="o">=</span> <span class="nv">$qb</span><span class="o">-></span><span class="na">getDql</span><span class="p">();</span>
<span class="c1">// example5: retrieve the associated Query object with the processed DQL</span>
<span class="nv">$q</span> <span class="o">=</span> <span class="nv">$qb</span><span class="o">-></span><span class="na">getQuery</span><span class="p">();</span>
</pre></div>
</div>
<p>Internally, <tt class="docutils literal"><span class="pre">QueryBuilder</span></tt> works with a DQL cache to increase
performance. Any changes that may affect the generated DQL actually
modifies the state of <tt class="docutils literal"><span class="pre">QueryBuilder</span></tt> to a stage we call
STATE_DIRTY. One <tt class="docutils literal"><span class="pre">QueryBuilder</span></tt> can be in two different states:</p>
<ul class="simple">
<li><tt class="docutils literal"><span class="pre">QueryBuilder::STATE_CLEAN</span></tt>, which means DQL haven’t been
altered since last retrieval or nothing were added since its
instantiation</li>
<li><tt class="docutils literal"><span class="pre">QueryBuilder::STATE_DIRTY</span></tt>, means DQL query must (and will)
be processed on next retrieval</li>
</ul>
</div>
<div class="section" id="working-with-querybuilder">
<h2>16.2. Working with QueryBuilder<a class="headerlink" href="#working-with-querybuilder" title="Permalink to this headline">¶</a></h2>
<div class="section" id="high-level-api-methods">
<h3>16.2.1. High level API methods<a class="headerlink" href="#high-level-api-methods" title="Permalink to this headline">¶</a></h3>
<p>To simplify even more the way you build a query in Doctrine, we can take
advantage of what we call Helper methods. For all base code, there
is a set of useful methods to simplify a programmer’s life. To
illustrate how to work with them, here is the same example 6
re-written using <tt class="docutils literal"><span class="pre">QueryBuilder</span></tt> helper methods:</p>
<div class="highlight-php"><div class="highlight"><pre><span class="cp"><?php</span>
<span class="c1">// $qb instanceof QueryBuilder</span>
<span class="nv">$qb</span><span class="o">-></span><span class="na">select</span><span class="p">(</span><span class="s1">'u'</span><span class="p">)</span>
<span class="o">-></span><span class="na">from</span><span class="p">(</span><span class="s1">'User'</span><span class="p">,</span> <span class="s1">'u'</span><span class="p">)</span>
<span class="o">-></span><span class="na">where</span><span class="p">(</span><span class="s1">'u.id = ?1'</span><span class="p">)</span>
<span class="o">-></span><span class="na">orderBy</span><span class="p">(</span><span class="s1">'u.name'</span><span class="p">,</span> <span class="s1">'ASC'</span><span class="p">);</span>
</pre></div>
</div>
<p><tt class="docutils literal"><span class="pre">QueryBuilder</span></tt> helper methods are considered the standard way to
build DQL queries. Although it is supported, it should be avoided
to use string based queries and greatly encouraged to use
<tt class="docutils literal"><span class="pre">$qb->expr()->*</span></tt> methods. Here is a converted example 8 to
suggested standard way to build queries:</p>
<div class="highlight-php"><div class="highlight"><pre><span class="cp"><?php</span>
<span class="c1">// $qb instanceof QueryBuilder</span>
<span class="nv">$qb</span><span class="o">-></span><span class="na">select</span><span class="p">(</span><span class="k">array</span><span class="p">(</span><span class="s1">'u'</span><span class="p">))</span> <span class="c1">// string 'u' is converted to array internally</span>
<span class="o">-></span><span class="na">from</span><span class="p">(</span><span class="s1">'User'</span><span class="p">,</span> <span class="s1">'u'</span><span class="p">)</span>
<span class="o">-></span><span class="na">where</span><span class="p">(</span><span class="nv">$qb</span><span class="o">-></span><span class="na">expr</span><span class="p">()</span><span class="o">-></span><span class="na">orX</span><span class="p">(</span>
<span class="nv">$qb</span><span class="o">-></span><span class="na">expr</span><span class="p">()</span><span class="o">-></span><span class="na">eq</span><span class="p">(</span><span class="s1">'u.id'</span><span class="p">,</span> <span class="s1">'?1'</span><span class="p">),</span>
<span class="nv">$qb</span><span class="o">-></span><span class="na">expr</span><span class="p">()</span><span class="o">-></span><span class="na">like</span><span class="p">(</span><span class="s1">'u.nickname'</span><span class="p">,</span> <span class="s1">'?2'</span><span class="p">)</span>
<span class="p">))</span>
<span class="o">-></span><span class="na">orderBy</span><span class="p">(</span><span class="s1">'u.surname'</span><span class="p">,</span> <span class="s1">'ASC'</span><span class="p">));</span>
</pre></div>
</div>
<p>Here is a complete list of helper methods available in <tt class="docutils literal"><span class="pre">QueryBuilder</span></tt>:</p>
<div class="highlight-php"><div class="highlight"><pre><span class="cp"><?php</span>
<span class="k">class</span> <span class="nc">QueryBuilder</span>
<span class="p">{</span>
<span class="c1">// Example - $qb->select('u')</span>
<span class="c1">// Example - $qb->select(array('u', 'p'))</span>
<span class="c1">// Example - $qb->select($qb->expr()->select('u', 'p'))</span>
<span class="k">public</span> <span class="k">function</span> <span class="nf">select</span><span class="p">(</span><span class="nv">$select</span> <span class="o">=</span> <span class="k">null</span><span class="p">);</span>
<span class="c1">// Example - $qb->delete('User', 'u')</span>
<span class="k">public</span> <span class="k">function</span> <span class="nf">delete</span><span class="p">(</span><span class="nv">$delete</span> <span class="o">=</span> <span class="k">null</span><span class="p">,</span> <span class="nv">$alias</span> <span class="o">=</span> <span class="k">null</span><span class="p">);</span>
<span class="c1">// Example - $qb->update('Group', 'g')</span>
<span class="k">public</span> <span class="k">function</span> <span class="nf">update</span><span class="p">(</span><span class="nv">$update</span> <span class="o">=</span> <span class="k">null</span><span class="p">,</span> <span class="nv">$alias</span> <span class="o">=</span> <span class="k">null</span><span class="p">);</span>
<span class="c1">// Example - $qb->set('u.firstName', $qb->expr()->literal('Arnold'))</span>
<span class="c1">// Example - $qb->set('u.numChilds', 'u.numChilds + ?1')</span>
<span class="c1">// Example - $qb->set('u.numChilds', $qb->expr()->sum('u.numChilds', '?1'))</span>
<span class="k">public</span> <span class="k">function</span> <span class="nf">set</span><span class="p">(</span><span class="nv">$key</span><span class="p">,</span> <span class="nv">$value</span><span class="p">);</span>
<span class="c1">// Example - $qb->from('Phonenumber', 'p')</span>
<span class="k">public</span> <span class="k">function</span> <span class="nf">from</span><span class="p">(</span><span class="nv">$from</span><span class="p">,</span> <span class="nv">$alias</span> <span class="o">=</span> <span class="k">null</span><span class="p">);</span>
<span class="c1">// Example - $qb->innerJoin('u.Group', 'g', Expr\Join::WITH, $qb->expr()->eq('u.status_id', '?1'))</span>
<span class="c1">// Example - $qb->innerJoin('u.Group', 'g', 'WITH', 'u.status = ?1')</span>
<span class="k">public</span> <span class="k">function</span> <span class="nf">innerJoin</span><span class="p">(</span><span class="nv">$join</span><span class="p">,</span> <span class="nv">$alias</span> <span class="o">=</span> <span class="k">null</span><span class="p">,</span> <span class="nv">$conditionType</span> <span class="o">=</span> <span class="k">null</span><span class="p">,</span> <span class="nv">$condition</span> <span class="o">=</span> <span class="k">null</span><span class="p">);</span>
<span class="c1">// Example - $qb->leftJoin('u.Phonenumbers', 'p', Expr\Join::WITH, $qb->expr()->eq('p.area_code', 55))</span>
<span class="c1">// Example - $qb->leftJoin('u.Phonenumbers', 'p', 'WITH', 'p.area_code = 55')</span>
<span class="k">public</span> <span class="k">function</span> <span class="nf">leftJoin</span><span class="p">(</span><span class="nv">$join</span><span class="p">,</span> <span class="nv">$alias</span> <span class="o">=</span> <span class="k">null</span><span class="p">,</span> <span class="nv">$conditionType</span> <span class="o">=</span> <span class="k">null</span><span class="p">,</span> <span class="nv">$condition</span> <span class="o">=</span> <span class="k">null</span><span class="p">);</span>
<span class="c1">// NOTE: ->where() overrides all previously set conditions</span>
<span class="c1">//</span>
<span class="c1">// Example - $qb->where('u.firstName = ?1', $qb->expr()->eq('u.surname', '?2'))</span>
<span class="c1">// Example - $qb->where($qb->expr()->andX($qb->expr()->eq('u.firstName', '?1'), $qb->expr()->eq('u.surname', '?2')))</span>
<span class="c1">// Example - $qb->where('u.firstName = ?1 AND u.surname = ?2')</span>
<span class="k">public</span> <span class="k">function</span> <span class="nf">where</span><span class="p">(</span><span class="nv">$where</span><span class="p">);</span>
<span class="c1">// Example - $qb->andWhere($qb->expr()->orX($qb->expr()->lte('u.age', 40), 'u.numChild = 0'))</span>
<span class="k">public</span> <span class="k">function</span> <span class="nf">andWhere</span><span class="p">(</span><span class="nv">$where</span><span class="p">);</span>
<span class="c1">// Example - $qb->orWhere($qb->expr()->between('u.id', 1, 10));</span>
<span class="k">public</span> <span class="k">function</span> <span class="nf">orWhere</span><span class="p">(</span><span class="nv">$where</span><span class="p">);</span>
<span class="c1">// NOTE: -> groupBy() overrides all previously set grouping conditions</span>
<span class="c1">//</span>
<span class="c1">// Example - $qb->groupBy('u.id')</span>
<span class="k">public</span> <span class="k">function</span> <span class="nf">groupBy</span><span class="p">(</span><span class="nv">$groupBy</span><span class="p">);</span>
<span class="c1">// Example - $qb->addGroupBy('g.name')</span>
<span class="k">public</span> <span class="k">function</span> <span class="nf">addGroupBy</span><span class="p">(</span><span class="nv">$groupBy</span><span class="p">);</span>
<span class="c1">// NOTE: -> having() overrides all previously set having conditions</span>
<span class="c1">//</span>
<span class="c1">// Example - $qb->having('u.salary >= ?1')</span>
<span class="c1">// Example - $qb->having($qb->expr()->gte('u.salary', '?1'))</span>
<span class="k">public</span> <span class="k">function</span> <span class="nf">having</span><span class="p">(</span><span class="nv">$having</span><span class="p">);</span>
<span class="c1">// Example - $qb->andHaving($qb->expr()->gt($qb->expr()->count('u.numChild'), 0))</span>
<span class="k">public</span> <span class="k">function</span> <span class="nf">andHaving</span><span class="p">(</span><span class="nv">$having</span><span class="p">);</span>
<span class="c1">// Example - $qb->orHaving($qb->expr()->lte('g.managerLevel', '100'))</span>
<span class="k">public</span> <span class="k">function</span> <span class="nf">orHaving</span><span class="p">(</span><span class="nv">$having</span><span class="p">);</span>
<span class="c1">// NOTE: -> orderBy() overrides all previously set ordering conditions</span>
<span class="c1">//</span>
<span class="c1">// Example - $qb->orderBy('u.surname', 'DESC')</span>
<span class="k">public</span> <span class="k">function</span> <span class="nf">orderBy</span><span class="p">(</span><span class="nv">$sort</span><span class="p">,</span> <span class="nv">$order</span> <span class="o">=</span> <span class="k">null</span><span class="p">);</span>
<span class="c1">// Example - $qb->addOrderBy('u.firstName')</span>
<span class="k">public</span> <span class="k">function</span> <span class="nf">addOrderBy</span><span class="p">(</span><span class="nv">$sort</span><span class="p">,</span> <span class="nv">$order</span> <span class="o">=</span> <span class="k">null</span><span class="p">);</span> <span class="c1">// Default $order = 'ASC'</span>
<span class="p">}</span>
</pre></div>
</div>
</div>
<div class="section" id="binding-parameters-to-your-query">
<h3>16.2.2. Binding parameters to your query<a class="headerlink" href="#binding-parameters-to-your-query" title="Permalink to this headline">¶</a></h3>
<p>Doctrine supports dynamic binding of parameters to your query,
similar to preparing queries. You can use both strings and numbers
as placeholders, although both have a slightly different syntax.
Additionally, you must make your choice: Mixing both styles is not
allowed. Binding parameters can simply be achieved as follows:</p>
<div class="highlight-php"><div class="highlight"><pre><span class="cp"><?php</span>
<span class="c1">// $qb instanceof QueryBuilder</span>
<span class="nv">$qb</span><span class="o">-></span><span class="na">select</span><span class="p">(</span><span class="s1">'u'</span><span class="p">)</span>
<span class="o">-></span><span class="na">from</span><span class="p">(</span><span class="s1">'User u'</span><span class="p">)</span>
<span class="o">-></span><span class="na">where</span><span class="p">(</span><span class="s1">'u.id = ?1'</span><span class="p">)</span>
<span class="o">-></span><span class="na">orderBy</span><span class="p">(</span><span class="s1">'u.name'</span><span class="p">,</span> <span class="s1">'ASC'</span><span class="p">);</span>
<span class="o">-></span><span class="na">setParameter</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="mi">100</span><span class="p">);</span> <span class="c1">// Sets ?1 to 100, and thus we will fetch a user with u.id = 100</span>
</pre></div>
</div>
<p>You are not forced to enumerate your placeholders as the
alternative syntax is available:</p>
<div class="highlight-php"><div class="highlight"><pre><span class="cp"><?php</span>
<span class="c1">// $qb instanceof QueryBuilder</span>
<span class="nv">$qb</span><span class="o">-></span><span class="na">select</span><span class="p">(</span><span class="s1">'u'</span><span class="p">)</span>
<span class="o">-></span><span class="na">from</span><span class="p">(</span><span class="s1">'User u'</span><span class="p">)</span>
<span class="o">-></span><span class="na">where</span><span class="p">(</span><span class="s1">'u.id = :identifier'</span><span class="p">)</span>
<span class="o">-></span><span class="na">orderBy</span><span class="p">(</span><span class="s1">'u.name'</span><span class="p">,</span> <span class="s1">'ASC'</span><span class="p">);</span>
<span class="o">-></span><span class="na">setParameter</span><span class="p">(</span><span class="s1">'identifier'</span><span class="p">,</span> <span class="mi">100</span><span class="p">);</span> <span class="c1">// Sets :identifier to 100, and thus we will fetch a user with u.id = 100</span>
</pre></div>
</div>
<p>Note that numeric placeholders start with a ? followed by a number
while the named placeholders start with a : followed by a string.</p>
<p>Calling <tt class="docutils literal"><span class="pre">setParameter()</span></tt> automatically infers which type you are setting as
value. This works for integers, arrays of strings/integers, DateTime instances
and for managed entities. If you want to set a type explicitly you can call
the third argument to <tt class="docutils literal"><span class="pre">setParameter()</span></tt> explicitly. It accepts either a PDO
type or a DBAL Type name for conversion.</p>
<p>If you’ve got several parameters to bind to your query, you can
also use setParameters() instead of setParameter() with the
following syntax:</p>
<div class="highlight-php"><div class="highlight"><pre><span class="cp"><?php</span>
<span class="c1">// $qb instanceof QueryBuilder</span>
<span class="c1">// Query here...</span>
<span class="nv">$qb</span><span class="o">-></span><span class="na">setParameters</span><span class="p">(</span><span class="k">array</span><span class="p">(</span><span class="mi">1</span> <span class="o">=></span> <span class="s1">'value for ?1'</span><span class="p">,</span> <span class="mi">2</span> <span class="o">=></span> <span class="s1">'value for ?2'</span><span class="p">));</span>
</pre></div>
</div>
<p>Getting already bound parameters is easy - simply use the above
mentioned syntax with “getParameter()” or “getParameters()”:</p>
<div class="highlight-php"><div class="highlight"><pre><span class="cp"><?php</span>
<span class="c1">// $qb instanceof QueryBuilder</span>
<span class="c1">// See example above</span>
<span class="nv">$params</span> <span class="o">=</span> <span class="nv">$qb</span><span class="o">-></span><span class="na">getParameters</span><span class="p">();</span>
<span class="c1">// $params instanceof \Doctrine\Common\Collections\ArrayCollection</span>
<span class="c1">// Equivalent to</span>
<span class="nv">$param</span> <span class="o">=</span> <span class="nv">$qb</span><span class="o">-></span><span class="na">getParameter</span><span class="p">(</span><span class="mi">1</span><span class="p">);</span>
<span class="c1">// $param instanceof \Doctrine\ORM\Query\Parameter</span>
</pre></div>
</div>
<p>Note: If you try to get a parameter that was not bound yet,
getParameter() simply returns NULL.</p>
<p>The API of a Query Parameter is:</p>
<div class="highlight-php"><div class="highlight"><pre><span class="x">namespace Doctrine\ORM\Query;</span>
<span class="x">class Parameter</span>
<span class="x">{</span>
<span class="x"> public function getName();</span>
<span class="x"> public function getValue();</span>
<span class="x"> public function getType();</span>
<span class="x"> public function setValue($value, $type = null);</span>
<span class="x">}</span>
</pre></div>
</div>
</div>
<div class="section" id="limiting-the-result">
<h3>16.2.3. Limiting the Result<a class="headerlink" href="#limiting-the-result" title="Permalink to this headline">¶</a></h3>
<p>To limit a result the query builder has some methods in common with
the Query object which can be retrieved from <tt class="docutils literal"><span class="pre">EntityManager#createQuery()</span></tt>.</p>
<div class="highlight-php"><div class="highlight"><pre><span class="cp"><?php</span>
<span class="c1">// $qb instanceof QueryBuilder</span>
<span class="nv">$offset</span> <span class="o">=</span> <span class="p">(</span><span class="nx">int</span><span class="p">)</span><span class="nv">$_GET</span><span class="p">[</span><span class="s1">'offset'</span><span class="p">];</span>
<span class="nv">$limit</span> <span class="o">=</span> <span class="p">(</span><span class="nx">int</span><span class="p">)</span><span class="nv">$_GET</span><span class="p">[</span><span class="s1">'limit'</span><span class="p">];</span>
<span class="nv">$qb</span><span class="o">-></span><span class="na">add</span><span class="p">(</span><span class="s1">'select'</span><span class="p">,</span> <span class="s1">'u'</span><span class="p">)</span>
<span class="o">-></span><span class="na">add</span><span class="p">(</span><span class="s1">'from'</span><span class="p">,</span> <span class="s1">'User u'</span><span class="p">)</span>
<span class="o">-></span><span class="na">add</span><span class="p">(</span><span class="s1">'orderBy'</span><span class="p">,</span> <span class="s1">'u.name ASC'</span><span class="p">)</span>
<span class="o">-></span><span class="na">setFirstResult</span><span class="p">(</span> <span class="nv">$offset</span> <span class="p">)</span>
<span class="o">-></span><span class="na">setMaxResults</span><span class="p">(</span> <span class="nv">$limit</span> <span class="p">);</span>
</pre></div>
</div>
</div>
<div class="section" id="executing-a-query">
<h3>16.2.4. Executing a Query<a class="headerlink" href="#executing-a-query" title="Permalink to this headline">¶</a></h3>
<p>The QueryBuilder is a builder object only, it has no means of actually
executing the Query. Additionally a set of parameters such as query hints
cannot be set on the QueryBuilder itself. This is why you always have to convert
a querybuilder instance into a Query object:</p>
<div class="highlight-php"><div class="highlight"><pre><span class="cp"><?php</span>
<span class="c1">// $qb instanceof QueryBuilder</span>
<span class="nv">$query</span> <span class="o">=</span> <span class="nv">$qb</span><span class="o">-></span><span class="na">getQuery</span><span class="p">();</span>
<span class="c1">// Set additional Query options</span>
<span class="nv">$query</span><span class="o">-></span><span class="na">setQueryHint</span><span class="p">(</span><span class="s1">'foo'</span><span class="p">,</span> <span class="s1">'bar'</span><span class="p">);</span>
<span class="nv">$query</span><span class="o">-></span><span class="na">useResultCache</span><span class="p">(</span><span class="s1">'my_cache_id'</span><span class="p">);</span>
<span class="c1">// Execute Query</span>
<span class="nv">$result</span> <span class="o">=</span> <span class="nv">$query</span><span class="o">-></span><span class="na">getResult</span><span class="p">();</span>
<span class="nv">$single</span> <span class="o">=</span> <span class="nv">$query</span><span class="o">-></span><span class="na">getSingleResult</span><span class="p">();</span>
<span class="nv">$array</span> <span class="o">=</span> <span class="nv">$query</span><span class="o">-></span><span class="na">getArrayResult</span><span class="p">();</span>
<span class="nv">$scalar</span> <span class="o">=</span> <span class="nv">$query</span><span class="o">-></span><span class="na">getScalarResult</span><span class="p">();</span>
<span class="nv">$singleScalar</span> <span class="o">=</span> <span class="nv">$query</span><span class="o">-></span><span class="na">getSingleScalarResult</span><span class="p">();</span>
</pre></div>
</div>
</div>
<div class="section" id="the-expr-class">
<h3>16.2.5. The Expr class<a class="headerlink" href="#the-expr-class" title="Permalink to this headline">¶</a></h3>
<p>To workaround some of the issues that <tt class="docutils literal"><span class="pre">add()</span></tt> method may cause,
Doctrine created a class that can be considered as a helper for
building expressions. This class is called <tt class="docutils literal"><span class="pre">Expr</span></tt>, which provides a
set of useful methods to help build expressions:</p>
<div class="highlight-php"><div class="highlight"><pre><span class="cp"><?php</span>
<span class="c1">// $qb instanceof QueryBuilder</span>
<span class="c1">// example8: QueryBuilder port of: "SELECT u FROM User u WHERE u.id = ? OR u.nickname LIKE ? ORDER BY u.surname DESC" using Expr class</span>
<span class="nv">$qb</span><span class="o">-></span><span class="na">add</span><span class="p">(</span><span class="s1">'select'</span><span class="p">,</span> <span class="k">new</span> <span class="nx">Expr\Select</span><span class="p">(</span><span class="k">array</span><span class="p">(</span><span class="s1">'u'</span><span class="p">)))</span>
<span class="o">-></span><span class="na">add</span><span class="p">(</span><span class="s1">'from'</span><span class="p">,</span> <span class="k">new</span> <span class="nx">Expr\From</span><span class="p">(</span><span class="s1">'User'</span><span class="p">,</span> <span class="s1">'u'</span><span class="p">))</span>
<span class="o">-></span><span class="na">add</span><span class="p">(</span><span class="s1">'where'</span><span class="p">,</span> <span class="nv">$qb</span><span class="o">-></span><span class="na">expr</span><span class="p">()</span><span class="o">-></span><span class="na">orX</span><span class="p">(</span>
<span class="nv">$qb</span><span class="o">-></span><span class="na">expr</span><span class="p">()</span><span class="o">-></span><span class="na">eq</span><span class="p">(</span><span class="s1">'u.id'</span><span class="p">,</span> <span class="s1">'?1'</span><span class="p">),</span>
<span class="nv">$qb</span><span class="o">-></span><span class="na">expr</span><span class="p">()</span><span class="o">-></span><span class="na">like</span><span class="p">(</span><span class="s1">'u.nickname'</span><span class="p">,</span> <span class="s1">'?2'</span><span class="p">)</span>
<span class="p">))</span>
<span class="o">-></span><span class="na">add</span><span class="p">(</span><span class="s1">'orderBy'</span><span class="p">,</span> <span class="k">new</span> <span class="nx">Expr\OrderBy</span><span class="p">(</span><span class="s1">'u.name'</span><span class="p">,</span> <span class="s1">'ASC'</span><span class="p">));</span>
</pre></div>
</div>
<p>Although it still sounds complex, the ability to programmatically
create conditions are the main feature of <tt class="docutils literal"><span class="pre">Expr</span></tt>. Here it is a
complete list of supported helper methods available:</p>
<div class="highlight-php"><div class="highlight"><pre><span class="cp"><?php</span>
<span class="k">class</span> <span class="nc">Expr</span>
<span class="p">{</span>
<span class="sd">/** Conditional objects **/</span>
<span class="c1">// Example - $qb->expr()->andX($cond1 [, $condN])->add(...)->...</span>
<span class="k">public</span> <span class="k">function</span> <span class="nf">andX</span><span class="p">(</span><span class="nv">$x</span> <span class="o">=</span> <span class="k">null</span><span class="p">);</span> <span class="c1">// Returns Expr\AndX instance</span>
<span class="c1">// Example - $qb->expr()->orX($cond1 [, $condN])->add(...)->...</span>
<span class="k">public</span> <span class="k">function</span> <span class="nf">orX</span><span class="p">(</span><span class="nv">$x</span> <span class="o">=</span> <span class="k">null</span><span class="p">);</span> <span class="c1">// Returns Expr\OrX instance</span>
<span class="sd">/** Comparison objects **/</span>
<span class="c1">// Example - $qb->expr()->eq('u.id', '?1') => u.id = ?1</span>
<span class="k">public</span> <span class="k">function</span> <span class="nf">eq</span><span class="p">(</span><span class="nv">$x</span><span class="p">,</span> <span class="nv">$y</span><span class="p">);</span> <span class="c1">// Returns Expr\Comparison instance</span>
<span class="c1">// Example - $qb->expr()->neq('u.id', '?1') => u.id <> ?1</span>
<span class="k">public</span> <span class="k">function</span> <span class="nf">neq</span><span class="p">(</span><span class="nv">$x</span><span class="p">,</span> <span class="nv">$y</span><span class="p">);</span> <span class="c1">// Returns Expr\Comparison instance</span>
<span class="c1">// Example - $qb->expr()->lt('u.id', '?1') => u.id < ?1</span>
<span class="k">public</span> <span class="k">function</span> <span class="nf">lt</span><span class="p">(</span><span class="nv">$x</span><span class="p">,</span> <span class="nv">$y</span><span class="p">);</span> <span class="c1">// Returns Expr\Comparison instance</span>
<span class="c1">// Example - $qb->expr()->lte('u.id', '?1') => u.id <= ?1</span>
<span class="k">public</span> <span class="k">function</span> <span class="nf">lte</span><span class="p">(</span><span class="nv">$x</span><span class="p">,</span> <span class="nv">$y</span><span class="p">);</span> <span class="c1">// Returns Expr\Comparison instance</span>
<span class="c1">// Example - $qb->expr()->gt('u.id', '?1') => u.id > ?1</span>
<span class="k">public</span> <span class="k">function</span> <span class="nf">gt</span><span class="p">(</span><span class="nv">$x</span><span class="p">,</span> <span class="nv">$y</span><span class="p">);</span> <span class="c1">// Returns Expr\Comparison instance</span>
<span class="c1">// Example - $qb->expr()->gte('u.id', '?1') => u.id >= ?1</span>
<span class="k">public</span> <span class="k">function</span> <span class="nf">gte</span><span class="p">(</span><span class="nv">$x</span><span class="p">,</span> <span class="nv">$y</span><span class="p">);</span> <span class="c1">// Returns Expr\Comparison instance</span>
<span class="c1">// Example - $qb->expr()->isNull('u.id') => u.id IS NULL</span>
<span class="k">public</span> <span class="k">function</span> <span class="nf">isNull</span><span class="p">(</span><span class="nv">$x</span><span class="p">);</span> <span class="c1">// Returns string</span>
<span class="c1">// Example - $qb->expr()->isNotNull('u.id') => u.id IS NOT NULL</span>
<span class="k">public</span> <span class="k">function</span> <span class="nf">isNotNull</span><span class="p">(</span><span class="nv">$x</span><span class="p">);</span> <span class="c1">// Returns string</span>
<span class="sd">/** Arithmetic objects **/</span>
<span class="c1">// Example - $qb->expr()->prod('u.id', '2') => u.id * 2</span>
<span class="k">public</span> <span class="k">function</span> <span class="nf">prod</span><span class="p">(</span><span class="nv">$x</span><span class="p">,</span> <span class="nv">$y</span><span class="p">);</span> <span class="c1">// Returns Expr\Math instance</span>
<span class="c1">// Example - $qb->expr()->diff('u.id', '2') => u.id - 2</span>
<span class="k">public</span> <span class="k">function</span> <span class="nf">diff</span><span class="p">(</span><span class="nv">$x</span><span class="p">,</span> <span class="nv">$y</span><span class="p">);</span> <span class="c1">// Returns Expr\Math instance</span>
<span class="c1">// Example - $qb->expr()->sum('u.id', '2') => u.id + 2</span>
<span class="k">public</span> <span class="k">function</span> <span class="nf">sum</span><span class="p">(</span><span class="nv">$x</span><span class="p">,</span> <span class="nv">$y</span><span class="p">);</span> <span class="c1">// Returns Expr\Math instance</span>
<span class="c1">// Example - $qb->expr()->quot('u.id', '2') => u.id / 2</span>
<span class="k">public</span> <span class="k">function</span> <span class="nf">quot</span><span class="p">(</span><span class="nv">$x</span><span class="p">,</span> <span class="nv">$y</span><span class="p">);</span> <span class="c1">// Returns Expr\Math instance</span>
<span class="sd">/** Pseudo-function objects **/</span>
<span class="c1">// Example - $qb->expr()->exists($qb2->getDql())</span>
<span class="k">public</span> <span class="k">function</span> <span class="nf">exists</span><span class="p">(</span><span class="nv">$subquery</span><span class="p">);</span> <span class="c1">// Returns Expr\Func instance</span>
<span class="c1">// Example - $qb->expr()->all($qb2->getDql())</span>
<span class="k">public</span> <span class="k">function</span> <span class="nf">all</span><span class="p">(</span><span class="nv">$subquery</span><span class="p">);</span> <span class="c1">// Returns Expr\Func instance</span>
<span class="c1">// Example - $qb->expr()->some($qb2->getDql())</span>
<span class="k">public</span> <span class="k">function</span> <span class="nf">some</span><span class="p">(</span><span class="nv">$subquery</span><span class="p">);</span> <span class="c1">// Returns Expr\Func instance</span>
<span class="c1">// Example - $qb->expr()->any($qb2->getDql())</span>
<span class="k">public</span> <span class="k">function</span> <span class="nf">any</span><span class="p">(</span><span class="nv">$subquery</span><span class="p">);</span> <span class="c1">// Returns Expr\Func instance</span>
<span class="c1">// Example - $qb->expr()->not($qb->expr()->eq('u.id', '?1'))</span>
<span class="k">public</span> <span class="k">function</span> <span class="nf">not</span><span class="p">(</span><span class="nv">$restriction</span><span class="p">);</span> <span class="c1">// Returns Expr\Func instance</span>
<span class="c1">// Example - $qb->expr()->in('u.id', array(1, 2, 3))</span>
<span class="c1">// Make sure that you do NOT use something similar to $qb->expr()->in('value', array('stringvalue')) as this will cause Doctrine to throw an Exception.</span>
<span class="c1">// Instead, use $qb->expr()->in('value', array('?1')) and bind your parameter to ?1 (see section above)</span>
<span class="k">public</span> <span class="k">function</span> <span class="nf">in</span><span class="p">(</span><span class="nv">$x</span><span class="p">,</span> <span class="nv">$y</span><span class="p">);</span> <span class="c1">// Returns Expr\Func instance</span>
<span class="c1">// Example - $qb->expr()->notIn('u.id', '2')</span>
<span class="k">public</span> <span class="k">function</span> <span class="nf">notIn</span><span class="p">(</span><span class="nv">$x</span><span class="p">,</span> <span class="nv">$y</span><span class="p">);</span> <span class="c1">// Returns Expr\Func instance</span>
<span class="c1">// Example - $qb->expr()->like('u.firstname', $qb->expr()->literal('Gui%'))</span>
<span class="k">public</span> <span class="k">function</span> <span class="nf">like</span><span class="p">(</span><span class="nv">$x</span><span class="p">,</span> <span class="nv">$y</span><span class="p">);</span> <span class="c1">// Returns Expr\Comparison instance</span>
<span class="c1">// Example - $qb->expr()->between('u.id', '1', '10')</span>
<span class="k">public</span> <span class="k">function</span> <span class="nf">between</span><span class="p">(</span><span class="nv">$val</span><span class="p">,</span> <span class="nv">$x</span><span class="p">,</span> <span class="nv">$y</span><span class="p">);</span> <span class="c1">// Returns Expr\Func</span>
<span class="sd">/** Function objects **/</span>
<span class="c1">// Example - $qb->expr()->trim('u.firstname')</span>
<span class="k">public</span> <span class="k">function</span> <span class="nf">trim</span><span class="p">(</span><span class="nv">$x</span><span class="p">);</span> <span class="c1">// Returns Expr\Func</span>
<span class="c1">// Example - $qb->expr()->concat('u.firstname', $qb->expr()->concat($qb->expr()->literal(' '), 'u.lastname'))</span>
<span class="k">public</span> <span class="k">function</span> <span class="nf">concat</span><span class="p">(</span><span class="nv">$x</span><span class="p">,</span> <span class="nv">$y</span><span class="p">);</span> <span class="c1">// Returns Expr\Func</span>
<span class="c1">// Example - $qb->expr()->substr('u.firstname', 0, 1)</span>
<span class="k">public</span> <span class="k">function</span> <span class="nf">substr</span><span class="p">(</span><span class="nv">$x</span><span class="p">,</span> <span class="nv">$from</span><span class="p">,</span> <span class="nv">$len</span><span class="p">);</span> <span class="c1">// Returns Expr\Func</span>
<span class="c1">// Example - $qb->expr()->lower('u.firstname')</span>
<span class="k">public</span> <span class="k">function</span> <span class="nf">lower</span><span class="p">(</span><span class="nv">$x</span><span class="p">);</span> <span class="c1">// Returns Expr\Func</span>
<span class="c1">// Example - $qb->expr()->upper('u.firstname')</span>
<span class="k">public</span> <span class="k">function</span> <span class="nf">upper</span><span class="p">(</span><span class="nv">$x</span><span class="p">);</span> <span class="c1">// Returns Expr\Func</span>
<span class="c1">// Example - $qb->expr()->length('u.firstname')</span>
<span class="k">public</span> <span class="k">function</span> <span class="nf">length</span><span class="p">(</span><span class="nv">$x</span><span class="p">);</span> <span class="c1">// Returns Expr\Func</span>
<span class="c1">// Example - $qb->expr()->avg('u.age')</span>
<span class="k">public</span> <span class="k">function</span> <span class="nf">avg</span><span class="p">(</span><span class="nv">$x</span><span class="p">);</span> <span class="c1">// Returns Expr\Func</span>
<span class="c1">// Example - $qb->expr()->max('u.age')</span>
<span class="k">public</span> <span class="k">function</span> <span class="nf">max</span><span class="p">(</span><span class="nv">$x</span><span class="p">);</span> <span class="c1">// Returns Expr\Func</span>
<span class="c1">// Example - $qb->expr()->min('u.age')</span>
<span class="k">public</span> <span class="k">function</span> <span class="nf">min</span><span class="p">(</span><span class="nv">$x</span><span class="p">);</span> <span class="c1">// Returns Expr\Func</span>
<span class="c1">// Example - $qb->expr()->abs('u.currentBalance')</span>
<span class="k">public</span> <span class="k">function</span> <span class="nf">abs</span><span class="p">(</span><span class="nv">$x</span><span class="p">);</span> <span class="c1">// Returns Expr\Func</span>
<span class="c1">// Example - $qb->expr()->sqrt('u.currentBalance')</span>
<span class="k">public</span> <span class="k">function</span> <span class="nf">sqrt</span><span class="p">(</span><span class="nv">$x</span><span class="p">);</span> <span class="c1">// Returns Expr\Func</span>
<span class="c1">// Example - $qb->expr()->count('u.firstname')</span>
<span class="k">public</span> <span class="k">function</span> <span class="nf">count</span><span class="p">(</span><span class="nv">$x</span><span class="p">);</span> <span class="c1">// Returns Expr\Func</span>
<span class="c1">// Example - $qb->expr()->countDistinct('u.surname')</span>
<span class="k">public</span> <span class="k">function</span> <span class="nf">countDistinct</span><span class="p">(</span><span class="nv">$x</span><span class="p">);</span> <span class="c1">// Returns Expr\Func</span>
<span class="p">}</span>
</pre></div>
</div>
</div>
<div class="section" id="low-level-api">
<h3>16.2.6. Low Level API<a class="headerlink" href="#low-level-api" title="Permalink to this headline">¶</a></h3>
<p>Now we have describe the low level (thought of as the
hardcore method) of creating queries. It may be useful to work at
this level for optimization purposes, but most of the time it is
preferred to work at a higher level of abstraction.</p>
<p>All helper methods in <tt class="docutils literal"><span class="pre">QueryBuilder</span></tt> actually rely on a single
one: <tt class="docutils literal"><span class="pre">add()</span></tt>. This method is responsible of building every piece
of DQL. It takes 3 parameters: <tt class="docutils literal"><span class="pre">$dqlPartName</span></tt>, <tt class="docutils literal"><span class="pre">$dqlPart</span></tt> and
<tt class="docutils literal"><span class="pre">$append</span></tt> (default=false)</p>
<ul class="simple">
<li><tt class="docutils literal"><span class="pre">$dqlPartName</span></tt>: Where the <tt class="docutils literal"><span class="pre">$dqlPart</span></tt> should be placed.
Possible values: select, from, where, groupBy, having, orderBy</li>
<li><tt class="docutils literal"><span class="pre">$dqlPart</span></tt>: What should be placed in <tt class="docutils literal"><span class="pre">$dqlPartName</span></tt>. Accepts
a string or any instance of <tt class="docutils literal"><span class="pre">Doctrine\ORM\Query\Expr\*</span></tt></li>
<li><tt class="docutils literal"><span class="pre">$append</span></tt>: Optional flag (default=false) if the <tt class="docutils literal"><span class="pre">$dqlPart</span></tt>
should override all previously defined items in <tt class="docutils literal"><span class="pre">$dqlPartName</span></tt> or
not (no effect on the <tt class="docutils literal"><span class="pre">where</span></tt> and <tt class="docutils literal"><span class="pre">having</span></tt> DQL query parts,
which always override all previously defined items)</li>
<li></li>
</ul>
<div class="highlight-php"><div class="highlight"><pre><span class="cp"><?php</span>
<span class="c1">// $qb instanceof QueryBuilder</span>
<span class="c1">// example6: how to define: "SELECT u FROM User u WHERE u.id = ? ORDER BY u.name ASC" using QueryBuilder string support</span>
<span class="nv">$qb</span><span class="o">-></span><span class="na">add</span><span class="p">(</span><span class="s1">'select'</span><span class="p">,</span> <span class="s1">'u'</span><span class="p">)</span>
<span class="o">-></span><span class="na">add</span><span class="p">(</span><span class="s1">'from'</span><span class="p">,</span> <span class="s1">'User u'</span><span class="p">)</span>
<span class="o">-></span><span class="na">add</span><span class="p">(</span><span class="s1">'where'</span><span class="p">,</span> <span class="s1">'u.id = ?1'</span><span class="p">)</span>
<span class="o">-></span><span class="na">add</span><span class="p">(</span><span class="s1">'orderBy'</span><span class="p">,</span> <span class="s1">'u.name ASC'</span><span class="p">);</span>
</pre></div>
</div>
</div>
<div class="section" id="expr-classes">
<h3>16.2.7. Expr* classes<a class="headerlink" href="#expr-classes" title="Permalink to this headline">¶</a></h3>
<p>When you call <tt class="docutils literal"><span class="pre">add()</span></tt> with string, it internally evaluates to an
instance of <tt class="docutils literal"><span class="pre">Doctrine\ORM\Query\Expr\Expr\*</span></tt> class. Here is the
same query of example 6 written using
<tt class="docutils literal"><span class="pre">Doctrine\ORM\Query\Expr\Expr\*</span></tt> classes:</p>
<div class="highlight-php"><div class="highlight"><pre><span class="cp"><?php</span>
<span class="c1">// $qb instanceof QueryBuilder</span>
<span class="c1">// example7: how to define: "SELECT u FROM User u WHERE u.id = ? ORDER BY u.name ASC" using QueryBuilder using Expr\* instances</span>
<span class="nv">$qb</span><span class="o">-></span><span class="na">add</span><span class="p">(</span><span class="s1">'select'</span><span class="p">,</span> <span class="k">new</span> <span class="nx">Expr\Select</span><span class="p">(</span><span class="k">array</span><span class="p">(</span><span class="s1">'u'</span><span class="p">)))</span>
<span class="o">-></span><span class="na">add</span><span class="p">(</span><span class="s1">'from'</span><span class="p">,</span> <span class="k">new</span> <span class="nx">Expr\From</span><span class="p">(</span><span class="s1">'User'</span><span class="p">,</span> <span class="s1">'u'</span><span class="p">))</span>
<span class="o">-></span><span class="na">add</span><span class="p">(</span><span class="s1">'where'</span><span class="p">,</span> <span class="k">new</span> <span class="nx">Expr\Comparison</span><span class="p">(</span><span class="s1">'u.id'</span><span class="p">,</span> <span class="s1">'='</span><span class="p">,</span> <span class="s1">'?1'</span><span class="p">))</span>
<span class="o">-></span><span class="na">add</span><span class="p">(</span><span class="s1">'orderBy'</span><span class="p">,</span> <span class="k">new</span> <span class="nx">Expr\OrderBy</span><span class="p">(</span><span class="s1">'u.name'</span><span class="p">,</span> <span class="s1">'ASC'</span><span class="p">));</span>
</pre></div>
</div>
<p>Of course this is the hardest way to build a DQL query in Doctrine.
To simplify some of these efforts, we introduce what we call as
<tt class="docutils literal"><span class="pre">Expr</span></tt> helper class.</p>
</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>
<h3><a href="../index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">16. The QueryBuilder</a><ul>
<li><a class="reference internal" href="#constructing-a-new-querybuilder-object">16.1. Constructing a new QueryBuilder object</a></li>
<li><a class="reference internal" href="#working-with-querybuilder">16.2. Working with QueryBuilder</a><ul>
<li><a class="reference internal" href="#high-level-api-methods">16.2.1. High level API methods</a></li>
<li><a class="reference internal" href="#binding-parameters-to-your-query">16.2.2. Binding parameters to your query</a></li>
<li><a class="reference internal" href="#limiting-the-result">16.2.3. Limiting the Result</a></li>
<li><a class="reference internal" href="#executing-a-query">16.2.4. Executing a Query</a></li>
<li><a class="reference internal" href="#the-expr-class">16.2.5. The Expr class</a></li>
<li><a class="reference internal" href="#low-level-api">16.2.6. Low Level API</a></li>
<li><a class="reference internal" href="#expr-classes">16.2.7. Expr* classes</a></li>
</ul>
</li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="dql-doctrine-query-language.html"
title="previous chapter">15. Doctrine Query Language</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="native-sql.html"
title="next chapter">17. Native SQL</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/reference/query-builder.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
© 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>
|