Skip to content

Reflection param renames amendment #6230

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
wants to merge 3 commits into from
Closed

Reflection param renames amendment #6230

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3dfbd22
Reflection param renames amendment
kocsismate Sep 28, 2020
5ed837c
Make the $modifiers parameter of ReflectionClass::get*Constants() nul…
kocsismate Sep 29, 2020
3913b34
Address review
kocsismate Sep 29, 2020
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
22 changes: 16 additions & 6 deletions ext/reflection/php_reflection.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4190,7 +4190,7 @@ ZEND_METHOD(ReflectionClass, getMethods)
reflection_object *intern;
zend_class_entry *ce;
zend_function *mptr;
zend_long filter = 0;
zend_long filter;
zend_bool filter_is_null = 1;

if (zend_parse_parameters(ZEND_NUM_ARGS(), "|l!", &filter, &filter_is_null) == FAILURE) {
Expand Down Expand Up @@ -4366,7 +4366,7 @@ ZEND_METHOD(ReflectionClass, getProperties)
zend_class_entry *ce;
zend_string *key;
zend_property_info *prop_info;
zend_long filter = 0;
zend_long filter;
zend_bool filter_is_null = 1;

if (zend_parse_parameters(ZEND_NUM_ARGS(), "|l!", &filter, &filter_is_null) == FAILURE) {
Expand Down Expand Up @@ -4422,12 +4422,17 @@ ZEND_METHOD(ReflectionClass, getConstants)
zend_string *key;
zend_class_constant *constant;
zval val;
zend_long filter = ZEND_ACC_PPP_MASK;
zend_long filter;
zend_bool filter_is_null = 1;

if (zend_parse_parameters(ZEND_NUM_ARGS(), "|l", &filter) == FAILURE) {
if (zend_parse_parameters(ZEND_NUM_ARGS(), "|l!", &filter, &filter_is_null) == FAILURE) {
Copy link
Member Author

Choose a reason for hiding this comment

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

I made these params nullable because the previous default value was horrible, there were precedents for doing so before (e.g. ReflectionClass:getMethods())

RETURN_THROWS();
}

if (filter_is_null) {
filter = ZEND_ACC_PPP_MASK;
}

GET_REFLECTION_OBJECT_PTR(ce);

array_init(return_value);
Expand All @@ -4452,12 +4457,17 @@ ZEND_METHOD(ReflectionClass, getReflectionConstants)
zend_class_entry *ce;
zend_string *name;
zend_class_constant *constant;
zend_long filter = ZEND_ACC_PPP_MASK;
zend_long filter;
zend_bool filter_is_null = 1;

if (zend_parse_parameters(ZEND_NUM_ARGS(), "|l", &filter) == FAILURE) {
if (zend_parse_parameters(ZEND_NUM_ARGS(), "|l!", &filter, &filter_is_null) == FAILURE) {
RETURN_THROWS();
}

if (filter_is_null) {
filter = ZEND_ACC_PPP_MASK;
}

GET_REFLECTION_OBJECT_PTR(ce);

array_init(return_value);
Expand Down
12 changes: 6 additions & 6 deletions ext/reflection/php_reflection.stub.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -194,7 +194,7 @@ public function getDeclaringClass() {}
public function getPrototype() {}

/** @return void */
public function setAccessible(bool $isAccessible) {}
public function setAccessible(bool $accessible) {}
}

class ReflectionClass implements Reflector
Expand Down Expand Up @@ -260,10 +260,10 @@ public function getProperties(?int $filter = null) {}
public function hasConstant(string $name) {}

/** @return array|null */
public function getConstants(int $filter = ReflectionClassConstant::IS_PUBLIC | ReflectionClassConstant::IS_PROTECTED | ReflectionClassConstant::IS_PRIVATE) {}
public function getConstants(?int $filter = null) {}

/** @return ReflectionClassConstant[] */
public function getReflectionConstants(int $filter = ReflectionClassConstant::IS_PUBLIC | ReflectionClassConstant::IS_PROTECTED | ReflectionClassConstant::IS_PRIVATE) {}
public function getReflectionConstants(?int $filter = null) {}

/** @return mixed */
public function getConstant(string $name) {}
Expand Down Expand Up @@ -364,7 +364,7 @@ public function getAttributes(?string $name = null, int $flags = 0): array {}

class ReflectionObject extends ReflectionClass
{
public function __construct(object $argument) {}
public function __construct(object $object) {}
}

class ReflectionProperty implements Reflector
Expand Down Expand Up @@ -415,7 +415,7 @@ public function getDeclaringClass() {}
public function getDocComment() {}

/** @return void */
public function setAccessible(bool $isAccessible) {}
public function setAccessible(bool $accessible) {}

/** @return ReflectionType|null */
public function getType() {}
Expand Down Expand Up @@ -475,7 +475,7 @@ class ReflectionParameter implements Reflector
final private function __clone() {}

/** @param string|array|object $function */
public function __construct($function, int|string $parameter) {}
public function __construct($function, int|string $param) {}

public function __toString(): string {}

Expand Down
16 changes: 6 additions & 10 deletions ext/reflection/php_reflection_arginfo.h
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/* This is a generated file, edit the .stub.php file instead.
* Stub hash: 35e17de0cdf6c11a315f6d10fd711492d1da567c */
* Stub hash: 4429ea0f96f81c3dbfb2a7e6e00ce49aea4bfeb1 */

ZEND_BEGIN_ARG_INFO_EX(arginfo_class_Reflection_getModifierNames, 0, 0, 1)
ZEND_ARG_TYPE_INFO(0, modifiers, IS_LONG, 0)
Expand Down Expand Up @@ -144,7 +144,7 @@ ZEND_END_ARG_INFO()
#define arginfo_class_ReflectionMethod_getPrototype arginfo_class_ReflectionFunctionAbstract___clone

ZEND_BEGIN_ARG_INFO_EX(arginfo_class_ReflectionMethod_setAccessible, 0, 0, 1)
ZEND_ARG_TYPE_INFO(0, isAccessible, _IS_BOOL, 0)
ZEND_ARG_TYPE_INFO(0, accessible, _IS_BOOL, 0)
ZEND_END_ARG_INFO()

#define arginfo_class_ReflectionClass___clone arginfo_class_ReflectionFunctionAbstract___clone
Expand Down Expand Up @@ -195,11 +195,9 @@ ZEND_END_ARG_INFO()

#define arginfo_class_ReflectionClass_hasConstant arginfo_class_ReflectionClass_hasMethod

ZEND_BEGIN_ARG_INFO_EX(arginfo_class_ReflectionClass_getConstants, 0, 0, 0)
ZEND_ARG_TYPE_INFO_WITH_DEFAULT_VALUE(0, filter, IS_LONG, 0, "ReflectionClassConstant::IS_PUBLIC | ReflectionClassConstant::IS_PROTECTED | ReflectionClassConstant::IS_PRIVATE")
ZEND_END_ARG_INFO()
#define arginfo_class_ReflectionClass_getConstants arginfo_class_ReflectionClass_getMethods

#define arginfo_class_ReflectionClass_getReflectionConstants arginfo_class_ReflectionClass_getConstants
#define arginfo_class_ReflectionClass_getReflectionConstants arginfo_class_ReflectionClass_getMethods

#define arginfo_class_ReflectionClass_getConstant arginfo_class_ReflectionClass_hasMethod

Expand Down Expand Up @@ -277,9 +275,7 @@ ZEND_END_ARG_INFO()

#define arginfo_class_ReflectionClass_getAttributes arginfo_class_ReflectionFunctionAbstract_getAttributes

ZEND_BEGIN_ARG_INFO_EX(arginfo_class_ReflectionObject___construct, 0, 0, 1)
ZEND_ARG_TYPE_INFO(0, argument, IS_OBJECT, 0)
ZEND_END_ARG_INFO()
#define arginfo_class_ReflectionObject___construct arginfo_class_ReflectionClass_isInstance

#define arginfo_class_ReflectionProperty___clone arginfo_class_ReflectionFunctionAbstract___clone

Expand Down Expand Up @@ -363,7 +359,7 @@ ZEND_END_ARG_INFO()

ZEND_BEGIN_ARG_INFO_EX(arginfo_class_ReflectionParameter___construct, 0, 0, 2)
ZEND_ARG_INFO(0, function)
ZEND_ARG_TYPE_MASK(0, parameter, MAY_BE_LONG|MAY_BE_STRING, NULL)
ZEND_ARG_TYPE_MASK(0, param, MAY_BE_LONG|MAY_BE_STRING, NULL)
ZEND_END_ARG_INFO()

#define arginfo_class_ReflectionParameter___toString arginfo_class_ReflectionFunction___toString
Expand Down
4 changes: 2 additions & 2 deletions ext/reflection/tests/ReflectionClass_toString_001.phpt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -166,14 +166,14 @@ Class [ <internal:Reflection> class ReflectionClass implements Reflector, String
Method [ <internal:Reflection> public method getConstants ] {

- Parameters [1] {
Parameter #0 [ <optional> int $filter = ReflectionClassConstant::IS_PUBLIC | ReflectionClassConstant::IS_PROTECTED | ReflectionClassConstant::IS_PRIVATE ]
Parameter #0 [ <optional> ?int $filter = null ]
}
}

Method [ <internal:Reflection> public method getReflectionConstants ] {

- Parameters [1] {
Parameter #0 [ <optional> int $filter = ReflectionClassConstant::IS_PUBLIC | ReflectionClassConstant::IS_PROTECTED | ReflectionClassConstant::IS_PRIVATE ]
Parameter #0 [ <optional> ?int $filter = null ]
}
}

Expand Down
2 changes: 1 addition & 1 deletion ext/reflection/tests/parameters_001.phpt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,4 +39,4 @@ int(1)
bool(false)
bool(true)
string(54) "The parameter specified by its name could not be found"
string(95) "ReflectionParameter::__construct(): Argument #2 ($parameter) must be greater than or equal to 0"
string(91) "ReflectionParameter::__construct(): Argument #2 ($param) must be greater than or equal to 0"