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\Subscriber
;
30 use Symfony\Component\EventDispatcher\EventSubscriberInterface
;
33 * This is a wrapper for the legacy "API Wrapper" interface which allows
34 * wrappers to run through the new kernel. It translates from dispatcher events
35 * ('api.prepare', 'api.respond') to wrapper calls ('fromApiInput', 'toApiOutput').
37 class WrapperAdapter
implements EventSubscriberInterface
{
42 public static function getSubscribedEvents() {
44 Events
::PREPARE
=> array('onApiPrepare', Events
::W_MIDDLE
),
45 Events
::RESPOND
=> array('onApiRespond', Events
::W_EARLY
* 2),
50 * @var array(\API_Wrapper)
55 * @param array $defaults
57 function __construct($defaults = array()) {
58 $this->defaults
= $defaults;
62 * @param \Civi\API\Event\PrepareEvent $event
64 public function onApiPrepare(\Civi\API\Event\PrepareEvent
$event) {
65 $apiRequest = $event->getApiRequest();
67 // For input filtering, process $apiWrappers in forward order
68 foreach ($this->getWrappers($apiRequest) as $apiWrapper) {
69 $apiRequest = $apiWrapper->fromApiInput($apiRequest);
72 $event->setApiRequest($apiRequest);
76 * @param \Civi\API\Event\RespondEvent $event
78 public function onApiRespond(\Civi\API\Event\RespondEvent
$event) {
79 $apiRequest = $event->getApiRequest();
80 $result = $event->getResponse();
82 // For output filtering, process $apiWrappers in reverse order
83 foreach (array_reverse($this->getWrappers($apiRequest)) as $apiWrapper) {
84 $result = $apiWrapper->toApiOutput($apiRequest, $result);
87 $event->setResponse($result);
91 * @param array $apiRequest
92 * @return array<\API_Wrapper>
94 public function getWrappers($apiRequest) {
95 if (!isset($apiRequest['wrappers'])) {
96 $apiRequest['wrappers'] = $this->defaults
;
97 \CRM_Utils_Hook
::apiWrappers($apiRequest['wrappers'], $apiRequest);
99 return $apiRequest['wrappers'];