218 lines
8.8 KiB
HTML
218 lines
8.8 KiB
HTML
<!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:05 +0000">
|
|
|
|
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css">
|
|
<link rel="start" href="../../../overview-summary.html">
|
|
|
|
<title>ParserResult (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/package-summary.html">Namespace</a></li>
|
|
<li class="active">Class</li>
|
|
<li><a href="../../../doctrine/orm/query/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/parserresult.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\ParserResult</div>
|
|
<div class="location">/Doctrine/ORM/Query/ParserResult.php at line 36</div>
|
|
|
|
<h1>Class ParserResult</h1>
|
|
|
|
<pre class="tree"><strong>ParserResult</strong><br /></pre>
|
|
|
|
<hr>
|
|
|
|
<p class="signature">public class <strong>ParserResult</strong></p>
|
|
|
|
<div class="comment" id="overview_description"><p>Encapsulates the resulting components from a DQL query parsing process that
|
|
can be serialized.</p></div>
|
|
|
|
<dl>
|
|
<dt>Author:</dt>
|
|
<dd>Guilherme Blanco <guilhermeblanco@hotmail.com></dd>
|
|
<dd>Janne Vanhala <jpvanhal@cc.hut.fi></dd>
|
|
<dt>Author Roman:</dt>
|
|
<dd>Borschel <roman@code-factory.org></dd>
|
|
<dt>License:</dt>
|
|
<dd>http://www.opensource.org/licenses/lgpl-license.php LGPL</dd>
|
|
<dt>See Also:</dt>
|
|
<dd><code><a href="http://www.doctrine-project.org">http://www.doctrine-project.org</a></code></dd>
|
|
<dt>Since:</dt>
|
|
<dd>2.0</dd>
|
|
<dt>Version:</dt>
|
|
<dd>$Revision$</dd>
|
|
</dl>
|
|
<hr>
|
|
|
|
<table id="summary_constr">
|
|
<tr><th colspan="2">Constructor Summary</th></tr>
|
|
<tr>
|
|
<td class="description"><p class="name"><a href="#ParserResult()">ParserResult</a>()</p><p class="description">Initializes a new instance of the ParserResult class.
|
|
</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="#addParameterMapping()">addParameterMapping</a>(string|integer dqlPosition, integer sqlPosition)</p><p class="description">Adds a DQL to SQL parameter mapping. </p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> array</td>
|
|
<td class="description"><p class="name"><a href="#getParameterMappings()">getParameterMappings</a>()</p><p class="description">Gets all DQL to SQL parameter mappings.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> <a href="../../../doctrine/orm/query/resultsetmapping.html">ResultSetMapping</a></td>
|
|
<td class="description"><p class="name"><a href="#getResultSetMapping()">getResultSetMapping</a>()</p><p class="description">Gets the ResultSetMapping for the parsed query.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> \Doctrine\ORM\Query\Exec\AbstractSqlExecutor</td>
|
|
<td class="description"><p class="name"><a href="#getSqlExecutor()">getSqlExecutor</a>()</p><p class="description">Gets the SQL executor used by this ParserResult.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> array</td>
|
|
<td class="description"><p class="name"><a href="#getSqlParameterPositions()">getSqlParameterPositions</a>(string|integer dqlPosition)</p><p class="description">Gets the SQL parameter positions for a DQL parameter name/position.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> void</td>
|
|
<td class="description"><p class="name"><a href="#setResultSetMapping()">setResultSetMapping</a>(<a href="../../../doctrine/orm/query/resultsetmapping.html">ResultSetMapping</a> rsm)</p><p class="description">Sets the ResultSetMapping of the parsed query.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> void</td>
|
|
<td class="description"><p class="name"><a href="#setSqlExecutor()">setSqlExecutor</a>(\Doctrine\ORM\Query\Exec\AbstractSqlExecutor executor)</p><p class="description">Sets the SQL executor that should be used for this ParserResult.</p></td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h2 id="detail_constr">Constructor Detail</h2>
|
|
<div class="location">/Doctrine/ORM/Query/ParserResult.php at line 63</div>
|
|
<h3 id="ParserResult()">ParserResult</h3>
|
|
<code class="signature">public <strong>ParserResult</strong>()</code>
|
|
<div class="details">
|
|
<p>Initializes a new instance of the <tt>ParserResult</tt> class.
|
|
The new instance is initialized with an empty <tt>ResultSetMapping</tt>.</p></div>
|
|
|
|
<hr>
|
|
|
|
<h2 id="detail_method">Method Detail</h2>
|
|
<div class="location">/Doctrine/ORM/Query/ParserResult.php at line 116</div>
|
|
<h3 id="addParameterMapping()">addParameterMapping</h3>
|
|
<code class="signature">public void <strong>addParameterMapping</strong>(string|integer dqlPosition, integer sqlPosition)</code>
|
|
<div class="details">
|
|
<p>Adds a DQL to SQL parameter mapping. One DQL parameter name/position can map to
|
|
several SQL parameter positions.</p></div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/ORM/Query/ParserResult.php at line 126</div>
|
|
<h3 id="getParameterMappings()">getParameterMappings</h3>
|
|
<code class="signature">public array <strong>getParameterMappings</strong>()</code>
|
|
<div class="details">
|
|
<p>Gets all DQL to SQL parameter mappings.</p><dl>
|
|
<dt>Returns:</dt>
|
|
<dd>The parameter mappings.</dd>
|
|
</dl>
|
|
</div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/ORM/Query/ParserResult.php at line 74</div>
|
|
<h3 id="getResultSetMapping()">getResultSetMapping</h3>
|
|
<code class="signature">public <a href="../../../doctrine/orm/query/resultsetmapping.html">ResultSetMapping</a> <strong>getResultSetMapping</strong>()</code>
|
|
<div class="details">
|
|
<p>Gets the ResultSetMapping for the parsed query.</p><dl>
|
|
<dt>Returns:</dt>
|
|
<dd>The result set mapping of the parsed query or NULL if the query is not a SELECT query.</dd>
|
|
</dl>
|
|
</div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/ORM/Query/ParserResult.php at line 104</div>
|
|
<h3 id="getSqlExecutor()">getSqlExecutor</h3>
|
|
<code class="signature">public \Doctrine\ORM\Query\Exec\AbstractSqlExecutor <strong>getSqlExecutor</strong>()</code>
|
|
<div class="details">
|
|
<p>Gets the SQL executor used by this ParserResult.</p></div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/ORM/Query/ParserResult.php at line 137</div>
|
|
<h3 id="getSqlParameterPositions()">getSqlParameterPositions</h3>
|
|
<code class="signature">public array <strong>getSqlParameterPositions</strong>(string|integer dqlPosition)</code>
|
|
<div class="details">
|
|
<p>Gets the SQL parameter positions for a DQL parameter name/position.</p><dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>dqlPosition - The name or position of the DQL parameter.</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>The positions of the corresponding SQL parameters.</dd>
|
|
</dl>
|
|
</div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/ORM/Query/ParserResult.php at line 84</div>
|
|
<h3 id="setResultSetMapping()">setResultSetMapping</h3>
|
|
<code class="signature">public void <strong>setResultSetMapping</strong>(<a href="../../../doctrine/orm/query/resultsetmapping.html">ResultSetMapping</a> rsm)</code>
|
|
<div class="details">
|
|
<p>Sets the ResultSetMapping of the parsed query.</p></div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/ORM/Query/ParserResult.php at line 94</div>
|
|
<h3 id="setSqlExecutor()">setSqlExecutor</h3>
|
|
<code class="signature">public void <strong>setSqlExecutor</strong>(\Doctrine\ORM\Query\Exec\AbstractSqlExecutor executor)</code>
|
|
<div class="details">
|
|
<p>Sets the SQL executor that should be used for this ParserResult.</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/package-summary.html">Namespace</a></li>
|
|
<li class="active">Class</li>
|
|
<li><a href="../../../doctrine/orm/query/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/parserresult.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> |