ZCiCal::addDataNode

Author: phpfui

examples/simpleEvent.ics

@@ -1,15 +1,16 @@
 BEGIN:VCALENDAR
 VERSION:2.0
+NAME:My Calendar Name
 PRODID:-//ZContent.net//ZapCalLib 1.0//EN
 CALSCALE:GREGORIAN
 METHOD:PUBLISH
 BEGIN:VEVENT
 SUMMARY:Simple Event
 DTSTART:20200101T120000
 DTEND:20200101T130000
-UID:2023-02-14-02-16-35@demo.icalendar.org
-DTSTAMP:20230214T021635
-Description: This is a simple event, using the Zap Calendar PHP lib 
-rary. Visit http://icalendar.org to validate icalendar files.
+UID:2024-12-26-15-58-12@demo.icalendar.org
+DTSTAMP:20241226T155812
+Description: This is a simple event, using the Zap Calendar PHP lib
+ rary. Visit http://icalendar.org to validate icalendar files.
 END:VEVENT
 END:VCALENDAR

examples/simpleevent.php

@@ -1,4 +1,5 @@
 <?php
+
 /**
  * simpleevent.php
  *
@@ -25,6 +26,9 @@
 // create the ical object
 $icalobj = new \ICalendarOrg\ZCiCal();
 
+// add name
+$icalobj->addDataNode(new \ICalendarOrg\ZCiCalDataNode('NAME:My Calendar Name'), new \ICalendarOrg\ZCiCalDataNode('PRODID:-//ZContent.net//ZapCalLib 1.0//EN'));
+
 // create the event within the ical object
 $eventobj = new \ICalendarOrg\ZCiCalNode('VEVENT', $icalobj->curnode);
 

src/ICalendarOrg/ZCiCal.php

@@ -1,4 +1,5 @@
 <?php
+
 /**
  * Create iCalendar data structure
  *
@@ -210,16 +211,33 @@ public function __construct(string $data = '', int $maxevents = 1_000_000, int $
 			$name = 'VCALENDAR';
 			$this->curnode = new \ICalendarOrg\ZCiCalNode($name, $this->curnode);
 			$this->tree = $this->curnode;
-			$datanode = new \ICalendarOrg\ZCiCalDataNode('VERSION:2.0');
-			$this->curnode->data[$datanode->getName()] = $datanode;
-
-			$datanode = new \ICalendarOrg\ZCiCalDataNode('PRODID:-//ZContent.net//ZapCalLib 1.0//EN');
-			$this->curnode->data[$datanode->getName()] = $datanode;
-			$datanode = new \ICalendarOrg\ZCiCalDataNode('CALSCALE:GREGORIAN');
-			$this->curnode->data[$datanode->getName()] = $datanode;
-			$datanode = new \ICalendarOrg\ZCiCalDataNode('METHOD:PUBLISH');
-			$this->curnode->data[$datanode->getName()] = $datanode;
+			$this->addDataNode(new \ICalendarOrg\ZCiCalDataNode('VERSION:2.0'));
+			$this->addDataNode(new \ICalendarOrg\ZCiCalDataNode('PRODID:-//ZContent.net//ZapCalLib 1.0//EN'));
+			$this->addDataNode(new \ICalendarOrg\ZCiCalDataNode('CALSCALE:GREGORIAN'));
+			$this->addDataNode(new \ICalendarOrg\ZCiCalDataNode('METHOD:PUBLISH'));
+			}
+		}
+
+	public function addDataNode(\ICalendarOrg\ZCiCalDataNode $dataNode, ?\ICalendarOrg\ZCiCalDataNode $beforeNode = null) : ZCiCal
+		{
+		if (! $beforeNode)
+			{
+			$this->tree->data[$dataNode->getName()] = $dataNode;
+
+			return $this;
+			}
+
+		// add name
+		$insertPosition = \array_search($beforeNode->getName(), \array_keys($this->tree->data));
+
+		if (false === $insertPosition)
+			{
+			throw new \UnexpectedValueException('Node ' . $beforeNode->getName() . ' not found in ' . __CLASS__);
 			}
+		// Create a new array with the new element inserted
+		$this->tree->data = \array_slice($this->tree->data, 0, $insertPosition) + [$dataNode->getName() => $dataNode] + \array_slice($this->tree->data, $insertPosition);
+
+		return $this;
 		}
 
 	/**

tests/SimpleEventTest.php

@@ -0,0 +1,60 @@
+<?php
+
+/**
+ * This file is part of the ICalendarOrg package
+ *
+ * (c) Bruce Wells
+ *
+ * For the full copyright and license information, please view
+ * the LICENSE file that was distributed with this source
+ * code
+ */
+class SimpleEventTest extends \PHPUnit\Framework\TestCase
+	{
+	public function testAddInvalidNode() : void
+		{
+		$this->expectException(\UnexpectedValueException::class);
+		$icalobj = new \ICalendarOrg\ZCiCal();
+
+		$icalobj->addDataNode(new \ICalendarOrg\ZCiCalDataNode('NAME:My Calendar Name'), new \ICalendarOrg\ZCiCalDataNode('FRED:Flintstone'));
+		}
+
+	public function testSimpleEvent() : void
+		{
+		$title = 'Simple Event';
+		// date/time is in SQL datetime format
+		$event_start = '2020-01-01 12:00:00';
+		$event_end = '2020-01-01 13:00:00';
+
+		// create the ical object
+		$icalobj = new \ICalendarOrg\ZCiCal();
+
+		// add name
+		$icalobj->addDataNode(new \ICalendarOrg\ZCiCalDataNode('NAME:My Calendar Name'), new \ICalendarOrg\ZCiCalDataNode('PRODID:-//ZContent.net//ZapCalLib 1.0//EN'));
+
+		// create the event within the ical object
+		$eventobj = new \ICalendarOrg\ZCiCalNode('VEVENT', $icalobj->curnode);
+
+		$eventobj->addNode(new \ICalendarOrg\ZCiCalDataNode('SUMMARY:' . $title));
+
+		// add start date
+		$eventobj->addNode(new \ICalendarOrg\ZCiCalDataNode('DTSTART:' . \ICalendarOrg\ZDateHelper::fromSqlDateTime($event_start)));
+
+		// add end date
+		$eventobj->addNode(new \ICalendarOrg\ZCiCalDataNode('DTEND:' . \ICalendarOrg\ZDateHelper::fromSqlDateTime($event_end)));
+
+		// UID is a required item in VEVENT, create unique string for this event
+		// Adding your domain to the end is a good way of creating uniqueness
+		$uid = \date('Y-m-d-H-i-s') . '@demo.icalendar.org';
+		$eventobj->addNode(new \ICalendarOrg\ZCiCalDataNode('UID:' . $uid));
+
+		// DTSTAMP is a required item in VEVENT
+		$eventobj->addNode(new \ICalendarOrg\ZCiCalDataNode('DTSTAMP:' . \ICalendarOrg\ZDateHelper::fromSqlDateTime()));
+
+		// Add description
+		$eventobj->addNode(new \ICalendarOrg\ZCiCalDataNode('Description: This is a simple event, using the Zap Calendar PHP library. Visit http://icalendar.org to validate icalendar files.'));
+
+		$icalString = $icalobj->export();
+		$this->assertStringContainsString('My Calendar Name', $icalString);
+		}
+	}