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