snowiow/cocurl

Abstraction Layer for Clash of Clans API Results

Maintainers

Details

github.com/snowiow/cocurl

Homepage

Source

Issues

Installs: 7

Dependents: 0

Suggesters: 0

Security: 0

Stars: 1

Watchers: 2

Forks: 1

Open Issues: 0

0.0.1-beta 2016-02-15 21:49 UTC

Requires

  • php: >=7.0.0

Requires (Dev)

MIT b08508c000131c562782a11e9e7c17fd8bc0375e

apicocurlClashClans

This package is not auto-updated.

Last update: 2024-05-31 16:16:57 UTC

README

Intro

COCUrl is a PHP framework with the goal to interact with the Clash of Clans Developer API more easily. It creates an object oriented layer above the raw cURL requests and offers Objects and Enums for the most common types returned by the CoC API. Sending requests is as easy as calling some functions on a object.

Installation

Installation via composer is currently supported. Just add the following line to the require key in your composer.json file inside your project directory.

"require": {
  "snowiow/cocurl": "dev-master"
}

Instead of dev-master you can also use any specified version you like. For more informations visit the composer website

How to use?

Everything starts with the Client class. It needs an API key to be created.

$client = COCUrl\Client('my-api-key');

With the $client instance you are able to do all calls, that are available in the CoC API Beta. All calls are done as function calls. For example, if we want to retrieve all locations we do the following:

$client = COCUrl\Client('my-api-key');
$locations = $client->locations();

$locations is an array with Location objects. All the data is available as public attributes. For example we can get the name of the first location we found by executing the following line:

$locations[0]->name;

If you want to do a specialised request under the same URL it is also possible over the same method. This is mostly implemented with the help of standard parameters. This behaviour is pulled through the whole COCUrl Framework. For example, if you know the id of the Location you want to retrieve. The call would look like this:

$location = $client->locations(32000094); //Returns a Location object of Germany
echo $location->name; //Would print Germany

For a complete reference of what's implemented at this state, please refer to the ClientTest Class.