3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2017 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2017
37 * This class defines the DataSource interface but must be subclassed to be
40 abstract class CRM_Import_DataSource
{
43 * Provides information about the data source.
46 * Description of this data source, including:
47 * - title: string, translated, required
48 * - permissions: array, optional
51 abstract public function getInfo();
54 * Set variables up before form is built.
56 * @param CRM_Core_Form $form
58 abstract public function preProcess(&$form);
61 * This is function is called by the form object to get the DataSource's form snippet.
63 * It should add all fields necessary to get the data uploaded to the temporary table in the DB.
65 * @param CRM_Core_Form $form
67 abstract public function buildQuickForm(&$form);
70 * Process the form submission.
72 * @param array $params
74 * @param CRM_Core_Form $form
76 abstract public function postProcess(&$params, &$db, &$form);
79 * Determine if the current user has access to this data source.
83 public function checkPermission() {
84 $info = $this->getInfo();
85 return empty($info['permissions']) || CRM_Core_Permission
::check($info['permissions']);