Commit | Line | Data |
---|---|---|
787604ff TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
81621fee | 4 | | CiviCRM version 4.7 | |
787604ff | 5 | +--------------------------------------------------------------------+ |
3b8eef99 | 6 | | Copyright CiviCRM LLC (c) 2004-2017 | |
787604ff 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 | | |
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 | +--------------------------------------------------------------------+ | |
d25dd0ee | 26 | */ |
787604ff TO |
27 | |
28 | namespace Civi\API\Provider; | |
46bcf597 | 29 | |
787604ff TO |
30 | use Civi\API\Events; |
31 | use Symfony\Component\EventDispatcher\EventSubscriberInterface; | |
32 | ||
33 | /** | |
34 | * An API "provider" provides a means to execute API requests. | |
35 | */ | |
36 | interface ProviderInterface { | |
82376c19 TO |
37 | /** |
38 | * @param array $apiRequest | |
8882ff5c | 39 | * The full description of the API request. |
a6c01b45 CW |
40 | * @return array |
41 | * structured response data (per civicrm_api3_create_success) | |
82376c19 TO |
42 | * @see civicrm_api3_create_success |
43 | * @throws \API_Exception | |
44 | */ | |
8882ff5c | 45 | public function invoke($apiRequest); |
82376c19 TO |
46 | |
47 | /** | |
48 | * @param int $version | |
8882ff5c | 49 | * API version. |
82376c19 TO |
50 | * @return array<string> |
51 | */ | |
8882ff5c | 52 | public function getEntityNames($version); |
82376c19 TO |
53 | |
54 | /** | |
55 | * @param int $version | |
8882ff5c | 56 | * API version. |
82376c19 | 57 | * @param string $entity |
8882ff5c | 58 | * API entity. |
82376c19 TO |
59 | * @return array<string> |
60 | */ | |
8882ff5c | 61 | public function getActionNames($version, $entity); |
96025800 | 62 | |
8882ff5c | 63 | } |