nystudio107 / craft-recipe

src/controllers/NutritionApiController.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\controllers;

use Craft;
use craft\web\Controller;
use nystudio107\recipe\Recipe;
use yii\web\BadRequestHttpException;
use yii\web\Response;

/**

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 NutritionApiController extends Controller
{
    /**
     * Returns nutritional information about a recipe.
     *
     * @throws BadRequestHttpException
     */

Missing @return tag in function comment

    public function actionGetNutritionalInfo(): Response
    {
        $this->requireAcceptsJson();

        $ingredients = Craft::$app->getRequest()->getParam('ingredients');
        $serves = Craft::$app->getRequest()->getParam('serves');

        if (empty($ingredients)) {
            return $this->asJson([

The opening parenthesis of a multi-line function call should be the last content on the line.

                'error' => 'Please provide some ingredients first.',
            ]);

For multi-line function calls, the closing parenthesis should be on a new line.

        }

        $nutritionalInfo = Recipe::$plugin->nutritionApi->getNutritionalInfo($ingredients, $serves);

        return $this->asJson($nutritionalInfo);
    }
}