├── CHANGELOG.md
├── phpstan.neon
├── src
    ├── assetbundles
    │   ├── recipe
    │   │   ├── dist
    │   │   │   ├── css
    │   │   │   │   └── Recipe.css
    │   │   │   ├── js
    │   │   │   │   └── Recipe.js
    │   │   │   └── img
    │   │   │   │   └── Recipe-icon.svg
    │   │   └── RecipeAsset.php
    │   └── recipefield
    │   │   ├── dist
    │   │       ├── img
    │   │       │   ├── Star-icon.svg
    │   │       │   ├── star.svg
    │   │       │   ├── Recipe-icon.svg
    │   │       │   ├── icon.svg
    │   │       │   ├── Healthy-icon.svg
    │   │       │   └── healthy.svg
    │   │       ├── css
    │   │       │   └── Recipe.css
    │   │       └── js
    │   │       │   └── Recipe.js
    │   │   └── RecipeFieldAsset.php
    ├── templates
    │   ├── settings.twig
    │   ├── _components
    │   │   └── fields
    │   │   │   ├── Recipe_settings.twig
    │   │   │   └── Recipe_input.twig
    │   ├── welcome.twig
    │   ├── _integrations
    │   │   └── feed-me.twig
    │   └── recipe-nutrition-facts.twig
    ├── config.php
    ├── models
    │   ├── Settings.php
    │   └── Recipe.php
    ├── services
    │   ├── ServicesTrait.php
    │   └── NutritionApi.php
    ├── controllers
    │   └── NutritionApiController.php
    ├── icon.svg
    ├── translations
    │   └── en
    │   │   └── recipe.php
    ├── integrations
    │   └── RecipeFeedMeField.php
    ├── helpers
    │   ├── Json.php
    │   └── PluginTemplate.php
    ├── Recipe.php
    ├── console
    │   └── controllers
    │   │   └── NutritionApiController.php
    └── fields
    │   └── Recipe.php
├── ecs.php
├── Makefile
├── LICENSE.md
├── composer.json
└── README.md


/CHANGELOG.md:
--------------------------------------------------------------------------------
1 | # Recipe Changelog
2 | 
3 | ## 5.0.0 - 2024.10.08
4 | ### Added
5 | * Initial Craft CMS 5 release
6 | 


--------------------------------------------------------------------------------
/phpstan.neon:
--------------------------------------------------------------------------------
1 | includes:
2 |     - %currentWorkingDirectory%/vendor/craftcms/phpstan/phpstan.neon
3 | 
4 | parameters:
5 |     level: 5
6 |     paths:
7 |         - src
8 | 


--------------------------------------------------------------------------------
/src/assetbundles/recipe/dist/css/Recipe.css:
--------------------------------------------------------------------------------
 1 | /**
 2 |  * Recipe plugin for Craft CMS
 3 |  *
 4 |  * Recipe CSS
 5 |  *
 6 |  * @author    nystudio107
 7 |  * @copyright Copyright (c) 2017 nystudio107
 8 |  * @link      https://nystudio107.com
 9 |  * @package   Recipe
10 |  * @since     1.0.0
11 |  */
12 | 


--------------------------------------------------------------------------------
/src/assetbundles/recipe/dist/js/Recipe.js:
--------------------------------------------------------------------------------
 1 | /**
 2 |  * Recipe plugin for Craft CMS
 3 |  *
 4 |  * Recipe JS
 5 |  *
 6 |  * @author    nystudio107
 7 |  * @copyright Copyright (c) 2017 nystudio107
 8 |  * @link      https://nystudio107.com
 9 |  * @package   Recipe
10 |  * @since     1.0.0
11 |  */
12 | 


--------------------------------------------------------------------------------
/src/assetbundles/recipefield/dist/img/Star-icon.svg:
--------------------------------------------------------------------------------
1 | <svg xmlns="http://www.w3.org/2000/svg" width="612" height="582.04"><path fill="#FFCD00" d="M612 222.32l-202.69-42.778L306 0v497.506l189.113 84.534-21.95-205.987"/><path fill="#FFDA44" d="M202.69 179.542L0 222.322l138.838 153.73-21.95 205.988L306 497.506V0"/></svg>


--------------------------------------------------------------------------------
/ecs.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | use craft\ecs\SetList;
 4 | use Symplify\EasyCodingStandard\Config\ECSConfig;
 5 | 
 6 | return static function(ECSConfig $ecsConfig): void {
 7 |     $ecsConfig->paths([
 8 |         __DIR__ . '/src',
 9 |         __FILE__,
10 |     ]);
11 |     $ecsConfig->parallel();
12 |     $ecsConfig->sets([SetList::CRAFT_CMS_4]);
13 | };
14 | 


--------------------------------------------------------------------------------
/Makefile:
--------------------------------------------------------------------------------
 1 | MAJOR_VERSION?=5
 2 | PLUGINDEV_PROJECT_DIR?=/Users/andrew/webdev/sites/plugindev/cms_v${MAJOR_VERSION}/
 3 | VENDOR?=nystudio107
 4 | PROJECT_PATH?=${VENDOR}/$(shell basename $(CURDIR))
 5 | 
 6 | .PHONY: dev docs release
 7 | 
 8 | # Start up the buildchain dev server
 9 | dev:
10 | # Start up the docs dev server
11 | docs:
12 | 	${MAKE} -C docs/ dev
13 | # Run code quality tools, tests, and build the buildchain & docs in preparation for a release
14 | release: --code-quality --code-tests --buildchain-clean-build --docs-clean-build
15 | # The internal targets used by the dev & release targets
16 | --buildchain-clean-build:
17 | --code-quality:
18 | 	${MAKE} -C ${PLUGINDEV_PROJECT_DIR} -- ecs check vendor/${PROJECT_PATH}/src --fix
19 | 	${MAKE} -C ${PLUGINDEV_PROJECT_DIR} -- phpstan analyze -c vendor/${PROJECT_PATH}/phpstan.neon
20 | --code-tests:
21 | --docs-clean-build:
22 | 	${MAKE} -C docs/ clean
23 | 	${MAKE} -C docs/ image-build
24 | 	${MAKE} -C docs/ fix
25 | 


--------------------------------------------------------------------------------
/src/templates/settings.twig:
--------------------------------------------------------------------------------
 1 | {% import '_includes/forms' as forms %}
 2 | 
 3 | 
 4 | <h3>
 5 | 	{{ 'The [Edamam Nutrition Analysis API]({url}) can be used to fetch nutritional information from your ingredients.'|t('recipe', { url: 'https://developer.edamam.com/edamam-nutrition-api' })|md }}
 6 | </h3>
 7 | 
 8 | <br>
 9 | 
10 | {{ forms.autosuggestField({
11 | 	label: 'API Application ID'|t('blitz'),
12 | 	instructions: 'An application ID for the Edamam Nutrition Analysis API.'|t('recipe'),
13 | 	suggestEnvVars: true,
14 | 	name: 'apiApplicationId',
15 | 	value: settings.apiApplicationId,
16 | 	errors: settings.getErrors('apiApplicationId'),
17 | 	first: true,
18 | }) }}
19 | 
20 | {{ forms.autosuggestField({
21 | 	label: 'API Application Key'|t('recipe'),
22 | 	instructions: 'An application ID for the Edamam Nutrition Analysis API.'|t('recipe'),
23 | 	suggestEnvVars: true,
24 | 	name: 'apiApplicationKey',
25 | 	value: settings.apiApplicationKey,
26 | 	errors: settings.getErrors('apiApplicationKey'),
27 | }) }}
28 | 


--------------------------------------------------------------------------------
/src/config.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * @copyright Copyright (c) PutYourLightsOn
 4 |  */
 5 | 
 6 | /**
 7 |  * Recipe config.php
 8 |  *
 9 |  * This file exists only as a template for the Recipe settings.
10 |  * It does nothing on its own.
11 |  *
12 |  * Don't edit this file, instead copy it to 'craft/config' as 'recipe.php'
13 |  * and make your changes there to override default settings.
14 |  *
15 |  * Once copied to 'craft/config', this file will be multi-environment aware as
16 |  * well, so you can have different settings groups for each environment, just as
17 |  * you do for 'general.php'
18 |  */
19 | 
20 | return [
21 |     '*' => [
22 |         // An application ID for the Edamam Nutrition Analysis API (https://developer.edamam.com/edamam-nutrition-api).
23 |         //'apiApplicationId' => '1a2b3c4e',
24 | 
25 |         // An application key for the Edamam Nutrition Analysis API (https://developer.edamam.com/edamam-nutrition-api).
26 |         //'apiApplicationId' => '1a2b3c4e5f6g7h8i9j0k',
27 |     ],
28 | ];
29 | 


--------------------------------------------------------------------------------
/src/templates/_components/fields/Recipe_settings.twig:
--------------------------------------------------------------------------------
 1 | {#
 2 | /**
 3 |  * Recipe plugin for Craft CMS
 4 |  *
 5 |  * Recipe Field Settings
 6 |  *
 7 |  * @author    nystudio107
 8 |  * @copyright Copyright (c) 2017 nystudio107
 9 |  * @link      https://nystudio107.com
10 |  * @package   Recipe
11 |  * @since     1.0.0
12 |  */
13 | #}
14 | 
15 | {% import "_includes/forms" as forms %}
16 | 
17 | {% do view.registerAssetBundle("nystudio107\\recipe\\assetbundles\\recipe\\RecipeAsset") %}
18 | 
19 | <div>
20 |     {% if assetSources %}
21 |         {{ forms.checkboxSelectField({
22 |             label: "Asset Sources"|t,
23 |             instructions: "Which sources do you want to select assets from?"|t,
24 |             id: 'assetSources',
25 |             name: 'assetSources',
26 |             options: assetSources,
27 |             values: field['assetSources']
28 |         }) }}
29 |     {% else %}
30 |         {{ forms.field({
31 |             label: "Asset Sources"|t,
32 |         }, '<p class="error">' ~ "No asset sources exist yet."|t ~ '</p>') }}
33 |     {% endif %}
34 | 
35 | </div>


--------------------------------------------------------------------------------
/LICENSE.md:
--------------------------------------------------------------------------------
1 | The MIT License (MIT)
2 | Copyright (c) nystudio107
3 | 
4 | Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
5 | 
6 | The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
7 | 
8 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
9 | 


--------------------------------------------------------------------------------
/src/assetbundles/recipe/RecipeAsset.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Recipe plugin for Craft CMS 3.x
 4 |  *
 5 |  * A comprehensive recipe FieldType for Craft CMS that includes metric/imperial
 6 |  * conversion, portion calculation, and JSON-LD microdata support
 7 |  *
 8 |  * @link      https://nystudio107.com
 9 |  * @copyright Copyright (c) 2017 nystudio107
10 |  */
11 | 
12 | namespace nystudio107\recipe\assetbundles\recipe;
13 | 
14 | use craft\web\AssetBundle;
15 | use craft\web\assets\cp\CpAsset;
16 | 
17 | /**
18 |  * @author    nystudio107
19 |  * @package   Recipe
20 |  * @since     1.0.0
21 |  */
22 | class RecipeAsset extends AssetBundle
23 | {
24 |     // Public Methods
25 |     // =========================================================================
26 | 
27 |     /**
28 |      * @inheritdoc
29 |      */
30 |     public function init(): void
31 |     {
32 |         $this->sourcePath = "@nystudio107/recipe/assetbundles/recipe/dist";
33 | 
34 |         $this->depends = [
35 |             CpAsset::class,
36 |         ];
37 | 
38 |         $this->js = [
39 |             'js/Recipe.js',
40 |         ];
41 | 
42 |         $this->css = [
43 |             'css/Recipe.css',
44 |         ];
45 | 
46 |         parent::init();
47 |     }
48 | }
49 | 


--------------------------------------------------------------------------------
/src/assetbundles/recipefield/RecipeFieldAsset.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Recipe plugin for Craft CMS 3.x
 4 |  *
 5 |  * A comprehensive recipe FieldType for Craft CMS that includes metric/imperial
 6 |  * conversion, portion calculation, and JSON-LD microdata support
 7 |  *
 8 |  * @link      https://nystudio107.com
 9 |  * @copyright Copyright (c) 2017 nystudio107
10 |  */
11 | 
12 | namespace nystudio107\recipe\assetbundles\recipefield;
13 | 
14 | use craft\web\AssetBundle;
15 | use craft\web\assets\cp\CpAsset;
16 | 
17 | /**
18 |  * @author    nystudio107
19 |  * @package   Recipe
20 |  * @since     1.0.0
21 |  */
22 | class RecipeFieldAsset extends AssetBundle
23 | {
24 |     // Public Methods
25 |     // =========================================================================
26 | 
27 |     /**
28 |      * @inheritdoc
29 |      */
30 |     public function init(): void
31 |     {
32 |         $this->sourcePath = "@nystudio107/recipe/assetbundles/recipefield/dist";
33 | 
34 |         $this->depends = [
35 |             CpAsset::class,
36 |         ];
37 | 
38 |         $this->js = [
39 |             'js/Recipe.js',
40 |         ];
41 | 
42 |         $this->css = [
43 |             'css/Recipe.css',
44 |         ];
45 | 
46 |         parent::init();
47 |     }
48 | }
49 | 


--------------------------------------------------------------------------------
/src/models/Settings.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Recipe plugin for Craft CMS 3.x
 4 |  *
 5 |  * A comprehensive recipe FieldType for Craft CMS that includes metric/imperial
 6 |  * conversion, portion calculation, and JSON-LD microdata support
 7 |  *
 8 |  * @link      https://nystudio107.com
 9 |  * @copyright Copyright (c) 2017 nystudio107
10 |  */
11 | 
12 | namespace nystudio107\recipe\models;
13 | 
14 | use craft\base\Model;
15 | 
16 | /**
17 |  * @author    nystudio107
18 |  * @package   Recipe
19 |  * @since     1.3.0
20 |  */
21 | class Settings extends Model
22 | {
23 |     /**
24 |      * An application ID for the Edamam Nutrition Analysis API.
25 |      * https://developer.edamam.com/edamam-nutrition-api
26 |      *
27 |      * @var ?string
28 |      */
29 |     public ?string $apiApplicationId = null;
30 | 
31 |     /**
32 |      * An application key for the Edamam Nutrition Analysis API.
33 |      * https://developer.edamam.com/edamam-nutrition-api
34 |      *
35 |      * @var ?string
36 |      */
37 |     public ?string $apiApplicationKey = null;
38 | 
39 |     /**
40 |      * Returns whether the settings have API credentials.
41 |      */
42 |     public function hasApiCredentials(): bool
43 |     {
44 |         return ($this->apiApplicationId && $this->apiApplicationKey);
45 |     }
46 | }
47 | 


--------------------------------------------------------------------------------
/src/services/ServicesTrait.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Recipe plugin for Craft CMS 3.x
 4 |  *
 5 |  * A comprehensive recipe FieldType for Craft CMS that includes metric/imperial
 6 |  * conversion, portion calculation, and JSON-LD microdata support
 7 |  *
 8 |  * @link      https://nystudio107.com
 9 |  * @copyright Copyright (c) 2022 nystudio107
10 |  */
11 | 
12 | namespace nystudio107\recipe\services;
13 | 
14 | use yii\base\InvalidConfigException;
15 | 
16 | /**
17 |  * @author    nystudio107
18 |  * @package   Recipe
19 |  * @since     4.0.3
20 |  *
21 |  * @property NutritionApi $nutritionApi
22 |  */
23 | trait ServicesTrait
24 | {
25 |     // Public Static Methods
26 |     // =========================================================================
27 | 
28 |     /**
29 |      * @inheritdoc
30 |      */
31 |     public static function config(): array
32 |     {
33 |         return [
34 |             'components' => [
35 |                 'nutritionApi' => NutritionApi::class,
36 |             ],
37 |         ];
38 |     }
39 | 
40 |     // Public Methods
41 |     // =========================================================================
42 | 
43 |     /**
44 |      * Returns the nutritionApi service
45 |      *
46 |      * @return NutritionApi The nutritionApi service
47 |      * @throws InvalidConfigException
48 |      */
49 |     public function getHelper(): NutritionApi
50 |     {
51 |         return $this->get('nutritionApi');
52 |     }
53 | }
54 | 


--------------------------------------------------------------------------------
/src/controllers/NutritionApiController.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Recipe plugin for Craft CMS 3.x
 4 |  *
 5 |  * A comprehensive recipe FieldType for Craft CMS that includes metric/imperial
 6 |  * conversion, portion calculation, and JSON-LD microdata support
 7 |  *
 8 |  * @link      https://nystudio107.com
 9 |  * @copyright Copyright (c) 2017 nystudio107
10 |  */
11 | 
12 | namespace nystudio107\recipe\controllers;
13 | 
14 | use Craft;
15 | use craft\web\Controller;
16 | use nystudio107\recipe\Recipe;
17 | use yii\web\BadRequestHttpException;
18 | use yii\web\Response;
19 | 
20 | /**
21 |  * @author    nystudio107
22 |  * @package   Recipe
23 |  * @since     1.3.0
24 |  */
25 | class NutritionApiController extends Controller
26 | {
27 |     /**
28 |      * Returns nutritional information about a recipe.
29 |      *
30 |      * @throws BadRequestHttpException
31 |      */
32 |     public function actionGetNutritionalInfo(): Response
33 |     {
34 |         $this->requireAcceptsJson();
35 | 
36 |         $ingredients = Craft::$app->getRequest()->getParam('ingredients');
37 |         $serves = Craft::$app->getRequest()->getParam('serves');
38 | 
39 |         if (empty($ingredients)) {
40 |             return $this->asJson([
41 |                 'error' => 'Please provide some ingredients first.',
42 |             ]);
43 |         }
44 | 
45 |         $nutritionalInfo = Recipe::$plugin->nutritionApi->getNutritionalInfo($ingredients, $serves);
46 | 
47 |         return $this->asJson($nutritionalInfo);
48 |     }
49 | }
50 | 


--------------------------------------------------------------------------------
/src/assetbundles/recipefield/dist/img/star.svg:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="utf-8"?>
 2 | <!-- Generator: Adobe Illustrator 16.0.0, SVG Export Plug-In . SVG Version: 6.00 Build 0)  -->
 3 | <!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
 4 | <svg version="1.1" id="Capa_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
 5 | 	 width="612.001px" height="584.338px" viewBox="0 103.831 612.001 584.338" enable-background="new 0 103.831 612.001 584.338"
 6 | 	 xml:space="preserve">
 7 | <g>
 8 | 	<path d="M611.161,324.653c-2.01-6.155-7.285-10.551-13.691-11.556l-190.928-27.131l-85.917-172.714
 9 | 		c-2.89-5.778-8.793-9.421-15.199-9.421l0,0c-6.406,0-12.31,3.643-15.199,9.546L205.44,286.594L14.513,314.981
10 | 		c-6.406,1.005-11.682,5.401-13.692,11.556s-0.251,12.938,4.396,17.334l138.548,134.277l-32.03,190.173
11 | 		c-1.131,6.406,1.507,12.812,6.783,16.581c2.889,2.136,6.406,3.266,9.923,3.266c2.763,0,5.401-0.628,7.914-2.01l170.453-90.313
12 | 		l170.955,89.309c2.513,1.256,5.15,1.885,7.788,1.885l0,0c9.295,0,16.957-7.662,16.957-16.958c0-1.382-0.125-2.638-0.502-3.894
13 | 		l-33.035-189.043l137.668-135.031C611.538,337.591,613.171,330.809,611.161,324.653z M439.075,459.182
14 | 		c-4.02,3.895-5.778,9.547-4.773,15.073l28.765,164.927L314.596,561.68c-4.899-2.638-10.803-2.512-15.827,0L150.8,640.061
15 | 		l27.76-165.178c0.879-5.526-0.879-11.054-4.898-14.947L53.578,343.369l165.68-24.619c5.527-0.879,10.3-4.271,12.687-9.295
16 | 		L305.552,159.1l74.612,149.978c2.512,5.024,7.285,8.416,12.812,9.295l165.805,23.615L439.075,459.182z"/>
17 | </g>
18 | </svg>
19 | 


--------------------------------------------------------------------------------
/composer.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "name": "nystudio107/craft-recipe",
 3 |   "description": "A comprehensive recipe FieldType for Craft CMS that includes metric/imperial conversion, portion calculation, and JSON-LD microdata support",
 4 |   "type": "craft-plugin",
 5 |   "version": "5.0.0",
 6 |   "keywords": [
 7 |     "craft",
 8 |     "cms",
 9 |     "craftcms",
10 |     "craft-plugin",
11 |     "recipe"
12 |   ],
13 |   "support": {
14 |     "docs": "https://nystudio107.com/docs/recipe/",
15 |     "issues": "https://nystudio107.com/plugins/recipe/support",
16 |     "source": "https://github.com/nystudio107/craft-recipe"
17 |   },
18 |   "license": "MIT",
19 |   "authors": [
20 |     {
21 |       "name": "nystudio107",
22 |       "homepage": "https://nystudio107.com"
23 |     }
24 |   ],
25 |   "require": {
26 |     "craftcms/cms": "^5.0.0"
27 |   },
28 |   "require-dev": {
29 |     "craftcms/ecs": "dev-main",
30 |     "craftcms/feed-me": "^6.0.0",
31 |     "craftcms/phpstan": "dev-main",
32 |     "craftcms/rector": "dev-main",
33 |     "nystudio107/craft-seomatic": "^5.0.0"
34 |   },
35 |   "scripts": {
36 |     "phpstan": "phpstan --ansi --memory-limit=1G",
37 |     "check-cs": "ecs check --ansi",
38 |     "fix-cs": "ecs check --fix --ansi"
39 |   },
40 |   "config": {
41 |     "allow-plugins": {
42 |       "craftcms/plugin-installer": true,
43 |       "yiisoft/yii2-composer": true
44 |     },
45 |     "optimize-autoloader": true,
46 |     "sort-packages": true
47 |   },
48 |   "autoload": {
49 |     "psr-4": {
50 |       "nystudio107\\recipe\\": "src/"
51 |     }
52 |   },
53 |   "extra": {
54 |     "class": "nystudio107\\recipe\\Recipe",
55 |     "handle": "recipe",
56 |     "name": "Recipe"
57 |   }
58 | }
59 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/nystudio107/craft-recipe/badges/quality-score.png?b=v5)](https://scrutinizer-ci.com/g/nystudio107/craft-recipe/?branch=v5) [![Code Coverage](https://scrutinizer-ci.com/g/nystudio107/craft-recipe/badges/coverage.png?b=v5)](https://scrutinizer-ci.com/g/nystudio107/craft-recipe/?branch=v5) [![Build Status](https://scrutinizer-ci.com/g/nystudio107/craft-recipe/badges/build.png?b=v5)](https://scrutinizer-ci.com/g/nystudio107/craft-recipe/build-status/v5) [![Code Intelligence Status](https://scrutinizer-ci.com/g/nystudio107/craft-recipe/badges/code-intelligence.svg?b=v5)](https://scrutinizer-ci.com/code-intelligence)
 2 | 
 3 | # Recipe plugin for Craft CMS 5.x
 4 | 
 5 | A comprehensive recipe FieldType for Craft CMS that includes metric/imperial conversion, portion calculation, and JSON-LD microdata support
 6 | 
 7 | ![Screenshot](./docs/docs/resources/img/plugin-logo.png)
 8 | 
 9 | ## Requirements
10 | 
11 | This plugin requires Craft CMS 5.0.0 or later.
12 | 
13 | ## Installation
14 | 
15 | To install Recipe, follow these steps:
16 | 
17 | 1. Install with Composer via `composer require nystudio107/craft-recipe`
18 | 2. Install the plugin via `./craft install/plugin recipe` via the CLI, or in the Control Panel, go to Settings → Plugins and click the “Install” button for Recipe.
19 | 
20 | You can also install Recipe via the **Plugin Store** in the Craft AdminCP.
21 | 
22 | ## Documentation
23 | 
24 | Click here -> [Recipe Documentation](https://nystudio107.com/plugins/recipe/documentation)
25 | 
26 | ## Recipe Roadmap
27 | 
28 | Some things to do, and ideas for potential features:
29 | 
30 | * Provide a front-end way to add ratings
31 | 
32 | Brought to you by [nystudio107](https://nystudio107.com)
33 | 


--------------------------------------------------------------------------------
/src/icon.svg:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="utf-8"?>
 2 | <!-- Generator: Adobe Illustrator 16.0.4, SVG Export Plug-In . SVG Version: 6.00 Build 0)  -->
 3 | <!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
 4 | <svg version="1.1" id="gr_x5F_icon08_x5F_recipe" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink"
 5 | 	 x="0px" y="0px" width="250px" height="250px" viewBox="0 0 250 250" enable-background="new 0 0 250 250" xml:space="preserve">
 6 | <g id="gr_x5F_big_8_">
 7 | 	<path id="gr_178_" fill="#F3BA48" d="M237.664,172.702c0,9.539-6.76,21.251-15.021,26.019l-82.621,47.701
 8 | 		c-8.263,4.771-21.78,4.771-30.043,0l-82.621-47.701c-8.263-4.768-15.021-16.479-15.021-26.019V77.298
 9 | 		c0-9.539,6.759-21.25,15.021-26.018l82.621-47.702c8.263-4.771,21.78-4.771,30.043,0l82.621,47.702
10 | 		c8.262,4.768,15.021,16.479,15.021,26.018V172.702z"/>
11 | 	<path fill="#FFFFFF" d="M169.263,129.238c-0.642,0-1.276,0.034-1.904,0.101L148.067,95.93l3.24-1.873l-12.981-22.496l-9.943,5.741
12 | 		c-3.47,2.005-4.656,6.431-2.654,9.901l5.741,9.94c1.998,3.467,6.432,4.653,9.898,2.654l2.113-1.224l18.568,32.161
13 | 		c-1.862,0.802-3.551,1.922-5.029,3.265l-31.277-18.304l2.329-4.032l-33.74-19.479l-8.607,14.91
14 | 		c-3.003,5.2-1.224,11.848,3.976,14.851l14.91,8.608c5.2,3.003,11.852,1.221,14.854-3.979l3.498-6.058l30.521,17.864
15 | 		c-0.963,1.66-1.682,3.481-2.079,5.424H116.18v-4.07H62.5v23.721c0,8.272,6.707,14.983,14.977,14.983h23.72
16 | 		c8.272,0,14.983-6.711,14.983-14.983v-13.965h34.972c1.008,9.106,8.743,16.214,18.111,16.214c10.059,0,18.237-8.179,18.237-18.23
17 | 		C187.5,137.417,179.321,129.238,169.263,129.238z M169.263,159.198c-6.463,0-11.723-5.26-11.723-11.727
18 | 		c0-6.47,5.26-11.729,11.723-11.729c6.47,0,11.732,5.26,11.732,11.729C180.995,153.938,175.732,159.198,169.263,159.198z"/>
19 | </g>
20 | </svg>
21 | 


--------------------------------------------------------------------------------
/src/assetbundles/recipe/dist/img/Recipe-icon.svg:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="utf-8"?>
 2 | <!-- Generator: Adobe Illustrator 16.0.4, SVG Export Plug-In . SVG Version: 6.00 Build 0)  -->
 3 | <!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
 4 | <svg version="1.1" id="gr_x5F_icon08_x5F_recipe" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink"
 5 | 	 x="0px" y="0px" width="250px" height="250px" viewBox="0 0 250 250" enable-background="new 0 0 250 250" xml:space="preserve">
 6 | <g id="gr_x5F_big_8_">
 7 | 	<path id="gr_178_" fill="#F3BA48" d="M237.664,172.702c0,9.539-6.76,21.251-15.021,26.019l-82.621,47.701
 8 | 		c-8.263,4.771-21.78,4.771-30.043,0l-82.621-47.701c-8.263-4.768-15.021-16.479-15.021-26.019V77.298
 9 | 		c0-9.539,6.759-21.25,15.021-26.018l82.621-47.702c8.263-4.771,21.78-4.771,30.043,0l82.621,47.702
10 | 		c8.262,4.768,15.021,16.479,15.021,26.018V172.702z"/>
11 | 	<path fill="#FFFFFF" d="M169.263,129.238c-0.642,0-1.276,0.034-1.904,0.101L148.067,95.93l3.24-1.873l-12.981-22.496l-9.943,5.741
12 | 		c-3.47,2.005-4.656,6.431-2.654,9.901l5.741,9.94c1.998,3.467,6.432,4.653,9.898,2.654l2.113-1.224l18.568,32.161
13 | 		c-1.862,0.802-3.551,1.922-5.029,3.265l-31.277-18.304l2.329-4.032l-33.74-19.479l-8.607,14.91
14 | 		c-3.003,5.2-1.224,11.848,3.976,14.851l14.91,8.608c5.2,3.003,11.852,1.221,14.854-3.979l3.498-6.058l30.521,17.864
15 | 		c-0.963,1.66-1.682,3.481-2.079,5.424H116.18v-4.07H62.5v23.721c0,8.272,6.707,14.983,14.977,14.983h23.72
16 | 		c8.272,0,14.983-6.711,14.983-14.983v-13.965h34.972c1.008,9.106,8.743,16.214,18.111,16.214c10.059,0,18.237-8.179,18.237-18.23
17 | 		C187.5,137.417,179.321,129.238,169.263,129.238z M169.263,159.198c-6.463,0-11.723-5.26-11.723-11.727
18 | 		c0-6.47,5.26-11.729,11.723-11.729c6.47,0,11.732,5.26,11.732,11.729C180.995,153.938,175.732,159.198,169.263,159.198z"/>
19 | </g>
20 | </svg>
21 | 


--------------------------------------------------------------------------------
/src/assetbundles/recipefield/dist/img/Recipe-icon.svg:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="utf-8"?>
 2 | <!-- Generator: Adobe Illustrator 16.0.4, SVG Export Plug-In . SVG Version: 6.00 Build 0)  -->
 3 | <!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
 4 | <svg version="1.1" id="gr_x5F_icon08_x5F_recipe" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink"
 5 | 	 x="0px" y="0px" width="250px" height="250px" viewBox="0 0 250 250" enable-background="new 0 0 250 250" xml:space="preserve">
 6 | <g id="gr_x5F_big_8_">
 7 | 	<path id="gr_178_" fill="#F3BA48" d="M237.664,172.702c0,9.539-6.76,21.251-15.021,26.019l-82.621,47.701
 8 | 		c-8.263,4.771-21.78,4.771-30.043,0l-82.621-47.701c-8.263-4.768-15.021-16.479-15.021-26.019V77.298
 9 | 		c0-9.539,6.759-21.25,15.021-26.018l82.621-47.702c8.263-4.771,21.78-4.771,30.043,0l82.621,47.702
10 | 		c8.262,4.768,15.021,16.479,15.021,26.018V172.702z"/>
11 | 	<path fill="#FFFFFF" d="M169.263,129.238c-0.642,0-1.276,0.034-1.904,0.101L148.067,95.93l3.24-1.873l-12.981-22.496l-9.943,5.741
12 | 		c-3.47,2.005-4.656,6.431-2.654,9.901l5.741,9.94c1.998,3.467,6.432,4.653,9.898,2.654l2.113-1.224l18.568,32.161
13 | 		c-1.862,0.802-3.551,1.922-5.029,3.265l-31.277-18.304l2.329-4.032l-33.74-19.479l-8.607,14.91
14 | 		c-3.003,5.2-1.224,11.848,3.976,14.851l14.91,8.608c5.2,3.003,11.852,1.221,14.854-3.979l3.498-6.058l30.521,17.864
15 | 		c-0.963,1.66-1.682,3.481-2.079,5.424H116.18v-4.07H62.5v23.721c0,8.272,6.707,14.983,14.977,14.983h23.72
16 | 		c8.272,0,14.983-6.711,14.983-14.983v-13.965h34.972c1.008,9.106,8.743,16.214,18.111,16.214c10.059,0,18.237-8.179,18.237-18.23
17 | 		C187.5,137.417,179.321,129.238,169.263,129.238z M169.263,159.198c-6.463,0-11.723-5.26-11.723-11.727
18 | 		c0-6.47,5.26-11.729,11.723-11.729c6.47,0,11.732,5.26,11.732,11.729C180.995,153.938,175.732,159.198,169.263,159.198z"/>
19 | </g>
20 | </svg>
21 | 


--------------------------------------------------------------------------------
/src/translations/en/recipe.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Recipe plugin for Craft CMS 3.x
 4 |  *
 5 |  * A comprehensive recipe FieldType for Craft CMS that includes metric/imperial
 6 |  * conversion, portion calculation, and JSON-LD microdata support
 7 |  *
 8 |  * @link      https://nystudio107.com
 9 |  * @copyright Copyright (c) 2017 nystudio107
10 |  */
11 | 
12 | /**
13 |  * @author    nystudio107
14 |  * @package   Recipe
15 |  * @since     1.0.0
16 |  */
17 | return [
18 |     'Recipe' => 'Recipe',
19 |     'Review' => 'Review',
20 |     '{name} plugin loaded' => '{name} plugin loaded',
21 |     'Error rendering template string -> {error}' => 'Error rendering template string -> {error}',
22 |     'Error rendering `{template}` -> {error}' => 'Error rendering `{template}` -> {error}',
23 |     'API Application Key' => 'API Application Key',
24 |     'Failed to generate nutritional information for {count} entries.' => 'Failed to generate nutritional information for {count} entries.',
25 |     'API credentials do not exist in plugin settings.' => 'API credentials do not exist in plugin settings.',
26 |     'An application ID for the Edamam Nutrition Analysis API.' => 'An application ID for the Edamam Nutrition Analysis API.',
27 |     'No entries found in the section with handle `{handle}`.' => 'No entries found in the section with handle `{handle}`.',
28 |     'A section handle must be provided using --section.' => 'A section handle must be provided using --section.',
29 |     'Generating nutritional information for {count} entries...' => 'Generating nutritional information for {count} entries...',
30 |     'The [Edamam Nutrition Analysis API]({url}) can be used to fetch nutritional information from your ingredients.' => 'The [Edamam Nutrition Analysis API]({url}) can be used to fetch nutritional information from your ingredients.',
31 |     'A field handle must be provided using --field.' => 'A field handle must be provided using --field.',
32 |     'Successfully generated nutritional information for {count} entries.' => 'Successfully generated nutritional information for {count} entries.',
33 | ];
34 | 


--------------------------------------------------------------------------------
/src/assetbundles/recipefield/dist/img/icon.svg:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="utf-8"?>
 2 | <!-- Generator: Adobe Illustrator 16.0.0, SVG Export Plug-In . SVG Version: 6.00 Build 0)  -->
 3 | <!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
 4 | <svg version="1.1" id="Capa_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
 5 | 	 width="608.015px" height="612px" viewBox="1.993 90 608.015 612" enable-background="new 1.993 90 608.015 612"
 6 | 	 xml:space="preserve">
 7 | <path d="M610.008,312.999c0-78.235-63.626-141.883-141.832-141.883c-3.397,0-6.829,0.128-10.276,0.385
 8 | 	C424.246,120.903,367.23,90,306,90c-61.229,0-118.244,30.909-151.897,81.501c-3.447-0.257-6.878-0.385-10.276-0.385
 9 | 	c-78.208,0-141.833,63.648-141.833,141.883c0,71.373,52.966,130.576,121.64,140.413v196.082c0,28.953,23.553,52.506,52.504,52.506
10 | 	h259.727c28.954,0,52.505-23.555,52.505-52.506V453.412C557.044,443.575,610.008,384.37,610.008,312.999z M435.863,661.61H176.139
11 | 	c-6.565,0-12.117-5.55-12.117-12.119V453.431c19.786-2.802,38.571-9.729,55.515-20.503c25.99,14.058,55.55,21.948,86.463,21.948
12 | 	s60.471-7.891,86.461-21.946c16.948,10.771,35.735,17.699,55.519,20.501v196.061C447.979,656.061,442.431,661.61,435.863,661.61z
13 | 	 M468.176,414.485c-13.594,0-26.734-2.656-38.945-7.76c24.577-22.531,43.155-51.816,52.483-85.472
14 | 	c2.978-10.748-3.319-21.877-14.067-24.857c-10.75-2.978-21.876,3.322-24.857,14.068C425.818,371.711,369.567,414.485,306,414.485
15 | 	c-63.568,0-119.816-42.774-136.789-104.021c-2.978-10.749-14.101-17.045-24.857-14.068c-10.748,2.978-17.045,14.109-14.067,24.857
16 | 	c9.326,33.656,27.907,62.943,52.483,85.472c-12.211,5.104-25.352,7.76-38.943,7.76c-55.937,0-101.444-45.527-101.444-101.487
17 | 	c0-55.962,45.509-101.493,101.444-101.493c5.654,0,11.476,0.507,17.303,1.504c8.412,1.435,16.835-2.569,21.019-10.017
18 | 	c25.149-44.783,72.607-72.604,123.851-72.604s98.701,27.822,123.854,72.605c4.181,7.447,12.601,11.451,21.019,10.015
19 | 	c5.827-0.997,11.648-1.504,17.301-1.504c55.935,0,101.441,45.531,101.441,101.493C569.619,368.958,524.111,414.485,468.176,414.485z
20 | 	"/>
21 | </svg>
22 | 


--------------------------------------------------------------------------------
/src/templates/welcome.twig:
--------------------------------------------------------------------------------
 1 | {% extends '_layouts/cp' %}
 2 | {% set title = 'Welcome to Recipe!' %}
 3 | 
 4 | {% set linkGetStarted = url('settings/fields') %}
 5 | {% set docsUrl = "https://github.com/nystudio107/craft-recipe/blob/master/README.md" %}
 6 | 
 7 | {% do view.registerAssetBundle("nystudio107\\recipe\\assetbundles\\recipe\\RecipeAsset") %}
 8 | {% set baseAssetsUrl = view.getAssetManager().getPublishedUrl('@nystudio107/recipe/assetbundles/recipe/dist', true) %}
 9 | 
10 | {% set crumbs = [
11 |     { label: "Recipe", url: url('recipe') },
12 |     { label: "Welcome"|t, url: url('recipe/welcome') },
13 | ] %}
14 | 
15 | {% set content %}
16 |     <div style="text-align:center; margin:0 auto; padding: 5% 10%;">
17 |         <img style="display: inline-block;" src="{{ baseAssetsUrl ~ '/img/Recipe-icon.svg' }}" width="30%" height="auto"/>
18 |         <h2>Thanks for using Recipe!</h2>
19 |         <p>Recipe adds a 'Recipe' FieldType for Craft CMS that you can add to any of your Sections.</p>
20 |         <p>In encapsulates everything you need for a recipe, including the ingredients, a photo of the recipe, directions, cooking time, ratings, and even nutritional information. It handles converting between Imperial and Metric units, outputs 'pretty' fractions for Imperial units, and can output correct ingredient portions for any number of servings.</p>
21 |         <p>Recipe also generates the <a href='https://developers.google.com/structured-data/' target='_blank'>JSON-LD microdata</a> for your recipes, which allows it to be displayed in the <a href='https://developers.google.com/structured-data/rich-snippets/recipes' target='_blank'>Googleknowledge panel</a> for search results.</p>
22 |         <p>We hope Recipe makes it easier for you to create and share some yummy recipes!</p>
23 |         <p>
24 |             &nbsp;
25 |         </p>
26 |         <p>
27 |             <a href="{{ linkGetStarted }}">
28 |                 <button class="btn submit">Get Started</button>
29 |             </a>
30 |         </p>
31 |     </div>
32 |     <div style="text-align:center; margin:0 auto; padding: 0;">
33 |         <p class="instructions">
34 |             Brought to you by <a href="http://nystudio107.com" target="_blank">nystudio107</a>
35 |         </p>
36 |     </div>
37 | {% endset %}
38 | 


--------------------------------------------------------------------------------
/src/assetbundles/recipefield/dist/img/Healthy-icon.svg:
--------------------------------------------------------------------------------
1 | <svg xmlns="http://www.w3.org/2000/svg" width="612" height="454.715"><path fill="#FFBAB0" d="M331.456 52.915L309.293 75.08 287.13 52.914c-50.326-50.32-131.915-50.32-182.235 0-50.32 50.32-50.32 131.91 0 182.23l22.164 22.167 182.23 182.23 182.23-182.23 22.16-22.17c50.32-50.32 50.32-131.9 0-182.22-50.32-50.32-131.91-50.32-182.23 0z"/><g fill="#783741"><path d="M309.293 454.716c-3.885 0-7.764-1.482-10.728-4.445L94.167 245.88c-56.162-56.158-56.162-147.533 0-203.686C121.367 14.98 157.537 0 196.012 0c38.47 0 74.644 14.98 101.85 42.187l11.436 11.436 11.437-11.436C347.935 14.98 384.105 0 422.58 0c38.47 0 74.645 14.98 101.846 42.187 27.206 27.202 42.188 63.37 42.188 101.845 0 38.47-14.98 74.644-42.188 101.845L320.03 450.275c-2.973 2.96-6.853 4.44-10.737 4.44zM196.013 30.348c-30.37 0-58.915 11.825-80.39 33.296-44.328 44.327-44.328 116.448 0 160.774l193.67 193.67 193.664-193.67c44.327-44.326 44.327-116.447 0-160.774-21.47-21.47-50.022-33.296-80.39-33.296-30.368 0-58.914 11.825-80.39 33.296L320.012 85.81c-5.928 5.927-15.528 5.927-21.456 0l-22.164-22.166c-21.467-21.47-50.02-33.296-80.38-33.296z"/><path d="M309.293 419.802c-3.885 0-7.764-1.482-10.728-4.447L118.293 235.093l-19.625-8.826c-7.642-3.438-11.056-12.422-7.617-20.063 3.44-7.644 12.42-11.062 20.07-7.617l22.17 9.97c1.68.754 3.21 1.806 4.51 3.11L309.3 383.17l171.5-171.503c.68-.683 1.42-1.295 2.217-1.83l22.16-15.028c6.94-4.71 16.374-2.89 21.078 4.04 4.7 6.93 2.885 16.37-4.05 21.07l-20.97 14.215-181.21 181.206c-2.963 2.966-6.843 4.448-10.727 4.448z" opacity=".2"/></g><path fill="#783741" d="M70.81 222.054H15.173c-8.38 0-15.173-6.79-15.173-15.172 0-8.382 6.792-15.175 15.173-15.175H70.81c8.38 0 15.173 6.793 15.173 15.175 0 8.38-6.792 15.172-15.173 15.172z"/><path fill="#FFBAB0" d="M75.868 207.372h131.504l40.463-85.984 65.752 182.082 55.636-156.793 25.29 55.637h151.735"/><path fill="#783741" d="M313.587 313.587c-4.264 0-8.067-2.672-9.514-6.678L246.6 147.76l-30.078 63.916c-1.67 3.544-5.235 5.805-9.155 5.805H75.863c-5.59 0-10.116-4.53-10.116-10.11s4.527-10.11 10.116-10.11h125.08l37.732-80.174c1.74-3.696 5.255-6 9.625-5.796 4.087.19 7.653 2.83 9.04 6.667l56.157 155.505 46.188-130.16c1.376-3.89 4.98-6.544 9.1-6.72 4.225-.12 7.937 2.165 9.642 5.92l22.6 49.706h145.22c5.585 0 10.116 4.53 10.116 10.116s-4.53 10.118-10.115 10.118h-151.74c-3.966 0-7.566-2.316-9.206-5.934l-14.926-32.83-47.26 133.19c-1.427 4.023-5.23 6.72-9.504 6.73-.005.002-.015.002-.025.002z"/><path fill="#783741" d="M596.826 216.997h-45.52c-8.382 0-15.175-6.793-15.175-15.174 0-8.382 6.8-15.173 15.18-15.173h45.52c8.38 0 15.18 6.79 15.18 15.173 0 8.38-6.79 15.174-15.17 15.174z"/></svg>


--------------------------------------------------------------------------------
/src/assetbundles/recipefield/dist/img/healthy.svg:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="utf-8"?>
 2 | <!-- Generator: Adobe Illustrator 16.0.0, SVG Export Plug-In . SVG Version: 6.00 Build 0)  -->
 3 | <!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
 4 | <svg version="1.1" id="Capa_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
 5 | 	 width="612px" height="589.532px" viewBox="0 101.23 612 589.532" enable-background="new 0 101.23 612 589.532"
 6 | 	 xml:space="preserve">
 7 | <g>
 8 | 	<g id="group-19svg">
 9 | 		<path id="path-1_9_" d="M303.482,526.641c-11.951,0-22.176-5.33-25.497-16.845l-48.181-166.038h-41.002l-25.954,40.058
10 | 			c-4.935,7.92-13.362,10.743-22.572,10.743c-0.081,0-0.183,0-0.274,0c-8.905,0-17.099-2.417-21.963-9.87L75.424,323.44H25.771
11 | 			c-8.408,0-15.231-6.824-15.231-15.241c0-8.408,6.823-15.241,15.231-15.241h50.201c5.32-0.041,15.779-0.112,22.247,9.809
12 | 			l41.794,62.031l23.08-37.57c5.483-8.763,13.9-13.941,22.582-13.941h47.47c12.854,0,22.562,10.347,25.517,20.562l44.708,156.26
13 | 			l34.361-128.824c3.087-11.616,13.24-19.557,25.263-19.75c11.9-0.406,22.329,7.352,25.802,18.815l22.166,72.977l75.596-107.419
14 | 			c5.687-8.042,13.586-12.622,21.699-12.622h75.982c8.407,0,15.23,6.824,15.23,15.241c0,8.408-6.823,15.231-15.23,15.231h-72.875
15 | 			l-80.054,113.593c-5.981,8.468-16.023,12.692-26.197,11.037c-9.962-1.625-17.973-8.641-20.897-18.317l-20.582-67.737
16 | 			l-34.473,126.925c-3.127,11.687-13.343,17.383-25.416,17.383C303.654,526.641,303.563,526.641,303.482,526.641z"/>
17 | 		<path id="path-2_9_" d="M310.214,690.719c-1.432,0.152-2.843-0.122-4.204-0.375c-1.36,0.253-2.771,0.375-4.203,0.375
18 | 			C242.365,690.719,0,396.802,0,298.796C0,189.854,88.573,101.23,197.444,101.23c35.224,0,65.127,28.238,91.528,53.156
19 | 			c5.92,5.585,11.626,10.987,17.038,15.678c5.402-4.691,11.108-10.093,17.039-15.688c26.39-24.907,56.293-53.146,91.507-53.146
20 | 			C523.438,101.23,612,189.854,612,298.796c0,65.859-90.827,185.798-129.88,234.303
21 | 			C469.134,549.233,353.968,690.719,310.214,690.719z M306.01,659.019c1.777,0,3.574,0.314,5.271,0.934
22 | 			c40.159-11.007,270.258-269.872,270.258-361.156c0-92.137-74.906-167.083-166.982-167.083c-23.1,0-48.343,23.821-70.601,44.84
23 | 			c-10.042,9.474-19.525,18.419-28.857,25.365c-5.392,4.031-12.794,4.031-18.186,0c-9.332-6.945-18.805-15.891-28.847-25.365
24 | 			c-22.268-21.019-47.5-44.84-70.621-44.84c-92.076,0-166.982,74.947-166.982,167.083c0,91.284,230.089,350.119,270.268,361.156
25 | 			C302.436,659.333,304.223,659.019,306.01,659.019z"/>
26 | 	</g>
27 | </g>
28 | </svg>
29 | 


--------------------------------------------------------------------------------
/src/integrations/RecipeFeedMeField.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Recipe plugin for Craft CMS 3.x
 4 |  *
 5 |  * A comprehensive recipe FieldType for Craft CMS that includes metric/imperial
 6 |  * conversion, portion calculation, and JSON-LD microdata support
 7 |  *
 8 |  * @link      https://nystudio107.com
 9 |  * @copyright Copyright (c) 2020 nystudio107
10 |  */
11 | 
12 | namespace nystudio107\recipe\integrations;
13 | 
14 | use Cake\Utility\Hash;
15 | use craft\feedme\base\Field;
16 | use craft\feedme\base\FieldInterface;
17 | use craft\feedme\helpers\DataHelper;
18 | 
19 | /**
20 |  * @author    nystudio107
21 |  * @package   Recipe
22 |  * @since     1.2.0
23 |  *
24 |  * @property-read string $mappingTemplate
25 |  */
26 | class RecipeFeedMeField extends Field implements FieldInterface
27 | {
28 |     // Properties
29 |     // =========================================================================
30 | 
31 |     public static $name = 'Recipe';
32 |     public static $class = 'nystudio107\recipe\fields\Recipe';
33 | 
34 | 
35 |     // Templates
36 |     // =========================================================================
37 | 
38 |     public function getMappingTemplate(): string
39 |     {
40 |         return 'recipe/_integrations/feed-me';
41 |     }
42 | 
43 | 
44 |     // Public Methods
45 |     // =========================================================================
46 | 
47 |     public function parseField(): mixed
48 |     {
49 |         $preppedData = [];
50 | 
51 |         $fields = Hash::get($this->fieldInfo, 'fields');
52 | 
53 |         if (!$fields) {
54 |             return null;
55 |         }
56 | 
57 |         foreach ($fields as $subFieldHandle => $subFieldInfo) {
58 |             // Check for sub-sub fields - bit dirty...
59 |             $subfields = Hash::get($subFieldInfo, 'fields');
60 | 
61 |             if ($subfields) {
62 |                 foreach ($subfields as $subSubFieldHandle => $subSubFieldInfo) {
63 |                     // Handle array data, man I hate Feed Me's data mapping now...
64 |                     $content = DataHelper::fetchArrayValue($this->feedData, $subSubFieldInfo);
65 | 
66 |                     if (is_array($content)) {
67 |                         foreach ($content as $key => $value) {
68 |                             $preppedData[$subFieldHandle][$key][$subSubFieldHandle] = $value;
69 |                         }
70 |                     } else {
71 |                         $preppedData[$subFieldHandle][$subSubFieldHandle] = $content;
72 |                     }
73 |                 }
74 |             } else {
75 |                 $preppedData[$subFieldHandle] = DataHelper::fetchValue($this->feedData, $subFieldInfo);
76 |             }
77 |         }
78 | 
79 |         // Protect against sending an empty array
80 |         if (!$preppedData) {
81 |             return null;
82 |         }
83 | 
84 |         return $preppedData;
85 |     }
86 | }
87 | 


--------------------------------------------------------------------------------
/src/helpers/Json.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Recipe plugin for Craft CMS 3.x
 4 |  *
 5 |  * A comprehensive recipe FieldType for Craft CMS that includes metric/imperial
 6 |  * conversion, portion calculation, and JSON-LD microdata support
 7 |  *
 8 |  * @link      https://nystudio107.com
 9 |  * @copyright Copyright (c) 2017 nystudio107
10 |  */
11 | 
12 | namespace nystudio107\recipe\helpers;
13 | 
14 | use Craft;
15 | 
16 | /**
17 |  * @author    nystudio107
18 |  * @package   Recipe
19 |  * @since     1.0.0
20 |  */
21 | class Json extends \craft\helpers\Json
22 | {
23 |     // Static Properties
24 |     // =========================================================================
25 | 
26 |     protected static int $recursionLevel;
27 | 
28 |     // Static Methods
29 |     // =========================================================================
30 | 
31 |     /**
32 |      * @inheritdoc
33 |      */
34 |     public static function encode(
35 |         $value,
36 |         $options =
37 |         JSON_UNESCAPED_UNICODE
38 |         | JSON_UNESCAPED_SLASHES,
39 |     ): string {
40 |         // If `devMode` is enabled, make the JSON-LD human-readable
41 |         if (Craft::$app->getConfig()->getGeneral()->devMode) {
42 |             $options |= JSON_PRETTY_PRINT;
43 |         }
44 | 
45 |         self::$recursionLevel = 0;
46 | 
47 |         return parent::encode($value, $options);
48 |     }
49 | 
50 |     /**
51 |      * @inheritdoc
52 |      */
53 |     protected static function processData($data, &$expressions, $expPrefix)
54 |     {
55 |         ++self::$recursionLevel;
56 |         $result = parent::processData($data, $expressions, $expPrefix);
57 |         --self::$recursionLevel;
58 |         static::normalizeJsonLdArray($result, self::$recursionLevel);
59 | 
60 |         return $result;
61 |     }
62 | 
63 | 
64 |     // Private Methods
65 |     // =========================================================================
66 | 
67 |     /**
68 |      * Normalize the JSON-LD array recursively to remove empty values, change
69 |      * 'type' to '@type' and have it be the first item in the array
70 |      *
71 |      * @param $array
72 |      * @param $depth
73 |      */
74 |     protected static function normalizeJsonLdArray(&$array, $depth): void
75 |     {
76 |         $array = array_filter($array);
77 |         $array = self::changeKey($array, 'context', '@context');
78 |         $array = self::changeKey($array, 'type', '@type');
79 |         ksort($array);
80 |     }
81 | 
82 |     /**
83 |      * Replace key values without reordering the array or converting numeric
84 |      * keys to associative keys (which unset() does)
85 |      */
86 |     protected static function changeKey(array $array, string $oldKey, string $newKey): array
87 |     {
88 |         if (!array_key_exists($oldKey, $array)) {
89 |             return $array;
90 |         }
91 | 
92 |         $keys = array_keys($array);
93 |         $keys[array_search($oldKey, $keys)] = $newKey;
94 | 
95 |         return array_combine($keys, $array);
96 |     }
97 | }
98 | 


--------------------------------------------------------------------------------
/src/assetbundles/recipefield/dist/css/Recipe.css:
--------------------------------------------------------------------------------
  1 | /**
  2 |  * Recipe plugin for Craft CMS
  3 |  *
  4 |  * Recipe Field CSS
  5 |  *
  6 |  * @author    nystudio107
  7 |  * @copyright Copyright (c) 2017 nystudio107
  8 |  * @link      https://nystudio107.com
  9 |  * @package   Recipe
 10 |  * @since     1.0.0
 11 |  */
 12 | 
 13 | div.recipe-field {
 14 |     border: 1px solid #e3e5e8;
 15 |     margin-bottom: 10px;
 16 |     border-radius: 3px;
 17 |     background: #f9fafa;
 18 | }
 19 | 
 20 | div.recipe-field-title {
 21 |     background: #eef0f1;
 22 |     color: #8f98a3;
 23 |     margin: -7px -14px 14px;
 24 |     padding: 7px 14px 7px 14px;
 25 |     width: calc(100% + 28px);
 26 |     -webkit-box-sizing: border-box;
 27 |     -moz-box-sizing: border-box;
 28 |     box-sizing: border-box;
 29 |     border-radius: 2px 2px 0 0;
 30 |     overflow: hidden;
 31 |     white-space: nowrap;
 32 |     text-overflow: ellipsis;
 33 |     word-wrap: normal;
 34 |     cursor: default;
 35 | }
 36 | 
 37 | img.recipe-field-icon {
 38 |     display: inline-block;
 39 |     width: 16px;
 40 |     height: auto;
 41 |     padding-right: 7px;
 42 |     vertical-align: middle;
 43 | }
 44 | 
 45 | span.recipe-field-title {
 46 |     vertical-align: middle;
 47 | }
 48 | 
 49 | 
 50 | div.recipe-tab-content {
 51 |     -webkit-box-flex: 1;
 52 |     -ms-flex: 1;
 53 |     flex: 1;
 54 |     background: #fff;
 55 |     padding: 24px;
 56 |     word-wrap: break-word;
 57 | }
 58 | 
 59 | nav.recipe-tabs {
 60 |     position: relative;
 61 |     z-index: 1;
 62 |     -webkit-box-shadow: inset 0 -1px 0 #e3e5e8;
 63 |     box-shadow: inset 0 -1px 0 #e3e5e8;
 64 |     min-height: 40px;
 65 |     overflow: hidden;
 66 | }
 67 | 
 68 | nav.recipe-tabs ul {
 69 |     display: -webkit-box;
 70 |     display: -ms-flexbox;
 71 |     display: flex;
 72 |     -webkit-box-orient: horizontal;
 73 |     -webkit-box-direction: normal;
 74 |     -ms-flex-direction: row;
 75 |     flex-direction: row;
 76 |     width: calc(100% + 1px);
 77 | }
 78 | 
 79 | nav.recipe-tabs ul li {
 80 |     -webkit-box-sizing: border-box;
 81 |     box-sizing: border-box;
 82 |     border-right: 1px solid rgba(0, 0, 20, 0.1);
 83 | }
 84 | 
 85 | nav.recipe-tabs ul li a {
 86 |     position: relative;
 87 |     display: block;
 88 |     padding: 10px 24px;
 89 |     white-space: nowrap;
 90 |     overflow: hidden;
 91 |     color: #576575;
 92 |     text-decoration: none;
 93 | }
 94 | 
 95 | nav.recipe-tabs ul li a:active, nav.recipe-tabs ul li a:focus {
 96 |     outline: 0;
 97 |     border: none;
 98 |     -moz-outline-style: none;
 99 | }
100 | 
101 | nav.recipe-tabs ul li a.sel {
102 |     color: #29323d;
103 |     background: #fff;
104 |     padding-bottom: 10px;
105 |     cursor: default;
106 | }
107 | 
108 | nav.recipe-tabs ul li a:not(.sel):hover {
109 |     color: #0d78f2;
110 | }
111 | 
112 | nav.recipe-tabs ul li a:after {
113 |     background: linear-gradient(to right, rgba(235, 237, 239, 0), #ebedef 17px);
114 | }
115 | 
116 | nav.recipe-tabs ul li a.sel:after {
117 |     background: linear-gradient(to right, rgba(255, 255, 255, 0), #fff 17px);
118 | }
119 | 
120 | div.content-icon-wrapper {
121 |     height: 24px;
122 |     width: auto;
123 |     display: inline-block;
124 |     padding: 3px 10px;
125 |     cursor: help;
126 | }
127 | 
128 | fieldset.recipe-fields .status-badge {
129 |     display: none;
130 | }
131 | 


--------------------------------------------------------------------------------
/src/services/NutritionApi.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Recipe plugin for Craft CMS 3.x
 4 |  *
 5 |  * A comprehensive recipe FieldType for Craft CMS that includes metric/imperial
 6 |  * conversion, portion calculation, and JSON-LD microdata support
 7 |  *
 8 |  * @link      https://nystudio107.com
 9 |  * @copyright Copyright (c) 2017 nystudio107
10 |  */
11 | 
12 | namespace nystudio107\recipe\services;
13 | 
14 | use Craft;
15 | use craft\base\Component;
16 | use Exception;
17 | use nystudio107\recipe\models\Settings;
18 | use nystudio107\recipe\Recipe;
19 | 
20 | /**
21 |  * @author    nystudio107
22 |  * @package   Recipe
23 |  * @since     1.3.0
24 |  */
25 | class NutritionApi extends Component
26 | {
27 |     /**
28 |      * Returns nutritional information about a recipe.
29 |      *
30 |      * @param int|null $serves
31 |      */
32 |     public function getNutritionalInfo(array $ingredients, int $serves = null): array
33 |     {
34 |         /** @var Settings $settings */
35 |         $settings = Recipe::$plugin->getSettings();
36 |         if (!$settings->hasApiCredentials()) {
37 |             return [];
38 |         }
39 | 
40 |         $url = 'https://api.edamam.com/api/nutrition-details'
41 |             . '?app_id=' . Craft::parseEnv($settings->apiApplicationId)
42 |             . '&app_key=' . Craft::parseEnv($settings->apiApplicationKey);
43 | 
44 |         $data = [
45 |             'ingr' => $ingredients,
46 |         ];
47 | 
48 |         if ($serves) {
49 |             $data['yield'] = $serves;
50 |         }
51 | 
52 |         try {
53 |             $response = Craft::createGuzzleClient()->post($url, ['json' => $data]);
54 | 
55 |             $result = json_decode($response->getBody(), null, 512, JSON_THROW_ON_ERROR);
56 | 
57 |             $yield = $result->yield ?: 1;
58 | 
59 |             return [
60 |                 'servingSize' => round($result->totalWeight ?? 0 / $yield, 0) . ' grams',
61 |                 'calories' => round($result->totalNutrients->ENERC_KCAL->quantity ?? 0 / $yield, 0),
62 |                 'carbohydrateContent' => round($result->totalNutrients->CHOCDF->quantity ?? 0 / $yield, 1),
63 |                 'cholesterolContent' => round($result->totalNutrients->CHOLE->quantity ?? 0 / $yield, 1),
64 |                 'fatContent' => round($result->totalNutrients->FAT->quantity ?? 0 / $yield, 1),
65 |                 'fiberContent' => round($result->totalNutrients->FIBTG->quantity ?? 0 / $yield, 1),
66 |                 'proteinContent' => round($result->totalNutrients->PROCNT->quantity ?? 0 / $yield, 1),
67 |                 'saturatedFatContent' => round($result->totalNutrients->FASAT->quantity ?? 0 / $yield, 1),
68 |                 'sodiumContent' => round($result->totalNutrients->NA->quantity ?? 0 / $yield, 1),
69 |                 'sugarContent' => round($result->totalNutrients->SUGAR->quantity ?? 0 / $yield, 1),
70 |                 'transFatContent' => round($result->totalNutrients->FATRN->quantity ?? 0 / $yield, 1),
71 |                 'unsaturatedFatContent' => round((($result->totalNutrients->FAMS->quantity ?? 0) + ($result->totalNutrients->FAPU->quantity ?? 0)) / $yield, 1),
72 |             ];
73 |         } catch (Exception $exception) {
74 |             $message = 'Error fetching nutritional information from API. ';
75 | 
76 |             if ($exception->getCode() == 401) {
77 |                 $message .= 'Please verify your API credentials.';
78 |             } elseif ($exception->getCode() == 555) {
79 |                 $message .= 'One or more ingredients could not be recognized.';
80 |             }
81 | 
82 |             Craft::error($message . $exception->getMessage(), __METHOD__);
83 | 
84 |             return ['error' => $message];
85 |         }
86 |     }
87 | }
88 | 


--------------------------------------------------------------------------------
/src/assetbundles/recipefield/dist/js/Recipe.js:
--------------------------------------------------------------------------------
  1 | /**
  2 |  * Recipe plugin for Craft CMS
  3 |  *
  4 |  * Recipe Field JS
  5 |  *
  6 |  * @author    nystudio107
  7 |  * @copyright Copyright (c) 2017 nystudio107
  8 |  * @link      https://nystudio107.com
  9 |  * @package   Recipe
 10 |  * @since     1.0.0
 11 |  */
 12 | 
 13 | ;(function ($, window, document, undefined) {
 14 | 
 15 |   var pluginName = "RecipeRecipe",
 16 |     defaults = {};
 17 | 
 18 |   // Plugin constructor
 19 |   function Plugin(element, options) {
 20 |     this.element = element;
 21 | 
 22 |     this.options = $.extend({}, defaults, options);
 23 | 
 24 |     this._defaults = defaults;
 25 |     this._name = pluginName;
 26 | 
 27 |     this.init();
 28 |   }
 29 | 
 30 |   Plugin.prototype = {
 31 | 
 32 |     init: function (id) {
 33 |       var _this = this;
 34 | 
 35 |       $(function () {
 36 | 
 37 |         /* -- _this.options gives us access to the $jsonVars that our FieldType passed down to us */
 38 | 
 39 |         // Tab handler
 40 |         $('.recipe-tab-links').on('click', function (e) {
 41 |           e.preventDefault();
 42 |           $('.recipe-tab-links').removeClass('sel');
 43 |           $(this).addClass('sel');
 44 |           $('.recipe-tab-content').addClass('hidden');
 45 |           var selector = $(this).attr('href');
 46 |           $(selector).removeClass('hidden');
 47 |           // Trigger a resize to make event handlers in Garnish activate
 48 |           Garnish.$win.trigger('resize');
 49 |           // Fixes Redactor fixed toolbars on previously hidden panes
 50 |           Garnish.$doc.trigger('scroll');
 51 |         });
 52 | 
 53 |         // Fetch nutritional info handler
 54 |         $('.fetch-nutritional-info button').on('click', function (e) {
 55 |           e.preventDefault();
 56 |           if ($(this).hasClass('disabled')) {
 57 |             return;
 58 |           }
 59 |           var ingredients = [];
 60 | 
 61 |           var field = $(this).attr('data-field');
 62 |           $('#' + field + 'ingredients tbody tr').each(function () {
 63 |             var ingredient = [];
 64 |             $(this).find('textarea, select').each(function () {
 65 |               ingredient.push($(this).val());
 66 |             })
 67 |             ingredients.push(ingredient.join(' '));
 68 |           });
 69 | 
 70 |           var serves = $('#' + field + 'serves').val();
 71 | 
 72 |           $('.fetch-nutritional-info button').addClass('disabled');
 73 |           $('.fetch-nutritional-info .spinner').removeClass('hidden');
 74 | 
 75 |           Craft.postActionRequest('recipe/nutrition-api/get-nutritional-info',
 76 |             {
 77 |               ingredients: ingredients,
 78 |               serves: serves,
 79 |             },
 80 |             function (response) {
 81 |               if (typeof response.error !== 'undefined') {
 82 |                 Craft.cp.displayError(response.error);
 83 |               } else {
 84 |                 $.each(response, function (index, value) {
 85 |                   $('#' + field + index).val(value);
 86 |                 });
 87 |               }
 88 | 
 89 |               $('.fetch-nutritional-info button').removeClass('disabled');
 90 |               $('.fetch-nutritional-info .spinner').addClass('hidden');
 91 |             }
 92 |           );
 93 |         });
 94 |       });
 95 |     }
 96 |   };
 97 | 
 98 |   // A really lightweight plugin wrapper around the constructor,
 99 |   // preventing against multiple instantiations
100 |   $.fn[pluginName] = function (options) {
101 |     return this.each(function () {
102 |       if (!$.data(this, "plugin_" + pluginName)) {
103 |         $.data(this, "plugin_" + pluginName,
104 |           new Plugin(this, options));
105 |       }
106 |     });
107 |   };
108 | 
109 | })(jQuery, window, document);
110 | 


--------------------------------------------------------------------------------
/src/helpers/PluginTemplate.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /**
  3 |  * Recipe plugin for Craft CMS 3.x
  4 |  *
  5 |  * A comprehensive recipe FieldType for Craft CMS that includes metric/imperial
  6 |  * conversion, portion calculation, and JSON-LD microdata support
  7 |  *
  8 |  * @link      https://nystudio107.com
  9 |  * @copyright Copyright (c) 2020 nystudio107
 10 |  */
 11 | 
 12 | namespace nystudio107\recipe\helpers;
 13 | 
 14 | use Craft;
 15 | use craft\helpers\Template;
 16 | use craft\web\View;
 17 | use Twig\Markup;
 18 | use yii\base\Exception;
 19 | 
 20 | /**
 21 |  * @author    nystudio107
 22 |  * @package   Recipe
 23 |  * @since     1.1.0
 24 |  */
 25 | class PluginTemplate
 26 | {
 27 |     // Static Methods
 28 |     // =========================================================================
 29 | 
 30 |     public static function renderStringTemplate(string $templateString, array $params = []): string
 31 |     {
 32 |         try {
 33 |             $html = Craft::$app->getView()->renderString($templateString, $params);
 34 |         } catch (\Exception $exception) {
 35 |             $html = Craft::t(
 36 |                 'recipe',
 37 |                 'Error rendering template string -> {error}',
 38 |                 ['error' => $exception->getMessage()]
 39 |             );
 40 |             Craft::error($html, __METHOD__);
 41 |         }
 42 | 
 43 |         return $html;
 44 |     }
 45 | 
 46 |     /**
 47 |      * Render a plugin template
 48 |      *
 49 |      * @param string $templatePath
 50 |      * @param array $params
 51 |      * @return Markup
 52 |      */
 53 |     public static function renderPluginTemplate(string $templatePath, array $params = []): Markup
 54 |     {
 55 |         $exception = null;
 56 |         $htmlText = '';
 57 |         // Stash the old template mode, and set it Control Panel template mode
 58 |         $oldMode = Craft::$app->view->getTemplateMode();
 59 |         // Look for a frontend template to render first
 60 |         try {
 61 |             Craft::$app->view->setTemplateMode(View::TEMPLATE_MODE_SITE);
 62 |         } catch (Exception $exception) {
 63 |             Craft::error($exception->getMessage(), __METHOD__);
 64 |         }
 65 | 
 66 |         // Render the template with our vars passed in
 67 |         try {
 68 |             $htmlText = Craft::$app->view->renderTemplate('recipe/' . $templatePath, $params);
 69 |             $templateRendered = true;
 70 |         } catch (\Exception $exception) {
 71 |             $templateRendered = false;
 72 |         }
 73 | 
 74 |         // If no frontend template was found, try our built-in template
 75 |         if (!$templateRendered) {
 76 |             try {
 77 |                 Craft::$app->view->setTemplateMode(View::TEMPLATE_MODE_CP);
 78 |             } catch (Exception $exception) {
 79 |                 Craft::error($exception->getMessage(), __METHOD__);
 80 |             }
 81 | 
 82 |             // Render the template with our vars passed in
 83 |             try {
 84 |                 $htmlText = Craft::$app->view->renderTemplate('recipe/' . $templatePath, $params);
 85 |                 $templateRendered = true;
 86 |             } catch (\Exception $exception) {
 87 |                 $templateRendered = false;
 88 |             }
 89 |         }
 90 | 
 91 |         // Only if the template didn't render at all should we log an error
 92 |         if (!$templateRendered) {
 93 |             $htmlText = Craft::t(
 94 |                 'recipe',
 95 |                 'Error rendering `{template}` -> {error}',
 96 |                 ['template' => $templatePath, 'error' => $exception->getMessage()]
 97 |             );
 98 |             Craft::error($htmlText, __METHOD__);
 99 |         }
100 | 
101 |         // Restore the old template mode
102 |         try {
103 |             Craft::$app->view->setTemplateMode($oldMode);
104 |         } catch (Exception $exception) {
105 |             Craft::error($exception->getMessage(), __METHOD__);
106 |         }
107 | 
108 |         return Template::raw($htmlText);
109 |     }
110 | }
111 | 


--------------------------------------------------------------------------------
/src/Recipe.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /**
  3 |  * Recipe plugin for Craft CMS 3.x
  4 |  *
  5 |  * A comprehensive recipe FieldType for Craft CMS that includes metric/imperial
  6 |  * conversion, portion calculation, and JSON-LD microdata support
  7 |  *
  8 |  * @link      https://nystudio107.com
  9 |  * @copyright Copyright (c) 2017 nystudio107
 10 |  */
 11 | 
 12 | namespace nystudio107\recipe;
 13 | 
 14 | use Craft;
 15 | use craft\base\Plugin;
 16 | use craft\events\PluginEvent;
 17 | use craft\events\RegisterComponentTypesEvent;
 18 | use craft\feedme\events\RegisterFeedMeFieldsEvent;
 19 | use craft\feedme\services\Fields as FeedMeFields;
 20 | use craft\helpers\UrlHelper;
 21 | use craft\services\Fields;
 22 | use craft\services\Plugins;
 23 | use nystudio107\recipe\fields\Recipe as RecipeField;
 24 | use nystudio107\recipe\integrations\RecipeFeedMeField;
 25 | use nystudio107\recipe\models\Settings;
 26 | use nystudio107\recipe\services\ServicesTrait;
 27 | use yii\base\Event;
 28 | 
 29 | /**
 30 |  * Class Recipe
 31 |  *
 32 |  * @author    nystudio107
 33 |  * @package   Recipe
 34 |  * @since     1.0.0
 35 |  *
 36 |  * @property Settings $settings
 37 |  */
 38 | class Recipe extends Plugin
 39 | {
 40 |     // Traits
 41 |     // =========================================================================
 42 | 
 43 |     use ServicesTrait;
 44 | 
 45 |     // Static Properties
 46 |     // =========================================================================
 47 | 
 48 |     /**
 49 |      * @var ?Recipe
 50 |      */
 51 |     public static ?Recipe $plugin = null;
 52 | 
 53 |     // Public Properties
 54 |     // =========================================================================
 55 | 
 56 |     /**
 57 |      * @var string
 58 |      */
 59 |     public string $schemaVersion = '1.0.0';
 60 | 
 61 |     /**
 62 |      * @var bool
 63 |      */
 64 |     public bool $hasCpSection = false;
 65 | 
 66 |     /**
 67 |      * @var bool
 68 |      */
 69 |     public bool $hasCpSettings = true;
 70 | 
 71 |     // Public Methods
 72 |     // =========================================================================
 73 | 
 74 |     /**
 75 |      * @inheritdoc
 76 |      */
 77 |     public function init(): void
 78 |     {
 79 |         parent::init();
 80 |         self::$plugin = $this;
 81 | 
 82 |         // Register our Field
 83 |         Event::on(
 84 |             Fields::class,
 85 |             Fields::EVENT_REGISTER_FIELD_TYPES,
 86 |             static function(RegisterComponentTypesEvent $event): void {
 87 |                 $event->types[] = RecipeField::class;
 88 |             }
 89 |         );
 90 | 
 91 |         // Show our "Welcome to Recipe" message
 92 |         Event::on(
 93 |             Plugins::class,
 94 |             Plugins::EVENT_AFTER_INSTALL_PLUGIN,
 95 |             function(PluginEvent $event): void {
 96 |                 if (($event->plugin === $this) && !Craft::$app->getRequest()->getIsConsoleRequest()) {
 97 |                     Craft::$app->getResponse()->redirect(UrlHelper::cpUrl('recipe/welcome'))->send();
 98 |                 }
 99 |             }
100 |         );
101 | 
102 |         $feedMeInstalled = Craft::$app->getPlugins()->isPluginInstalled('feed-me') && Craft::$app->getPlugins()->isPluginEnabled('feed-me');
103 | 
104 |         if ($feedMeInstalled) {
105 |             Event::on(FeedMeFields::class, FeedMeFields::EVENT_REGISTER_FEED_ME_FIELDS, function(RegisterFeedMeFieldsEvent $e) {
106 |                 $e->fields[] = RecipeFeedMeField::class;
107 |             });
108 |         }
109 | 
110 |         Craft::info(
111 |             Craft::t(
112 |                 'recipe',
113 |                 '{name} plugin loaded',
114 |                 ['name' => $this->name]
115 |             ),
116 |             __METHOD__
117 |         );
118 |     }
119 | 
120 |     /**
121 |      * @inheritdoc
122 |      */
123 |     protected function createSettingsModel(): Settings
124 |     {
125 |         return new Settings();
126 |     }
127 | 
128 |     /**
129 |      * @inheritdoc
130 |      */
131 |     protected function settingsHtml(): ?string
132 |     {
133 |         return Craft::$app->getView()->renderTemplate('recipe/settings', [
134 |             'settings' => $this->settings,
135 |         ]);
136 |     }
137 | }
138 | 


--------------------------------------------------------------------------------
/src/console/controllers/NutritionApiController.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /**
  3 |  * Recipe plugin for Craft CMS 3.x
  4 |  *
  5 |  * A comprehensive recipe FieldType for Craft CMS that includes metric/imperial
  6 |  * conversion, portion calculation, and JSON-LD microdata support
  7 |  *
  8 |  * @link      https://nystudio107.com
  9 |  * @copyright Copyright (c) 2017 nystudio107
 10 |  */
 11 | 
 12 | namespace nystudio107\recipe\console\controllers;
 13 | 
 14 | use Craft;
 15 | use craft\console\Controller;
 16 | use craft\elements\Entry;
 17 | use craft\helpers\Console;
 18 | use nystudio107\recipe\models\Settings;
 19 | use nystudio107\recipe\Recipe;
 20 | use yii\console\ExitCode;
 21 | use yii\helpers\BaseConsole;
 22 | 
 23 | /**
 24 |  * @author    nystudio107
 25 |  * @package   Recipe
 26 |  * @since     1.3.0
 27 |  */
 28 | class NutritionApiController extends Controller
 29 | {
 30 |     /**
 31 |      * @var ?string The handle of the section.
 32 |      */
 33 |     public ?string $section = null;
 34 | 
 35 |     /**
 36 |      * @var ?string The handle of the recipe field.
 37 |      */
 38 |     public ?string $field = null;
 39 | 
 40 |     /**
 41 |      * @inheritdoc
 42 |      */
 43 |     public function options($actionID): array
 44 |     {
 45 |         $options = parent::options($actionID);
 46 |         $options[] = 'section';
 47 |         $options[] = 'field';
 48 | 
 49 |         return $options;
 50 |     }
 51 | 
 52 |     /**
 53 |      * Generates nutritional information for all entries in a section provided using --section.
 54 |      */
 55 |     public function actionGenerate(): int
 56 |     {
 57 |         /** @var Settings $settings */
 58 |         $settings = Recipe::$plugin->getSettings();
 59 |         if (!$settings->hasApiCredentials()) {
 60 |             $this->stderr(Craft::t('recipe', 'API credentials do not exist in plugin settings.') . PHP_EOL, BaseConsole::FG_RED);
 61 | 
 62 |             return ExitCode::OK;
 63 |         }
 64 | 
 65 |         if ($this->section === null) {
 66 |             $this->stderr(Craft::t('recipe', 'A section handle must be provided using --section.') . PHP_EOL, BaseConsole::FG_RED);
 67 | 
 68 |             return ExitCode::OK;
 69 |         }
 70 | 
 71 |         if ($this->field === null) {
 72 |             $this->stderr(Craft::t('recipe', 'A field handle must be provided using --field.') . PHP_EOL, BaseConsole::FG_RED);
 73 | 
 74 |             return ExitCode::OK;
 75 |         }
 76 | 
 77 |         $entries = Entry::find()->section($this->section)->all();
 78 | 
 79 |         if (empty($entries)) {
 80 |             $this->stderr(Craft::t('recipe', 'No entries found in the section with handle `{handle}`.', ['handle' => $this->section]) . PHP_EOL, BaseConsole::FG_RED);
 81 | 
 82 |             return ExitCode::OK;
 83 |         }
 84 | 
 85 |         $total = count($entries);
 86 |         $count = 0;
 87 |         $failed = 0;
 88 | 
 89 |         $this->stdout(Craft::t('recipe', 'Generating nutritional information for {count} entries...', ['count' => $total]) . PHP_EOL, BaseConsole::FG_YELLOW);
 90 | 
 91 |         Console::startProgress($count, $total, '', 0.8);
 92 | 
 93 |         foreach ($entries as $entry) {
 94 |             $field = $entry->{$this->field};
 95 |             $ingredients = $field->ingredients;
 96 | 
 97 |             foreach ($ingredients as $key => $value) {
 98 |                 $ingredients[$key] = implode(' ', $value);
 99 |             }
100 | 
101 |             $nutritionalInfo = Recipe::$plugin->nutritionApi->getNutritionalInfo($ingredients, $field->serves);
102 | 
103 |             if (empty($nutritionalInfo['error'])) {
104 |                 $recipe = $entry->{$this->field};
105 | 
106 |                 foreach ($nutritionalInfo as $fieldHandle => $value) {
107 |                     $recipe[$fieldHandle] = $value;
108 |                 }
109 | 
110 |                 $entry->setFieldValue($this->field, $recipe);
111 | 
112 |                 if (!Craft::$app->getElements()->saveElement($entry)) {
113 |                     ++$failed;
114 |                 }
115 |             } else {
116 |                 ++$failed;
117 |             }
118 | 
119 |             ++$count;
120 | 
121 |             Console::updateProgress($count, $total);
122 |         }
123 | 
124 |         Console::endProgress();
125 | 
126 |         $succeeded = $count - $failed;
127 | 
128 |         $this->stdout(Craft::t('recipe', 'Successfully generated nutritional information for {count} entries.', ['count' => $succeeded]) . PHP_EOL, BaseConsole::FG_GREEN);
129 | 
130 |         if ($failed > 0) {
131 |             $this->stderr(Craft::t('recipe', 'Failed to generate nutritional information for {count} entries.', ['count' => $failed]) . PHP_EOL, BaseConsole::FG_RED);
132 |         }
133 | 
134 |         return ExitCode::OK;
135 |     }
136 | }
137 | 


--------------------------------------------------------------------------------
/src/fields/Recipe.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /**
  3 |  * Recipe plugin for Craft CMS 3.x
  4 |  *
  5 |  * A comprehensive recipe FieldType for Craft CMS that includes metric/imperial
  6 |  * conversion, portion calculation, and JSON-LD microdata support
  7 |  *
  8 |  * @link      https://nystudio107.com
  9 |  * @copyright Copyright (c) 2017 nystudio107
 10 |  */
 11 | 
 12 | namespace nystudio107\recipe\fields;
 13 | 
 14 | use Craft;
 15 | use craft\base\ElementInterface;
 16 | use craft\base\Field;
 17 | use craft\base\PreviewableFieldInterface;
 18 | use craft\elements\Asset;
 19 | use craft\helpers\Html;
 20 | use craft\helpers\Json;
 21 | use nystudio107\recipe\assetbundles\recipefield\RecipeFieldAsset;
 22 | use nystudio107\recipe\models\Recipe as RecipeModel;
 23 | use nystudio107\recipe\models\Settings;
 24 | use nystudio107\recipe\Recipe as RecipePlugin;
 25 | use Throwable;
 26 | use yii\base\InvalidConfigException;
 27 | use yii\db\Schema;
 28 | 
 29 | /**
 30 |  * @author    nystudio107
 31 |  * @package   Recipe
 32 |  * @since     1.0.0
 33 |  */
 34 | class Recipe extends Field implements PreviewableFieldInterface
 35 | {
 36 |     // Public Properties
 37 |     // =========================================================================
 38 | 
 39 |     /**
 40 |      * @var array
 41 |      */
 42 |     public array $assetSources = [];
 43 | 
 44 |     // Static Methods
 45 |     // =========================================================================
 46 | 
 47 |     /**
 48 |      * @inheritdoc
 49 |      */
 50 |     public static function dbType(): array|string|null
 51 |     {
 52 |         return Schema::TYPE_TEXT;
 53 |     }
 54 | 
 55 |     /**
 56 |      * @inheritdoc
 57 |      */
 58 |     public static function displayName(): string
 59 |     {
 60 |         return Craft::t('recipe', 'Recipe');
 61 |     }
 62 | 
 63 |     /**
 64 |      * @inheritdoc
 65 |      */
 66 |     public static function icon(): string
 67 |     {
 68 |         return 'hat-chef';
 69 |     }
 70 | 
 71 |     /**
 72 |      * @inheritdoc
 73 |      */
 74 |     public static function phpType(): string
 75 |     {
 76 |         return sprintf('\\%s', RecipeModel::class);
 77 |     }
 78 | 
 79 |     // Public Methods
 80 |     // =========================================================================
 81 | 
 82 |     /**
 83 |      * @inheritdoc
 84 |      */
 85 |     public function rules(): array
 86 |     {
 87 |         $rules = parent::rules();
 88 | 
 89 |         return array_merge($rules, [
 90 |         ]);
 91 |     }
 92 | 
 93 |     /**
 94 |      * @inheritdoc
 95 |      * @since 1.2.1
 96 |      */
 97 |     public function useFieldset(): bool
 98 |     {
 99 |         return true;
100 |     }
101 | 
102 |     /**
103 |      * @inheritdoc
104 |      */
105 |     public function normalizeValue(mixed $value, ?ElementInterface $element = null): RecipeModel
106 |     {
107 |         $config = [];
108 |         // If we already have a model, just return it
109 |         if ($value instanceof RecipeModel) {
110 |             return $value;
111 |         }
112 |         // If we have a non-empty string, try to JSON-decode it
113 |         if (is_string($value)) {
114 |             $value = Json::decodeIfJson($value);
115 |         }
116 |         // If we have an array, use that for our config data
117 |         if (is_array($value)) {
118 |             $config = $value;
119 |         }
120 |         // Ensure we save our asset ids as integers, not arrays
121 |         if (isset($config['imageId'])) {
122 |             if (is_array($config['imageId'])) {
123 |                 $config['imageId'] = $config['imageId'][0];
124 |             }
125 |         }
126 |         if (isset($config['videoId'])) {
127 |             if (is_array($config['videoId'])) {
128 |                 $config['videoId'] = $config['videoId'][0];
129 |             }
130 |         }
131 | 
132 |         return new RecipeModel($config);
133 |     }
134 | 
135 |     /**
136 |      * @inheritdoc
137 |      */
138 |     public function getSettingsHtml(): ?string
139 |     {
140 |         // Render the settings template
141 |         return Craft::$app->getView()->renderTemplate(
142 |             'recipe/_components/fields/Recipe_settings',
143 |             [
144 |                 'field' => $this,
145 |                 'assetSources' => $this->getSourceOptions(),
146 |             ]
147 |         );
148 |     }
149 | 
150 |     /**
151 |      * @inheritdoc
152 |      */
153 |     public function getInputHtml(mixed $value, ?ElementInterface $element = null): string
154 |     {
155 |         // Register our asset bundle
156 |         try {
157 |             Craft::$app->getView()->registerAssetBundle(RecipeFieldAsset::class);
158 |         } catch (InvalidConfigException $invalidConfigException) {
159 |             Craft::error($invalidConfigException->getMessage(), __METHOD__);
160 |         }
161 | 
162 |         // Get our id and namespace
163 |         $id = Html::id($this->handle);
164 |         $nameSpacedId = Craft::$app->getView()->namespaceInputId($id);
165 | 
166 |         // Variables to pass down to our field JavaScript to let it namespace properly
167 |         $jsonVars = [
168 |             'id' => $id,
169 |             'name' => $this->handle,
170 |             'namespace' => $nameSpacedId,
171 |             'prefix' => Craft::$app->getView()->namespaceInputId(''),
172 |         ];
173 |         $jsonVars = Json::encode($jsonVars);
174 |         Craft::$app->getView()->registerJs(sprintf('$(\'#%s-field\').RecipeRecipe(', $nameSpacedId) . $jsonVars . ");");
175 | 
176 |         // Set asset elements
177 |         $elements = [];
178 |         if ($value->imageId) {
179 |             if (is_array($value->imageId)) {
180 |                 $value->imageId = $value->imageId[0];
181 |             }
182 | 
183 |             $elements = [Craft::$app->getAssets()->getAssetById($value->imageId)];
184 |         }
185 | 
186 |         $videoElements = [];
187 |         if ($value->videoId) {
188 |             if (is_array($value->videoId)) {
189 |                 $value->videoId = $value->videoId[0];
190 |             }
191 | 
192 |             $videoElements = [Craft::$app->getAssets()->getAssetById($value->videoId)];
193 |         }
194 | 
195 |         /** @var Settings $settings */
196 |         $settings = RecipePlugin::$plugin->getSettings();
197 |         // Render the input template
198 |         try {
199 |             return Craft::$app->getView()->renderTemplate(
200 |                 'recipe/_components/fields/Recipe_input',
201 |                 [
202 |                     'name' => $this->handle,
203 |                     'value' => $value,
204 |                     'field' => $this,
205 |                     'id' => $id,
206 |                     'nameSpacedId' => $nameSpacedId,
207 |                     'prefix' => Craft::$app->getView()->namespaceInputId(''),
208 |                     'assetsSourceExists' => count(Craft::$app->getAssets()->findFolders()),
209 |                     'elements' => $elements,
210 |                     'videoElements' => $videoElements,
211 |                     'elementType' => Asset::class,
212 |                     'assetSources' => $this->assetSources,
213 |                     'hasApiCredentials' => $settings->hasApiCredentials(),
214 |                 ]
215 |             );
216 |         } catch (Throwable $throwable) {
217 |             Craft::error($throwable->getMessage(), __METHOD__);
218 |             return '';
219 |         }
220 |     }
221 | 
222 |     /**
223 |      * Get the asset sources
224 |      */
225 |     public function getSourceOptions(): array
226 |     {
227 |         $sourceOptions = [];
228 | 
229 |         foreach (Asset::sources('settings') as $volume) {
230 |             if (!isset($volume['heading'])) {
231 |                 $sourceOptions[] = [
232 |                     'label' => Html::encode($volume['label']),
233 |                     'value' => $volume['key'],
234 |                 ];
235 |             }
236 |         }
237 | 
238 |         return $sourceOptions;
239 |     }
240 | }
241 | 


--------------------------------------------------------------------------------
/src/templates/_integrations/feed-me.twig:
--------------------------------------------------------------------------------
  1 | {# ------------------------ #}
  2 | {# Available Variables #}
  3 | {# ------------------------ #}
  4 | {# Attributes: #}
  5 | {# type, name, handle, instructions, attribute, default, feed, feedData #}
  6 | {# ------------------------ #}
  7 | {# Fields: #}
  8 | {# name, handle, instructions, feed, feedData, field, fieldClass #}
  9 | {# ------------------------ #}
 10 | 
 11 | {% import 'feed-me/_macros' as feedMeMacro %}
 12 | {% import '_includes/forms' as forms %}
 13 | 
 14 | {# Special case when inside another complex field (Matrix) #}
 15 | {% if parentPath is defined %}
 16 |     {% set prefixPath = parentPath %}
 17 | {% else %}
 18 |     {% set prefixPath = [handle] %}
 19 | {% endif %}
 20 | 
 21 | {% set classes = ['complex-field'] %}
 22 | 
 23 | <tr class="complex-field complex-field-header">
 24 |     <td class="col-field" colspan="3">
 25 |         <div class="field">
 26 |             <div class="heading">
 27 |                 <label class="">{{ name }}</label>
 28 |             </div>
 29 | 
 30 |             <div class="additional-mapping-fields">
 31 |                 {% namespace 'fieldMapping[' ~ prefixPath | join('][') ~ ']' %}
 32 |                     <input type="text" name="field" value="{{ className(field) }}">
 33 |                 {% endnamespace %}
 34 |             </div>
 35 |         </div>
 36 |     </td>
 37 | </tr>
 38 | 
 39 | {% set subfields = [
 40 |     { label: 'Recipe Name', handle: 'name' },
 41 |     { label: 'Recipe Author', handle: 'author' },
 42 |     { label: 'Recipe Description', handle: 'description' },
 43 |     { label: 'Recipe Keywords', handle: 'keywords' },
 44 |     { label: 'Recipe Category', handle: 'recipeCategory' },
 45 |     { label: 'Recipe Cuisine', handle: 'recipeCuisine' },
 46 |     { label: 'Recipe Skill', handle: 'skill', default: {
 47 |         type: 'select',
 48 |         options: [
 49 |             { label: 'Don\'t import', value: '' },
 50 |             { label: 'Beginner', value: 'beginner' },
 51 |             { label: 'Intermediate', value: 'intermediate' },
 52 |             { label: 'Advanced', value: 'advanced' },
 53 |         ],
 54 |     } },
 55 |     { label: 'Recipe Serves', handle: 'serves' },
 56 |     { label: 'Recipe Serves Unit', handle: 'servesUnit' },
 57 |     { label: 'Recipe Image', handle: 'imageId', default: {
 58 |         type: 'elementselect',
 59 |         options: {
 60 |             limit: 1,
 61 |             elementType: 'craft\\elements\\Asset',
 62 |             selectionLabel: "Default Asset" | t('feed-me'),
 63 |         },
 64 |     } },
 65 |     { label: 'Recipe Video', handle: 'videoId', default: {
 66 |         type: 'elementselect',
 67 |         options: {
 68 |             limit: 1,
 69 |             elementType: 'craft\\elements\\Asset',
 70 |             selectionLabel: "Default Video Asset" | t('feed-me'),
 71 |         },
 72 |     } },
 73 |     { label: 'Recipe Prep Time', handle: 'prepTime' },
 74 |     { label: 'Recipe Cook Time', handle: 'cookTime' },
 75 |     { label: 'Recipe Total Time', handle: 'totalTime' },
 76 |     { label: 'Recipe Serving Size', handle: 'servingSize' },
 77 |     { label: 'Recipe Calories', handle: 'calories' },
 78 |     { label: 'Recipe Carbohydrate Content', handle: 'carbohydrateContent' },
 79 |     { label: 'Recipe Cholesterol Content', handle: 'cholesterolContent' },
 80 |     { label: 'Recipe Fat Content', handle: 'fatContent' },
 81 |     { label: 'Recipe Fiber Content', handle: 'fiberContent' },
 82 |     { label: 'Recipe Protein Content', handle: 'proteinContent' },
 83 |     { label: 'Recipe Saturated Fat Content', handle: 'saturatedFatContent' },
 84 |     { label: 'Recipe Sodium Content', handle: 'sodiumContent' },
 85 |     { label: 'Recipe Sugar Content', handle: 'sugarContent' },
 86 |     { label: 'Recipe Trans Fat Content', handle: 'transFatContent' },
 87 |     { label: 'Recipe Unsaturated Fat Content', handle: 'unsaturatedFatContent' },
 88 |     { label: 'Recipe Ingredients', handle: 'ingredients', type: 'table', default: false, cols: {
 89 |         quantity: {
 90 |             heading: "Quantity" |t,
 91 |         },
 92 |         units: {
 93 |             heading: "Units" |t,
 94 |             default: {
 95 |                 type: "select" |t,
 96 |                 options: {
 97 |                     "": "",
 98 |                     "tsp": "teaspoons" |t,
 99 |                     "tbsp": "tablespoons" |t,
100 |                     "floz": "fluid ounces" |t,
101 |                     "cups": "cups" |t,
102 |                     "oz": "ounces" |t,
103 |                     "lb": "pounds" |t,
104 |                     "ml": "milliliters" |t,
105 |                     "l": "liters" |t,
106 |                     "mg": "milligram" |t,
107 |                     "g": "grams" |t,
108 |                     "kg": "kilograms" |t,
109 |                 },
110 |             },
111 |         },
112 |         ingredient: {
113 |             heading: "Ingredient" |t,
114 |         },
115 |     }, },
116 |     { label: 'Recipe Directions', handle: 'directions', type: 'table', default: false, cols: {
117 |         direction: {
118 |             heading: "Direction" |t,
119 |         },
120 |     }, },
121 |     { label: 'Recipe Equipment', handle: 'equipment', type: 'table', default: false, cols: {
122 |         equipment: {
123 |             heading: "Equipment" |t,
124 |         },
125 |     }, },
126 |     { label: 'Recipe Ratings', handle: 'ratings', type: 'table', default: false, cols: {
127 |         rating: {
128 |             heading: "Rating" |t,
129 |             default: {
130 |                 type: "select" |t,
131 |                 options: {
132 |                     "5": "5 Stars" |t,
133 |                     "4": "4 Stars" |t,
134 |                     "3": "3 Stars" |t,
135 |                     "2": "2 Stars" |t,
136 |                     "1": "1 Star" |t,
137 |                 }
138 |             },
139 |         },
140 |         review: {
141 |             heading: "Review" |t,
142 |         },
143 |         author: {
144 |             heading: "Author" |t,
145 |         },
146 |     }, },
147 | ] %}
148 | 
149 | {% for subfield in subfields %}
150 |     {% set nameLabel = subfield.label %}
151 |     {% set instructionsHandle = handle ~ '[' ~ subfield.handle ~ ']' %}
152 | 
153 |     {% set path = prefixPath | merge ([ 'fields', subfield.handle ]) %}
154 | 
155 |     {% set default = subfield.default ?? {
156 |         type: 'text',
157 |     } %}
158 | 
159 |     {% set type = subfield.type ?? '_base' %}
160 | 
161 |     {% if type == 'table' %}
162 |         {% set columns = subfield.cols ?? {} %}
163 | 
164 |         <tr class="complex-field complex-field-header">
165 |             <td class="col-field" colspan="3">
166 |                 <div class="field">
167 |                     <div class="heading">
168 |                         <label class="">{{ nameLabel }}</label>
169 |                     </div>
170 |                 </div>
171 |             </td>
172 |         </tr>
173 | 
174 |         {% for colHandle, col in columns %}
175 |             {% set path = prefixPath | merge ([ 'fields', subfield.handle, 'fields', colHandle ]) %}
176 | 
177 |             {% set nameLabel = subfield.label ~ ': ' ~ col.heading %}
178 |             {% set instructionsHandle = handle ~ '[' ~ subfield.handle ~ ']' ~ '[' ~ colHandle ~ ']' %}
179 | 
180 |             {% set default = col.default ?? {
181 |                 type: 'text',
182 |             } %}
183 | 
184 |             {% embed 'feed-me/_includes/fields/_base' %}
185 |                 {% block additionalFieldSettings %}
186 | 
187 |                 {% endblock %}
188 | 
189 |                 {% block fieldSettings %}
190 | 
191 |                 {% endblock %}
192 |             {% endembed %}
193 |         {% endfor %}
194 |     {% else %}
195 |         {% embed 'feed-me/_includes/fields/_base' %}
196 |             {% block additionalFieldSettings %}
197 | 
198 |             {% endblock %}
199 | 
200 |             {% block fieldSettings %}
201 | 
202 |             {% endblock %}
203 |         {% endembed %}
204 |     {% endif %}
205 | {% endfor %}
206 | 


--------------------------------------------------------------------------------
/src/templates/recipe-nutrition-facts.twig:
--------------------------------------------------------------------------------
  1 | <style>
  2 |     .recipe-plugin-nutrition-label {
  3 |         background: #fff;
  4 |         border: 1px solid #000;
  5 |         box-sizing: border-box;
  6 |         padding: 10px 10px 0 10px;
  7 |         max-width: 300px;
  8 |         font-family: Helvetica, Arial, sans-serif;
  9 |         margin: 0 auto;
 10 |         font-size: 14px;
 11 |         font-weight: normal;
 12 |         text-align: left;
 13 |         -webkit-font-smoothing: antialiased;
 14 |     }
 15 | 
 16 |     .recipe-plugin-label-header {
 17 |         border-bottom: 10px solid #000;
 18 |         padding: 0 0 5px;
 19 |         margin: 0 0 4px;
 20 |     }
 21 | 
 22 |     .recipe-plugin-label-title {
 23 |         font-family: "Helvetica Black", "Franklin Gothic Heavy", Helvetica, Arial, sans-serif;
 24 |         font-weight: bold;
 25 |         font-size: 34px;
 26 |         margin: 0 0 2px;
 27 |     }
 28 | 
 29 |     .recipe-plugin-detail {
 30 |         line-height: 1.25;
 31 |     }
 32 | 
 33 |     .recipe-plugin-nutrition-label table {
 34 |         width: 100%;
 35 |         border-spacing: 0;
 36 |     }
 37 | 
 38 |     .recipe-plugin-nutrition-label table thead th {
 39 |         border: 0;
 40 |         padding: 5px 0;
 41 |         font-weight: 400;
 42 |     }
 43 | 
 44 |     .recipe-plugin-small-info {
 45 |         font-size: 11.5px;
 46 |     }
 47 | 
 48 |     .recipe-plugin-nutrition-label table tbody th, .recipe-plugin-nutrition-label table tbody td {
 49 |         padding: 3px 0;
 50 |         border-top: 1px solid #000;
 51 |         line-height: 1.75;
 52 |         font-weight: normal;
 53 |     }
 54 | 
 55 |     .recipe-plugin-nutrition-label table td:last-child {
 56 |         text-align: right;
 57 |     }
 58 | 
 59 |     .recipe-plugin-nutrition-label table td.recipe-plugin-indent {
 60 |         border-collapse: separate;
 61 | 
 62 |         border-top: 1px solid transparent;
 63 |         width: 17px;
 64 |     }
 65 | 
 66 |     .recipe-plugin-nutrition-label table tr.recipe-plugin-micros:not(:empty) td {
 67 |         border-top: 4px solid #000;
 68 |     }
 69 | 
 70 |     .recipe-plugin-nutrition-label table tr.recipe-plugin-micros ul {
 71 |         box-sizing: border-box;
 72 |         list-style: none;
 73 |         margin: 0;
 74 |         padding: 0;
 75 |     }
 76 | 
 77 |     .recipe-plugin-nutrition-label table tr.recipe-plugin-thick-row td {
 78 |         border-top: 4px solid #000;
 79 |     }
 80 | 
 81 |     .recipe-plugin-nutrition-label table tr.recipe-plugin-micros li:nth-child(1n+0) {
 82 |         padding-right: 8px;
 83 |     }
 84 | 
 85 |     .recipe-plugin-nutrition-label table tr.recipe-plugin-micros li:nth-child(2n+0) {
 86 |         padding-left: 7px;
 87 |     }
 88 | 
 89 |     .recipe-plugin-nutrition-label table tr.recipe-plugin-micros li:first-child, .recipe-plugin-nutrition-label table tr.recipe-plugin-micros li:nth-child(2) {
 90 |         border-top: none;
 91 |     }
 92 | 
 93 |     .recipe-plugin-nutrition-label table tr.recipe-plugin-micros li {
 94 |         border-top: 1px solid #000;
 95 |     }
 96 | 
 97 |     .recipe-plugin-nutrition-label table tr.recipe-plugin-micros li {
 98 |         box-sizing: border-box;
 99 |         float: left;
100 |         line-height: 1.75;
101 |         text-align: left;
102 |         width: 50%;
103 |     }
104 | 
105 |     .recipe-plugin-nutrition-label table tr.recipe-plugin-micros li span {
106 |         text-align: right;
107 |         float: right;
108 |     }
109 | </style>
110 | 
111 | 
112 | {% macro percentage(numerator, denomoninator, serves = 1) %}
113 |     {% if serves is empty %}
114 |         {% set serves = 1 %}
115 |     {% endif %}
116 |     {% set result = ((numerator / serves) * 100) / denomoninator %}
117 |     {{ result | number_format(0) ~ '%' }}
118 | {% endmacro %}
119 | {% from _self import percentage %}
120 | 
121 | {% macro servesValue(value, serves) %}
122 |     {% set result = value / serves %}
123 |     {{- result | number_format(0) -}}
124 | {% endmacro %}
125 | {% from _self import servesValue %}
126 | 
127 | <div class="recipe-plugin-label">
128 |     <div class="recipe-plugin-label-wrapper">
129 |         <div class="recipe-plugin-nutrition-label">
130 |             <header class="recipe-plugin-label-header">
131 |                 <h1 class="recipe-plugin-label-title">Nutrition Facts</h1>
132 |                 {% if value.servingSize | length %}
133 |                     <div class="recipe-plugin-detail">Serving
134 |                         {% set servingSizeParts = value.servingSize | split(' ') %}
135 |                         Size: {{ servesValue(servingSizeParts[0], value.serves) ~ ' ' ~ servingSizeParts[1] ?? '' }}
136 |                     </div>
137 |                 {% endif %}
138 |                 {% if value.serves | length %}
139 |                     <div class="recipe-plugin-detail">Serves: {{ value.serves }}</div>
140 |                 {% endif %}
141 |             </header>
142 |             <table class="recipe-plugin-label-table">
143 |                 <thead>
144 |                 <tr>
145 |                     <th colspan="3" class="recipe-plugin-small-info"><b>Amount Per Serving</b></th>
146 |                 </tr>
147 |                 </thead>
148 |                 <tbody>
149 |                 {% if value.calories | length %}
150 |                     <tr class="recipe-plugin-calories-row">
151 |                         <td colspan="2"><b>Calories:</b></td>
152 |                         <td>{{ servesValue(value.calories, value.serves) }}</td>
153 |                     </tr>
154 |                 {% endif %}
155 |                 <tr class="recipe-plugin-thick-row">
156 |                     <td colspan="3" class="recipe-plugin-small-info"><b>% Daily Value*</b></td>
157 |                 </tr>
158 |                 {% if value.fatContent | length %}
159 |                     <tr class="recipe-plugin-macros">
160 |                         <td colspan="2"><b>Total Fat:</b> {{ servesValue(value.fatContent, value.serves) ~ 'g' }}</td>
161 |                         <td><b>{{ percentage(value.fatContent, rda.fatContent, value.serves) }}</b></td>
162 |                     </tr>
163 |                 {% endif %}
164 |                 {% if value.saturatedFatContent | length %}
165 |                     <tr class="recipe-plugin-macros">
166 |                         <td class="recipe-plugin-indent"></td>
167 |                         <td>Saturated Fat: {{ servesValue(value.saturatedFatContent, value.serves) ~ 'g' }}</td>
168 |                         <td>
169 |                         </td>
170 |                     </tr>
171 |                 {% endif %}
172 |                 {% if value.transFatContent | length %}
173 |                     <tr class="recipe-plugin-macros">
174 |                         <td class="recipe-plugin-indent"></td>
175 |                         <td>Trans Fat: {{ servesValue(value.transFatContent, value.serves) ~ 'g' }}</td>
176 |                         <td>
177 |                         </td>
178 |                     </tr>
179 |                 {% endif %}
180 |                 {% if value.cholesterolContent | length %}
181 |                     <tr class="recipe-plugin-macros">
182 |                         <td colspan="2">
183 |                             <b>Cholesterol:</b> {{ servesValue(value.cholesterolContent, value.serves) ~ 'mg' }}</td>
184 |                         <td><b>{{ percentage(value.cholesterolContent, rda.cholesterolContent, value.serves) }}</b></td>
185 |                     </tr>
186 |                 {% endif %}
187 |                 {% if value.sodiumContent | length %}
188 |                     <tr class="recipe-plugin-macros">
189 |                         <td colspan="2"><b>Sodium:</b> {{ servesValue(value.sodiumContent, value.serves) ~ 'mg' }}</td>
190 |                         <td><b>{{ percentage(value.sodiumContent, rda.sodiumContent, value.serves) }}</b></td>
191 |                     </tr>
192 |                 {% endif %}
193 |                 {% if value.carbohydrateContent | length %}
194 |                     <tr class="recipe-plugin-macros">
195 |                         <td colspan="2"><b>Total
196 |                                 Carbohydrate:</b> {{ servesValue(value.carbohydrateContent, value.serves) ~ 'g' }}</td>
197 |                         <td><b>{{ percentage(value.carbohydrateContent, rda.carbohydrateContent, value.serves) }}</b>
198 |                         </td>
199 |                     </tr>
200 |                 {% endif %}
201 |                 {% if value.fiberContent | length %}
202 |                     <tr class="recipe-plugin-macros">
203 |                         <td class="recipe-plugin-indent"></td>
204 |                         <td>Dietary Fiber: {{ servesValue(value.fiberContent, value.serves) ~ 'g' }}</td>
205 |                         <td><b>{{ percentage(value.fiberContent, rda.fiberContent, value.serves) }}</b></td>
206 |                     </tr>
207 |                 {% endif %}
208 |                 {% if value.sugarContent | length %}
209 |                     <tr class="recipe-plugin-macros">
210 |                         <td class="recipe-plugin-indent"></td>
211 |                         <td>Sugars: {{ servesValue(value.sugarContent, value.serves) ~ 'g' }}</td>
212 |                         <td><b>{{ percentage(value.sugarContent, rda.sugarContent, value.serves) }}</b></td>
213 |                     </tr>
214 |                 {% endif %}
215 |                 {% if value.proteinContent | length %}
216 |                     <tr class="recipe-plugin-macros">
217 |                         <td colspan="2"><b>Protein:</b> {{ servesValue(value.proteinContent, value.serves) ~ 'g' }}</td>
218 |                         <td><b>{{ percentage(value.proteinContent, rda.proteinContent, value.serves) }}</b></td>
219 |                     </tr>
220 |                 {% endif %}
221 | 
222 |                 </tbody>
223 |             </table>
224 |         </div>
225 |     </div>
226 | </div>
227 | 


--------------------------------------------------------------------------------
/src/templates/_components/fields/Recipe_input.twig:
--------------------------------------------------------------------------------
  1 | {#
  2 | /**
  3 |  * Recipe plugin for Craft CMS 3.x
  4 |  *
  5 |  * Recipe Field Input
  6 |  *
  7 |  * @author    nystudio107
  8 |  * @copyright Copyright (c) 2017 nystudio107
  9 |  * @link      https://nystudio107.com
 10 |  * @package   Recipe
 11 |  * @since     1.0.0
 12 |  */
 13 | #}
 14 | 
 15 | {% import "_includes/forms" as forms %}
 16 | 
 17 | {% set baseAssetsUrl = view.getAssetManager().getPublishedUrl('@nystudio107/recipe/assetbundles/recipefield/dist', true) %}
 18 | 
 19 | <div id="{{ id }}" class="recipe-field">
 20 |     <nav id="{{ id ~ "tabs" }}" class="recipe-tabs">
 21 |         <ul>
 22 |             <li><a id="{{ id ~ "tabs-recipe" }}" class="recipe-tab-links tab sel"
 23 |                    href="#{{ prefix ~ id ~ 'tab-recipe' }}" tabindex="0"><img class="recipe-field-icon"
 24 |                                                                               src="{{ baseAssetsUrl ~ '/img/Recipe-icon.svg' }}"
 25 |                                                                               width="16px" height="auto"/><span
 26 |                         class="recipe-field-title">Recipe</span></a></li>
 27 |             <li><a id="{{ id ~ "tabs-ratings" }}" class="recipe-tab-links tab" href="#{{ prefix ~ id ~ 'tab-ratings' }}"
 28 |                    tabindex="0"><img class="recipe-field-icon" src="{{ baseAssetsUrl ~ '/img/Star-icon.svg' }}"
 29 |                                      width="16px" height="auto"/><span class="recipe-field-title">Ratings</span></a>
 30 |             </li>
 31 |             <li><a id="{{ id ~ "tabs-health" }}" class="recipe-tab-links tab" href="#{{ prefix ~ id ~ 'tab-health' }}"
 32 |                    tabindex="0"><img class="recipe-field-icon" src="{{ baseAssetsUrl ~ '/img/Healthy-icon.svg' }}"
 33 |                                      width="16px" height="auto"/><span class="recipe-field-title">Nutrition</span></a>
 34 |             </li>
 35 |         </ul>
 36 |     </nav>
 37 |     <div id="{{ id ~ "tab-recipe" }}" class="recipe-tab-content">
 38 |         <fieldset class="recipe-fields">
 39 |             {{ forms.textField({
 40 |                 id: id ~ 'name',
 41 |                 class: 'nicetext',
 42 |                 name: name ~ '[name]',
 43 |                 label: 'Recipe Name' |t,
 44 |                 instructions: 'Enter the name of this recipe' |t,
 45 |                 value: value.name,
 46 |                 errors: value.getErrors('name'),
 47 |                 required: true,
 48 |             }) }}
 49 | 
 50 |             {{ forms.textField({
 51 |                 id: id ~ 'author',
 52 |                 class: 'nicetext',
 53 |                 name: name ~ '[author]',
 54 |                 label: 'Recipe Author' |t,
 55 |                 instructions: 'Enter the person who authored this recipe' |t,
 56 |                 value: value.author,
 57 |                 errors: value.getErrors('author'),
 58 |                 required: false,
 59 |             }) }}
 60 | 
 61 |             {{ forms.textareaField({
 62 |                 id: id ~ 'description',
 63 |                 class: 'nicetext',
 64 |                 name: name ~ '[description]',
 65 |                 label: 'Recipe Description' |t,
 66 |                 instructions: 'Enter a description of this recipe' |t,
 67 |                 value: value.description,
 68 |                 errors: value.getErrors('description'),
 69 |                 required: false,
 70 |             }) }}
 71 | 
 72 |             {{ forms.textField({
 73 |                 id: id ~ 'keywords',
 74 |                 class: 'nicetext',
 75 |                 name: name ~ '[keywords]',
 76 |                 label: 'Recipe Keywords' |t,
 77 |                 instructions: 'A comma-separated list of keywords for this recipe' |t,
 78 |                 value: value.keywords,
 79 |                 errors: value.getErrors('keywords'),
 80 |                 required: false,
 81 |             }) }}
 82 | 
 83 |             {{ forms.textField({
 84 |                 id: id ~ 'recipeCategory',
 85 |                 class: 'nicetext',
 86 |                 name: name ~ '[recipeCategory]',
 87 |                 label: 'Recipe Category' |t,
 88 |                 instructions: 'The category of the recipe—for example, appetizer, entree, etc.' |t,
 89 |                 value: value.recipeCategory,
 90 |                 errors: value.getErrors('recipeCategory'),
 91 |                 required: false,
 92 |             }) }}
 93 | 
 94 |             {{ forms.textField({
 95 |                 id: id ~ 'recipeCuisine',
 96 |                 class: 'nicetext',
 97 |                 name: name ~ '[recipeCuisine]',
 98 |                 label: 'Recipe Cuisine' |t,
 99 |                 instructions: 'The cuisine of the recipe (for example, French or Ethiopian).' |t,
100 |                 value: value.recipeCuisine,
101 |                 errors: value.getErrors('recipeCuisine'),
102 |                 required: false,
103 |             }) }}
104 | 
105 |             {{ forms.selectField({
106 |                 id: id ~ "skill",
107 |                 name: name ~ "[skill]",
108 |                 label: 'Recipe Skill' |t,
109 |                 instructions: 'The skill level required to make this recipe' |t,
110 |                 options: {
111 |                     "beginner": "Beginner"|t,
112 |                     "intermediate": "Intermediate"|t,
113 |                     "advanced": "Advanced"|t,
114 |                 },
115 |                 value: value.skill,
116 |             }) }}
117 | 
118 |             {{ forms.textField({
119 |                 id: id ~ 'serves',
120 |                 type: 'number',
121 |                 class: 'nicetext',
122 |                 size: 3,
123 |                 name: name ~ '[serves]',
124 |                 label: 'Recipe Serves' |t,
125 |                 instructions: 'Enter how many people this recipe serves' |t,
126 |                 value: value.serves,
127 |                 errors: value.getErrors('serves'),
128 |                 required: true,
129 |             }) }}
130 | 
131 |             {{ forms.textField({
132 |                 id: id ~ 'servesUnit',
133 |                 class: 'nicetext',
134 |                 name: name ~ '[servesUnit]',
135 |                 label: 'Recipe Serves Unit' |t,
136 |                 instructions: 'Enter the name of the portions (slices, pints, loafs...)' |t,
137 |                 value: value.servesUnit,
138 |                 errors: value.getErrors('servesUnit'),
139 |                 required: false,
140 |             }) }}
141 | 
142 |             {% if assetsSourceExists %}
143 |                 {{ forms.elementSelectField({
144 |                     elements: elements,
145 |                     id: id ~ 'imageId',
146 |                     name: name ~ '[imageId]',
147 |                     label: 'Recipe Image' |t,
148 |                     instructions: 'Pick an image that represents this recipe. This is also used for the Recipe Video thumbnail, if a Recipe Video is present.' |t,
149 |                     elementType: elementType,
150 |                     criteria: {
151 |                         'kind': ['image'],
152 |                     },
153 |                     sourceElementId: value.imageId,
154 |                     sources: assetSources,
155 |                     jsClass: 'Craft.AssetSelectInput',
156 |                     addButtonLabel: "Select an Image" |t,
157 |                     limit: 1,
158 |                 }) }}
159 |             {% else %}
160 |                 <p class="error">No assets sources currently exist.</p>
161 |             {% endif %}
162 | 
163 |             {% if assetsSourceExists %}
164 |                 {{ forms.elementSelectField({
165 |                     elements: videoElements,
166 |                     id: id ~ 'videoId',
167 |                     name: name ~ '[videoId]',
168 |                     label: 'Recipe Video' |t,
169 |                     instructions: 'Pick an video that represents this recipe' |t,
170 |                     elementType: elementType,
171 |                     criteria: {
172 |                         'kind': ['video'],
173 |                     },
174 |                     sourceElementId: value.videoId,
175 |                     sources: assetSources,
176 |                     jsClass: 'Craft.AssetSelectInput',
177 |                     addButtonLabel: "Select a Video" |t,
178 |                     limit: 1,
179 |                 }) }}
180 |             {% else %}
181 |                 <p class="error">No assets sources currently exist.</p>
182 |             {% endif %}
183 | 
184 |             {{ forms.editableTableField({
185 |                 id: id ~ 'ingredients',
186 |                 name: name ~ '[ingredients]',
187 |                 label: 'Recipe Ingredients' |t,
188 |                 instructions: "Enter the ingredients needed for this recipe by clicking on 'Add an Ingredient'.  The quantity should be in decimal form." |t,
189 |                 required: false,
190 |                 allowAdd: true,
191 |                 allowDelete: true,
192 |                 allowReorder: true,
193 |                 static: false,
194 |                 cols: {
195 |                     quantity: {
196 |                         heading: "Quantity" |t,
197 |                         type: "number" |t,
198 |                         width: '5%',
199 |                     },
200 |                     units: {
201 |                         heading: "Units" |t,
202 |                         type: "select" |t,
203 |                         width: '20%',
204 |                         options: {
205 |                             "": "",
206 |                             "tsp": "teaspoons" |t,
207 |                             "tbsp": "tablespoons" |t,
208 |                             "floz": "fluid ounces" |t,
209 |                             "cups": "cups" |t,
210 |                             "oz": "ounces" |t,
211 |                             "lb": "pounds" |t,
212 |                             "ml": "milliliters" |t,
213 |                             "l": "liters" |t,
214 |                             "mg": "milligram" |t,
215 |                             "g": "grams" |t,
216 |                             "kg": "kilograms" |t,
217 |                         }
218 |                     },
219 |                     ingredient: {
220 |                         heading: "Ingredient" |t,
221 |                         type: "singleline" |t,
222 |                         width: '75%',
223 |                     },
224 |                 },
225 |                 rows: value.ingredients,
226 |                 addRowLabel: "Add an Ingredient" |t,
227 |             }) }}
228 | 
229 |             {{ forms.editableTableField({
230 |                 id: id ~ 'directions',
231 |                 name: name ~ '[directions]',
232 |                 label: 'Recipe Directions' |t,
233 |                 instructions: "Enter the directions for this recipe by clicking on 'Add a Direction'." |t,
234 |                 required: false,
235 |                 allowAdd: true,
236 |                 allowDelete: true,
237 |                 allowReorder: true,
238 |                 static: false,
239 |                 cols: {
240 |                     direction: {
241 |                         heading: "Direction" |t,
242 |                         type: "multiline" |t,
243 |                     },
244 |                 },
245 |                 rows: value.directions,
246 |                 addRowLabel: "Add a Direction" |t,
247 |             }) }}
248 | 
249 |             {{ forms.editableTableField({
250 |                 id: id ~ 'equipment',
251 |                 name: name ~ '[equipment]',
252 |                 label: 'Recipe Equipment' |t,
253 |                 instructions: "Enter the equipment for this recipe by clicking on 'Add Equipment'." |t,
254 |                 required: false,
255 |                 allowAdd: true,
256 |                 allowDelete: true,
257 |                 allowReorder: true,
258 |                 static: false,
259 |                 cols: {
260 |                     equipment: {
261 |                         heading: "Equipment" |t,
262 |                         type: "multiline" |t,
263 |                     },
264 |                 },
265 |                 rows: value.equipment,
266 |                 addRowLabel: "Add Equipment" |t,
267 |             }) }}
268 | 
269 |             {{ forms.textField({
270 |                 id: id ~ 'prepTime',
271 |                 type: 'number',
272 |                 class: 'nicetext',
273 |                 name: name ~ '[prepTime]',
274 |                 size: 3,
275 |                 label: 'Recipe Prep Time' |t,
276 |                 instructions: 'The number of minutes it takes to prep this recipe' |t,
277 |                 value: value.prepTime,
278 |                 errors: value.getErrors('prepTime'),
279 |                 required: false,
280 |             }) }}
281 | 
282 |             {{ forms.textField({
283 |                 id: id ~ 'cookTime',
284 |                 type: 'number',
285 |                 class: 'nicetext',
286 |                 size: 3,
287 |                 name: name ~ '[cookTime]',
288 |                 label: 'Recipe Cook Time' |t,
289 |                 instructions: 'The number of minutes it takes to cook this recipe' |t,
290 |                 value: value.cookTime,
291 |                 errors: value.getErrors('cookTime'),
292 |                 required: false,
293 |             }) }}
294 | 
295 |             {{ forms.textField({
296 |                 id: id ~ 'totalTime',
297 |                 type: 'number',
298 |                 class: 'nicetext',
299 |                 size: 3,
300 |                 name: name ~ '[totalTime]',
301 |                 label: 'Recipe Total Time' |t,
302 |                 instructions: 'The number of minutes it takes for this entire recipe' |t,
303 |                 value: value.totalTime,
304 |                 errors: value.getErrors('totalTime'),
305 |                 required: false,
306 |             }) }}
307 |         </fieldset>
308 |     </div>
309 | 
310 |     <div id="{{ id ~ "tab-ratings" }}" class="recipe-tab-content hidden">
311 |         <fieldset class="recipe-fields">
312 |             {{ forms.editableTableField({
313 |                 id: id ~ 'ratings',
314 |                 name: name ~ '[ratings]',
315 |                 label: 'Recipe Ratings' |t,
316 |                 instructions: "Enter ratings of this recipe by clicking on 'Add a Rating'." |t,
317 |                 required: false,
318 |                 allowAdd: true,
319 |                 allowDelete: true,
320 |                 allowReorder: true,
321 |                 static: false,
322 |                 cols: {
323 |                     rating: {
324 |                         heading: "Rating" |t,
325 |                         type: "select" |t,
326 |                         width: '10%',
327 |                         options: {
328 |                             "5": "5 Stars" |t,
329 |                             "4": "4 Stars" |t,
330 |                             "3": "3 Stars" |t,
331 |                             "2": "2 Stars" |t,
332 |                             "1": "1 Star" |t,
333 |                         }
334 |                     },
335 |                     review: {
336 |                         heading: "Review" |t,
337 |                         type: "singleline" |t,
338 |                         width: '60%',
339 |                     },
340 |                     author: {
341 |                         heading: "Author" |t,
342 |                         type: "singleline" |t,
343 |                         width: '30%',
344 |                     },
345 |                 },
346 |                 rows: value.ratings,
347 |                 addRowLabel: "Add a Rating" |t,
348 |             }) }}
349 |         </fieldset>
350 |     </div>
351 | 
352 |     <div id="{{ id ~ "tab-health" }}" class="recipe-tab-content hidden">
353 |         <fieldset class="recipe-fields">
354 |             {% if hasApiCredentials %}
355 |                 <div class="fetch-nutritional-info text-right" style="margin: -8px 0 -24px;">
356 |                     <span class="spinner hidden"></span>
357 |                     <button data-field="{{ nameSpacedId }}" class="btn submit">
358 |                         Fetch Nutritional Information
359 |                     </button>
360 |                 </div>
361 |             {% endif %}
362 | 
363 |             {{ forms.textField({
364 |                 id: id ~ 'servingSize',
365 |                 class: 'nicetext',
366 |                 name: name ~ '[servingSize]',
367 |                 label: 'Recipe Serving Size' |t,
368 |                 instructions: 'The serving size, in terms of the number of volume or mass' |t,
369 |                 value: value.servingSize,
370 |                 errors: value.getErrors('servingSize'),
371 |                 required: false,
372 |             }) }}
373 | 
374 |             {{ forms.textField({
375 |                 id: id ~ 'calories',
376 |                 type: 'number',
377 |                 class: 'nicetext',
378 |                 size: 3,
379 |                 name: name ~ '[calories]',
380 |                 label: 'Recipe Calories' |t,
381 |                 instructions: 'The number of calories per serving' |t,
382 |                 value: value.calories,
383 |                 errors: value.getErrors('calories'),
384 |                 required: false,
385 |             }) }}
386 | 
387 |             {{ forms.textField({
388 |                 id: id ~ 'carbohydrateContent',
389 |                 type: 'number',
390 |                 class: 'nicetext',
391 |                 size: 3,
392 |                 name: name ~ '[carbohydrateContent]',
393 |                 label: 'Recipe Carbohydrate Content' |t,
394 |                 instructions: 'The number of grams of carbohydrates per serving' |t,
395 |                 value: value.carbohydrateContent,
396 |                 errors: value.getErrors('carbohydrateContent'),
397 |                 required: false,
398 |             }) }}
399 | 
400 |             {{ forms.textField({
401 |                 id: id ~ 'cholesterolContent',
402 |                 type: 'number',
403 |                 class: 'nicetext',
404 |                 size: 3,
405 |                 name: name ~ '[cholesterolContent]',
406 |                 label: 'Recipe Cholesterol Content' |t,
407 |                 instructions: 'The number of milligrams of cholesterol per serving' |t,
408 |                 value: value.cholesterolContent,
409 |                 errors: value.getErrors('cholesterolContent'),
410 |                 required: false,
411 |             }) }}
412 | 
413 |             {{ forms.textField({
414 |                 id: id ~ 'fatContent',
415 |                 type: 'number',
416 |                 class: 'nicetext',
417 |                 size: 3,
418 |                 name: name ~ '[fatContent]',
419 |                 label: 'Recipe Fat Content' |t,
420 |                 instructions: 'The number of grams of fat per serving' |t,
421 |                 value: value.fatContent,
422 |                 errors: value.getErrors('fatContent'),
423 |                 required: false,
424 |             }) }}
425 | 
426 |             {{ forms.textField({
427 |                 id: id ~ 'fiberContent',
428 |                 type: 'number',
429 |                 class: 'nicetext',
430 |                 size: 3,
431 |                 name: name ~ '[fiberContent]',
432 |                 label: 'Recipe Fiber Content' |t,
433 |                 instructions: 'The number of grams of fiber per serving' |t,
434 |                 value: value.fiberContent,
435 |                 errors: value.getErrors('fiberContent'),
436 |                 required: false,
437 |             }) }}
438 | 
439 |             {{ forms.textField({
440 |                 id: id ~ 'proteinContent',
441 |                 type: 'number',
442 |                 class: 'nicetext',
443 |                 size: 3,
444 |                 name: name ~ '[proteinContent]',
445 |                 label: 'Recipe Protein Content' |t,
446 |                 instructions: 'The number of grams of protein per serving' |t,
447 |                 value: value.proteinContent,
448 |                 errors: value.getErrors('proteinContent'),
449 |                 required: false,
450 |             }) }}
451 | 
452 |             {{ forms.textField({
453 |                 id: id ~ 'saturatedFatContent',
454 |                 type: 'number',
455 |                 class: 'nicetext',
456 |                 size: 3,
457 |                 name: name ~ '[saturatedFatContent]',
458 |                 label: 'Recipe Saturated Fat Content' |t,
459 |                 instructions: 'The number of grams of saturated fat per serving' |t,
460 |                 value: value.saturatedFatContent,
461 |                 errors: value.getErrors('saturatedFatContent'),
462 |                 required: false,
463 |             }) }}
464 | 
465 |             {{ forms.textField({
466 |                 id: id ~ 'sodiumContent',
467 |                 type: 'number',
468 |                 class: 'nicetext',
469 |                 size: 3,
470 |                 name: name ~ '[sodiumContent]',
471 |                 label: 'Recipe Sodium Content' |t,
472 |                 instructions: 'The number of milligrams of sodium per serving' |t,
473 |                 value: value.sodiumContent,
474 |                 errors: value.getErrors('sodiumContent'),
475 |                 required: false,
476 |             }) }}
477 | 
478 |             {{ forms.textField({
479 |                 id: id ~ 'sugarContent',
480 |                 type: 'number',
481 |                 class: 'nicetext',
482 |                 size: 3,
483 |                 name: name ~ '[sugarContent]',
484 |                 label: 'Recipe Sugar Content' |t,
485 |                 instructions: 'The number of grams of sugar per serving' |t,
486 |                 value: value.sugarContent,
487 |                 errors: value.getErrors('sugarContent'),
488 |                 required: false,
489 |             }) }}
490 | 
491 |             {{ forms.textField({
492 |                 id: id ~ 'transFatContent',
493 |                 type: 'number',
494 |                 class: 'nicetext',
495 |                 size: 3,
496 |                 name: name ~ '[transFatContent]',
497 |                 label: 'Recipe Trans Fat Content' |t,
498 |                 instructions: 'The number of grams of trans fat per serving' |t,
499 |                 value: value.transFatContent,
500 |                 errors: value.getErrors('transFatContent'),
501 |                 required: false,
502 |             }) }}
503 | 
504 |             {{ forms.textField({
505 |                 id: id ~ 'unsaturatedFatContent',
506 |                 type: 'number',
507 |                 class: 'nicetext',
508 |                 size: 3,
509 |                 name: name ~ '[unsaturatedFatContent]',
510 |                 label: 'Recipe Unsaturated Fat Content' |t,
511 |                 instructions: 'The number of grams of unsaturated fat per serving' |t,
512 |                 value: value.unsaturatedFatContent,
513 |                 errors: value.getErrors('unsaturatedFatContent'),
514 |                 required: false,
515 |             }) }}
516 |         </fieldset>
517 |     </div>
518 | </div>
519 | 


--------------------------------------------------------------------------------
/src/models/Recipe.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /**
  3 |  * Recipe plugin for Craft CMS 3.x
  4 |  *
  5 |  * A comprehensive recipe FieldType for Craft CMS that includes metric/imperial
  6 |  * conversion, portion calculation, and JSON-LD microdata support
  7 |  *
  8 |  * @link      https://nystudio107.com
  9 |  * @copyright Copyright (c) 2017 nystudio107
 10 |  */
 11 | 
 12 | namespace nystudio107\recipe\models;
 13 | 
 14 | use Craft;
 15 | use craft\base\Model;
 16 | use craft\helpers\StringHelper;
 17 | use craft\helpers\Template;
 18 | use craft\validators\ArrayValidator;
 19 | use Exception;
 20 | use nystudio107\recipe\helpers\Json;
 21 | use nystudio107\recipe\helpers\PluginTemplate;
 22 | use nystudio107\seomatic\models\MetaJsonLd;
 23 | use nystudio107\seomatic\Seomatic;
 24 | use Twig\Markup;
 25 | 
 26 | /**
 27 |  * @author    nystudio107
 28 |  * @package   Recipe
 29 |  * @since     1.0.0
 30 |  */
 31 | class Recipe extends Model
 32 | {
 33 |     // Constants
 34 |     // =========================================================================
 35 | 
 36 |     public const SEOMATIC_PLUGIN_HANDLE = 'seomatic';
 37 | 
 38 |     public const MAIN_ENTITY_KEY = 'mainEntityOfPage';
 39 | 
 40 |     public const US_RDA = [
 41 |         'calories' => 2000,
 42 |         'carbohydrateContent' => 275,
 43 |         'cholesterolContent' => 300,
 44 |         'fatContent' => 78,
 45 |         'fiberContent' => 28,
 46 |         'proteinContent' => 50,
 47 |         'saturatedFatContent' => 20,
 48 |         'sodiumContent' => 2300,
 49 |         'sugarContent' => 50,
 50 |     ];
 51 | 
 52 |     // Mapping to convert any of the incorrect plural values
 53 |     public const NORMALIZE_PLURALS = [
 54 |         'tsps' => 'tsp',
 55 |         'tbsps' => 'tbsp',
 56 |         'flozs' => 'floz',
 57 |         'cups' => 'cups',
 58 |         'ozs' => 'oz',
 59 |         'lbs' => 'lb',
 60 |         'mls' => 'ml',
 61 |         'ls' => 'l',
 62 |         'mgs' => 'mg',
 63 |         'gs' => 'g',
 64 |         'kg' => 'kg',
 65 |     ];
 66 | 
 67 |     // Public Properties
 68 |     // =========================================================================
 69 | 
 70 |     /**
 71 |      * @var string
 72 |      */
 73 |     public string $name = '';
 74 | 
 75 |     /**
 76 |      * @var string
 77 |      */
 78 |     public string $author = '';
 79 | 
 80 |     /**
 81 |      * @var string
 82 |      */
 83 |     public string $description = '';
 84 | 
 85 |     /**
 86 |      * @var string
 87 |      */
 88 |     public string $keywords = '';
 89 | 
 90 |     /**
 91 |      * @var string
 92 |      */
 93 |     public string $recipeCategory = '';
 94 | 
 95 |     /**
 96 |      * @var string
 97 |      */
 98 |     public string $recipeCuisine = '';
 99 | 
100 |     /**
101 |      * @var string
102 |      */
103 |     public string $skill = 'intermediate';
104 | 
105 |     /**
106 |      * @var int
107 |      */
108 |     public int $serves = 1;
109 | 
110 |     /**
111 |      * @var string
112 |      */
113 |     public string $servesUnit = '';
114 | 
115 |     /**
116 |      * @var array
117 |      */
118 |     public array $ingredients = [];
119 | 
120 |     /**
121 |      * @var array
122 |      */
123 |     public array $directions = [];
124 | 
125 |     /**
126 |      * @var array
127 |      */
128 |     public array $equipment = [];
129 | 
130 |     /**
131 |      * @var ?int
132 |      */
133 |     public ?int $imageId = null;
134 | 
135 |     /**
136 |      * @var ?int
137 |      */
138 |     public ?int $videoId = null;
139 | 
140 |     /**
141 |      * @var int
142 |      */
143 |     public int $prepTime = 0;
144 | 
145 |     /**
146 |      * @var int
147 |      */
148 |     public int $cookTime = 0;
149 | 
150 |     /**
151 |      * @var int
152 |      */
153 |     public int $totalTime = 0;
154 | 
155 |     /**
156 |      * @var ?array
157 |      */
158 |     public ?array $ratings = null;
159 | 
160 |     /**
161 |      * @var string
162 |      */
163 |     public string $servingSize = '';
164 | 
165 |     /**
166 |      * @var int
167 |      */
168 |     public int $calories = 0;
169 | 
170 |     /**
171 |      * @var int
172 |      */
173 |     public int $carbohydrateContent = 0;
174 | 
175 |     /**
176 |      * @var int
177 |      */
178 |     public int $cholesterolContent = 0;
179 | 
180 |     /**
181 |      * @var int
182 |      */
183 |     public int $fatContent = 0;
184 | 
185 |     /**
186 |      * @var int
187 |      */
188 |     public int $fiberContent = 0;
189 | 
190 |     /**
191 |      * @var int
192 |      */
193 |     public int $proteinContent = 0;
194 | 
195 |     /**
196 |      * @var int
197 |      */
198 |     public int $saturatedFatContent = 0;
199 | 
200 |     /**
201 |      * @var int
202 |      */
203 |     public int $sodiumContent = 0;
204 | 
205 |     /**
206 |      * @var int
207 |      */
208 |     public int $sugarContent = 0;
209 | 
210 |     /**
211 |      * @var int
212 |      */
213 |     public int $transFatContent = 0;
214 | 
215 |     /**
216 |      * @var int
217 |      */
218 |     public int $unsaturatedFatContent = 0;
219 | 
220 |     // Public Methods
221 |     // =========================================================================
222 | 
223 |     /**
224 |      * @inheritdoc
225 |      */
226 |     public function init(): void
227 |     {
228 |         parent::init();
229 |         // Fix any of the incorrect plural values
230 |         if (!empty($this->ingredients)) {
231 |             foreach ($this->ingredients as &$row) {
232 |                 if (!empty($row['units']) && !empty(self::NORMALIZE_PLURALS[$row['units']])) {
233 |                     $row['units'] = self::NORMALIZE_PLURALS[$row['units']];
234 |                 }
235 |             }
236 | 
237 |             unset($row);
238 |         }
239 |     }
240 | 
241 |     /**
242 |      * @inheritdoc
243 |      */
244 |     public function rules(): array
245 |     {
246 |         return [
247 |             ['name', 'string'],
248 |             ['author', 'string'],
249 |             ['name', 'default', 'value' => ''],
250 |             ['description', 'string'],
251 |             ['keywords', 'string'],
252 |             ['recipeCategory', 'string'],
253 |             ['recipeCuisine', 'string'],
254 |             ['skill', 'string'],
255 |             ['serves', 'integer'],
256 |             ['imageId', 'integer'],
257 |             ['videoId', 'integer'],
258 |             ['prepTime', 'integer'],
259 |             ['cookTime', 'integer'],
260 |             ['totalTime', 'integer'],
261 |             ['servingSize', 'string'],
262 |             ['calories', 'integer'],
263 |             ['carbohydrateContent', 'integer'],
264 |             ['cholesterolContent', 'integer'],
265 |             ['fatContent', 'integer'],
266 |             ['fiberContent', 'integer'],
267 |             ['proteinContent', 'integer'],
268 |             ['saturatedFatContent', 'integer'],
269 |             ['sodiumContent', 'integer'],
270 |             ['sugarContent', 'integer'],
271 |             ['transFatContent', 'integer'],
272 |             ['unsaturatedFatContent', 'integer'],
273 |             [
274 |                 [
275 |                     'ingredients',
276 |                     'directions',
277 |                     'equipment',
278 |                 ],
279 |                 ArrayValidator::class,
280 |             ],
281 | 
282 |         ];
283 |     }
284 | 
285 |     /**
286 |      * Return the JSON-LD Structured Data for this recipe
287 |      */
288 |     public function getRecipeJSONLD(): array
289 |     {
290 |         $recipeJSONLD = [
291 |             'context' => 'https://schema.org',
292 |             'type' => 'Recipe',
293 |             'name' => $this->name,
294 |             'image' => $this->getImageUrl(),
295 |             'description' => $this->description,
296 |             'keywords' => $this->keywords,
297 |             'recipeCategory' => $this->recipeCategory,
298 |             'recipeCuisine' => $this->recipeCuisine,
299 |             'recipeYield' => $this->getServes(),
300 |             'recipeIngredient' => $this->getIngredients('imperial', 0, false),
301 |             'recipeInstructions' => $this->getDirections(false),
302 |             'tool' => $this->getEquipment(false),
303 |         ];
304 |         $recipeJSONLD = array_filter($recipeJSONLD);
305 | 
306 |         if (!empty($this->author)) {
307 |             $author = [
308 |                 'type' => 'Person',
309 |                 'name' => $this->author,
310 |             ];
311 |             $author = array_filter($author);
312 |             $recipeJSONLD['author'] = $author;
313 |         }
314 | 
315 |         $videoUrl = $this->getVideoUrl();
316 |         if (!empty($videoUrl)) {
317 |             $video = [
318 |                 'type' => 'VideoObject',
319 |                 'name' => $this->name,
320 |                 'description' => $this->description,
321 |                 'contentUrl' => $videoUrl,
322 |                 'thumbnailUrl' => $this->getImageUrl(),
323 |                 'uploadDate' => $this->getVideoUploadedDate(),
324 |             ];
325 |             $video = array_filter($video);
326 |             $recipeJSONLD['video'] = $video;
327 |         }
328 | 
329 |         $nutrition = [
330 |             'type' => 'NutritionInformation',
331 |             'servingSize' => $this->servingSize,
332 |             'calories' => $this->calories,
333 |             'carbohydrateContent' => $this->carbohydrateContent,
334 |             'cholesterolContent' => $this->cholesterolContent,
335 |             'fatContent' => $this->fatContent,
336 |             'fiberContent' => $this->fiberContent,
337 |             'proteinContent' => $this->proteinContent,
338 |             'saturatedFatContent' => $this->saturatedFatContent,
339 |             'sodiumContent' => $this->sodiumContent,
340 |             'sugarContent' => $this->sugarContent,
341 |             'transFatContent' => $this->transFatContent,
342 |             'unsaturatedFatContent' => $this->unsaturatedFatContent,
343 |         ];
344 |         $nutrition = array_filter($nutrition);
345 |         $recipeJSONLD['nutrition'] = $nutrition;
346 |         if (count($recipeJSONLD['nutrition']) === 1) {
347 |             unset($recipeJSONLD['nutrition']);
348 |         }
349 | 
350 |         $aggregateRating = $this->getAggregateRating();
351 |         if ($aggregateRating) {
352 |             $aggregateRatings = [
353 |                 'type' => 'AggregateRating',
354 |                 'ratingCount' => $this->getRatingsCount(),
355 |                 'bestRating' => '5',
356 |                 'worstRating' => '1',
357 |                 'ratingValue' => $aggregateRating,
358 |             ];
359 |             $aggregateRatings = array_filter($aggregateRatings);
360 |             $recipeJSONLD['aggregateRating'] = $aggregateRatings;
361 | 
362 |             $reviews = [];
363 |             foreach ($this->ratings as $rating) {
364 |                 $review = [
365 |                     'type' => 'Review',
366 |                     'author' => $rating['author'],
367 |                     'name' => $this->name . ' ' . Craft::t('recipe', 'Review'),
368 |                     'description' => $rating['review'],
369 |                     'reviewRating' => [
370 |                         'type' => 'Rating',
371 |                         'bestRating' => '5',
372 |                         'worstRating' => '1',
373 |                         'ratingValue' => $rating['rating'],
374 |                     ],
375 |                 ];
376 |                 $reviews[] = $review;
377 |             }
378 | 
379 |             $reviews = array_filter($reviews);
380 |             $recipeJSONLD['review'] = $reviews;
381 |         }
382 | 
383 |         if ($this->prepTime !== 0) {
384 |             $recipeJSONLD['prepTime'] = 'PT' . $this->prepTime . 'M';
385 |         }
386 | 
387 |         if ($this->cookTime !== 0) {
388 |             $recipeJSONLD['cookTime'] = 'PT' . $this->cookTime . 'M';
389 |         }
390 | 
391 |         if ($this->totalTime !== 0) {
392 |             $recipeJSONLD['totalTime'] = 'PT' . $this->totalTime . 'M';
393 |         }
394 | 
395 |         return $recipeJSONLD;
396 |     }
397 | 
398 |     /**
399 |      * Create the SEOmatic MetaJsonLd object for this recipe
400 |      *
401 |      * @param null $key
402 |      */
403 |     public function createRecipeMetaJsonLd($key = null, bool $add = true): ?MetaJsonLd
404 |     {
405 |         $result = null;
406 |         if (Craft::$app->getPlugins()->getPlugin(self::SEOMATIC_PLUGIN_HANDLE)) {
407 |             $seomatic = Seomatic::getInstance();
408 |             if ($seomatic !== null) {
409 |                 $recipeJson = $this->getRecipeJSONLD();
410 |                 // If we're adding the MetaJsonLd to the container, and no key is provided, give it a random key
411 |                 if ($add && $key === null) {
412 |                     try {
413 |                         $key = StringHelper::UUID();
414 |                     } catch (Exception) {
415 |                         // That's okay
416 |                     }
417 |                 }
418 | 
419 |                 if ($key !== null) {
420 |                     $recipeJson['key'] = $key;
421 |                 }
422 | 
423 |                 // If the key is `mainEntityOfPage` add in the URL
424 |                 if ($key === self::MAIN_ENTITY_KEY) {
425 |                     $mainEntity = Seomatic::$plugin->jsonLd->get(self::MAIN_ENTITY_KEY);
426 |                     if ($mainEntity !== null) {
427 |                         $recipeJson[self::MAIN_ENTITY_KEY] = $mainEntity[self::MAIN_ENTITY_KEY];
428 |                     }
429 |                 }
430 | 
431 |                 $result = Seomatic::$plugin->jsonLd->create(
432 |                     $recipeJson,
433 |                     $add
434 |                 );
435 |             }
436 |         }
437 | 
438 |         return $result;
439 |     }
440 | 
441 |     /**
442 |      * Render the JSON-LD Structured Data for this recipe
443 |      *
444 |      *
445 |      */
446 |     public function renderRecipeJSONLD(bool $raw = true): string|Markup
447 |     {
448 |         return $this->renderJsonLd($this->getRecipeJSONLD(), $raw);
449 |     }
450 | 
451 |     /**
452 |      * Get the URL to the recipe's image
453 |      *
454 |      * @param null $transform
455 |      */
456 |     public function getImageUrl($transform = null): ?string
457 |     {
458 |         $result = '';
459 |         if ($this->imageId) {
460 |             $image = Craft::$app->getAssets()->getAssetById($this->imageId);
461 |             if ($image) {
462 |                 $result = $image->getUrl($transform);
463 |             }
464 |         }
465 | 
466 |         return $result;
467 |     }
468 | 
469 |     /**
470 |      * Get the URL to the recipe's video
471 |      */
472 |     public function getVideoUrl(): ?string
473 |     {
474 |         $result = '';
475 |         if ($this->videoId) {
476 |             $video = Craft::$app->getAssets()->getAssetById($this->videoId);
477 |             if ($video) {
478 |                 $result = $video->getUrl();
479 |             }
480 |         }
481 | 
482 |         return $result;
483 |     }
484 | 
485 |     /**
486 |      * Get the URL to the recipe's uploaded date
487 |      */
488 |     public function getVideoUploadedDate(): ?string
489 |     {
490 |         $result = '';
491 |         if ($this->videoId) {
492 |             $video = Craft::$app->getAssets()->getAssetById($this->videoId);
493 |             if ($video) {
494 |                 $result = $video->dateCreated->format('c');
495 |             }
496 |         }
497 | 
498 |         return $result;
499 |     }
500 | 
501 |     /**
502 |      * Render the Nutrition Facts template
503 |      */
504 |     public function renderNutritionFacts(array $rda = self::US_RDA): Markup
505 |     {
506 |         return PluginTemplate::renderPluginTemplate(
507 |             'recipe-nutrition-facts',
508 |             [
509 |                 'value' => $this,
510 |                 'rda' => $rda,
511 |             ]
512 |         );
513 |     }
514 | 
515 |     /**
516 |      * Get all the ingredients for this recipe
517 |      */
518 |     public function getIngredients(string $outputUnits = 'imperial', int $serving = 0, bool $raw = true): array
519 |     {
520 |         $result = [];
521 | 
522 |         foreach ($this->ingredients as $row) {
523 |             $convertedUnits = '';
524 |             $ingredient = '';
525 |             if ($row['quantity']) {
526 |                 // Multiply the quantity by how many servings we want
527 |                 $multiplier = 1;
528 |                 if ($serving > 0) {
529 |                     $multiplier = $serving / $this->serves;
530 |                 }
531 | 
532 |                 $quantity = $row['quantity'] * $multiplier;
533 |                 $originalQuantity = $quantity;
534 | 
535 |                 // Do the imperial->metric units conversion
536 |                 if ($outputUnits === 'imperial') {
537 |                     switch ($row['units']) {
538 |                         case 'ml':
539 |                             $convertedUnits = 'tsp';
540 |                             $quantity *= 0.2;
541 |                             break;
542 |                         case 'l':
543 |                             $convertedUnits = 'cups';
544 |                             $quantity *= 4.2;
545 |                             break;
546 |                         case 'mg':
547 |                             $convertedUnits = 'oz';
548 |                             $quantity *= 0.000035274;
549 |                             break;
550 |                         case 'g':
551 |                             $convertedUnits = 'oz';
552 |                             $quantity *= 0.035274;
553 |                             break;
554 |                         case 'kg':
555 |                             $convertedUnits = 'lb';
556 |                             $quantity *= 2.2046226218;
557 |                             break;
558 |                     }
559 |                 }
560 | 
561 |                 // Do the metric->imperial units conversion
562 |                 if ($outputUnits === 'metric') {
563 |                     switch ($row['units']) {
564 |                         case 'tsp':
565 |                             $convertedUnits = 'ml';
566 |                             $quantity *= 4.929;
567 |                             break;
568 |                         case 'tbsp':
569 |                             $convertedUnits = 'ml';
570 |                             $quantity *= 14.787;
571 |                             break;
572 |                         case 'floz':
573 |                             $convertedUnits = 'ml';
574 |                             $quantity *= 29.574;
575 |                             break;
576 |                         case 'cups':
577 |                             $convertedUnits = 'l';
578 |                             $quantity *= 0.236588;
579 |                             break;
580 |                         case 'oz':
581 |                             $convertedUnits = 'g';
582 |                             $quantity *= 28.3495;
583 |                             break;
584 |                         case 'lb':
585 |                             $convertedUnits = 'kg';
586 |                             $quantity *= 0.45359237;
587 |                             break;
588 |                     }
589 | 
590 |                     $quantity = round($quantity, 1);
591 |                 }
592 | 
593 |                 // Convert units to nice fractions
594 |                 $quantity = $this->convertToFractions($quantity);
595 | 
596 |                 $ingredient .= $quantity;
597 | 
598 |                 if ($row['units']) {
599 |                     $units = $row['units'];
600 |                     if ($convertedUnits !== '' && $convertedUnits !== '0') {
601 |                         $units = $convertedUnits;
602 |                     }
603 | 
604 |                     if ($originalQuantity <= 1) {
605 |                         $units = rtrim($units);
606 |                         $units = rtrim($units, 's');
607 |                     }
608 | 
609 |                     $ingredient .= ' ' . $units;
610 |                 }
611 |             }
612 | 
613 |             if ($row['ingredient']) {
614 |                 $ingredient .= ' ' . $row['ingredient'];
615 |             }
616 | 
617 |             if ($raw) {
618 |                 $ingredient = Template::raw($ingredient);
619 |             }
620 | 
621 |             $result[] = $ingredient;
622 |         }
623 | 
624 |         return $result;
625 |     }
626 | 
627 |     /**
628 |      * Get all the directions for this recipe
629 |      *
630 |      *
631 |      * @return array
632 |      */
633 |     public function getDirections(bool $raw = true): array
634 |     {
635 |         $result = [];
636 |         foreach ($this->directions as $row) {
637 |             $direction = $row['direction'];
638 |             if ($raw) {
639 |                 $direction = Template::raw($direction);
640 |             }
641 | 
642 |             $result[] = $direction;
643 |         }
644 | 
645 |         return $result;
646 |     }
647 | 
648 |     /**
649 |      * Get all the equipment for this recipe
650 |      */
651 |     public function getEquipment(bool $raw = true): array
652 |     {
653 |         $result = [];
654 |         foreach ($this->equipment as $row) {
655 |             $equipment = $row['equipment'];
656 |             if ($raw) {
657 |                 $equipment = Template::raw($equipment);
658 |             }
659 | 
660 |             $result[] = $equipment;
661 |         }
662 | 
663 |         return $result;
664 |     }
665 | 
666 |     /**
667 |      * Get the aggregate rating from all the ratings
668 |      */
669 |     public function getAggregateRating(): float|int|string
670 |     {
671 |         $result = 0;
672 |         $total = 0;
673 |         if (!empty($this->ratings)) {
674 |             foreach ($this->ratings as $row) {
675 |                 $result += $row['rating'];
676 |                 ++$total;
677 |             }
678 | 
679 |             $result /= $total;
680 |         } else {
681 |             $result = '';
682 |         }
683 | 
684 |         return $result;
685 |     }
686 | 
687 |     /**
688 |      * Get the total number of ratings
689 |      */
690 |     public function getRatingsCount(): int
691 |     {
692 |         return count($this->ratings);
693 |     }
694 | 
695 |     /**
696 |      * Returns concatenated serves with its unit
697 |      */
698 |     public function getServes(): int|string
699 |     {
700 |         if (!empty($this->servesUnit)) {
701 |             return $this->serves . ' ' . $this->servesUnit;
702 |         }
703 | 
704 |         return $this->serves;
705 |     }
706 | 
707 |     /**
708 |      * Convert decimal numbers into fractions
709 |      *
710 |      * @param $quantity
711 |      */
712 |     private function convertToFractions($quantity): string
713 |     {
714 |         $whole = floor($quantity);
715 |         // Round the mantissa so we can do a floating point comparison without
716 |         // weirdness, per: https://www.php.net/manual/en/language.types.float.php#113703
717 |         $fraction = round($quantity - $whole, 3);
718 |         switch ($fraction) {
719 |             case 0:
720 |                 $fraction = '';
721 |                 break;
722 |             case 0.25:
723 |                 $fraction = ' &frac14;';
724 |                 break;
725 |             case 0.33:
726 |                 $fraction = ' &frac13;';
727 |                 break;
728 |             case 0.66:
729 |                 $fraction = ' &frac23;';
730 |                 break;
731 |             case 0.165:
732 |                 $fraction = ' &frac16;';
733 |                 break;
734 |             case 0.5:
735 |                 $fraction = ' &frac12;';
736 |                 break;
737 |             case 0.75:
738 |                 $fraction = ' &frac34;';
739 |                 break;
740 |             case 0.125:
741 |                 $fraction = ' &#x215B;';
742 |                 break;
743 |             case 0.375:
744 |                 $fraction = ' &#x215C;';
745 |                 break;
746 |             case 0.625:
747 |                 $fraction = ' &#x215D;';
748 |                 break;
749 |             case 0.875:
750 |                 $fraction = ' &#x215E;';
751 |                 break;
752 |             default:
753 |                 $precision = 1;
754 |                 $pnum = round($fraction, $precision);
755 |                 $denominator = 10 ** $precision;
756 |                 $numerator = $pnum * $denominator;
757 |                 $fraction = ' <sup>'
758 |                     . $numerator
759 |                     . '</sup>&frasl;<sub>'
760 |                     . $denominator
761 |                     . '</sub>';
762 |                 break;
763 |         }
764 | 
765 |         if ($whole == 0) {
766 |             $whole = '';
767 |         }
768 | 
769 |         return $whole . $fraction;
770 |     }
771 | 
772 |     // Private Methods
773 |     // =========================================================================
774 | 
775 |     /**
776 |      * Renders a JSON-LD representation of the schema
777 |      *
778 |      * @param      $json
779 |      */
780 |     private function renderJsonLd($json, bool $raw = true): string|Markup
781 |     {
782 |         $linebreak = '';
783 | 
784 |         // If `devMode` is enabled, make the JSON-LD human-readable
785 |         if (Craft::$app->getConfig()->getGeneral()->devMode) {
786 |             $linebreak = PHP_EOL;
787 |         }
788 | 
789 |         // Render the resulting JSON-LD
790 |         $result = '<script type="application/ld+json">'
791 |             . $linebreak
792 |             . Json::encode($json)
793 |             . $linebreak
794 |             . '</script>';
795 | 
796 |         if ($raw) {
797 |             $result = Template::raw($result);
798 |         }
799 | 
800 |         return $result;
801 |     }
802 | }
803 | 


--------------------------------------------------------------------------------