From 1def2adae269a22ea286151cf9abbe0c93f44edc Mon Sep 17 00:00:00 2001 From: Philip Lehmann-Boehm Date: Mon, 27 Nov 2017 16:34:01 +0100 Subject: [PATCH] regenerated the documentation --- .../0.13.0/_sources/api/EntityDefinition.txt | 23 +++++++++- docs/html/0.13.0/_sources/api/MySQLData.txt | 20 +++++++++ .../_sources/manual/crudyamlreference.txt | 2 + .../0.13.0/_sources/manual/datastructures.txt | 1 + .../_sources/manual/extendedfeatures.txt | 19 ++++++++ docs/html/0.13.0/api/EntityDefinition.html | 42 +++++++++++++++++- docs/html/0.13.0/api/MySQLData.html | 37 +++++++++++++++ docs/html/0.13.0/genindex.html | 28 ++++++++++-- docs/html/0.13.0/index.html | 1 + .../html/0.13.0/manual/crudyamlreference.html | 2 + docs/html/0.13.0/manual/datastructures.html | 3 +- docs/html/0.13.0/manual/extendedfeatures.html | 16 +++++++ docs/html/0.13.0/objects.inv | Bin 1999 -> 2043 bytes docs/html/0.13.0/searchindex.js | 2 +- 14 files changed, 186 insertions(+), 10 deletions(-) diff --git a/docs/html/0.13.0/_sources/api/EntityDefinition.txt b/docs/html/0.13.0/_sources/api/EntityDefinition.txt index 86ee0da..93a5fa0 100644 --- a/docs/html/0.13.0/_sources/api/EntityDefinition.txt +++ b/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. diff --git a/docs/html/0.13.0/_sources/api/MySQLData.txt b/docs/html/0.13.0/_sources/api/MySQLData.txt index 3fffb4e..729aa07 100644 --- a/docs/html/0.13.0/_sources/api/MySQLData.txt +++ b/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} diff --git a/docs/html/0.13.0/_sources/manual/crudyamlreference.txt b/docs/html/0.13.0/_sources/manual/crudyamlreference.txt index d452258..ec235d9 100644 --- a/docs/html/0.13.0/_sources/manual/crudyamlreference.txt +++ b/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 diff --git a/docs/html/0.13.0/_sources/manual/datastructures.txt b/docs/html/0.13.0/_sources/manual/datastructures.txt index 9aaf501..fb52873 100644 --- a/docs/html/0.13.0/_sources/manual/datastructures.txt +++ b/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 `_ diff --git a/docs/html/0.13.0/_sources/manual/extendedfeatures.txt b/docs/html/0.13.0/_sources/manual/extendedfeatures.txt index 03fc1d2..420d1b7 100644 --- a/docs/html/0.13.0/_sources/manual/extendedfeatures.txt +++ b/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 ------------------------------------ diff --git a/docs/html/0.13.0/api/EntityDefinition.html b/docs/html/0.13.0/api/EntityDefinition.html index 61d5597..1ffebbe 100644 --- a/docs/html/0.13.0/api/EntityDefinition.html +++ b/docs/html/0.13.0/api/EntityDefinition.html @@ -277,6 +277,13 @@

CRUDlex\EntityDefinition +
+property hardDeletion
+

protected bool

+

Holds whether hard deletion is activated.

+
+
property navBarGroup
@@ -845,7 +852,7 @@

CRUDlex\EntityDefinition
setInitialSortAscending($initialSortAscending)
-

Sets the initial sort order.

+

Sets whether the initial sort order is ascending.

@@ -862,7 +869,7 @@

CRUDlex\EntityDefinition
isInitialSortAscending()
-

Gets the initial sort order.

+

Gets whether the initial sort order is ascending.

@@ -873,6 +880,37 @@

CRUDlex\EntityDefinition +
+setHardDeletion($hardDeletion)
+

Sets the hard deletion state.

+

+++ + + + +
Parameters:
    +
  • $hardDeletion (boolean) – the hard deletion state
    • +
+
+

+ +
+
+isHardDeletion()
+

Gets the hard deletion state.

+ +++ + + + +
Returns:boolean the hard deletion state
+
+
getNavBarGroup()
diff --git a/docs/html/0.13.0/api/MySQLData.html b/docs/html/0.13.0/api/MySQLData.html index 78d21d3..2035417 100644 --- a/docs/html/0.13.0/api/MySQLData.html +++ b/docs/html/0.13.0/api/MySQLData.html @@ -227,6 +227,26 @@

CRUDlex\MySQLData +
+addSoftDeletionToQuery(EntityDefinition $definition, QueryBuilder $queryBuilder, $fieldPrefix = '', $method = 'andWhere')
+

Adds the soft deletion parameters if activated.

+ +++ + + + +
Parameters:
    +
  • $definition (EntityDefinition) – the entity definition which might have soft deletion activated
    • +
  • $queryBuilder (QueryBuilder) – the query builder to add the deletion condition to
    • +
  • $fieldPrefix (string) – the prefix to add before the deleted_at field like an table alias
    • +
  • $method (string) – the method to use of the query builder, “where” or “andWhere”
    • +
+
+

+
setValuesAndParameters(Entity $entity, QueryBuilder $queryBuilder, $setMethod)
@@ -267,6 +287,23 @@

CRUDlex\MySQLData +
+deleteManyToManyReferences(Entity $entity)
+

Deletes any many to many references pointing to the given entity.

+ +++ + + + +
Parameters:
    +
  • $entity (Entity) – the referenced entity
    • +
+
+

+
doDelete(Entity $entity, $deleteCascade)
diff --git a/docs/html/0.13.0/genindex.html b/docs/html/0.13.0/genindex.html index 0c35dc4..8d99c7d 100644 --- a/docs/html/0.13.0/genindex.html +++ b/docs/html/0.13.0/genindex.html @@ -242,12 +242,12 @@

A

AbstractData::DELETION_SUCCESS (class constant)
-
-
addChild() (EntityDefinition method)
+
+
addFilter() (MySQLData method)
@@ -257,6 +257,10 @@

A

+
addSoftDeletionToQuery() (MySQLData method) +
+ +
addSort() (MySQLData method)
@@ -442,8 +446,6 @@

D

deleteCascade (EntityDefinition property)
-
-
deleteChildren() (AbstractData method)
@@ -454,6 +456,8 @@

D

+ +
deleteFile() (ControllerProvider method)
@@ -469,6 +473,10 @@

D

+
deleteManyToManyReferences() (MySQLData method) +
+ +
doCreate() (AbstractData method)
@@ -901,6 +909,10 @@

H

+
hardDeletion (EntityDefinition property) +
+ +
hasChildren() (MySQLData method)
@@ -967,6 +979,10 @@

I

+
isHardDeletion() (EntityDefinition method) +
+ +
isInitialSortAscending() (EntityDefinition method)
@@ -1195,6 +1211,10 @@

S

+
setHardDeletion() (EntityDefinition method) +
+ +
setInitialSortAscending() (EntityDefinition method)
diff --git a/docs/html/0.13.0/index.html b/docs/html/0.13.0/index.html index ad49339..76da044 100644 --- a/docs/html/0.13.0/index.html +++ b/docs/html/0.13.0/index.html @@ -243,6 +243,7 @@

Welcome to CRUDlex’s documentation!Displayed Fields in the List
  • Pagination
  • Filters
    • +
  • Hard Deletion
  • Group entities in the Navigation Bar
  • I18n
    • Set the Translations of Entity- and Field-Labels
      • diff --git a/docs/html/0.13.0/manual/crudyamlreference.html b/docs/html/0.13.0/manual/crudyamlreference.html index 4ae975e..1e88d3e 100644 --- a/docs/html/0.13.0/manual/crudyamlreference.html +++ b/docs/html/0.13.0/manual/crudyamlreference.html @@ -254,6 +254,8 @@

      CRUD YAML Reference# 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 diff --git a/docs/html/0.13.0/manual/datastructures.html b/docs/html/0.13.0/manual/datastructures.html index a0d7735..2e8ba8c 100644 --- a/docs/html/0.13.0/manual/datastructures.html +++ b/docs/html/0.13.0/manual/datastructures.html @@ -238,7 +238,8 @@

      Fieldssample diff --git a/docs/html/0.13.0/manual/extendedfeatures.html b/docs/html/0.13.0/manual/extendedfeatures.html index f90c79f..988e9ae 100644 --- a/docs/html/0.13.0/manual/extendedfeatures.html +++ b/docs/html/0.13.0/manual/extendedfeatures.html @@ -100,6 +100,7 @@
    • Displayed Fields in the List
    • Pagination
    • Filters
      • +
    • Hard Deletion
    • Group entities in the Navigation Bar
    • I18n
      • Set the Translations of Entity- and Field-Labels
        • @@ -309,6 +310,21 @@

        Filters +

        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:

        +
        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

        Each entity represents and option in the navigation bar at the top. If there are diff --git a/docs/html/0.13.0/objects.inv b/docs/html/0.13.0/objects.inv index 8aa03adc2e62e95639d8b35f254b18aff893f02a..07f23531ec7531ffbb16cb9677ca3c2dcfdcfbbc 100644 GIT binary patch delta 1939 zcmV;E2W5+^nH$D?7*Se}C;5QXxOzbahx7`q&n@ z*-)%O*4w-NgB|rzHllOo#2&Tl{8 zqMCd>eYkJg-I-)C_<&(WD$;g`(jy_5j~w2h5!G7qAJD53@-&A3r}WM)%`M zHe6)iv!{921%I^SB7!uVk0+DGG#h2p?CBvJ#zAMV4-eUF76i#@Q;9FzR=WXFQ0yaS zfCR*7vrR1mE5}emXyu*up&%t@Pz5sRL&WQ2I*e&QeXVhD-B2--7g;5U*#01*cm#nC ztJ|Bl1`#YAo?C_xM0T_eA@UJrn-PH$ha<*#PM^>Q9)D3C%#hZ68`+F0tUylY9LAxL z0&&%jS?GWkTg-wdWl6Y@Q<4z~Y<=UkA|9x6%w-Aeh0!;HfnE8w>moM!V6beYIeD!o z@)Qvw!XlAwp=3c6p(LF>%&R6?2T`4`0G z%9cO#B!4wLQE70R3ah{>9;iaR)wZ+asc33Q_0X7)dWd*;a1ZfUQv85y;_N2hkO@WA@fpAAe%mc_)ke)HQWKUly}&wTu!tR^d>5 zv1oS~tkHQTlSmsPS_<33LW^vQ-rdXBv~JWI_)gFiel@^7n#g_LN6`7U2G{ZzuYNt~ z#{y=l9M$}EZ*w)So{)(;Bsd9ALwUPx7ved>5Jg(WH)eH=(LxagVz`YLjO)!2)P6$c zjDIq5&vWT5NwrP|Y{xAM)}0YW5!#qIddSM7 zkX(i}KV!$emVxDr{2SLt9M~Jl;cR0R%o3==a+$QFpP<_XTE@))2M6W`LKwFPNO6?B zfc$6MIqC?3$HAlzG@oe&f-Y@;3^S8EHGegJ3E%f<-J&UzgPDs)rFu90DMAniaKe_2 zb?zkwn5OS1=WZqnW!PhSVxBI%L=5ZY)V4=~nq{f>NXe$d6cB!{%59>)pK1J06t7vT z5IoIHogW-f6veV7aDxE=dS2gj2*IG)bI@iY#OCvg$fOtZj6y!G1Q|CvwL}zllSgySoRXc@=Pl@Op~E;#yKF&$$|Z1>n!V+ch04~YY&mzvL}4hL4TFEClR6u zk=D{cQ?_}of-ARW67;J(1NnoI@XqV9jC|U!QmV}6_3WuZv^#QZ7ugU5BBiEoHxS|N z7kBw~_HClg{5?F;6jr`K{#hb^byVLcGcM>Jq25vVh|CtCN7!(9eH{-y>vPK|_G9#B z5&kIay} z=b|#?SKFngBtI9G`Tog8t*p?Ts(%mJtlXPq%**c64a45sn2T-Kxo2U!a9V=ww>Y)o ztjiT~7&KqR3PgTX^ATl1Em=baDg#;BW`C^+kl0QJdc~&H^(_#UMx7v3(jX2IK~9KAt^1?aM1n>Op$mhNn)Gyyiybo_W( zz$|qMG+iLQ@tgz1Ef#VB*|J5=oWlw+?=`NA*yK*T4qv2k|6v2^4&P7T>*BdlxSK6k zqwKC|+Lsh~o2i^|W(1$wy@-h8<^5l)Z3Ty3E4Dm%q}{D0arq(Xka>g%vH^r0(o zRZ*-#Hrtzz2RrJ6Y(xn=I0wY?;#AWAwky5p3p}F@T-~j>U?>-3B+zwJG^4ykoL}Ew zqlSDwe)!R{n-j@s^a;b7)THYUrAI=rA#!+wTJRw0nv}q|TtF2fA7`^{IemJ3o!m`l z+4wd4mOU=}E`Ojk7ZIezaypy6&a+82&mQlyaU68xP<OZtc^cz-}mFhg4NZDcd%um(AqbC`xg z3dB`A7NG-LY%vR-lqKOpPDw@}u=VYr6>(3MV=hZz&y2ni4D7b+O>qLDN!0;LEqC*l-*1~5^^;2 z;Zsd{hl%tOlx^jf4cHpxJ%Q}M^$=Y_JLbds>VHElJMU<5AG@ah=ksFLt(H*&hblaZ zzrJ=m4A$zrl1Zcu5iNynVWCAfNALdS8``vL4SXYL4nJGq1DeQ(ypN#EZ3DjL&tCm< z&<_R7QaP&m@!sZQTn9pC>X6_lJPqaTwq1zl2tyQU9p9MsAw~;Dbe~YUpiJEHTsk>Y zZ+}t&yY7yH^+!8Vgf5hg?&o7Q-5ZAGZ&3Y^=|sje-H+6!j?^S?j;78rtfE` zZYBz4*cuMRJf3-p7}oQ#ZI1%At5R)kl1+y>ApBI9+eCf8(D3@bZ ztsmh@{0L9yM|c`P!V~%t$x3WCcq-4t6I*_s#8~rqW4$|-bDqQO$~i&%J8#`VkF|}y zHP}xsT_S&c^qY9pxjUJs%-R3@k{+Gh&llzBy zi7_+BN7_)ML39XPUW6%mLE92%zkeWa%{`|_xaOj9rX0;X=h3_u#CBNk1MoOT@xkn_ zy7f02gE8~AH1B47INfRRefMHWu06h_X^_f;Bw)FgtA?R2u>L|dE;V@xN6)l^{WKXH zXPgJZoI2+gTW6VD-aD7>COSlJ%Pkn94ywG{@QWfu+DHRUS@l#0S8ls!cYmvU1Nohi z@XqUVaE7#BB^;T}>&a7tXm_&JEwV8PL`qHFejviTFaGlF;_sO@FLwV#Q&{-|`Dcar z#fi8}W?aw?q25tDL}m-%5Vjm%UZ&%L_4#Gn4r4g;Y&~(N3|qV0Y6k66gt6%Wz$uj5 zI#MHjJnj^$J^fIbF^AY8Gk@fy`KSze!*;1DdCf;`;5&OayE zhtmi95xnL~5tdmO||m zTa%}qYFpa0mv|baw5M9zPz|IHajGsIpezAuK$d)@0K%u=$MvxPGQ2VJT;(opOT^T{xpPUO|}tHYXA` zJI`c`Ma5D+lEGszYJbFI^=7X)jFX^O6y||&PU_9svnVWsjdZ9GHG?d7lm3v814;M& zjhQLrYOhpwQVDb5jdV6}X$m!k?1(<`isnp8ibO0Vt|49GSG{S`22|)C4*FOSnqR^4;=R=5XKM*D&Yl~E zUcrSw%otV-M)bcY1L*^DBkUhkl`2O}6XYBo>58j=9YA>j`;+ja@W!RI2Cgo#N`O@r g>(8%UYH3e!m}