CRM/Batch/BAO/EntityBatch.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 /**
  13  *
  14  * @package CRM
  15  * @copyright CiviCRM LLC https://civicrm.org/licensing
  16  */
  17 class CRM_Batch_BAO_EntityBatch extends CRM_Batch_DAO_EntityBatch {
  18
  19   /**
  20    * Create entity batch entry.
  21    *
  22    * @param array $params
  23    * @return CRM_Batch_DAO_EntityBatch
  24    */
  25   public static function create($params) {
  26     return self::writeRecord($params);
  27   }
  28
  29   /**
  30    * Remove entries from entity batch.
  31    * @param array|int $params
  32    * @return CRM_Batch_DAO_EntityBatch
  33    */
  34   public static function del($params) {
  35     if (!is_array($params)) {
  36       $params = ['id' => $params];
  37     }
  38     $entityBatch = new CRM_Batch_DAO_EntityBatch();
  39     $entityId = $params['id'] ?? NULL;
  40     CRM_Utils_Hook::pre('delete', 'EntityBatch', $entityId, $params);
  41     $entityBatch->copyValues($params);
  42     $entityBatch->delete();
  43     CRM_Utils_Hook::post('delete', 'EntityBatch', $entityBatch->id, $entityBatch);
  44     return $entityBatch;
  45   }
  46
  47 }