185 lines
6.9 KiB
HTML
185 lines
6.9 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:04 +0000">
|
|
|
|
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css">
|
|
<link rel="start" href="../../../overview-summary.html">
|
|
|
|
<title>SequenceGenerator (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/id/package-summary.html">Namespace</a></li>
|
|
<li class="active">Class</li>
|
|
<li><a href="../../../doctrine/orm/id/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/id/sequencegenerator.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\Id\SequenceGenerator</div>
|
|
<div class="location">/Doctrine/ORM/Id/SequenceGenerator.php at line 32</div>
|
|
|
|
<h1>Class SequenceGenerator</h1>
|
|
|
|
<pre class="tree">Class:SequenceGenerator - Superclass: AbstractIdGenerator
|
|
<a href="../../../doctrine/orm/id/abstractidgenerator.html">AbstractIdGenerator</a><br> ⌊ <strong>SequenceGenerator</strong><br /></pre>
|
|
|
|
<hr>
|
|
|
|
<p class="signature">public class <strong>SequenceGenerator</strong><br>extends <a href="../../../doctrine/orm/id/abstractidgenerator.html">AbstractIdGenerator</a>
|
|
|
|
</p>
|
|
|
|
<div class="comment" id="overview_description"><p>Represents an ID generator that uses a database sequence.</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_constr">
|
|
<tr><th colspan="2">Constructor Summary</th></tr>
|
|
<tr>
|
|
<td class="description"><p class="name"><a href="#SequenceGenerator()">SequenceGenerator</a>(string sequenceName, integer allocationSize, Doctrine\ORM\EntityManager em)</p><p class="description">Initializes a new sequence generator.</p></td>
|
|
</tr>
|
|
</table>
|
|
|
|
<table id="summary_method">
|
|
<tr><th colspan="2">Method Summary</th></tr>
|
|
<tr>
|
|
<td class="type"> integer|float</td>
|
|
<td class="description"><p class="name"><a href="#generate()">generate</a>(mixed em, object entity)</p><p class="description">Generates an ID for the given entity.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> integer|float</td>
|
|
<td class="description"><p class="name"><a href="#getCurrentMaxValue()">getCurrentMaxValue</a>()</p><p class="description">Gets the maximum value of the currently allocated bag of values.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> integer|float</td>
|
|
<td class="description"><p class="name"><a href="#getNextValue()">getNextValue</a>()</p><p class="description">Gets the next value that will be returned by generate().</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> void</td>
|
|
<td class="description"><p class="name"><a href="#serialize()">serialize</a>()</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> void</td>
|
|
<td class="description"><p class="name"><a href="#unserialize()">unserialize</a>(mixed serialized)</p></td>
|
|
</tr>
|
|
</table>
|
|
|
|
<table class="inherit">
|
|
<tr><th colspan="2">Methods inherited from Doctrine\ORM\Id\AbstractIdGenerator</th></tr>
|
|
<tr><td><a href="../../../doctrine/orm/id/abstractidgenerator.html#generate()">generate</a>, <a href="../../../doctrine/orm/id/abstractidgenerator.html#isPostInsertGenerator()">isPostInsertGenerator</a></td></tr></table>
|
|
|
|
<h2 id="detail_constr">Constructor Detail</h2>
|
|
<div class="location">/Doctrine/ORM/Id/SequenceGenerator.php at line 46</div>
|
|
<h3 id="SequenceGenerator()">SequenceGenerator</h3>
|
|
<code class="signature">public <strong>SequenceGenerator</strong>(string sequenceName, integer allocationSize, Doctrine\ORM\EntityManager em)</code>
|
|
<div class="details">
|
|
<p>Initializes a new sequence generator.</p><dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>em - The EntityManager to use.</dd>
|
|
<dd>sequenceName - The name of the sequence.</dd>
|
|
<dd>allocationSize - The allocation size of the sequence.</dd>
|
|
</dl>
|
|
</div>
|
|
|
|
<hr>
|
|
|
|
<h2 id="detail_method">Method Detail</h2>
|
|
<div class="location">/Doctrine/ORM/Id/SequenceGenerator.php at line 59</div>
|
|
<h3 id="generate()">generate</h3>
|
|
<code class="signature">public integer|float <strong>generate</strong>(mixed em, object entity)</code>
|
|
<div class="details">
|
|
<p>Generates an ID for the given entity.</p><dl>
|
|
<dt>Returns:</dt>
|
|
<dd>The generated value.</dd>
|
|
<dt>Override.</dt>
|
|
</dl>
|
|
</div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/ORM/Id/SequenceGenerator.php at line 76</div>
|
|
<h3 id="getCurrentMaxValue()">getCurrentMaxValue</h3>
|
|
<code class="signature">public integer|float <strong>getCurrentMaxValue</strong>()</code>
|
|
<div class="details">
|
|
<p>Gets the maximum value of the currently allocated bag of values.</p></div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/ORM/Id/SequenceGenerator.php at line 86</div>
|
|
<h3 id="getNextValue()">getNextValue</h3>
|
|
<code class="signature">public integer|float <strong>getNextValue</strong>()</code>
|
|
<div class="details">
|
|
<p>Gets the next value that will be returned by generate().</p></div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/ORM/Id/SequenceGenerator.php at line 91</div>
|
|
<h3 id="serialize()">serialize</h3>
|
|
<code class="signature">public void <strong>serialize</strong>()</code>
|
|
<div class="details">
|
|
</div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/ORM/Id/SequenceGenerator.php at line 99</div>
|
|
<h3 id="unserialize()">unserialize</h3>
|
|
<code class="signature">public void <strong>unserialize</strong>(mixed serialized)</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/id/package-summary.html">Namespace</a></li>
|
|
<li class="active">Class</li>
|
|
<li><a href="../../../doctrine/orm/id/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/id/sequencegenerator.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> |