CRM/Contact/BAO/SubscriptionHistory.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 5                                                  |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2020                                |
   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-2020
  32  */
  33
  34 /**
  35  * BAO object for crm_email table.
  36  */
  37 class CRM_Contact_BAO_SubscriptionHistory extends CRM_Contact_DAO_SubscriptionHistory {
  38
  39   /**
  40    * Class constructor.
  41    */
  42   public function __construct() {
  43     parent::__construct();
  44   }
  45
  46   /**
  47    * Create a new subscription history record.
  48    *
  49    * @param array $params
  50    *   Values for the new history record.
  51    *
  52    * @return object
  53    *   $history  The new history object
  54    */
  55   public static function &create(&$params) {
  56     $history = new CRM_Contact_BAO_SubscriptionHistory();
  57     $history->date = date('Ymd');
  58     $history->copyValues($params);
  59     $history->save();
  60     return $history;
  61   }
  62
  63   /**
  64    * Erase a contact's subscription history records.
  65    *
  66    * @param int $id
  67    *   The contact id.
  68    */
  69   public static function deleteContact($id) {
  70     $history = new CRM_Contact_BAO_SubscriptionHistory();
  71     $history->contact_id = $id;
  72     $history->delete();
  73   }
  74
  75 }