PHP SDK for Open Brewery DB api.
Like this package? Consider sponsoring me to help me reach my goals.
composer require alexjustesen/php-openbrewerydb
v1 of OpenBreweryDB API does not enforce any authentication patterns but rate limiting does exist.
To get started create a new instance of the SDK.
$obdb = new OpenBreweryDb;
The SDK makes use of Saloon by Sam Carre, after a request is sent you can interact with the response with any of the documented methods like ->body()
or ->json()
.
In the example below we're requesting a single brewery and formatting the response as json.
$request = new GetBrewery('brewery-id-goes-here');
$response = $obdb->send($request);
$response->json();
$request = new ListBreweries();
$response = $obdb->send($request);
Additional methods for filtering results:
$request->filterByCity('hartford')
-string
$request->filterByName('broad brook')
-string
$request->filterByPostal('06002')
-string
$request->filterByState('connecticut')
-string
$request->filterByType('micro')
-string
Additional methods for sorting results:
$request->sortBy('type,name:asc')
-string
orarray
$request->sortByDistance(41.96200785, -72.66266463)
- $lat:float
, $lon:float
$request = new GetBrewery('brewery-id-goes-here');
$response = $obdb->send($request);
$request = new GetRandomBrewery();
$response = $obdb->send($request);
Available parameters
size
, default =1
$request = new SearchBreweries('dog');
$response = $obdb->send($request);
$request = new AutocompleteBreweries('dog');
$response = $obdb->send($request);
PHP_CS_FIXER_IGNORE_ENV=1 tools/php-cs-fixer/vendor/bin/php-cs-fixer fix src --allow-risky=yes
./vendor/bin/pest
``