├── phpstan.neon
├── src
    ├── assetbundles
    │   ├── units
    │   │   ├── dist
    │   │   │   ├── css
    │   │   │   │   └── Units.css
    │   │   │   ├── js
    │   │   │   │   └── Units.js
    │   │   │   └── img
    │   │   │   │   └── Units-icon.svg
    │   │   └── UnitsAsset.php
    │   └── unitsfield
    │   │   ├── dist
    │   │       ├── css
    │   │       │   └── Units.css
    │   │       ├── js
    │   │       │   └── Units.js
    │   │       └── img
    │   │       │   └── Units-icon.svg
    │   │   └── UnitsFieldAsset.php
    ├── gql
    │   └── types
    │   │   ├── UnitsDataType.php
    │   │   └── generators
    │   │       └── UnitsDataGenerator.php
    ├── templates
    │   ├── _components
    │   │   └── fields
    │   │   │   ├── Units_input.twig
    │   │   │   └── Units_settings.twig
    │   └── settings.twig
    ├── translations
    │   └── en
    │   │   └── units.php
    ├── config.php
    ├── helpers
    │   ├── ClassHelper.php
    │   └── ClassMapGenerator.php
    ├── controllers
    │   └── UnitsController.php
    ├── models
    │   ├── Settings.php
    │   └── UnitsData.php
    ├── icon.svg
    ├── validators
    │   └── EmbeddedUnitsDataValidator.php
    ├── Units.php
    ├── variables
    │   └── UnitsVariable.php
    └── fields
    │   └── Units.php
├── ecs.php
├── CHANGELOG.md
├── Makefile
├── LICENSE.md
├── composer.json
└── README.md


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


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


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


--------------------------------------------------------------------------------
/CHANGELOG.md:
--------------------------------------------------------------------------------
 1 | # Units Changelog
 2 | 
 3 | ## 5.0.1 - 2025.06.13
 4 | ### Fixed
 5 | * Pinned the `php-units-of-measure` to version `~2.1.0` to avoid breaking changes in non-major releases
 6 | 
 7 | ## 5.0.0 - 2025.01.19
 8 | ### Added
 9 | * Initial Craft CMS 5 release
10 | * Add a GraphQL interface for Units fields, closes ([#5](https://github.com/nystudio107/craft-units/issues/5))
11 | 


--------------------------------------------------------------------------------
/src/assetbundles/unitsfield/dist/css/Units.css:
--------------------------------------------------------------------------------
 1 | /**
 2 |  * Units plugin for Craft CMS
 3 |  *
 4 |  * Units Field CSS
 5 |  *
 6 |  * @author    nystudio107
 7 |  * @copyright Copyright (c) nystudio107
 8 |  * @link      https://nystudio107.com/
 9 |  * @package   Units
10 |  * @since     1.0.0
11 |  */
12 | 
13 | .units-field-units {
14 |     margin: -20px 9px;
15 | }
16 | 
17 | .units-field-units-select {
18 |     margin: -16px 0px;
19 | }
20 | 


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


--------------------------------------------------------------------------------
/LICENSE.md:
--------------------------------------------------------------------------------
1 | The MIT License (MIT)
2 | 
3 | Copyright (c) 2018 nystudio107
4 | 
5 | 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:
6 | 
7 | The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
8 | 
9 | 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.


--------------------------------------------------------------------------------
/src/assetbundles/units/UnitsAsset.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Units plugin for Craft CMS
 4 |  *
 5 |  * A plugin for handling physical quantities and the units of measure in which they're represented.
 6 |  *
 7 |  * @link      https://nystudio107.com/
 8 |  * @copyright Copyright (c) nystudio107
 9 |  */
10 | 
11 | namespace nystudio107\units\assetbundles\units;
12 | 
13 | use craft\web\AssetBundle;
14 | use craft\web\assets\cp\CpAsset;
15 | 
16 | /**
17 |  * @author    nystudio107
18 |  * @package   Units
19 |  * @since     1.0.0
20 |  */
21 | class UnitsAsset extends AssetBundle
22 | {
23 |     // Public Methods
24 |     // =========================================================================
25 | 
26 |     /**
27 |      * @inheritdoc
28 |      */
29 |     public function init(): void
30 |     {
31 |         $this->sourcePath = "@nystudio107/units/assetbundles/units/dist";
32 | 
33 |         $this->depends = [
34 |             CpAsset::class,
35 |         ];
36 | 
37 |         $this->js = [
38 |             'js/Units.js',
39 |         ];
40 | 
41 |         $this->css = [
42 |             'css/Units.css',
43 |         ];
44 | 
45 |         parent::init();
46 |     }
47 | }
48 | 


--------------------------------------------------------------------------------
/src/assetbundles/unitsfield/UnitsFieldAsset.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Units plugin for Craft CMS
 4 |  *
 5 |  * A plugin for handling physical quantities and the units of measure in which they're represented.
 6 |  *
 7 |  * @link      https://nystudio107.com/
 8 |  * @copyright Copyright (c) nystudio107
 9 |  */
10 | 
11 | namespace nystudio107\units\assetbundles\unitsfield;
12 | 
13 | use craft\web\AssetBundle;
14 | use craft\web\assets\cp\CpAsset;
15 | 
16 | /**
17 |  * @author    nystudio107
18 |  * @package   Units
19 |  * @since     1.0.0
20 |  */
21 | class UnitsFieldAsset extends AssetBundle
22 | {
23 |     // Public Methods
24 |     // =========================================================================
25 | 
26 |     /**
27 |      * @inheritdoc
28 |      */
29 |     public function init(): void
30 |     {
31 |         $this->sourcePath = "@nystudio107/units/assetbundles/unitsfield/dist";
32 | 
33 |         $this->depends = [
34 |             CpAsset::class,
35 |         ];
36 | 
37 |         $this->js = [
38 |             'js/Units.js',
39 |         ];
40 | 
41 |         $this->css = [
42 |             'css/Units.css',
43 |         ];
44 | 
45 |         parent::init();
46 |     }
47 | }
48 | 


--------------------------------------------------------------------------------
/src/gql/types/UnitsDataType.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Units plugin for Craft CMS
 4 |  *
 5 |  * A plugin for handling physical quantities and the units of measure in which they're represented.
 6 |  *
 7 |  * @link      https://nystudio107.com/
 8 |  * @copyright Copyright (c) nystudio107
 9 |  */
10 | 
11 | namespace nystudio107\units\gql\types;
12 | 
13 | use craft\gql\base\ObjectType;
14 | use GraphQL\Type\Definition\ResolveInfo;
15 | use nystudio107\units\models\UnitsData;
16 | 
17 | /**
18 |  * @author    nystudio107
19 |  * @package   CodeField
20 |  * @since     5.0.0
21 |  */
22 | class UnitsDataType extends ObjectType
23 | {
24 |     /**
25 |      * @inheritdoc
26 |      */
27 |     protected function resolve(mixed $source, array $arguments, mixed $context, ResolveInfo $resolveInfo): mixed
28 |     {
29 |         /** @var UnitsData $source */
30 |         $fieldName = $resolveInfo->fieldName;
31 |         // Special-case to `toString` since __ prefixes are reserved in GQL
32 |         if ($fieldName === 'toString') {
33 |             $fieldName = '__toString';
34 |         }
35 |         // If the method exists, call it with the passed in args. Otherwise try to retur a property
36 |         if (method_exists($source, $fieldName)) {
37 |             return $source->$fieldName(...$arguments);
38 |         } else {
39 |             return $source->$fieldName;
40 |         }
41 |     }
42 | }
43 | 


--------------------------------------------------------------------------------
/src/assetbundles/unitsfield/dist/js/Units.js:
--------------------------------------------------------------------------------
 1 | /**
 2 |  * Units plugin for Craft CMS
 3 |  *
 4 |  * Units Field JS
 5 |  *
 6 |  * @author    nystudio107
 7 |  * @copyright Copyright (c) nystudio107
 8 |  * @link      https://nystudio107.com/
 9 |  * @package   Units
10 |  * @since     1.0.0UnitsUnits
11 |  */
12 | 
13 | ;(function ($, window, document, undefined) {
14 | 
15 |   var pluginName = "UnitsUnits",
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 |       });
40 |     }
41 |   };
42 | 
43 |   // A really lightweight plugin wrapper around the constructor,
44 |   // preventing against multiple instantiations
45 |   $.fn[pluginName] = function (options) {
46 |     return this.each(function () {
47 |       if (!$.data(this, "plugin_" + pluginName)) {
48 |         $.data(this, "plugin_" + pluginName,
49 |           new Plugin(this, options));
50 |       }
51 |     });
52 |   };
53 | 
54 | })(jQuery, window, document);
55 | 


--------------------------------------------------------------------------------
/src/assetbundles/units/dist/js/Units.js:
--------------------------------------------------------------------------------
 1 | /**
 2 |  * Units plugin for Craft CMS
 3 |  *
 4 |  * Units JS
 5 |  *
 6 |  * @author    nystudio107
 7 |  * @copyright Copyright (c) nystudio107
 8 |  * @link      https://nystudio107.com/
 9 |  * @package   Units
10 |  * @since     1.0.0
11 |  */
12 | 
13 | /**
14 |  * Fill a dynamic schema.org type menu with the units data
15 |  *
16 |  * @param menuId
17 |  * @param menuValue
18 |  * @param unitsClass
19 |  * @param callback
20 |  */
21 | function fillDynamicUnitsMenu(menuId, menuValue, unitsClass, callback) {
22 |   var menu = $('#' + menuId);
23 | 
24 |   if (menu.length) {
25 |     menu.empty();
26 |     $.ajax({
27 |         url: Craft.getActionUrl('units/units/available-units?unitsClass=' + unitsClass)
28 |       })
29 |       .done(function (data) {
30 |         var newValue = Object.keys(data)[0];
31 |         for (var k in data) {
32 |           if (data.hasOwnProperty(k)) {
33 |             if (k === menuValue) {
34 |               newValue = menuValue;
35 |             }
36 |             $('<option />')
37 |               .attr('value', k)
38 |               .html(data[k])
39 |               .appendTo(menu);
40 |           }
41 |         }
42 |         menu.val(newValue);
43 |         if (callback !== undefined) {
44 |           callback();
45 |         }
46 |       })
47 |       .fail(function (data) {
48 |         console.log('Error loading units data');
49 |       })
50 |   }
51 | }
52 | 


--------------------------------------------------------------------------------
/src/templates/_components/fields/Units_input.twig:
--------------------------------------------------------------------------------
 1 | {# @var craft \craft\web\twig\variables\CraftVariable #}
 2 | {# @var model \nystudio107\units\models\UnitsData #}
 3 | {# @var field \nystudio107\units\fields\Units #}
 4 | {#
 5 | /**
 6 |  * Units plugin for Craft CMS
 7 |  *
 8 |  * Units Field Input
 9 |  *
10 |  * @author    nystudio107
11 |  * @copyright Copyright (c) nystudio107
12 |  * @link      https://nystudio107.com/
13 |  * @package   Units
14 |  * @since     1.0.0
15 |  */
16 | #}
17 | 
18 | {% import "_includes/forms" as forms %}
19 | 
20 | {% do view.registerAssetBundle("nystudio107\\units\\assetbundles\\units\\UnitsAsset") %}
21 | {% do view.registerAssetBundle("nystudio107\\units\\assetbundles\\unitsfield\\UnitsFieldAsset") %}
22 | 
23 | {{ forms.textField({
24 |     id: id ~ "value",
25 |     name: name ~ "[value]",
26 |     value: value,
27 |     size: field.size,
28 | }) }}
29 | 
30 | {% if field.changeableUnits %}
31 |     <div class="field units-field-units-select">
32 |         {{ forms.select({
33 |             id: id ~ "units",
34 |             name: name ~ "[units]",
35 |             options: craft.units.availableUnits(model.unitsClass),
36 |             value: model.units,
37 |         }) }}
38 |     </div>
39 | {% else %}
40 |     <div class="field units-field-units">
41 |         <div class="heading">
42 |             <p class="instructions">{{ field.defaultUnits }}</p>
43 |         </div>
44 |     </div>
45 | {% endif %}
46 | 


--------------------------------------------------------------------------------
/src/translations/en/units.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Units plugin for Craft CMS
 4 |  *
 5 |  * A plugin for handling physical quantities and the units of measure in which they're represented.
 6 |  *
 7 |  * @link      https://nystudio107.com/
 8 |  * @copyright Copyright (c) nystudio107
 9 |  */
10 | 
11 | /**
12 |  * @author    nystudio107
13 |  * @package   Units
14 |  * @since     1.0.0
15 |  */
16 | return [
17 |     'Min Value' => 'Min Value',
18 |     'Max Value' => 'Max Value',
19 |     'Default Size' => 'Default Size',
20 |     'Default Min Value' => 'Default Min Value',
21 |     'Is not a Model object.' => 'Is not a Model object.',
22 |     'Default Measure Type' => 'Default Measure Type',
23 |     'Size' => 'Size',
24 |     'Default Units Changeable' => 'Default Units Changeable',
25 |     'Default Value' => 'Default Value',
26 |     '{name} plugin loaded' => '{name} plugin loaded',
27 |     'blah.' => 'blah.',
28 |     'Default Max Value' => 'Default Max Value',
29 |     'Units Changeable' => 'Units Changeable',
30 |     'Units' => 'Units',
31 |     'Measure Type' => 'Measure Type',
32 |     'Object failed to validate' => 'Object failed to validate',
33 |     'Decimal Points' => 'Decimal Points',
34 |     'UnitsData failed validation: ' => 'UnitsData failed validation: ',
35 |     'Default Decimal Points' => 'Default Decimal Points',
36 |     'Default Units' => 'Default Units',
37 |     'Default settings for newly created Units fields' => 'Default settings for newly created Units fields',
38 | ];
39 | 


--------------------------------------------------------------------------------
/src/config.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Units plugin for Craft CMS
 4 |  *
 5 |  * A plugin for handling physical quantities and the units of measure in which they're represented.
 6 |  *
 7 |  * @link      https://nystudio107.com/
 8 |  * @copyright Copyright (c) nystudio107
 9 |  */
10 | 
11 | use PhpUnitsOfMeasure\PhysicalQuantity\Length;
12 | 
13 | /**
14 |  * Units config.php
15 |  *
16 |  * This file exists only as a template for the Units settings.
17 |  * It does nothing on its own.
18 |  *
19 |  * Don't edit this file, instead copy it to 'craft/config' as 'units.php'
20 |  * and make your changes there to override default settings.
21 |  *
22 |  * Once copied to 'craft/config', this file will be multi-environment aware as
23 |  * well, so you can have different settings groups for each environment, just as
24 |  * you do for 'general.php'
25 |  */
26 | return [
27 |     // The default fully qualified class name of the unit of measure
28 |     'defaultUnitsClass' => Length::class,
29 | 
30 |     // The default value of the unit of measure
31 |     'defaultValue' => 0.0,
32 | 
33 |     // The default units that the unit of measure is in
34 |     'defaultUnits' => 'ft',
35 | 
36 |     // Whether the units the field can be changed
37 |     'defaultChangeableUnits' => true,
38 | 
39 |     // The default minimum allowed number
40 |     'defaultMin' => 0,
41 | 
42 |     // The default maximum allowed number
43 |     'defaultMax' => null,
44 | 
45 |     // The default number of digits allowed after the decimal point
46 |     'defaultDecimals' => 3,
47 | 
48 |     // The default size of the field
49 |     'defaultSize' => 6,
50 | ];
51 | 


--------------------------------------------------------------------------------
/composer.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "name": "nystudio107/craft-units",
 3 |   "description": "Units is a plugin that can convert between any units of measure, and comes with a Field for content authors to use",
 4 |   "type": "craft-plugin",
 5 |   "version": "5.0.1",
 6 |   "keywords": [
 7 |     "craft",
 8 |     "cms",
 9 |     "craftcms",
10 |     "craft-plugin",
11 |     "measurement",
12 |     "measures",
13 |     "units",
14 |     "conversion"
15 |   ],
16 |   "support": {
17 |     "docs": "https://nystudio107.com/docs/units/",
18 |     "issues": "https://nystudio107.com/plugins/units/support",
19 |     "source": "https://github.com/nystudio107/craft-units"
20 |   },
21 |   "license": "MIT",
22 |   "authors": [
23 |     {
24 |       "name": "nystudio107",
25 |       "homepage": "https://nystudio107.com/"
26 |     }
27 |   ],
28 |   "require": {
29 |     "craftcms/cms": "^5.0.0",
30 |     "php-units-of-measure/php-units-of-measure": "~2.1.0"
31 |   },
32 |   "require-dev": {
33 |     "craftcms/ecs": "dev-main",
34 |     "craftcms/phpstan": "dev-main",
35 |     "craftcms/rector": "dev-main"
36 |   },
37 |   "scripts": {
38 |     "phpstan": "phpstan --ansi --memory-limit=1G",
39 |     "check-cs": "ecs check --ansi",
40 |     "fix-cs": "ecs check --fix --ansi"
41 |   },
42 |   "config": {
43 |     "allow-plugins": {
44 |       "craftcms/plugin-installer": true,
45 |       "yiisoft/yii2-composer": true
46 |     },
47 |     "optimize-autoloader": true,
48 |     "platform": {
49 |       "php": "8.2"
50 |     },
51 |     "platform-check": false,
52 |     "sort-packages": true
53 |   },
54 |   "autoload": {
55 |     "psr-4": {
56 |       "nystudio107\\units\\": "src/"
57 |     }
58 |   },
59 |   "extra": {
60 |     "class": "nystudio107\\units\\Units",
61 |     "handle": "units",
62 |     "name": "Units"
63 |   }
64 | }
65 | 


--------------------------------------------------------------------------------
/src/helpers/ClassHelper.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Units plugin for Craft CMS
 4 |  *
 5 |  * A plugin for handling physical quantities and the units of measure in which they're represented.
 6 |  *
 7 |  * @link      https://nystudio107.com/
 8 |  * @copyright Copyright (c) nystudio107
 9 |  */
10 | 
11 | namespace nystudio107\units\helpers;
12 | 
13 | use Craft;
14 | use ReflectionClass;
15 | use ReflectionException;
16 | use function dirname;
17 | 
18 | /**
19 |  * @author    nystudio107
20 |  * @package   Units
21 |  * @since     1.0.0
22 |  */
23 | class ClassHelper
24 | {
25 |     // Public Static Methods
26 |     // =========================================================================
27 | 
28 |     /**
29 |      * Return an array of classes in the same namespace as $className, in an
30 |      * array of shortName => fullyQualifiedName
31 |      *
32 |      * @param string $className
33 |      *
34 |      * @return array
35 |      */
36 |     public static function getClassesInNamespace(string $className): array
37 |     {
38 |         $result = [];
39 |         $loader = include Craft::getAlias('@vendor/autoload.php');
40 |         $filePath = $loader->findFile($className);
41 |         if ($filePath) {
42 |             $dir = realpath(dirname($filePath));
43 |             $classesMap = ClassMapGenerator::createMap($dir);
44 |             foreach ($classesMap as $class => $path) {
45 |                 try {
46 |                     $reflect = new ReflectionClass($class);
47 |                     $shortName = $reflect->getShortName();
48 |                     $result[$shortName] = $class;
49 |                 } catch (ReflectionException $e) {
50 |                     Craft::error($e->getMessage(), __METHOD__);
51 |                 }
52 |             }
53 |         }
54 |         ksort($result);
55 | 
56 |         return $result;
57 |     }
58 | }
59 | 


--------------------------------------------------------------------------------
/src/controllers/UnitsController.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Units plugin for Craft CMS
 4 |  *
 5 |  * A plugin for handling physical quantities and the units of measure in which they're represented.
 6 |  *
 7 |  * @link      https://nystudio107.com/
 8 |  * @copyright Copyright (c) nystudio107
 9 |  */
10 | 
11 | namespace nystudio107\units\controllers;
12 | 
13 | use craft\web\Controller;
14 | use nystudio107\units\Units;
15 | use yii\web\Response;
16 | 
17 | /**
18 |  * @author    nystudio107
19 |  * @package   Units
20 |  * @since     1.0.0
21 |  */
22 | class UnitsController extends Controller
23 | {
24 |     // Properties
25 |     // =========================================================================
26 | 
27 |     /**
28 |      * @inheritdoc
29 |      */
30 |     protected array|bool|int $allowAnonymous = [
31 |         'all-available-units',
32 |         'available-units',
33 |     ];
34 | 
35 |     // Public Methods
36 |     // =========================================================================
37 | 
38 |     /**
39 |      * Return all the available units as JSON
40 |      *
41 |      * @param bool $includeAliases whether to include aliases or not
42 |      *
43 |      * @return Response
44 |      */
45 |     public function actionAllAvailableUnits(bool $includeAliases = false): Response
46 |     {
47 |         return $this->asJson(Units::$variable->allAvailableUnits($includeAliases));
48 |     }
49 | 
50 |     /**
51 |      * Return the available units for a given AbstractPhysicalQuantity as JSON
52 |      *
53 |      * @param string $unitsClass
54 |      * @param bool $includeAliases whether to include aliases or not
55 |      *
56 |      * @return Response
57 |      */
58 |     public function actionAvailableUnits(string $unitsClass, bool $includeAliases = false): Response
59 |     {
60 |         return $this->asJson(Units::$variable->availableUnits($unitsClass, $includeAliases));
61 |     }
62 | }
63 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/nystudio107/craft-units/badges/quality-score.png?b=v5)](https://scrutinizer-ci.com/g/nystudio107/craft-units/?branch=v5) [![Code Coverage](https://scrutinizer-ci.com/g/nystudio107/craft-units/badges/coverage.png?b=v5)](https://scrutinizer-ci.com/g/nystudio107/craft-units/?branch=v5) [![Build Status](https://scrutinizer-ci.com/g/nystudio107/craft-units/badges/build.png?b=v5)](https://scrutinizer-ci.com/g/nystudio107/craft-units/build-status/v5) [![Code Intelligence Status](https://scrutinizer-ci.com/g/nystudio107/craft-units/badges/code-intelligence.svg?b=v5)](https://scrutinizer-ci.com/code-intelligence)
 2 | 
 3 | # Units plugin for Craft CMS 5.x
 4 | 
 5 | Units is a plugin that can convert between any units of measure, and comes with a Field for content authors to use.
 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 the plugin, follow these instructions.
16 | 
17 | 1. Open your terminal and go to your Craft project:
18 | 
19 |         cd /path/to/project
20 | 
21 | 2. Then tell Composer to load the plugin:
22 | 
23 |         composer require nystudio107/craft-units
24 | 
25 | 3. Install the plugin via `./craft install/plugin units` via the CLI, or in the Control Panel, go to Settings → Plugins and click the “Install” button for Units.
26 | 
27 | You can also install Units via the **Plugin Store** in the Craft Control Panel.
28 | 
29 | ## Documentation
30 | 
31 | Click here -> [Units Documentation](https://nystudio107.com/plugins/units/documentation)
32 | 
33 | ## Units Roadmap
34 | 
35 | Some things to do, and ideas for potential features:
36 | 
37 | * Add the ability to control what units appear in the list (because who uses _yottameters_?)
38 | 
39 | Brought to you by [nystudio107](https://nystudio107.com/)
40 | 


--------------------------------------------------------------------------------
/src/assetbundles/unitsfield/dist/img/Units-icon.svg:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="iso-8859-1"?>
 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="412.766px" height="412.767px" viewBox="0 0 412.766 412.767" style="enable-background:new 0 0 412.766 412.767;"
 6 | 	 xml:space="preserve">
 7 | <g>
 8 | 	<path d="M95.373,80.2c0,26.336-21.355,47.683-47.685,47.683c-26.327,0-47.682-21.347-47.682-47.683
 9 | 		c0-26.335,21.355-47.682,47.682-47.682C74.018,32.513,95.373,53.859,95.373,80.2z M47.682,274.588
10 | 		C21.355,274.588,0,295.938,0,322.27c0,26.333,21.355,47.683,47.682,47.683c26.335,0,47.685-21.35,47.685-47.683
11 | 		C95.367,295.938,74.018,274.588,47.682,274.588z M166.769,65.312h231.895c7.784,0,14.103-6.313,14.103-14.104
12 | 		c0-7.79-6.312-14.103-14.103-14.103H166.769c-7.784,0-14.103,6.313-14.103,14.103C152.666,58.999,158.985,65.312,166.769,65.312z
13 | 		 M166.769,134.257h150.426c7.791,0,14.104-6.316,14.104-14.103c0-7.791-6.312-14.103-14.104-14.103H166.769
14 | 		c-7.784,0-14.103,6.307-14.103,14.103C152.666,127.947,158.985,134.257,166.769,134.257z M398.664,283.1H166.769
15 | 		c-7.784,0-14.103,6.312-14.103,14.103s6.319,14.104,14.103,14.104h231.895c7.784,0,14.103-6.313,14.103-14.104
16 | 		S406.448,283.1,398.664,283.1z M317.195,352.043H166.769c-7.784,0-14.103,6.307-14.103,14.103c0,7.79,6.319,14.103,14.103,14.103
17 | 		h150.426c7.791,0,14.104-6.312,14.104-14.103S324.98,352.043,317.195,352.043z"/>
18 | </g>
19 | <g>
20 | </g>
21 | <g>
22 | </g>
23 | <g>
24 | </g>
25 | <g>
26 | </g>
27 | <g>
28 | </g>
29 | <g>
30 | </g>
31 | <g>
32 | </g>
33 | <g>
34 | </g>
35 | <g>
36 | </g>
37 | <g>
38 | </g>
39 | <g>
40 | </g>
41 | <g>
42 | </g>
43 | <g>
44 | </g>
45 | <g>
46 | </g>
47 | <g>
48 | </g>
49 | </svg>
50 | 


--------------------------------------------------------------------------------
/src/assetbundles/units/dist/img/Units-icon.svg:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="iso-8859-1"?>
 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="99.012px" height="99.012px" viewBox="0 0 99.012 99.012" style="enable-background:new 0 0 99.012 99.012;"
 6 | 	 xml:space="preserve">
 7 | <g>
 8 | 	<g>
 9 | 		<path d="M25.08,15.648c-0.478-0.478-1.135-0.742-1.805-0.723c-0.675,0.017-1.314,0.309-1.768,0.808
10 | 			c-14.829,16.325-6.762,51.623-5.916,55.115L0.723,85.717C0.26,86.18,0,86.808,0,87.463c0,0.654,0.26,1.283,0.723,1.746
11 | 			l8.958,8.957c0.482,0.48,1.114,0.723,1.746,0.723c0.631,0,1.264-0.24,1.745-0.723l14.865-14.864
12 | 			c7.237,1.859,16.289,2.968,24.28,2.968c9.599,0,22.739-1.543,30.836-8.886c0.5-0.454,0.793-1.093,0.809-1.769
13 | 			c0.018-0.676-0.245-1.328-0.723-1.805L25.08,15.648z"/>
14 | 		<path d="M46.557,30.345c0.482,0.482,1.114,0.723,1.746,0.723c0.632,0,1.264-0.241,1.746-0.724l18.428-18.428
15 | 			c1.305-1.305,2.023-3.04,2.023-4.885c0-1.846-0.719-3.582-2.023-4.886c-1.305-1.305-3.039-2.022-4.885-2.022
16 | 			c-1.845,0-3.581,0.718-4.887,2.022L40.277,20.574c-0.964,0.964-0.964,2.527,0,3.492L46.557,30.345z"/>
17 | 		<path d="M96.99,30.661c-1.305-1.305-3.039-2.024-4.885-2.024c-1.847,0-3.582,0.718-4.886,2.023L68.79,49.089
18 | 			c-0.464,0.463-0.724,1.091-0.724,1.746s0.26,1.282,0.724,1.746l6.28,6.278c0.481,0.482,1.113,0.724,1.746,0.724
19 | 			c0.631,0,1.264-0.241,1.746-0.724l18.43-18.429C99.686,37.735,99.686,33.353,96.99,30.661z"/>
20 | 	</g>
21 | </g>
22 | <g>
23 | </g>
24 | <g>
25 | </g>
26 | <g>
27 | </g>
28 | <g>
29 | </g>
30 | <g>
31 | </g>
32 | <g>
33 | </g>
34 | <g>
35 | </g>
36 | <g>
37 | </g>
38 | <g>
39 | </g>
40 | <g>
41 | </g>
42 | <g>
43 | </g>
44 | <g>
45 | </g>
46 | <g>
47 | </g>
48 | <g>
49 | </g>
50 | <g>
51 | </g>
52 | </svg>
53 | 


--------------------------------------------------------------------------------
/src/templates/_components/fields/Units_settings.twig:
--------------------------------------------------------------------------------
  1 | {# @var craft \craft\web\twig\variables\CraftVariable #}
  2 | {# @var field \nystudio107\units\fields\Units #}
  3 | {#
  4 | /**
  5 |  * Units plugin for Craft CMS
  6 |  *
  7 |  * Units Field Settings
  8 |  *
  9 |  * @author    nystudio107
 10 |  * @copyright Copyright (c) nystudio107
 11 |  * @link      https://nystudio107.com/
 12 |  * @package   Units
 13 |  * @since     1.0.0
 14 |  */
 15 | #}
 16 | 
 17 | {% import "_includes/forms" as forms %}
 18 | 
 19 | {% do view.registerAssetBundle("nystudio107\\units\\assetbundles\\units\\UnitsAsset") %}
 20 | {% do view.registerAssetBundle("nystudio107\\units\\assetbundles\\unitsfield\\UnitsFieldAsset") %}
 21 | 
 22 | {{ forms.selectField({
 23 |     label: "Measure Type"|t("units"),
 24 |     id: "defaultUnitsClass",
 25 |     name: "defaultUnitsClass",
 26 |     options: unitsClassMap,
 27 |     value: field.defaultUnitsClass,
 28 |     errors: field.getErrors("defaultUnitsClass"),
 29 | }) }}
 30 | 
 31 | {{ forms.textField({
 32 |     label: "Default Value"|t("units"),
 33 |     id: 'defaultValue',
 34 |     name: 'defaultValue',
 35 |     value: field.defaultValue,
 36 |     size: 5,
 37 |     errors: field.getErrors("defaultValue"),
 38 | }) }}
 39 | 
 40 | {{ forms.selectField({
 41 |     label: "Default Units"|t("units"),
 42 |     id: "defaultUnits",
 43 |     name: "defaultUnits",
 44 |     options: craft.units.availableUnits(field.defaultUnitsClass),
 45 |     value: field.defaultUnits,
 46 |     errors: field.getErrors("defaultUnits"),
 47 | }) }}
 48 | 
 49 | {{ forms.lightswitchField({
 50 |     label: "Units Changeable"|t("units"),
 51 |     id: "changeableUnits",
 52 |     name: "changeableUnits",
 53 |     on: field.changeableUnits,
 54 |     errors: field.getErrors("changeableUnits"),
 55 | }) }}
 56 | 
 57 | {{ forms.textField({
 58 |     label: "Min Value"|t('units'),
 59 |     id: 'min',
 60 |     name: 'min',
 61 |     value: field.min,
 62 |     size: 5,
 63 |     errors: field.getErrors('min')
 64 | }) }}
 65 | 
 66 | {{ forms.textField({
 67 |     label: "Max Value"|t('units'),
 68 |     id: 'max',
 69 |     name: 'max',
 70 |     value: field.max,
 71 |     size: 5,
 72 |     errors: field.getErrors('max')
 73 | }) }}
 74 | 
 75 | {{ forms.textField({
 76 |     label: "Decimal Points"|t('units'),
 77 |     id: 'decimals',
 78 |     name: 'decimals',
 79 |     value: field.decimals,
 80 |     size: 1,
 81 |     errors: field.getErrors('decimals')
 82 | }) }}
 83 | 
 84 | {{ forms.textField({
 85 |     label: "Size"|t('units'),
 86 |     id: 'size',
 87 |     name: 'size',
 88 |     value: field.size,
 89 |     size: 2,
 90 |     errors: field.getErrors('size')
 91 | }) }}
 92 | 
 93 | 
 94 | {% js %}
 95 |     // Fill in the dynamic unit menu
 96 |     var defaultUnitsId = '{{ "defaultUnits" |namespaceInputId }}';
 97 |     var defaultUnitsClassId = '{{ "defaultUnitsClass" |namespaceInputId }}';
 98 | 
 99 |     $('#'+defaultUnitsClassId).on('change', function(e) {
100 |     var value = $('#'+defaultUnitsClassId).val();
101 |     fillDynamicUnitsMenu(defaultUnitsId, '{{ field.defaultUnits }}', value);
102 |     });
103 | {% endjs %}
104 | 


--------------------------------------------------------------------------------
/src/models/Settings.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /**
  3 |  * Units plugin for Craft CMS
  4 |  *
  5 |  * A plugin for handling physical quantities and the units of measure in which they're represented.
  6 |  *
  7 |  * @link      https://nystudio107.com/
  8 |  * @copyright Copyright (c) nystudio107
  9 |  */
 10 | 
 11 | namespace nystudio107\units\models;
 12 | 
 13 | use craft\base\Model;
 14 | use PhpUnitsOfMeasure\PhysicalQuantity\Length;
 15 | 
 16 | /**
 17 |  * @author    nystudio107
 18 |  * @package   Units
 19 |  * @since     1.0.0
 20 |  */
 21 | class Settings extends Model
 22 | {
 23 |     // Public Properties
 24 |     // =========================================================================
 25 | 
 26 |     /**
 27 |      * @var string The default fully qualified class name of the unit of measure
 28 |      */
 29 |     public string $defaultUnitsClass = Length::class;
 30 | 
 31 |     /**
 32 |      * @var float The default value of the unit of measure
 33 |      */
 34 |     public float $defaultValue = 0.0;
 35 | 
 36 |     /**
 37 |      * @var string The default units that the unit of measure is in
 38 |      */
 39 |     public string $defaultUnits = 'ft';
 40 | 
 41 |     /**
 42 |      * @var bool Whether the units the field can be changed
 43 |      */
 44 |     public bool $defaultChangeableUnits = true;
 45 | 
 46 |     /**
 47 |      * @var int|float The default minimum allowed number
 48 |      */
 49 |     public int|float $defaultMin = 0;
 50 | 
 51 |     /**
 52 |      * @var int|float|null The default maximum allowed number
 53 |      */
 54 |     public int|null|float $defaultMax = null;
 55 | 
 56 |     /**
 57 |      * @var int The default number of digits allowed after the decimal point
 58 |      */
 59 |     public int $defaultDecimals = 3;
 60 | 
 61 |     /**
 62 |      * @var int|null The default size of the field
 63 |      */
 64 |     public ?int $defaultSize = 6;
 65 | 
 66 |     // Public Methods
 67 |     // =========================================================================
 68 | 
 69 |     /**
 70 |      * @inheritdoc
 71 |      */
 72 |     public function rules(): array
 73 |     {
 74 |         $rules = parent::rules();
 75 |         $rules = array_merge($rules, [
 76 |             ['defaultUnitsClass', 'string'],
 77 |             ['defaultUnitsClass', 'default', 'value' => Length::class],
 78 |             ['defaultValue', 'number'],
 79 |             ['defaultValue', 'default', 'value' => 0.0],
 80 |             ['defaultUnits', 'string'],
 81 |             ['defaultUnits', 'default', 'value' => 'ft'],
 82 |             ['defaultChangeableUnits', 'boolean'],
 83 |             ['defaultChangeableUnits', 'default', 'value' => true],
 84 |             [['defaultMin', 'defaultMax'], 'number'],
 85 |             [
 86 |                 ['defaultMax'],
 87 |                 'compare',
 88 |                 'compareAttribute' => 'defaultMin',
 89 |                 'operator' => '>=',
 90 |             ],
 91 |             ['defaultMin', 'default', 'value' => 0],
 92 |             ['defaultMax', 'default', 'value' => null],
 93 |             [['defaultDecimals', 'defaultSize'], 'integer'],
 94 |             ['defaultDecimals', 'default', 'value' => 3],
 95 |             ['defaultSize', 'default', 'value' => 6],
 96 |         ]);
 97 | 
 98 |         if (!$this->defaultDecimals) {
 99 |             $rules[] = [['defaultMin', 'defaultMax'], 'integer'];
100 |         }
101 | 
102 |         return $rules;
103 |     }
104 | }
105 | 


--------------------------------------------------------------------------------
/src/templates/settings.twig:
--------------------------------------------------------------------------------
  1 | {# @var craft \craft\web\twig\variables\CraftVariable #}
  2 | {#
  3 | /**
  4 |  * Units plugin for Craft CMS
  5 |  *
  6 |  * Units Settings.twig
  7 |  *
  8 |  * @author    nystudio107
  9 |  * @copyright Copyright (c) nystudio107
 10 |  * @link      https://nystudio107.com/
 11 |  * @package   Units
 12 |  * @since     1.0.0
 13 |  */
 14 | #}
 15 | 
 16 | {% import "_includes/forms" as forms %}
 17 | 
 18 | {% do view.registerAssetBundle("nystudio107\\units\\assetbundles\\units\\UnitsAsset") %}
 19 | 
 20 | <div class="readable">
 21 | 
 22 |     <div class="heading">
 23 |         <div class="instructions">
 24 |             <p class="">
 25 |                 {{ "Default settings for newly created Units fields"|t("units") }}
 26 |             </p>
 27 |         </div>
 28 |     </div>
 29 | 
 30 |     {{ forms.selectField({
 31 |         label: "Default Measure Type"|t("units"),
 32 |         id: "defaultUnitsClass",
 33 |         name: "defaultUnitsClass",
 34 |         options: unitsClassMap,
 35 |         value: settings.defaultUnitsClass,
 36 |         errors: settings.getErrors("defaultUnitsClass"),
 37 |     }) }}
 38 | 
 39 |     {{ forms.textField({
 40 |         label: "Default Value"|t("units"),
 41 |         id: 'defaultValue',
 42 |         name: 'defaultValue',
 43 |         value: settings.defaultValue,
 44 |         size: 5,
 45 |         errors: settings.getErrors("defaultValue"),
 46 |     }) }}
 47 | 
 48 |     {{ forms.selectField({
 49 |         label: "Default Units"|t("units"),
 50 |         id: "defaultUnits",
 51 |         name: "defaultUnits",
 52 |         options: craft.units.availableUnits(settings.defaultUnitsClass),
 53 |         value: settings.defaultUnits,
 54 |         errors: settings.getErrors("defaultUnits"),
 55 |     }) }}
 56 | 
 57 |     {{ forms.lightswitchField({
 58 |         label: "Default Units Changeable"|t("units"),
 59 |         id: "defaultChangeableUnits",
 60 |         name: "defaultChangeableUnits",
 61 |         on: settings.defaultChangeableUnits,
 62 |         errors: settings.getErrors("defaultChangeableUnits"),
 63 |     }) }}
 64 | 
 65 |     {{ forms.textField({
 66 |         label: "Default Min Value"|t('units'),
 67 |         id: 'defaultMin',
 68 |         name: 'defaultMin',
 69 |         value: settings.defaultMin,
 70 |         size: 5,
 71 |         errors: settings.getErrors('defaultMin')
 72 |     }) }}
 73 | 
 74 |     {{ forms.textField({
 75 |         label: "Default Max Value"|t('units'),
 76 |         id: 'defaultMax',
 77 |         name: 'defaultMax',
 78 |         value: settings.defaultMax,
 79 |         size: 5,
 80 |         errors: settings.getErrors('defaultMax')
 81 |     }) }}
 82 | 
 83 |     {{ forms.textField({
 84 |         label: "Default Decimal Points"|t('units'),
 85 |         id: 'defaultDecimals',
 86 |         name: 'defaultDecimals',
 87 |         value: settings.defaultDecimals,
 88 |         size: 1,
 89 |         errors: settings.getErrors('defaultDecimals')
 90 |     }) }}
 91 | 
 92 |     {{ forms.textField({
 93 |         label: "Default Size"|t('units'),
 94 |         id: 'defaultSize',
 95 |         name: 'defaultSize',
 96 |         value: settings.defaultSize,
 97 |         size: 2,
 98 |         errors: settings.getErrors('defaultSize')
 99 |     }) }}
100 | 
101 | </div>
102 | 
103 | {% js %}
104 |     // Fill in the dynamic unit menu
105 |     var defaultUnitsId = '{{ "defaultUnits" |namespaceInputId }}';
106 |     var defaultUnitsClassId = '{{ "defaultUnitsClass" |namespaceInputId }}';
107 | 
108 |     $('#'+defaultUnitsClassId).on('change', function(e) {
109 |     var value = $('#'+defaultUnitsClassId).val();
110 |     fillDynamicUnitsMenu(defaultUnitsId, '{{ settings.defaultUnits }}', value);
111 |     });
112 | {% endjs %}
113 | 


--------------------------------------------------------------------------------
/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_icon16_x5F_twigProfiler"
 5 | 	 xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px" width="250px" height="250px"
 6 | 	 viewBox="0 0 250 250" enable-background="new 0 0 250 250" xml:space="preserve">
 7 | <g id="gr_x5F_big_40_">
 8 | 	<path id="gr_230_" fill="#F3BA48" d="M237.665,172.702c0,9.539-6.756,21.251-15.021,26.019l-82.621,47.702
 9 | 		c-8.263,4.771-21.781,4.771-30.044,0l-82.625-47.702c-8.262-4.768-15.021-16.479-15.021-26.019V77.301
10 | 		c0-9.542,6.759-21.254,15.021-26.019l82.625-47.706c8.263-4.771,21.781-4.771,30.044,0l82.621,47.706
11 | 		c8.266,4.764,15.021,16.476,15.021,26.019V172.702z"/>
12 | 	<path fill="#FFFFFF" d="M189.168,111.146l-20.09-34.793c-3.94-6.836-12.681-9.173-19.51-5.228l-83.511,48.215
13 | 		c-6.836,3.944-9.173,12.682-5.231,19.514l20.089,34.798c3.948,6.832,12.682,9.172,19.518,5.228l83.511-48.211
14 | 		C190.772,126.716,193.116,117.982,189.168,111.146z M110.017,104.409l2.225-1.285c0.238-0.138,0.545-0.055,0.683,0.183
15 | 		l6.643,11.501c0.138,0.238,0.055,0.546-0.183,0.683l-2.224,1.286c-0.238,0.137-0.545,0.055-0.683-0.183l-6.644-11.502
16 | 		C109.696,104.854,109.779,104.546,110.017,104.409z M77.058,123.438l2.224-1.285c0.238-0.137,0.545-0.055,0.683,0.183l6.643,11.502
17 | 		c0.138,0.237,0.055,0.545-0.183,0.683l-2.224,1.286c-0.238,0.138-0.545,0.055-0.683-0.183l-6.643-11.503
18 | 		C76.737,123.883,76.82,123.575,77.058,123.438z M87.576,150.355l-5.314,3.071c-0.238,0.138-0.545,0.055-0.683-0.183l-13.786-23.877
19 | 		c-0.138-0.237-0.055-0.545,0.183-0.683l5.314-3.072c0.238-0.137,0.545-0.055,0.683,0.183l13.786,23.877
20 | 		C87.897,149.91,87.814,150.218,87.576,150.355z M92.424,131.061l-2.231,1.286c-0.238,0.138-0.545,0.056-0.683-0.183l-6.643-11.503
21 | 		c-0.138-0.238-0.055-0.545,0.183-0.683l2.231-1.286c0.238-0.137,0.545-0.055,0.683,0.184l6.643,11.502
22 | 		C92.745,130.615,92.662,130.923,92.424,131.061z M98.416,127.601l-2.231,1.286c-0.238,0.138-0.545,0.055-0.683-0.183l-6.643-11.502
23 | 		c-0.138-0.238-0.055-0.545,0.183-0.683l2.231-1.286c0.238-0.138,0.545-0.055,0.683,0.183l6.643,11.502
24 | 		C98.737,127.155,98.654,127.463,98.416,127.601z M104.408,124.141l-2.23,1.286c-0.238,0.137-0.545,0.055-0.683-0.184l-6.643-11.501
25 | 		c-0.138-0.238-0.055-0.545,0.183-0.683l2.231-1.286c0.238-0.138,0.545-0.055,0.683,0.183l6.643,11.502
26 | 		C104.729,123.696,104.646,124.003,104.408,124.141z M120.633,131.271l-5.321,3.071c-0.238,0.138-0.545,0.055-0.683-0.183
27 | 		l-13.786-23.877c-0.138-0.238-0.055-0.545,0.183-0.683l5.321-3.071c0.238-0.138,0.545-0.055,0.683,0.183l13.786,23.877
28 | 		C120.954,130.825,120.872,131.133,120.633,131.271z M125.383,112.031l-2.23,1.286c-0.238,0.138-0.545,0.055-0.683-0.183
29 | 		l-6.644-11.501c-0.138-0.238-0.055-0.545,0.183-0.683l2.231-1.287c0.238-0.137,0.545-0.055,0.683,0.184l6.643,11.501
30 | 		C125.704,111.586,125.622,111.893,125.383,112.031z M131.375,108.57l-2.23,1.287c-0.238,0.137-0.546,0.055-0.684-0.184
31 | 		l-6.643-11.501c-0.138-0.238-0.055-0.545,0.183-0.683l2.23-1.286c0.238-0.138,0.545-0.055,0.683,0.183l6.644,11.501
32 | 		C131.696,108.126,131.613,108.433,131.375,108.57z M137.366,105.111l-2.229,1.286c-0.238,0.137-0.546,0.055-0.684-0.184
33 | 		l-6.643-11.501c-0.138-0.238-0.055-0.545,0.184-0.683l2.229-1.286c0.238-0.138,0.546-0.055,0.684,0.183l6.643,11.502
34 | 		C137.688,104.667,137.604,104.974,137.366,105.111z M153.593,112.241l-5.322,3.071c-0.237,0.138-0.545,0.055-0.683-0.183
35 | 		l-13.786-23.876c-0.138-0.238-0.055-0.545,0.183-0.683l5.322-3.071c0.237-0.138,0.545-0.055,0.683,0.183l13.786,23.876
36 | 		C153.913,111.796,153.83,112.103,153.593,112.241z M168.514,109.13c-3.411,1.974-7.785,0.802-9.752-2.616
37 | 		c-1.974-3.418-0.802-7.78,2.616-9.751c3.41-1.975,7.777-0.806,9.751,2.612C173.104,102.79,171.932,107.16,168.514,109.13z"/>
38 | </g>
39 | </svg>
40 | 


--------------------------------------------------------------------------------
/src/validators/EmbeddedUnitsDataValidator.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /**
  3 |  * Units plugin for Craft CMS
  4 |  *
  5 |  * A plugin for handling physical quantities and the units of measure in which
  6 |  * they're represented.
  7 |  *
  8 |  * @link      https://nystudio107.com/
  9 |  * @copyright Copyright (c) nystudio107
 10 |  */
 11 | 
 12 | namespace nystudio107\units\validators;
 13 | 
 14 | use Craft;
 15 | use nystudio107\units\models\UnitsData;
 16 | use yii\base\Model;
 17 | use yii\validators\NumberValidator;
 18 | use yii\validators\Validator;
 19 | use function is_object;
 20 | 
 21 | /**
 22 |  * @author    nystudio107
 23 |  * @package   Units
 24 |  * @since     1.0.0
 25 |  */
 26 | class EmbeddedUnitsDataValidator extends Validator
 27 | {
 28 |     // Public Properties
 29 |     // =========================================================================
 30 | 
 31 |     /**
 32 |      * @var string the base units
 33 |      */
 34 |     public $units;
 35 | 
 36 |     /**
 37 |      * @var bool whether the attribute value can only be an integer. Defaults
 38 |      *      to false.
 39 |      */
 40 |     public $integerOnly = false;
 41 |     /**
 42 |      * @var int|float|null upper limit of the number. Defaults to null, meaning no
 43 |      *      upper limit.
 44 |      * @see tooBig for the customized message used when the number is too big.
 45 |      */
 46 |     public $max = null;
 47 |     /**
 48 |      * @var int|float|null lower limit of the number. Defaults to null, meaning no
 49 |      *      lower limit.
 50 |      * @see tooSmall for the customized message used when the number is too
 51 |      *      small.
 52 |      */
 53 |     public $min = null;
 54 | 
 55 |     // Public Methods
 56 |     // =========================================================================
 57 | 
 58 |     /**
 59 |      * @inheritdoc
 60 |      */
 61 |     public function validateAttribute($model, $attribute)
 62 |     {
 63 |         /** @var Model $model */
 64 |         $value = $model->$attribute;
 65 | 
 66 |         if ($value !== null && is_object($value) && $value instanceof UnitsData) {
 67 |             // Validate the model
 68 |             $value->validate();
 69 |             // Normalize the min/max value
 70 |             $this->normalizeMinMax($value);
 71 |             // Do a min/max validation, too
 72 |             $config = [
 73 |                 'integerOnly' => $this->integerOnly,
 74 |                 'min' => $this->min,
 75 |                 'max' => $this->max,
 76 |             ];
 77 |             $numberValidator = new NumberValidator($config);
 78 |             $numberValidator->validateAttribute($value, 'value');
 79 |             // Add any errors to the parent model
 80 |             $errors = $value->getErrors();
 81 |             foreach ($errors as $attributeError => $valueErrors) {
 82 |                 /** @var array $valueErrors */
 83 |                 foreach ($valueErrors as $valueError) {
 84 |                     $model->addError(
 85 |                         $attribute,
 86 |                         $valueError
 87 |                     );
 88 |                 }
 89 |             }
 90 |         } else {
 91 |             $model->addError($attribute, Craft::t('units', 'Is not a Model object.'));
 92 |         }
 93 |     }
 94 | 
 95 |     // Protected Methods
 96 |     // =========================================================================
 97 | 
 98 |     /**
 99 |      * Normalize the min/max values using the base units
100 |      *
101 |      * @param UnitsData $unitsData
102 |      */
103 |     protected function normalizeMinMax(UnitsData $unitsData)
104 |     {
105 |         $config = [
106 |             'unitsClass' => $unitsData->unitsClass,
107 |             'units' => $this->units,
108 |         ];
109 |         // Normalize the min
110 |         if (!empty($this->min)) {
111 |             $config['value'] = (float)$this->min;
112 |             $baseUnit = new UnitsData($config);
113 |             $this->min = $baseUnit->toUnit($unitsData->units);
114 |         } else {
115 |             $this->min = null;
116 |         }
117 |         // Normalize the max
118 |         if (!empty($this->max)) {
119 |             $config['value'] = (float)$this->max;
120 |             $baseUnit = new UnitsData($config);
121 |             $this->max = $baseUnit->toUnit($unitsData->units);
122 |         } else {
123 |             $this->max = null;
124 |         }
125 |     }
126 | }
127 | 


--------------------------------------------------------------------------------
/src/Units.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /**
  3 |  * Units plugin for Craft CMS
  4 |  *
  5 |  * A plugin for handling physical quantities and the units of measure in which they're represented.
  6 |  *
  7 |  * @link      https://nystudio107.com/
  8 |  * @copyright Copyright (c) nystudio107
  9 |  */
 10 | 
 11 | namespace nystudio107\units;
 12 | 
 13 | use Craft;
 14 | use craft\base\Model;
 15 | use craft\base\Plugin;
 16 | use craft\events\RegisterComponentTypesEvent;
 17 | use craft\services\Fields;
 18 | use craft\web\twig\variables\CraftVariable;
 19 | use nystudio107\units\fields\Units as UnitsField;
 20 | use nystudio107\units\helpers\ClassHelper;
 21 | use nystudio107\units\models\Settings;
 22 | use nystudio107\units\variables\UnitsVariable;
 23 | use PhpUnitsOfMeasure\PhysicalQuantity\Length;
 24 | use yii\base\Event;
 25 | 
 26 | /**
 27 |  * Class Units
 28 |  *
 29 |  * @author    nystudio107
 30 |  * @package   Units
 31 |  * @since     1.0.0
 32 |  */
 33 | class Units extends Plugin
 34 | {
 35 |     // Static Properties
 36 |     // =========================================================================
 37 | 
 38 |     /**
 39 |      * @var Units
 40 |      */
 41 |     public static $plugin;
 42 | 
 43 |     /**
 44 |      * @var UnitsVariable
 45 |      */
 46 |     public static $variable;
 47 | 
 48 |     // Public Properties
 49 |     // =========================================================================
 50 | 
 51 |     /**
 52 |      * @var string
 53 |      */
 54 |     public string $schemaVersion = '1.0.0';
 55 | 
 56 |     /**
 57 |      * @var bool
 58 |      */
 59 |     public bool $hasCpSettings = true;
 60 |     /**
 61 |      * @var bool
 62 |      */
 63 |     public bool $hasCpSection = false;
 64 | 
 65 |     // Public Methods
 66 |     // =========================================================================
 67 | 
 68 |     /**
 69 |      * @inheritdoc
 70 |      */
 71 |     public function init(): void
 72 |     {
 73 |         parent::init();
 74 |         self::$plugin = $this;
 75 | 
 76 |         Event::on(
 77 |             Fields::class,
 78 |             Fields::EVENT_REGISTER_FIELD_TYPES,
 79 |             static function(RegisterComponentTypesEvent $event) {
 80 |                 $event->types[] = UnitsField::class;
 81 |             }
 82 |         );
 83 | 
 84 |         self::$variable = new UnitsVariable();
 85 |         Event::on(
 86 |             CraftVariable::class,
 87 |             CraftVariable::EVENT_INIT,
 88 |             static function(Event $event) {
 89 |                 /** @var CraftVariable $variable */
 90 |                 $variable = $event->sender;
 91 |                 $variable->set('units', self::$variable);
 92 |             }
 93 |         );
 94 | 
 95 |         Event::on(
 96 |             UnitsField::class,
 97 |             'craftQlGetFieldSchema',
 98 |             static function($event) {
 99 |                 $field = $event->sender;
100 | 
101 |                 if (!$field instanceof UnitsField) {
102 |                     return;
103 |                 }
104 | 
105 |                 $object = $event->schema->createObjectType(ucfirst($field->handle) . 'Units');
106 |                 $object->addFloatField('value');
107 |                 $object->addStringField('units');
108 | 
109 |                 $event->schema->addField($field)->type($object);
110 |                 $event->handled = true;
111 |             }
112 |         );
113 | 
114 |         Craft::info(
115 |             Craft::t(
116 |                 'units',
117 |                 '{name} plugin loaded',
118 |                 ['name' => $this->name]
119 |             ),
120 |             __METHOD__
121 |         );
122 |     }
123 | 
124 |     // Protected Methods
125 |     // =========================================================================
126 | 
127 |     /**
128 |      * @inheritdoc
129 |      */
130 |     protected function createSettingsModel(): ?Model
131 |     {
132 |         return new Settings();
133 |     }
134 | 
135 |     /**
136 |      * @inheritdoc
137 |      */
138 |     protected function settingsHtml(): ?string
139 |     {
140 |         $unitsClassMap = array_flip(ClassHelper::getClassesInNamespace(Length::class));
141 |         return Craft::$app->view->renderTemplate(
142 |             'units/settings',
143 |             [
144 |                 'settings' => $this->getSettings(),
145 |                 'unitsClassMap' => $unitsClassMap,
146 |             ]
147 |         );
148 |     }
149 | }
150 | 


--------------------------------------------------------------------------------
/src/gql/types/generators/UnitsDataGenerator.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /**
  3 |  * Units plugin for Craft CMS
  4 |  *
  5 |  * A plugin for handling physical quantities and the units of measure in which they're represented.
  6 |  *
  7 |  * @link      https://nystudio107.com/
  8 |  * @copyright Copyright (c) nystudio107
  9 |  */
 10 | 
 11 | namespace nystudio107\units\gql\types\generators;
 12 | 
 13 | use craft\gql\base\GeneratorInterface;
 14 | use craft\gql\GqlEntityRegistry;
 15 | use craft\gql\TypeLoader;
 16 | use GraphQL\Type\Definition\Type;
 17 | use nystudio107\units\fields\Units;
 18 | use nystudio107\units\gql\types\UnitsDataType;
 19 | 
 20 | /**
 21 |  * @author    nystudio107
 22 |  * @package   CodeField
 23 |  * @since     5.0.0
 24 |  */
 25 | class UnitsDataGenerator implements GeneratorInterface
 26 | {
 27 |     // Public Static methods
 28 |     // =========================================================================
 29 | 
 30 |     /**
 31 |      * @inheritdoc
 32 |      */
 33 |     public static function generateTypes($context = null): array
 34 |     {
 35 |         /** @var Units $context */
 36 |         $typeName = self::getName($context);
 37 | 
 38 |         $unitsDataFields = [
 39 |             // static fields
 40 |             'toString' => [
 41 |                 'name' => 'toString',
 42 |                 'description' => 'The unit value & label',
 43 |                 'type' => Type::string(),
 44 |             ],
 45 |             'units' => [
 46 |                 'name' => 'units',
 47 |                 'description' => 'The units of measurement',
 48 |                 'type' => Type::string(),
 49 |             ],
 50 |             'value' => [
 51 |                 'name' => 'value',
 52 |                 'description' => 'The unit value',
 53 |                 'type' => Type::string(),
 54 |             ],
 55 |             'toUnit' => [
 56 |                 'name' => 'toUnit',
 57 |                 'description' => 'Convert to another unit of measurement',
 58 |                 'type' => Type::string(),
 59 |                 'args' => [
 60 |                     'unit' => [
 61 |                         'name' => 'unit',
 62 |                         'description' => 'The unit to convert to',
 63 |                         'type' => Type::nonNull(Type::string()),
 64 |                     ],
 65 |                 ],
 66 |             ],
 67 |             'toNativeUnit' => [
 68 |                 'name' => 'toNativeUnit',
 69 |                 'description' => 'The unit value as a fraction',
 70 |                 'type' => Type::string(),
 71 |             ],
 72 |             'toFraction' => [
 73 |                 'name' => 'toFraction',
 74 |                 'description' => 'The unit value as a fraction',
 75 |                 'type' => Type::string(),
 76 |             ],
 77 |             'toUnitFraction' => [
 78 |                 'name' => 'toUnitFraction',
 79 |                 'description' => 'Convert to another unit of measurement as a fraction',
 80 |                 'type' => Type::string(),
 81 |                 'args' => [
 82 |                     'unit' => [
 83 |                         'name' => 'unit',
 84 |                         'description' => 'The unit to convert to',
 85 |                         'type' => Type::nonNull(Type::string()),
 86 |                     ],
 87 |                 ],
 88 |             ],
 89 |             'getValueFraction' => [
 90 |                 'name' => 'getValueFraction',
 91 |                 'description' => 'Return the value as a fraction',
 92 |                 'type' => Type::string(),
 93 |             ],
 94 |         ];
 95 |         $unitsDataType = GqlEntityRegistry::getEntity($typeName)
 96 |             ?: GqlEntityRegistry::createEntity($typeName, new UnitsDataType([
 97 |                 'name' => $typeName,
 98 |                 'description' => 'This entity has all the UnitsData properties',
 99 |                 'fields' => function() use ($unitsDataFields) {
100 |                     return $unitsDataFields;
101 |                 },
102 |             ]));
103 | 
104 |         TypeLoader::registerType($typeName, static function() use ($unitsDataType) {
105 |             return $unitsDataType;
106 |         });
107 | 
108 |         return [$unitsDataType];
109 |     }
110 | 
111 |     /**
112 |      * @inheritdoc
113 |      */
114 |     public static function getName($context = null): string
115 |     {
116 |         /** @var Units $context */
117 |         return $context->handle . '_UnitsData';
118 |     }
119 | }
120 | 


--------------------------------------------------------------------------------
/src/helpers/ClassMapGenerator.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /*
  3 |  * This file is part of the Symfony package.
  4 |  *
  5 |  * (c) Fabien Potencier <fabien@symfony.com>
  6 |  *
  7 |  * For the full copyright and license information, please view the LICENSE
  8 |  * file that was distributed with this source code.
  9 |  */
 10 | 
 11 | namespace nystudio107\units\helpers;
 12 | 
 13 | /**
 14 |  * ClassMapGenerator.
 15 |  *
 16 |  * @author Gyula Sallai <salla016@gmail.com>
 17 |  */
 18 | class ClassMapGenerator
 19 | {
 20 |     /**
 21 |      * Generate a class map file.
 22 |      *
 23 |      * @param array|string $dirs Directories or a single path to search in
 24 |      * @param string $file The name of the class map file
 25 |      */
 26 |     public static function dump($dirs, $file)
 27 |     {
 28 |         $dirs = (array)$dirs;
 29 |         $maps = [];
 30 |         foreach ($dirs as $dir) {
 31 |             $maps = array_merge($maps, static::createMap($dir));
 32 |         }
 33 |         file_put_contents($file, sprintf('<?php return %s;', var_export($maps, true)));
 34 |     }
 35 | 
 36 |     /**
 37 |      * Iterate over all files in the given directory searching for classes.
 38 |      *
 39 |      * @param \Iterator|string $dir The directory to search in or an iterator
 40 |      *
 41 |      * @return array A class map array
 42 |      */
 43 |     public static function createMap($dir): array
 44 |     {
 45 |         if (\is_string($dir)) {
 46 |             $dir = new \RecursiveIteratorIterator(new \RecursiveDirectoryIterator($dir));
 47 |         }
 48 |         $map = [];
 49 |         /** @var \Iterator $dir */
 50 |         foreach ($dir as $file) {
 51 |             if (!$file->isFile()) {
 52 |                 continue;
 53 |             }
 54 |             $path = $file->getRealPath() ?: $file->getPathname();
 55 |             if ('php' !== pathinfo($path, PATHINFO_EXTENSION)) {
 56 |                 continue;
 57 |             }
 58 |             $classes = self::findClasses($path);
 59 |             if (\PHP_VERSION_ID >= 70000) {
 60 |                 // PHP 7 memory manager will not release after token_get_all(), see https://bugs.php.net/70098
 61 |                 gc_mem_caches();
 62 |             }
 63 |             foreach ($classes as $class) {
 64 |                 $map[$class] = $path;
 65 |             }
 66 |         }
 67 | 
 68 |         return $map;
 69 |     }
 70 | 
 71 |     /**
 72 |      * Extract the classes in the given file.
 73 |      *
 74 |      * @param string $path The file to check
 75 |      *
 76 |      * @return array The found classes
 77 |      */
 78 |     private static function findClasses($path): array
 79 |     {
 80 |         $contents = file_get_contents($path);
 81 |         $tokens = token_get_all($contents);
 82 |         $classes = [];
 83 |         $namespace = '';
 84 |         for ($i = 0; isset($tokens[$i]); ++$i) {
 85 |             $token = $tokens[$i];
 86 |             if (!isset($token[1])) {
 87 |                 continue;
 88 |             }
 89 |             $class = '';
 90 |             switch ($token[0]) {
 91 |                 case T_NAMESPACE:
 92 |                     $namespace = '';
 93 |                     // If there is a namespace, extract it
 94 |                     while (isset($tokens[++$i][1])) {
 95 |                         if (PHP_MAJOR_VERSION >= 8) {
 96 |                             if (\in_array($tokens[$i][0], [T_NAME_QUALIFIED], false)) {
 97 |                                 $namespace .= $tokens[$i][1];
 98 |                             }
 99 |                         } else {
100 |                             if (\in_array($tokens[$i][0], [T_STRING, T_NS_SEPARATOR], false)) {
101 |                                 $namespace .= $tokens[$i][1];
102 |                             }
103 |                         }
104 |                     }
105 |                     $namespace .= '\\';
106 |                     break;
107 |                 case T_CLASS:
108 |                 case T_INTERFACE:
109 |                 case T_TRAIT:
110 |                     // Skip usage of ::class constant
111 |                     $isClassConstant = false;
112 |                     for ($j = $i - 1; $j > 0; --$j) {
113 |                         if (!isset($tokens[$j][1])) {
114 |                             break;
115 |                         }
116 |                         if (T_DOUBLE_COLON === $tokens[$j][0]) {
117 |                             $isClassConstant = true;
118 |                             break;
119 |                         } elseif (!\in_array($tokens[$j][0], [T_WHITESPACE, T_DOC_COMMENT, T_COMMENT], false)) {
120 |                             break;
121 |                         }
122 |                     }
123 |                     if ($isClassConstant) {
124 |                         break;
125 |                     }
126 |                     // Find the classname
127 |                     while (isset($tokens[++$i][1])) {
128 |                         $t = $tokens[$i];
129 |                         if (T_STRING === $t[0]) {
130 |                             $class .= $t[1];
131 |                         } elseif ('' !== $class && T_WHITESPACE === $t[0]) {
132 |                             break;
133 |                         }
134 |                     }
135 |                     $classes[] = ltrim($namespace . $class, '\\');
136 |                     break;
137 |                 default:
138 |                     break;
139 |             }
140 |         }
141 | 
142 |         return $classes;
143 |     }
144 | }
145 | 


--------------------------------------------------------------------------------
/src/variables/UnitsVariable.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /**
  3 |  * Units plugin for Craft CMS
  4 |  *
  5 |  * A plugin for handling physical quantities and the units of measure in which they're represented.
  6 |  *
  7 |  * @link      https://nystudio107.com/
  8 |  * @copyright Copyright (c) nystudio107
  9 |  */
 10 | 
 11 | namespace nystudio107\units\variables;
 12 | 
 13 | use nystudio107\units\helpers\ClassHelper;
 14 | use nystudio107\units\models\UnitsData;
 15 | use PhpUnitsOfMeasure\AbstractPhysicalQuantity;
 16 | use PhpUnitsOfMeasure\PhysicalQuantity\Acceleration;
 17 | use PhpUnitsOfMeasure\PhysicalQuantity\Angle;
 18 | use PhpUnitsOfMeasure\PhysicalQuantity\Area;
 19 | use PhpUnitsOfMeasure\PhysicalQuantity\ElectricCurrent;
 20 | use PhpUnitsOfMeasure\PhysicalQuantity\Energy;
 21 | use PhpUnitsOfMeasure\PhysicalQuantity\Length;
 22 | use PhpUnitsOfMeasure\PhysicalQuantity\LuminousIntensity;
 23 | use PhpUnitsOfMeasure\PhysicalQuantity\Mass;
 24 | use PhpUnitsOfMeasure\PhysicalQuantity\Pressure;
 25 | use PhpUnitsOfMeasure\PhysicalQuantity\Quantity;
 26 | use PhpUnitsOfMeasure\PhysicalQuantity\SolidAngle;
 27 | use PhpUnitsOfMeasure\PhysicalQuantity\Temperature;
 28 | use PhpUnitsOfMeasure\PhysicalQuantity\Time;
 29 | use PhpUnitsOfMeasure\PhysicalQuantity\Velocity;
 30 | use PhpUnitsOfMeasure\PhysicalQuantity\Volume;
 31 | use PhpUnitsOfMeasure\UnitOfMeasure;
 32 | use yii\base\InvalidArgumentException;
 33 | 
 34 | /**
 35 |  * @author    nystudio107
 36 |  * @package   Units
 37 |  * @since     1.0.0
 38 |  *
 39 |  * @method Acceleration acceleration($value, string $units)
 40 |  * @method Angle angle($value, string $units)
 41 |  * @method Area area($value, string $units)
 42 |  * @method ElectricCurrent electricCurrent($value, string $units)
 43 |  * @method Energy energy($value, string $units)
 44 |  * @method Length length($value, string $units)
 45 |  * @method LuminousIntensity luminousIntensity($value, string $units)
 46 |  * @method Mass mass($value, string $units)
 47 |  * @method Pressure pressure($value, string $units)
 48 |  * @method Quantity quantity($value, string $units)
 49 |  * @method SolidAngle solidAngle($value, string $units)
 50 |  * @method Temperature temperature($value, string $units)
 51 |  * @method Time time($value, string $units)
 52 |  * @method Velocity velocity($value, string $units)
 53 |  * @method Volume volume($value, string $units)
 54 |  */
 55 | class UnitsVariable
 56 | {
 57 |     // Public Properties
 58 |     // =========================================================================
 59 | 
 60 |     /**
 61 |      * @var array
 62 |      */
 63 |     public array $unitsClassMap = [];
 64 | 
 65 |     // Public Methods
 66 |     // =========================================================================
 67 | 
 68 |     /**
 69 |      * If the passed in class exists in PhpUnitsOfMeasure\PhysicalQuantity
 70 |      * return a new instance of the unit of measure
 71 |      *
 72 |      * @param $method
 73 |      * @param $args
 74 |      *
 75 |      * @return UnitsData
 76 |      * @throws InvalidArgumentException
 77 |      */
 78 |     public function __call($method, $args): UnitsData
 79 |     {
 80 |         if (empty($this->unitsClassMap)) {
 81 |             $this->unitsClassMap = ClassHelper::getClassesInNamespace(Length::class);
 82 |         }
 83 |         $unitsClassKey = ucfirst($method);
 84 |         if (isset($this->unitsClassMap[$unitsClassKey])) {
 85 |             [$value, $units] = $args;
 86 |             $config = [
 87 |                 'unitsClass' => $this->unitsClassMap[$unitsClassKey],
 88 |                 'value' => $value,
 89 |                 'units' => $units,
 90 |             ];
 91 | 
 92 |             return new UnitsData($config);
 93 |         }
 94 | 
 95 |         throw new InvalidArgumentException("Method {$method} doesn't exist");
 96 |     }
 97 | 
 98 |     /**
 99 |      * Outputs a floating point number as a fraction
100 |      *
101 |      * @param float $value
102 |      *
103 |      * @return string
104 |      */
105 |     public function fraction(float $value): string
106 |     {
107 |         [$whole, $decimal] = $this->float2parts($value);
108 | 
109 |         return $whole . ' ' . $this->float2ratio($decimal);
110 |     }
111 | 
112 |     /**
113 |      * Convert a floating point number to the whole and the decimal
114 |      *
115 |      * @param float $number
116 |      * @param bool $returnUnsigned
117 |      *
118 |      * @return array
119 |      */
120 |     public function float2parts(float $number, bool $returnUnsigned = false): array
121 |     {
122 |         $negative = 1;
123 |         if ($number < 0) {
124 |             $negative = -1;
125 |             $number *= -1;
126 |         }
127 | 
128 |         if ($returnUnsigned) {
129 |             return [
130 |                 floor($number),
131 |                 $number - floor($number),
132 |             ];
133 |         }
134 | 
135 |         return [
136 |             floor($number) * $negative,
137 |             ($number - floor($number)) * $negative,
138 |         ];
139 |     }
140 | 
141 |     /**
142 |      * Convert a floating point number to a ratio
143 |      *
144 |      * @param float $n
145 |      * @param float $tolerance
146 |      *
147 |      * @return string
148 |      */
149 |     public function float2ratio(float $n, float $tolerance = 1.e-6): string
150 |     {
151 |         if ($n === 0.0) {
152 |             return '';
153 |         }
154 |         $h1 = 1;
155 |         $h2 = 0;
156 |         $k1 = 0;
157 |         $k2 = 1;
158 |         $b = 1 / $n;
159 |         do {
160 |             $b = 1 / $b;
161 |             $a = floor($b);
162 |             $aux = $h1;
163 |             $h1 = $a * $h1 + $h2;
164 |             $h2 = $aux;
165 |             $aux = $k1;
166 |             $k1 = $a * $k1 + $k2;
167 |             $k2 = $aux;
168 |             $b -= $a;
169 |         } while (abs($n - $h1 / $k1) > $n * $tolerance);
170 | 
171 |         return "$h1/$k1";
172 |     }
173 | 
174 |     /**
175 |      * Return all of the available units
176 |      *
177 |      * @param bool $includeAliases whether to include aliases or not
178 |      *
179 |      * @return array
180 |      */
181 |     public function allAvailableUnits(bool $includeAliases = false): array
182 |     {
183 |         $unitsList = [];
184 |         $units = ClassHelper::getClassesInNamespace(Length::class);
185 |         foreach ($units as $key => $value) {
186 |             /** @var AbstractPhysicalQuantity $value */
187 |             $unitsList[$key] = $this->availableUnits($value, $includeAliases);
188 |         }
189 |         ksort($unitsList);
190 | 
191 |         return $unitsList;
192 |     }
193 | 
194 |     /**
195 |      * Return the available units for a given AbstractPhysicalQuantity
196 |      *
197 |      * @param string $unitsClass
198 |      * @param bool $includeAliases whether to include aliases or not
199 |      *
200 |      * @return array
201 |      */
202 |     public function availableUnits(string $unitsClass, bool $includeAliases = false): array
203 |     {
204 |         $availableUnits = [];
205 |         if (is_subclass_of($unitsClass, AbstractPhysicalQuantity::class)) {
206 |             /** @var array $units */
207 |             /** @var AbstractPhysicalQuantity $unitsClass */
208 |             $units = $unitsClass::getUnitDefinitions();
209 |             /** @var UnitOfMeasure $unit */
210 |             foreach ($units as $unit) {
211 |                 $name = $unit->getName();
212 |                 $aliases = $unit->getAliases();
213 |                 $availableUnits[$name] = $includeAliases ? $aliases : $aliases[0] ?? $name;
214 |             }
215 |         }
216 | 
217 |         return $availableUnits;
218 |     }
219 | }
220 | 


--------------------------------------------------------------------------------
/src/models/UnitsData.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /**
  3 |  * Units plugin for Craft CMS
  4 |  *
  5 |  * A plugin for handling physical quantities and the units of measure in which
  6 |  * they're represented.
  7 |  *
  8 |  * @link      https://nystudio107.com/
  9 |  * @copyright Copyright (c) nystudio107
 10 |  */
 11 | 
 12 | namespace nystudio107\units\models;
 13 | 
 14 | use craft\base\Model;
 15 | use nystudio107\units\Units;
 16 | use PhpUnitsOfMeasure\AbstractPhysicalQuantity;
 17 | use PhpUnitsOfMeasure\Exception\NonNumericValue;
 18 | use PhpUnitsOfMeasure\Exception\NonStringUnitName;
 19 | use PhpUnitsOfMeasure\PhysicalQuantityInterface;
 20 | use PhpUnitsOfMeasure\UnitOfMeasure;
 21 | use PhpUnitsOfMeasure\UnitOfMeasureInterface;
 22 | use yii\base\InvalidArgumentException;
 23 | use function call_user_func_array;
 24 | use function get_class;
 25 | 
 26 | /**
 27 |  * @author    nystudio107
 28 |  * @package   Units
 29 |  * @since     1.0.0
 30 |  *
 31 |  * @property string $valueFraction
 32 |  * @property array|float[] $valueParts
 33 |  * @property array|string[] $valuePartsFraction
 34 |  */
 35 | class UnitsData extends Model implements PhysicalQuantityInterface
 36 | {
 37 |     // Public Properties
 38 |     // =========================================================================
 39 | 
 40 |     /**
 41 |      * @var ?string The fully qualified class name of the unit of measure
 42 |      */
 43 |     public ?string $unitsClass = null;
 44 | 
 45 |     /**
 46 |      * @var ?float The value of the unit of measure
 47 |      */
 48 |     public ?float $value = null;
 49 | 
 50 |     /**
 51 |      * @var ?string The units that the unit of measure is in
 52 |      */
 53 |     public ?string $units = null;
 54 | 
 55 |     /**
 56 |      * @var AbstractPhysicalQuantity
 57 |      */
 58 |     public AbstractPhysicalQuantity $unitsInstance;
 59 | 
 60 |     // Public Methods
 61 |     // =========================================================================
 62 | 
 63 |     /**
 64 |      * Call through to the appropriate method in the AbstractPhysicalQuantity
 65 |      * class in $unitsInstance, if it exists
 66 |      *
 67 |      * @param string $method
 68 |      * @param array $args
 69 |      *
 70 |      * @return mixed
 71 |      * @throws InvalidArgumentException
 72 |      * @throws NonNumericValue
 73 |      * @throws NonStringUnitName
 74 |      */
 75 |     public function __call($method, $args)
 76 |     {
 77 |         $unitsInstance = $this->unitsInstance;
 78 |         if (method_exists($unitsInstance, $method)) {
 79 |             return call_user_func_array([$unitsInstance, $method], $args);
 80 |         }
 81 | 
 82 |         throw new InvalidArgumentException("Method {$method} doesn't exist");
 83 |     }
 84 | 
 85 |     /**
 86 |      * @inheritdoc
 87 |      */
 88 |     public function init(): void
 89 |     {
 90 |         parent::init();
 91 |         /** @var Settings $settings */
 92 |         $settings = Units::$plugin->getSettings();
 93 |         $this->unitsClass = $this->unitsClass ?? $settings->defaultUnitsClass;
 94 |         $this->value = $this->value ?? $settings->defaultValue;
 95 |         $this->units = $this->units ?? $settings->defaultUnits;
 96 | 
 97 |         if ($this->unitsClass !== null) {
 98 |             $this->unitsInstance = new $this->unitsClass($this->value, $this->units);
 99 |         }
100 |     }
101 | 
102 |     /**
103 |      * @inheritdoc
104 |      */
105 |     public function rules(): array
106 |     {
107 |         $rules = parent::rules();
108 |         $rules = array_merge($rules, [
109 |             ['unitsClass', 'string'],
110 |             ['value', 'number'],
111 |             ['units', 'string'],
112 |         ]);
113 | 
114 |         return $rules;
115 |     }
116 | 
117 |     /**
118 |      * @inheritdoc
119 |      */
120 |     public function fields(): array
121 |     {
122 |         $fields = parent::fields();
123 |         $fields = array_diff_key(
124 |             $fields,
125 |             array_flip([
126 |                 'unitsInstance',
127 |             ])
128 |         );
129 | 
130 |         return $fields;
131 |     }
132 | 
133 |     /**
134 |      * @inheritdoc
135 |      */
136 |     public function toUnit($unit)
137 |     {
138 |         return $this->unitsInstance->toUnit($unit);
139 |     }
140 | 
141 |     /**
142 |      * @inheritdoc
143 |      */
144 |     public function toNativeUnit()
145 |     {
146 |         return $this->unitsInstance->toNativeUnit();
147 |     }
148 | 
149 |     /**
150 |      * @inheritdoc
151 |      */
152 |     public function __toString(): string
153 |     {
154 |         return $this->unitsInstance->__toString();
155 |     }
156 | 
157 |     /**
158 |      * @inheritdoc
159 |      */
160 |     public function add(PhysicalQuantityInterface $quantity)
161 |     {
162 |         /** @var UnitsData $quantity */
163 |         return $this->physicalQuantityToUnitsData($this->unitsInstance->add($quantity->unitsInstance));
164 |     }
165 | 
166 |     /**
167 |      * @inheritdoc
168 |      */
169 |     public function subtract(PhysicalQuantityInterface $quantity)
170 |     {
171 |         /** @var UnitsData $quantity */
172 |         return $this->physicalQuantityToUnitsData($this->unitsInstance->subtract($quantity->unitsInstance));
173 |     }
174 | 
175 |     /**
176 |      * @inheritdoc
177 |      */
178 |     public function isEquivalentQuantity(PhysicalQuantityInterface $testQuantity)
179 |     {
180 |         /** @var UnitsData $testQuantity */
181 |         return $this->unitsInstance->isEquivalentQuantity($testQuantity->unitsInstance);
182 |     }
183 | 
184 |     /**
185 |      * @inheritdoc
186 |      */
187 |     public function availableUnits(bool $includeAliases = true)
188 |     {
189 |         $availableUnits = [];
190 |         $units = $this->unitsInstance::getUnitDefinitions();
191 |         /** @var UnitOfMeasure $unit */
192 |         foreach ($units as $unit) {
193 |             $name = $unit->getName();
194 |             $aliases = $unit->getAliases();
195 |             $availableUnits[$name] = $includeAliases ? $aliases : $aliases[0] ?? $name;
196 |         }
197 | 
198 |         return $availableUnits;
199 |     }
200 | 
201 |     /**
202 |      * Return the measurement as a fraction, with the units appended
203 |      *
204 |      * @return string
205 |      */
206 |     public function toFraction(): string
207 |     {
208 |         return trim(Units::$variable->fraction($this->value) . ' ' . $this->units);
209 |     }
210 | 
211 |     /**
212 |      * Return the measurement as a fraction, in the given unit of measure
213 |      *
214 |      * @param UnitOfMeasureInterface|string $unit The desired unit of measure,
215 |      *                                             or a string name of one
216 |      *
217 |      * @return string The measurement cast in the requested units, as a
218 |      *                fraction
219 |      */
220 |     public function toUnitFraction($unit): string
221 |     {
222 |         $value = $this->toUnit($unit);
223 | 
224 |         return Units::$variable->fraction($value);
225 |     }
226 | 
227 |     /**
228 |      * Return the value as a fraction
229 |      *
230 |      * @return string
231 |      */
232 |     public function getValueFraction(): string
233 |     {
234 |         return Units::$variable->fraction($this->value);
235 |     }
236 | 
237 |     /**
238 |      * Return an array of the whole number and decimal number ports of the value
239 |      * [0] has the whole number part, and [1] has the decimal part
240 |      *
241 |      * @return float[]
242 |      */
243 |     public function getValueParts(): array
244 |     {
245 |         return Units::$variable->float2parts($this->value);
246 |     }
247 | 
248 |     /**
249 |      * Return an array of the whole number and decimal number ports of the
250 |      * value with the decimal part converted to a fraction. [0] has the whole
251 |      * number part, and [1] has the fractional part
252 |      *
253 |      * @return string[]
254 |      */
255 |     public function getValuePartsFraction(): array
256 |     {
257 |         $parts = Units::$variable->float2parts($this->value);
258 |         $parts[0] = (string)$parts[0];
259 |         $parts[1] = Units::$variable->float2ratio($parts[1]);
260 | 
261 |         return $parts;
262 |     }
263 | 
264 |     // Protected Methods
265 |     // =========================================================================
266 | 
267 |     /**
268 |      * Convert a PhysicalQuantity object into a UnitsData object
269 |      *
270 |      * @param PhysicalQuantityInterface $quantity
271 |      *
272 |      * @return UnitsData
273 |      */
274 |     protected function physicalQuantityToUnitsData(PhysicalQuantityInterface $quantity): UnitsData
275 |     {
276 |         $unitsClass = get_class($quantity);
277 |         list($value, $units) = explode(' ', (string)$quantity);
278 |         $config = [
279 |             'unitsClass' => $unitsClass,
280 |             'value' => $value,
281 |             'units' => $units,
282 |         ];
283 | 
284 |         return new UnitsData($config);
285 |     }
286 | }
287 | 


--------------------------------------------------------------------------------
/src/fields/Units.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /**
  3 |  * Units plugin for Craft CMS
  4 |  *
  5 |  * A plugin for handling physical quantities and the units of measure in which
  6 |  * they're represented.
  7 |  *
  8 |  * @link      https://nystudio107.com/
  9 |  * @copyright Copyright (c) nystudio107
 10 |  */
 11 | 
 12 | namespace nystudio107\units\fields;
 13 | 
 14 | use Craft;
 15 | use craft\base\ElementInterface;
 16 | use craft\base\Field;
 17 | use craft\base\PreviewableFieldInterface;
 18 | use craft\helpers\Html;
 19 | use craft\helpers\Json;
 20 | use craft\i18n\Locale;
 21 | use GraphQL\Type\Definition\Type;
 22 | use nystudio107\units\assetbundles\unitsfield\UnitsFieldAsset;
 23 | use nystudio107\units\gql\types\generators\UnitsDataGenerator;
 24 | use nystudio107\units\helpers\ClassHelper;
 25 | use nystudio107\units\models\Settings;
 26 | use nystudio107\units\models\UnitsData;
 27 | use nystudio107\units\Units as UnitsPlugin;
 28 | use nystudio107\units\validators\EmbeddedUnitsDataValidator;
 29 | use PhpUnitsOfMeasure\PhysicalQuantity\Length;
 30 | use yii\base\InvalidConfigException;
 31 | 
 32 | /**
 33 |  * @author    nystudio107
 34 |  * @package   Units
 35 |  * @since     1.0.0
 36 |  */
 37 | class Units extends Field implements PreviewableFieldInterface
 38 | {
 39 |     // Static Methods
 40 |     // =========================================================================
 41 | 
 42 |     /**
 43 |      * @var string The default fully qualified class name of the unit of measure
 44 |      */
 45 |     public string $defaultUnitsClass;
 46 | 
 47 |     // Public Properties
 48 |     // =========================================================================
 49 |     /**
 50 |      * @var ?float The default value of the unit of measure
 51 |      */
 52 |     public ?float $defaultValue = null;
 53 |     /**
 54 |      * @var ?string The default units that the unit of measure is in
 55 |      */
 56 |     public ?string $defaultUnits = null;
 57 |     /**
 58 |      * @var ?bool Whether the units the field can be changed
 59 |      */
 60 |     public ?bool $changeableUnits = null;
 61 |     /**
 62 |      * @var int|float|null The minimum allowed number
 63 |      */
 64 |     public int|float|null $min = null;
 65 |     /**
 66 |      * @var int|float|null The maximum allowed number
 67 |      */
 68 |     public int|float|null $max = null;
 69 |     /**
 70 |      * @var ?int The number of digits allowed after the decimal point
 71 |      */
 72 |     public ?int $decimals = null;
 73 |     /**
 74 |      * @var ?int The size of the field
 75 |      */
 76 |     public ?int $size = null;
 77 | 
 78 |     /**
 79 |      * @inheritdoc
 80 |      */
 81 |     public static function displayName(): string
 82 |     {
 83 |         return Craft::t('units', 'Units');
 84 |     }
 85 | 
 86 |     /**
 87 |      * @inheritdoc
 88 |      */
 89 |     public static function icon(): string
 90 |     {
 91 |         return 'scale-balanced';
 92 |     }
 93 | 
 94 |     // Public Methods
 95 |     // =========================================================================
 96 | 
 97 |     /**
 98 |      * @inheritdoc
 99 |      */
100 |     public function init(): void
101 |     {
102 |         parent::init();
103 |         if (UnitsPlugin::$plugin !== null) {
104 |             /** @var Settings $settings */
105 |             $settings = UnitsPlugin::$plugin->getSettings();
106 |             if ($settings !== null) {
107 |                 $this->defaultUnitsClass = $this->defaultUnitsClass ?? $settings->defaultUnitsClass;
108 |                 $this->defaultValue = $this->defaultValue ?? $settings->defaultValue;
109 |                 $this->defaultUnits = $this->defaultUnits ?? $settings->defaultUnits;
110 |                 $this->changeableUnits = $this->changeableUnits ?? $settings->defaultChangeableUnits;
111 |                 $this->min = $this->min ?? $settings->defaultMin;
112 |                 $this->max = $this->max ?? $settings->defaultMax;
113 |                 $this->decimals = $this->decimals ?? $settings->defaultDecimals;
114 |                 $this->size = $this->size ?? $settings->defaultSize;
115 |             }
116 |         }
117 |     }
118 | 
119 |     /**
120 |      * @inheritdoc
121 |      */
122 |     public function rules(): array
123 |     {
124 |         $rules = parent::rules();
125 |         $rules = array_merge($rules, [
126 |             ['defaultUnitsClass', 'string'],
127 |             ['defaultValue', 'number'],
128 |             ['defaultUnits', 'string'],
129 |             ['changeableUnits', 'boolean'],
130 |             [['min', 'max'], 'number'],
131 |             [['decimals', 'size'], 'integer'],
132 |             [
133 |                 ['max'],
134 |                 'compare',
135 |                 'compareAttribute' => 'min',
136 |                 'operator' => '>=',
137 |             ],
138 |         ]);
139 | 
140 |         if (!$this->decimals) {
141 |             $rules[] = [['min', 'max'], 'integer'];
142 |         }
143 | 
144 |         return $rules;
145 |     }
146 | 
147 |     /**
148 |      * @inheritdoc
149 |      */
150 |     public function normalizeValue(mixed $value, ?ElementInterface $element = null): mixed
151 |     {
152 |         if ($value instanceof UnitsData) {
153 |             return $value;
154 |         }
155 |         // Default config
156 |         $config = [
157 |             'unitsClass' => $this->defaultUnitsClass,
158 |             'value' => $this->defaultValue,
159 |             'units' => $this->defaultUnits,
160 |         ];
161 |         // Handle incoming values potentially being JSON or an array
162 |         if (!empty($value)) {
163 |             // Handle a numeric value coming in (perhaps from a Number field)
164 |             if (is_numeric($value)) {
165 |                 $config['value'] = (float)$value;
166 |             } elseif (is_string($value)) {
167 |                 $config = Json::decodeIfJson($value);
168 |             }
169 |             if (is_array($value)) {
170 |                 $config = array_merge($config, array_filter($value));
171 |             }
172 |         }
173 |         // Typecast it to a float
174 |         $config['value'] = (float)$config['value'];
175 |         // Create and validate the model
176 |         $unitsData = new UnitsData($config);
177 |         if (!$unitsData->validate()) {
178 |             Craft::error(
179 |                 Craft::t('units', 'UnitsData failed validation: ')
180 |                 . print_r($unitsData->getErrors(), true),
181 |                 __METHOD__
182 |             );
183 |         }
184 | 
185 |         return $unitsData;
186 |     }
187 | 
188 |     /**
189 |      * @inheritdoc
190 |      */
191 |     public function getSettingsHtml(): ?string
192 |     {
193 |         $unitsClassMap = array_flip(ClassHelper::getClassesInNamespace(Length::class));
194 | 
195 |         // Render the settings template
196 |         return Craft::$app->getView()->renderTemplate(
197 |             'units/_components/fields/Units_settings',
198 |             [
199 |                 'field' => $this,
200 |                 'unitsClassMap' => $unitsClassMap,
201 |             ]
202 |         );
203 |     }
204 | 
205 |     /**
206 |      * @inheritdoc
207 |      */
208 |     public function getInputHtml(mixed $value, ?ElementInterface $element = null): string
209 |     {
210 |         if ($value instanceof UnitsData) {
211 |             // Register our asset bundle
212 |             try {
213 |                 Craft::$app->getView()->registerAssetBundle(UnitsFieldAsset::class);
214 |             } catch (InvalidConfigException $e) {
215 |                 Craft::error($e->getMessage(), __METHOD__);
216 |             }
217 |             $model = $value;
218 |             $value = $model->value;
219 |             $decimals = $this->decimals;
220 |             // If decimals is 0 (or null, empty for whatever reason), don't run this
221 |             if ($decimals) {
222 |                 $decimalSeparator = Craft::$app->getLocale()->getNumberSymbol(Locale::SYMBOL_DECIMAL_SEPARATOR);
223 |                 $value = number_format($value, $decimals, $decimalSeparator, '');
224 |             }
225 |             // Get our id and namespace
226 |             $id = Html::id($this->handle);
227 |             $namespacedId = Craft::$app->getView()->namespaceInputId($id);
228 | 
229 |             // Variables to pass down to our field JavaScript to let it namespace properly
230 |             $jsonVars = [
231 |                 'id' => $id,
232 |                 'name' => $this->handle,
233 |                 'namespace' => $namespacedId,
234 |                 'prefix' => Craft::$app->getView()->namespaceInputId(''),
235 |             ];
236 |             $jsonVars = Json::encode($jsonVars);
237 |             Craft::$app->getView()->registerJs("$('#{$namespacedId}-field').UnitsUnits(" . $jsonVars . ");");
238 | 
239 |             // Render the input template
240 |             return Craft::$app->getView()->renderTemplate(
241 |                 'units/_components/fields/Units_input',
242 |                 [
243 |                     'name' => $this->handle,
244 |                     'field' => $this,
245 |                     'id' => $id,
246 |                     'namespacedId' => $namespacedId,
247 |                     'value' => $value,
248 |                     'model' => $model,
249 |                 ]
250 |             );
251 |         }
252 | 
253 |         return '';
254 |     }
255 | 
256 |     /**
257 |      * @inheritdoc
258 |      */
259 |     public function getContentGqlType(): Type|array
260 |     {
261 |         $typeArray = UnitsDataGenerator::generateTypes($this);
262 | 
263 |         return [
264 |             'name' => $this->handle,
265 |             'description' => 'Units field',
266 |             'type' => array_shift($typeArray),
267 |         ];
268 |     }
269 | 
270 |     /**
271 |      * @inheritdoc
272 |      */
273 |     public function getElementValidationRules(): array
274 |     {
275 |         return [
276 |             [
277 |                 EmbeddedUnitsDataValidator::class,
278 |                 'units' => $this->defaultUnits,
279 |                 'integerOnly' => !$this->decimals,
280 |                 'min' => $this->min,
281 |                 'max' => $this->max,
282 |             ],
283 |         ];
284 |     }
285 | }
286 | 


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