Customize Integration

Note: Integration is not Syndication. Integration of Helios Calendar components is only possible on a website that has Helios Calendar installed on in. To add event information to a site Helios Calendar is not installed on (Syndication) Helios supports both RSS Feeds and JavaScript Syndication.

Also Note: Integration is not the same as building a theme. Helios Calendar components can be integrated with areas of a website outside of the calendar, however, to style the public calendar so that it matches the design of your site a custom theme can be built.

Getting Started

Each component has it's own unique function. These functions are contained within the int.php file included with Helios Calendar in the root directory of the application. This file can be included in any page where integration is needed.

include('int.php');

Note: This include path will vary depending on where your Helios Calendar is located in relation to the page where the integration will take place, you can use either absolute or relative local filesystem path to the int.php file, however, a URL should never be used with the include() function.

Available Components/Functions

The following components can be integrated, using their associated functions, with any PHP based file present on the site.

Dashboard

Function: int_week_dashboard()

A homepage “dashboard” showing events for the upcoming 7 days (sliding window), RSS & iCalendar subscription links as well as links to the calendar homepage & event submit form.

Mini Calendar

Function: int_mini_calendar()

The mini calendar is a key part of Helios' public calendar navigation. Integrating this component permits the addition of the mini-calendar throughout the site allowing users direct access to browse events within the calendar quickly and easily.

This function supports a date parameter permitting the creation of any calendar date.

Event Lists

Function: int_event_list()

The event list is three components in one. This function supports a type parameter that allows the integration of a list of Billboard, Most Popular or Newest events. Each listed event links directly to it's event detail view within the calendar.

Feed Links

Function: int_links()

Providing sitewide access to RSS & iCalendar event feed links is easy when integrating the links component.

Mini Search

Function: int_mini_search()

A slimmed down search utility, the mini search provides quick access to searching events by keyword. In addition the mini search component also includes a link to the full public calendar search form allowing users the option to access either search method.

Styling & CSS

With the exception of the dashboard, markup output for integrated components is identical to their public calendar counterparts. Standard CSS styling can be employed (or any Helios Calendar theme style sheet can be utilized) to style integrated components.

Dashboard

Dashboard Markup:

<div id="hc_dashboard">
    <ul id="menu">
        <li><a></a></li>
        <li class="icon"><a></a></li>
    </ul>
    <div id="hc_dashboard_dayX" class="hc_dashboard_day">
        <ul>
            <li>DATE</li>
            <li><div class="time">TIME</div><a>EVENT TITLE</a></li>
        </ul>
    </div>
    <a>All Events</a> | <a>Submit Your Events</a>
</div>

Note: X in hc_dashboard_dayX = 0-6 (0 is Today, 1 is Tomorrow and so on.)

Performance

Integrated components utilize the same caching methodologies and cache files as their public calendar counterparts. These files will be updated in tandem with the public calendar to ensure they are up-to-date and to minimize server workload.

Documentation

As with all public calendar functions the integration functions within the int.php file include PHPDoc style internal documentation to assist in their use.