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\BaseModulePeer | 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.BaseModulePeer.html#18-799" title="Go to source code">core/lib/Thelia/Model/om/BaseModulePeer.php</a><br />
<b>Located at</b> <a href="source-class-Thelia.Model.om.BaseModulePeer.html#18-806" title="Go to source code">core/lib/Thelia/Model/om/BaseModulePeer.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.BaseModulePeer.html#388-396" title="Go to source code">clearInstancePool</a>( )</code>
<code><a href="source-class-Thelia.Model.om.BaseModulePeer.html#388-403" 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.BaseModulePeer.html#398-410" title="Go to source code">clearRelatedInstancePool</a>( )</code>
<code><a href="source-class-Thelia.Model.om.BaseModulePeer.html#405-417" 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.BaseModulePeer.html#412-430" 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.BaseModulePeer.html#419-437" 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.BaseModulePeer.html#432-445" 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.BaseModulePeer.html#439-452" 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.BaseModulePeer.html#447-478" 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.BaseModulePeer.html#454-485" 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.BaseModulePeer.html#479-504" 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.BaseModulePeer.html#486-511" 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.BaseModulePeer.html#506-516" title="Go to source code">getTableMap</a>( )</code>
<code><a href="source-class-Thelia.Model.om.BaseModulePeer.html#513-523" 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.BaseModulePeer.html#518-527" title="Go to source code">buildTableMap</a>( )</code>
<code><a href="source-class-Thelia.Model.om.BaseModulePeer.html#525-534" 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.BaseModulePeer.html#529-538" title="Go to source code">getOMClass</a>( )</code>
<code><a href="source-class-Thelia.Model.om.BaseModulePeer.html#536-545" 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.BaseModulePeer.html#540-577" 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.BaseModulePeer.html#547-584" 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.BaseModulePeer.html#579-616" 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.BaseModulePeer.html#586-623" 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.BaseModulePeer.html#618-648" 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.BaseModulePeer.html#625-655" 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.BaseModulePeer.html#650-707" 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.BaseModulePeer.html#657-714" 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.BaseModulePeer.html#709-744" title="Go to source code">doValidate</a>( <span><code><a href="class-Thelia.Model.Module.html">Thelia\Model\Module</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.BaseModulePeer.html#716-751" title="Go to source code">doValidate</a>( <span><code><a href="class-Thelia.Model.Module.html">Thelia\Model\Module</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.BaseModulePeer.html#746-770" 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.BaseModulePeer.html#753-777" 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.BaseModulePeer.html#772-797" 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.BaseModulePeer.html#779-804" 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">
@@ -1888,19 +1890,19 @@ PropelException.<br />
<td class="name"><code>
<a href="source-class-Thelia.Model.om.BaseModulePeer.html#49-50" title="Go to source code"><b>ID</b></a>
</code></td>
<td class="value"><code><span class="php-quote">'module.ID'</span></code></td>
<td class="value"><code><span class="php-quote">'module.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>
@@ -1912,19 +1914,19 @@ PropelException.<br />
<td class="name"><code>
<a href="source-class-Thelia.Model.om.BaseModulePeer.html#52-53" title="Go to source code"><b>CODE</b></a>
</code></td>
<td class="value"><code><span class="php-quote">'module.CODE'</span></code></td>
<td class="value"><code><span class="php-quote">'module.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>
@@ -1936,19 +1938,19 @@ PropelException.<br />
<td class="name"><code>
<a href="source-class-Thelia.Model.om.BaseModulePeer.html#55-56" title="Go to source code"><b>TYPE</b></a>
</code></td>
<td class="value"><code><span class="php-quote">'module. TYPE'</span></code></td>
<td class="value"><code><span class="php-quote">'module. type'</span></code></td>
<td class="description"><div>
<a href="#TYPE" class="anchor">#</a>
<div class="description short">
<p>the column name for the TYPE field</p>
<p>the column name for the type field</p>
</div>
<div class="description detailed hidden">
<p>the column name for the TYPE field</p>
<p>the column name for the type field</p>
</div>
@@ -1960,19 +1962,19 @@ PropelException.<br />
<td class="name"><code>
<a href="source-class-Thelia.Model.om.BaseModulePeer.html#58-59" title="Go to source code"><b>ACTIVATE</b></a>
</code></td>
<td class="value"><code><span class="php-quote">'module.ACTIVATE'</span></code></td>
<td class="value"><code><span class="php-quote">'module.activate'</span></code></td>
<td class="description"><div>
<a href="#ACTIVATE" class="anchor">#</a>
<div class="description short">
<p>the column name for the ACTIVATE field</p>
<p>the column name for the activate field</p>
</div>
<div class="description detailed hidden">
<p>the column name for the ACTIVATE field</p>
<p>the column name for the activate field</p>
</div>
@@ -1984,19 +1986,19 @@ PropelException.<br />
<td class="name"><code>
<a href="source-class-Thelia.Model.om.BaseModulePeer.html#61-62" title="Go to source code"><b>POSITION</b></a>
</code></td>
<td class="value"><code><span class="php-quote">'module.POSITION'</span></code></td>
<td class="value"><code><span class="php-quote">'module.position'</span></code></td>
<td class="description"><div>
<a href="#POSITION" class="anchor">#</a>
<div class="description short">
<p>the column name for the POSITION field</p>
<p>the column name for the position field</p>
</div>
<div class="description detailed hidden">
<p>the column name for the POSITION field</p>
<p>the column name for the position field</p>
</div>
@@ -2008,19 +2010,19 @@ PropelException.<br />
<td class="name"><code>
<a href="source-class-Thelia.Model.om.BaseModulePeer.html#64-65" title="Go to source code"><b>CREATED_AT</b></a>
</code></td>
<td class="value"><code><span class="php-quote">'module.CREATED_AT'</span></code></td>
<td class="value"><code><span class="php-quote">'module.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>
@@ -2032,19 +2034,19 @@ PropelException.<br />
<td class="name"><code>
<a href="source-class-Thelia.Model.om.BaseModulePeer.html#67-68" title="Go to source code"><b>UPDATED_AT</b></a>
</code></td>
<td class="value"><code><span class="php-quote">'module.UPDATED_AT'</span></code></td>
<td class="value"><code><span class="php-quote">'module.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>
@@ -2080,7 +2082,7 @@ PropelException.<br />
<td class="name"><code>
<a href="source-class-Thelia.Model.om.BaseModulePeer.html#84-88" 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>