194 lines
6.7 KiB
HTML
194 lines
6.7 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>Printer (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/printer.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\Printer</div>
|
||
|
|
<div class="location">/Doctrine/ORM/Query/Printer.php at line 33</div>
|
||
|
|
|
||
|
|
<h1>Class Printer</h1>
|
||
|
|
|
||
|
|
<pre class="tree"><strong>Printer</strong><br /></pre>
|
||
|
|
|
||
|
|
<hr>
|
||
|
|
|
||
|
|
<p class="signature">public class <strong>Printer</strong></p>
|
||
|
|
|
||
|
|
<div class="comment" id="overview_description"><p>A parse tree printer for Doctrine Query Language parser.</p></div>
|
||
|
|
|
||
|
|
<dl>
|
||
|
|
<dt>Author:</dt>
|
||
|
|
<dd>Janne Vanhala <jpvanhal@cc.hut.fi></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.phpdoctrine.org">http://www.phpdoctrine.org</a></code></dd>
|
||
|
|
<dt>Since:</dt>
|
||
|
|
<dd>2.0</dd>
|
||
|
|
<dt>Version:</dt>
|
||
|
|
<dd>$Revision$</dd>
|
||
|
|
</dl>
|
||
|
|
<hr>
|
||
|
|
|
||
|
|
<table id="summary_field">
|
||
|
|
<tr><th colspan="2">Field Summary</th></tr>
|
||
|
|
<tr>
|
||
|
|
<td class="type">protected int</td>
|
||
|
|
<td class="description"><p class="name"><a href="#_indent">$_indent</a></p><p class="description">Current indentation level</p></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="type">protected bool</td>
|
||
|
|
<td class="description"><p class="name"><a href="#_silent">$_silent</a></p><p class="description">Defines whether parse tree is printed (default, false) or not (true).</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="#Printer()">Printer</a>(bool silent)</p><p class="description">Constructs a new parse tree printer.</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="#endProduction()">endProduction</a>()</p><p class="description">Decreases indentation level by one and prints a closing parenthesis.
|
||
|
|
</p></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="type"> void</td>
|
||
|
|
<td class="description"><p class="name"><a href="#println()">println</a>(string str)</p><p class="description">Prints text indented with spaces depending on current indentation level.</p></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="type"> void</td>
|
||
|
|
<td class="description"><p class="name"><a href="#startProduction()">startProduction</a>(string name)</p><p class="description">Prints an opening parenthesis followed by production name and increases
|
||
|
|
indentation level by one.
|
||
|
|
</p></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<h2 id="detail_field">Field Detail</h2>
|
||
|
|
<div class="location">/Doctrine/ORM/Query/Printer.php at line 40</div>
|
||
|
|
<h3 id="_indent">_indent</h3>
|
||
|
|
<code class="signature">protected int <strong>$_indent</strong></code>
|
||
|
|
<div class="details">
|
||
|
|
<p>Current indentation level</p></div>
|
||
|
|
|
||
|
|
<hr>
|
||
|
|
|
||
|
|
<div class="location">/Doctrine/ORM/Query/Printer.php at line 47</div>
|
||
|
|
<h3 id="_silent">_silent</h3>
|
||
|
|
<code class="signature">protected bool <strong>$_silent</strong></code>
|
||
|
|
<div class="details">
|
||
|
|
<p>Defines whether parse tree is printed (default, false) or not (true).</p></div>
|
||
|
|
|
||
|
|
<hr>
|
||
|
|
|
||
|
|
<h2 id="detail_constr">Constructor Detail</h2>
|
||
|
|
<div class="location">/Doctrine/ORM/Query/Printer.php at line 54</div>
|
||
|
|
<h3 id="Printer()">Printer</h3>
|
||
|
|
<code class="signature">public <strong>Printer</strong>(bool silent)</code>
|
||
|
|
<div class="details">
|
||
|
|
<p>Constructs a new parse tree printer.</p><dl>
|
||
|
|
<dt>Parameters:</dt>
|
||
|
|
<dd>silent - Parse tree will not be printed if true.</dd>
|
||
|
|
</dl>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<hr>
|
||
|
|
|
||
|
|
<h2 id="detail_method">Method Detail</h2>
|
||
|
|
<div class="location">/Doctrine/ORM/Query/Printer.php at line 78</div>
|
||
|
|
<h3 id="endProduction()">endProduction</h3>
|
||
|
|
<code class="signature">public void <strong>endProduction</strong>()</code>
|
||
|
|
<div class="details">
|
||
|
|
<p>Decreases indentation level by one and prints a closing parenthesis.</p><p>This method is called after executing a production.</p></div>
|
||
|
|
|
||
|
|
<hr>
|
||
|
|
|
||
|
|
<div class="location">/Doctrine/ORM/Query/Printer.php at line 89</div>
|
||
|
|
<h3 id="println()">println</h3>
|
||
|
|
<code class="signature">public void <strong>println</strong>(string str)</code>
|
||
|
|
<div class="details">
|
||
|
|
<p>Prints text indented with spaces depending on current indentation level.</p><dl>
|
||
|
|
<dt>Parameters:</dt>
|
||
|
|
<dd>str - text</dd>
|
||
|
|
</dl>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<hr>
|
||
|
|
|
||
|
|
<div class="location">/Doctrine/ORM/Query/Printer.php at line 67</div>
|
||
|
|
<h3 id="startProduction()">startProduction</h3>
|
||
|
|
<code class="signature">public void <strong>startProduction</strong>(string name)</code>
|
||
|
|
<div class="details">
|
||
|
|
<p>Prints an opening parenthesis followed by production name and increases
|
||
|
|
indentation level by one.</p><p>This method is called before executing a production.</p><dl>
|
||
|
|
<dt>Parameters:</dt>
|
||
|
|
<dd>name - production name</dd>
|
||
|
|
</dl>
|
||
|
|
</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/printer.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>
|