CRM/Member/BAO/MembershipLog.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_Member_BAO_MembershipLog extends CRM_Member_DAO_MembershipLog {
  18
  19   /**
  20    * Add the membership log record.
  21    *
  22    * @param array $params
  23    *   Properties of the log item.
  24    *
  25    * @return CRM_Member_DAO_MembershipLog|CRM_Core_Error
  26    */
  27   public static function add($params) {
  28     $membershipLog = new CRM_Member_DAO_MembershipLog();
  29     $membershipLog->copyValues($params);
  30     $membershipLog->save();
  31
  32     return $membershipLog;
  33   }
  34
  35   /**
  36    * Delete membership log record.
  37    *
  38    * @param int $membershipID
  39    *
  40    * @return mixed
  41    */
  42   public static function del($membershipID) {
  43     $membershipLog = new CRM_Member_DAO_MembershipLog();
  44     $membershipLog->membership_id = $membershipID;
  45     return $membershipLog->delete();
  46   }
  47
  48   /**
  49    * Reset the modified ID to NULL for log items by the given contact ID.
  50    *
  51    * @param int $contactID
  52    */
  53   public static function resetModifiedID($contactID) {
  54     $query = "
  55 UPDATE civicrm_membership_log
  56    SET modified_id = null
  57  WHERE modified_id = %1";
  58
  59     $params = [1 => [$contactID, 'Integer']];
  60     CRM_Core_DAO::executeQuery($query, $params);
  61   }
  62
  63 }