nystudio107\recipe\models\Recipe

Complexity

Total Complexity

86

Size/Duplication

Total Lines	770
Duplicated Lines	0 %

Importance

Changes	15
Bugs	1	Features	0

17 Methods

Rating	Name	Duplication	Size	Complexity
A	renderJsonLd()	0	21	3
A	getServes()	0	7	2
C	getRecipeJSONLD()	0	108	9
C	convertToFractions()	0	58	13
A	getVideoUploadedDate()	0	11	3
F	getIngredients()	0	107	23
A	rules()	0	36	1
A	init()	0	12	5
A	getEquipment()	0	13	3
A	getImageUrl()	0	11	3
A	getDirections()	0	13	3
A	getAggregateRating()	0	16	3
B	createRecipeMetaJsonLd()	0	36	9
A	renderRecipeJSONLD()	0	3	1
A	renderNutritionFacts()	0	7	1
A	getRatingsCount()	0	3	1
A	getVideoUrl()	0	11	3

<?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\models;

use Craft;
use craft\base\Model;
use craft\helpers\StringHelper;
use craft\helpers\Template;
use craft\validators\ArrayValidator;
use Exception;
use nystudio107\recipe\helpers\Json;
use nystudio107\recipe\helpers\PluginTemplate;
use nystudio107\seomatic\models\MetaJsonLd;
use nystudio107\seomatic\Seomatic;
use Twig\Markup;

/**

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 @license tag in class comment

Missing @link tag in class comment

Missing @category tag in class comment

class Recipe extends Model
{
    // Constants
    // =========================================================================

    public const SEOMATIC_PLUGIN_HANDLE = 'seomatic';

    public const MAIN_ENTITY_KEY = 'mainEntityOfPage';

    public const US_RDA = [
        'calories' => 2000,
        'carbohydrateContent' => 275,
        'cholesterolContent' => 300,
        'fatContent' => 78,
        'fiberContent' => 28,
        'proteinContent' => 50,
        'saturatedFatContent' => 20,
        'sodiumContent' => 2300,
        'sugarContent' => 50,
    ];

    // Mapping to convert any of the incorrect plural values
    public const NORMALIZE_PLURALS = [
        'tsps' => 'tsp',
        'tbsps' => 'tbsp',
        'flozs' => 'floz',
        'cups' => 'cups',
        'ozs' => 'oz',
        'lbs' => 'lb',
        'mls' => 'ml',
        'ls' => 'l',
        'mgs' => 'mg',
        'gs' => 'g',
        'kg' => 'kg',
    ];

    // Public Properties
    // =========================================================================

    /**

Missing short description in doc comment

     * @var string
     */
    public string $name = '';

    /**

Missing short description in doc comment

     * @var string
     */
    public string $author = '';

    /**

Missing short description in doc comment

     * @var string
     */
    public string $description = '';

    /**

Missing short description in doc comment

     * @var string
     */
    public string $keywords = '';

    /**

Missing short description in doc comment

     * @var string
     */
    public string $recipeCategory = '';

    /**

Missing short description in doc comment

     * @var string
     */
    public string $recipeCuisine = '';

    /**

Missing short description in doc comment

     * @var string
     */
    public string $skill = 'intermediate';

    /**

Missing short description in doc comment

     * @var int
     */
    public int $serves = 1;

    /**

Missing short description in doc comment

     * @var string
     */
    public string $servesUnit = '';

    /**

Missing short description in doc comment

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

    /**

Missing short description in doc comment

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

    /**

Missing short description in doc comment

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

    /**

Missing short description in doc comment

     * @var ?int
     */
    public ?int $imageId = null;

    /**

Missing short description in doc comment

     * @var ?int
     */
    public ?int $videoId = null;

    /**

Missing short description in doc comment

     * @var int
     */
    public int $prepTime = 0;

    /**

Missing short description in doc comment

     * @var int
     */
    public int $cookTime = 0;

    /**

Missing short description in doc comment

     * @var int
     */
    public int $totalTime = 0;

    /**

Missing short description in doc comment

     * @var ?array
     */
    public ?array $ratings = null;

    /**

Missing short description in doc comment

     * @var string
     */
    public string $servingSize = '';

    /**

Missing short description in doc comment

     * @var int
     */
    public int $calories = 0;

    /**

Missing short description in doc comment

     * @var int
     */
    public int $carbohydrateContent = 0;

    /**

Missing short description in doc comment

     * @var int
     */
    public int $cholesterolContent = 0;

    /**

Missing short description in doc comment

     * @var int
     */
    public int $fatContent = 0;

    /**

Missing short description in doc comment

     * @var int
     */
    public int $fiberContent = 0;

    /**

Missing short description in doc comment

     * @var int
     */
    public int $proteinContent = 0;

    /**

Missing short description in doc comment

     * @var int
     */
    public int $saturatedFatContent = 0;

    /**

Missing short description in doc comment

     * @var int
     */
    public int $sodiumContent = 0;

    /**

Missing short description in doc comment

     * @var int
     */
    public int $sugarContent = 0;

    /**

Missing short description in doc comment

     * @var int
     */
    public int $transFatContent = 0;

    /**

Missing short description in doc comment

     * @var int
     */
    public int $unsaturatedFatContent = 0;

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

    /**

Missing short description in doc comment

     * @inheritdoc
     */

Missing @return tag in function comment

    public function init(): void
    {
        parent::init();
        // Fix any of the incorrect plural values
        if (!empty($this->ingredients)) {
            foreach ($this->ingredients as &$row) {
                if (!empty($row['units']) && !empty(self::NORMALIZE_PLURALS[$row['units']])) {
                    $row['units'] = self::NORMALIZE_PLURALS[$row['units']];
                }
            }

            unset($row);
        }
    }

    /**

Missing short description in doc comment

     * @inheritdoc
     */

Missing @return tag in function comment

    public function rules(): array
    {
        return [
            ['name', 'string'],
            ['author', 'string'],
            ['name', 'default', 'value' => ''],
            ['description', 'string'],
            ['keywords', 'string'],
            ['recipeCategory', 'string'],
            ['recipeCuisine', 'string'],
            ['skill', 'string'],
            ['serves', 'integer'],
            ['imageId', 'integer'],
            ['videoId', 'integer'],
            ['prepTime', 'integer'],
            ['cookTime', 'integer'],
            ['totalTime', 'integer'],
            ['servingSize', 'string'],
            ['calories', 'integer'],
            ['carbohydrateContent', 'integer'],
            ['cholesterolContent', 'integer'],
            ['fatContent', 'integer'],
            ['fiberContent', 'integer'],
            ['proteinContent', 'integer'],
            ['saturatedFatContent', 'integer'],
            ['sodiumContent', 'integer'],
            ['sugarContent', 'integer'],
            ['transFatContent', 'integer'],
            ['unsaturatedFatContent', 'integer'],
            [
                [
                    'ingredients',
                    'directions',
                    'equipment',
                ],
                ArrayValidator::class,
            ],

        ];
    }

    /**
     * Return the JSON-LD Structured Data for this recipe
     */

Missing @return tag in function comment

    public function getRecipeJSONLD(): array
    {
        $recipeJSONLD = [
            'context' => 'https://schema.org',
            'type' => 'Recipe',
            'name' => $this->name,
            'image' => $this->getImageUrl(),
            'description' => $this->description,
            'keywords' => $this->keywords,
            'recipeCategory' => $this->recipeCategory,
            'recipeCuisine' => $this->recipeCuisine,
            'recipeYield' => $this->getServes(),
            'recipeIngredient' => $this->getIngredients('imperial', 0, false),
            'recipeInstructions' => $this->getDirections(false),
            'tool' => $this->getEquipment(false),
        ];
        $recipeJSONLD = array_filter($recipeJSONLD);

        if (!empty($this->author)) {
            $author = [
                'type' => 'Person',
                'name' => $this->author,
            ];
            $author = array_filter($author);
            $recipeJSONLD['author'] = $author;
        }

        $videoUrl = $this->getVideoUrl();
        if (!empty($videoUrl)) {
            $video = [
                'type' => 'VideoObject',
                'name' => $this->name,
                'description' => $this->description,
                'contentUrl' => $videoUrl,
                'thumbnailUrl' => $this->getImageUrl(),
                'uploadDate' => $this->getVideoUploadedDate(),
            ];
            $video = array_filter($video);
            $recipeJSONLD['video'] = $video;
        }

        $nutrition = [
            'type' => 'NutritionInformation',
            'servingSize' => $this->servingSize,
            'calories' => $this->calories,
            'carbohydrateContent' => $this->carbohydrateContent,
            'cholesterolContent' => $this->cholesterolContent,
            'fatContent' => $this->fatContent,
            'fiberContent' => $this->fiberContent,
            'proteinContent' => $this->proteinContent,
            'saturatedFatContent' => $this->saturatedFatContent,
            'sodiumContent' => $this->sodiumContent,
            'sugarContent' => $this->sugarContent,
            'transFatContent' => $this->transFatContent,
            'unsaturatedFatContent' => $this->unsaturatedFatContent,
        ];
        $nutrition = array_filter($nutrition);
        $recipeJSONLD['nutrition'] = $nutrition;
        if (count($recipeJSONLD['nutrition']) === 1) {
            unset($recipeJSONLD['nutrition']);
        }

        $aggregateRating = $this->getAggregateRating();
        if ($aggregateRating) {
            $aggregateRatings = [
                'type' => 'AggregateRating',
                'ratingCount' => $this->getRatingsCount(),
                'bestRating' => '5',
                'worstRating' => '1',
                'ratingValue' => $aggregateRating,
            ];
            $aggregateRatings = array_filter($aggregateRatings);
            $recipeJSONLD['aggregateRating'] = $aggregateRatings;

            $reviews = [];
            foreach ($this->ratings as $rating) {
                $review = [
                    'type' => 'Review',
                    'author' => $rating['author'],
                    'name' => $this->name . ' ' . Craft::t('recipe', 'Review'),
                    'description' => $rating['review'],
                    'reviewRating' => [
                        'type' => 'Rating',
                        'bestRating' => '5',
                        'worstRating' => '1',
                        'ratingValue' => $rating['rating'],
                    ],
                ];
                $reviews[] = $review;
            }

            $reviews = array_filter($reviews);
            $recipeJSONLD['review'] = $reviews;
        }

        if ($this->prepTime !== 0) {
            $recipeJSONLD['prepTime'] = 'PT' . $this->prepTime . 'M';
        }

        if ($this->cookTime !== 0) {
            $recipeJSONLD['cookTime'] = 'PT' . $this->cookTime . 'M';
        }

        if ($this->totalTime !== 0) {
            $recipeJSONLD['totalTime'] = 'PT' . $this->totalTime . 'M';
        }

        return $recipeJSONLD;
    }

    /**

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

     * Create the SEOmatic MetaJsonLd object for this recipe
     *
     * @param null $key

Are you sure the doc-type for parameter $key is correct as it would always require null to be passed?

Missing parameter comment

     */

Missing @return tag in function comment

    public function createRecipeMetaJsonLd($key = null, bool $add = true): ?MetaJsonLd
    {
        $result = null;
        if (Craft::$app->getPlugins()->getPlugin(self::SEOMATIC_PLUGIN_HANDLE)) {
            $seomatic = Seomatic::getInstance();
            if ($seomatic !== null) {
                $recipeJson = $this->getRecipeJSONLD();
                // If we're adding the MetaJsonLd to the container, and no key is provided, give it a random key
                if ($add && $key === null) {
                    try {
                        $key = StringHelper::UUID();
                    } catch (Exception) {
                        // That's okay
                    }
                }

                if ($key !== null) {
                    $recipeJson['key'] = $key;
                }

                // If the key is `mainEntityOfPage` add in the URL
                if ($key === self::MAIN_ENTITY_KEY) {
                    $mainEntity = Seomatic::$plugin->jsonLd->get(self::MAIN_ENTITY_KEY);
                    if ($mainEntity !== null) {
                        $recipeJson[self::MAIN_ENTITY_KEY] = $mainEntity[self::MAIN_ENTITY_KEY];
                    }
                }

                $result = Seomatic::$plugin->jsonLd->create(
                    $recipeJson,
                    $add
                );
            }
        }

        return $result;
    }

    /**

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

     * Render the JSON-LD Structured Data for this recipe
     *
     *
     */

Additional blank lines found at end of doc comment

Missing @return tag in function comment

    public function renderRecipeJSONLD(bool $raw = true): string|Markup
    {
        return $this->renderJsonLd($this->getRecipeJSONLD(), $raw);
    }

    /**
     * Get the URL to the recipe's image
     *
     * @param null $transform

Are you sure the doc-type for parameter $transform is correct as it would always require null to be passed?

Missing parameter comment

     */

Missing @return tag in function comment

    public function getImageUrl($transform = null): ?string
    {
        $result = '';
        if ($this->imageId) {

The expression $this->imageId of type integer|null is loosely compared to true; this is ambiguous if the integer can be 0. You might want to explicitly use !== null instead.

            $image = Craft::$app->getAssets()->getAssetById($this->imageId);
            if ($image) {
                $result = $image->getUrl($transform);
            }
        }

        return $result;
    }

    /**
     * Get the URL to the recipe's video
     */

Missing @return tag in function comment

    public function getVideoUrl(): ?string
    {
        $result = '';
        if ($this->videoId) {

The expression $this->videoId of type integer|null is loosely compared to true; this is ambiguous if the integer can be 0. You might want to explicitly use !== null instead.

            $video = Craft::$app->getAssets()->getAssetById($this->videoId);
            if ($video) {
                $result = $video->getUrl();
            }
        }

        return $result;
    }

    /**
     * Get the URL to the recipe's uploaded date
     */

Missing @return tag in function comment

    public function getVideoUploadedDate(): ?string
    {
        $result = '';
        if ($this->videoId) {

The expression $this->videoId of type integer|null is loosely compared to true; this is ambiguous if the integer can be 0. You might want to explicitly use !== null instead.

            $video = Craft::$app->getAssets()->getAssetById($this->videoId);
            if ($video) {
                $result = $video->dateCreated->format('c');
            }
        }

        return $result;
    }

    /**

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

     * Render the Nutrition Facts template
     */

Missing @return tag in function comment

    public function renderNutritionFacts(array $rda = self::US_RDA): Markup
    {
        return PluginTemplate::renderPluginTemplate(
            'recipe-nutrition-facts',
            [
                'value' => $this,
                'rda' => $rda,
            ]
        );
    }

    /**

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

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

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

     * Get all the ingredients for this recipe
     */

Missing @return tag in function comment

    public function getIngredients(string $outputUnits = 'imperial', int $serving = 0, bool $raw = true): array
    {
        $result = [];

        foreach ($this->ingredients as $row) {
            $convertedUnits = '';
            $ingredient = '';
            if ($row['quantity']) {
                // Multiply the quantity by how many servings we want
                $multiplier = 1;
                if ($serving > 0) {
                    $multiplier = $serving / $this->serves;
                }

                $quantity = $row['quantity'] * $multiplier;
                $originalQuantity = $quantity;

                // Do the imperial->metric units conversion
                if ($outputUnits === 'imperial') {
                    switch ($row['units']) {
                        case 'ml':

Line indented incorrectly; expected 20 spaces, found 24

                            $convertedUnits = 'tsp';
                            $quantity *= 0.2;
                            break;
                        case 'l':

Line indented incorrectly; expected 20 spaces, found 24

                            $convertedUnits = 'cups';
                            $quantity *= 4.2;
                            break;
                        case 'mg':

Line indented incorrectly; expected 20 spaces, found 24

                            $convertedUnits = 'oz';
                            $quantity *= 0.000035274;
                            break;
                        case 'g':

Line indented incorrectly; expected 20 spaces, found 24

                            $convertedUnits = 'oz';
                            $quantity *= 0.035274;
                            break;
                        case 'kg':

Line indented incorrectly; expected 20 spaces, found 24

                            $convertedUnits = 'lb';
                            $quantity *= 2.2046226218;
                            break;
                    }
                }

                // Do the metric->imperial units conversion
                if ($outputUnits === 'metric') {
                    switch ($row['units']) {
                        case 'tsp':

Line indented incorrectly; expected 20 spaces, found 24

                            $convertedUnits = 'ml';
                            $quantity *= 4.929;
                            break;
                        case 'tbsp':

Line indented incorrectly; expected 20 spaces, found 24

                            $convertedUnits = 'ml';
                            $quantity *= 14.787;
                            break;
                        case 'floz':

Line indented incorrectly; expected 20 spaces, found 24

                            $convertedUnits = 'ml';
                            $quantity *= 29.574;
                            break;
                        case 'cups':

Line indented incorrectly; expected 20 spaces, found 24

                            $convertedUnits = 'l';
                            $quantity *= 0.236588;
                            break;
                        case 'oz':

Line indented incorrectly; expected 20 spaces, found 24

                            $convertedUnits = 'g';
                            $quantity *= 28.3495;
                            break;
                        case 'lb':

Line indented incorrectly; expected 20 spaces, found 24

                            $convertedUnits = 'kg';
                            $quantity *= 0.45359237;
                            break;
                    }

                    $quantity = round($quantity, 1);
                }

                // Convert units to nice fractions
                $quantity = $this->convertToFractions($quantity);

                $ingredient .= $quantity;

                if ($row['units']) {
                    $units = $row['units'];
                    if ($convertedUnits !== '' && $convertedUnits !== '0') {
                        $units = $convertedUnits;
                    }

                    if ($originalQuantity <= 1) {
                        $units = rtrim($units);
                        $units = rtrim($units, 's');
                    }

                    $ingredient .= ' ' . $units;
                }
            }

            if ($row['ingredient']) {
                $ingredient .= ' ' . $row['ingredient'];
            }

            if ($raw) {
                $ingredient = Template::raw($ingredient);
            }

            $result[] = $ingredient;
        }

        return $result;
    }

    /**

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

     * Get all the directions for this recipe
     *
     *
     * @return array

There must be exactly one blank line before the tags in a doc comment

     */
    public function getDirections(bool $raw = true): array
    {
        $result = [];
        foreach ($this->directions as $row) {
            $direction = $row['direction'];
            if ($raw) {
                $direction = Template::raw($direction);
            }

            $result[] = $direction;
        }

        return $result;
    }

    /**

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

     * Get all the equipment for this recipe
     */

Missing @return tag in function comment

    public function getEquipment(bool $raw = true): array
    {
        $result = [];
        foreach ($this->equipment as $row) {
            $equipment = $row['equipment'];
            if ($raw) {
                $equipment = Template::raw($equipment);
            }

            $result[] = $equipment;
        }

        return $result;
    }

    /**
     * Get the aggregate rating from all the ratings
     */

Missing @return tag in function comment

    public function getAggregateRating(): float|int|string
    {
        $result = 0;
        $total = 0;
        if (!empty($this->ratings)) {
            foreach ($this->ratings as $row) {
                $result += $row['rating'];
                ++$total;
            }

            $result /= $total;
        } else {
            $result = '';
        }

        return $result;
    }

    /**
     * Get the total number of ratings
     */

Missing @return tag in function comment

    public function getRatingsCount(): int
    {
        return count($this->ratings);

It seems like $this->ratings can also be of type null; however, parameter $value of count() does only seem to accept Countable|array, maybe add an additional type check?

    }

    /**
     * Returns concatenated serves with its unit
     */

Missing @return tag in function comment

    public function getServes(): int|string
    {
        if (!empty($this->servesUnit)) {
            return $this->serves . ' ' . $this->servesUnit;
        }

        return $this->serves;
    }

    /**
     * Convert decimal numbers into fractions
     *
     * @param $quantity

Missing parameter comment

     */

Missing @return tag in function comment

    private function convertToFractions($quantity): string

Private method name "Recipe::convertToFractions" must be prefixed with an underscore

    {
        $whole = floor($quantity);
        // Round the mantissa so we can do a floating point comparison without
        // weirdness, per: https://www.php.net/manual/en/language.types.float.php#113703
        $fraction = round($quantity - $whole, 3);
        switch ($fraction) {
            case 0:

Line indented incorrectly; expected 8 spaces, found 12

                $fraction = '';
                break;
            case 0.25:

Line indented incorrectly; expected 8 spaces, found 12

                $fraction = ' ¼';
                break;
            case 0.33:

Line indented incorrectly; expected 8 spaces, found 12

                $fraction = ' ⅓';
                break;
            case 0.66:

Line indented incorrectly; expected 8 spaces, found 12

                $fraction = ' ⅔';
                break;
            case 0.165:

Line indented incorrectly; expected 8 spaces, found 12

                $fraction = ' ⅙';
                break;
            case 0.5:

Line indented incorrectly; expected 8 spaces, found 12

                $fraction = ' ½';
                break;
            case 0.75:

Line indented incorrectly; expected 8 spaces, found 12

                $fraction = ' ¾';
                break;
            case 0.125:

Line indented incorrectly; expected 8 spaces, found 12

                $fraction = ' ⅛';
                break;
            case 0.375:

Line indented incorrectly; expected 8 spaces, found 12

                $fraction = ' ⅜';
                break;
            case 0.625:

Line indented incorrectly; expected 8 spaces, found 12

                $fraction = ' ⅝';
                break;
            case 0.875:

Line indented incorrectly; expected 8 spaces, found 12

                $fraction = ' ⅞';
                break;
            default:

Line indented incorrectly; expected 8 spaces, found 12

                $precision = 1;
                $pnum = round($fraction, $precision);
                $denominator = 10 ** $precision;
                $numerator = $pnum * $denominator;
                $fraction = ' <sup>'
                    . $numerator
                    . '</sup>&frasl;<sub>'
                    . $denominator
                    . '</sub>';
                break;
        }

        if ($whole == 0) {
            $whole = '';
        }

        return $whole . $fraction;
    }

    // Private Methods
    // =========================================================================

    /**

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

     * Renders a JSON-LD representation of the schema
     *
     * @param      $json

Missing parameter comment

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

     */

Missing @return tag in function comment

    private function renderJsonLd($json, bool $raw = true): string|Markup

Private method name "Recipe::renderJsonLd" must be prefixed with an underscore

    {
        $linebreak = '';

        // If `devMode` is enabled, make the JSON-LD human-readable
        if (Craft::$app->getConfig()->getGeneral()->devMode) {
            $linebreak = PHP_EOL;
        }

        // Render the resulting JSON-LD
        $result = '<script type="application/ld+json">'
            . $linebreak
            . Json::encode($json)
            . $linebreak
            . '</script>';

        if ($raw) {
            $result = Template::raw($result);
        }

        return $result;
    }
}