Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gpslab/interval
Interval Value Objects
https://github.com/gpslab/interval
datetime ddd doctrine interval ip ipv4 ipv4-network ipv6 ipv6-network period php value-object
Last synced: about 13 hours ago
JSON representation
Interval Value Objects
- Host: GitHub
- URL: https://github.com/gpslab/interval
- Owner: gpslab
- License: mit
- Created: 2016-11-29T12:21:31.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2022-03-16T13:15:23.000Z (almost 3 years ago)
- Last Synced: 2024-11-23T09:06:39.542Z (about 1 month ago)
- Topics: datetime, ddd, doctrine, interval, ip, ipv4, ipv4-network, ipv6, ipv6-network, period, php, value-object
- Language: PHP
- Homepage:
- Size: 194 KB
- Stars: 6
- Watchers: 2
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/gpslab/interval/actions?query=workflow%3A%22CI%22+branch%3Amaster)
[](https://packagist.org/packages/gpslab/interval)
[](https://codecov.io/gh/gpslab/interval/branch/master)
[](https://scrutinizer-ci.com/g/gpslab/interval/?branch=master)
[](https://styleci.io/repos/75078831)
[](https://github.com/gpslab/interval)
Interval Value Objects
======================
This is a library with a set of classes intended to describe intervals as
[Value Objects](https://en.wikipedia.org/wiki/Value_object) and perform operations on them.
## Installation
Pretty simple with [Composer](http://packagist.org), run:
```sh
composer require gpslab/interval
```
## Interval type
This library is supports [interval types](https://en.wikipedia.org/wiki/Interval_(mathematics)).
* `[a, b] = [a, b] = {x ∈ ℝ | a ≤ x ≤ b}` - Closed
* `[a, b) = [a, b[ = {x ∈ ℝ | a ≤ x < b}` - Half-closed
* `(a, b] = ]a, b] = {x ∈ ℝ | a < x ≤ b}` - Half-open
* `(a, b) = ]a, b[ = {x ∈ ℝ | a < x < b}` - Open
## Intervals
* Number
* Date
* Time
* DateTime
* Week
* Month
* Year
* IPv4
* IPv6
* IPv4Network
* IPv6Network
## Usage intervals
Create interval `[1, 5)`
```php
$interval = NumberInterval::halfClosed(1, 5);
echo $interval->start(); // 1
echo $interval->end(); // 5
// convert to string
$string = (string)$interval;
echo $string; // [1, 5)
// restore from string
$new_interval = NumberInterval::fromString($string);
$interval == $new_interval; // true
$interval->equal($new_interval); // true
```
Change intervals
```php
$interval = NumberInterval::halfClosed(1, 5);
// created a new interval instance
$new_interval = $interval->withStart(new NumberIntervalPoint(2));
$interval->start() != $new_interval->start(); // true
```
IPv4 network
```php
// from CIDR
$network = IPv4Network::fromCIDR('192.168.0.0', 16);
echo $network->start(); // 192.168.0.0
echo $network->end(); // 192.168.255.255
$network->contains('192.168.13.74'); // true
// from ip mask
$new_network = IPv4Network::fromMask('192.168.0.0', '255.255.0.0');
$network->equal($new_network); // true
```
Local network
```php
function isLocalNetworkHost($host)
{
// is IPv6
if (strpos($host, ':') !== false) {
// RFC 4193
return IPv6Network::fromString('fc00::/7')->contains($host);
}
// RFC 1918
return
IPv4Network::fromString('10/8')->contains($host) ||
IPv4Network::fromString('172.16/12')->contains($host) ||
IPv4Network::fromString('192.168/16')->contains($host)
;
}
```
## Interval operations
* `equal` - Checks if this Interval is equal to the specified interval;
* `contains` - Does this interval contain the specified point;
* `intersects` - Does this interval intersect the specified interval;
* `intersection` - Gets the intersection between this interval and another interval;
* `cover` - Gets the covered interval between this Interval and another interval;
* `gap` - Gets the gap between this interval and another interval;
* `abuts` - Does this interval abut with the interval specified;
* `join` - Joins the interval between the adjacent;
* `union` - Gets the union between this interval and another interval;
* `before` - The point is before the interval;
* `after` - The point is after the interval.
## Iterate intervals
The following intervals support iteration:
* Number
* Date
* Time
* DateTime
* Week
* Month
* Year
* IPv4
* IPv4Network
### Example usage
Use step `1` and closed interval type `[1, 5]`
```php
$interval = NumberInterval::closed(1, 5);
$points_in_interval = [];
foreach ($interval->iterate() as $point) {
$points_in_interval[] = $point;
}
$points_in_interval == [1, 2, 3, 4, 5]; // true
```
Use step `2` and open interval type `(0, 10)`
```php
$step = 2;
$interval = NumberInterval::open(0, 10);
$points_in_interval = [];
foreach ($interval->iterate($step) as $point) {
$points_in_interval[] = $point;
}
$points_in_interval == [2, 4, 6, 8]; // true
```
Iterate IPv4 interval
```php
$expected = [
'10.0.1.2',
'10.0.1.4',
'10.0.1.6',
'10.0.1.8'
];
$step = 2;
$interval = IPv4Interval::open('10.0.1.0', '10.0.1.10');
$points_in_interval = [];
foreach ($interval->iterate($step) as $point) {
$points_in_interval[] = $point;
}
$points_in_interval == $expected; // true
```
Iterate date interval
```php
$expected = [
'2017-03-03',
'2017-03-05',
'2017-03-07',
'2017-03-09',
];
$step = new \DateInterval('P2D');
$interval = DateInterval::open(new \DateTime('2017-03-01'), new \DateTime('2017-03-11'));
$points_in_interval = [];
foreach ($interval->iterate($step) as $point) {
$points_in_interval[] = $point->format('Y-m-d');
}
$points_in_interval == $expected; // true
```
## Persistence in Doctrine
You cat use intervals as
[Custom Mapping Types](http://docs.doctrine-project.org/projects/doctrine-orm/en/latest/cookbook/custom-mapping-types.html)
for Doctrine.
```php
Type::addType('NumberInterval', 'GpsLab\Component\Interval\Persistence\Doctrine\DBAL\Types\NumberIntervalType');
$em->getConnection()->getDatabasePlatform()->registerDoctrineTypeMapping('NumberInterval', 'NumberInterval');
```
You cat [registration](http://symfony.com/doc/current/doctrine/dbal.html#registering-custom-mapping-types) custom
Doctrine mapping types in Symfony
```yml
# config/packages/doctrine.yml
doctrine:
dbal:
types:
NumberInterval: GpsLab\Component\Interval\Persistence\Doctrine\DBAL\Types\NumberIntervalType
DateInterval: GpsLab\Component\Interval\Persistence\Doctrine\DBAL\Types\DateIntervalType
TimeInterval: GpsLab\Component\Interval\Persistence\Doctrine\DBAL\Types\TimeIntervalType
DateTimeInterval: GpsLab\Component\Interval\Persistence\Doctrine\DBAL\Types\DateTimeIntervalType
WeekInterval: GpsLab\Component\Interval\Persistence\Doctrine\DBAL\Types\WeekIntervalType
MonthInterval: GpsLab\Component\Interval\Persistence\Doctrine\DBAL\Types\MonthIntervalType
YearInterval: GpsLab\Component\Interval\Persistence\Doctrine\DBAL\Types\YearIntervalType
IPv4Interval: GpsLab\Component\Interval\Persistence\Doctrine\DBAL\Types\IPv4IntervalType
IPv6Interval: GpsLab\Component\Interval\Persistence\Doctrine\DBAL\Types\IPv6IntervalType
IPv4Network: GpsLab\Component\Interval\Persistence\Doctrine\DBAL\Types\IPv4NetworkType
IPv6Network: GpsLab\Component\Interval\Persistence\Doctrine\DBAL\Types\IPv6NetworkType
```
## License
This bundle is under the [MIT license](http://opensource.org/licenses/MIT). See the complete license in the file: LICENSE