lmerotta/phpokeapi

A PHP7.1 Wrapper for PokéAPI, with cache and lazy-loading

1.1.5 2019-09-27 06:37 UTC

Requires

• php: ^7.1.3
• doctrine/common: ^2.8
• jms/serializer: ^1.11
• ocramius/proxy-manager: ^2.1
• psr/cache: ^1.0
• psr/simple-cache: ^1.0
• symfony/cache: ^4.0
• symfony/yaml: ^4.0

Requires (Dev)

• phpunit/phpunit: ^7.2

MIT

• Lucio Merotta

README

A PHP7.1+ wrapper for PokéAPI. This package offers the possibility to query the majority of the PokéAPI endpoints (see exceptions below). It supports caching of responses and lazy-loading relations.

Installation

composer require lmerotta/phpokeapi

Basic Usage

UsePokeAPI\Client to query the endpoints directly through the named methods.

<?php

use PokeAPI\Client;

$client = new Client();

// Returns a PokeAPI\Pokemon\Species instance
$species = $client->species('bulbasaur'); // or $client->species(1);

You can then traverse the returned object. All its relations will be proxies, and won't make any new requests to the API except if you explicitly call one of their getters

<?php

// ...

$species->getName(); // 'bulbasaur'
$growthRate = $species->getGrowthRate(); // A proxy of PokeAPI\Pokemon\GrowthRate 

$growthRate->getName(); // Here the real API call to the GrowthRate endpoint is made 

All the requests made are cached, so you won't have to query twice for the same dataset.

PokeAPI\Client

The PokeAPI\Client takes 3 optional parameters:

• $url, a string pointing to the base URL of the PokéAPI. Defaults to pokeapi.co
• $cache, A Psr\SimpleCache\CacheInterface. Defaults to a Symfony\Component\Cache\Simple\FilesystemCache instance
• $serializer, A JMS\Serializer\SerializerInterface implementation.

Contributing

Feel free to open pull requests or submit issues!