PHPFUI/InstaDoc
 
Copied!

The main iCalendar object containing ZCiCalDataNodes and ZCiCalNodes.

CloneableInstantiable
Properties
public ?ICalendarOrg\ZCiCalNode $curnode = NULL
 

The most recently created node in the tree

public ?ICalendarOrg\ZCiCalNode $tree = NULL
 

The root node of the object tree

Methods
public __construct(string $data = '', int $maxevents = 1000000, int $startevent = 0)
 

The main iCalendar object containing ZCiCalDataNodes and ZCiCalNodes.

use maxevents and startevent to read events in multiple passes (to save memory)

  • param string $data icalendar feed string (empty if creating new feed)
  • param int $maxevents maximum # of events to read
  • param int $startevent starting event to read
  • throws \Exception
public countEvents() : int
 

Return the # of VEVENTs in the object

public countVenues() : int
 

Return the # of VVENUEs in the object

public export() : string
 

Export object to string

This function exports all objects to an iCalendar string

  • return string an iCalendar formatted string
public static formatContent(string $content) : string
 

Escape slashes, commas and semicolons in strings

public getFirstChild( $thisnode) : ?object
 

Get first child in object list Use getNextSibling() and getPreviousSibling() to navigate through list

  • param object $thisnode The parent object
  • return ?object The child object
public getFirstEvent() : ?object
 

Get first event in object list Use getNextEvent() to navigate through list

  • return ?object The first event, or null
public getFirstVenue() : ?object
 

Get first venue in object list Use getNextVenue() to navigate through list

  • return ?object The first venue, or null
public getNextEvent( $event)
 

Get next event in object list

  • param object $event The current event object
  • return object Returns the next event or null if past last event
public getNextSibling( $thisnode)
 

Get next sibling in object list

  • param object $thisnode The current object
  • return object Returns the next sibling
public getNextVenue( $venue)
 

Get next venue in object list

  • param object $venue The current venue object
  • return object Returns the next venue or null if past last venue
public getPrevSibling( $thisnode)
 

Get previous sibling in object list

  • param object $thisnode The current object
  • return object Returns the previous sibling
public static getTZValues(ICalendarOrg\ZCiCalNode $node) : array
 

Pull timezone data from node and put in array

Returning array contains the following array keys: tzoffsetfrom, tzoffsetto, tzname, dtstart, rrule

  • param \ZCiCalNode $node timezone object
  • return array<string,mixed>
Methods
public static formatContent(string $content) : string
 

Escape slashes, commas and semicolons in strings

public static getTZValues(ICalendarOrg\ZCiCalNode $node) : array
 

Pull timezone data from node and put in array

Returning array contains the following array keys: tzoffsetfrom, tzoffsetto, tzname, dtstart, rrule

  • param \ZCiCalNode $node timezone object
  • return array<string,mixed>
© 2025 Bruce Wells
Search Namespaces \ Classes
Configuration