generate new api documentation

This commit is contained in:
Manuel Raynaud
2013-02-19 12:12:50 +01:00
parent 41d608c378
commit 99b428fb5c
1411 changed files with 247479 additions and 235229 deletions

View File

@@ -7,7 +7,7 @@
<title>Class Thelia\Model\om\BaseMessagePeer | thelia</title>
<script type="text/javascript" src="resources/combined.js?394153670"></script>
<script type="text/javascript" src="elementlist.js?319012511"></script>
<script type="text/javascript" src="elementlist.js?3178389089"></script>
<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360" />
</head>
@@ -21,8 +21,6 @@
<div id="groups">
<h3>Namespaces</h3>
<ul>
<li><a href="namespace-PHP.html">PHP</a>
</li>
<li class="active"><a href="namespace-Thelia.html">Thelia<span></span></a>
<ul>
<li><a href="namespace-Thelia.Action.html">Action</a>
@@ -61,7 +59,11 @@
</ul></li>
<li><a href="namespace-Thelia.Tools.html">Tools</a>
</li>
</ul></li>
<li><a href="namespace-Thelia.Tpex.html">Tpex<span></span></a>
<ul>
<li><a href="namespace-Thelia.Tpex.Loop.html">Loop</a>
</li>
</ul></li></ul></li>
</ul>
</div>
@@ -424,7 +426,7 @@ table.</p>
<b>Namespace:</b> <a href="namespace-Thelia.html">Thelia</a>\<a href="namespace-Thelia.Model.html">Model</a>\<a href="namespace-Thelia.Model.om.html">om</a><br />
<b>Package:</b> propel\generator\Thelia\Model\om<br />
<b>Located at</b> <a href="source-class-Thelia.Model.om.BaseMessagePeer.html#18-848" title="Go to source code">core/lib/Thelia/Model/om/BaseMessagePeer.php</a><br />
<b>Located at</b> <a href="source-class-Thelia.Model.om.BaseMessagePeer.html#18-855" title="Go to source code">core/lib/Thelia/Model/om/BaseMessagePeer.php</a><br />
</div>
@@ -783,7 +785,7 @@ PropelException.<br />
<td class="attributes"><code>
public static
<code><a href="class-PDOStatement.html">PDOStatement</a></code>
PDOStatement
</code>
</td>
@@ -805,7 +807,7 @@ a PDOStatement.</p>
a PDOStatement.</p>
<p>Use this method directly if you want to work with an executed statement
durirectly (for example to perform your own object hydration).</p>
directly (for example to perform your own object hydration).</p>
@@ -819,7 +821,7 @@ durirectly (for example to perform your own object hydration).</p>
<h4>Returns</h4>
<div class="list">
<code><code><a href="class-PDOStatement.html">PDOStatement</a></code></code><br>The executed PDOStatement object.<br />
<code>PDOStatement</code><br>The executed PDOStatement object.<br />
</div>
<h4>Throws</h4>
@@ -996,7 +998,7 @@ pooling has been disabled.<br />
<td class="name"><div>
<a class="anchor" href="#_clearInstancePool">#</a>
<code><a href="source-class-Thelia.Model.om.BaseMessagePeer.html#405-413" title="Go to source code">clearInstancePool</a>( )</code>
<code><a href="source-class-Thelia.Model.om.BaseMessagePeer.html#405-420" title="Go to source code">clearInstancePool</a>( <span>mixed <var>$and_clear_all_references</var> = <span class="php-keyword1">false</span></span> )</code>
<div class="description short">
@@ -1029,7 +1031,7 @@ pooling has been disabled.<br />
<td class="name"><div>
<a class="anchor" href="#_clearRelatedInstancePool">#</a>
<code><a href="source-class-Thelia.Model.om.BaseMessagePeer.html#415-427" title="Go to source code">clearRelatedInstancePool</a>( )</code>
<code><a href="source-class-Thelia.Model.om.BaseMessagePeer.html#422-434" title="Go to source code">clearRelatedInstancePool</a>( )</code>
<div class="description short">
@@ -1064,7 +1066,7 @@ foreign key with ON DELETE CASCADE</p>
<td class="name"><div>
<a class="anchor" href="#_getPrimaryKeyHashFromRow">#</a>
<code><a href="source-class-Thelia.Model.om.BaseMessagePeer.html#429-447" title="Go to source code">getPrimaryKeyHashFromRow</a>( <span>array <var>$row</var></span>, <span>integer <var>$startcol</var> = <span class="php-num">0</span></span> )</code>
<code><a href="source-class-Thelia.Model.om.BaseMessagePeer.html#436-454" title="Go to source code">getPrimaryKeyHashFromRow</a>( <span>array <var>$row</var></span>, <span>integer <var>$startcol</var> = <span class="php-num">0</span></span> )</code>
<div class="description short">
@@ -1115,7 +1117,7 @@ are all null.<br />
<td class="name"><div>
<a class="anchor" href="#_getPrimaryKeyFromRow">#</a>
<code><a href="source-class-Thelia.Model.om.BaseMessagePeer.html#449-462" title="Go to source code">getPrimaryKeyFromRow</a>( <span>array <var>$row</var></span>, <span>integer <var>$startcol</var> = <span class="php-num">0</span></span> )</code>
<code><a href="source-class-Thelia.Model.om.BaseMessagePeer.html#456-469" title="Go to source code">getPrimaryKeyFromRow</a>( <span>array <var>$row</var></span>, <span>integer <var>$startcol</var> = <span class="php-num">0</span></span> )</code>
<div class="description short">
@@ -1165,7 +1167,7 @@ returned.</p>
<td class="name"><div>
<a class="anchor" href="#_populateObjects">#</a>
<code><a href="source-class-Thelia.Model.om.BaseMessagePeer.html#464-495" title="Go to source code">populateObjects</a>( <span><code><a href="class-PDOStatement.html">PDOStatement</a></code> <var>$stmt</var></span> )</code>
<code><a href="source-class-Thelia.Model.om.BaseMessagePeer.html#471-502" title="Go to source code">populateObjects</a>( <span>PDOStatement <var>$stmt</var></span> )</code>
<div class="description short">
@@ -1205,7 +1207,7 @@ PropelException.<br />
<td class="name"><div>
<a class="anchor" href="#_populateObject">#</a>
<code><a href="source-class-Thelia.Model.om.BaseMessagePeer.html#496-521" title="Go to source code">populateObject</a>( <span>array <var>$row</var></span>, <span>integer <var>$startcol</var> = <span class="php-num">0</span></span> )</code>
<code><a href="source-class-Thelia.Model.om.BaseMessagePeer.html#503-528" title="Go to source code">populateObject</a>( <span>array <var>$row</var></span>, <span>integer <var>$startcol</var> = <span class="php-num">0</span></span> )</code>
<div class="description short">
@@ -1256,7 +1258,7 @@ PropelException.<br />
<td class="name"><div>
<a class="anchor" href="#_getTableMap">#</a>
<code><a href="source-class-Thelia.Model.om.BaseMessagePeer.html#523-533" title="Go to source code">getTableMap</a>( )</code>
<code><a href="source-class-Thelia.Model.om.BaseMessagePeer.html#530-540" title="Go to source code">getTableMap</a>( )</code>
<div class="description short">
@@ -1300,7 +1302,7 @@ PropelException.<br />
<td class="name"><div>
<a class="anchor" href="#_buildTableMap">#</a>
<code><a href="source-class-Thelia.Model.om.BaseMessagePeer.html#535-544" title="Go to source code">buildTableMap</a>( )</code>
<code><a href="source-class-Thelia.Model.om.BaseMessagePeer.html#542-551" title="Go to source code">buildTableMap</a>( )</code>
<div class="description short">
@@ -1333,7 +1335,7 @@ PropelException.<br />
<td class="name"><div>
<a class="anchor" href="#_getOMClass">#</a>
<code><a href="source-class-Thelia.Model.om.BaseMessagePeer.html#546-555" title="Go to source code">getOMClass</a>( )</code>
<code><a href="source-class-Thelia.Model.om.BaseMessagePeer.html#553-562" title="Go to source code">getOMClass</a>( <span>mixed <var>$row</var> = <span class="php-num">0</span></span>, <span>mixed <var>$colnum</var> = <span class="php-num">0</span></span> )</code>
<div class="description short">
@@ -1370,7 +1372,7 @@ PropelException.<br />
<td class="name"><div>
<a class="anchor" href="#_doInsert">#</a>
<code><a href="source-class-Thelia.Model.om.BaseMessagePeer.html#557-598" title="Go to source code">doInsert</a>( <span>mixed <var>$values</var></span>, <span>PropelPDO <var>$con</var> = <span class="php-keyword1">null</span></span> )</code>
<code><a href="source-class-Thelia.Model.om.BaseMessagePeer.html#564-605" title="Go to source code">doInsert</a>( <span>mixed <var>$values</var></span>, <span>PropelPDO <var>$con</var> = <span class="php-keyword1">null</span></span> )</code>
<div class="description short">
@@ -1420,7 +1422,7 @@ PropelException.<br />
<td class="name"><div>
<a class="anchor" href="#_doUpdate">#</a>
<code><a href="source-class-Thelia.Model.om.BaseMessagePeer.html#600-637" title="Go to source code">doUpdate</a>( <span>mixed <var>$values</var></span>, <span>PropelPDO <var>$con</var> = <span class="php-keyword1">null</span></span> )</code>
<code><a href="source-class-Thelia.Model.om.BaseMessagePeer.html#607-644" title="Go to source code">doUpdate</a>( <span>mixed <var>$values</var></span>, <span>PropelPDO <var>$con</var> = <span class="php-keyword1">null</span></span> )</code>
<div class="description short">
@@ -1471,7 +1473,7 @@ PropelException.<br />
<td class="name"><div>
<a class="anchor" href="#_doDeleteAll">#</a>
<code><a href="source-class-Thelia.Model.om.BaseMessagePeer.html#639-669" title="Go to source code">doDeleteAll</a>( <span>PropelPDO <var>$con</var> = <span class="php-keyword1">null</span></span> )</code>
<code><a href="source-class-Thelia.Model.om.BaseMessagePeer.html#646-676" title="Go to source code">doDeleteAll</a>( <span>PropelPDO <var>$con</var> = <span class="php-keyword1">null</span></span> )</code>
<div class="description short">
@@ -1517,7 +1519,7 @@ PropelException.<br />
<td class="name"><div>
<a class="anchor" href="#_doDelete">#</a>
<code><a href="source-class-Thelia.Model.om.BaseMessagePeer.html#671-728" title="Go to source code">doDelete</a>( <span>mixed <var>$values</var></span>, <span>PropelPDO <var>$con</var> = <span class="php-keyword1">null</span></span> )</code>
<code><a href="source-class-Thelia.Model.om.BaseMessagePeer.html#678-735" title="Go to source code">doDelete</a>( <span>mixed <var>$values</var></span>, <span>PropelPDO <var>$con</var> = <span class="php-keyword1">null</span></span> )</code>
<div class="description short">
@@ -1571,7 +1573,7 @@ PropelException.<br />
<td class="name"><div>
<a class="anchor" href="#_doValidate">#</a>
<code><a href="source-class-Thelia.Model.om.BaseMessagePeer.html#730-765" title="Go to source code">doValidate</a>( <span><code><a href="class-Thelia.Model.Message.html">Thelia\Model\Message</a></code> <var>$obj</var></span>, <span>mixed <var>$cols</var> = <span class="php-keyword1">null</span></span> )</code>
<code><a href="source-class-Thelia.Model.om.BaseMessagePeer.html#737-772" title="Go to source code">doValidate</a>( <span><code><a href="class-Thelia.Model.Message.html">Thelia\Model\Message</a></code> <var>$obj</var></span>, <span>mixed <var>$cols</var> = <span class="php-keyword1">null</span></span> )</code>
<div class="description short">
@@ -1621,7 +1623,7 @@ columns are validated.</p>
<td class="name"><div>
<a class="anchor" href="#_retrieveByPK">#</a>
<code><a href="source-class-Thelia.Model.om.BaseMessagePeer.html#767-791" title="Go to source code">retrieveByPK</a>( <span>integer <var>$pk</var></span>, <span>PropelPDO <var>$con</var> = <span class="php-keyword1">null</span></span> )</code>
<code><a href="source-class-Thelia.Model.om.BaseMessagePeer.html#774-798" title="Go to source code">retrieveByPK</a>( <span>integer <var>$pk</var></span>, <span>PropelPDO <var>$con</var> = <span class="php-keyword1">null</span></span> )</code>
<div class="description short">
@@ -1665,7 +1667,7 @@ columns are validated.</p>
<td class="name"><div>
<a class="anchor" href="#_retrieveByPKs">#</a>
<code><a href="source-class-Thelia.Model.om.BaseMessagePeer.html#793-818" title="Go to source code">retrieveByPKs</a>( <span>array <var>$pks</var></span>, <span>PropelPDO <var>$con</var> = <span class="php-keyword1">null</span></span> )</code>
<code><a href="source-class-Thelia.Model.om.BaseMessagePeer.html#800-825" title="Go to source code">retrieveByPKs</a>( <span>array <var>$pks</var></span>, <span>PropelPDO <var>$con</var> = <span class="php-keyword1">null</span></span> )</code>
<div class="description short">
@@ -1714,7 +1716,7 @@ PropelException.<br />
<td class="name"><div>
<a class="anchor" href="#_isVersioningEnabled">#</a>
<code><a href="source-class-Thelia.Model.om.BaseMessagePeer.html#822-830" title="Go to source code">isVersioningEnabled</a>( )</code>
<code><a href="source-class-Thelia.Model.om.BaseMessagePeer.html#829-837" title="Go to source code">isVersioningEnabled</a>( )</code>
<div class="description short">
@@ -1751,7 +1753,7 @@ PropelException.<br />
<td class="name"><div>
<a class="anchor" href="#_enableVersioning">#</a>
<code><a href="source-class-Thelia.Model.om.BaseMessagePeer.html#832-838" title="Go to source code">enableVersioning</a>( )</code>
<code><a href="source-class-Thelia.Model.om.BaseMessagePeer.html#839-845" title="Go to source code">enableVersioning</a>( )</code>
<div class="description short">
@@ -1784,7 +1786,7 @@ PropelException.<br />
<td class="name"><div>
<a class="anchor" href="#_disableVersioning">#</a>
<code><a href="source-class-Thelia.Model.om.BaseMessagePeer.html#840-846" title="Go to source code">disableVersioning</a>( )</code>
<code><a href="source-class-Thelia.Model.om.BaseMessagePeer.html#847-853" title="Go to source code">disableVersioning</a>( )</code>
<div class="description short">
@@ -1991,19 +1993,19 @@ PropelException.<br />
<td class="name"><code>
<a href="source-class-Thelia.Model.om.BaseMessagePeer.html#49-50" title="Go to source code"><b>ID</b></a>
</code></td>
<td class="value"><code><span class="php-quote">'message.ID'</span></code></td>
<td class="value"><code><span class="php-quote">'message.id'</span></code></td>
<td class="description"><div>
<a href="#ID" class="anchor">#</a>
<div class="description short">
<p>the column name for the ID field</p>
<p>the column name for the id field</p>
</div>
<div class="description detailed hidden">
<p>the column name for the ID field</p>
<p>the column name for the id field</p>
</div>
@@ -2015,19 +2017,19 @@ PropelException.<br />
<td class="name"><code>
<a href="source-class-Thelia.Model.om.BaseMessagePeer.html#52-53" title="Go to source code"><b>CODE</b></a>
</code></td>
<td class="value"><code><span class="php-quote">'message.CODE'</span></code></td>
<td class="value"><code><span class="php-quote">'message.code'</span></code></td>
<td class="description"><div>
<a href="#CODE" class="anchor">#</a>
<div class="description short">
<p>the column name for the CODE field</p>
<p>the column name for the code field</p>
</div>
<div class="description detailed hidden">
<p>the column name for the CODE field</p>
<p>the column name for the code field</p>
</div>
@@ -2039,19 +2041,19 @@ PropelException.<br />
<td class="name"><code>
<a href="source-class-Thelia.Model.om.BaseMessagePeer.html#55-56" title="Go to source code"><b>SECURED</b></a>
</code></td>
<td class="value"><code><span class="php-quote">'message.SECURED'</span></code></td>
<td class="value"><code><span class="php-quote">'message.secured'</span></code></td>
<td class="description"><div>
<a href="#SECURED" class="anchor">#</a>
<div class="description short">
<p>the column name for the SECURED field</p>
<p>the column name for the secured field</p>
</div>
<div class="description detailed hidden">
<p>the column name for the SECURED field</p>
<p>the column name for the secured field</p>
</div>
@@ -2063,19 +2065,19 @@ PropelException.<br />
<td class="name"><code>
<a href="source-class-Thelia.Model.om.BaseMessagePeer.html#58-59" title="Go to source code"><b>REF</b></a>
</code></td>
<td class="value"><code><span class="php-quote">'message.REF'</span></code></td>
<td class="value"><code><span class="php-quote">'message.ref'</span></code></td>
<td class="description"><div>
<a href="#REF" class="anchor">#</a>
<div class="description short">
<p>the column name for the REF field</p>
<p>the column name for the ref field</p>
</div>
<div class="description detailed hidden">
<p>the column name for the REF field</p>
<p>the column name for the ref field</p>
</div>
@@ -2087,19 +2089,19 @@ PropelException.<br />
<td class="name"><code>
<a href="source-class-Thelia.Model.om.BaseMessagePeer.html#61-62" title="Go to source code"><b>CREATED_AT</b></a>
</code></td>
<td class="value"><code><span class="php-quote">'message.CREATED_AT'</span></code></td>
<td class="value"><code><span class="php-quote">'message.created_at'</span></code></td>
<td class="description"><div>
<a href="#CREATED_AT" class="anchor">#</a>
<div class="description short">
<p>the column name for the CREATED_AT field</p>
<p>the column name for the created_at field</p>
</div>
<div class="description detailed hidden">
<p>the column name for the CREATED_AT field</p>
<p>the column name for the created_at field</p>
</div>
@@ -2111,19 +2113,19 @@ PropelException.<br />
<td class="name"><code>
<a href="source-class-Thelia.Model.om.BaseMessagePeer.html#64-65" title="Go to source code"><b>UPDATED_AT</b></a>
</code></td>
<td class="value"><code><span class="php-quote">'message.UPDATED_AT'</span></code></td>
<td class="value"><code><span class="php-quote">'message.updated_at'</span></code></td>
<td class="description"><div>
<a href="#UPDATED_AT" class="anchor">#</a>
<div class="description short">
<p>the column name for the UPDATED_AT field</p>
<p>the column name for the updated_at field</p>
</div>
<div class="description detailed hidden">
<p>the column name for the UPDATED_AT field</p>
<p>the column name for the updated_at field</p>
</div>
@@ -2135,19 +2137,19 @@ PropelException.<br />
<td class="name"><code>
<a href="source-class-Thelia.Model.om.BaseMessagePeer.html#67-68" title="Go to source code"><b>VERSION</b></a>
</code></td>
<td class="value"><code><span class="php-quote">'message.VERSION'</span></code></td>
<td class="value"><code><span class="php-quote">'message.version'</span></code></td>
<td class="description"><div>
<a href="#VERSION" class="anchor">#</a>
<div class="description short">
<p>the column name for the VERSION field</p>
<p>the column name for the version field</p>
</div>
<div class="description detailed hidden">
<p>the column name for the VERSION field</p>
<p>the column name for the version field</p>
</div>
@@ -2159,19 +2161,19 @@ PropelException.<br />
<td class="name"><code>
<a href="source-class-Thelia.Model.om.BaseMessagePeer.html#70-71" title="Go to source code"><b>VERSION_CREATED_AT</b></a>
</code></td>
<td class="value"><code><span class="php-quote">'message.VERSION_CREATED_AT'</span></code></td>
<td class="value"><code><span class="php-quote">'message.version_created_at'</span></code></td>
<td class="description"><div>
<a href="#VERSION_CREATED_AT" class="anchor">#</a>
<div class="description short">
<p>the column name for the VERSION_CREATED_AT field</p>
<p>the column name for the version_created_at field</p>
</div>
<div class="description detailed hidden">
<p>the column name for the VERSION_CREATED_AT field</p>
<p>the column name for the version_created_at field</p>
</div>
@@ -2183,19 +2185,19 @@ PropelException.<br />
<td class="name"><code>
<a href="source-class-Thelia.Model.om.BaseMessagePeer.html#73-74" title="Go to source code"><b>VERSION_CREATED_BY</b></a>
</code></td>
<td class="value"><code><span class="php-quote">'message.VERSION_CREATED_BY'</span></code></td>
<td class="value"><code><span class="php-quote">'message.version_created_by'</span></code></td>
<td class="description"><div>
<a href="#VERSION_CREATED_BY" class="anchor">#</a>
<div class="description short">
<p>the column name for the VERSION_CREATED_BY field</p>
<p>the column name for the version_created_by field</p>
</div>
<div class="description detailed hidden">
<p>the column name for the VERSION_CREATED_BY field</p>
<p>the column name for the version_created_by field</p>
</div>
@@ -2231,7 +2233,7 @@ PropelException.<br />
<td class="name"><code>
<a href="source-class-Thelia.Model.om.BaseMessagePeer.html#90-94" title="Go to source code"><b>DEFAULT_LOCALE</b></a>
</code></td>
<td class="value"><code><span class="php-quote">'en_EN'</span></code></td>
<td class="value"><code><span class="php-quote">'en_US'</span></code></td>
<td class="description"><div>
<a href="#DEFAULT_LOCALE" class="anchor">#</a>