includes/profiler/output/ProfilerOutput.php

   1 <?php
   2 /**
   3  * This program is free software; you can redistribute it and/or modify
   4  * it under the terms of the GNU General Public License as published by
   5  * the Free Software Foundation; either version 2 of the License, or
   6  * (at your option) any later version.
   7  *
   8  * This program is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  11  * GNU General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License along
  14  * with this program; if not, write to the Free Software Foundation, Inc.,
  15  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  16  * http://www.gnu.org/copyleft/gpl.html
  17  *
  18  * @file
  19  * @ingroup Profiler
  20  */
  21
  22 /**
  23  * Base class for profiling output
  24  *
  25  * Since 1.25
  26  */
  27 abstract class ProfilerOutput {
  28         /** @var Profiler */
  29         protected $collector;
  30         /** @var array Configuration of $wgProfiler */
  31         protected $params = [];
  32
  33         /**
  34          * @param Profiler $collector The actual profiler
  35          * @param array $params Configuration array, passed down from $wgProfiler
  36          */
  37         public function __construct( Profiler $collector, array $params ) {
  38                 $this->collector = $collector;
  39                 $this->params = $params;
  40         }
  41
  42         /**
  43          * Can this output type be used?
  44          * @return bool
  45          */
  46         public function canUse() {
  47                 return true;
  48         }
  49
  50         /**
  51          * Log MediaWiki-style profiling data
  52          *
  53          * @param array $stats Result of Profiler::getFunctionStats()
  54          */
  55         abstract public function log( array $stats );
  56 }