Skip to content

Latest commit

 

History

History
40 lines (27 loc) · 2.35 KB

README.md

File metadata and controls

40 lines (27 loc) · 2.35 KB
Raw

LibCal Integration for Drupal (8/9)

Introduction

This Drupal module provides a method to integrate LibCal Events to Drupal content by pulling data from the LibCal Rest API. It is intended to be a sync of events found in libcal, meaning that if an event is deleted from libcal, it will be deleted from Drupal next time the sync runs.

Requirements

Installation

  • Under the repositories section of your composer.json file, add this repo.
{
  "type": "vcs",
  "url": "https://github.com/digitalutsc/drupal_libcal"
}
  • Add the module by running composer require digitalutsc/drupal_libcal
  • Enable the module via the Drupal interface or drush command
  • Configure the LibCal Rest API information by going to Configuration > System > LibCal or visit https://yoursite.com/admin/config/libcal, then fill out the setup form (Screenshot below)

alt text

Configuration

  • The only required configuration parameters are LibCal Host, Client ID, Client Secret and Calendar ID(s). If you wish to pull data from multiple calendars, list all the calendar IDs separated by a comma ,.
  • You can also specify Tag ID(s) if you only want to pull in events with specific internal event tags. Multiple tags should be comma-separated, just like the calendar IDs.
  • Limit is the maximum number of events to retrieve. The default to 20 and the maximum is 500.
  • Days is the number of days in to the future to pull events. The default is 30 and the maximum is 365 days.
  • If you check the box Remove past events?, event nodes in Drupal will be deleted if the event has passed. This prevents events from showing up in searches. This feature is enabled by default.

Usage