64 lines
2.4 KiB
PHP
64 lines
2.4 KiB
PHP
|
<?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 |
|
||
|
|
+--------------------------------------------------------------------+
|
||
|
|
*/
|
||
|
|
|
||
|
|
namespace Civi\API\Provider;
|
||
|
|
|
||
|
|
use Civi\API\Events;
|
||
|
|
use Symfony\Component\EventDispatcher\EventSubscriberInterface;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* An API "provider" provides a means to execute API requests.
|
||
|
|
*/
|
||
|
|
interface ProviderInterface {
|
||
|
|
/**
|
||
|
|
* @param array $apiRequest
|
||
|
|
* The full description of the API request.
|
||
|
|
* @return array
|
||
|
|
* structured response data (per civicrm_api3_create_success)
|
||
|
|
* @see civicrm_api3_create_success
|
||
|
|
* @throws \API_Exception
|
||
|
|
*/
|
||
|
|
public function invoke($apiRequest);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @param int $version
|
||
|
|
* API version.
|
||
|
|
* @return array<string>
|
||
|
|
*/
|
||
|
|
public function getEntityNames($version);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @param int $version
|
||
|
|
* API version.
|
||
|
|
* @param string $entity
|
||
|
|
* API entity.
|
||
|
|
* @return array<string>
|
||
|
|
*/
|
||
|
|
public function getActionNames($version, $entity);
|
||
|
|
|
||
|
|
}
|