tests/phpunit/api/v4/Traits/QueryCounterTrait.php

   1 <?php
   2
   3 /*
   4  +--------------------------------------------------------------------+
   5  | CiviCRM version 5                                                  |
   6  +--------------------------------------------------------------------+
   7  | Copyright CiviCRM LLC (c) 2004-2019                                |
   8  +--------------------------------------------------------------------+
   9  | This file is a part of CiviCRM.                                    |
  10  |                                                                    |
  11  | CiviCRM is free software; you can copy, modify, and distribute it  |
  12  | under the terms of the GNU Affero General Public License           |
  13  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  14  |                                                                    |
  15  | CiviCRM is distributed in the hope that it will be useful, but     |
  16  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  17  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  18  | See the GNU Affero General Public License for more details.        |
  19  |                                                                    |
  20  | You should have received a copy of the GNU Affero General Public   |
  21  | License and the CiviCRM Licensing Exception along                  |
  22  | with this program; if not, contact CiviCRM LLC                     |
  23  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  24  | GNU Affero General Public License or the licensing of CiviCRM,     |
  25  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  26  +--------------------------------------------------------------------+
  27  */
  28
  29 /**
  30  *
  31  * @package CRM
  32  * @copyright CiviCRM LLC (c) 2004-2019
  33  * $Id$
  34  *
  35  */
  36
  37
  38 namespace api\v4\Traits;
  39
  40 use CRM_Utils_Array as ArrayHelper;
  41
  42 trait QueryCounterTrait {
  43
  44   /**
  45    * @var int
  46    */
  47   protected $startCount = 0;
  48
  49   /**
  50    * Start the query counter
  51    */
  52   protected function beginQueryCount() {
  53     $this->startCount = $this->getCurrentGlobalQueryCount();
  54   }
  55
  56   /**
  57    * @return int
  58    *   The number of queries since the counter was started
  59    */
  60   protected function getQueryCount() {
  61     return $this->getCurrentGlobalQueryCount() - $this->startCount;
  62   }
  63
  64   /**
  65    * @return int
  66    * @throws \Exception
  67    */
  68   private function getCurrentGlobalQueryCount() {
  69     global $_DB_DATAOBJECT;
  70
  71     if (!$_DB_DATAOBJECT) {
  72       throw new \Exception('Database object not set so cannot count queries');
  73     }
  74
  75     return ArrayHelper::value('RESULTSEQ', $_DB_DATAOBJECT, 0);
  76   }
  77
  78 }