Event¶

To start using the Calendar Event API, add the following to the top of your file:

use EncoreDigitalGroup\PlanningCenter\Objects\Calendar\Event;

Now we can create a new instance of the Event class;

$event = new Event($client);

To get all calendar events that exist in Planning Center, use the following method:

$event->all();

To modify the Planning Center API Query, you can pass an argument to the all() method.

$query = [
    'filter' => 'future'
];

$event->all($query);

Specifically for Future Calendar Events, we have created a method that applies this query modification for you automatically.

$event->future();

To get a single Planning Center Calendar Event, pass the id of the event to the get() method

$event->eventId = YOUR_EVENT_ID;
$event->get();

$event->eventId = YOUR_EVENT_ID;
$event->instances();

$event->eventId = YOUR_EVENT_ID;
$event->eventInstanceId = YOUR_EVENT_INSTANCE_ID;
$event->instance();

$event->eventId = YOUR_EVENT_ID;
$event->connectionId = YOUR_CONNECTION_ID;
$event->connection();