Merge remote-tracking branch 'upstream/4.6' into 4.6-master-2015-07-13-12-30-17

[civicrm-core.git] / Civi / API / Provider / ProviderInterface.php

diff --git a/Civi/API/Provider/ProviderInterface.php b/Civi/API/Provider/ProviderInterface.php
index 31034c70ca6cf27d5c720e51ce2322c622c996de..31d17d521415143b333d5a2c96b181cb40fa6905 100644 (file)
--- a/Civi/API/Provider/ProviderInterface.php
+++ b/Civi/API/Provider/ProviderInterface.php
@@ -3,7 +3,7 @@
  +--------------------------------------------------------------------+
  | CiviCRM version 4.6                                                |
  +--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2014                                |
+ | Copyright CiviCRM LLC (c) 2004-2015                                |
  +--------------------------------------------------------------------+
  | This file is a part of CiviCRM.                                    |
  |                                                                    |
@@ -23,9 +23,10 @@
  | 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;
 
@@ -35,22 +36,28 @@ use Symfony\Component\EventDispatcher\EventSubscriberInterface;
 interface ProviderInterface {
   /**
    * @param array $apiRequest
-   * @return array structured response data (per civicrm_api3_create_success)
+   *   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
    */
-  function invoke($apiRequest);
+  public function invoke($apiRequest);
 
   /**
    * @param int $version
+   *   API version.
    * @return array<string>
    */
-  function getEntityNames($version);
+  public function getEntityNames($version);
 
   /**
    * @param int $version
+   *   API version.
    * @param string $entity
+   *   API entity.
    * @return array<string>
    */
-  function getActionNames($version, $entity);
-}
\ No newline at end of file
+  public function getActionNames($version, $entity);
+
+}