-
-
Notifications
You must be signed in to change notification settings - Fork 188
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add "skipDestructor" option to lazy loading proxies #641
Closed
Closed
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
29 changes: 29 additions & 0 deletions
29
src/ProxyManager/ProxyGenerator/LazyLoadingGhost/MethodGenerator/SkipDestructor.php
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| <?php | ||
|
|
||
| declare(strict_types=1); | ||
|
|
||
| namespace ProxyManager\ProxyGenerator\LazyLoadingGhost\MethodGenerator; | ||
|
|
||
| use Laminas\Code\Generator\Exception\InvalidArgumentException; | ||
| use Laminas\Code\Generator\PropertyGenerator; | ||
| use ProxyManager\Generator\MethodGenerator; | ||
|
|
||
| /** | ||
| * Destructor that skips the original destructor when the proxy is not initialized. | ||
| */ | ||
| class SkipDestructor extends MethodGenerator | ||
| { | ||
| /** | ||
| * Constructor | ||
| * | ||
| * @throws InvalidArgumentException | ||
| */ | ||
| public function __construct(PropertyGenerator $initializerProperty) | ||
| { | ||
| parent::__construct('__destruct'); | ||
|
|
||
| $this->setBody( | ||
| '$this->' . $initializerProperty->getName() . ' || parent::__destruct();' | ||
| ); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
32 changes: 32 additions & 0 deletions
32
src/ProxyManager/ProxyGenerator/LazyLoadingValueHolder/MethodGenerator/SkipDestructor.php
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,32 @@ | ||
| <?php | ||
|
|
||
| declare(strict_types=1); | ||
|
|
||
| namespace ProxyManager\ProxyGenerator\LazyLoadingValueHolder\MethodGenerator; | ||
|
|
||
| use Laminas\Code\Generator\PropertyGenerator; | ||
| use ProxyManager\Generator\MethodGenerator; | ||
| use ReflectionClass; | ||
|
|
||
| /** | ||
| * Destructor that skips the original destructor when the proxy is not initialized. | ||
| */ | ||
| class SkipDestructor extends MethodGenerator | ||
| { | ||
| /** | ||
| * Constructor | ||
| */ | ||
| public function __construct( | ||
| PropertyGenerator $initializerProperty, | ||
| PropertyGenerator $valueHolderProperty | ||
| ) { | ||
| parent::__construct('__destruct'); | ||
|
|
||
| $initializer = $initializerProperty->getName(); | ||
| $valueHolder = $valueHolderProperty->getName(); | ||
|
|
||
| $this->setBody( | ||
| '$this->' . $initializer . ' || $this->' . $valueHolder . '->__destruct();' | ||
| ); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
39 changes: 39 additions & 0 deletions
39
tests/language-feature-scripts/lazy-loading-ghost-skip-destructor.phpt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| --TEST-- | ||
| Verifies that generated lazy loading ghost objects can skip calling the proxied destructor | ||
| --FILE-- | ||
| <?php | ||
|
|
||
| require_once __DIR__ . '/init.php'; | ||
|
|
||
| class Destructable | ||
| { | ||
| public function __destruct() | ||
| { | ||
| echo __FUNCTION__; | ||
| } | ||
| } | ||
|
|
||
| $factory = new \ProxyManager\Factory\LazyLoadingGhostFactory($configuration); | ||
|
|
||
| $init = function ($object, $method, $parameters, & $initializer) { | ||
| echo 'init'; | ||
| $initializer = null; | ||
| }; | ||
|
|
||
| $proxy = $factory->createProxy(Destructable::class, $init, ['skipDestructor' => true]); | ||
| echo "NO __destruct\n"; | ||
| unset($proxy); | ||
|
|
||
| $proxy = $factory->createProxy(Destructable::class, $init, ['skipDestructor' => true]); | ||
| echo 'DO '; | ||
| $proxy->triggerInit = true; | ||
| unset($proxy); | ||
|
|
||
| $proxy = $factory->createProxy(Destructable::class, $init); | ||
| echo "\nDO "; | ||
| unset($proxy); | ||
| ?> | ||
| --EXPECT-- | ||
| NO __destruct | ||
| DO init__destruct | ||
| DO __destruct |
40 changes: 40 additions & 0 deletions
40
tests/language-feature-scripts/lazy-loading-value-holder-skip-destructor.phpt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,40 @@ | ||
| --TEST-- | ||
| Verifies that generated lazy loading value holders can skip calling the proxied destructor | ||
| --FILE-- | ||
| <?php | ||
|
|
||
| require_once __DIR__ . '/init.php'; | ||
|
|
||
| class Destructable | ||
| { | ||
| public function __destruct() | ||
| { | ||
| echo __FUNCTION__; | ||
| } | ||
| } | ||
|
|
||
| $factory = new \ProxyManager\Factory\LazyLoadingValueHolderFactory($configuration); | ||
|
|
||
| $init = function (& $wrapped, $proxy, $method, $parameters, & $initializer) { | ||
| echo 'init'; | ||
| $wrapped = new Destructable(); | ||
| $initializer = null; | ||
| }; | ||
|
|
||
| $proxy = $factory->createProxy(Destructable::class, $init, ['skipDestructor' => true]); | ||
| echo "NO __destruct\n"; | ||
| unset($proxy); | ||
|
|
||
| $proxy = $factory->createProxy(Destructable::class, $init, ['skipDestructor' => true]); | ||
| echo "DO "; | ||
| $proxy->triggerInit = true; | ||
| unset($proxy); | ||
|
|
||
| $proxy = $factory->createProxy(Destructable::class, $init); | ||
| echo "\nDO "; | ||
| unset($proxy); | ||
| ?> | ||
| --EXPECT-- | ||
| NO __destruct | ||
| DO init__destruct__destruct | ||
| DO init__destruct__destruct |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nit: rename the option to "excludeDestructor" since that seems to be the internal wording.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not sure about this proposal: "exclude" here is used for a different thing.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
My thinking was that you're excluding the destructor from the list of proxied methods, but I defer to your (and @Ocramius') judgment on this 👍