├── CHANGELOG.md
├── phpstan.neon
├── ecs.php
├── src
    ├── translations
    │   └── en
    │   │   └── empty-coalesce.php
    ├── EmptyCoalesce.php
    ├── twigextensions
    │   └── EmptyCoalesceTwigExtension.php
    ├── Node
    │   └── Expression
    │   │   └── EmptyCoalesceExpression.php
    └── icon.svg
├── LICENSE.md
├── test
    └── Twig
    │   └── Tests
    │       └── Node
    │           └── Expression
    │               └── EmptyCoalesceTest.php
├── composer.json
└── README.md


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


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


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


--------------------------------------------------------------------------------
/src/translations/en/empty-coalesce.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Empty Coalesce plugin for Craft CMS 3.x
 4 |  *
 5 |  * Empty Coalesce adds the ??? operator to Twig that will return the first thing
 6 |  * that is defined, not null, and not empty.
 7 |  *
 8 |  * @link      https://nystudio107.com/
 9 |  * @copyright Copyright (c) 2018 nystudio107
10 |  */
11 | 
12 | /**
13 |  * @author    nystudio107
14 |  * @package   EmptyCoalesce
15 |  * @since     1.0.0
16 |  */
17 | return [
18 |     'Empty Coalesce plugin loaded' => 'Empty Coalesce plugin loaded',
19 | ];
20 | 


--------------------------------------------------------------------------------
/LICENSE.md:
--------------------------------------------------------------------------------
 1 | The MIT License (MIT)
 2 | 
 3 | Copyright (c) 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.
10 | 


--------------------------------------------------------------------------------
/test/Twig/Tests/Node/Expression/EmptyCoalesceTest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Empty Coalesce plugin for Craft CMS 3.x
 4 |  *
 5 |  * Empty Coalesce adds the ??? operator to Twig that will return the first thing
 6 |  * that is defined, not null, and not empty.
 7 |  *
 8 |  * @link      https://nystudio107.com/
 9 |  * @copyright Copyright (c) 2018 nystudio107
10 |  */
11 | 
12 | use nystudio107\emptycoalesce\Node\Expression\EmptyCoalesceExpression;
13 | 
14 | use Twig\Node\Expression\ConstantExpression;
15 | use Twig\Node\Expression\NameExpression;
16 | use Twig\Test\NodeTestCase;
17 | 
18 | /**
19 |  * @author    nystudio107
20 |  * @package   EmptyCoalesce
21 |  * @since     1.0.0
22 |  *
23 |  */
24 | class Twig_Tests_Node_Expression_EmptyCoalesceTest extends NodeTestCase
25 | {
26 |     public function getTests()
27 |     {
28 |         $left = new NameExpression('foo', 1);
29 |         $right = new ConstantExpression(2, 1);
30 |         $node = new EmptyCoalesceExpression($left, $right, 1);
31 | 
32 |         return array(array($node, "((".EmptyCoalesceExpression::class."::empty(// line 1\n(\$context[\"foo\"] ?? null)) ? null : (\$context[\"foo\"] ?? null)) ?? (".EmptyCoalesceExpression::class."::empty(2) ? null : 2))"));
33 |     }
34 | }
35 | 


--------------------------------------------------------------------------------
/composer.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "name": "nystudio107/craft-emptycoalesce",
 3 |   "description": "Empty Coalesce adds the ??? operator to Twig that will return the first thing that is defined, not null, and not empty.",
 4 |   "type": "craft-plugin",
 5 |   "version": "5.0.0",
 6 |   "keywords": [
 7 |     "craftcms",
 8 |     "craft-plugin",
 9 |     "craft3",
10 |     "empty",
11 |     "coalesce",
12 |     "operator",
13 |     "coalescing",
14 |     "twig"
15 |   ],
16 |   "support": {
17 |     "docs": "https://nystudio107.com/docs/empty-coalesce/",
18 |     "issues": "https://nystudio107.com/plugins/empty-coalesce/support",
19 |     "source": "https://github.com/nystudio107/craft-emptycoalesce"
20 |   },
21 |   "license": "MIT",
22 |   "authors": [
23 |     {
24 |       "name": "nystudio107",
25 |       "homepage": "https://nystudio107.com/"
26 |     }
27 |   ],
28 |   "require": {
29 |     "php": "^8.2",
30 |     "craftcms/cms": "^5.0.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 |     "sort-packages": true
49 |   },
50 |   "autoload": {
51 |     "psr-4": {
52 |       "nystudio107\\emptycoalesce\\": "src/"
53 |     }
54 |   },
55 |   "extra": {
56 |     "class": "nystudio107\\emptycoalesce\\EmptyCoalesce",
57 |     "handle": "empty-coalesce",
58 |     "name": "Empty Coalesce"
59 |   }
60 | }
61 | 


--------------------------------------------------------------------------------
/src/EmptyCoalesce.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Empty Coalesce plugin for Craft CMS 3.x
 4 |  *
 5 |  * Empty Coalesce adds the ??? operator to Twig that will return the first thing
 6 |  * that is defined, not null, and not empty.
 7 |  *
 8 |  * @link      https://nystudio107.com/
 9 |  * @copyright Copyright (c) 2018 nystudio107
10 |  */
11 | 
12 | namespace nystudio107\emptycoalesce;
13 | 
14 | use Craft;
15 | 
16 | use craft\base\Plugin;
17 | use nystudio107\emptycoalesce\twigextensions\EmptyCoalesceTwigExtension;
18 | 
19 | /**
20 |  * Class EmptyCoalesce
21 |  *
22 |  * @author    nystudio107
23 |  * @package   EmptyCoalesce
24 |  * @since     1.0.0
25 |  *
26 |  */
27 | class EmptyCoalesce extends Plugin
28 | {
29 |     // Static Properties
30 |     // =========================================================================
31 | 
32 |     /**
33 |      * @var EmptyCoalesce
34 |      */
35 |     public static $plugin;
36 | 
37 |     // Public Properties
38 |     // =========================================================================
39 | 
40 |     /**
41 |      * @var string
42 |      */
43 |     public string $schemaVersion = '1.0.0';
44 | 
45 |     // Public Methods
46 |     // =========================================================================
47 | 
48 |     /**
49 |      * @inheritdoc
50 |      */
51 |     public function init(): void
52 |     {
53 |         parent::init();
54 |         self::$plugin = $this;
55 | 
56 |         Craft::$app->view->registerTwigExtension(new EmptyCoalesceTwigExtension());
57 | 
58 |         Craft::info(
59 |             Craft::t(
60 |                 'empty-coalesce',
61 |                 '{name} plugin loaded',
62 |                 ['name' => $this->name]
63 |             ),
64 |             __METHOD__
65 |         );
66 |     }
67 | }
68 | 


--------------------------------------------------------------------------------
/src/twigextensions/EmptyCoalesceTwigExtension.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Empty Coalesce plugin for Craft CMS 3.x
 4 |  *
 5 |  * Empty Coalesce adds the ??? operator to Twig that will return the first thing
 6 |  * that is defined, not null, and not empty.
 7 |  *
 8 |  * @link      https://nystudio107.com/
 9 |  * @copyright Copyright (c) 2018 nystudio107
10 |  */
11 | 
12 | namespace nystudio107\emptycoalesce\twigextensions;
13 | 
14 | use nystudio107\emptycoalesce\Node\Expression\EmptyCoalesceExpression;
15 | 
16 | use Twig\ExpressionParser;
17 | use Twig\Extension\AbstractExtension;
18 | 
19 | /**
20 |  * @author    nystudio107
21 |  * @package   EmptyCoalesce
22 |  * @since     1.0.0
23 |  */
24 | class EmptyCoalesceTwigExtension extends AbstractExtension
25 | {
26 |     // Public Methods
27 |     // =========================================================================
28 | 
29 |     /**
30 |      * @inheritdoc
31 |      */
32 |     public function getName(): string
33 |     {
34 |         return 'EmptyCoalesce';
35 |     }
36 | 
37 |     /**
38 |      * @inheritdoc
39 |      */
40 |     public function getFilters(): array
41 |     {
42 |         return [
43 |         ];
44 |     }
45 | 
46 |     /**
47 |      * @inheritdoc
48 |      */
49 |     public function getFunctions(): array
50 |     {
51 |         return [
52 |         ];
53 |     }
54 | 
55 |     /**
56 |      * @return array<int, mixed[]>
57 |      */
58 |     public function getOperators(): array
59 |     {
60 |         return [
61 |             // Unary operators
62 |             [],
63 |             // Binary operators
64 |             [
65 |                 '???' => [
66 |                     'precedence' => 300,
67 |                     'class' => EmptyCoalesceExpression::class,
68 |                     'associativity' => ExpressionParser::OPERATOR_RIGHT,
69 |                 ],
70 |             ],
71 |         ];
72 |     }
73 | }
74 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/nystudio107/craft-emptycoalesce/badges/quality-score.png?b=v5)](https://scrutinizer-ci.com/g/nystudio107/craft-emptycoalesce/?branch=v5) [![Code Coverage](https://scrutinizer-ci.com/g/nystudio107/craft-emptycoalesce/badges/coverage.png?b=v5)](https://scrutinizer-ci.com/g/nystudio107/craft-emptycoalesce/?branch=v5) [![Build Status](https://scrutinizer-ci.com/g/nystudio107/craft-emptycoalesce/badges/build.png?b=v5)](https://scrutinizer-ci.com/g/nystudio107/craft-emptycoalesce/build-status/v5) [![Code Intelligence Status](https://scrutinizer-ci.com/g/nystudio107/craft-emptycoalesce/badges/code-intelligence.svg?b=v5)](https://scrutinizer-ci.com/code-intelligence)
 2 | 
 3 | # Empty Coalesce plugin for Craft CMS 5.x
 4 | 
 5 | Empty Coalesce adds the ??? operator to Twig that will return the first thing that is defined, not null, and not empty.
 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-emptycoalesce
24 | 
25 | 3. Install the plugin via `./craft install/plugin empty-coalesce` via the CLI, or in the Control Panel, go to Settings → Plugins and click the “Install” button for Empty Coalesce.
26 | 
27 | You can also install Empty Coalesce via the **Plugin Store** in the Craft Control Panel.
28 | 
29 | ## Documentation
30 | 
31 | Click here -> [Empty Coalesce Documentation](https://nystudio107.com/plugins/empty-coalesce/documentation)
32 | 
33 | ## Empty Coalesce Roadmap
34 | 
35 | Some things to do, and ideas for potential features:
36 | 
37 | * Submit a PR to the Twig project to get it into core
38 | 
39 | Brought to you by [nystudio107](https://nystudio107.com/)
40 | 


--------------------------------------------------------------------------------
/src/Node/Expression/EmptyCoalesceExpression.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Empty Coalesce plugin for Craft CMS 3.x
 4 |  *
 5 |  * Empty Coalesce adds the ??? operator to Twig that will return the first thing
 6 |  * that is defined, not null, and not empty.
 7 |  *
 8 |  * @link      https://nystudio107.com/
 9 |  * @copyright Copyright (c) 2018 nystudio107
10 |  */
11 | 
12 | namespace nystudio107\emptycoalesce\Node\Expression;
13 | 
14 | use Twig\Compiler;
15 | use Twig\Node\Expression\AbstractExpression;
16 | use Twig\Node\Node;
17 | 
18 | /**
19 |  * @author    nystudio107
20 |  * @package   EmptyCoalesce
21 |  * @since     1.0.0
22 |  *
23 |  */
24 | class EmptyCoalesceExpression extends AbstractExpression
25 | {
26 |     /**
27 |      * Checks if a variable is empty.
28 |      *
29 |      *    {# evaluates to true if the foo variable is null, false, or the empty string #}
30 |      *    {% if foo is empty %}
31 |      *        {# ... #}
32 |      *    {% endif %}
33 |      *
34 |      * @param mixed $value A variable
35 |      *
36 |      * @return bool true if the value is empty, false otherwise
37 |      */
38 |     public static function empty($value): bool
39 |     {
40 |         if ($value instanceof \Countable) {
41 |             return 0 == \count($value);
42 |         }
43 | 
44 |         if (\is_object($value) && method_exists($value, '__toString')) {
45 |             return '' === (string) $value;
46 |         }
47 | 
48 |         return '' === $value || false === $value || null === $value || [] === $value;
49 |     }
50 | 
51 |     public function __construct(Node $left, Node $right, int $lineno)
52 |     {
53 |         $left->setAttribute('ignore_strict_check', true);
54 |         $left->setAttribute('is_defined_test', false);
55 | 
56 |         $right->setAttribute('ignore_strict_check', true);
57 |         $right->setAttribute('is_defined_test', false);
58 |         parent::__construct(
59 |             ['left' => $left, 'right' => $right],
60 |             ['ignore_strict_check' => true, 'is_defined_test' => false],
61 |             $lineno
62 |         );
63 |     }
64 | 
65 |     public function compile(Compiler $compiler): void
66 |     {
67 |         //$this->getNode('expr1')->setAttribute('always_defined', true);
68 |         $compiler
69 |             ->raw('((' . self::class . '::empty(')
70 |             ->subcompile($this->getNode('left'))
71 |             ->raw(') ? null : ')
72 |             ->subcompile($this->getNode('left'))
73 |             ->raw(') ?? (' . self::class . '::empty(')
74 |             ->subcompile($this->getNode('right'))
75 |             ->raw(') ? null : ')
76 |             ->subcompile($this->getNode('right'))
77 |             ->raw('))')
78 |         ;
79 |     }
80 | }
81 | 


--------------------------------------------------------------------------------
/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_icon20_x5F_emptyCoalesce"
 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_62_">
 8 | 	<path id="gr_263_" fill="#F3BA48" d="M237.667,172.705c0,9.535-6.759,21.247-15.018,26.019l-82.624,47.698
 9 | 		c-8.267,4.771-21.784,4.771-30.043,0l-82.624-47.698c-8.267-4.771-15.025-16.483-15.025-26.019V77.299
10 | 		c0-9.539,6.759-21.251,15.025-26.019l82.624-47.702c8.259-4.771,21.776-4.771,30.043,0l82.624,47.702
11 | 		c8.259,4.768,15.018,16.479,15.018,26.019V172.705z"/>
12 | 	<g>
13 | 		<path fill="#FBFFFF" d="M73.208,129.849v-4.2c0-10.902,14.495-12.199,14.495-21.4c0-4.102-3.202-7.701-8.999-7.701
14 | 			c-7.102,0-10.303,4.301-12.298,5.999c-0.802,0.705-1.604,0.705-2.399,0l-3.299-3.198c-0.802-0.701-0.601-1.8,0-2.599
15 | 			c0,0,6.299-8.803,18.994-8.803c10.4,0,18.4,6.602,18.4,16.099c0,12.604-15.499,14.902-15.499,22.001v3.704
16 | 			c0,1.297-0.9,1.998-2.1,1.998h-5.399C74.107,131.749,73.208,130.95,73.208,129.849z M77.706,146.049
17 | 			c3.899,0,6.997,3.1,6.997,6.999c0,3.802-3.098,6.899-6.997,6.899c-3.802,0-6.905-3.098-6.905-6.899
18 | 			C70.801,149.148,73.904,146.049,77.706,146.049z"/>
19 | 		<path fill="#FBFFFF" d="M118.604,129.849v-4.2c0-10.902,14.502-12.199,14.502-21.4c0-4.102-3.202-7.701-9.005-7.701
20 | 			c-7.095,0-10.296,4.301-12.298,5.999c-0.803,0.705-1.597,0.705-2.399,0l-3.3-3.198c-0.802-0.701-0.6-1.8,0-2.599
21 | 			c0,0,6.299-8.803,19.002-8.803c10.399,0,18.4,6.602,18.4,16.099c0,12.604-15.499,14.902-15.499,22.001v3.704
22 | 			c0,1.297-0.9,1.998-2.1,1.998h-5.405C119.503,131.749,118.604,130.95,118.604,129.849z M123.103,146.049
23 | 			c3.899,0,7.004,3.1,7.004,6.999c0,3.802-3.104,6.899-7.004,6.899c-3.801,0-6.898-3.098-6.898-6.899
24 | 			C116.204,149.148,119.302,146.049,123.103,146.049z"/>
25 | 		<path fill="#FBFFFF" d="M164.007,129.849v-4.2c0-10.902,14.495-12.199,14.495-21.4c0-4.102-3.202-7.701-8.998-7.701
26 | 			c-7.102,0-10.303,4.301-12.299,5.999c-0.802,0.705-1.604,0.705-2.399,0l-3.299-3.198c-0.802-0.701-0.601-1.8,0-2.599
27 | 			c0,0,6.299-8.803,18.994-8.803c10.4,0,18.4,6.602,18.4,16.099c0,12.604-15.498,14.902-15.498,22.001v3.704
28 | 			c0,1.297-0.9,1.998-2.101,1.998h-5.399C164.906,131.749,164.007,130.95,164.007,129.849z M168.506,146.049
29 | 			c3.899,0,6.996,3.1,6.996,6.999c0,3.802-3.097,6.899-6.996,6.899c-3.801,0-6.905-3.098-6.905-6.899
30 | 			C161.601,149.148,164.705,146.049,168.506,146.049z"/>
31 | 	</g>
32 | </g>
33 | </svg>
34 | 


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