Skip to content

D
doctrine-dbal
Switch branch/tag
Find file
Normal viewHistoryPermalink
pathexpression.html 8.61 KB
Newer Older
Roman S. Borschel's avatar
Adding new API docs.
10acab65
 
Roman S. Borschel committed
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 
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">

<html lang="en">
<head>

<meta name="generator" content="PHPDoctor 2RC4 (http://phpdoctor.sourceforge.net/)">
<meta name="when" content="Wed, 14 Apr 2010 15:12:06 +0000">

<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css">
<link rel="start" href="../../../../overview-summary.html">

<title>PathExpression (Doctrine)</title>

</head>
<body id="definition" onload="parent.document.title=document.title;">

<div class="header">
<h1>Doctrine</h1>
<ul>
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="../../../../doctrine/orm/query/ast/package-summary.html">Namespace</a></li>
<li class="active">Class</li>
<li><a href="../../../../doctrine/orm/query/ast/package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
</ul>
</div>

<div class="small_links">
<a href="../../../../index.html" target="_top">Frames</a>
<a href="../../../../doctrine/orm/query/ast/pathexpression.html" target="_top">No frames</a>
</div>
<div class="small_links">
Summary: <a href="#summary_field">Field</a> | <a href="#summary_method">Method</a> | <a href="#summary_constr">Constr</a>
Detail: <a href="#detail_field">Field</a> | <a href="#detail_method">Method</a> | <a href="#summary_constr">Constr</a>
</div>
<hr>

<div class="qualifiedName">Doctrine\ORM\Query\AST\PathExpression</div>
<div class="location">/Doctrine/ORM/Query/AST/PathExpression.php at line 42</div>

<h1>Class PathExpression</h1>

<pre class="tree">Class:PathExpression - Superclass: Node
<a href="../../../../doctrine/orm/query/ast/node.html">Node</a><br>   &lfloor;&nbsp;<strong>PathExpression</strong><br /></pre>

<hr>

<p class="signature">public  class <strong>PathExpression</strong><br>extends <a href="../../../../doctrine/orm/query/ast/node.html">Node</a>

</p>

<div class="comment" id="overview_description"><p>AssociationPathExpression ::= CollectionValuedPathExpression | SingleValuedAssociationPathExpression
SingleValuedPathExpression ::= StateFieldPathExpression | SingleValuedAssociationPathExpression
StateFieldPathExpression ::= SimpleStateFieldPathExpression | SimpleStateFieldAssociationPathExpression
SingleValuedAssociationPathExpression ::= IdentificationVariable "." {SingleValuedAssociationField "."}* SingleValuedAssociationField
CollectionValuedPathExpression ::= IdentificationVariable "." {SingleValuedAssociationField "."}* CollectionValuedAssociationField
StateField ::= {EmbeddedClassStateField "."}* SimpleStateField
SimpleStateFieldPathExpression ::= IdentificationVariable "." StateField
SimpleStateFieldAssociationPathExpression ::= SingleValuedAssociationPathExpression "." StateField</p></div>

<dl>
<dt>License:</dt>
<dd>http://www.opensource.org/licenses/lgpl-license.php LGPL</dd>
<dt>See Also:</dt>
<dd><code>www.doctrine-project.org</code></dd>
<dt>Since:</dt>
<dd>2.0</dd>
<dt>Version:</dt>
<dd>$Revision: 3938 $</dd>
<dt>Author:</dt>
<dd>Guilherme Blanco <guilhermeblanco@hotmail.com></dd>
<dd>Jonathan Wage <jonwage@gmail.com></dd>
<dd>Roman Borschel <roman@code-factory.org></dd>
</dl>
<hr>

<table id="summary_field">
<tr><th colspan="2">Field Summary</th></tr>
<tr>
<td class="type">final  int</td>
<td class="description"><p class="name"><a href="#TYPE_COLLECTION_VALUED_ASSOCIATION">TYPE_COLLECTION_VALUED_ASSOCIATION</a></p></td>
</tr>
<tr>
<td class="type">final  int</td>
<td class="description"><p class="name"><a href="#TYPE_SINGLE_VALUED_ASSOCIATION">TYPE_SINGLE_VALUED_ASSOCIATION</a></p></td>
</tr>
<tr>
<td class="type">final  int</td>
<td class="description"><p class="name"><a href="#TYPE_STATE_FIELD">TYPE_STATE_FIELD</a></p></td>
</tr>
<tr>
<td class="type"> mixed</td>
<td class="description"><p class="name"><a href="#expectedType">$expectedType</a></p></td>
</tr>
<tr>
<td class="type"> mixed</td>
<td class="description"><p class="name"><a href="#identificationVariable">$identificationVariable</a></p></td>
</tr>
<tr>
<td class="type"> mixed</td>
<td class="description"><p class="name"><a href="#parts">$parts</a></p></td>
</tr>
<tr>
<td class="type"> mixed</td>
<td class="description"><p class="name"><a href="#type">$type</a></p></td>
</tr>
</table>

<table id="summary_constr">
<tr><th colspan="2">Constructor Summary</th></tr>
<tr>
<td class="description"><p class="name"><a href="#PathExpression()">PathExpression</a>(mixed expectedType, mixed identificationVariable, mixed parts)</p></td>
</tr>
</table>

<table id="summary_method">
<tr><th colspan="2">Method Summary</th></tr>
<tr>
<td class="type"> void</td>
<td class="description"><p class="name"><a href="#dispatch()">dispatch</a>(mixed walker, $walker )</p><p class="description">Double-dispatch method, supposed to dispatch back to the walker.
</p></td>
</tr>
</table>

<table class="inherit">
<tr><th colspan="2">Methods inherited from Doctrine\ORM\Query\AST\Node</th></tr>
<tr><td><a href="../../../../doctrine/orm/query/ast/node.html#dispatch()">dispatch</a>, <a href="../../../../doctrine/orm/query/ast/node.html#dump()">dump</a></td></tr></table>

<h2 id="detail_field">Field Detail</h2>
<div class="location">/Doctrine/ORM/Query/AST/PathExpression.php at line 44</div>
<h3 id="TYPE_COLLECTION_VALUED_ASSOCIATION">TYPE_COLLECTION_VALUED_ASSOCIATION</h3>
<code class="signature">public final  int <strong>TYPE_COLLECTION_VALUED_ASSOCIATION</strong> = 2</code>
<div class="details">
</div>

<hr>

<div class="location">/Doctrine/ORM/Query/AST/PathExpression.php at line 45</div>
<h3 id="TYPE_SINGLE_VALUED_ASSOCIATION">TYPE_SINGLE_VALUED_ASSOCIATION</h3>
<code class="signature">public final  int <strong>TYPE_SINGLE_VALUED_ASSOCIATION</strong> = 4</code>
<div class="details">
</div>

<hr>

<div class="location">/Doctrine/ORM/Query/AST/PathExpression.php at line 46</div>
<h3 id="TYPE_STATE_FIELD">TYPE_STATE_FIELD</h3>
<code class="signature">public final  int <strong>TYPE_STATE_FIELD</strong> = 8</code>
<div class="details">
</div>

<hr>

<div class="location">/Doctrine/ORM/Query/AST/PathExpression.php at line 49</div>
<h3 id="expectedType">expectedType</h3>
<code class="signature">public  mixed <strong>$expectedType</strong></code>
<div class="details">
</div>

<hr>

<div class="location">/Doctrine/ORM/Query/AST/PathExpression.php at line 50</div>
<h3 id="identificationVariable">identificationVariable</h3>
<code class="signature">public  mixed <strong>$identificationVariable</strong></code>
<div class="details">
</div>

<hr>

<div class="location">/Doctrine/ORM/Query/AST/PathExpression.php at line 51</div>
<h3 id="parts">parts</h3>
<code class="signature">public  mixed <strong>$parts</strong></code>
<div class="details">
</div>

<hr>

<div class="location">/Doctrine/ORM/Query/AST/PathExpression.php at line 48</div>
<h3 id="type">type</h3>
<code class="signature">public  mixed <strong>$type</strong></code>
<div class="details">
</div>

<hr>

<h2 id="detail_constr">Constructor Detail</h2>
<div class="location">/Doctrine/ORM/Query/AST/PathExpression.php at line 53</div>
<h3 id="PathExpression()">PathExpression</h3>
<code class="signature">public <strong>PathExpression</strong>(mixed expectedType, mixed identificationVariable, mixed parts)</code>
<div class="details">
</div>

<hr>

<h2 id="detail_method">Method Detail</h2>
<div class="location">/Doctrine/ORM/Query/AST/PathExpression.php at line 60</div>
<h3 id="dispatch()">dispatch</h3>
<code class="signature">public  void <strong>dispatch</strong>(mixed walker, $walker )</code>
<div class="details">
<p>Double-dispatch method, supposed to dispatch back to the walker.</p><p>Implementation is not mandatory for all nodes.</p></div>

<hr>

<div class="header">
<h1>Doctrine</h1>
<ul>
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="../../../../doctrine/orm/query/ast/package-summary.html">Namespace</a></li>
<li class="active">Class</li>
<li><a href="../../../../doctrine/orm/query/ast/package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
</ul>
</div>

<div class="small_links">
<a href="../../../../index.html" target="_top">Frames</a>
<a href="../../../../doctrine/orm/query/ast/pathexpression.html" target="_top">No frames</a>
</div>
<div class="small_links">
Summary: <a href="#summary_field">Field</a> | <a href="#summary_method">Method</a> | <a href="#summary_constr">Constr</a>
Detail: <a href="#detail_field">Field</a> | <a href="#detail_method">Method</a> | <a href="#summary_constr">Constr</a>
</div>
<hr>

<p id="footer">This document was generated by <a href="http://peej.github.com/phpdoctor/">PHPDoctor: The PHP Documentation Creator</a></p>

</body>

</html>