README

Stopwatch, CSV logger and time converter (seconds to readable string).

Install

Put this in a composer.json:

{
    "require": {
        "zdenekdrahos/profiler-tools": "*"
    }
}

Usage

// start stopwatch
$stopwatch = ProfilerTools\stopwatch();

// execute something

// stop timer
list($start, $end, $elapsedSeconds) = $stopwatch();

// log execution time
appendCsvLine(
    'log.csv'
    array(
        $start->format('c'),
        $end->format('c'),
        ProfilerTools\secondsToDays($elapsedSeconds)
    )
);

Logger appends following line to log.csv:

2015-02-01T09:15:17+01:00,2015-02-01T09:15:18+01:00,1.1s

No temporal coupling

execute something is the tricky part of the previous example. You could get easily coupled to start and stop stopwatch. You can use passing closure to monitorExecution which returns execution report. Take a look at example with hidden stopwatch:

$report = ProfilerTools\monitorExecution(function() {
    // execute something
});
ProfilerTools\appendCsvLine('log.csv', array(
    $report->dateStart->format('c'),
    $report->dateFinish->format('c'),
    $report->convertSecondsToReadableString(),
    $report->elapsedSeconds,
    $report->hasFailed() ? $report->exception->getMessage() : ''
));

Stopwatch

• $stopwatch = ProfilerTools\stopwatch() - starts timer and returns function for stopping timer
• $stopwatch() - returns start/end date and elapsed seconds
• $report = ProfilerTools\monitorExecution(closure) - monitors function call and returns report

Logger

• ProfilerTools\appendCsvLine($file, array $row) - converts array to line and append the line
• ProfilerTools\appendCsvLines($file, array $rows) - appends N lines in one write operation
• ProfilerTools\clearLog($file) - deletes existing content of file

Time converter

• ProfilerTools\secondsToDays($elapsedSeconds, $precision) - converts seconds to readable format, optional milliseconds precions

Examples

License

Copyright (c) 2015 Zdeněk Drahoš. MIT Licensed, see LICENSE for details.