cultuurnet/calendar-summary-v3

Library to convert cultuurnet dates to a readable summary

calendar-summary-v3

, _(*1)

Installation

You can install the cultuurnet\calendar-summary-v3 PHP library in different ways:, _(*2)

• Standalone. Clone or download from github and use Composer. Run composer install from the root of the clone to download the necessary dependencies. Standalone usage is probably only useful for testing purposes.
• Inside your project: require the cultuurnet/calendar-summary-v3 package (it is registered on Packagist) and the cultuurnet/cdb package in your project's composer.json file and run composer update.

{
    "require": {
        "cultuurnet/calendar-summary-v3": "dev-master"
    }
}

How it works

The calendar-summary-v3 PHP takes the start and end date of an Event or Place object (hence the dependency oncultuurnet/search-v3), and formats it. There's a HTML formatter and a plain text formatter., _(*3)

Types

The Event or Place object has a calendarType property which can have one of the four following options: * single * multiple * periodic * permanent, _(*4)

Parameters

There are 3 (optional) parameters which can be used on the initialisation of the formatters. Those are * langCode * hidePastDates * timeZone, _(*5)

langCode

(string) Default value: 'nl_BE'. You can use this parameter to change the language of the output that the formatter will produce. Currently works in nl, fr, de and en. The format here is standard PHP locales. For example 'fr_BE' or 'de_BE'., _(*6)

hidePastDates

(boolean) Default value: false. This parameter (when true) will only be used on offers with a calendarType 'multiple'. When true dates in the past won't be in the formatter's output., _(*7)

timeZone

(string) Default value: 'Europe/Brussels' You can set a different timezone with this parameter. Supported timezones can be found in thislist., _(*8)

Formats

After initializing the formatter, you call the format method with the following 2 parameters: * Event or Place object (from cultuurnet/search-v3) * The desired output format ('xs', 'sm', 'md' or 'lg'), _(*9)

Using an unsupported format will throw an exception., _(*10)

Example

<?php
    $event = new Event();

    // This will format the calendar info of $event in an medium HTML output 
    $calendarHTML = new CalendarHTMLFormatter('nl_BE', true, 'Europe/Brussels');
    $calendarHTML->format($event, 'md');

    // This will format the calendar info of $event in a large plain text output
    $calendarPlainText = new CalendarPlainTextFormatter('fr_BE', true, 'Europe/Paris');
    $calendarPlainText->format($event, 'lg');