crm.fsf.org/20131203/files/sites/all/modules-old/civicrm/CRM/Import/DataSource.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  * 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
  46    *   Description of this data source, including:
  47    *   - title: string, translated, required
  48    *   - permissions: array, optional
  49    *
  50    */
  51   abstract public function getInfo();
  52
  53   /**
  54    * Set variables up before form is built.
  55    */
  56   abstract public function preProcess(&$form);
  57
  58   /**
  59    * This is function is called by the form object to get the DataSource's
  60    * form snippet. It should add all fields necesarry to get the data
  61    * uploaded to the temporary table in the DB.
  62    *
  63    * @param CRM_Core_Form $form
  64    *
  65    * @return void
  66    *   (operates directly on form argument)
  67    */
  68   abstract public function buildQuickForm(&$form);
  69
  70   /**
  71    * Process the form submission.
  72    */
  73   abstract public function postProcess(&$params, &$db, &$form);
  74
  75   /**
  76    * Determine if the current user has access to this data source.
  77    *
  78    * @return bool
  79    */
  80   public function checkPermission() {
  81     $info = $this->getInfo();
  82     return empty($info['permissions']) || CRM_Core_Permission::check($info['permissions']);
  83   }
  84
  85 }