CRM/Import/DataSource.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.4                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2013                                |
   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 2009.                                       |
  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-2013
  32  * $Id$
  33  *
  34  */
  35
  36 /**
  37  * This class defines the DataSource interface but must be subclassed to be
  38  * useful.
  39  */
  40 abstract class CRM_Import_DataSource {
  41
  42   /**
  43    * Provides information about the data source
  44    *
  45    * @return array collection of info about this data source
  46    *
  47    * @access public
  48    *
  49    */
  50   abstract public function getInfo();
  51
  52   /**
  53    * Function to set variables up before form is built
  54    *
  55    * @access public
  56    */
  57   abstract public function preProcess(&$form);
  58
  59   /**
  60    * This is function is called by the form object to get the DataSource's
  61    * form snippet. It should add all fields necesarry to get the data
  62    * uploaded to the temporary table in the DB.
  63    *
  64    * @return void (operates directly on form argument)
  65    * @access public
  66    */
  67   abstract public function buildQuickForm(&$form);
  68
  69   /**
  70    * Function to process the form
  71    *
  72    * @access public
  73    */
  74   abstract public function postProcess(&$params, &$db, &$form);
  75 }
  76