Timing.php

Go to the documentation of this file.

<?php
namespace Wikimedia\Timing;
 
use Psr\Log\LoggerAwareInterface;
use Psr\Log\LoggerInterface;
use Psr\Log\NullLogger;
 
class Timing implements LoggerAwareInterface {
 
    private $entries = [];
 
    protected $logger;
 
    public function __construct( array $params = [] ) {
        $this->clearMarks();
        $this->setLogger( $params['logger'] ?? new NullLogger() );
    }
 
    public function setLogger( LoggerInterface $logger ): void {
        $this->logger = $logger;
    }
 
    public function mark( $markName ) {
        $this->entries[$markName] = [
            'name'      => $markName,
            'entryType' => 'mark',
            'startTime' => microtime( true ),
            'duration'  => 0,
        ];
        return $this->entries[$markName];
    }
 
    public function clearMarks( $markName = null ) {
        if ( $markName !== null ) {
            unset( $this->entries[$markName] );
        } else {
            $this->entries = [
                'requestStart' => [
                    'name'      => 'requestStart',
                    'entryType' => 'mark',
                    'startTime' => $_SERVER['REQUEST_TIME_FLOAT'],
                    'duration'  => 0,
                ],
            ];
        }
    }
 
    public function measure( $measureName, $startMark = 'requestStart', $endMark = null ) {
        $start = $this->getEntryByName( $startMark );
        if ( $start === null ) {
            $this->logger->error( __METHOD__ . ": The mark '$startMark' does not exist" );
            return false;
        }
        $startTime = $start['startTime'];
 
        if ( $endMark ) {
            $end = $this->getEntryByName( $endMark );
            if ( $end === null ) {
                $this->logger->error( __METHOD__ . ": The mark '$endMark' does not exist" );
                return false;
            }
            $endTime = $end['startTime'];
        } else {
            $endTime = microtime( true );
        }
 
        $this->entries[$measureName] = [
            'name'      => $measureName,
            'entryType' => 'measure',
            'startTime' => $startTime,
            'duration'  => $endTime - $startTime,
        ];
 
        return $this->entries[$measureName];
    }
 
    private function sortEntries() {
        uasort( $this->entries, static function ( $a, $b ) {
            return $a['startTime'] <=> $b['startTime'];
        } );
    }
 
    public function getEntries() {
        $this->sortEntries();
        return $this->entries;
    }
 
    public function getEntriesByType( $entryType ) {
        $this->sortEntries();
        $entries = [];
        foreach ( $this->entries as $entry ) {
            if ( $entry['entryType'] === $entryType ) {
                $entries[] = $entry;
            }
        }
        return $entries;
    }
 
    public function getEntryByName( $name ) {
        return $this->entries[$name] ?? null;
    }
}
 
class_alias( Timing::class, 'Timing' );