Recipe::dbType() - Code Metrics - Inspection of "Merge branch 'release/5.0.0' into v5" - nystudio107/craft-recipe - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — v5 ( 1b075a...467c6f )

by Andrew
created 2024-10-08 19:01 UTC
Recipe::dbType() A

↳ Parent: Recipe
Complexity

Conditions	1
Paths	1
Size

Total Lines	3
Code Lines	1
Duplication

Lines	0
Ratio	0 %
Importance

Changes	1
Bugs	0	Features	0
Metric	Value
cc	1
eloc	1
c	1
b	0
f	0
nc	1
nop	0
dl	0
loc	3
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\fields;

use Craft;
use craft\base\ElementInterface;
filter:
    dependency_paths: ["lib/*"]
use craft\base\Field;
use craft\base\PreviewableFieldInterface;
use craft\elements\Asset;
filter:
    dependency_paths: ["lib/*"]
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;

/**

 * @author    nystudio107

 * @package   Recipe

 * @since     1.0.0

 */

class Recipe extends Field implements PreviewableFieldInterface
{
    // Public Properties
    // =========================================================================

    /**

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

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

    /**

     * @inheritdoc
     */

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

    /**

     * @inheritdoc
     */

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

    /**

     * @inheritdoc
     */

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

    /**

     * @inheritdoc
     */

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

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

    /**

     * @inheritdoc
     */

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

        return array_merge($rules, [

        ]);
someFunctionCall(
    $firstArgument,
    $secondArgument,
    $thirdArgument
); // Closing parenthesis on a new line.
    }

    /**

     * @inheritdoc
     * @since 1.2.1

     */

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

    /**

     * @inheritdoc
     */

    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);
    }

    /**

     * @inheritdoc
     */

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

    /**

     * @inheritdoc
     */

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

        $settings = RecipePlugin::$plugin->getSettings();
        $settings = RecipePlugin::$plugin->getSettings();
        // 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
     */

    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;
    }
}

nystudio107 / craft-recipe

Push — v5 ( 1b075a...467c6f )

Recipe::dbType() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
