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    * Class constructor.
  25    */
  26   public function __construct() {
  27     parent::__construct();
  28   }
  29
  30   /**
  31    * Create a new subscription history record.
  32    *
  33    * @param array $params
  34    *   Values for the new history record.
  35    *
  36    * @return object
  37    *   $history  The new history object
  38    */
  39   public static function &create(&$params) {
  40     $history = new CRM_Contact_BAO_SubscriptionHistory();
  41     $history->date = date('Ymd');
  42     $history->copyValues($params);
  43     $history->save();
  44     return $history;
  45   }
  46
  47   /**
  48    * Erase a contact's subscription history records.
  49    *
  50    * @param int $id
  51    *   The contact id.
  52    */
  53   public static function deleteContact($id) {
  54     $history = new CRM_Contact_BAO_SubscriptionHistory();
  55     $history->contact_id = $id;
  56     $history->delete();
  57   }
  58
  59 }