Skip to content

Latest commit

 

History

History
152 lines (107 loc) · 3.83 KB

README.md

File metadata and controls

152 lines (107 loc) · 3.83 KB
Raw

FatSecret API for Laravel

StyleCI Build Status codecov

The FatSecret API for Laravel gives you access to the FatSecret API.

FatSecret provides you with access to comprehensive nutrition data for many thousands of foods, not to mention a range exercises and great weight management tools for your applications.

Requirements

  • Laravel versions: 5.6, 5.7 and 5.8

Looking for 4.x Compatibility?

While it may be unsupported now, you can find 4.x compatible versions in the laravel4 branch or tagged with 4.0

How to Install

  1. Install the braunson/fatsecret-laravel package

    $ composer require "braunson/fatsecret-laravel"

  2. Update config/app.php to activate FatSecret package

    # Add `FatSecretServiceProvider` to the `providers` array
'providers' => [
	...
	Braunson\FatSecret\ServiceProvider::class,
]

# Add the FatSecret Facade to the `aliases` array
'aliases' => [
	...
	'FatSecret' => Braunson\FatSecret\Facades\Facade::class,
]

Configuration

  1. Publish the config file:

    php artisan vendor:publish --provider="Braunson\FatSecret\ServiceProvider"

  2. Open your .env file and add in

    FATSECRET_KEY=YOUR-API-KEY
FATSECRET_SECRET=YOUR-API-SECRET

Usage

When you are using this package in a file, make sure to add this to the top of your file:

use Fatsecret;

The FatSecret is available as FatSecret, for example:

FatSecret::ProfileCreate($userID, &$token, &$secret);

For more information on using the FatSecret API check out the documentation

Methods

FatSecret::searchIngredients($search_phrase, $page, $maxresults)
  • Search ingredients by phrase, page and max results
FatSecret::getIngredient($ingredient_id)
  • Retrieve an ingredient by ID
FatSecret::GetKey()
  • Gets the set consumer key
FatSecret::SetKey()
  • Allows overriding or setting of the consumer key
FatSecret::GetSecret()
  • Gets the set secret key
FatSecret::SetSecret()
  • Allows overriding or setting of the secret key
FatSecret::ProfileCreate($userID, $token, $secret)
  • Allows creation of a profile in FS with a user specific ID.
FatSecret::ProfileGetAuth($userID, $token, $secret)
  • Get the authentication details of a profile
FatSecret::ProfileRequestScriptSessionKey($auth, $expires, $consumeWithin, $permittedReferrerRegex, $cookie, $sessionKey)
  • Create a new session for JavaScript API users

Reporting Bugs or Feature Requests

Please report any bugs or feature requests on the github issues page for this project here:

https://github.com/braunson/fatsecret/issues

Contributing

License

The FatSecret Laravel API is free software released under the MIT License. See LICENSE for details. This is not an official release and is released separately from FatSecret.