Cronofy PHP Sample Application

Prerequisites

A Git Tool

We would recommend downloading and using the Git Bash tool, which you can find here.

A cloned version of this repository

For help in cloning this repository please see this article.

A local PHP environment version 7 or later

Mac

For Mac we would recommend using MAMP.

Download and install MAMP, in the Preferences set the Document Root to the repository you have just cloned, click the Start Servers button, and you can visit your site at http://localhost:8888

Windows

For Windows we would recommend using XAMPP.

Download and install XAMPP, then move your cloned repository to C:/xampp/htdocs/cronofy-php, open XAMPP and start your servers and then you can visit your site at http://localhost:80/cronofy-php

Linux

For Linux we would recommend using APACHE2.

Commands to install APACHE2

(apt-get is used by ubuntu based linux)
sudo apt-get update
sudo apt-get install apache2

Then move your cloned repository to /var/www/html/cronofy-php, then you can visit your site at http://localhost:80/cronofy-php

Set-up

Install the dependencies

Cronofy-php is installed via a composer package so you will have to install it

curl -sS https://getcomposer.org/installer | php
php composer.phar install

for more details see Packagist's documentation

Create a Cronofy application

To use the Cronofy PHP Sample App you need to create a Cronofy application. To do this, create a free developer account, click "Create New App" in the left-hand navigation and create an application.

Once you've created your application you will need to set the CRONOFY_CLIENT_ID and CRONOFY_CLIENT_SECRET in the application's globals.php file.

Setting up a Remote URL

In order to test Push Notification callbacks and Enterprise Connect user authentications your application will need to be reachable by the internet.

To do this we would recommend using ngrok to create a URL that is accessible by the Cronofy API.

Once you have ngrok installed you can initialise it for your application by using the following line in your terminal:

ngrok http -host-header=localhost localhost:8888 (Replace localhost:8888 with localhost:[port number] where appropriate)

Your terminal will then display a URL in the format http://[unique identifier].ngrok.io. You will need to set the DOMAIN variable in the application's globals.php in order to test these remote features.

Setting up Google Maps

In order to view geo-location that has been set on events you will need to set the GOOGLE_MAPS_EMBED_API_KEY in the application's globals.php file. You can get your key from here by clicking "GET A KEY": Google Maps Embed API