CRM/Contact/BAO/SubscriptionHistory.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
  18 /**
  19  * BAO object for crm_email table.
  20  */
  21 class CRM_Contact_BAO_SubscriptionHistory extends CRM_Contact_DAO_SubscriptionHistory {
  22
  23   /**
  24    * Create a new subscription history record.
  25    *
  26    * @param array $params
  27    *   Values for the new history record.
  28    *
  29    * @return object
  30    *   $history  The new history object
  31    */
  32   public static function create($params) {
  33     $history = new CRM_Contact_BAO_SubscriptionHistory();
  34     $history->date = date('Ymd');
  35     $history->copyValues($params);
  36     $history->save();
  37     return $history;
  38   }
  39
  40   /**
  41    * Erase a contact's subscription history records.
  42    *
  43    * @param int $id
  44    *   The contact id.
  45    */
  46   public static function deleteContact($id) {
  47     $history = new CRM_Contact_BAO_SubscriptionHistory();
  48     $history->contact_id = $id;
  49     $history->delete();
  50   }
  51
  52 }