3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2015 |
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
;
31 use Symfony\Component\EventDispatcher\EventSubscriberInterface
;
34 * This class defines operations for inspecting the API's metadata.
36 class ReflectionProvider
implements EventSubscriberInterface
, ProviderInterface
{
40 public static function getSubscribedEvents() {
42 Events
::RESOLVE
=> array(
43 // TODO decide if we really want to override others
44 array('onApiResolve', Events
::W_EARLY
),
46 Events
::AUTHORIZE
=> array(
47 // TODO decide if we really want to override others
48 array('onApiAuthorize', Events
::W_EARLY
),
54 * @var \Civi\API\Kernel
59 * @var array (string $entityName => array(string $actionName))
64 * @param \Civi\API\Kernel $apiKernel
67 public function __construct($apiKernel) {
68 $this->apiKernel
= $apiKernel;
69 $this->actions
= array(
70 'Entity' => array('get', 'getactions'),
71 '*' => array('getactions'), // 'getfields'
76 * @param \Civi\API\Event\ResolveEvent $event
77 * API resolution event.
79 public function onApiResolve(\Civi\API\Event\ResolveEvent
$event) {
80 $apiRequest = $event->getApiRequest();
81 $actions = $this->getActionNames($apiRequest['version'], $apiRequest['entity']);
82 if (in_array($apiRequest['action'], $actions)) {
83 $apiRequest['is_metadata'] = TRUE;
84 $event->setApiRequest($apiRequest);
85 $event->setApiProvider($this);
86 $event->stopPropagation();
87 // TODO decide if we really want to override others
92 * @param \Civi\API\Event\AuthorizeEvent $event
93 * API authorization event.
95 public function onApiAuthorize(\Civi\API\Event\AuthorizeEvent
$event) {
96 $apiRequest = $event->getApiRequest();
97 if (isset($apiRequest['is_metadata'])) {
98 // if (\CRM_Core_Permission::check('access AJAX API')
99 // || \CRM_Core_Permission::check('access CiviCRM')) {
101 $event->stopPropagation();
108 * @param array $apiRequest
110 * @throws \API_Exception
112 public function invoke($apiRequest) {
113 if (strtolower($apiRequest['entity']) == 'entity' && $apiRequest['action'] == 'get') {
114 return civicrm_api3_create_success($this->apiKernel
->getEntityNames($apiRequest['version']), $apiRequest['params'], 'entity', 'get');
116 switch ($apiRequest['action']) {
118 return civicrm_api3_create_success($this->apiKernel
->getActionNames($apiRequest['version'], $apiRequest['entity']), $apiRequest['params'], $apiRequest['entity'], $apiRequest['action']);
121 // return $this->doGetFields($apiRequest);
126 // We shouldn't get here because onApiResolve() checks $this->actions
127 throw new \
API_Exception("Unsupported action (" . $apiRequest['entity'] . '.' . $apiRequest['action'] . ']');
132 * @param int $version
135 public function getEntityNames($version) {
136 return array('Entity');
141 * @param int $version
142 * @param string $entity
145 public function getActionNames($version, $entity) {
146 $entity = _civicrm_api_get_camel_name($entity, $version);
147 return isset($this->actions
[$entity]) ?
$this->actions
[$entity] : $this->actions
['*'];