crm.fsf.org/20131203/files/sites/all/modules-new/civicrm/CRM/Contact/BAO/SubscriptionHistory.php

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