includes/profiler/output/ProfilerOutputText.php

   1 <?php
   2 /**
   3  * Profiler showing output in page source.
   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  * The least sophisticated profiler output class possible, view your source! :)
  26  *
  27  * Put the following 2 lines in StartProfiler.php:
  28  *
  29  * $wgProfiler['class'] = 'ProfilerSimpleText';
  30  * $wgProfiler['visible'] = true;
  31  *
  32  * @ingroup Profiler
  33  * @since 1.25
  34  */
  35 class ProfilerOutputText extends ProfilerOutput {
  36         /** @var float Min real time display threshold */
  37         protected $thresholdMs;
  38
  39         function __construct( Profiler $collector, array $params ) {
  40                 parent::__construct( $collector, $params );
  41                 $this->thresholdMs = isset( $params['thresholdMs'] )
  42                         ? $params['thresholdMs']
  43                         : .25;
  44         }
  45         protected function logStandardData( array $stats ) {
  46                 if ( $this->collector->getTemplated() ) {
  47                         $out = '';
  48
  49                         // Filter out really tiny entries
  50                         $min = $this->thresholdMs;
  51                         $stats = array_filter( $stats, function( $a ) use ( $min ) {
  52                                 return $a['real'] > $min;
  53                         } );
  54                         // Sort descending by time elapsed
  55                         usort( $stats, function( $a, $b ) {
  56                                 return $a['real'] < $b['real'];
  57                         } );
  58
  59                         array_walk( $stats,
  60                                 function ( $item ) use ( &$out ) {
  61                                         $out .= sprintf( "%6.2f%% %3.3f %6d - %s\n",
  62                                                 $item['%real'], $item['real'], $item['calls'], $item['name'] );
  63                                 }
  64                         );
  65
  66                         $contentType = $this->collector->getContentType();
  67                         if ( PHP_SAPI === 'cli' ) {
  68                                 print "<!--\n{$out}\n-->\n";
  69                         } elseif ( $contentType === 'text/html' ) {
  70                                 $visible = isset( $this->params['visible'] ) ?
  71                                         $this->params['visible'] : false;
  72                                 if ( $visible ) {
  73                                         print "<pre>{$out}</pre>";
  74                                 } else {
  75                                         print "<!--\n{$out}\n-->\n";
  76                                 }
  77                         } elseif ( $contentType === 'text/javascript' ) {
  78                                 print "\n/*\n${$out}*/\n";
  79                         } elseif ( $contentType === 'text/css' ) {
  80                                 print "\n/*\n{$out}*/\n";
  81                         }
  82                 }
  83         }
  84 }