Download the PHP package boxhead/craft-churchsuite-events without Composer
On this page you can find all versions of the php package boxhead/craft-churchsuite-events. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download boxhead/craft-churchsuite-events
More information about boxhead/craft-churchsuite-events
Files in boxhead/craft-churchsuite-events
Package craft-churchsuite-events
Short Description Sync ChurchSuite Events into Craft as native elements.
License proprietary
Informations about the package craft-churchsuite-events
churchsuite-events
Sync ChurchSuite Events into Craft as native elements.
Requirements
This plugin requires Craft CMS 4.5.0 or later, and PHP 8.0.2 or later.
Installation
You can install this plugin from the Plugin Store or with Composer.
With Composer
Open your terminal and run the following commands:
Configuring churchsuite-events
Once installed, you will need to configure the plugin settings with your ChurchSuite organisation/church handle as found in your ChurchSuite URLs. For example abcd in the URL https://**abcd**.churchsuite.com/.
The installation process will generate a number of custom fields, a filesystem and volume for storing event images, and a category group for event categories. You can change the names and labels of these elements but the handles should not be changed. Deleting these fields while the plugin is installed could also cause issues with the sync process.
You may create additional custom fields as your needs require and assign them to the ChurchSuiteEvent element field layout within the settings.
Using churchsuite-events
The Sync process pulls in all available events from ChurchSuite Calendar JSON feed and creates a new Event element for each one. The sync process will also update existing events if they have been changed in ChurchSuite. The sync process will not delete events that have been deleted in ChurchSuite but will set the status to disabled for any missing of historic events.
The sync process can be run manually from the plugin ultities page or can be set to run automatically on a schedule. The sync process can also be run from the command line using the ./craft churchsuite-events/events/sync
command.
Twig Templating
The plugin provides an craft.churchsuiteevents()
method to query events. The method returns an instance of craft\elements\db\ElementQuery which can be used to further refine the query.