Civi/API/Subscriber/XDebugSubscriber.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\Subscriber;
  29 use Civi\API\Events;
  30 use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  31
  32 /**
  33  * Class XDebugSubscriber
  34  * @package Civi\API\Subscriber
  35  */
  36 class XDebugSubscriber implements EventSubscriberInterface {
  37   /**
  38    * @return array
  39    */
  40   public static function getSubscribedEvents() {
  41     return array(
  42       Events::RESPOND => array('onApiRespond', Events::W_LATE),
  43     );
  44   }
  45
  46   /**
  47    * @param \Civi\API\Event\RespondEvent $event
  48    *   API response event.
  49    */
  50   public function onApiRespond(\Civi\API\Event\RespondEvent $event) {
  51     $apiRequest = $event->getApiRequest();
  52     $result = $event->getResponse();
  53     if (function_exists('xdebug_time_index')
  54       && \CRM_Utils_Array::value('debug', $apiRequest['params'])
  55       // result would not be an array for getvalue
  56       && is_array($result)
  57     ) {
  58       $result['xdebug']['peakMemory'] = xdebug_peak_memory_usage();
  59       $result['xdebug']['memory'] = xdebug_memory_usage();
  60       $result['xdebug']['timeIndex'] = xdebug_time_index();
  61       $event->setResponse($result);
  62     }
  63   }
  64 }