e662614f95
Implicitly marking parameter $... as nullable is deprecated in php8.4, the explicit nullable type must be used instead Created with autofix from Ide15839e98a6229c22584d1c1c88c690982e1d7a Break one long line in SpecialPage.php Bug: T376276 Change-Id: I807257b2ba1ab2744ab74d9572c9c3d3ac2a968e
113 lines
3.2 KiB
PHP
113 lines
3.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
|
|
*/
|
|
|
|
declare( strict_types=1 );
|
|
|
|
namespace Wikimedia\Stats;
|
|
|
|
use Wikimedia\Stats\Emitters\EmitterInterface;
|
|
use Wikimedia\Stats\Emitters\NullEmitter;
|
|
use Wikimedia\Stats\Emitters\UDPEmitter;
|
|
use Wikimedia\Stats\Exceptions\UnsupportedFormatException;
|
|
use Wikimedia\Stats\Formatters\DogStatsdFormatter;
|
|
use Wikimedia\Stats\Formatters\FormatterInterface;
|
|
use Wikimedia\Stats\Formatters\NullFormatter;
|
|
use Wikimedia\Stats\Formatters\StatsdFormatter;
|
|
|
|
/**
|
|
* Metrics Format and Output Helpers
|
|
*
|
|
* @author Cole White
|
|
* @since 1.41
|
|
*/
|
|
class OutputFormats {
|
|
|
|
public const NULL = 1;
|
|
public const STATSD = 2;
|
|
public const DOGSTATSD = 3;
|
|
|
|
private const SUPPORTED_FORMATS = [
|
|
'null' => self::NULL,
|
|
'statsd' => self::STATSD,
|
|
'dogstatsd' => self::DOGSTATSD
|
|
];
|
|
|
|
/**
|
|
* Convert friendly format name to integer.
|
|
*
|
|
* @param string $format
|
|
* @return int
|
|
*/
|
|
public static function getFormatFromString( string $format ): int {
|
|
if ( self::SUPPORTED_FORMATS[$format] ?? false ) {
|
|
return self::SUPPORTED_FORMATS[$format];
|
|
}
|
|
throw new UnsupportedFormatException(
|
|
"Format '" . $format . "' not supported. Expected one of "
|
|
. json_encode( array_keys( self::SUPPORTED_FORMATS ) )
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Returns an instance of the requested formatter.
|
|
*
|
|
* @param int $format
|
|
* @return FormatterInterface
|
|
*/
|
|
public static function getNewFormatter( int $format ): FormatterInterface {
|
|
switch ( $format ) {
|
|
case self::DOGSTATSD:
|
|
return new DogStatsdFormatter();
|
|
case self::STATSD:
|
|
return new StatsdFormatter();
|
|
case self::NULL:
|
|
return new NullFormatter();
|
|
default:
|
|
throw new UnsupportedFormatException( 'Unsupported metrics format. Got format: ' . $format );
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Returns an emitter instance appropriate the formatter instance.
|
|
*
|
|
* @param string $prefix
|
|
* @param StatsCache $cache
|
|
* @param FormatterInterface $formatter
|
|
* @param string|null $target
|
|
* @return EmitterInterface
|
|
*/
|
|
public static function getNewEmitter(
|
|
string $prefix,
|
|
StatsCache $cache,
|
|
FormatterInterface $formatter,
|
|
?string $target = null
|
|
): EmitterInterface {
|
|
switch ( get_class( $formatter ) ) {
|
|
case StatsdFormatter::class:
|
|
case DogStatsdFormatter::class:
|
|
return new UDPEmitter( $prefix, $cache, $formatter, $target );
|
|
case NullFormatter::class:
|
|
return new NullEmitter;
|
|
default:
|
|
throw new UnsupportedFormatException(
|
|
'Unsupported metrics format. Got format: ' . get_class( $formatter )
|
|
);
|
|
}
|
|
}
|
|
}
|