includes/profiler/ProfileSection.php

   1 <?php
   2 /**
   3  * Function scope profiling assistant
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18  * http://www.gnu.org/copyleft/gpl.html
  19  *
  20  * @file
  21  * @ingroup Profiler
  22  */
  23
  24 /**
  25  * Class for handling function-scope profiling
  26  *
  27  * @since 1.22
  28  */
  29 class ProfileSection {
  30         /** @var string $name Method name */
  31         protected $name;
  32         /** @var boolean $enabled Is profiling enabled? */
  33         protected $enabled = false;
  34
  35         /**
  36          * Begin profiling of a function and return an object that ends profiling
  37          * of the function when that object leaves scope. As long as the object is
  38          * not specifically linked to other objects, it will fall out of scope at
  39          * the same moment that the function to be profiled terminates.
  40          *
  41          * This is typically called like:
  42          * <code>$section = new ProfileSection( __METHOD__ );</code>
  43          *
  44          * @param string $name Name of the function to profile
  45          */
  46         public function __construct( $name ) {
  47                 $this->name = $name;
  48                 // Use Profiler member variable directly to reduce overhead
  49                 if ( Profiler::$__instance === null ) {
  50                         Profiler::instance();
  51                 }
  52                 if ( !( Profiler::$__instance instanceof ProfilerStub ) ) {
  53                         $this->enabled = true;
  54                         Profiler::$__instance->profileIn( $this->name );
  55                 }
  56         }
  57
  58         function __destruct() {
  59                 if ( $this->enabled ) {
  60                         Profiler::$__instance->profileOut( $this->name );
  61                 }
  62         }
  63 }