MetricSpec.php

Go to the documentation of this file.

<?php
 
namespace Wikimedia\WRStats;
 
class MetricSpec {
    public const DEFAULT_RESOLUTION = 1;
 
    public $type;
    public $resolution;
    public $sequences;
 
    public function __construct( array $spec ) {
        $this->type = $spec['type'] ?? 'counter';
        $this->resolution = $spec['resolution'] ?? self::DEFAULT_RESOLUTION;
        foreach ( [ 'timeStep', 'expiry' ] as $var ) {
            if ( isset( $spec[$var] ) ) {
                throw new WRStatsError( __METHOD__ .
                    ": $var must be specified in the sequences array" );
            }
        }
        $seqArrays = $spec['sequences'] ?? [];
        if ( !count( $seqArrays ) ) {
            $seqArrays = [ [] ];
        }
        $sequences = [];
        foreach ( $seqArrays as $i => $seqArray ) {
            if ( !is_array( $seqArray ) ) {
                throw new WRStatsError( __METHOD__ .
                    ': sequences is supposed to be an array of arrays' );
            }
            $seqSpec = new SequenceSpec( $seqArray );
            while ( isset( $sequences[$seqSpec->name] ) ) {
                $seqSpec->name .= "s$i";
            }
            $sequences[$seqSpec->name] = $seqSpec;
        }
        uasort( $sequences, static function ( SequenceSpec $a, SequenceSpec $b ) {
            return $a->hardExpiry <=> $b->hardExpiry;
        } );
        $this->sequences = $sequences;
    }
}