vctls / php-interval-graph

index.php

<?php
require_once 'vendor/autoload.php';

use Vctls\IntervalGraph\IntervalGraph;

/**
 * Generate random dates.
 * @param int $min
 * @param int $max
 * @return DateTime
 */
function rdm($min = 1514764800, $max = 1577750400)
{
    return (new DateTime)->setTimestamp(mt_rand($min, $max));
}

$today = new DateTime('today');

$base = [$today, new DateTime('today + 5 days')];
$date1 = [$today, new DateTime('today + 4 days'), 7 / 10];
$date2 = [new DateTime('today + 1 day'), new DateTime('today + 5 days'), 3 / 10];
$date3 = [new DateTime('today + 2 day'), new DateTime('today + 3 days'), 3 / 10];
$overlapped1 = new IntervalGraph([$base, $date1]);
$overlapped2 = new IntervalGraph([$base, $date2]);
$overlapped3 = new IntervalGraph([$base, $date3]);
$overlapped = new IntervalGraph([$base, $date1, $date2, $date3]);

$withNull1 = new IntervalGraph([$base, [new DateTime('today'), new DateTime('today + 3 days'), 4 / 10],]);
$withNull2 = new IntervalGraph([$base, [new DateTime('today + 1 day'), new DateTime('today + 2 days')],]);
$withNull3 = new IntervalGraph([$base, [new DateTime('today + 2 day'), new DateTime('today + 3 days'), 4 / 10],]);
$withNull4 = new IntervalGraph([$base, [new DateTime('today + 4 day'), new DateTime('today + 5 days'), 5 / 10],]);
$withNullIntervals = new IntervalGraph([
    [$today, new DateTime('today + 3 days'), 4 / 10],
    [new DateTime('today + 1 day'), new DateTime('today + 2 days')],
    [new DateTime('today + 2 day'), new DateTime('today + 3 days'), 4 / 10],
    [new DateTime('today + 4 day'), new DateTime('today + 5 days'), 5 / 10],
]);

$longIntervals = [
    [$today, new DateTime('today + 3 days'), 2 / 10],
    [new DateTime('today + 1 day'), new DateTime('today + 4 days'), 2 / 10],
    [new DateTime('today + 2 day'), new DateTime('today + 5 days'), 3 / 10],
    [new DateTime('today + 3 day'), new DateTime('today + 6 days'), 5 / 10],
    [new DateTime('today + 4 day'), new DateTime('today + 7 days'), 4 / 10],
    [new DateTime('today + 5 day'), new DateTime('today + 8 days'), 2 / 10],
    [new DateTime('today + 6 day'), new DateTime('today + 9 days'), 2 / 10],
];

$longDateFormat = function (\DateTime $bound){
    return $bound->format('Y-m-d H:i:s');
};

$long = (new IntervalGraph($longIntervals))->setBoundToStringFunction($longDateFormat);

/*
 * CUSTOM VALUE TYPES
 */

// An aggregate function for arrays representing fractions with the same denominator.
$agg = function ($a, $b) {
    if ($a === null && $b === null) return null;
    return [$a[0] + $b[0], $b[1]];
};

// A toNumeric function…
$toNumeric = function ($a) {return $a === null ? null : (int)($a[0] / $a[1] * 100);};

// A toString function…
$toString = function ($a) {return $a === null ? null : ($a[0] . '/' . $a[1]);};

$fractions = [
    [$today, new DateTime('today + 3 days'), [2, 10]],
    [new DateTime('today + 1 day'), new DateTime('today + 4 days'), [2, 10]],
    [new DateTime('today + 2 day'), new DateTime('today + 5 days'), [3, 10]],
    [new DateTime('today + 3 day'), new DateTime('today + 6 days'), [5, 10]],
    [new DateTime('today + 4 day'), new DateTime('today + 7 days'), [4, 10]],
    [new DateTime('today + 5 day'), new DateTime('today + 8 days'), [2, 10]],
    [new DateTime('today + 6 day'), new DateTime('today + 9 days'), [2, 10]],
];
$fractim = (new IntervalGraph($fractions))->setAggregateFunction($agg)
    ->setValueToNumericFunction($toNumeric)
    ->setValueToStringFunction($toString);
$fract = $fractim->draw();

/* /CUSTOM VALUE TYPES */

/*
 * TRUNCATED INTERVALS
 */
try {
    $date1 = (clone $today)->add(new DateInterval('PT60H'));
    $date2 = (clone $today)->add(new DateInterval('PT108H'));
    $date3 = (clone $date2)->add(new DateInterval('PT60H'));
} catch (Exception $e) {

Consider adding a comment why this CATCH block is empty.

}

$truncated = ($fractim->setIntervals(IntervalGraph::truncate($fractions, $date1, $date2)))

It seems like $date2 can also be of type array<integer,integer|DateTime>; however, parameter $end of Vctls\IntervalGraph\IntervalGraph::truncate() does only seem to accept null|DateTime, maybe add an additional type check?

    ->setBoundToStringFunction($longDateFormat);
/* /TRUNCATED INTERVALS */

$withDates = new IntervalGraph([
    [$date1, $date1],
    [$today, new DateTime('today + 4 days'), 7 / 10],
    [$date2, $date2],
    [new DateTime('today + 1 day'), new DateTime('today + 5 days'), 3 / 10],
    [new DateTime('today + 2 day'), new DateTime('today + 3 days'), 3 / 10],
    [$date3, $date3],
]);

$intvGraphs = [];
foreach (range(0, 20) as $t) {
    $intervals = [];
    $j = (int)rand(3, 6);
    for ($i = 0; $i < $j; $i++) {
        $intervals[] = [rdm(), rdm(), rand(1, 9) / 10];
    }
    $intvGraphs[] = new IntervalGraph($intervals);
}

?>
<html>
<head>
    <title>Php IntervalGraph demo</title>
    <link rel="stylesheet" href="styles.css">
    <script type="application/javascript" src="app.js"></script>
</head>
<body style="font-family: sans-serif;">
<header>
    <h1>PHP Interval Graph demo</h1>
</header>
<p>
    PHP Interval Graph is a small utility to manipulate and
    display arrays of intervals.
</p>
<a href="https://github.com/vctls/php-interval-graph">
    https://github.com/vctls/php-interval-graph
</a>
<h2>How it works</h2>
<p>
    Here are three overlapping date intervals.
    Each one has a linked rate, displayed as a percentage when hovering it.
    <br>They are all displayed over the same period of time, which has no rate.
</p>
<div style="margin-bottom: 2px"><?= $overlapped1 ?></div>
<div style="margin-bottom: 2px"><?= $overlapped2 ?></div>
<div style="margin-bottom: 2px"><?= $overlapped3 ?></div>

<p>
    Gathered on the same graph, they are displayed as follows.
</p>
<?= $overlapped ?>

<h2>More examples</h2>
<p>
    Overlapping intervals with a couple null intervals.<br>
    The first null interval overlaps a non null one.
    This cuts the non null interval, while the weight remains the same.<br>
    The second null interval is implicit.
    It is simply the gap between the two last intervals.
</p>
<div style="margin-bottom: 2px"><?= $withNull1 ?></div>
<div style="margin-bottom: 2px"><?= $withNull2 ?></div>
<div style="margin-bottom: 2px"><?= $withNull3 ?></div>
<div style="margin-bottom: 2px"><?= $withNull4 ?></div>
<br>
<?= $withNullIntervals ?>


<h2>Custom value types</h2>
<p>
    The following graph takes arrays of two values
    and displays them as fractions.<br>
    In order to use custom value types, you need to set the custom functions
    that will aggregate the values, convert them to numeric values and strings.
</p>
<?= $fract ?>

<p>
    The same graph, truncated between <?= $date1->format('Y-m-d H:i:s') ?>
    and <?= $date2->format('Y-m-d H:i:s') ?>.
    <?= $truncated ?>
</p>

<p>
    A graph with three isolated dates, shown as black bars.
    <br>One of the dates goes beyond all intervals.
    <?= $withDates ?>
</p>
<p>
    A bunch of random graphs, this time generated through JavaScript:
    <br>
</p>
<div id="random"></div>
<script>
    'use strict';
    const graphs = JSON.parse('<?= json_encode($intvGraphs) ?>');
    const el = document.getElementById('random');

    try {
        graphs.forEach(function (graph) {
            let html = document.createRange().createContextualFragment(intvg(graph));
            el.appendChild(html);
        });
    } catch (e) {
        el.innerHTML = 'The JavaScript function uses ES6 string literals. Sorry not sorry, IE.';
    }
</script>
</body>
</html>