devilcius/eventful-api

PHP API client for EventFul webservices

v0.4 2016-10-11 11:53 UTC

Requires

• php: >=5.3.3

Requires (Dev)

• php: >=5.3.3
• phpunit/phpunit: ~4.8
• vlucas/phpdotenv: *

MIT

• Marcos Peña

• api
• Eventful
• webservice client

README

A PHP client library for the EventFul API

Installation

composer require devilcius/eventful-api

Quick Start

The main entry point of the library is the EventFul\EventFulApiClient class. Once you have an EventFulApiClient instance, you can easily access all the API services and call their methods. Any use of the Eventful API requires a valid, current application key. You can obtain one here

Let's try to find an event using the search method of the Event service:

<?php

// options:
$apiKey = 'secretAppKey'; // mandatory
$endPoint = 'http://api.evdb.com'; // optional
$timeout = 10; // optional
$userAgent = 'EventFul PHP Client'; // optional
$apiClient = new EventFulApiClient($apiKey, $endPoint, $timeout, $userAgent);

$service = $apiClient->getEventService();
$params['page_number'] = 1;
$params['page_size'] = 10;
$params['category'] = 'music';
$params['location'] = 'Madrid';
$result = $service->search($params);
foreach ($result->events->event as $event) {
    echo $event->title;
}

Tests

phpunit

Methods

Service	Method	Description	Implemented
Event	new	Add a new event record.	⌛
Event	get	Get an event record.	✔️
Event	modify	Modify an event record.	⌛
Event	withdraw	Withdraw (delete, remove) an event.	⌛
Event	restore	Restore a withdrawn event.	⌛
Event	search	Search for events.	✔️
Event	reindex	Update the search index for an event record.	⌛
Event	tagsList	List all tags attached to an event.	✔️
Event	goingList	List all users going to an event.	✔️
Event	tagsNew	Add tags to an event.	⌛
Event	tagsRemove	Remove tags from an event.	⌛
Event	commentsNew	Add a comment to an event.	⌛
Event	commentsModify	Make changes to an event comment.	⌛
Event	commentsDelete	Remove a comment from an event.	⌛
Event	linksNew	Add a URL to an event.	⌛
Event	linksDelete	Remove a URL from an event.	⌛
Event	imagesAdd	Add an image to an event.	⌛
Event	imagesRemove	Remove an image from an event.	⌛
Event	performersAdd	Add a performer to an event.	⌛
Event	performersRemove	Remove a performer from an event.	⌛
Event	propertiesAdd	Add a property to an event.	⌛
Event	propertiesList	List properties for an event.	✔️
Event	propertiesRemove	Remove a property from an event.	⌛
Event	categoriesAdd	Add a category to an event.	⌛
Event	categoriesRemove	Remove a category from an event.	⌛
Event	datesResolve	Resolve start and end dates from a date string.	✔️
Venue	new	Add a new venue record.	⌛
Venue	get	Get a venue record.	✔️
Venue	modify	Make changes to a venue.	⌛
Venue	withdraw	Withdraw (delete, remove) a venue.	⌛
Venue	restore	Restore a withdrawn venue.	⌛
Venue	search	Search for venues.	✔️
Venue	tagsList	List all tags attached to an venue.	✔️
Venue	tagsNew	Add tags to an venue.	⌛
Venue	tagsDelete	Remove tags from an venue.	⌛
Venue	commentsNew	Add a comment to a venue.	⌛
Venue	commentsModify	Make changes to a venue comment.	⌛
Venue	commentsDelete	Remove a comment from a venue.	⌛
Venue	linksNew	Add a URL to a venue.	⌛
Venue	linksDelete	Remove a URL from an event.	⌛
Venue	propertiesAdd	Add a property to an venue.	⌛
Venue	propertiesList	List properties for an venue.	✔️
Venue	propertiesRemove	Remove a property from an venue.	⌛
Venue	resolve	Resolve a venue from a location string.	✔️
User	get	Get a user record.	✔️
User	search	Searches for users.	✔️
User	groupsList	List the groups of which a user is a member.	✔️
User	venueList	List a user's recently added venues.	⌛
User	localesAdd	Add a locale to a user's saved locations.	⌛
User	localesList	List a user's saved locations.	⌛
User	localesDelete	Delete a locale from a user's saved locations.	⌛
User	goingAdd	Marks a user as "I'm going" to an event.	⌛
User	goingRemove	Removes a user from an event's "I'm going" list.	⌛
Image	new	Add a new image.	⌛
Image	delete	Delete an image.	⌛
Performer	new	Add a new performer.	⌛
Performer	get	Get the details for a performer.	✔️
Performer	modify	Modify a performer.	⌛
Performer	search	Search for performers.	✔️
Performer	withdraw	Delete a performer.	⌛
Performer	linksAdd	Add links to an performer.	⌛
Performer	linksRemove	Remove links from an performer.	⌛
Performer	imagesAdd	Add an image to a performer.	⌛
Performer	imagesRemove	Remove an image from a performer.	⌛
Performer	eventsList	Get all events for a performer.	✔️
Performer	xidsList	Get all performers based on external ids (facebook, etc).	✔️
Demand	get	Get the details for a demand.	✔️
Demand	search	Search for demands.	✔️
Category	list	List the available categories.	✔️