Download the PHP package openfoodfacts/openfoodfacts-php without Composer
On this page you can find all versions of the php package openfoodfacts/openfoodfacts-php. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download openfoodfacts/openfoodfacts-php
More information about openfoodfacts/openfoodfacts-php
Files in openfoodfacts/openfoodfacts-php
Package openfoodfacts-php
Short Description Open Food Facts API Wrapper, the open database about food.
License MIT
Homepage https://world.openfoodfacts.org/
Informations about the package openfoodfacts-php
openfoodfacts-php - Official PHP package for Open Food Facts
PHP API Wrapper for Open Food Facts, the open database about food.
Current features
- Search-A-Licious (#62), user-agent (#53), PHP 8.1 (#47), Image upload
- Most features should be visible here: https://github.com/openfoodfacts/openfoodfacts-php/blob/develop/src/Api.php
- PLEASE DOCUMENT ANY MISSING FEATURES HERE
Installation
With Composer:
Usage
This is the most basic way of creating the API:
In the example above you access the "food" database, limited to the French language/country scope. The first parameter is either
- "food"
- "beauty" or
- "pet"
to decide which product database you want to use.
The second parameter decides the language/country scope of the chosen database: f.e. "world" or "de" or "fr".
For more details on this topic: see the API Documentation
These are all the parameters you really need for basic usage.
As return types for you get an Object. This may also be an Object of Type ,, depending on which API you are creating. These objects inherit from the more generic
In the example above, we use the 'food' API and there will get a
For getting a first overview the has a function to return an array representation(sorted) for a first start.
Optional Parameters
The other parameters are optional and for a more sophisticated use of the api (from a software development point of view):
An example in code is found here: cached_example.php
LoggerInterface: A logger which decieds where to log errors to (file, console , etc)
ClientInterface: The HTTP Client - to adjust the connection configs to your needs and more
see: Guzzle HTTP Client
CacheInterface: To temporarily save the results of API request to improve the performance and to reduce the load on the API- Server
see: PSR-16 Simple Cache
Development
Contributing
- Fork it ( https://github.com/openfoodfacts/openfoodfacts-php/fork )
- Create your feature branch (
git checkout -b my-new-feature
) - Launch test
vendor/bin/phpunit
&& cs-fixervendor/bin/php-cs-fixer fix
- Commit your changes (
git commit -am 'Add some feature'
) - Push to the branch (
git push origin my-new-feature
) - Create a new Pull Request
Third party applications
If you use this SDK, feel free to open a PR to add your application in this list.
Authors
All versions of openfoodfacts-php with dependencies
ext-json Version *
ext-curl Version *
ext-gd Version *
guzzlehttp/guzzle Version ^7.4
psr/log Version ^3.0
psr/simple-cache Version ^3.0