nystudio107 / craft-recipe

src/fields/Recipe.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\fields;

use Craft;
use craft\base\ElementInterface;

The type craft\base\ElementInterface was not found. Maybe you did not declare it correctly or list all dependencies?

use craft\base\Field;
use craft\base\PreviewableFieldInterface;
use craft\elements\Asset;

The type craft\elements\Asset was not found. Maybe you did not declare it correctly or list all dependencies?

use craft\helpers\Html;
use craft\helpers\Json;
use nystudio107\recipe\assetbundles\recipefield\RecipeFieldAsset;
use nystudio107\recipe\models\Recipe as RecipeModel;
use nystudio107\recipe\models\Settings;
use nystudio107\recipe\Recipe as RecipePlugin;
use Throwable;
use yii\base\InvalidConfigException;
use yii\db\Schema;

/**

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.0.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 Recipe extends Field implements PreviewableFieldInterface
{
    // Public Properties
    // =========================================================================

    /**

Missing short description in doc comment

     * @var array
     */
    public array $assetSources = [];

    // Static Methods
    // =========================================================================

    /**

Missing short description in doc comment

     * @inheritdoc
     */

Missing @return tag in function comment

    public static function dbType(): array|string|null
    {
        return Schema::TYPE_TEXT;
    }

    /**

Missing short description in doc comment

     * @inheritdoc
     */

Missing @return tag in function comment

    public static function displayName(): string
    {
        return Craft::t('recipe', 'Recipe');
    }

    /**

Missing short description in doc comment

     * @inheritdoc
     */

Missing @return tag in function comment

    public static function icon(): string
    {
        return 'hat-chef';
    }

    /**

Missing short description in doc comment

     * @inheritdoc
     */

Missing @return tag in function comment

    public static function phpType(): string
    {
        return sprintf('\\%s', RecipeModel::class);
    }

    // Public Methods
    // =========================================================================

    /**

Missing short description in doc comment

     * @inheritdoc
     */

Missing @return tag in function comment

    public function rules(): array
    {
        $rules = parent::rules();

        return array_merge($rules, [

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

        ]);

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

    }

    /**

Missing short description in doc comment

     * @inheritdoc
     * @since 1.2.1

Tag value for @since tag indented incorrectly; expected 6 spaces but found 1

     */

Missing @return tag in function comment

    public function useFieldset(): bool
    {
        return true;
    }

    /**

Missing short description in doc comment

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

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

     * @inheritdoc
     */

Missing @return tag in function comment

    public function normalizeValue(mixed $value, ?ElementInterface $element = null): RecipeModel
    {
        $config = [];
        // If we already have a model, just return it
        if ($value instanceof RecipeModel) {
            return $value;
        }
        // If we have a non-empty string, try to JSON-decode it
        if (is_string($value)) {
            $value = Json::decodeIfJson($value);
        }
        // If we have an array, use that for our config data
        if (is_array($value)) {
            $config = $value;
        }
        // Ensure we save our asset ids as integers, not arrays
        if (isset($config['imageId'])) {
            if (is_array($config['imageId'])) {
                $config['imageId'] = $config['imageId'][0];
            }
        }
        if (isset($config['videoId'])) {
            if (is_array($config['videoId'])) {
                $config['videoId'] = $config['videoId'][0];
            }
        }

        return new RecipeModel($config);
    }

    /**

Missing short description in doc comment

     * @inheritdoc
     */

Missing @return tag in function comment

    public function getSettingsHtml(): ?string
    {
        // Render the settings template
        return Craft::$app->getView()->renderTemplate(
            'recipe/_components/fields/Recipe_settings',
            [
                'field' => $this,
                'assetSources' => $this->getSourceOptions(),
            ]
        );
    }

    /**

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

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

Missing short description in doc comment

     * @inheritdoc
     */

Missing @return tag in function comment

    public function getInputHtml(mixed $value, ?ElementInterface $element = null): string
    {
        // Register our asset bundle
        try {
            Craft::$app->getView()->registerAssetBundle(RecipeFieldAsset::class);
        } catch (InvalidConfigException $invalidConfigException) {
            Craft::error($invalidConfigException->getMessage(), __METHOD__);
        }

        // Get our id and namespace
        $id = Html::id($this->handle);
        $nameSpacedId = Craft::$app->getView()->namespaceInputId($id);

        // Variables to pass down to our field JavaScript to let it namespace properly
        $jsonVars = [
            'id' => $id,
            'name' => $this->handle,
            'namespace' => $nameSpacedId,
            'prefix' => Craft::$app->getView()->namespaceInputId(''),
        ];
        $jsonVars = Json::encode($jsonVars);
        Craft::$app->getView()->registerJs(sprintf('$(\'#%s-field\').RecipeRecipe(', $nameSpacedId) . $jsonVars . ");");

        // Set asset elements
        $elements = [];
        if ($value->imageId) {
            if (is_array($value->imageId)) {
                $value->imageId = $value->imageId[0];
            }

            $elements = [Craft::$app->getAssets()->getAssetById($value->imageId)];
        }

        $videoElements = [];
        if ($value->videoId) {
            if (is_array($value->videoId)) {
                $value->videoId = $value->videoId[0];
            }

            $videoElements = [Craft::$app->getAssets()->getAssetById($value->videoId)];
        }

        /** @var Settings $settings */

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

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

Missing short description in doc comment

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

The method getSettings() does not exist on null.

        // Render the input template
        try {
            return Craft::$app->getView()->renderTemplate(
                'recipe/_components/fields/Recipe_input',
                [
                    'name' => $this->handle,
                    'value' => $value,
                    'field' => $this,
                    'id' => $id,
                    'nameSpacedId' => $nameSpacedId,
                    'prefix' => Craft::$app->getView()->namespaceInputId(''),
                    'assetsSourceExists' => count(Craft::$app->getAssets()->findFolders()),
                    'elements' => $elements,
                    'videoElements' => $videoElements,
                    'elementType' => Asset::class,
                    'assetSources' => $this->assetSources,
                    'hasApiCredentials' => $settings->hasApiCredentials(),
                ]
            );
        } catch (Throwable $throwable) {
            Craft::error($throwable->getMessage(), __METHOD__);
            return '';
        }
    }

    /**
     * Get the asset sources
     */

Missing @return tag in function comment

    public function getSourceOptions(): array
    {
        $sourceOptions = [];

        foreach (Asset::sources('settings') as $volume) {
            if (!isset($volume['heading'])) {
                $sourceOptions[] = [
                    'label' => Html::encode($volume['label']),
                    'value' => $volume['key'],
                ];
            }
        }

        return $sourceOptions;
    }
}