Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
7e9e8871 | 4 | | CiviCRM version 4.7 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
fa938177 | 6 | | Copyright CiviCRM LLC (c) 2004-2016 | |
6a488035 TO |
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 | | |
c73475ea | 12 | | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. | |
6a488035 TO |
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 | +--------------------------------------------------------------------+ | |
d25dd0ee | 26 | */ |
6a488035 TO |
27 | |
28 | /** | |
29 | * | |
30 | * @package CRM | |
fa938177 | 31 | * @copyright CiviCRM LLC (c) 2004-2016 |
6a488035 TO |
32 | * $Id$ |
33 | * | |
34 | */ | |
35 | ||
6a488035 TO |
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 | /** | |
fe482240 | 43 | * Provides information about the data source. |
6a488035 | 44 | * |
a6c01b45 | 45 | * @return array |
11749569 TO |
46 | * Description of this data source, including: |
47 | * - title: string, translated, required | |
48 | * - permissions: array, optional | |
49 | * | |
6a488035 TO |
50 | */ |
51 | abstract public function getInfo(); | |
52 | ||
53 | /** | |
fe482240 | 54 | * Set variables up before form is built. |
54957108 | 55 | * |
56 | * @param CRM_Core_Form $form | |
6a488035 TO |
57 | */ |
58 | abstract public function preProcess(&$form); | |
59 | ||
60 | /** | |
54957108 | 61 | * This is function is called by the form object to get the DataSource's form snippet. |
6a488035 | 62 | * |
54957108 | 63 | * It should add all fields necessary to get the data uploaded to the temporary table in the DB. |
6c8f6e67 | 64 | * |
54957108 | 65 | * @param CRM_Core_Form $form |
6a488035 TO |
66 | */ |
67 | abstract public function buildQuickForm(&$form); | |
68 | ||
69 | /** | |
fe482240 | 70 | * Process the form submission. |
54957108 | 71 | * |
72 | * @param array $params | |
73 | * @param string $db | |
74 | * @param CRM_Core_Form $form | |
6a488035 TO |
75 | */ |
76 | abstract public function postProcess(&$params, &$db, &$form); | |
96025800 | 77 | |
11749569 TO |
78 | /** |
79 | * Determine if the current user has access to this data source. | |
80 | * | |
81 | * @return bool | |
82 | */ | |
83 | public function checkPermission() { | |
84 | $info = $this->getInfo(); | |
85 | return empty($info['permissions']) || CRM_Core_Permission::check($info['permissions']); | |
86 | } | |
87 | ||
6a488035 | 88 | } |