Skip to content

Commit 350c9ec

Browse files
committed
Updating some docblocks with additional usage details
1 parent cd181ab commit 350c9ec

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

src/PhpSpreadsheet/Shared/Date.php

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -160,7 +160,9 @@ private static function validateTimeZone($timeZone)
160160
}
161161

162162
/**
163-
* @param mixed $value
163+
* @param mixed $value Converts a date/time in ISO-8601 standard format date string to an Excel
164+
* serialized timestamp.
165+
* See https://en.wikipedia.org/wiki/ISO_8601 for details of the ISO-8601 standard format.
164166
*
165167
* @return float|int
166168
*/
@@ -194,8 +196,8 @@ public static function convertIsoDate($value)
194196
*
195197
* @param float|int $excelTimestamp MS Excel serialized date/time value
196198
* @param null|DateTimeZone|string $timeZone The timezone to assume for the Excel timestamp,
197-
* if you don't want to treat it as a UTC value
198-
* Use the default (UTC) unless you absolutely need a conversion
199+
* if you don't want to treat it as a UTC value
200+
* Use the default (UTC) unless you absolutely need a conversion
199201
*
200202
* @return DateTime PHP date/time object
201203
*/
@@ -243,8 +245,8 @@ public static function excelToDateTimeObject($excelTimestamp, $timeZone = null)
243245
*
244246
* @param float|int $excelTimestamp MS Excel serialized date/time value
245247
* @param null|DateTimeZone|string $timeZone The timezone to assume for the Excel timestamp,
246-
* if you don't want to treat it as a UTC value
247-
* Use the default (UTC) unless you absolutely need a conversion
248+
* if you don't want to treat it as a UTC value
249+
* Use the default (UTC) unless you absolutely need a conversion
248250
*
249251
* @return int Unix timetamp for this date/time
250252
*/
@@ -395,7 +397,7 @@ public static function isDateTime(Cell $cell, $value = null, bool $dateWithoutTi
395397
}
396398

397399
/**
398-
* Is a given number format a date/time?
400+
* Is a given NumberFormat code a date/time format code?
399401
*
400402
* @return bool
401403
*/

0 commit comments

Comments
 (0)