| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307 |
- <?php
- namespace PhpOffice\PhpSpreadsheet\Calculation\DateTimeExcel;
- use DateTime;
- use PhpOffice\PhpSpreadsheet\Calculation\Exception;
- use PhpOffice\PhpSpreadsheet\Calculation\Functions;
- use PhpOffice\PhpSpreadsheet\Calculation\Information\ExcelError;
- use PhpOffice\PhpSpreadsheet\Shared\Date as SharedDateHelper;
- class Helpers
- {
- /**
- * Identify if a year is a leap year or not.
- *
- * @param int|string $year The year to test
- *
- * @return bool TRUE if the year is a leap year, otherwise FALSE
- */
- public static function isLeapYear($year): bool
- {
- return (($year % 4) === 0) && (($year % 100) !== 0) || (($year % 400) === 0);
- }
- /**
- * getDateValue.
- *
- * @param mixed $dateValue
- *
- * @return float Excel date/time serial value
- */
- public static function getDateValue($dateValue, bool $allowBool = true): float
- {
- if (is_object($dateValue)) {
- $retval = SharedDateHelper::PHPToExcel($dateValue);
- if (is_bool($retval)) {
- throw new Exception(ExcelError::VALUE());
- }
- return $retval;
- }
- self::nullFalseTrueToNumber($dateValue, $allowBool);
- if (!is_numeric($dateValue)) {
- $saveReturnDateType = Functions::getReturnDateType();
- Functions::setReturnDateType(Functions::RETURNDATE_EXCEL);
- $dateValue = DateValue::fromString($dateValue);
- Functions::setReturnDateType($saveReturnDateType);
- if (!is_numeric($dateValue)) {
- throw new Exception(ExcelError::VALUE());
- }
- }
- if ($dateValue < 0 && Functions::getCompatibilityMode() !== Functions::COMPATIBILITY_OPENOFFICE) {
- throw new Exception(ExcelError::NAN());
- }
- return (float) $dateValue;
- }
- /**
- * getTimeValue.
- *
- * @param string $timeValue
- *
- * @return mixed Excel date/time serial value, or string if error
- */
- public static function getTimeValue($timeValue)
- {
- $saveReturnDateType = Functions::getReturnDateType();
- Functions::setReturnDateType(Functions::RETURNDATE_EXCEL);
- $timeValue = TimeValue::fromString($timeValue);
- Functions::setReturnDateType($saveReturnDateType);
- return $timeValue;
- }
- /**
- * Adjust date by given months.
- *
- * @param mixed $dateValue
- */
- public static function adjustDateByMonths($dateValue = 0, float $adjustmentMonths = 0): DateTime
- {
- // Execute function
- $PHPDateObject = SharedDateHelper::excelToDateTimeObject($dateValue);
- $oMonth = (int) $PHPDateObject->format('m');
- $oYear = (int) $PHPDateObject->format('Y');
- $adjustmentMonthsString = (string) $adjustmentMonths;
- if ($adjustmentMonths > 0) {
- $adjustmentMonthsString = '+' . $adjustmentMonths;
- }
- if ($adjustmentMonths != 0) {
- $PHPDateObject->modify($adjustmentMonthsString . ' months');
- }
- $nMonth = (int) $PHPDateObject->format('m');
- $nYear = (int) $PHPDateObject->format('Y');
- $monthDiff = ($nMonth - $oMonth) + (($nYear - $oYear) * 12);
- if ($monthDiff != $adjustmentMonths) {
- $adjustDays = (int) $PHPDateObject->format('d');
- $adjustDaysString = '-' . $adjustDays . ' days';
- $PHPDateObject->modify($adjustDaysString);
- }
- return $PHPDateObject;
- }
- /**
- * Help reduce perceived complexity of some tests.
- *
- * @param mixed $value
- * @param mixed $altValue
- */
- public static function replaceIfEmpty(&$value, $altValue): void
- {
- $value = $value ?: $altValue;
- }
- /**
- * Adjust year in ambiguous situations.
- */
- public static function adjustYear(string $testVal1, string $testVal2, string &$testVal3): void
- {
- if (!is_numeric($testVal1) || $testVal1 < 31) {
- if (!is_numeric($testVal2) || $testVal2 < 12) {
- if (is_numeric($testVal3) && $testVal3 < 12) {
- $testVal3 += 2000;
- }
- }
- }
- }
- /**
- * Return result in one of three formats.
- *
- * @return mixed
- */
- public static function returnIn3FormatsArray(array $dateArray, bool $noFrac = false)
- {
- $retType = Functions::getReturnDateType();
- if ($retType === Functions::RETURNDATE_PHP_DATETIME_OBJECT) {
- return new DateTime(
- $dateArray['year']
- . '-' . $dateArray['month']
- . '-' . $dateArray['day']
- . ' ' . $dateArray['hour']
- . ':' . $dateArray['minute']
- . ':' . $dateArray['second']
- );
- }
- $excelDateValue =
- SharedDateHelper::formattedPHPToExcel(
- $dateArray['year'],
- $dateArray['month'],
- $dateArray['day'],
- $dateArray['hour'],
- $dateArray['minute'],
- $dateArray['second']
- );
- if ($retType === Functions::RETURNDATE_EXCEL) {
- return $noFrac ? floor($excelDateValue) : (float) $excelDateValue;
- }
- // RETURNDATE_UNIX_TIMESTAMP)
- return (int) SharedDateHelper::excelToTimestamp($excelDateValue);
- }
- /**
- * Return result in one of three formats.
- *
- * @return mixed
- */
- public static function returnIn3FormatsFloat(float $excelDateValue)
- {
- $retType = Functions::getReturnDateType();
- if ($retType === Functions::RETURNDATE_EXCEL) {
- return $excelDateValue;
- }
- if ($retType === Functions::RETURNDATE_UNIX_TIMESTAMP) {
- return (int) SharedDateHelper::excelToTimestamp($excelDateValue);
- }
- // RETURNDATE_PHP_DATETIME_OBJECT
- return SharedDateHelper::excelToDateTimeObject($excelDateValue);
- }
- /**
- * Return result in one of three formats.
- *
- * @return mixed
- */
- public static function returnIn3FormatsObject(DateTime $PHPDateObject)
- {
- $retType = Functions::getReturnDateType();
- if ($retType === Functions::RETURNDATE_PHP_DATETIME_OBJECT) {
- return $PHPDateObject;
- }
- if ($retType === Functions::RETURNDATE_EXCEL) {
- return (float) SharedDateHelper::PHPToExcel($PHPDateObject);
- }
- // RETURNDATE_UNIX_TIMESTAMP
- $stamp = SharedDateHelper::PHPToExcel($PHPDateObject);
- $stamp = is_bool($stamp) ? ((int) $stamp) : $stamp;
- return (int) SharedDateHelper::excelToTimestamp($stamp);
- }
- private static function baseDate(): int
- {
- if (Functions::getCompatibilityMode() === Functions::COMPATIBILITY_OPENOFFICE) {
- return 0;
- }
- if (SharedDateHelper::getExcelCalendar() === SharedDateHelper::CALENDAR_MAC_1904) {
- return 0;
- }
- return 1;
- }
- /**
- * Many functions accept null/false/true argument treated as 0/0/1.
- *
- * @param mixed $number
- */
- public static function nullFalseTrueToNumber(&$number, bool $allowBool = true): void
- {
- $number = Functions::flattenSingleValue($number);
- $nullVal = self::baseDate();
- if ($number === null) {
- $number = $nullVal;
- } elseif ($allowBool && is_bool($number)) {
- $number = $nullVal + (int) $number;
- }
- }
- /**
- * Many functions accept null argument treated as 0.
- *
- * @param mixed $number
- *
- * @return float|int
- */
- public static function validateNumericNull($number)
- {
- $number = Functions::flattenSingleValue($number);
- if ($number === null) {
- return 0;
- }
- if (is_int($number)) {
- return $number;
- }
- if (is_numeric($number)) {
- return (float) $number;
- }
- throw new Exception(ExcelError::VALUE());
- }
- /**
- * Many functions accept null/false/true argument treated as 0/0/1.
- *
- * @param mixed $number
- *
- * @return float
- */
- public static function validateNotNegative($number)
- {
- if (!is_numeric($number)) {
- throw new Exception(ExcelError::VALUE());
- }
- if ($number >= 0) {
- return (float) $number;
- }
- throw new Exception(ExcelError::NAN());
- }
- public static function silly1900(DateTime $PHPDateObject, string $mod = '-1 day'): void
- {
- $isoDate = $PHPDateObject->format('c');
- if ($isoDate < '1900-03-01') {
- $PHPDateObject->modify($mod);
- }
- }
- public static function dateParse(string $string): array
- {
- return self::forceArray(date_parse($string));
- }
- public static function dateParseSucceeded(array $dateArray): bool
- {
- return $dateArray['error_count'] === 0;
- }
- /**
- * Despite documentation, date_parse probably never returns false.
- * Just in case, this routine helps guarantee it.
- *
- * @param array|false $dateArray
- */
- private static function forceArray($dateArray): array
- {
- return is_array($dateArray) ? $dateArray : ['error_count' => 1];
- }
- }
|