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\BaseCouponRulePeer | 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 @@
<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.BaseCouponRulePeer.html#17-1027" title="Go to source code">core/lib/Thelia/Model/om/BaseCouponRulePeer.php</a><br />
<b>Located at</b> <a href="source-class-Thelia.Model.om.BaseCouponRulePeer.html#17-1034" title="Go to source code">core/lib/Thelia/Model/om/BaseCouponRulePeer.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.BaseCouponRulePeer.html#380-388" title="Go to source code">clearInstancePool</a>( )</code>
<code><a href="source-class-Thelia.Model.om.BaseCouponRulePeer.html#380-395" 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.BaseCouponRulePeer.html#390-396" title="Go to source code">clearRelatedInstancePool</a>( )</code>
<code><a href="source-class-Thelia.Model.om.BaseCouponRulePeer.html#397-403" title="Go to source code">clearRelatedInstancePool</a>( )</code>
<div class="description short">
@@ -1064,7 +1066,7 @@ by a 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.BaseCouponRulePeer.html#398-416" 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.BaseCouponRulePeer.html#405-423" 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.BaseCouponRulePeer.html#418-431" 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.BaseCouponRulePeer.html#425-438" 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.BaseCouponRulePeer.html#433-464" 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.BaseCouponRulePeer.html#440-471" 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.BaseCouponRulePeer.html#465-490" 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.BaseCouponRulePeer.html#472-497" 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="#_doCountJoinCoupon">#</a>
<code><a href="source-class-Thelia.Model.om.BaseCouponRulePeer.html#493-541" title="Go to source code">doCountJoinCoupon</a>( <span>Criteria <var>$criteria</var></span>, <span>boolean <var>$distinct</var> = <span class="php-keyword1">false</span></span>, <span>PropelPDO <var>$con</var> = <span class="php-keyword1">null</span></span>, <span>String <var>$join_behavior</var> = Thelia\Model\om\Criteria::LEFT_JOIN</span> )</code>
<code><a href="source-class-Thelia.Model.om.BaseCouponRulePeer.html#500-548" title="Go to source code">doCountJoinCoupon</a>( <span>Criteria <var>$criteria</var></span>, <span>boolean <var>$distinct</var> = <span class="php-keyword1">false</span></span>, <span>PropelPDO <var>$con</var> = <span class="php-keyword1">null</span></span>, <span>String <var>$join_behavior</var> = Thelia\Model\om\Criteria::LEFT_JOIN</span> )</code>
<div class="description short">
@@ -1307,7 +1309,7 @@ Criteria-&gt;setDistinct() instead.</dd>
<td class="name"><div>
<a class="anchor" href="#_doSelectJoinCoupon">#</a>
<code><a href="source-class-Thelia.Model.om.BaseCouponRulePeer.html#544-608" title="Go to source code">doSelectJoinCoupon</a>( <span>Criteria <var>$criteria</var></span>, <span>PropelPDO <var>$con</var> = <span class="php-keyword1">null</span></span>, <span>String <var>$join_behavior</var> = Thelia\Model\om\Criteria::LEFT_JOIN</span> )</code>
<code><a href="source-class-Thelia.Model.om.BaseCouponRulePeer.html#551-615" title="Go to source code">doSelectJoinCoupon</a>( <span>Criteria <var>$criteria</var></span>, <span>PropelPDO <var>$con</var> = <span class="php-keyword1">null</span></span>, <span>String <var>$join_behavior</var> = Thelia\Model\om\Criteria::LEFT_JOIN</span> )</code>
<div class="description short">
@@ -1360,7 +1362,7 @@ PropelException.<br />
<td class="name"><div>
<a class="anchor" href="#_doCountJoinAll">#</a>
<code><a href="source-class-Thelia.Model.om.BaseCouponRulePeer.html#611-659" title="Go to source code">doCountJoinAll</a>( <span>Criteria <var>$criteria</var></span>, <span>boolean <var>$distinct</var> = <span class="php-keyword1">false</span></span>, <span>PropelPDO <var>$con</var> = <span class="php-keyword1">null</span></span>, <span>String <var>$join_behavior</var> = Thelia\Model\om\Criteria::LEFT_JOIN</span> )</code>
<code><a href="source-class-Thelia.Model.om.BaseCouponRulePeer.html#618-666" title="Go to source code">doCountJoinAll</a>( <span>Criteria <var>$criteria</var></span>, <span>boolean <var>$distinct</var> = <span class="php-keyword1">false</span></span>, <span>PropelPDO <var>$con</var> = <span class="php-keyword1">null</span></span>, <span>String <var>$join_behavior</var> = Thelia\Model\om\Criteria::LEFT_JOIN</span> )</code>
<div class="description short">
@@ -1409,7 +1411,7 @@ Criteria-&gt;setDistinct() instead.</dd>
<td class="name"><div>
<a class="anchor" href="#_doSelectJoinAll">#</a>
<code><a href="source-class-Thelia.Model.om.BaseCouponRulePeer.html#661-728" title="Go to source code">doSelectJoinAll</a>( <span>Criteria <var>$criteria</var></span>, <span>PropelPDO <var>$con</var> = <span class="php-keyword1">null</span></span>, <span>String <var>$join_behavior</var> = Thelia\Model\om\Criteria::LEFT_JOIN</span> )</code>
<code><a href="source-class-Thelia.Model.om.BaseCouponRulePeer.html#668-735" title="Go to source code">doSelectJoinAll</a>( <span>Criteria <var>$criteria</var></span>, <span>PropelPDO <var>$con</var> = <span class="php-keyword1">null</span></span>, <span>String <var>$join_behavior</var> = Thelia\Model\om\Criteria::LEFT_JOIN</span> )</code>
<div class="description short">
@@ -1462,7 +1464,7 @@ PropelException.<br />
<td class="name"><div>
<a class="anchor" href="#_getTableMap">#</a>
<code><a href="source-class-Thelia.Model.om.BaseCouponRulePeer.html#730-740" title="Go to source code">getTableMap</a>( )</code>
<code><a href="source-class-Thelia.Model.om.BaseCouponRulePeer.html#737-747" title="Go to source code">getTableMap</a>( )</code>
<div class="description short">
@@ -1506,7 +1508,7 @@ PropelException.<br />
<td class="name"><div>
<a class="anchor" href="#_buildTableMap">#</a>
<code><a href="source-class-Thelia.Model.om.BaseCouponRulePeer.html#742-751" title="Go to source code">buildTableMap</a>( )</code>
<code><a href="source-class-Thelia.Model.om.BaseCouponRulePeer.html#749-758" title="Go to source code">buildTableMap</a>( )</code>
<div class="description short">
@@ -1539,7 +1541,7 @@ PropelException.<br />
<td class="name"><div>
<a class="anchor" href="#_getOMClass">#</a>
<code><a href="source-class-Thelia.Model.om.BaseCouponRulePeer.html#753-762" title="Go to source code">getOMClass</a>( )</code>
<code><a href="source-class-Thelia.Model.om.BaseCouponRulePeer.html#760-769" 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">
@@ -1576,7 +1578,7 @@ PropelException.<br />
<td class="name"><div>
<a class="anchor" href="#_doInsert">#</a>
<code><a href="source-class-Thelia.Model.om.BaseCouponRulePeer.html#764-805" 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.BaseCouponRulePeer.html#771-812" 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">
@@ -1628,7 +1630,7 @@ PropelException.<br />
<td class="name"><div>
<a class="anchor" href="#_doUpdate">#</a>
<code><a href="source-class-Thelia.Model.om.BaseCouponRulePeer.html#807-844" 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.BaseCouponRulePeer.html#814-851" 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">
@@ -1681,7 +1683,7 @@ PropelException.<br />
<td class="name"><div>
<a class="anchor" href="#_doDeleteAll">#</a>
<code><a href="source-class-Thelia.Model.om.BaseCouponRulePeer.html#846-876" 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.BaseCouponRulePeer.html#853-883" title="Go to source code">doDeleteAll</a>( <span>PropelPDO <var>$con</var> = <span class="php-keyword1">null</span></span> )</code>
<div class="description short">
@@ -1727,7 +1729,7 @@ PropelException.<br />
<td class="name"><div>
<a class="anchor" href="#_doDelete">#</a>
<code><a href="source-class-Thelia.Model.om.BaseCouponRulePeer.html#878-935" 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.BaseCouponRulePeer.html#885-942" 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">
@@ -1781,7 +1783,7 @@ PropelException.<br />
<td class="name"><div>
<a class="anchor" href="#_doValidate">#</a>
<code><a href="source-class-Thelia.Model.om.BaseCouponRulePeer.html#937-972" title="Go to source code">doValidate</a>( <span><code><a href="class-Thelia.Model.CouponRule.html">Thelia\Model\CouponRule</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.BaseCouponRulePeer.html#944-979" title="Go to source code">doValidate</a>( <span><code><a href="class-Thelia.Model.CouponRule.html">Thelia\Model\CouponRule</a></code> <var>$obj</var></span>, <span>mixed <var>$cols</var> = <span class="php-keyword1">null</span></span> )</code>
<div class="description short">
@@ -1831,7 +1833,7 @@ those columns are validated.</p>
<td class="name"><div>
<a class="anchor" href="#_retrieveByPK">#</a>
<code><a href="source-class-Thelia.Model.om.BaseCouponRulePeer.html#974-998" 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.BaseCouponRulePeer.html#981-1005" 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">
@@ -1875,7 +1877,7 @@ those columns are validated.</p>
<td class="name"><div>
<a class="anchor" href="#_retrieveByPKs">#</a>
<code><a href="source-class-Thelia.Model.om.BaseCouponRulePeer.html#1000-1025" 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.BaseCouponRulePeer.html#1007-1032" 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">
@@ -2098,19 +2100,19 @@ PropelException.<br />
<td class="name"><code>
<a href="source-class-Thelia.Model.om.BaseCouponRulePeer.html#48-49" title="Go to source code"><b>ID</b></a>
</code></td>
<td class="value"><code><span class="php-quote">'coupon_rule.ID'</span></code></td>
<td class="value"><code><span class="php-quote">'coupon_rule.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>
@@ -2122,19 +2124,19 @@ PropelException.<br />
<td class="name"><code>
<a href="source-class-Thelia.Model.om.BaseCouponRulePeer.html#51-52" title="Go to source code"><b>COUPON_ID</b></a>
</code></td>
<td class="value"><code><span class="php-quote">'coupon_rule.COUPON_ID'</span></code></td>
<td class="value"><code><span class="php-quote">'coupon_rule.coupon_id'</span></code></td>
<td class="description"><div>
<a href="#COUPON_ID" class="anchor">#</a>
<div class="description short">
<p>the column name for the COUPON_ID field</p>
<p>the column name for the coupon_id field</p>
</div>
<div class="description detailed hidden">
<p>the column name for the COUPON_ID field</p>
<p>the column name for the coupon_id field</p>
</div>
@@ -2146,19 +2148,19 @@ PropelException.<br />
<td class="name"><code>
<a href="source-class-Thelia.Model.om.BaseCouponRulePeer.html#54-55" title="Go to source code"><b>CONTROLLER</b></a>
</code></td>
<td class="value"><code><span class="php-quote">'coupon_rule.CONTROLLER'</span></code></td>
<td class="value"><code><span class="php-quote">'coupon_rule.controller'</span></code></td>
<td class="description"><div>
<a href="#CONTROLLER" class="anchor">#</a>
<div class="description short">
<p>the column name for the CONTROLLER field</p>
<p>the column name for the controller field</p>
</div>
<div class="description detailed hidden">
<p>the column name for the CONTROLLER field</p>
<p>the column name for the controller field</p>
</div>
@@ -2170,19 +2172,19 @@ PropelException.<br />
<td class="name"><code>
<a href="source-class-Thelia.Model.om.BaseCouponRulePeer.html#57-58" title="Go to source code"><b>OPERATION</b></a>
</code></td>
<td class="value"><code><span class="php-quote">'coupon_rule.OPERATION'</span></code></td>
<td class="value"><code><span class="php-quote">'coupon_rule.operation'</span></code></td>
<td class="description"><div>
<a href="#OPERATION" class="anchor">#</a>
<div class="description short">
<p>the column name for the OPERATION field</p>
<p>the column name for the operation field</p>
</div>
<div class="description detailed hidden">
<p>the column name for the OPERATION field</p>
<p>the column name for the operation field</p>
</div>
@@ -2194,19 +2196,19 @@ PropelException.<br />
<td class="name"><code>
<a href="source-class-Thelia.Model.om.BaseCouponRulePeer.html#60-61" title="Go to source code"><b>VALUE</b></a>
</code></td>
<td class="value"><code><span class="php-quote">'coupon_rule.VALUE'</span></code></td>
<td class="value"><code><span class="php-quote">'coupon_rule.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>
@@ -2218,19 +2220,19 @@ PropelException.<br />
<td class="name"><code>
<a href="source-class-Thelia.Model.om.BaseCouponRulePeer.html#63-64" title="Go to source code"><b>CREATED_AT</b></a>
</code></td>
<td class="value"><code><span class="php-quote">'coupon_rule.CREATED_AT'</span></code></td>
<td class="value"><code><span class="php-quote">'coupon_rule.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>
@@ -2242,19 +2244,19 @@ PropelException.<br />
<td class="name"><code>
<a href="source-class-Thelia.Model.om.BaseCouponRulePeer.html#66-67" title="Go to source code"><b>UPDATED_AT</b></a>
</code></td>
<td class="value"><code><span class="php-quote">'coupon_rule.UPDATED_AT'</span></code></td>
<td class="value"><code><span class="php-quote">'coupon_rule.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>