drupal-civicrm/sites/all/modules/civicrm/CRM/Import/DataSource.php

89 lines
3 KiB
PHP
Raw Normal View History

2018-01-14 15:10:16 +02:00
<?php
/*
+--------------------------------------------------------------------+
| CiviCRM version 4.7 |
+--------------------------------------------------------------------+
| Copyright CiviCRM LLC (c) 2004-2017 |
+--------------------------------------------------------------------+
| This file is a part of CiviCRM. |
| |
| CiviCRM is free software; you can copy, modify, and distribute it |
| under the terms of the GNU Affero General Public License |
| Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
| |
| CiviCRM is distributed in the hope that it will be useful, but |
| WITHOUT ANY WARRANTY; without even the implied warranty of |
| MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
| See the GNU Affero General Public License for more details. |
| |
| You should have received a copy of the GNU Affero General Public |
| License and the CiviCRM Licensing Exception along |
| with this program; if not, contact CiviCRM LLC |
| at info[AT]civicrm[DOT]org. If you have questions about the |
| GNU Affero General Public License or the licensing of CiviCRM, |
| see the CiviCRM license FAQ at http://civicrm.org/licensing |
+--------------------------------------------------------------------+
*/
/**
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2017
* $Id$
*
*/
/**
* This class defines the DataSource interface but must be subclassed to be
* useful.
*/
abstract class CRM_Import_DataSource {
/**
* Provides information about the data source.
*
* @return array
* Description of this data source, including:
* - title: string, translated, required
* - permissions: array, optional
*
*/
abstract public function getInfo();
/**
* Set variables up before form is built.
*
* @param CRM_Core_Form $form
*/
abstract public function preProcess(&$form);
/**
* This is function is called by the form object to get the DataSource's form snippet.
*
* It should add all fields necessary to get the data uploaded to the temporary table in the DB.
*
* @param CRM_Core_Form $form
*/
abstract public function buildQuickForm(&$form);
/**
* Process the form submission.
*
* @param array $params
* @param string $db
* @param CRM_Core_Form $form
*/
abstract public function postProcess(&$params, &$db, &$form);
/**
* Determine if the current user has access to this data source.
*
* @return bool
*/
public function checkPermission() {
$info = $this->getInfo();
return empty($info['permissions']) || CRM_Core_Permission::check($info['permissions']);
}
}