Skip to content

Commit 3fcfa36

Browse files
dan-ondan-on
authored
Merge pull request #9 from dan-on/feature/generics-types-support
feat: generics types support
2 parents c497d80 + 8e642bf commit 3fcfa36

14 files changed

Lines changed: 277 additions & 130 deletions

‎phpstan.neon.dist‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@ parameters:
22
level: 7
33
paths:
44
- src
5-
- tests
5+
- tests

‎src/Interval/DateTimeInterval.php‎

Lines changed: 22 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -9,22 +9,26 @@
99

1010
use function count;
1111

12+
/**
13+
* @template TPoint of DateTimeInterface
14+
* @implements IntervalInterface<TPoint>
15+
*/
1216
final class DateTimeInterval implements IntervalInterface
1317
{
1418
/**
15-
* @var DateTimeInterface
19+
* @var TPoint
1620
*/
1721
private $low;
1822

1923
/**
20-
* @var DateTimeInterface
24+
* @var TPoint
2125
*/
2226
private $high;
2327

2428
/**
2529
* DateTimeInterval constructor
26-
* @param DateTimeInterface $low
27-
* @param DateTimeInterface $high
30+
* @param TPoint $low
31+
* @param TPoint $high
2832
*/
2933
public function __construct($low, $high)
3034
{
@@ -37,10 +41,12 @@ public function __construct($low, $high)
3741
}
3842

3943
/**
40-
* @param DateTimeInterface[] $interval
41-
* @return DateTimeInterval
44+
* @phpstan-ignore-next-line
45+
* @psalm-template TPoint of DateTimeInterface
46+
* @param TPoint[] $interval
47+
* @return IntervalInterface<TPoint>
4248
*/
43-
public static function fromArray($interval): DateTimeInterval
49+
public static function fromArray(array $interval): IntervalInterface
4450
{
4551
if (count($interval) !== 2) {
4652
throw new InvalidArgumentException('Wrong interval array');
@@ -59,20 +65,20 @@ public function getHigh(): DateTimeInterface
5965
}
6066

6167
/**
62-
* @param DateTimeInterval $otherInterval
68+
* @param IntervalInterface<TPoint> $otherInterval
6369
* @return bool
6470
*/
65-
public function equalTo($otherInterval): bool
71+
public function equalTo(IntervalInterface $otherInterval): bool
6672
{
6773
return $this->getLow()->getTimestamp() === $otherInterval->getLow()->getTimestamp() &&
6874
$this->getHigh()->getTimestamp() === $otherInterval->getHigh()->getTimestamp();
6975
}
7076

7177
/**
72-
* @param DateTimeInterval $otherInterval
78+
* @param IntervalInterface<TPoint> $otherInterval
7379
* @return bool
7480
*/
75-
public function lessThan($otherInterval): bool
81+
public function lessThan(IntervalInterface $otherInterval): bool
7682
{
7783
return $this->getLow()->getTimestamp() < $otherInterval->getLow()->getTimestamp() ||
7884
(
@@ -82,19 +88,19 @@ public function lessThan($otherInterval): bool
8288
}
8389

8490
/**
85-
* @param DateTimeInterval $otherInterval
91+
* @param IntervalInterface<TPoint> $otherInterval
8692
* @return bool
8793
*/
88-
public function intersect($otherInterval): bool
94+
public function intersect(IntervalInterface $otherInterval): bool
8995
{
9096
return !($this->getHigh() < $otherInterval->getLow() || $otherInterval->getHigh() < $this->getLow());
9197
}
9298

9399
/**
94-
* @param DateTimeInterval $otherInterval
95-
* @return DateTimeInterval
100+
* @param IntervalInterface<TPoint> $otherInterval
101+
* @return IntervalInterface<TPoint>
96102
*/
97-
public function merge($otherInterval): DateTimeInterval
103+
public function merge(IntervalInterface $otherInterval): IntervalInterface
98104
{
99105
return new DateTimeInterval(
100106
min($this->getLow(), $otherInterval->getLow()),

‎src/Interval/IntervalInterface.php‎

Lines changed: 44 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -4,29 +4,56 @@
44

55
namespace Danon\IntervalTree\Interval;
66

7+
/**
8+
* @template TPoint
9+
*/
710
interface IntervalInterface
811
{
9-
// @phpstan-ignore-next-line
12+
/**
13+
* @param TPoint $low
14+
* @param TPoint $high
15+
*/
1016
public function __construct($low, $high);
1117

12-
// @phpstan-ignore-next-line
13-
public static function fromArray($interval);
14-
15-
// @phpstan-ignore-next-line
18+
/**
19+
* @phpstan-ignore-next-line
20+
* @psalm-template TPoint
21+
* @param TPoint[] $interval
22+
* @return IntervalInterface<TPoint>
23+
*/
24+
public static function fromArray(array $interval): IntervalInterface;
25+
26+
/**
27+
* @return TPoint
28+
*/
1629
public function getLow();
1730

18-
// @phpstan-ignore-next-line
31+
/**
32+
* @return TPoint
33+
*/
1934
public function getHigh();
2035

21-
// @phpstan-ignore-next-line
22-
public function equalTo($otherInterval): bool;
23-
24-
// @phpstan-ignore-next-line
25-
public function lessThan($otherInterval): bool;
26-
27-
// @phpstan-ignore-next-line
28-
public function intersect($otherInterval): bool;
29-
30-
// @phpstan-ignore-next-line
31-
public function merge($otherInterval);
36+
/**
37+
* @param IntervalInterface<TPoint> $otherInterval
38+
* @return bool
39+
*/
40+
public function equalTo(IntervalInterface $otherInterval): bool;
41+
42+
/**
43+
* @param IntervalInterface<TPoint> $otherInterval
44+
* @return bool
45+
*/
46+
public function lessThan(IntervalInterface $otherInterval): bool;
47+
48+
/**
49+
* @param IntervalInterface<TPoint> $otherInterval
50+
* @return bool
51+
*/
52+
public function intersect(IntervalInterface $otherInterval): bool;
53+
54+
/**
55+
* @param IntervalInterface<TPoint> $otherInterval
56+
* @return IntervalInterface<TPoint>
57+
*/
58+
public function merge(IntervalInterface $otherInterval): IntervalInterface;
3259
}

‎src/Interval/NumericInterval.php‎

Lines changed: 24 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -8,22 +8,26 @@
88

99
use function count;
1010

11+
/**
12+
* @template TPoint of int|float
13+
* @implements IntervalInterface<TPoint>
14+
*/
1115
final class NumericInterval implements IntervalInterface
1216
{
1317
/**
14-
* @var int|float
18+
* @var TPoint
1519
*/
1620
private $low;
1721

1822
/**
19-
* @var int|float
23+
* @var TPoint
2024
*/
2125
private $high;
2226

2327
/**
2428
* NumericInterval constructor
25-
* @param int|float $low
26-
* @param int|float $high
29+
* @param TPoint $low
30+
* @param TPoint $high
2731
*/
2832
public function __construct($low, $high)
2933
{
@@ -36,10 +40,12 @@ public function __construct($low, $high)
3640
}
3741

3842
/**
39-
* @param int[] $interval
40-
* @return NumericInterval
43+
* @phpstan-ignore-next-line
44+
* @psalm-template TPoint of int|float
45+
* @param TPoint[] $interval
46+
* @return IntervalInterface<TPoint>
4147
*/
42-
public static function fromArray($interval): NumericInterval
48+
public static function fromArray(array $interval): IntervalInterface
4349
{
4450
if (count($interval) !== 2) {
4551
throw new InvalidArgumentException('Wrong interval array');
@@ -48,54 +54,54 @@ public static function fromArray($interval): NumericInterval
4854
}
4955

5056
/**
51-
* @return int|float
57+
* @return TPoint
5258
*/
5359
public function getLow()
5460
{
5561
return $this->low;
5662
}
5763

5864
/**
59-
* @return int|float
65+
* @return TPoint
6066
*/
6167
public function getHigh()
6268
{
6369
return $this->high;
6470
}
6571

6672
/**
67-
* @param NumericInterval $otherInterval
73+
* @param IntervalInterface<TPoint> $otherInterval
6874
* @return bool
6975
*/
70-
public function equalTo($otherInterval): bool
76+
public function equalTo(IntervalInterface $otherInterval): bool
7177
{
7278
return $this->getLow() === $otherInterval->getLow() && $this->getHigh() === $otherInterval->getHigh();
7379
}
7480

7581
/**
76-
* @param NumericInterval $otherInterval
82+
* @param IntervalInterface<TPoint> $otherInterval
7783
* @return bool
7884
*/
79-
public function lessThan($otherInterval): bool
85+
public function lessThan(IntervalInterface $otherInterval): bool
8086
{
8187
return $this->getLow() < $otherInterval->getLow() ||
8288
($this->getLow() === $otherInterval->getLow() && $this->getHigh() < $otherInterval->getHigh());
8389
}
8490

8591
/**
86-
* @param NumericInterval $otherInterval
92+
* @param IntervalInterface<TPoint> $otherInterval
8793
* @return bool
8894
*/
89-
public function intersect($otherInterval): bool
95+
public function intersect(IntervalInterface $otherInterval): bool
9096
{
9197
return !($this->getHigh() < $otherInterval->getLow() || $otherInterval->getHigh() < $this->getLow());
9298
}
9399

94100
/**
95-
* @param NumericInterval $otherInterval
96-
* @return NumericInterval
101+
* @param IntervalInterface<TPoint> $otherInterval
102+
* @return IntervalInterface<TPoint>
97103
*/
98-
public function merge($otherInterval): NumericInterval
104+
public function merge(IntervalInterface $otherInterval): IntervalInterface
99105
{
100106
return new NumericInterval(
101107
min($this->getLow(), $otherInterval->getLow()),

0 commit comments

Comments
 (0)