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\BaseCouponPeer | 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.BaseCouponPeer.html#17-807" title="Go to source code">core/lib/Thelia/Model/om/BaseCouponPeer.php</a><br />
<b>Located at</b> <a href="source-class-Thelia.Model.om.BaseCouponPeer.html#17-814" title="Go to source code">core/lib/Thelia/Model/om/BaseCouponPeer.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.BaseCouponPeer.html#395-403" title="Go to source code">clearInstancePool</a>( )</code>
<code><a href="source-class-Thelia.Model.om.BaseCouponPeer.html#395-410" 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.BaseCouponPeer.html#405-414" title="Go to source code">clearRelatedInstancePool</a>( )</code>
<code><a href="source-class-Thelia.Model.om.BaseCouponPeer.html#412-421" 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.BaseCouponPeer.html#416-434" 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.BaseCouponPeer.html#423-441" 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.BaseCouponPeer.html#436-449" 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.BaseCouponPeer.html#443-456" 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.BaseCouponPeer.html#451-482" 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.BaseCouponPeer.html#458-489" 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.BaseCouponPeer.html#483-508" 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.BaseCouponPeer.html#490-515" 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.BaseCouponPeer.html#510-520" title="Go to source code">getTableMap</a>( )</code>
<code><a href="source-class-Thelia.Model.om.BaseCouponPeer.html#517-527" 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.BaseCouponPeer.html#522-531" title="Go to source code">buildTableMap</a>( )</code>
<code><a href="source-class-Thelia.Model.om.BaseCouponPeer.html#529-538" 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.BaseCouponPeer.html#533-542" title="Go to source code">getOMClass</a>( )</code>
<code><a href="source-class-Thelia.Model.om.BaseCouponPeer.html#540-549" 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.BaseCouponPeer.html#544-585" 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.BaseCouponPeer.html#551-592" 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.BaseCouponPeer.html#587-624" 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.BaseCouponPeer.html#594-631" 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.BaseCouponPeer.html#626-656" 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.BaseCouponPeer.html#633-663" 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.BaseCouponPeer.html#658-715" 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.BaseCouponPeer.html#665-722" 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.BaseCouponPeer.html#717-752" title="Go to source code">doValidate</a>( <span><code><a href="class-Thelia.Model.Coupon.html">Thelia\Model\Coupon</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.BaseCouponPeer.html#724-759" title="Go to source code">doValidate</a>( <span><code><a href="class-Thelia.Model.Coupon.html">Thelia\Model\Coupon</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.BaseCouponPeer.html#754-778" 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.BaseCouponPeer.html#761-785" 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.BaseCouponPeer.html#780-805" 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.BaseCouponPeer.html#787-812" 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.BaseCouponPeer.html#48-49" title="Go to source code"><b>ID</b></a>
</code></td>
<td class="value"><code><span class="php-quote">'coupon.ID'</span></code></td>
<td class="value"><code><span class="php-quote">'coupon.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.BaseCouponPeer.html#51-52" title="Go to source code"><b>CODE</b></a>
</code></td>
<td class="value"><code><span class="php-quote">'coupon.CODE'</span></code></td>
<td class="value"><code><span class="php-quote">'coupon.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.BaseCouponPeer.html#54-55" title="Go to source code"><b>ACTION</b></a>
</code></td>
<td class="value"><code><span class="php-quote">'coupon.ACTION'</span></code></td>
<td class="value"><code><span class="php-quote">'coupon.action'</span></code></td>
<td class="description"><div>
<a href="#ACTION" class="anchor">#</a>
<div class="description short">
<p>the column name for the ACTION field</p>
<p>the column name for the action field</p>
</div>
<div class="description detailed hidden">
<p>the column name for the ACTION field</p>
<p>the column name for the action field</p>
</div>
@@ -1960,19 +1962,19 @@ PropelException.<br />
<td class="name"><code>
<a href="source-class-Thelia.Model.om.BaseCouponPeer.html#57-58" title="Go to source code"><b>VALUE</b></a>
</code></td>
<td class="value"><code><span class="php-quote">'coupon.VALUE'</span></code></td>
<td class="value"><code><span class="php-quote">'coupon.value'</span></code></td>
<td class="description"><div>
<a href="#VALUE" class="anchor">#</a>
<div class="description short">
<p>the column name for the VALUE field</p>
<p>the column name for the value field</p>
</div>
<div class="description detailed hidden">
<p>the column name for the VALUE field</p>
<p>the column name for the value field</p>
</div>
@@ -1984,19 +1986,19 @@ PropelException.<br />
<td class="name"><code>
<a href="source-class-Thelia.Model.om.BaseCouponPeer.html#60-61" title="Go to source code"><b>USED</b></a>
</code></td>
<td class="value"><code><span class="php-quote">'coupon.USED'</span></code></td>
<td class="value"><code><span class="php-quote">'coupon.used'</span></code></td>
<td class="description"><div>
<a href="#USED" class="anchor">#</a>
<div class="description short">
<p>the column name for the USED field</p>
<p>the column name for the used field</p>
</div>
<div class="description detailed hidden">
<p>the column name for the USED field</p>
<p>the column name for the used field</p>
</div>
@@ -2008,19 +2010,19 @@ PropelException.<br />
<td class="name"><code>
<a href="source-class-Thelia.Model.om.BaseCouponPeer.html#63-64" title="Go to source code"><b>AVAILABLE_SINCE</b></a>
</code></td>
<td class="value"><code><span class="php-quote">'coupon.AVAILABLE_SINCE'</span></code></td>
<td class="value"><code><span class="php-quote">'coupon.available_since'</span></code></td>
<td class="description"><div>
<a href="#AVAILABLE_SINCE" class="anchor">#</a>
<div class="description short">
<p>the column name for the AVAILABLE_SINCE field</p>
<p>the column name for the available_since field</p>
</div>
<div class="description detailed hidden">
<p>the column name for the AVAILABLE_SINCE field</p>
<p>the column name for the available_since field</p>
</div>
@@ -2032,19 +2034,19 @@ PropelException.<br />
<td class="name"><code>
<a href="source-class-Thelia.Model.om.BaseCouponPeer.html#66-67" title="Go to source code"><b>DATE_LIMIT</b></a>
</code></td>
<td class="value"><code><span class="php-quote">'coupon.DATE_LIMIT'</span></code></td>
<td class="value"><code><span class="php-quote">'coupon.date_limit'</span></code></td>
<td class="description"><div>
<a href="#DATE_LIMIT" class="anchor">#</a>
<div class="description short">
<p>the column name for the DATE_LIMIT field</p>
<p>the column name for the date_limit field</p>
</div>
<div class="description detailed hidden">
<p>the column name for the DATE_LIMIT field</p>
<p>the column name for the date_limit field</p>
</div>
@@ -2056,19 +2058,19 @@ PropelException.<br />
<td class="name"><code>
<a href="source-class-Thelia.Model.om.BaseCouponPeer.html#69-70" title="Go to source code"><b>ACTIVATE</b></a>
</code></td>
<td class="value"><code><span class="php-quote">'coupon.ACTIVATE'</span></code></td>
<td class="value"><code><span class="php-quote">'coupon.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>
@@ -2080,19 +2082,19 @@ PropelException.<br />
<td class="name"><code>
<a href="source-class-Thelia.Model.om.BaseCouponPeer.html#72-73" title="Go to source code"><b>CREATED_AT</b></a>
</code></td>
<td class="value"><code><span class="php-quote">'coupon.CREATED_AT'</span></code></td>
<td class="value"><code><span class="php-quote">'coupon.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>
@@ -2104,19 +2106,19 @@ PropelException.<br />
<td class="name"><code>
<a href="source-class-Thelia.Model.om.BaseCouponPeer.html#75-76" title="Go to source code"><b>UPDATED_AT</b></a>
</code></td>
<td class="value"><code><span class="php-quote">'coupon.UPDATED_AT'</span></code></td>
<td class="value"><code><span class="php-quote">'coupon.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>