Skip to content

Add Reflection*::getAttribute(): ?ReflectionAttribute method #22092

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

Closed
vudaltsov wants to merge 1 commit into from
Closed

Add Reflection*::getAttribute(): ?ReflectionAttribute method #22092

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
179 changes: 179 additions & 0 deletions ext/reflection/php_reflection.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1314,6 +1314,59 @@ static zend_result read_attributes(zval *ret, HashTable *attributes, zend_class_
}
/* }}} */

static zend_result read_attribute(zval *ret, HashTable *attributes, zend_class_entry *scope,
uint32_t offset, uint32_t target, zend_string *name, zend_class_entry *base, zend_string *filename) /* {{{ */
{
ZEND_ASSERT(attributes != NULL);

zend_attribute *attr;

if (name) {
// Name based filtering using lowercased key.
zend_string *filter = zend_string_tolower(name);

ZEND_HASH_PACKED_FOREACH_PTR(attributes, attr) {
if (attr->offset == offset && zend_string_equals(attr->lcname, filter)) {
zend_string_release(filter);
reflection_attribute_factory(ret, attributes, attr, scope, target, filename);
return SUCCESS;
}
} ZEND_HASH_FOREACH_END();

zend_string_release(filter);
return SUCCESS;
}

ZEND_HASH_PACKED_FOREACH_PTR(attributes, attr) {
if (attr->offset != offset) {
continue;
}

if (base) {
// Base type filtering.
zend_class_entry *ce = zend_lookup_class_ex(attr->name, attr->lcname, 0);

if (ce == NULL) {
// Bailout on error, otherwise ignore unavailable class.
if (EG(exception)) {
return FAILURE;
}
continue;
}

if (!instanceof_function(ce, base)) {
continue;
}
}

reflection_attribute_factory(ret, attributes, attr, scope, target, filename);
return SUCCESS;
} ZEND_HASH_FOREACH_END();

return SUCCESS;
}
/* }}} */

static void reflect_attributes(INTERNAL_FUNCTION_PARAMETERS, HashTable *attributes,
uint32_t offset, zend_class_entry *scope, uint32_t target, zend_string *filename) /* {{{ */
{
Expand Down Expand Up @@ -1354,6 +1407,44 @@ static void reflect_attributes(INTERNAL_FUNCTION_PARAMETERS, HashTable *attribut
}
/* }}} */

static void reflect_attribute(INTERNAL_FUNCTION_PARAMETERS, HashTable *attributes,
uint32_t offset, zend_class_entry *scope, uint32_t target, zend_string *filename) /* {{{ */
{
zend_string *name = NULL;
zend_long flags = 0;
zend_class_entry *base = NULL;

if (zend_parse_parameters(ZEND_NUM_ARGS(), "|S!l", &name, &flags) == FAILURE) {
RETURN_THROWS();
}

if (flags & ~REFLECTION_ATTRIBUTE_IS_INSTANCEOF) {
zend_argument_value_error(2, "must be a valid attribute filter flag");
RETURN_THROWS();
}

if (name && (flags & REFLECTION_ATTRIBUTE_IS_INSTANCEOF)) {
if (NULL == (base = zend_lookup_class(name))) {
if (!EG(exception)) {
zend_throw_error(NULL, "Class \"%s\" not found", ZSTR_VAL(name));
}

RETURN_THROWS();
}

name = NULL;
}

if (!attributes) {
RETURN_NULL();
}

if (FAILURE == read_attribute(return_value, attributes, scope, offset, target, name, base, filename)) {
RETURN_THROWS();
}
}
/* }}} */

static void _zend_extension_string(smart_str *str, const zend_extension *extension, const char *indent) /* {{{ */
{
smart_str_append_printf(str, "%sZend Extension [ %s ", indent, extension->name);
Expand Down Expand Up @@ -2063,6 +2154,27 @@ ZEND_METHOD(ReflectionFunctionAbstract, getAttributes)
}
/* }}} */

/* {{{ Returns the first matching attribute of this function */
ZEND_METHOD(ReflectionFunctionAbstract, getAttribute)
{
reflection_object *intern;
zend_function *fptr;
uint32_t target;

GET_REFLECTION_OBJECT_PTR(fptr);

if (fptr->common.scope && (fptr->common.fn_flags & (ZEND_ACC_CLOSURE|ZEND_ACC_FAKE_CLOSURE)) != ZEND_ACC_CLOSURE) {
target = ZEND_ATTRIBUTE_TARGET_METHOD;
} else {
target = ZEND_ATTRIBUTE_TARGET_FUNCTION;
}

reflect_attribute(INTERNAL_FUNCTION_PARAM_PASSTHRU,
fptr->common.attributes, 0, fptr->common.scope, target,
fptr->type == ZEND_USER_FUNCTION ? fptr->op_array.filename : NULL);
}
/* }}} */

/* {{{ Returns an associative array containing this function's static variables and their values */
ZEND_METHOD(ReflectionFunctionAbstract, getStaticVariables)
{
Expand Down Expand Up @@ -2889,6 +3001,21 @@ ZEND_METHOD(ReflectionParameter, getAttributes)
param->fptr->type == ZEND_USER_FUNCTION ? param->fptr->op_array.filename : NULL);
}

ZEND_METHOD(ReflectionParameter, getAttribute)
{
reflection_object *intern;
parameter_reference *param;

GET_REFLECTION_OBJECT_PTR(param);

HashTable *attributes = param->fptr->common.attributes;
zend_class_entry *scope = param->fptr->common.scope;

reflect_attribute(INTERNAL_FUNCTION_PARAM_PASSTHRU,
attributes, param->offset + 1, scope, ZEND_ATTRIBUTE_TARGET_PARAMETER,
param->fptr->type == ZEND_USER_FUNCTION ? param->fptr->op_array.filename : NULL);
}

/* {{{ Returns the index of the parameter, starting from 0 */
ZEND_METHOD(ReflectionParameter, getPosition)
{
Expand Down Expand Up @@ -4037,6 +4164,18 @@ ZEND_METHOD(ReflectionClassConstant, getAttributes)
}
/* }}} */

ZEND_METHOD(ReflectionClassConstant, getAttribute)
{
reflection_object *intern;
zend_class_constant *ref;

GET_REFLECTION_OBJECT_PTR(ref);

reflect_attribute(INTERNAL_FUNCTION_PARAM_PASSTHRU,
ref->attributes, 0, ref->ce, ZEND_ATTRIBUTE_TARGET_CLASS_CONST,
ref->ce->type == ZEND_USER_CLASS ? ref->ce->info.user.filename : NULL);
}

ZEND_METHOD(ReflectionClassConstant, isEnumCase)
{
reflection_object *intern;
Expand Down Expand Up @@ -4442,6 +4581,18 @@ ZEND_METHOD(ReflectionClass, getAttributes)
}
/* }}} */

ZEND_METHOD(ReflectionClass, getAttribute)
{
reflection_object *intern;
zend_class_entry *ce;

GET_REFLECTION_OBJECT_PTR(ce);

reflect_attribute(INTERNAL_FUNCTION_PARAM_PASSTHRU,
ce->attributes, 0, ce, ZEND_ATTRIBUTE_TARGET_CLASS,
ce->type == ZEND_USER_CLASS ? ce->info.user.filename : NULL);
}

/* {{{ Returns the class' constructor if there is one, NULL otherwise */
ZEND_METHOD(ReflectionClass, getConstructor)
{
Expand Down Expand Up @@ -6390,6 +6541,22 @@ ZEND_METHOD(ReflectionProperty, getAttributes)
}
/* }}} */

ZEND_METHOD(ReflectionProperty, getAttribute)
{
reflection_object *intern;
property_reference *ref;

GET_REFLECTION_OBJECT_PTR(ref);

if (ref->prop == NULL) {
RETURN_NULL();
}

reflect_attribute(INTERNAL_FUNCTION_PARAM_PASSTHRU,
ref->prop->attributes, 0, ref->prop->ce, ZEND_ATTRIBUTE_TARGET_PROPERTY,
ref->prop->ce->type == ZEND_USER_CLASS ? ref->prop->ce->info.user.filename : NULL);
}

/* {{{ Sets whether non-public properties can be requested */
ZEND_METHOD(ReflectionProperty, setAccessible)
{
Expand Down Expand Up @@ -8148,6 +8315,18 @@ ZEND_METHOD(ReflectionConstant, getAttributes)
const_->filename);
}

ZEND_METHOD(ReflectionConstant, getAttribute)
{
reflection_object *intern;
zend_constant *const_;

GET_REFLECTION_OBJECT_PTR(const_);

reflect_attribute(INTERNAL_FUNCTION_PARAM_PASSTHRU,
const_->attributes, 0, NULL, ZEND_ATTRIBUTE_TARGET_CONST,
const_->filename);
}

ZEND_METHOD(ReflectionConstant, __toString)
{
reflection_object *intern;
Expand Down
12 changes: 12 additions & 0 deletions ext/reflection/php_reflection.stub.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,8 @@ public function hasTentativeReturnType(): bool {}
public function getTentativeReturnType(): ?ReflectionType {}

public function getAttributes(?string $name = null, int $flags = 0): array {}

public function getAttribute(?string $name = null, int $flags = 0): ?ReflectionAttribute {}
}

class ReflectionFunction extends ReflectionFunctionAbstract
Expand Down Expand Up @@ -436,6 +438,8 @@ public function getNamespaceName(): string {}
public function getShortName(): string {}

public function getAttributes(?string $name = null, int $flags = 0): array {}

public function getAttribute(?string $name = null, int $flags = 0): ?ReflectionAttribute {}
}

class ReflectionObject extends ReflectionClass
Expand Down Expand Up @@ -564,6 +568,8 @@ public function getDefaultValue(): mixed {}

public function getAttributes(?string $name = null, int $flags = 0): array {}

public function getAttribute(?string $name = null, int $flags = 0): ?ReflectionAttribute {}

public function hasHooks(): bool {}

/** @return array<string, ReflectionMethod> */
Expand Down Expand Up @@ -630,6 +636,8 @@ public function getDocComment(): string|false {}

public function getAttributes(?string $name = null, int $flags = 0): array {}

public function getAttribute(?string $name = null, int $flags = 0): ?ReflectionAttribute {}

public function isEnumCase(): bool {}

public function isDeprecated(): bool {}
Expand Down Expand Up @@ -720,6 +728,8 @@ public function isVariadic(): bool {}
public function isPromoted(): bool {}

public function getAttributes(?string $name = null, int $flags = 0): array {}

public function getAttribute(?string $name = null, int $flags = 0): ?ReflectionAttribute {}
}

/** @not-serializable */
Expand Down Expand Up @@ -940,4 +950,6 @@ public function getExtensionName(): string|false {}
public function __toString(): string {}

public function getAttributes(?string $name = null, int $flags = 0): array {}

public function getAttribute(?string $name = null, int $flags = 0): ?ReflectionAttribute {}
}
Loading
Loading