CRM/Contact/BAO/SubscriptionHistory.php

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