regenerated the documentation

docs/html/0.13.0/_sources/api/EntityDefinition.txt

@@ -102,6 +102,12 @@ CRUDlex\\EntityDefinition
 
         Holds the initial sort order.
 
+    .. php:attr:: hardDeletion
+
+        protected bool
+
+        Holds whether hard deletion is activated.
+
     .. php:attr:: navBarGroup
 
         protected string
@@ -367,17 +373,30 @@ CRUDlex\\EntityDefinition
 
     .. php:method:: setInitialSortAscending($initialSortAscending)
 
-        Sets the initial sort order.
+        Sets whether the initial sort order is ascending.
 
         :type $initialSortAscending: boolean
         :param $initialSortAscending: the initial sort order, true if ascending
 
     .. php:method:: isInitialSortAscending()
 
-        Gets the initial sort order.
+        Gets whether the initial sort order is ascending.
 
         :returns: boolean the initial sort order, true if ascending
 
+    .. php:method:: setHardDeletion($hardDeletion)
+
+        Sets the hard deletion state.
+
+        :type $hardDeletion: boolean
+        :param $hardDeletion: the hard deletion state
+
+    .. php:method:: isHardDeletion()
+
+        Gets the hard deletion state.
+
+        :returns: boolean the hard deletion state
+
     .. php:method:: getNavBarGroup()
 
         Gets the navigation bar group where the entity belongs.

docs/html/0.13.0/_sources/api/MySQLData.txt

@@ -50,6 +50,19 @@ CRUDlex\\MySQLData
 
         Holds the events.
 
+    .. php:method:: addSoftDeletionToQuery(EntityDefinition $definition, QueryBuilder $queryBuilder, $fieldPrefix = '', $method = 'andWhere')
+
+        Adds the soft deletion parameters if activated.
+
+        :type $definition: EntityDefinition
+        :param $definition: the entity definition which might have soft deletion activated
+        :type $queryBuilder: QueryBuilder
+        :param $queryBuilder: the query builder to add the deletion condition to
+        :type $fieldPrefix: string
+        :param $fieldPrefix: the prefix to add before the deleted_at field like an table alias
+        :type $method: string
+        :param $method: the method to use of the query builder, "where" or "andWhere"
+
     .. php:method:: setValuesAndParameters(Entity $entity, QueryBuilder $queryBuilder, $setMethod)
 
         Sets the values and parameters of the upcoming given query according
@@ -70,6 +83,13 @@ CRUDlex\\MySQLData
         :param $id: the current entities id
         :returns: boolean true if the entity still has children
 
+    .. php:method:: deleteManyToManyReferences(Entity $entity)
+
+        Deletes any many to many references pointing to the given entity.
+
+        :type $entity: Entity
+        :param $entity: the referenced entity
+
     .. php:method:: doDelete(Entity $entity, $deleteCascade)
 
         {@inheritdoc}

docs/html/0.13.0/_sources/manual/crudyamlreference.txt

@@ -95,6 +95,8 @@ required, along with the default value or behaviour.
       # the label which should be displayed if the "de" is selected as language
       label_de: Bücher
       table: book
+      # database entries will be hard deleted for this entry
+      hardDeletion: true
       fields:
         title:
           type: text

docs/html/0.13.0/_sources/manual/datastructures.txt

@@ -83,6 +83,7 @@ more fields per table:
   updated
 * deleted_at datetime DEFAULT NULL: defines when this entry was deleted in UTC.
   CRUDlex uses a soft delete mechanism hiding all rows where this is not null
+  (only if hard deletion is not activated)
 * version int(11) NOT NULL: used for optimistic locking
 
 See the CRUDlexSample.sql in the `sample <https://github.com/philiplb/CRUDlexSample>`_

docs/html/0.13.0/_sources/manual/extendedfeatures.txt

@@ -138,6 +138,25 @@ Currently, the listview contains all entries on the pages. Often, it is desirabl
                 type: integer
                 label: Pages
 
+-------------
+Hard Deletion
+-------------
+
+By default, CRUDlex uses a soft deletion mechanism by only setting a deleted_at field. Hard deletion from the database
+can be activated though via the "hardDeletion" flag like this:
+
+.. code-block:: yaml
+
+    library:
+        table: library
+        hardDeletion: true
+        fields:
+            name:
+                type: text
+                label: Name
+
+If activated, the column "deleted_at" is not needed in the entities table.
+
 ------------------------------------
 Group entities in the Navigation Bar
 ------------------------------------

docs/html/0.13.0/api/EntityDefinition.html

@@ -277,6 +277,13 @@ <h1>CRUDlex\EntityDefinition<a class="headerlink" href="#crudlex-entitydefinitio
 <p>Holds the initial sort order.</p>
 </dd></dl>
 
+<dl class="attr">
+<dt id="EntityDefinition::$hardDeletion">
+<em class="property">property </em><code class="descname">hardDeletion</code><a class="headerlink" href="#EntityDefinition::$hardDeletion" title="Permalink to this definition">¶</a></dt>
+<dd><p>protected bool</p>
+<p>Holds whether hard deletion is activated.</p>
+</dd></dl>
+
 <dl class="attr">
 <dt id="EntityDefinition::$navBarGroup">
 <em class="property">property </em><code class="descname">navBarGroup</code><a class="headerlink" href="#EntityDefinition::$navBarGroup" title="Permalink to this definition">¶</a></dt>
@@ -845,7 +852,7 @@ <h1>CRUDlex\EntityDefinition<a class="headerlink" href="#crudlex-entitydefinitio
 <dl class="method">
 <dt id="EntityDefinition::setInitialSortAscending">
 <code class="descname">setInitialSortAscending</code><span class="sig-paren">(</span><em>$initialSortAscending</em><span class="sig-paren">)</span><a class="headerlink" href="#EntityDefinition::setInitialSortAscending" title="Permalink to this definition">¶</a></dt>
-<dd><p>Sets the initial sort order.</p>
+<dd><p>Sets whether the initial sort order is ascending.</p>
 <table class="docutils field-list" frame="void" rules="none">
 <col class="field-name" />
 <col class="field-body" />
@@ -862,7 +869,7 @@ <h1>CRUDlex\EntityDefinition<a class="headerlink" href="#crudlex-entitydefinitio
 <dl class="method">
 <dt id="EntityDefinition::isInitialSortAscending">
 <code class="descname">isInitialSortAscending</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#EntityDefinition::isInitialSortAscending" title="Permalink to this definition">¶</a></dt>
-<dd><p>Gets the initial sort order.</p>
+<dd><p>Gets whether the initial sort order is ascending.</p>
 <table class="docutils field-list" frame="void" rules="none">
 <col class="field-name" />
 <col class="field-body" />
@@ -873,6 +880,37 @@ <h1>CRUDlex\EntityDefinition<a class="headerlink" href="#crudlex-entitydefinitio
 </table>
 </dd></dl>
 
+<dl class="method">
+<dt id="EntityDefinition::setHardDeletion">
+<code class="descname">setHardDeletion</code><span class="sig-paren">(</span><em>$hardDeletion</em><span class="sig-paren">)</span><a class="headerlink" href="#EntityDefinition::setHardDeletion" title="Permalink to this definition">¶</a></dt>
+<dd><p>Sets the hard deletion state.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
+<li><strong>$hardDeletion</strong> (<em>boolean</em>) &#8211; the hard deletion state</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="method">
+<dt id="EntityDefinition::isHardDeletion">
+<code class="descname">isHardDeletion</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#EntityDefinition::isHardDeletion" title="Permalink to this definition">¶</a></dt>
+<dd><p>Gets the hard deletion state.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">boolean the hard deletion state</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
 <dl class="method">
 <dt id="EntityDefinition::getNavBarGroup">
 <code class="descname">getNavBarGroup</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#EntityDefinition::getNavBarGroup" title="Permalink to this definition">¶</a></dt>

docs/html/0.13.0/api/MySQLData.html

@@ -227,6 +227,26 @@ <h1>CRUDlex\MySQLData<a class="headerlink" href="#crudlex-mysqldata" title="Perm
 <p>Holds the events.</p>
 </dd></dl>
 
+<dl class="method">
+<dt id="MySQLData::addSoftDeletionToQuery">
+<code class="descname">addSoftDeletionToQuery</code><span class="sig-paren">(</span><em>EntityDefinition $definition</em>, <em>QueryBuilder $queryBuilder</em>, <em>$fieldPrefix = ''</em>, <em>$method = 'andWhere'</em><span class="sig-paren">)</span><a class="headerlink" href="#MySQLData::addSoftDeletionToQuery" title="Permalink to this definition">¶</a></dt>
+<dd><p>Adds the soft deletion parameters if activated.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
+<li><strong>$definition</strong> (<a class="reference internal" href="EntityDefinition.html#EntityDefinition" title="EntityDefinition"><em>EntityDefinition</em></a>) &#8211; the entity definition which might have soft deletion activated</li>
+<li><strong>$queryBuilder</strong> (<em>QueryBuilder</em>) &#8211; the query builder to add the deletion condition to</li>
+<li><strong>$fieldPrefix</strong> (<em>string</em>) &#8211; the prefix to add before the deleted_at field like an table alias</li>
+<li><strong>$method</strong> (<em>string</em>) &#8211; the method to use of the query builder, &#8220;where&#8221; or &#8220;andWhere&#8221;</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
 <dl class="method">
 <dt id="MySQLData::setValuesAndParameters">
 <code class="descname">setValuesAndParameters</code><span class="sig-paren">(</span><em>Entity $entity</em>, <em>QueryBuilder $queryBuilder</em>, <em>$setMethod</em><span class="sig-paren">)</span><a class="headerlink" href="#MySQLData::setValuesAndParameters" title="Permalink to this definition">¶</a></dt>
@@ -267,6 +287,23 @@ <h1>CRUDlex\MySQLData<a class="headerlink" href="#crudlex-mysqldata" title="Perm
 </table>
 </dd></dl>
 
+<dl class="method">
+<dt id="MySQLData::deleteManyToManyReferences">
+<code class="descname">deleteManyToManyReferences</code><span class="sig-paren">(</span><em>Entity $entity</em><span class="sig-paren">)</span><a class="headerlink" href="#MySQLData::deleteManyToManyReferences" title="Permalink to this definition">¶</a></dt>
+<dd><p>Deletes any many to many references pointing to the given entity.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
+<li><strong>$entity</strong> (<a class="reference internal" href="Entity.html#Entity" title="Entity"><em>Entity</em></a>) &#8211; the referenced entity</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
 <dl class="method">
 <dt id="MySQLData::doDelete">
 <code class="descname">doDelete</code><span class="sig-paren">(</span><em>Entity $entity</em>, <em>$deleteCascade</em><span class="sig-paren">)</span><a class="headerlink" href="#MySQLData::doDelete" title="Permalink to this definition">¶</a></dt>

docs/html/0.13.0/genindex.html

@@ -242,12 +242,12 @@ <h2 id="A">A</h2>
   <dt><a href="api/AbstractData.html#AbstractData::DELETION_SUCCESS"><strong>AbstractData::DELETION_SUCCESS (class constant)</strong></a>
   </dt>
 
-  </dl></td>
-  <td style="width: 33%" valign="top"><dl>
 
   <dt><a href="api/EntityDefinition.html#EntityDefinition::addChild"><strong>addChild() (EntityDefinition method)</strong></a>
   </dt>
 
+  </dl></td>
+  <td style="width: 33%" valign="top"><dl>
 
   <dt><a href="api/MySQLData.html#MySQLData::addFilter"><strong>addFilter() (MySQLData method)</strong></a>
   </dt>
@@ -257,6 +257,10 @@ <h2 id="A">A</h2>
   </dt>
 
 
+  <dt><a href="api/MySQLData.html#MySQLData::addSoftDeletionToQuery"><strong>addSoftDeletionToQuery() (MySQLData method)</strong></a>
+  </dt>
+
+
   <dt><a href="api/MySQLData.html#MySQLData::addSort"><strong>addSort() (MySQLData method)</strong></a>
   </dt>
 
@@ -442,8 +446,6 @@ <h2 id="D">D</h2>
   <dt><a href="api/EntityDefinition.html#EntityDefinition::$deleteCascade"><strong>deleteCascade (EntityDefinition property)</strong></a>
   </dt>
 
-  </dl></td>
-  <td style="width: 33%" valign="top"><dl>
 
   <dt><a href="api/AbstractData.html#AbstractData::deleteChildren"><strong>deleteChildren() (AbstractData method)</strong></a>
   </dt>
@@ -454,6 +456,8 @@ <h2 id="D">D</h2>
   </dt>
 
       </dl></dd>
+  </dl></td>
+  <td style="width: 33%" valign="top"><dl>
 
   <dt><a href="api/ControllerProvider.html#ControllerProvider::deleteFile"><strong>deleteFile() (ControllerProvider method)</strong></a>
   </dt>
@@ -469,6 +473,10 @@ <h2 id="D">D</h2>
   </dt>
 
 
+  <dt><a href="api/MySQLData.html#MySQLData::deleteManyToManyReferences"><strong>deleteManyToManyReferences() (MySQLData method)</strong></a>
+  </dt>
+
+
   <dt><a href="api/AbstractData.html#AbstractData::doCreate"><strong>doCreate() (AbstractData method)</strong></a>
   </dt>
 
@@ -901,6 +909,10 @@ <h2 id="H">H</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%" valign="top"><dl>
 
+  <dt><a href="api/EntityDefinition.html#EntityDefinition::$hardDeletion"><strong>hardDeletion (EntityDefinition property)</strong></a>
+  </dt>
+
+
   <dt><a href="api/MySQLData.html#MySQLData::hasChildren"><strong>hasChildren() (MySQLData method)</strong></a>
   </dt>
 
@@ -967,6 +979,10 @@ <h2 id="I">I</h2>
   </dt>
 
 
+  <dt><a href="api/EntityDefinition.html#EntityDefinition::isHardDeletion"><strong>isHardDeletion() (EntityDefinition method)</strong></a>
+  </dt>
+
+
   <dt><a href="api/EntityDefinition.html#EntityDefinition::isInitialSortAscending"><strong>isInitialSortAscending() (EntityDefinition method)</strong></a>
   </dt>
 
@@ -1195,6 +1211,10 @@ <h2 id="S">S</h2>
   </dt>
 
 
+  <dt><a href="api/EntityDefinition.html#EntityDefinition::setHardDeletion"><strong>setHardDeletion() (EntityDefinition method)</strong></a>
+  </dt>
+
+
   <dt><a href="api/EntityDefinition.html#EntityDefinition::setInitialSortAscending"><strong>setInitialSortAscending() (EntityDefinition method)</strong></a>
   </dt>
 

docs/html/0.13.0/index.html

@@ -243,6 +243,7 @@ <h1>Welcome to CRUDlex&#8217;s documentation!<a class="headerlink" href="#welcom
 <li class="toctree-l2"><a class="reference internal" href="manual/extendedfeatures.html#displayed-fields-in-the-list">Displayed Fields in the List</a></li>
 <li class="toctree-l2"><a class="reference internal" href="manual/extendedfeatures.html#pagination">Pagination</a></li>
 <li class="toctree-l2"><a class="reference internal" href="manual/extendedfeatures.html#filters">Filters</a></li>
+<li class="toctree-l2"><a class="reference internal" href="manual/extendedfeatures.html#hard-deletion">Hard Deletion</a></li>
 <li class="toctree-l2"><a class="reference internal" href="manual/extendedfeatures.html#group-entities-in-the-navigation-bar">Group entities in the Navigation Bar</a></li>
 <li class="toctree-l2"><a class="reference internal" href="manual/extendedfeatures.html#i18n">I18n</a><ul>
 <li class="toctree-l3"><a class="reference internal" href="manual/extendedfeatures.html#set-the-translations-of-entity-and-field-labels">Set the Translations of Entity- and Field-Labels</a></li>

docs/html/0.13.0/manual/crudyamlreference.html

@@ -254,6 +254,8 @@ <h1>CRUD YAML Reference<a class="headerlink" href="#crud-yaml-reference" title="
   <span class="c1"># the label which should be displayed if the &quot;de&quot; is selected as language</span>
   <span class="l l-Scalar l-Scalar-Plain">label_de</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">Bücher</span>
   <span class="l l-Scalar l-Scalar-Plain">table</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">book</span>
+  <span class="c1"># database entries will be hard deleted for this entry</span>
+  <span class="l l-Scalar l-Scalar-Plain">hardDeletion</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">true</span>
   <span class="l l-Scalar l-Scalar-Plain">fields</span><span class="p p-Indicator">:</span>
     <span class="l l-Scalar l-Scalar-Plain">title</span><span class="p p-Indicator">:</span>
       <span class="l l-Scalar l-Scalar-Plain">type</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">text</span>

docs/html/0.13.0/manual/datastructures.html

@@ -238,7 +238,8 @@ <h2>Fields<a class="headerlink" href="#fields" title="Permalink to this headline
 <li>updated_at datetime NOT NULL: a timestamp in UTC when the row was the last time
 updated</li>
 <li>deleted_at datetime DEFAULT NULL: defines when this entry was deleted in UTC.
-CRUDlex uses a soft delete mechanism hiding all rows where this is not null</li>
+CRUDlex uses a soft delete mechanism hiding all rows where this is not null
+(only if hard deletion is not activated)</li>
 <li>version int(11) NOT NULL: used for optimistic locking</li>
 </ul>
 <p>See the CRUDlexSample.sql in the <a class="reference external" href="https://github.com/philiplb/CRUDlexSample">sample</a>

docs/html/0.13.0/manual/extendedfeatures.html

@@ -100,6 +100,7 @@
 <li class="toctree-l2"><a class="reference internal" href="#displayed-fields-in-the-list">Displayed Fields in the List</a></li>
 <li class="toctree-l2"><a class="reference internal" href="#pagination">Pagination</a></li>
 <li class="toctree-l2"><a class="reference internal" href="#filters">Filters</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#hard-deletion">Hard Deletion</a></li>
 <li class="toctree-l2"><a class="reference internal" href="#group-entities-in-the-navigation-bar">Group entities in the Navigation Bar</a></li>
 <li class="toctree-l2"><a class="reference internal" href="#i18n">I18n</a><ul>
 <li class="toctree-l3"><a class="reference internal" href="#set-the-translations-of-entity-and-field-labels">Set the Translations of Entity- and Field-Labels</a></li>
@@ -309,6 +310,21 @@ <h2>Filters<a class="headerlink" href="#filters" title="Permalink to this headli
 </pre></div>
 </div>
 </div>
+<div class="section" id="hard-deletion">
+<h2>Hard Deletion<a class="headerlink" href="#hard-deletion" title="Permalink to this headline">¶</a></h2>
+<p>By default, CRUDlex uses a soft deletion mechanism by only setting a deleted_at field. Hard deletion from the database
+can be activated though via the &#8220;hardDeletion&#8221; flag like this:</p>
+<div class="highlight-yaml"><div class="highlight"><pre><span></span><span class="l l-Scalar l-Scalar-Plain">library</span><span class="p p-Indicator">:</span>
+    <span class="l l-Scalar l-Scalar-Plain">table</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">library</span>
+    <span class="l l-Scalar l-Scalar-Plain">hardDeletion</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">true</span>
+    <span class="l l-Scalar l-Scalar-Plain">fields</span><span class="p p-Indicator">:</span>
+        <span class="l l-Scalar l-Scalar-Plain">name</span><span class="p p-Indicator">:</span>
+            <span class="l l-Scalar l-Scalar-Plain">type</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">text</span>
+            <span class="l l-Scalar l-Scalar-Plain">label</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">Name</span>
+</pre></div>
+</div>
+<p>If activated, the column &#8220;deleted_at&#8221; is not needed in the entities table.</p>
+</div>
 <div class="section" id="group-entities-in-the-navigation-bar">
 <h2>Group entities in the Navigation Bar<a class="headerlink" href="#group-entities-in-the-navigation-bar" title="Permalink to this headline">¶</a></h2>
 <p>Each entity represents and option in the navigation bar at the top. If there are