<?php
/**
* iCalcreator, the PHP class package managing iCal (rfc2445/rfc5445) calendar information.
*
* This file is a part of iCalcreator.
*
* @author Kjell-Inge Gustafsson, kigkonsult <ical@kigkonsult.se>
* @copyright 2007-2022 Kjell-Inge Gustafsson, kigkonsult, All rights reserved
* @link https://kigkonsult.se
* @license Subject matter of licence is the software iCalcreator.
* The above copyright, link, package and version notices,
* this licence notice and the invariant [rfc5545] PRODID result use
* as implemented and invoked in iCalcreator shall be included in
* all copies or substantial portions of the iCalcreator.
*
* iCalcreator is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation, either version 3 of
* the License, or (at your option) any later version.
*
* iCalcreator is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with iCalcreator. If not, see <https://www.gnu.org/licenses/>.
*/
namespace Kigkonsult\Icalcreator;
use DateTime;
use Exception;
use InvalidArgumentException;
use Kigkonsult\Icalcreator\Util\DateTimeFactory;
use Kigkonsult\Icalcreator\Util\StringFactory;
/**
* class DateTest, testing VALUE DATE, also empty value, DTSTART, DTEND, DUE, RECURRENCE_ID, (single) EXDATE + RDATE
*
* @since 2.27.14 - 2019-01-24
*/
class DateTest extends DtBase
{
private static array $compsProps = [
IcalInterface::VEVENT => [
IcalInterface::DTSTART,
IcalInterface::DTEND,
IcalInterface::RECURRENCE_ID,
IcalInterface::EXDATE,
IcalInterface::RDATE
],
IcalInterface::VTODO => [ IcalInterface::DTSTART, IcalInterface::DUE, IcalInterface::RECURRENCE_ID ],
IcalInterface::VJOURNAL => [ IcalInterface::DTSTART, IcalInterface::RECURRENCE_ID ],
// IcalInterface::VAVAILABILITY => [ IcalInterface::DTSTART, IcalInterface::DTEND ], datetime required
];
private static array $compsProps2 = [
IcalInterface::VEVENT => [ IcalInterface::EXDATE, IcalInterface::RDATE ],
IcalInterface::AVAILABLE => [ IcalInterface::EXDATE, IcalInterface::RDATE ]
];
private static array $compsProps3 = [
IcalInterface::VEVENT => [ IcalInterface::LAST_MODIFIED, IcalInterface::CREATED ],
IcalInterface::VTODO => [ IcalInterface::LAST_MODIFIED, IcalInterface::CREATED, IcalInterface::COMPLETED ],
];
/**
* Test date isPropSet Methods and properties with no-args set-method (i.e. 'now')
*
* @test
* @throws Exception
*/
public function isPropSetTest1() : void
{
foreach( self::$compsProps as $theComp => $propNames ) {
$this->isPropSetTest2( 1, $theComp, $propNames );
}
foreach( self::$compsProps2 as $theComp => $propNames ) {
$this->isPropSetTest2( 2, $theComp, $propNames );
}
foreach( self::$compsProps3 as $theComp => $propNames ) {
$vcalendar = new Vcalendar();
$comp = $vcalendar->{'new' . $theComp}();
foreach( $propNames as $propName ) {
$isPropSetMethod = StringFactory::getIsMethodSetName( $propName );
$setMethod = StringFactory::getSetMethodName( $propName );
$this->assertFalse(
$comp->{$isPropSetMethod}(),
'error case 3-1 ' . $comp->getCompType() . '::' . $propName . ', expected false'
);
if(( IcalInterface::VTODO === $theComp ) && ( IcalInterface::COMPLETED === $propName )) {
$comp->{$setMethod}( new dateTime());
}
else {
$comp->{$setMethod}();
}
$this->assertTrue(
$comp->{$isPropSetMethod}(),
'error case 3-2 ' . $comp->getCompType() . '::' . $propName . ', expected true'
);
}
}
}
/**
* @param int $case
* @param string $theComp
* @param array $propNames
* @throws Exception
*/
private function isPropSetTest2( int $case, string $theComp, array $propNames ) : void
{
$case += 10;
$vcalendar = new Vcalendar();
$newMethod = 'new' . $theComp;
$comp = match ( true ) {
IcalInterface::PARTICIPANT === $theComp => $vcalendar->newVevent()->{$newMethod}(),
IcalInterface::AVAILABLE === $theComp => $vcalendar->newVavailability()->{$newMethod}(),
default => $vcalendar->{$newMethod}(),
};
$this->assertTrue(
$comp->isUidSet(),
'error case ' . $case . '-1 ' . $theComp . '::dtstart, expected true'
);
$this->assertTrue(
$comp->isDtstampSet(),
'error case ' . $case . '-2 ' . $theComp . '::dtstart, expected true'
);
$this->isPropSetTest3( $case, $comp, $propNames );
}
/**
* @param int $case
* @param CalendarComponent $comp
* @param array $propNames
*/
private function isPropSetTest3( int $case, CalendarComponent $comp, array $propNames ) : void
{
$case += 100;
$dateTime = new DateTime();
foreach( $propNames as $propName ) {
$isPropSetMethod = StringFactory::getIsMethodSetName( $propName );
$setMethod = StringFactory::getSetMethodName( $propName );
$this->assertFalse(
$comp->{$isPropSetMethod}(),
'error case ' . $case . '-11 ' . $comp->getCompType() . '::' . $propName . ', expected false'
);
$comp->{$setMethod}( $dateTime );
$this->assertTrue(
$comp->{$isPropSetMethod}(),
'error case ' . $case . '-12 ' . $comp->getCompType() . '::' . $propName . ', expected true'
);
}
}
/**
* DATEtest provider
*
* @return mixed[]
* @throws Exception
*/
public function DATEtestProvider() : array
{
$dataArr = [];
$dataArr[] = [ // test set #100 empty
100,
null,
null,
Pc::factory()->setEmpty(),
':'
];
$dateTime = DateTimeFactory::factory( DATEYmd );
$dataArr[] = [ // test set #101 DateTime
101,
$dateTime,
[ IcalInterface::VALUE => IcalInterface::DATE ],
Pc::factory(
clone $dateTime,
[ IcalInterface::VALUE => IcalInterface::DATE ]
),
$this->getDateTimeAsCreateShortString( $dateTime )
];
$dateTime = DateTimeFactory::factory( DATEYmdTHis );
$dataArr[] = [ // test set #102 DateTime
102,
$dateTime,
[ IcalInterface::VALUE => IcalInterface::DATE ],
Pc::factory(
clone $dateTime,
[ IcalInterface::VALUE => IcalInterface::DATE ]
),
$this->getDateTimeAsCreateShortString( $dateTime )
];
$dateTime = DateTimeFactory::factory( DATEYmdTHis . ' ' . LTZ );
$dataArr[] = [ // test set #103 DateTime
103,
$dateTime,
[],
Pc::factory(
clone $dateTime,
[ IcalInterface::TZID => LTZ ]
),
$this->getDateTimeAsCreateLongString( clone $dateTime, LTZ)
];
$dateTime = DateTimeFactory::factory( DATEYmd );
$dataArr[] = [ // test set #114 string
114,
DATEYmd,
[ IcalInterface::VALUE => IcalInterface::DATE ],
Pc::factory(
$dateTime,
[ IcalInterface::VALUE => IcalInterface::DATE ]
),
$this->getDateTimeAsCreateShortString( $dateTime )
];
$dateTime = DateTimeFactory::factory( DATEYmdTHis );
$dataArr[] = [ // test set #115 string
115,
DATEYmdTHis,
[ IcalInterface::VALUE => IcalInterface::DATE ],
Pc::factory(
$dateTime,
[ IcalInterface::VALUE => IcalInterface::DATE ]
),
$this->getDateTimeAsCreateShortString( $dateTime )
];
$dateTime = DateTimeFactory::factory( DATEYmdTHis, IcalInterface::UTC );
$dataArr[] = [ // test set #116 string
116,
DATEYmdTHis,
[],
Pc::factory(
$dateTime,
[]
),
$this->getDateTimeAsCreateLongString( $dateTime )
];
$dateTime = DateTimeFactory::factory( DATEYmdTHis, IcalInterface::UTC );
$dataArr[] = [ // test set #117 string
117,
DATEYmdTHis . 'Z',
[ IcalInterface::VALUE => IcalInterface::DATE ],
Pc::factory(
$dateTime,
[ IcalInterface::VALUE => IcalInterface::DATE ]
),
$this->getDateTimeAsCreateShortString( $dateTime )
];
$dateTime = DateTimeFactory::factory( DATEYmdTHis, IcalInterface::UTC );
$dataArr[] = [ // test set #118 string
118,
DATEYmdTHis . 'Z',
[],
Pc::factory(
$dateTime,
[]
),
$this->getDateTimeAsCreateLongString( $dateTime, IcalInterface::UTC )
];
$dateTime = DateTimeFactory::factory( '20160305' );
for( $x = 1; $x < 10; $x++ ) {
$dataArr[] = [ // test set #101 DateTime
200 + $x,
$dateTime->format( 'Ymd' ),
[ IcalInterface::VALUE => IcalInterface::DATE ],
Pc::factory(
clone $dateTime,
[ IcalInterface::VALUE => IcalInterface::DATE ]
),
$this->getDateTimeAsCreateShortString( $dateTime )
];
$dateTime->modify( '-1 day ' );
} // end for
$dateTime = DateTimeFactory::factory( '20160305' );
foreach( self::$DATECONSTANTFORMTS as $x => $format ) {
$dataArr[] = [ // test set #101 DateTime
301 + $x,
$dateTime->format( $format ),
[ IcalInterface::VALUE => IcalInterface::DATE ],
Pc::factory(
clone $dateTime,
[ IcalInterface::VALUE => IcalInterface::DATE ]
),
$this->getDateTimeAsCreateShortString( $dateTime )
];
} // end for
return $dataArr;
}
/**
* Testing VALUE DATE, also empty value, DTSTART, DTEND, DUE, RECURRENCE_ID, (single) EXDATE + RDATE
*
* @test
* @dataProvider DATEtestProvider
* @param int $case
* @param mixed $value
* @param mixed $params
* @param Pc $expectedGet
* @param string $expectedString
* @throws Exception
* @throws InvalidArgumentException
*/
public function DATEtest(
int $case,
mixed $value,
mixed $params,
Pc $expectedGet,
string $expectedString
) : void
{
// error_log( __FUNCTION__ . ' start #' . $case .
// ' value : ' . var_export( $value, true ) .
// ' params : ' . var_export( $params, true )); // test ###
$this->thePropTest( $case, self::$compsProps, $value, $params, $expectedGet, $expectedString );
$this->propGetNoParamsTest( $case, self::$compsProps, $value, $params, $expectedGet );
$this->exdateRdateSpecTest( $case, self::$compsProps2, $value, $params, $expectedGet, $expectedString );
}
/**
* testRexDATE provider
*
* @return mixed[]
* @throws Exception
*/
public function RexDATEtestProvider() : array
{
$dataArr = [];
$dateTime = DateTimeFactory::factory( DATEYmd );
$dataArr[] = [ // test set #101 DateTime
101,
[ clone $dateTime, clone $dateTime ],
[ IcalInterface::VALUE => IcalInterface::DATE ],
Pc::factory(
[ clone $dateTime, clone $dateTime ],
[ IcalInterface::VALUE => IcalInterface::DATE ]
),
$this->getDateTimeAsCreateShortString( clone $dateTime ) . ',' . $dateTime->format( DateTimeFactory::$Ymd )
];
$dateTime = DateTimeFactory::factory( DATEYmdTHis );
$dataArr[] = [ // test set #102 DateTime
102,
[ clone $dateTime, clone $dateTime ],
[ IcalInterface::VALUE => IcalInterface::DATE ],
Pc::factory(
[ clone $dateTime, clone $dateTime ],
[ IcalInterface::VALUE => IcalInterface::DATE ]
),
$this->getDateTimeAsCreateShortString( $dateTime ) . ',' . $dateTime->format( DateTimeFactory::$Ymd )
];
$dateTime = DateTimeFactory::factory( DATEYmdTHis . ' ' . LTZ );
$dataArr[] = [ // test set #103 DateTime
103,
[ clone $dateTime, clone $dateTime ],
[],
Pc::factory(
[ clone $dateTime, clone $dateTime ],
[ IcalInterface::TZID => LTZ ]
),
$this->getDateTimeAsCreateLongString( clone $dateTime, LTZ) . ',' . $dateTime->format( DateTimeFactory::$YmdTHis )
];
$dateTime = DateTimeFactory::factory( DATEYmd );
$dateTime2 = DateTimeFactory::factory( DATEYmd, IcalInterface::UTC );
$dataArr[] = [ // test set #114 string
114,
[ DATEYmd, DATEYmd ],
[ IcalInterface::VALUE => IcalInterface::DATE ],
Pc::factory(
[ (clone $dateTime2), (clone $dateTime2) ],
[ IcalInterface::VALUE => IcalInterface::DATE ]
),
$this->getDateTimeAsCreateShortString( $dateTime ) . ',' . $dateTime->format( DateTimeFactory::$Ymd )
];
$dateTime = DateTimeFactory::factory( DATEYmdTHis );
$dateTime2 = DateTimeFactory::factory( DATEYmdTHis, IcalInterface::UTC );
$dataArr[] = [ // test set #115 string
115,
[ DATEYmdTHis, DATEYmdTHis ],
[ IcalInterface::VALUE => IcalInterface::DATE ],
Pc::factory(
[ (clone $dateTime2), (clone $dateTime2) ],
[ IcalInterface::VALUE => IcalInterface::DATE ]
),
$this->getDateTimeAsCreateShortString( $dateTime ) . ',' . $dateTime->format( DateTimeFactory::$Ymd )
];
$dateTime = DateTimeFactory::factory( DATEYmdTHis, IcalInterface::UTC );
$dataArr[] = [ // test set #116 string
116,
[ DATEYmdTHis, DATEYmdTHis ],
[],
Pc::factory(
[ clone $dateTime, clone $dateTime ],
[ IcalInterface::ISLOCALTIME => true ]
),
$this->getDateTimeAsCreateLongString( $dateTime ) . ',' . $dateTime->format( DateTimeFactory::$YmdTHis )
];
$dateTime = DateTimeFactory::factory( DATEYmdTHis, IcalInterface::UTC );
$dataArr[] = [ // test set #117 string
117,
[ DATEYmdTHis . 'Z', DATEYmdTHis . 'Z' ],
[ IcalInterface::VALUE => IcalInterface::DATE ],
Pc::factory(
[ clone $dateTime, clone $dateTime ],
[ IcalInterface::VALUE => IcalInterface::DATE ]
),
$this->getDateTimeAsCreateShortString( $dateTime ) . ',' . $dateTime->format( DateTimeFactory::$Ymd )
];
$dateTime = DateTimeFactory::factory( DATEYmdTHis, IcalInterface::UTC );
$dataArr[] = [ // test set #118 string
118,
[ DATEYmdTHis . 'Z', DATEYmdTHis . 'Z' ],
[],
Pc::factory(
[ clone $dateTime, clone $dateTime ],
[]
),
$this->getDateTimeAsCreateLongString( $dateTime, IcalInterface::UTC ) .
',' . $dateTime->format( DateTimeFactory::$YmdTHis ) . 'Z'
];
$dateTime = DateTimeFactory::factory( '20160305' );
for( $x = 1; $x < 10; $x++ ) {
$dateTime2 = DateTimeFactory::factory( $dateTime->format( DateTimeFactory::$YmdTHis ), IcalInterface::UTC );
$dataArr[] = [ // test set #101 DateTime
200 + $x,
[ $dateTime->format( 'Ymd' ), $dateTime->format( 'Ymd' ) ],
[ IcalInterface::VALUE => IcalInterface::DATE ],
Pc::factory(
[ (clone $dateTime2), (clone $dateTime2) ],
[ IcalInterface::VALUE => IcalInterface::DATE ]
),
$this->getDateTimeAsCreateShortString( $dateTime ) . ',' . $dateTime->format( DateTimeFactory::$Ymd )
];
$dateTime->modify( '-1 day ' );
} // end for
return $dataArr;
}
/**
* Testing VALUE DATE (multi) EXDATE + RDATE
*
* @test
* @dataProvider RexDATEtestProvider
* @param int $case
* @param mixed $value
* @param mixed $params
* @param Pc $expectedGet
* @param string $expectedString
* @throws Exception
* @throws InvalidArgumentException
*/
public function rexDATEtest(
int $case,
mixed $value,
mixed $params,
Pc $expectedGet,
string $expectedString
) : void
{
$c = new Vcalendar();
foreach( self::$compsProps2 as $theComp => $props ) {
$newMethod = 'new' . $theComp;
if( IcalInterface::AVAILABLE === $theComp ) {
$comp = $c->newVavailability()->{$newMethod}();
}
else {
$comp = $c->{$newMethod}();
}
foreach( $props as $propName ) {
[ , , $getMethod, $isMethod, $setMethod ] = self::getPropMethodnames( $propName );
$this->assertFalse(
$comp->{$isMethod}(),
self::getErrMsg( __FUNCTION__, $case . '-1', __FUNCTION__, $theComp, $isMethod )
);
$comp->{$setMethod}( $value, $params );
$this->assertTrue(
$comp->{$isMethod}(),
self::getErrMsg( __FUNCTION__, $case . '-2', __FUNCTION__, $theComp, $isMethod )
);
$getValue = $comp->{$getMethod}( null, true );
$this->assertEquals(
$expectedGet,
$getValue,
self::getErrMsg( __FUNCTION__, $case . '-3', __FUNCTION__, $theComp, $getMethod )
. PHP_EOL . 'expectedGet : ' . var_export( $expectedGet, true )
. PHP_EOL . 'getValue : ' . var_export( $getValue, true )
);
} // end foreach propName
} // end foreach
$this->parseCalendarTest( $case, $c, $expectedString );
}
}