BZIon\Debug\Debug

Complexity

Total Complexity

13

Size/Duplication

Total Lines	81
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	1

Test Coverage

Coverage

85.29%

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	finishStopwatch()	0	18	3
A	log()	0	14	3
A	startStopwatch()	0	12	3
A	logCacheFetch()	0	9	4

<?php
/**
 * This file contains functionality related to debugging, logging and timing actions
 *
 * @package    BZiON
 * @license    https://github.com/allejo/bzion/blob/master/LICENSE.md GNU General Public License Version 3
 */

namespace BZIon\Debug;

/**
 * Useful debugging functions (will only waste time on a development environment)
 */
abstract class Debug
{
    /**
     * Start counting time for an event
     * @param  string $event The event's name
     * @return void
     */
    public static function startStopwatch($event)
    {
        if (!\Service::getContainer()) {
            return;
        }

        $stopwatch = \Service::getContainer()->get('debug.stopwatch', null);

        if ($stopwatch) {
            $stopwatch->start($event);
        }
    }

    /**
     * Stop counting time for an event and get its duration
     * @param  string $event The event's name
     * @return int    The time in milliseconds
     */
    public static function finishStopwatch($event)
    {
        if (!\Service::getContainer()) {
            return 0;
        }

        $stopwatch = \Service::getContainer()->get('debug.stopwatch', null);

        if (!$stopwatch) {
            return 0;
        }

        $event = $stopwatch->stop($event);
        $periods = $event->getPeriods();
        $duration = end($periods)->getDuration();

        return $duration;
    }

    /**
     * Log a debug message
     * @param  string $message The message to return
     * @param  array  $context Any additional information to show
     * @param  string $channel The channel to store the log into
     * @return void
     */
    public static function log($message, array $context = array(), $channel = 'app')
    {
        if (!\Service::getContainer()) {
            return;
        }

        $logger = \Service::getContainer()->get("monolog.logger.$channel", null);

        if (!$logger) {
            return;
        }

        $logger->debug($message, $context);
    }

    /**
     * Log a cache fetch in the data collector
     * @param string $type The type of the fetched model
     * @param int    $id   The ID of the fetched model
     */
    public static function logCacheFetch($type, $id)
    {
        if (\Service::isDebug() && \Service::getContainer()) {
            $collector = \Service::getContainer()->get('data_collector.bzion_database_collector', null);
            if ($collector) {
                $collector->logCacheFetch($type, $id);
            }
        }
    }
}