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 */
20
21use MediaWiki\Logger\LoggerFactory;
22use Psr\Log\LoggerInterface;
23
24/**
25 * Base class for profiling output.
26 *
27 * @ingroup Profiler
28 * @since 1.25
29 */
30abstract class ProfilerOutput {
31	/** @var Profiler */
32	protected $collector;
33	/** @var LoggerInterface */
34	protected $logger;
35	/** @var array Configuration of $wgProfiler */
36	protected $params;
37
38	/**
39	 * @param Profiler $collector The actual profiler
40	 * @param array $params Configuration array, passed down from $wgProfiler
41	 */
42	public function __construct( Profiler $collector, array $params ) {
43		$this->collector = $collector;
44		$this->params = $params;
45		$this->logger = LoggerFactory::getInstance( 'profiler' );
46	}
47
48	/**
49	 * Can this output type be used?
50	 * @return bool
51	 */
52	public function canUse() {
53		return true;
54	}
55
56	/**
57	 * May the log() try to write to standard output?
58	 * @return bool
59	 * @since 1.33
60	 */
61	public function logsToOutput() {
62		return false;
63	}
64
65	/**
66	 * Log MediaWiki-style profiling data.
67	 *
68	 * For classes that enable logsToOutput(), this must not
69	 * be called unless Profiler::setAllowOutput is enabled.
70	 *
71	 * @param array $stats Result of Profiler::getFunctionStats()
72	 */
73	abstract public function log( array $stats );
74}
75