3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.4 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2013 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
28 namespace Civi\API\Provider
;
30 use Symfony\Component\EventDispatcher\EventSubscriberInterface
;
33 * This class defines operations for inspecting the API's metadata.
35 class ReflectionProvider
implements EventSubscriberInterface
, ProviderInterface
{
36 public static function getSubscribedEvents() {
38 Events
::RESOLVE
=> array(
39 array('onApiResolve', Events
::W_EARLY
), // TODO decide if we really want to override others
41 Events
::AUTHORIZE
=> array(
42 array('onApiAuthorize', Events
::W_EARLY
), // TODO decide if we really want to override others
48 * @var \Civi\API\Kernel
53 * @var array (string $entityName => array(string $actionName))
58 * @param \Civi\API\Kernel $apiKernel
60 public function __construct($apiKernel) {
61 $this->apiKernel
= $apiKernel;
62 $this->actions
= array(
63 'Entity' => array('get', 'getactions'),
64 '*' => array('getactions'), // 'getfields'
68 public function onApiResolve(\Civi\API\Event\ResolveEvent
$event) {
69 $apiRequest = $event->getApiRequest();
70 $actions = isset($this->actions
[$apiRequest['entity']]) ?
$this->actions
[$apiRequest['entity']] : $this->actions
['*'];
71 if (in_array($apiRequest['action'], $actions)) {
72 $apiRequest['is_metadata'] = TRUE;
73 $event->setApiRequest($apiRequest);
74 $event->setApiProvider($this);
75 $event->stopPropagation(); // TODO decide if we really want to override others
79 public function onApiAuthorize(\Civi\API\Event\AuthorizeEvent
$event) {
80 $apiRequest = $event->getApiRequest();
81 if (isset($apiRequest['is_metadata'])) {
82 // if (\CRM_Core_Permission::check('access AJAX API') || \CRM_Core_Permission::check('access CiviCRM')) {
84 $event->stopPropagation();
92 public function invoke($apiRequest) {
93 if ($apiRequest['entity'] == 'Entity' && $apiRequest['action'] == 'get') {
94 return civicrm_api3_create_success($this->apiKernel
->getEntityNames($apiRequest['version']));
96 switch ($apiRequest['action']) {
98 return civicrm_api3_create_success($this->apiKernel
->getActionNames($apiRequest['version'], $apiRequest['entity']));
100 // return $this->doGetFields($apiRequest);
104 // We shouldn't get here because onApiResolve() checks $this->actions
105 throw new \
API_Exception("Unsupported action (" . $apiRequest['entity'] . '.' . $apiRequest['action'] . ']');
111 function getEntityNames($version) {
112 return array('Entity');
118 function getActionNames($version, $entity) {
119 return isset($this->actions
[$entity]) ?
$this->actions
[$entity] : $this->actions
['*'];