Skip to content

Commit a79802b

Browse files
nyamsprodnyamsprod
committed
typo fixed for subtract usage
1 parent 00ae974 commit a79802b

8 files changed

Lines changed: 40 additions & 38 deletions

File tree

‎docs/4.0/instantiation.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ public static Period::around(mixed $datepoint, mixed $duration, string $boundary
109109

110110
- `Period::after` returns a `Period` object which starts at `$datepoint`
111111
- `Period::before` returns a `Period` object which ends at `$datepoint`
112-
- `Period::around` returns a `Period` object where the given duration is simultaneously substracted from and added to the `$datepoint`.
112+
- `Period::around` returns a `Period` object where the given duration is simultaneously subtracted from and added to the `$datepoint`.
113113

114114
#### Parameters
115115

@@ -305,7 +305,7 @@ function League\Period\interval_around(mixed $datepoint, mixed $duration): Perio
305305

306306
- `interval_after` returns a `Period` object which starts at `$datepoint`
307307
- `interval_before` returns a `Period` object which ends at `$datepoint`.
308-
- `interval_around` returns a `Period` object where the given duration is simultaneously substracted from and added to the `$datepoint`.
308+
- `interval_around` returns a `Period` object where the given duration is simultaneously subtracted from and added to the `$datepoint`.
309309

310310
#### Parameters
311311

‎docs/4.0/modifying.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -154,7 +154,7 @@ public Period::expand(mixed $duration): Period
154154

155155
Returns a new `Period` object where the given interval is:
156156

157-
- substracted from the starting endpoint
157+
- subtracted from the starting endpoint
158158
- added to the ending endpoint
159159

160160
#### Example

‎docs/4.0/sequence/container.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,7 @@ $timestamp = $sequence->getTotalTimestampInterval(); // a float
137137
Sequence::subtract(Sequence $sequence): Sequence
138138
~~~
139139

140-
This method enables subtracting a `Sequence` instance from another one. It internally use `Period::substract` and as such is not commutative.
140+
This method enables subtracting a `Sequence` instance from another one. It internally use `Period::subtract` and as such is not commutative.
141141

142142
<p class="message-notice"><strong>warning:</strong> This method is not optimized for subtracting two large collection of <code>Sequence</code> objects.</p>
143143

‎src/Period.php‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -168,7 +168,7 @@ public static function before($endDate, $duration, string $boundaryType = self::
168168

169169
/**
170170
* Creates new instance where the given duration is simultaneously
171-
* substracted from and added to the datepoint.
171+
* subtracted from and added to the datepoint.
172172
*
173173
* @param mixed $datepoint a Datepoint
174174
* @param mixed $duration a Duration
@@ -1122,7 +1122,7 @@ public function move($duration): self
11221122

11231123
/**
11241124
* Returns an instance where the given DateInterval is simultaneously
1125-
* substracted from the starting datepoint and added to the ending datepoint.
1125+
* subtracted from the starting datepoint and added to the ending datepoint.
11261126
*
11271127
* Depending on the duration value, the resulting instance duration will be expanded or shrinked.
11281128
*

‎src/Sequence.php‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -193,7 +193,7 @@ public function substract(Sequence $sequence): self
193193
* Subtract a Sequence from the current instance.
194194
*
195195
* This method MUST retain the state of the current instance, and return
196-
* an instance that contains substracted intervals.
196+
* an instance that contains subtracted intervals.
197197
*/
198198
public function subtract(Sequence $sequence): self
199199
{
@@ -219,9 +219,9 @@ private function subtractOne(Sequence $sequence, Period $interval): self
219219
}
220220

221221
$reducer = function (Sequence $sequence, Period $period) use ($interval) {
222-
$substract = $period->substract($interval);
223-
if (!$substract->isEmpty()) {
224-
$sequence->push(...$substract);
222+
$subtract = $period->subtract($interval);
223+
if (!$subtract->isEmpty()) {
224+
$sequence->push(...$subtract);
225225
}
226226

227227
return $sequence;

‎src/functions.php‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ function interval_before($endDate, $duration): Period
9090

9191
/**
9292
* Creates new instance where the given duration is simultaneously
93-
* substracted from and added to the datepoint.
93+
* subtracted from and added to the datepoint.
9494
*
9595
* DEPRECATION WARNING! This function will be removed in the next major point release
9696
*

‎tests/Period/IntervalRelationTest.php‎

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -993,63 +993,64 @@ public function testDiffAndIntersect(): void
993993
}
994994
}
995995

996-
public function testSubstractWithOverlappingUnequalPeriods(): void
996+
public function testSubtractWithOverlappingUnequalPeriods(): void
997997
{
998998
$periodA = Period::after('2000-01-01 10:00:00', '8 HOURS');
999999
$periodB = Period::after('2000-01-01 14:00:00', '6 HOURS');
10001000

1001-
$diff1 = $periodA->substract($periodB);
1001+
$diff1 = $periodA->subtract($periodB);
10021002

10031003
self::assertCount(1, $diff1);
10041004
self::assertEquals($periodA->getStartDate(), $diff1[0]->getStartDate());
10051005
self::assertEquals($periodB->getStartDate(), $diff1[0]->getEndDate());
10061006

1007-
$diff2 = $periodB->substract($periodA);
1007+
$diff2 = $periodB->subtract($periodA);
10081008

10091009
self::assertCount(1, $diff2);
10101010
self::assertEquals($periodA->getEndDate(), $diff2[0]->getStartDate());
10111011
self::assertEquals($periodB->getEndDate(), $diff2[0]->getEndDate());
10121012
}
10131013

1014-
public function testSubstractWithSeparatePeriods(): void
1014+
public function testSubtractWithSeparatePeriods(): void
10151015
{
10161016
$periodA = Period::after('2000-01-01 10:00:00', '4 HOURS');
10171017
$periodB = Period::after('2000-01-01 15:00:00', '3 HOURS');
10181018

1019-
$diff1 = $periodA->substract($periodB);
1019+
$diff1 = $periodA->subtract($periodB);
10201020

10211021
self::assertCount(1, $diff1);
10221022
self::assertTrue($diff1[0]->equals($periodA));
10231023

1024-
$diff2 = $periodB->substract($periodA);
1024+
$diff2 = $periodB->subtract($periodA);
10251025

10261026
self::assertCount(1, $diff2);
10271027
self::assertTrue($diff2[0]->equals($periodB));
10281028
}
10291029

1030-
public function testSubstractWithOnePeriodContainedInAnother(): void
1030+
public function testSubtractWithOnePeriodContainedInAnother(): void
10311031
{
10321032
$periodA = Period::after('2000-01-01 10:00:00', '8 HOURS');
10331033
$periodB = Period::after('2000-01-01 15:00:00', '1 HOUR');
10341034

1035-
$diff1 = $periodA->substract($periodB);
1035+
$diff1 = $periodA->subtract($periodB);
10361036

10371037
self::assertCount(2, $diff1);
10381038
self::assertEquals($periodA->getStartDate(), $diff1[0]->getStartDate());
10391039
self::assertEquals($periodB->getStartDate(), $diff1[0]->getEndDate());
10401040
self::assertEquals($periodB->getEndDate(), $diff1[1]->getStartDate());
10411041
self::assertEquals($periodA->getEndDate(), $diff1[1]->getEndDate());
10421042

1043-
$diff2 = $periodB->substract($periodA);
1043+
$diff2 = $periodB->subtract($periodA);
10441044

10451045
self::assertCount(0, $diff2);
10461046
}
10471047

1048-
public function testSubstractWithEqualPeriodObjec(): void
1048+
public function testSubtractWithEqualPeriodObjec(): void
10491049
{
10501050
$periodA = Period::after('2000-01-01 10:00:00', '8 HOURS');
1051-
$diff = $periodA->substract($periodA);
1051+
$diff = $periodA->subtract($periodA);
10521052

10531053
self::assertCount(0, $diff);
1054+
self::assertEquals($diff, $periodA->substract($periodA));
10541055
}
10551056
}

‎tests/SequenceTest.php‎

Lines changed: 17 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -231,15 +231,15 @@ public function testEvery(): void
231231
}
232232

233233
/**
234-
* Substract test 1.
234+
* subtract test 1.
235235
*
236236
* [-------------) [------------)
237237
* -
238238
* [--) [---------------------)
239239
* =
240240
* [----) [----)
241241
*/
242-
public function testSubstract1(): void
242+
public function testSubtract1(): void
243243
{
244244
$sequenceA = new Sequence(
245245
new Period('2000-01-01', '2000-01-10'),
@@ -249,23 +249,24 @@ public function testSubstract1(): void
249249
new Period('2000-01-05', '2000-01-08'),
250250
new Period('2000-01-11', '2000-01-25')
251251
);
252-
$diff = $sequenceA->substract($sequenceB);
252+
$diff = $sequenceA->subtract($sequenceB);
253253

254254
self::assertCount(2, $diff);
255255
self::assertSame('[2000-01-01, 2000-01-05)', $diff->get(0)->format('Y-m-d'));
256256
self::assertSame('[2000-01-08, 2000-01-10)', $diff->get(1)->format('Y-m-d'));
257+
self::assertEquals($diff, $sequenceA->substract($sequenceB));
257258
}
258259

259260
/**
260-
* Substract test 2.
261+
* subtract test 2.
261262
*
262263
* [------) [------) [------)
263264
* -
264265
* [------------------------------------------)
265266
* =
266267
* ()
267268
*/
268-
public function testSubstract2(): void
269+
public function testSubtract2(): void
269270
{
270271
$sequenceA = new Sequence(
271272
new Period('2000-01-01', '2000-01-05'),
@@ -275,55 +276,55 @@ public function testSubstract2(): void
275276
$sequenceB = new Sequence(
276277
new Period('2000-01-01', '2000-01-30')
277278
);
278-
$diff = $sequenceA->substract($sequenceB);
279+
$diff = $sequenceA->subtract($sequenceB);
279280

280281
self::assertCount(0, $diff);
281282
}
282283

283284
/**
284-
* Substract test 3.
285+
* subtract test 3.
285286
*/
286-
public function testSubstract3(): void
287+
public function testSubtract3(): void
287288
{
288289
$sequenceA = new Sequence(
289290
new Period('2000-01-01', '2000-01-10'),
290291
new Period('2000-01-12', '2000-01-20')
291292
);
292293
$sequenceB = new Sequence();
293294

294-
$diff1 = $sequenceA->substract($sequenceB);
295+
$diff1 = $sequenceA->subtract($sequenceB);
295296
self::assertCount(2, $diff1);
296297
self::assertSame('[2000-01-01, 2000-01-10)', $diff1->get(0)->format('Y-m-d'));
297298
self::assertSame('[2000-01-12, 2000-01-20)', $diff1->get(1)->format('Y-m-d'));
298299

299-
$diff2 = $sequenceB->substract($sequenceA);
300+
$diff2 = $sequenceB->subtract($sequenceA);
300301
self::assertCount(0, $diff2);
301302
}
302303

303304
/**
304-
* Substract test 4.
305+
* subtract test 4.
305306
*/
306-
public function testSubstract4(): void
307+
public function testSubtract4(): void
307308
{
308309
$sequenceA = new Sequence(
309310
new Period('2000-01-01', '2000-01-10'),
310311
new Period('2000-01-12', '2000-01-20')
311312
);
312313
$sequenceB = new Sequence(new Period('2003-01-12', '2003-01-20'));
313-
self::assertSame($sequenceA, $sequenceA->substract($sequenceB));
314+
self::assertSame($sequenceA, $sequenceA->subtract($sequenceB));
314315
}
315316

316317
/**
317-
* Substract test 5.
318+
* subtract test 5.
318319
*/
319-
public function testSubstract5(): void
320+
public function testSubtract5(): void
320321
{
321322
$sequenceA = new Sequence(
322323
new Period('2000-01-01', '2000-01-10'),
323324
new Period('2001-01-01', '2001-01-10')
324325
);
325326
$sequenceB = new Sequence(new Period('2000-01-01', '2000-01-10'));
326-
self::assertCount(0, $sequenceB->substract($sequenceA));
327+
self::assertCount(0, $sequenceB->subtract($sequenceA));
327328
}
328329

329330
/**

0 commit comments

Comments
 (0)