NutritionApiController::actionGetNutritionalInfo() - Code Metrics - Inspection of "Version 1.3.0" - nystudio107/craft-recipe - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — develop ( 19391e...30063e )

by Andrew

created 2021-03-05 19:31 UTC

NutritionApiController::actionGetNutritionalInfo() A

↳ Parent: NutritionApiController

Complexity

Conditions	2
Paths	2

Size

Total Lines	16
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Importance

Changes	3
Bugs	0	Features	0

Metric	Value
cc	2
eloc	8
c	3
b	0
f	0
nc	2
nop	0
dl	0
loc	16
rs	10

<?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

 * @copyright Copyright (c) 2017 nystudio107

 */


namespace nystudio107\recipe\controllers;

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

/**

 * @author    nystudio107

 * @package   Recipe

 * @since     1.3.0

 */

class NutritionApiController extends Controller
{
    /**
     * Returns nutritional information about a recipe.
     *
     * @throws BadRequestHttpException
     */

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

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

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

                'error' => 'Please provide some ingredients first.'
            ]);
someFunctionCall(
    $firstArgument,
    $secondArgument,
    $thirdArgument
); // Closing parenthesis on a new line.
        }

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

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


1			<?php
2			/**
3			* Recipe plugin for Craft CMS 3.x
4			*
5			* A comprehensive recipe FieldType for Craft CMS that includes metric/imperial
6			* conversion, portion calculation, and JSON-LD microdata support
7			*
8			* @link https://nystudio107.com
			0 ignored issues – show Coding Style introduced 2021-03-05 19:38 UTC by Report Bug Copy Issue Report The tag in position 1 should be the @copyright tag Loading history...
9			* @copyright Copyright (c) 2017 nystudio107
			0 ignored issues – show Coding Style introduced 2021-03-05 19:38 UTC by Report Bug Copy Issue Report @copyright tag must contain a year and the name of the copyright holder Loading history...
10			*/
			0 ignored issues – show Coding Style introduced 2021-03-05 19:38 UTC by Report Bug Copy Issue Report PHP version not specified Loading history... Coding Style introduced 2021-03-05 19:38 UTC by Report Bug Copy Issue Report Missing @category tag in file comment Loading history... Coding Style introduced 2021-03-05 19:38 UTC by Report Bug Copy Issue Report Missing @package tag in file comment Loading history... Coding Style introduced 2021-03-05 19:38 UTC by Report Bug Copy Issue Report Missing @author tag in file comment Loading history... Coding Style introduced 2021-03-05 19:38 UTC by Report Bug Copy Issue Report Missing @license tag in file comment Loading history...
11
12			namespace nystudio107\recipe\controllers;
13
14			use Craft;
15			use craft\web\Controller;
16			use nystudio107\recipe\Recipe;
17			use yii\web\BadRequestHttpException;
18
19			/**
			0 ignored issues – show Coding Style introduced 2021-03-05 19:38 UTC by Report Bug Copy Issue Report Missing short description in doc comment Loading history...
20			* @author nystudio107
			0 ignored issues – show Coding Style introduced 2021-03-05 19:38 UTC by Report Bug Copy Issue Report The tag in position 1 should be the @package tag Loading history... Coding Style introduced 2021-03-05 19:38 UTC by Report Bug Copy Issue Report Content of the @author tag must be in the form "Display Name <[email protected]>" Loading history... Coding Style introduced 2021-03-05 19:38 UTC by Report Bug Copy Issue Report Tag value for @author tag indented incorrectly; expected 2 spaces but found 4 Loading history...
21			* @package Recipe
			0 ignored issues – show Coding Style introduced 2021-03-05 19:38 UTC by Report Bug Copy Issue Report Tag value for @package tag indented incorrectly; expected 1 spaces but found 3 Loading history...
22			* @since 1.3.0
			0 ignored issues – show Coding Style introduced 2021-03-05 19:38 UTC by Report Bug Copy Issue Report Tag value for @since tag indented incorrectly; expected 3 spaces but found 5 Loading history... Coding Style introduced 2021-03-05 19:38 UTC by Report Bug Copy Issue Report The tag in position 3 should be the @author tag Loading history...
23			*/
			0 ignored issues – show Coding Style introduced 2021-03-05 19:38 UTC by Report Bug Copy Issue Report Missing @link tag in class comment Loading history... Coding Style introduced 2021-03-05 19:38 UTC by Report Bug Copy Issue Report Missing @license tag in class comment Loading history... Coding Style introduced 2021-03-05 19:38 UTC by Report Bug Copy Issue Report Missing @category tag in class comment Loading history...
24			class NutritionApiController extends Controller
25			{
26			/**
27			* Returns nutritional information about a recipe.
28			*
29			* @throws BadRequestHttpException
30			*/
			0 ignored issues – show Coding Style introduced 2021-03-05 19:38 UTC by Report Bug Copy Issue Report Missing @return tag in function comment Loading history...
31			public function actionGetNutritionalInfo()
32			{
33			$this->requireAcceptsJson();
34
35			$ingredients = Craft::$app->getRequest()->getParam('ingredients');
36			$serves = Craft::$app->getRequest()->getParam('serves');
37
38			if (empty($ingredients)) {
39			return $this->asJson([
			0 ignored issues – show Coding Style introduced 2021-03-05 19:38 UTC by Report Bug Copy Issue Report The opening parenthesis of a multi-line function call should be the last content on the line. Loading history...
40			'error' => 'Please provide some ingredients first.'
41			]);
			0 ignored issues – show Coding Style introduced 2021-03-05 19:38 UTC by Report Bug Copy Issue Report For multi-line function calls, the closing parenthesis should be on a new line. If a function call spawns multiple lines, the coding standard suggests to move the closing parenthesis to a new line: someFunctionCall( $firstArgument, $secondArgument, $thirdArgument ); // Closing parenthesis on a new line. Loading history...
42			}
43
44			$nutritionalInfo = Recipe::$plugin->nutritionApi->getNutritionalInfo($ingredients, $serves);
45
46			return $this->asJson($nutritionalInfo);
47			}
48			}
49

nystudio107 / craft-recipe

Push — develop ( 19391e...30063e )

NutritionApiController::actionGetNutritionalInfo() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like