Civi/API/Provider/ProviderInterface.php

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