<?php

/*
 +--------------------------------------------------------------------+
 | CiviCRM version 5                                                  |
 +--------------------------------------------------------------------+
 | Copyright CiviCRM LLC (c) 2004-2019                                |
 +--------------------------------------------------------------------+
 | This file is a part of CiviCRM.                                    |
 |                                                                    |
 | CiviCRM is free software; you can copy, modify, and distribute it  |
 | under the terms of the GNU Affero General Public License           |
 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
 |                                                                    |
 | CiviCRM is distributed in the hope that it will be useful, but     |
 | WITHOUT ANY WARRANTY; without even the implied warranty of         |
 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
 | See the GNU Affero General Public License for more details.        |
 |                                                                    |
 | You should have received a copy of the GNU Affero General Public   |
 | License and the CiviCRM Licensing Exception along                  |
 | with this program; if not, contact CiviCRM LLC                     |
 | at info[AT]civicrm[DOT]org. If you have questions about the        |
 | GNU Affero General Public License or the licensing of CiviCRM,     |
 | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
 +--------------------------------------------------------------------+
 */

/**
 *
 * @package CRM
 * @copyright CiviCRM LLC (c) 2004-2019
 * $Id$
 *
 */


namespace api\v4\Traits;

use CRM_Utils_Array as ArrayHelper;

trait QueryCounterTrait {

  /**
   * @var int
   */
  protected $startCount = 0;

  /**
   * Start the query counter
   */
  protected function beginQueryCount() {
    $this->startCount = $this->getCurrentGlobalQueryCount();
  }

  /**
   * @return int
   *   The number of queries since the counter was started
   */
  protected function getQueryCount() {
    return $this->getCurrentGlobalQueryCount() - $this->startCount;
  }

  /**
   * @return int
   * @throws \Exception
   */
  private function getCurrentGlobalQueryCount() {
    global $_DB_DATAOBJECT;

    if (!$_DB_DATAOBJECT) {
      throw new \Exception('Database object not set so cannot count queries');
    }

    return ArrayHelper::value('RESULTSEQ', $_DB_DATAOBJECT, 0);
  }

}