CRM/Member/BAO/MembershipLog.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 5                                                  |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2019                                |
   7  +--------------------------------------------------------------------+
   8  | This file is a part of CiviCRM.                                    |
   9  |                                                                    |
  10  | CiviCRM is free software; you can copy, modify, and distribute it  |
  11  | under the terms of the GNU Affero General Public License           |
  12  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  13  |                                                                    |
  14  | CiviCRM is distributed in the hope that it will be useful, but     |
  15  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  16  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  17  | See the GNU Affero General Public License for more details.        |
  18  |                                                                    |
  19  | You should have received a copy of the GNU Affero General Public   |
  20  | License and the CiviCRM Licensing Exception along                  |
  21  | with this program; if not, contact CiviCRM LLC                     |
  22  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  23  | GNU Affero General Public License or the licensing of CiviCRM,     |
  24  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  25  +--------------------------------------------------------------------+
  26  */
  27
  28 /**
  29  *
  30  * @package CRM
  31  * @copyright CiviCRM LLC (c) 2004-2019
  32  * $Id$
  33  *
  34  */
  35 class CRM_Member_BAO_MembershipLog extends CRM_Member_DAO_MembershipLog {
  36
  37   /**
  38    * Add the membership log record.
  39    *
  40    * @param array $params
  41    *   Properties of the log item.
  42    *
  43    * @return CRM_Member_DAO_MembershipLog|CRM_Core_Error
  44    */
  45   public static function add($params) {
  46     $membershipLog = new CRM_Member_DAO_MembershipLog();
  47     $membershipLog->copyValues($params);
  48     $membershipLog->save();
  49     $membershipLog->free();
  50
  51     return $membershipLog;
  52   }
  53
  54   /**
  55    * Delete membership log record.
  56    *
  57    * @param int $membershipID
  58    *
  59    * @return mixed
  60    */
  61   public static function del($membershipID) {
  62     $membershipLog = new CRM_Member_DAO_MembershipLog();
  63     $membershipLog->membership_id = $membershipID;
  64     return $membershipLog->delete();
  65   }
  66
  67   /**
  68    * Reset the modified ID to NULL for log items by the given contact ID.
  69    *
  70    * @param int $contactID
  71    */
  72   public static function resetModifiedID($contactID) {
  73     $query = "
  74 UPDATE civicrm_membership_log
  75    SET modified_id = null
  76  WHERE modified_id = %1";
  77
  78     $params = array(1 => array($contactID, 'Integer'));
  79     CRM_Core_DAO::executeQuery($query, $params);
  80   }
  81
  82 }