Skip to content

Commit 4203053

Browse files
gregor-jgregor-j
committed
add parameter type declarations #6 
1 parent 1e31bb1 commit 4203053

File tree

3 files changed

+42
-42
lines changed

3 files changed

+42
-42
lines changed

‎src/SapDateTime.php‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -57,13 +57,13 @@ class SapDateTime extends DateTime
5757
/**
5858
* Parse an SAP week string into a new DateTime object.
5959
*
60-
* @param string $sapWeek String representing the SAP week.
61-
* @param DateTimeZone $timezone A DateTimeZone object representing the desired
60+
* @param string $sapWeek String representing the SAP week.
61+
* @param DateTimeZone|null $timezone A DateTimeZone object representing the desired
6262
* time zone.
6363
* @return DateTime|bool
6464
* @throws Exception
6565
*/
66-
public static function createFromSapWeek($sapWeek, $timezone = null)
66+
public static function createFromSapWeek(string $sapWeek, DateTimeZone $timezone = null)
6767
{
6868
if (preg_match(static::$sapWeekRegex, $sapWeek, $matches) !== 1) {
6969
return false;
@@ -77,7 +77,7 @@ public static function createFromSapWeek($sapWeek, $timezone = null)
7777
*
7878
* @param string $format Format accepted by date().
7979
* @param string $datetime String representing the time.
80-
* @param DateTimeZone $timezone A DateTimeZone object representing the desired
80+
* @param DateTimeZone|null $timezone A DateTimeZone object representing the desired
8181
* time zone.
8282
* @return DateTime|bool
8383
* @throws Exception
@@ -87,7 +87,7 @@ public static function createFromSapWeek($sapWeek, $timezone = null)
8787
public static function createFromFormat(
8888
$format,
8989
$datetime,
90-
$timezone = null
90+
DateTimeZone $timezone = null
9191
) {
9292
if ($format === static::SAP_WEEK) {
9393
return static::createFromSapWeek($datetime, $timezone);

‎tests/SapDateIntervalTest.php‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -43,13 +43,13 @@ public static function provideValidTimes()
4343

4444
/**
4545
* Test converting valid times from SAP to an ISO date and time after 2020-01-31.
46-
* @param string $sapTime
47-
* @param string $startDate
48-
* @param string $expected
46+
* @param string $sapTime
47+
* @param string $startDate
48+
* @param string $expected
4949
* @throws Exception
5050
* @dataProvider provideValidTimes
5151
*/
52-
public function testValidTimes($sapTime, $startDate, $expected)
52+
public function testValidTimes(string $sapTime, string $startDate, string $expected)
5353
{
5454
$dateTime = new DateTime($startDate);
5555
$time = SapDateInterval::createFromDateString($sapTime);

‎tests/SapDateTimeTest.php‎

Lines changed: 33 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -50,13 +50,13 @@ public static function validSapWeeks()
5050
/**
5151
* Test valid SAP week conversions.
5252
*
53-
* @param string $sapWeek The SAP week string.
54-
* @param string $expected The expected week in format <year>W<week>.
55-
* @param string $timestamp The expected timestamp in format Y-m-d H:i:s
53+
* @param string $sapWeek The SAP week string.
54+
* @param string $expected The expected week in format <year>W<week>.
55+
* @param string $timestamp The expected timestamp in format Y-m-d H:i:s
5656
* @dataProvider validSapWeeks
5757
* @throws Exception
5858
*/
59-
public function testParseSapWeeks($sapWeek, $expected, $timestamp)
59+
public function testParseSapWeeks(string $sapWeek, string $expected, string $timestamp)
6060
{
6161
$dateTime = SapDateTime::createFromFormat(SapDateTime::SAP_WEEK, $sapWeek);
6262
static::assertInstanceOf(DateTime::class, $dateTime);
@@ -82,11 +82,11 @@ public static function invalidSapWeeks()
8282
/**
8383
* Test valid SAP week conversions.
8484
*
85-
* @param string $sapWeek The SAP week string.
85+
* @param string $sapWeek The SAP week string.
8686
* @dataProvider invalidSapWeeks
8787
* @throws Exception
8888
*/
89-
public function testParseInvalidSapWeeks($sapWeek)
89+
public function testParseInvalidSapWeeks(string $sapWeek)
9090
{
9191
$dateTime = SapDateTime::createFromFormat(SapDateTime::SAP_WEEK, $sapWeek);
9292
static::assertFalse($dateTime);
@@ -111,12 +111,12 @@ public static function timestampsAndSapWeeks()
111111

112112
/**
113113
* Test formatting timestamps to SAP week strings.
114-
* @param string $timestamp Timestamp string
115-
* @param string $expected SAP week string
114+
* @param string $timestamp Timestamp string
115+
* @param string $expected SAP week string
116116
* @throws Exception
117117
* @dataProvider timestampsAndSapWeeks
118118
*/
119-
public function testCreateSapWeeks($timestamp, $expected)
119+
public function testCreateSapWeeks(string $timestamp, string $expected)
120120
{
121121
$dateTime = new SapDateTime($timestamp);
122122
$sapWeekString = $dateTime->format(SapDateTime::SAP_WEEK);
@@ -142,12 +142,12 @@ public static function sapDatesAndIsoDates()
142142

143143
/**
144144
* Test parsing SAP dates.
145-
* @param string $sapDate
146-
* @param string $isoDate
145+
* @param string $sapDate
146+
* @param string $isoDate
147147
* @throws Exception
148148
* @dataProvider sapDatesAndIsoDates
149149
*/
150-
public function testParseSapDates($sapDate, $isoDate)
150+
public function testParseSapDates(string $sapDate, string $isoDate)
151151
{
152152
$dateTime = SapDateTime::createFromFormat(SapDateTime::SAP_DATE, $sapDate);
153153
static::assertSame($isoDate, $dateTime->format('Y-m-d H:i:s'));
@@ -169,25 +169,25 @@ public static function timesAndSapTimes()
169169

170170
/**
171171
* Test formatting an ISO time as SAP time.
172-
* @param string $isoTime
173-
* @param string $sapTime
172+
* @param string $isoTime
173+
* @param string $sapTime
174174
* @throws Exception
175175
* @dataProvider timesAndSapTimes
176176
*/
177-
public function testCreateSapTimes($isoTime, $sapTime)
177+
public function testCreateSapTimes(string $isoTime, string $sapTime)
178178
{
179179
$dateTime = new SapDateTime($isoTime);
180180
static::assertSame($sapTime, $dateTime->format(SapDateTime::SAP_TIME));
181181
}
182182

183183
/**
184184
* Test reading time from SAP and formatting it as ISO.
185-
* @param string $isoTime
186-
* @param string $sapTime
185+
* @param string $isoTime
186+
* @param string $sapTime
187187
* @throws Exception
188188
* @dataProvider timesAndSapTimes
189189
*/
190-
public function testParseSapTimes($isoTime, $sapTime)
190+
public function testParseSapTimes(string $isoTime, string $sapTime)
191191
{
192192
$dateTime = SapDateTime::createFromFormat(SapDateTime::SAP_TIME, $sapTime);
193193
static::assertSame($isoTime, $dateTime->format('H:i:s'));
@@ -212,12 +212,12 @@ public static function timestampsAndSapDates()
212212

213213
/**
214214
* Test formatting DateTime objects as SAP dates.
215-
* @param string $timestamp
216-
* @param string $sapDate
215+
* @param string $timestamp
216+
* @param string $sapDate
217217
* @throws Exception
218218
* @dataProvider timestampsAndSapDates
219219
*/
220-
public function testCreateSapDates($timestamp, $sapDate)
220+
public function testCreateSapDates(string $timestamp, string $sapDate)
221221
{
222222
$dateTime = new SapDateTime($timestamp);
223223
static::assertSame($sapDate, $dateTime->format(SapDateTime::SAP_DATE));
@@ -242,25 +242,25 @@ public static function timestampsAndSapTimestamps()
242242

243243
/**
244244
* Test parsing SAP timestamps.
245-
* @param string $isotime
246-
* @param string $saptime
245+
* @param string $isotime
246+
* @param string $saptime
247247
* @throws Exception
248248
* @dataProvider timestampsAndSapTimestamps
249249
*/
250-
public function testParseSapTimestamps($isotime, $saptime)
250+
public function testParseSapTimestamps(string $isotime, string $saptime)
251251
{
252252
$dateTime = SapDateTime::createFromFormat(SapDateTime::SAP_TIMESTAMP, $saptime);
253253
static::assertSame($isotime, $dateTime->format('Y-m-d H:i:s'));
254254
}
255255

256256
/**
257257
* Test formatting DateTime objects as SAP timestamps.
258-
* @param string $isotime
259-
* @param string $saptime
258+
* @param string $isotime
259+
* @param string $saptime
260260
* @throws Exception
261261
* @dataProvider timestampsAndSapTimestamps
262262
*/
263-
public function testCreateSapTimestamps($isotime, $saptime)
263+
public function testCreateSapTimestamps(string $isotime, string $saptime)
264264
{
265265
$dateTime = new SapDateTime($isotime);
266266
static::assertSame($saptime, $dateTime->format(SapDateTime::SAP_TIMESTAMP));
@@ -300,14 +300,14 @@ public static function provideTimezones()
300300
/**
301301
* Test timezones.
302302
* @dataProvider provideTimezones
303-
* @param string $format
304-
* @param string $time
305-
* @param DateTimeZone $zone
306-
* @param string $expected
307-
* @param string $utc
303+
* @param string $format
304+
* @param string $time
305+
* @param DateTimeZone $zone
306+
* @param string $expected
307+
* @param string $utc
308308
* @throws Exception
309309
*/
310-
public function testTimezones($format, $time, $zone, $expected, $utc)
310+
public function testTimezones(string $format, string $time, DateTimeZone $zone, string $expected, string $utc)
311311
{
312312
$dateTime = SapDateTime::createFromFormat($format, $time, $zone);
313313
static::assertSame($expected, $dateTime->format('c'));

0 commit comments

Comments
 (0)