nystudio107 / craft-closure

src/Closure.php

<?php
/**
 * Closure for Craft CMS
 *
 * Allows you to use arrow function closures in Twig
 *
 * @link      https://nystudio107.com

The tag in position 1 should be the @copyright tag

 * @copyright Copyright (c) 2022 nystudio107

@copyright tag must contain a year and the name of the copyright holder

 */

PHP version not specified

Missing @category tag in file comment

Missing @package tag in file comment

Missing @author tag in file comment

Missing @license tag in file comment

namespace nystudio107\closure;

use Craft;
use craft\console\Application as CraftConsoleApp;
use craft\events\CreateTwigEvent;
use craft\web\Application as CraftWebApp;
use craft\web\twig\Environment;
use craft\web\View;
use nystudio107\closure\helpers\Reflection as ReflectionHelper;
use nystudio107\closure\twig\ClosureExpressionParser;
use ReflectionException;
use Twig\Environment as TwigEnvironment;
use Twig\Parser;
use yii\base\BootstrapInterface;
use yii\base\Event;
use yii\base\Module;

/**

Missing short description in doc comment

 * @author    nystudio107

The tag in position 1 should be the @package tag

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

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

 * @package   Closure

Tag value for @package tag indented incorrectly; expected 1 spaces but found 3

 * @since     1.0.0

The tag in position 3 should be the @author tag

Tag value for @since tag indented incorrectly; expected 3 spaces but found 5

 */

Missing @category tag in class comment

Missing @license tag in class comment

Missing @link tag in class comment

class Closure extends Module implements BootstrapInterface
{
    // Constants
    // =========================================================================

    public const ID = 'closure';

    // Protected Static Properties
    // =========================================================================

    protected bool $closureAdded = false;

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

    /**

Missing short description in doc comment

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

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

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

     * @inerhitdoc
     */
    public function __construct($id = self::ID, $parent = null, $config = [])
    {
        /**
         * Explicitly set the $id parameter, as earlier versions of Yii2 look for a
         * default parameter, and depend on $id being explicitly set:
         * https://github.com/yiisoft/yii2/blob/f3d1534125c9c3dfe8fa65c28a4be5baa822e721/framework/di/Container.php#L436-L448
         */
        parent::__construct($id, $parent, $config);
    }

    /**

Missing short description in doc comment

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

     * @inerhitDoc
     */

Missing @return tag in function comment

    public function bootstrap($app)
    {
        // Only bootstrap if this is a CraftWebApp
        if (!($app instanceof CraftWebApp || $app instanceof CraftConsoleApp)) {
            return;
        }
        // Do nothing if we're running a version of Twig that has baked in support for "arrow functions everywhere"
        // @phpstan-ignore-next-line
        if (version_compare(TwigEnvironment::VERSION, '3.15.0', '>=')) {
            Craft::warning('Craft Closure not loaded because this version of Twig already supports arrow functions everywhere. You can safely uninstall Craft Closure by removing it from your composer.json', __METHOD__);
            return;
        }
        // Set the instance of this module class, so we can later access it with `Closure::getInstance()`
        static::setInstance($this);
        // Configure our module
        $this->configureModule();
        // Register our event handlers
        $this->registerEventHandlers();
        Craft::info('Closure module bootstrapped', __METHOD__);
    }

    // Protected Methods
    // =========================================================================

    /**
     * Add our ClosureExpressionParser to default $allowArrow = true to let
     * arrow function closures work outside of Twig filter contexts
     *
     * @param Environment|null $twig

Missing parameter comment

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

     * @return void

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

     */
    public function addClosure(?Environment $twig = null): void
    {
        // Custom environment if specified, otherwise Craft default
        $twig = $twig ?? Craft::$app->getView()->getTwig();
        // Get the parser object used by Twig
        try {
            $parserReflection = ReflectionHelper::getReflectionProperty($twig, 'parser');
        } catch (ReflectionException $e) {
            Craft::error($e->getMessage(), __METHOD__);
            return;
        }
        $parserReflection->setAccessible(true);
        $parser = $parserReflection->getValue($twig);
        if ($parser === null) {
            $parser = new Parser($twig);
            $parserReflection->setValue($twig, $parser);
        }
        // Create the ClosureExpressionParser object and set the parser to use it
        try {
            $expressionParserReflection = ReflectionHelper::getReflectionProperty($parser, 'expressionParser');
        } catch (ReflectionException $e) {
            Craft::error($e->getMessage(), __METHOD__);
            return;
        }
        $expressionParserReflection->setAccessible(true);
        $expressionParser = new ClosureExpressionParser($parser, $twig);
        $expressionParserReflection->setValue($parser, $expressionParser);
    }

    /**
     * Configure our module
     *
     * @return void
     */
    protected function configureModule(): void
    {
        // Register our module
        Craft::$app->setModule($this->id, $this);
    }

    /**
     * Registers our event handlers
     *
     * @return void
     */
    protected function registerEventHandlers(): void
    {
        // Handler: View::EVENT_AFTER_CREATE_TWIG
        Event::on(
            View::class,
            View::EVENT_AFTER_CREATE_TWIG,
            fn(CreateTwigEvent $event) => $this->addClosure($event->twig)
        );
    }
}