Fabfuel\Prophiler\Benchmark\Benchmark

Complexity

Total Complexity

19

Size/Duplication

Total Lines	190
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	0

Test Coverage

Coverage

100%

Importance

Changes

0

16 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	6	1
A	getDuration()	0	4	1
A	getStartTime()	0	4	1
A	getEndTime()	0	7	2
A	getMemoryUsage()	0	4	1
A	getMemoryUsageStart()	0	4	1
A	getMemoryUsageEnd()	0	7	2
A	getName()	0	4	1
A	setName()	0	4	1
A	getMetadata()	0	4	1
A	addMetadata()	0	4	1
A	getComponent()	0	4	1
A	start()	0	5	1
A	stop()	0	5	1
A	getMetadataValue()	0	4	2
A	setComponent()	0	4	1

<?php
/**
 * @author @fabfuel <fabian@fabfuel.de>
 * @created 13.11.14, 08:11
 */
namespace Fabfuel\Prophiler\Benchmark;

/**
 * Class Benchmark
 * @package Fabfuel\Prophiler\Benchmark
 */
class Benchmark implements BenchmarkInterface
{
    /**
     * @var string Unique identifier
     */
    protected $name;

    /**
     * @var double Starting time
     */
    protected $startTime = 0.0;

    /**
     * @var double Starting memory usage
     */
    protected $startMemory = 0.0;

    /**
     * @var double Ending time
     */
    protected $endTime = 0.0;

    /**
     * @var double Ending memory usage
     */
    protected $endMemory = 0.0;

    /**
     * @var array Custom metadata regarding this benchmark
     */
    protected $metadata = [];

    /**
     * @var string
     */
    protected $component;

    /**
     * @param string $name Unique identifier like e.g. Class::Method (\Foobar\MyClass::doSomething)
     * @param array $metadata Additional metadata
     * @param string $component Name of the component which triggered the benchmark, e.g. "App", "Database"
     */
    public function __construct($name, array $metadata = [], $component = null)
    {
        $this->setName($name);
        $this->addMetadata($metadata);
        $this->setComponent($component);
    }

    /**
     * Start the benchmark
     *
     * @return void
     */
    public function start()
    {
        $this->startTime = (double)microtime(true);
        $this->startMemory = (double)memory_get_usage();
    }

    /**
     * Stop the benchmark
     *
     * @return void
     */
    public function stop()
    {
        $this->endTime = (double)microtime(true);
        $this->endMemory = (double)memory_get_usage();
    }

    /**
     * @return double Duration in milliseconds
     */
    public function getDuration()
    {
        return ($this->getEndTime() - $this->getStartTime()) * 1000;
    }

    /**
     * @return double Timestamp in microtime
     */
    public function getStartTime()
    {
        return $this->startTime;
    }

    /**
     * @return double Timestamp in microtime
     */
    public function getEndTime()
    {
        if ($this->endTime < $this->startTime) {
            $this->endTime = (double)microtime(true);
        }
        return $this->endTime;
    }

    /**
     * Memory usage (difference between start and end memory usage)
     *
     * @return double
     */
    public function getMemoryUsage()
    {
        return $this->getMemoryUsageEnd() - $this->getMemoryUsageStart();
    }

    /**
     * Memory usage (difference between start and end memory usage)
     *
     * @return double
     */
    public function getMemoryUsageStart()
    {
        return $this->startMemory;
    }

    /**
     * Memory usage (difference between start and end memory usage)
     *
     * @return double
     */
    public function getMemoryUsageEnd()
    {
        if ($this->endMemory < $this->startMemory) {
            $this->endMemory = (double)memory_get_usage();
        }
        return $this->endMemory;
    }

    /**
     * @return string
     */
    public function getName()
    {
        return $this->name;
    }

    /**
     * @param string $name
     */
    public function setName($name)
    {
        $this->name = $name;
    }

    /**
     * @return array
     */
    public function getMetadata()
    {
        return $this->metadata;
    }

    /**
     * @param string $key Metadata key to receive
     * @return mixed Custom metadata value
     */
    public function getMetadataValue($key = null)
    {
        return array_key_exists($key, $this->metadata) ? $this->metadata[$key] : null;
    }

    /**
     * Add interesting metadata to the benchmark
     *
     * @param array $metadata Additional metadata
     */
    public function addMetadata(array $metadata)
    {
        $this->metadata = array_merge($this->metadata, $metadata);
    }

    /**
     * @return string
     */
    public function getComponent()
    {
        return $this->component;
    }

    /**
     * @param string $component
     */
    public function setComponent($component)
    {
        $this->component = $component;
    }
}