iCalcreator

CREATE 

namespace Kigkonsult\Icalcreator;

    // define time zone
$tz = "Europe/Stockholm";
    // set Your unique id, 
    // required if any component UID is missing
$config = [ 
    Vcalendar::UNIQUE_ID => "kigkonsult.se",
    // opt. set "calendar" timezone
    Vcalendar::TZID      => $tz
];
    // create a new calendar object instance
$calendar = new Vcalendar( $config );

    // required of some calendar software
$calendar->setMethod( "PUBLISH" );
$calendar->setXprop( "x-wr-calname", "Calendar Sample" );
$calendar->setXprop( "X-WR-CALDESC", "Calendar Description" );
$calendar->setXprop( "X-WR-TIMEZONE", $tz );

    // create an calendar event component
$vevent = $calendar->newVevent();
    // set event start
$vevent->setDtstart( 
  new DateTime( '2017-04-01 19:00:00' ), 
  new DateTimezone( $tz )
);
    // set event end
$vevent->setDtend(    
  new DateTime( '2017-04-01 22:30:00'), 
  new DateTimezone( $tz )
);
$vevent->setLocation( "Central Placa" );
$vevent->setSummary(  "PHP summit" );
$vevent->setDescription( "This is a description" );
$vevent->setComment(  "This is a comment" );
$vevent->setAttendee( "attendee1@icaldomain.net" );

    // create an event alarm
$valarm = $vevent->newValarm();
$valarm->setAction( Vcalendar::DISPLAY );
    // reuse the event description
$valarm->setDescription( $vevent->getProperty( Vcalendar::DESCRIPTION ));
    // create alarm trigger (in UTC datetime)
$valarm->setTrigger( new DateTime( "2017-04-01 08:00:00 UTC"));

    // create another calendar event component
$vevent = $calendar->newVevent();
    // alt. date format, here for an all-day event
$vevent->setDtstart(  "20170401", [ Vcalendar::VALUE => Vcalendar::DATE ] );
$vevent->setOrganizer( "boss@icaldomain.com" );
$vevent->setSummary( "ALL-DAY event" );
$vevent->setDescription( "An all-day event" );
$vevent->setResources( "Full attension" );
    // weekly, four occasions
$vevent->setRRule( 
    [ 
        Vcalendar::FREQ  => Vcalendar::WEEKLY,
        Vcalendar::COUNT => 4
    ]
);
    // supporting parse of strict rfc5545 formatted text
$vevent->parse( "LOCATION:1CP Conference Room 4350" );

    // all calendar components are described in rfc5545
    // a complete iCalcreator function list (ex. setProperty) in
    // iCalcreator manual

$calendarString = $vcalendar

    // apply appropriate Vtimezone with Standard/DayLight components
    ->vtimezonePopulate()

    // and create the (string) calendar
    ->createCalendar();

PARSE 

iCal, rfc5545 / rfc2445

create iCalcreator object instance

  // set the (site) unique id,
  // required if any component UID is missing!!
$config   = [ Vcalendar::UNIQUE_ID => "kigkonsult.se" ];

  // create a new calendar instance
$calendar = new vcalendar( $config );

.. .

then parse of local file

    // get iCal contents from file
$iCalContent = file_get_contents( "calendar.ics" );

    // parse iCal contents
$vcalendar->parse( $iCalContent );

    // continue process (edit, parse, select) $calendar
...

xCal, rfc6321 (XML)

How to convert (file) XML resource to an iCalcreator object instance.

use Kigkonsult\Icalcreator\Vcalendar;
use Kigkonsult\Icalcreator\Util\IcalXMLFactory;

    // set Your unique id, 
    // site info for the Vcalendar PRODID property
$config       = [ Vcalendar::UNIQUE_ID => "kigkonsult.se" ];

    // use a local or remote xCal file
$filename     = "xmlfile.xml";

    // get XML contents from file
$iCalContent  = file_get_contents( $filename );

    // parse the XML contents to Vcalendar class instance
try {
    $calendar = IcalXMLFactory::XML2iCal( $iCalContent, $config );
}
catch( Exception $e ) {
    exit( "XML parse error" );
}
    // continue process (edit, parse, select) $calendar
...
...

EDIT 

    // create a new Vcalendar instance
$calendar    = new Vcalendar( 
    [ 
        Vcalendar::UNIQUE_ID => "kigkonsult.se"
    ]
);

    // get iCal contents from file
$iCalContent = file_get_contents( "calendar.ics" );

    // parse iCal contents
$calendar->parse( $iCalContent )

$calendar->setMethod( Vcalendar::PUBLISH );
$calendar->setXprop(  Vcalendar::X_WR_CALNAME,  "Calendar Sample" );
$calendar->setXprop(  Vcalendar::X_WR_CALDESC,  "Calendar Description" );
$calendar->setXprop(  Vcalendar::X_WR_TIMEZONE, "Europe/Stockholm" );

    // read events, one by one
while( $vevent = $calendar->getComponent( Vcalendar::VEVENT )) {

    // uid (unique id/key for component), required, one occurrence 
  $uid     = $vevent->getUid();

    // dtstart required, one occurrence
  $dtstart = $vevent->getDtstart();

    // opt. (first) description
  if( false !== ( $description = $vevent->getDescription())) {

    // edit the description

    // update/replace the (first) description
    $vevent->setDescription( $description );
  }

    // get optional comments
  while( $comment = $vevent->getComment()) {
        .. .
  }

    // remove all ATTENDEE properties .. .
  while( $vevent->deleteAttendee()) {
       continue;
  }

    // update/replace event in calendar
    //  with UID as key
  $calendar->setComponent ( $vevent, $uid );
}

SELECT 

    // create a new calendar object instance
$calendar    = new Vcalendar( 
    [ 
        Vcalendar::UNIQUE_ID => "kigkonsult.se"
    ]
);


    // iCalcreator also support remote files
$url         = "http://www.ical.net/calendars/calendar.ics";
$iCalContent = UrlRsrc::getContent( $url );
$calendar->parse( $iCalContent );

    // required of some calendar software
$calendar->setMethod( Vcalendar::PUBLISH );
$calendar->setXprop(  Vcalendar::X_WR_CALNAME,  "Calendar Sample" );
$calendar->setXprop(  Vcalendar::X_WR_CALDESC,  "Calendar Description" );
$calendar->setXprop(  Vcalendar::X_WR_TIMEZONE, "Europe/Stockholm" );

Select components based on specific date period

    // select components occurring today
    // (including components with recurrence pattern)
$eventArray = $calendar->selectComponents();
foreach( $eventArray as $year => $yearArray) {
    foreach( $yearArray as $month => $monthArray ) {
        foreach( $monthArray as $day => $dailyEventsArray ) {
            foreach( $dailyEventsArray as $vevent ) {

    // if event is a member of a recurrence set

                $currddate = $event->getProperty( 
                    Vcalendar::X_CURRENT_DTSTART
                );

    // returns [ 
    //     "x-current-dtstart"
    //   , (string) date(
    //     "Y-m-d [H:i:s][timezone/UTC offset]" ) ]

    // orig. dtstart
                $dtstart     = $vevent->getDtstart();
                $summary     = $vevent->getSummary();
                $description = $vevent->getDescription();
                .. .
                .. .
            }
        }
    }
}

Select specific property values

    // selects components
    // based on specific property value(-s)
    // ATTENDEE, CATEGORIES, CONTACT,
    // LOCATION, ORGANIZER,
    // PRIORITY, RESOURCES, STATUS,
    // SUMMARY, URL, UID
$selectSpec = [ Vcalendar::CATEGORIES => "course1" ];
$specComps  = $calendar->selectComponents( $selectSpec );
foreach( $specComps as $comp ) {
    .. .
}

^*) Using the non-standard directive "GEOLOCATION", iCalcreator returns output supporting ISO6709 "Standard representation of geographic point location by coordinates", by combining the "LOCATION" and "GEO" property values (only if "GEO" is set).

Select components based on specific property value

    // selects components
    // based on specific property value(-s)
    // ATTENDEE, CATEGORIES, CONTACT,
    // LOCATION, ORGANIZER,
    // PRIORITY, RESOURCES, STATUS,
    // SUMMARY, URL, UID
$selectSpec = [ Vcalendar::CATEGORIES => "course1" ];
$specComps  = $calendar->selectComponents( $selectSpec );
foreach( $specComps as $comp ) {
    .. .
}
.. .

OUTPUT

.. .
    // create a new calendar object instance
$calendar    = new Vcalendar( 
    [ 
        Vcalendar::UNIQUE_ID => "kigkonsult.se"
    ]
);
.. .
  // required of some calendar software
$calendar->setMethod( Vcalendar::PUBLISH );
$calendar->setXprop(  Vcalendar::X_WR_CALNAME,  "Calendar Sample" );
$calendar->setXprop(  Vcalendar::X_WR_CALDESC,  "Calendar Description" );
$calendar->setXprop(  Vcalendar::X_WR_TIMEZONE, "Europe/Stockholm" );
.. .
  // parse calendar file(s)
  // and/or edit/create calendar components.. .
.. .

opt 1

Get calendar as string.

$calendarStr = $calendar->createCalendar();

opt 2

Redirect calendar file to browser.

$calendar->returnCalendar();
exit();

opt 3

Save calendar to file.

    // Get calendar as string
$calendarStr = $calendar->createCalendar();

    // Save string as file
file_put_contents( "calendar.ics", $calendarStr );

opt 4

Create well-formed XML, rfc6321 (as string).

$xmlstr = Kigkonsult\Icalcreator\Util\IcalXMLFactory::iCal2XML( $calendar);

opt 5

Create a json string.

$xmlstr = Kigkonsult\Icalcreator\Util\IcalXMLFactory::iCal2XML( $calendar);
$json   = json_encode( simplexml_load_string( $xmlstr ));

iCalcreator used in.. .

Please use the contact page if you would like to

• report your site / application / module / plugin as a new entry in the list
• report a dead link
• tell us what iCalcreator is missing!!

Free images

Click on an image to download. To download all, click here!

If the download do not start, please refresh the page and try again!