nystudio107 / craft-recipe

src/services/NutritionApi.php

<?php
/**
 * Recipe plugin for Craft CMS 3.x
 *
 * A comprehensive recipe FieldType for Craft CMS that includes metric/imperial
 * conversion, portion calculation, and JSON-LD microdata support
 *
 * @link      https://nystudio107.com

The tag in position 1 should be the @copyright tag

 * @copyright Copyright (c) 2017 nystudio107

@copyright tag must contain a year and the name of the copyright holder

 */

PHP version not specified

Missing @category tag in file comment

Missing @package tag in file comment

Missing @author tag in file comment

Missing @license tag in file comment

namespace nystudio107\recipe\services;

use Craft;
use craft\base\Component;
use Exception;
use nystudio107\recipe\models\Settings;
use nystudio107\recipe\Recipe;

/**

Missing short description in doc comment

 * @author    nystudio107

The tag in position 1 should be the @package tag

Content of the @author tag must be in the form "Display Name <username@example.com>"

Tag value for @author tag indented incorrectly; expected 2 spaces but found 4

 * @package   Recipe

Tag value for @package tag indented incorrectly; expected 1 spaces but found 3

 * @since     1.3.0

The tag in position 3 should be the @author tag

Tag value for @since tag indented incorrectly; expected 3 spaces but found 5

 */

Missing @category tag in class comment

Missing @license tag in class comment

Missing @link tag in class comment

class NutritionApi extends Component
{
    /**

Parameter $ingredients should have a doc-comment as per coding-style.

     * Returns nutritional information about a recipe.
     *
     * @param int|null $serves

Missing parameter comment

Doc comment for parameter $serves does not match actual variable name $ingredients

     */

Missing @return tag in function comment

    public function getNutritionalInfo(array $ingredients, int $serves = null): array
    {
        /** @var Settings $settings */

The open comment tag must be the only content on the line

Missing short description in doc comment

The close comment tag must be the only content on the line

        $settings = Recipe::$plugin->getSettings();

The method getSettings() does not exist on null.

        if (!$settings->hasApiCredentials()) {
            return [];
        }

        $url = 'https://api.edamam.com/api/nutrition-details'
            . '?app_id=' . Craft::parseEnv($settings->apiApplicationId)

The function Craft::parseEnv() has been deprecated: in 3.7.29. [[App::parseEnv()]] should be used instead.

            . '&app_key=' . Craft::parseEnv($settings->apiApplicationKey);

The function Craft::parseEnv() has been deprecated: in 3.7.29. [[App::parseEnv()]] should be used instead.

        $data = [
            'ingr' => $ingredients,
        ];

        if ($serves) {

The expression $serves of type integer|null is loosely compared to true; this is ambiguous if the integer can be 0. You might want to explicitly use !== null instead.

            $data['yield'] = $serves;
        }

        try {
            $response = Craft::createGuzzleClient()->post($url, ['json' => $data]);

            $result = json_decode($response->getBody(), null, 512, JSON_THROW_ON_ERROR);

            $yield = $result->yield ?: 1;

            return [
                'servingSize' => round($result->totalWeight ?? 0 / $yield, 0) . ' grams',
                'calories' => round($result->totalNutrients->ENERC_KCAL->quantity ?? 0 / $yield, 0),
                'carbohydrateContent' => round($result->totalNutrients->CHOCDF->quantity ?? 0 / $yield, 1),
                'cholesterolContent' => round($result->totalNutrients->CHOLE->quantity ?? 0 / $yield, 1),
                'fatContent' => round($result->totalNutrients->FAT->quantity ?? 0 / $yield, 1),
                'fiberContent' => round($result->totalNutrients->FIBTG->quantity ?? 0 / $yield, 1),
                'proteinContent' => round($result->totalNutrients->PROCNT->quantity ?? 0 / $yield, 1),
                'saturatedFatContent' => round($result->totalNutrients->FASAT->quantity ?? 0 / $yield, 1),
                'sodiumContent' => round($result->totalNutrients->NA->quantity ?? 0 / $yield, 1),
                'sugarContent' => round($result->totalNutrients->SUGAR->quantity ?? 0 / $yield, 1),
                'transFatContent' => round($result->totalNutrients->FATRN->quantity ?? 0 / $yield, 1),
                'unsaturatedFatContent' => round((($result->totalNutrients->FAMS->quantity ?? 0) + ($result->totalNutrients->FAPU->quantity ?? 0)) / $yield, 1),
            ];
        } catch (Exception $exception) {
            $message = 'Error fetching nutritional information from API. ';

            if ($exception->getCode() == 401) {
                $message .= 'Please verify your API credentials.';
            } elseif ($exception->getCode() == 555) {
                $message .= 'One or more ingredients could not be recognized.';
            }

            Craft::error($message . $exception->getMessage(), __METHOD__);

            return ['error' => $message];
        }
    }
}