Skip to content

Fix GH-15731: Prevent #[AllowDynamicProperties] on enums #15733

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Sep 4, 2024
Merged

Fix GH-15731: Prevent #[AllowDynamicProperties] on enums #15733

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions Zend/tests/allow_dynamic_properties_on_enum.phpt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
--TEST--
#[AllowDynamicProperties] cannot be applied to enum (GH-15731)
--FILE--
<?php

#[AllowDynamicProperties]
enum Test {}

?>
--EXPECTF--
Fatal error: Cannot apply #[AllowDynamicProperties] to enum Test in %s on line %d
5 changes: 5 additions & 0 deletions Zend/zend_attributes.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,11 @@ static void validate_allow_dynamic_properties(
ZSTR_VAL(scope->name)
);
}
if (scope->ce_flags & ZEND_ACC_ENUM) {
Copy link
Member

@kocsismate kocsismate Sep 4, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The change looks good on its own but I'm wondering whether it isn't an oversight of the enum RFC that attributes targeting classes are allowed for enums? It looks like to me that we should(n't have) allow(ed) this, so the best course of action would be to add a new target for enums, and only allow the usage if it's set.

cc @iluuu1994

Copy link
Member

@iluuu1994 iluuu1994 Sep 4, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's not an oversight. From the RFC:

https://wiki.php.net/rfc/enumerations

Enums and cases may have attributes attached to them, like any other language construct. The TARGET_CLASS target filter will include Enums themselves.

Enums are special classes, just like interfaces, traits, etc.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK, I see it now.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@kocsismate Do you have a special use-case for TARGET_ENUM? We considered it back then but it never came up again, so I assume use-cases are limited.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you have a special use-case for TARGET_ENUM? We considered it back then but it never came up again, so I assume use-cases are limited.

No, I don't have any... I just proposed this in order to be able to retain the original behavior if we prevented the usage of attributes targeting classes for enums. But I realized that it would already be a possibly serious BC break since userland attributes have already been relying on the current behavior. Sorry for the noise!

zend_error_noreturn(E_ERROR, "Cannot apply #[AllowDynamicProperties] to enum %s",
ZSTR_VAL(scope->name)
);
}
scope->ce_flags |= ZEND_ACC_ALLOW_DYNAMIC_PROPERTIES;
}

Expand Down
Loading