| 1 | <?php |
| 2 | /* |
| 3 | +--------------------------------------------------------------------+ |
| 4 | | CiviCRM version 5 | |
| 5 | +--------------------------------------------------------------------+ |
| 6 | | Copyright CiviCRM LLC (c) 2004-2019 | |
| 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 | namespace Civi\API\Provider; |
| 29 | |
| 30 | /** |
| 31 | * An API "provider" provides a means to execute API requests. |
| 32 | */ |
| 33 | interface ProviderInterface { |
| 34 | |
| 35 | /** |
| 36 | * @param array $apiRequest |
| 37 | * The full description of the API request. |
| 38 | * @return array |
| 39 | * structured response data (per civicrm_api3_create_success) |
| 40 | * @see civicrm_api3_create_success |
| 41 | * @throws \API_Exception |
| 42 | */ |
| 43 | public function invoke($apiRequest); |
| 44 | |
| 45 | /** |
| 46 | * @param int $version |
| 47 | * API version. |
| 48 | * @return array<string> |
| 49 | */ |
| 50 | public function getEntityNames($version); |
| 51 | |
| 52 | /** |
| 53 | * @param int $version |
| 54 | * API version. |
| 55 | * @param string $entity |
| 56 | * API entity. |
| 57 | * @return array<string> |
| 58 | */ |
| 59 | public function getActionNames($version, $entity); |
| 60 | |
| 61 | } |