nystudio107 / craft-recipe

src/console/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 @license tag in file comment

Missing @author tag in file comment

namespace nystudio107\recipe\console\controllers;

use Craft;
use craft\console\Controller;
use craft\elements\Entry;
use craft\helpers\Console;
use nystudio107\recipe\models\Settings;
use nystudio107\recipe\Recipe;
use yii\console\ExitCode;
use yii\helpers\BaseConsole;

/**

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
{
    /**

Missing short description in doc comment

     * @var ?string The handle of the section.
     */
    public ?string $section = null;

    /**

Missing short description in doc comment

     * @var ?string The handle of the recipe field.
     */
    public ?string $field = null;

    /**

Missing short description in doc comment

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

     * @inheritdoc
     */

Missing @return tag in function comment

    public function options($actionID): array
    {
        $options = parent::options($actionID);
        $options[] = 'section';
        $options[] = 'field';

        return $options;
    }

    /**
     * Generates nutritional information for all entries in a section provided using --section.
     */

Missing @return tag in function comment

    public function actionGenerate(): int
    {
        /** @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()) {
            $this->stderr(Craft::t('recipe', 'API credentials do not exist in plugin settings.') . PHP_EOL, BaseConsole::FG_RED);

            return ExitCode::OK;
        }

        if ($this->section === null) {
            $this->stderr(Craft::t('recipe', 'A section handle must be provided using --section.') . PHP_EOL, BaseConsole::FG_RED);

            return ExitCode::OK;
        }

        if ($this->field === null) {
            $this->stderr(Craft::t('recipe', 'A field handle must be provided using --field.') . PHP_EOL, BaseConsole::FG_RED);

            return ExitCode::OK;
        }

        $entries = Entry::find()->section($this->section)->all();

        if (empty($entries)) {
            $this->stderr(Craft::t('recipe', 'No entries found in the section with handle `{handle}`.', ['handle' => $this->section]) . PHP_EOL, BaseConsole::FG_RED);

            return ExitCode::OK;
        }

        $total = count($entries);
        $count = 0;
        $failed = 0;

        $this->stdout(Craft::t('recipe', 'Generating nutritional information for {count} entries...', ['count' => $total]) . PHP_EOL, BaseConsole::FG_YELLOW);

        Console::startProgress($count, $total, '', 0.8);

        foreach ($entries as $entry) {
            $field = $entry->{$this->field};
            $ingredients = $field->ingredients;

            foreach ($ingredients as $key => $value) {
                $ingredients[$key] = implode(' ', $value);
            }

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

            if (empty($nutritionalInfo['error'])) {
                $recipe = $entry->{$this->field};

                foreach ($nutritionalInfo as $fieldHandle => $value) {
                    $recipe[$fieldHandle] = $value;
                }

                $entry->setFieldValue($this->field, $recipe);

                if (!Craft::$app->getElements()->saveElement($entry)) {
                    ++$failed;
                }
            } else {
                ++$failed;
            }

            ++$count;

            Console::updateProgress($count, $total);
        }

        Console::endProgress();

        $succeeded = $count - $failed;

        $this->stdout(Craft::t('recipe', 'Successfully generated nutritional information for {count} entries.', ['count' => $succeeded]) . PHP_EOL, BaseConsole::FG_GREEN);

        if ($failed > 0) {
            $this->stderr(Craft::t('recipe', 'Failed to generate nutritional information for {count} entries.', ['count' => $failed]) . PHP_EOL, BaseConsole::FG_RED);
        }

        return ExitCode::OK;
    }
}