Civi/Api4/Generic/Traits/SoftDeleteActionTrait.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | Copyright CiviCRM LLC. All rights reserved.                        |
   5  |                                                                    |
   6  | This work is published under the GNU AGPLv3 license with some      |
   7  | permitted exceptions and without any warranty. For full license    |
   8  | and copyright information, see https://civicrm.org/licensing       |
   9  +--------------------------------------------------------------------+
  10  */
  11
  12 namespace Civi\Api4\Generic\Traits;
  13
  14 /**
  15  * This trait is used by delete actions with a "move to trash" option.
  16  * @method $this setUseTrash(bool $useTrash) Pass FALSE to force delete and bypass trash
  17  * @method bool getUseTrash()
  18  */
  19 trait SoftDeleteActionTrait {
  20
  21   /**
  22    * Should $ENTITY be moved to the trash instead of permanently deleted?
  23    * @var bool
  24    */
  25   protected $useTrash = TRUE;
  26
  27 }