nystudio107\recipe\models\Recipe

Complexity

Total Complexity

91

Size/Duplication

Total Lines	769
Duplicated Lines	0 %

Importance

Changes	12
Bugs	0	Features	0

17 Methods

Rating	Name	Duplication	Size	Complexity
A	getServes()	0	7	2
B	getRecipeJSONLD()	0	94	8
C	convertToFractions()	0	57	13
A	getVideoUploadedDate()	0	11	4
A	renderJsonLd()	0	21	3
D	getIngredients()	0	102	23
A	rules()	0	34	1
A	init()	0	11	5
A	getEquipment()	0	14	4
A	getImageUrl()	0	11	4
A	getDirections()	0	14	4
A	getAggregateRating()	0	15	4
B	createRecipeMetaJsonLd()	0	34	9
A	renderRecipeJSONLD()	0	3	1
A	renderNutritionFacts()	0	6	1
A	getRatingsCount()	0	3	1
A	getVideoUrl()	0	11	4

<?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 nystudio107\recipe\helpers\Json;
use nystudio107\recipe\helpers\PluginTemplate;
use nystudio107\seomatic\Seomatic;

The type nystudio107\seomatic\Seomatic was not found. Maybe you did not declare it correctly or list all dependencies?

use nystudio107\seomatic\models\MetaJsonLd;

The type nystudio107\seomatic\models\MetaJsonLd was not found. Maybe you did not declare it correctly or list all dependencies?

use Craft;
use craft\base\Model;
use craft\helpers\StringHelper;
use craft\helpers\Template;
use craft\validators\ArrayValidator;

use Twig\Markup;

/**

Missing short description in doc comment

 * @author    nystudio107

Tag value for @author tag indented incorrectly; expected 2 spaces but found 4

Content of the @author tag must be in the form "Display Name <username@example.com>"

The tag in position 1 should be the @package tag

 * @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 Model
{
    // Constants
    // =========================================================================

    const SEOMATIC_PLUGIN_HANDLE = 'seomatic';
    const MAIN_ENTITY_KEY = 'mainEntityOfPage';

    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
    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 $name;

    /**

Missing short description in doc comment

     * @var string
     */
    public $description;

    /**

Missing short description in doc comment

     * @var string
     */
    public $recipeCategory;

    /**

Missing short description in doc comment

     * @var string
     */
    public $recipeCuisine;

    /**

Missing short description in doc comment

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

    /**

Missing short description in doc comment

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

    /**

Missing short description in doc comment

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

    /**

Missing short description in doc comment

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

    /**

Missing short description in doc comment

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

    /**

Missing short description in doc comment

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

    /**

Missing short description in doc comment

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

    /**

Missing short description in doc comment

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

    /**

Missing short description in doc comment

     * @var int
     */
    public $prepTime;

    /**

Missing short description in doc comment

     * @var int
     */
    public $cookTime;

    /**

Missing short description in doc comment

     * @var int
     */
    public $totalTime;

    /**

Missing short description in doc comment

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

    /**

Missing short description in doc comment

     * @var string
     */
    public $servingSize;

    /**

Missing short description in doc comment

     * @var int
     */
    public $calories;

    /**

Missing short description in doc comment

     * @var int
     */
    public $carbohydrateContent;

    /**

Missing short description in doc comment

     * @var int
     */
    public $cholesterolContent;

    /**

Missing short description in doc comment

     * @var int
     */
    public $fatContent;

    /**

Missing short description in doc comment

     * @var int
     */
    public $fiberContent;

    /**

Missing short description in doc comment

     * @var int
     */
    public $proteinContent;

    /**

Missing short description in doc comment

     * @var int
     */
    public $saturatedFatContent;

    /**

Missing short description in doc comment

     * @var int
     */
    public $sodiumContent;

    /**

Missing short description in doc comment

     * @var int
     */
    public $sugarContent;

    /**

Missing short description in doc comment

     * @var int
     */
    public $transFatContent;

    /**

Missing short description in doc comment

     * @var int
     */
    public $unsaturatedFatContent;

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

    /**

Missing short description in doc comment

     * @inheritdoc
     */

Missing @return tag in function comment

    public function init()
    {
        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()
    {
        return [
            ['name', 'string'],
            ['name', 'default', 'value' => ''],
            ['description', '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
     *
     * @return array
     */
    public function getRecipeJSONLD(): array
    {
        $recipeJSONLD = [
            'context' => 'http://schema.org',
            'type' => 'Recipe',
            'name' => $this->name,
            'image' => $this->getImageUrl(),
            'description' => $this->description,
            '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);

        $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) {
            $recipeJSONLD['prepTime'] = 'PT' . $this->prepTime . 'M';
        }
        if ($this->cookTime) {
            $recipeJSONLD['cookTime'] = 'PT' . $this->cookTime . 'M';
        }
        if ($this->totalTime) {
            $recipeJSONLD['totalTime'] = 'PT' . $this->totalTime . 'M';
        }

        return $recipeJSONLD;
    }

    /**
     * Create the SEOmatic MetaJsonLd object for this recipe
     *
     * @param bool $add

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

Doc comment for parameter $add does not match actual variable name $key

Missing parameter comment

     * @param null $key

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

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

Missing parameter comment

Doc comment for parameter $key does not match actual variable name $add

     * @return null|MetaJsonLd

Tag @return cannot be grouped with parameter tags in a doc comment

     */
    public function createRecipeMetaJsonLd($key = null, bool $add = true)
    {
        $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 $e) {
                        // 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) {
                        $recipeJson[self::MAIN_ENTITY_KEY] = $mainEntity[self::MAIN_ENTITY_KEY];
                    }
                }

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

        return $result;
    }

    /**
     * Render the JSON-LD Structured Data for this recipe
     *
     * @param bool $raw

Missing parameter comment

     *
     * @return string|\Twig_Markup
     */
    public function renderRecipeJSONLD($raw = true)
    {
        return $this->renderJsonLd($this->getRecipeJSONLD(), $raw);
    }

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

Missing parameter comment

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

     *
     * @return null|string
     */
    public function getImageUrl($transform = null)
    {
        $result = '';
        if (isset($this->imageId) && $this->imageId) {
            $image = Craft::$app->getAssets()->getAssetById($this->imageId[0]);
            if ($image) {
                $result = $image->getUrl($transform);
            }
        }

        return $result;
    }

    /**
     * Get the URL to the recipe's video
     *
     * @return null|string
     */
    public function getVideoUrl()
    {
        $result = '';
        if (isset($this->videoId) && $this->videoId) {
            $video = Craft::$app->getAssets()->getAssetById($this->videoId[0]);
            if ($video) {
                $result = $video->getUrl();
            }
        }

        return $result;
    }

    /**
     * Get the URL to the recipe's uploaded date
     *
     * @return null|string
     */
    public function getVideoUploadedDate()
    {
        $result = '';
        if (isset($this->videoId) && $this->videoId) {
            $video = Craft::$app->getAssets()->getAssetById($this->videoId[0]);
            if ($video) {
                $result = $video->dateCreated->format('c');
            }
        }

        return $result;
    }

    /**
     * Render the Nutrition Facts template
     *
     * @param array $rda

Missing parameter comment

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

     * @return Markup

Tag @return cannot be grouped with parameter tags in a doc comment

     */
    public function renderNutritionFacts(array $rda = self::US_RDA): Markup {

Opening brace should be on a new line

        return PluginTemplate::renderPluginTemplate(
            'recipe-nutrition-facts',
            [
                'value' => $this,
                'rda' => $rda,
            ]
        );
    }

    /**
     * Get all of the ingredients for this recipe
     *
     * @param string $outputUnits

Missing parameter comment

     * @param int    $serving

Missing parameter comment

     * @param bool   $raw

Missing parameter comment

     *
     * @return array
     */
    public function getIngredients($outputUnits = 'imperial', $serving = 0, $raw = true): array
    {
        $result = [];

        if (!empty($this->ingredients)) {
            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 24 spaces, found 28

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

Line indented incorrectly; expected 24 spaces, found 28

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

Line indented incorrectly; expected 24 spaces, found 28

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

Line indented incorrectly; expected 24 spaces, found 28

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

Line indented incorrectly; expected 24 spaces, found 28

                                $convertedUnits = 'lb';
                                $quantity *= 2.2046226218;
                                break;
                        }
                    }
                    // Do the metric->imperial units conversion
                    if ($outputUnits === 'metric') {
                        switch ($row['units']) {
                            case 'tsp':

Line indented incorrectly; expected 24 spaces, found 28

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

Line indented incorrectly; expected 24 spaces, found 28

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

Line indented incorrectly; expected 24 spaces, found 28

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

Line indented incorrectly; expected 24 spaces, found 28

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

Line indented incorrectly; expected 24 spaces, found 28

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

Line indented incorrectly; expected 24 spaces, found 28

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

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

Missing parameter comment

     *
     * @return string
     */
    private function convertToFractions($quantity)

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

    /**
     * Get all of the directions for this recipe
     *
     * @param bool $raw

Missing parameter comment

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

        return $result;
    }

    /**
     * Get all of the equipment for this recipe
     *
     * @param bool $raw

Missing parameter comment

     *
     * @return array
     */
    public function getEquipment($raw = true)
    {
        $result = [];
        if (!empty($this->equipment)) {
            foreach ($this->equipment as $row) {
                $equipment = $row['equipment'];
                if ($raw) {
                    $equipment = Template::raw(equipment);

The constant nystudio107\recipe\models\equipment was not found. Maybe you did not declare it correctly or list all dependencies?

                }
                $result[] = $equipment;
            }
        }

        return $result;
    }

    /**
     * Get the aggregate rating from all of the ratings
     *
     * @return float|int|string
     */
    public function getAggregateRating()
    {
        $result = 0;
        $total = 0;
        if (isset($this->ratings) && !empty($this->ratings)) {
            foreach ($this->ratings as $row) {
                $result += $row['rating'];
                $total++;
            }
            $result /= $total;
        } else {
            $result = '';
        }

        return $result;
    }

    /**
     * Get the total number of ratings
     *
     * @return int
     */
    public function getRatingsCount(): int
    {
        return count($this->ratings);
    }

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

Missing @return tag in function comment

    public function getServes(): string
    {
        if(!empty($this->servesUnit)) {

Expected "if (...) {\n"; found "if(...) {\n"

            return $this->serves . ' ' . $this->servesUnit;
        }

        return $this->serves;
    }

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

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

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

Missing parameter comment

     * @param bool $raw

Missing parameter comment

     *
     * @return string|\Twig_Markup
     */
    private function renderJsonLd($json, $raw = true)

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 === true) {
            $result = Template::raw($result);
        }

        return $result;
    }
}