Merge pull request #15916 from twistersfury/5.0.x-initialization

Adding InitializationAwareInterface

CHANGELOG-5.0.md

@@ -5,6 +5,7 @@
 
 ## Added
 - Added `Phalcon\Encryption\Crypt::isValidDecryptLength($input)` to allow checking for the length of the decryption string [#15879](https://github.com/phalcon/cphalcon/issues/15879)
+- Added `Phalcon\Di\InitializationAwareInterface` to allow auto calling the `initialize` method when accessing service through DIC
 
 # [5.0.0beta3](https://github.com/phalcon/cphalcon/releases/tag/v5.0.0beta3) (2022-02-06)
 

phalcon/Di/Di.zep

@@ -19,6 +19,7 @@ use Phalcon\Config\Adapter\Yaml;
 use Phalcon\Config\ConfigInterface;
 use Phalcon\Di\ServiceInterface;
 use Phalcon\Events\ManagerInterface;
+use Phalcon\Di\InitializationAwareInterface;
 use Phalcon\Di\InjectionAwareInterface;
 use Phalcon\Di\ServiceProviderInterface;
 
@@ -240,6 +241,10 @@ class Di implements DiInterface
             if instance instanceof InjectionAwareInterface {
                 instance->setDI(this);
             }
+
+            if instance instanceof InitializationAwareInterface {
+                instance->initialize();
+            }
         }
 
         /**

phalcon/Di/InitializationAwareInterface.zep

@@ -0,0 +1,6 @@
+namespace Phalcon\Di;
+
+interface InitializationAwareInterface
+{
+    public function initialize() -> void;
+}

tests/_data/fixtures/Di/InitializationAwareComponent.php

@@ -0,0 +1,36 @@
+<?php
+
+/**
+ * This file is part of the Phalcon Framework.
+ *
+ * (c) Phalcon Team <team@phalcon.io>
+ *
+ * For the full copyright and license information, please view the LICENSE.txt
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace Phalcon\Tests\Fixtures\Di;
+
+use Phalcon\Di\InitializationAwareInterface;
+
+/**
+ * Class InitializationAwareComponent
+ *
+ * @package Phalcon\Tests\Fixtures\Di
+ */
+class InitializationAwareComponent implements InitializationAwareInterface
+{
+    private bool $initialized = false;
+
+    public function initialize(): void
+    {
+        $this->initialized = true;
+    }
+
+    public function isInitialized(): bool
+    {
+        return $this->initialized;
+    }
+}

tests/unit/Di/InitializationAwareCest.php

@@ -0,0 +1,43 @@
+<?php
+
+/**
+ * This file is part of the Phalcon Framework.
+ *
+ * (c) Phalcon Team <team@phalcon.io>
+ *
+ * For the full copyright and license information, please view the LICENSE.txt
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace Phalcon\Tests\Unit\Di;
+
+use Phalcon\Di\Di;
+use Phalcon\Tests\Fixtures\Di\InitializationAwareComponent;
+use UnitTester;
+
+/**
+ * Class InitializationAwareCest
+ *
+ * @package Phalcon\Tests\Unit\Di
+ */
+class InitializationAwareCest
+{
+    /**
+     * Tests Phalcon\Di\Di :: initialization aware interface
+     *
+     * @param UnitTester $I
+     *
+     * @author Phalcon Team <team@phalcon.io>
+     * @since  2019-09-09
+     */
+    public function diInitializationAware(UnitTester $I)
+    {
+        $I->wantToTest('Di - initialization aware interface');
+
+        $di = new Di();
+
+        $I->assertEquals(true, $di->get(InitializationAwareComponent::class)->isInitialized());
+    }
+}