Skip to content

D
doctrine-dbal
Switch branch/tag
Find file
Normal viewHistoryPermalink
commitordercalculator.html 6.67 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 
<!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:04 +0000">

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

<title>CommitOrderCalculator (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/internal/package-summary.html">Namespace</a></li>
<li class="active">Class</li>
<li><a href="../../../doctrine/orm/internal/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/internal/commitordercalculator.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\Internal\CommitOrderCalculator</div>
<div class="location">/Doctrine/ORM/Internal/CommitOrderCalculator.php at line 31</div>

<h1>Class CommitOrderCalculator</h1>

<pre class="tree"><strong>CommitOrderCalculator</strong><br /></pre>

<hr>

<p class="signature">public  class <strong>CommitOrderCalculator</strong></p>

<div class="comment" id="overview_description"><p>The CommitOrderCalculator is used by the UnitOfWork to sort out the
correct order in which changes to entities need to be persisted.</p></div>

<dl>
<dt>Since:</dt>
<dd>2.0</dd>
<dt>Author:</dt>
<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="#IN_PROGRESS">IN_PROGRESS</a></p></td>
</tr>
<tr>
<td class="type">final  int</td>
<td class="description"><p class="name"><a href="#NOT_VISITED">NOT_VISITED</a></p></td>
</tr>
<tr>
<td class="type">final  int</td>
<td class="description"><p class="name"><a href="#VISITED">VISITED</a></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="#addClass()">addClass</a>(mixed class)</p></td>
</tr>
<tr>
<td class="type"> void</td>
<td class="description"><p class="name"><a href="#addDependency()">addDependency</a>(mixed fromClass, mixed toClass)</p></td>
</tr>
<tr>
<td class="type"> void</td>
<td class="description"><p class="name"><a href="#clear()">clear</a>()</p><p class="description">Clears the current graph.</p></td>
</tr>
<tr>
<td class="type"> array</td>
<td class="description"><p class="name"><a href="#getCommitOrder()">getCommitOrder</a>()</p><p class="description">Gets a valid commit order for all current nodes.
</p></td>
</tr>
<tr>
<td class="type"> void</td>
<td class="description"><p class="name"><a href="#hasClass()">hasClass</a>(mixed className)</p></td>
</tr>
</table>

<h2 id="detail_field">Field Detail</h2>
<div class="location">/Doctrine/ORM/Internal/CommitOrderCalculator.php at line 34</div>
<h3 id="IN_PROGRESS">IN_PROGRESS</h3>
<code class="signature">public final  int <strong>IN_PROGRESS</strong> = 2</code>
<div class="details">
</div>

<hr>

<div class="location">/Doctrine/ORM/Internal/CommitOrderCalculator.php at line 33</div>
<h3 id="NOT_VISITED">NOT_VISITED</h3>
<code class="signature">public final  int <strong>NOT_VISITED</strong> = 1</code>
<div class="details">
</div>

<hr>

<div class="location">/Doctrine/ORM/Internal/CommitOrderCalculator.php at line 35</div>
<h3 id="VISITED">VISITED</h3>
<code class="signature">public final  int <strong>VISITED</strong> = 3</code>
<div class="details">
</div>

<hr>

<h2 id="detail_method">Method Detail</h2>
<div class="location">/Doctrine/ORM/Internal/CommitOrderCalculator.php at line 116</div>
<h3 id="addClass()">addClass</h3>
<code class="signature">public  void <strong>addClass</strong>(mixed class)</code>
<div class="details">
</div>

<hr>

<div class="location">/Doctrine/ORM/Internal/CommitOrderCalculator.php at line 106</div>
<h3 id="addDependency()">addDependency</h3>
<code class="signature">public  void <strong>addDependency</strong>(mixed fromClass, mixed toClass)</code>
<div class="details">
</div>

<hr>

<div class="location">/Doctrine/ORM/Internal/CommitOrderCalculator.php at line 47</div>
<h3 id="clear()">clear</h3>
<code class="signature">public  void <strong>clear</strong>()</code>
<div class="details">
<p>Clears the current graph.</p></div>

<hr>

<div class="location">/Doctrine/ORM/Internal/CommitOrderCalculator.php at line 61</div>
<h3 id="getCommitOrder()">getCommitOrder</h3>
<code class="signature">public  array <strong>getCommitOrder</strong>()</code>
<div class="details">
<p>Gets a valid commit order for all current nodes.</p><p>Uses a depth-first search (DFS) to traverse the graph.
The desired topological sorting is the reverse postorder of these searches.</p><dl>
<dt>Returns:</dt>
<dd>The list of ordered classes.</dd>
</dl>
</div>

<hr>

<div class="location">/Doctrine/ORM/Internal/CommitOrderCalculator.php at line 111</div>
<h3 id="hasClass()">hasClass</h3>
<code class="signature">public  void <strong>hasClass</strong>(mixed className)</code>
<div class="details">
</div>

<hr>

<div class="header">
<h1>Doctrine</h1>
<ul>
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="../../../doctrine/orm/internal/package-summary.html">Namespace</a></li>
<li class="active">Class</li>
<li><a href="../../../doctrine/orm/internal/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/internal/commitordercalculator.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>