* Requires formatters $metric parameter to be an instance of MetricsInterface. * Updates type constraints in MetricsCache Bug: T240685 Change-Id: If80968a9be26d08d42617842be9b34fe6c946340
39 lines
1.2 KiB
PHP
39 lines
1.2 KiB
PHP
<?php
|
|
/**
|
|
* This program is free software; you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation; either version 2 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program 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 General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License along
|
|
* with this program; if not, write to the Free Software Foundation, Inc.,
|
|
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
* http://www.gnu.org/copyleft/gpl.html
|
|
* @file
|
|
*/
|
|
|
|
namespace Wikimedia\Stats\Formatters;
|
|
|
|
use Wikimedia\Stats\Metrics\MetricInterface;
|
|
|
|
/**
|
|
* Metrics Formatter Interface
|
|
*
|
|
* @author Cole White
|
|
* @since 1.41
|
|
*/
|
|
interface FormatterInterface {
|
|
/**
|
|
* Renders metric to line format.
|
|
*
|
|
* @param string $prefix
|
|
* @param MetricInterface $metric
|
|
* @return string[]
|
|
*/
|
|
public function getFormattedSamples( string $prefix, MetricInterface $metric ): array;
|
|
}
|