PHP: Hypertext Preprocessor (original) (raw)
ReflectionClass::getProperties
(PHP 5, PHP 7, PHP 8)
ReflectionClass::getProperties — Gets properties
Description
public ReflectionClass::getProperties(?int $filter = [null](reserved.constants.php#constant.null)): array
Parameters
filter
The optional filter, for filtering desired property types. It's configured using the ReflectionProperty constants, and defaults to all property types.
Changelog
| Version | Description |
|---|---|
| 7.2.0 | filter is nullable now. |
Examples
Example #1 ReflectionClass::getProperties() filtering example
This example demonstrates usage of the optional filter parameter, where it essentially skips private properties.
`<?php
class Foo {
public $foo = 1;
protected $bar = 2;
private $baz = 3;
}$foo = new Foo();$reflect = new ReflectionClass($foo); props=props = props=reflect->getProperties(ReflectionProperty::IS_PUBLIC | ReflectionProperty::IS_PROTECTED);
foreach (
propsasprops as propsasprop) {
print $prop->getName() . "\n";
}var_dump($props);?>`
The above example will output something similar to:
foo bar array(2) { [0]=> object(ReflectionProperty)#3 (2) { ["name"]=> string(3) "foo" ["class"]=> string(3) "Foo" } [1]=> object(ReflectionProperty)#4 (2) { ["name"]=> string(3) "bar" ["class"]=> string(3) "Foo" } }
See Also
- ReflectionClass::getProperty() - Gets a ReflectionProperty for a class's property
- ReflectionProperty
- ReflectionProperty modifier constants
Found A Problem?
7 years ago
`Note that inherited properties are returned, but no private properties of parent classes. Depending on the use case, you need to check that, too.
do {
foreach ($reflectionClass->getProperties() as $property) {
/* ... */
}
} while ($reflectionClass = $reflectionClass->getParentClass());
`
postmaster at greg0ire dot fr ¶
10 years ago
`The code in the first example actually does get inherited properties with at least php 5.5.9 . I don't know if / when this behavior changed.
Here is the output:
array(2) {
[0] =>
class ReflectionProperty#2 (2) {
public $name =>
string(2) "a2"
public $class =>
string(2) "AA"
}
[1] =>
class ReflectionProperty#3 (2) {
public $name =>
string(2) "a1"
public $class =>
string(1) "A"
}
}
`
16 years ago
`Some may find this useful.
ReflectionProperty() object * including inherited ones from extended classes * @param string $className Class name * @param string $types Any combination of public, private, protected, static * @return array */ function getClassProperties($className, $types='public'){ ref=newReflectionClass(ref = new ReflectionClass(ref=newReflectionClass(className); props=props = props=ref->getProperties(); $props_arr = array(); foreach($props as $prop){ f=f = f=prop->getName(); if( prop−>isPublic()and(stripos(prop->isPublic() and (stripos(prop−>isPublic()and(stripos(types, 'public') === FALSE)) continue; if($prop->isPrivate() and (stripos($types, 'private') === FALSE)) continue; if($prop->isProtected() and (stripos($types, 'protected') === FALSE)) continue; if($prop->isStatic() and (stripos($types, 'static') === FALSE)) continue;$props_arr[$f] = $prop; } if($parentClass = $ref->getParentClass()){ parentpropsarr=getClassProperties(parent_props_arr = getClassProperties(parentpropsarr=getClassProperties(parentClass->getName());//RECURSION if(count($parent_props_arr) > 0) propsarr=arraymerge(props_arr = array_merge(propsarr=arraymerge(parent_props_arr, $props_arr); } return $props_arr; }//USAGEclass A{ public $a1; function abc(){ //do something } } class AA extends A{ public $a2; function edf(){ //do something } } class AAA extends AA{ //may not have extra properties, but may have extra methods function ghi(){ //ok } }//$ref = new ReflectionClass('AAA'); props=props = props=ref->getProperties();//This will get no properties! $props_arr = getClassProperties('AAA', 'public');//Use this var_dump($props_arr); /* OUTPUT on PHP5.2.6: array 'a1' => object(ReflectionProperty)[4] public 'name' => string 'a1' (length=2) public 'class' => string 'AAA' (length=3) 'a2' => object(ReflectionProperty)[3] public 'name' => string 'a2' (length=2) public 'class' => string 'AAA' (length=3) */ ?>`
16 years ago
It should be noted that the 'filter' parameter in the getProperties(filter) method is expected to be of type long. Not sure why, but it doesn't function as a way of passing in a string to fetch a subset of properties by string match.
14 years ago
`Looks like you can access public, protected, private variables by casting the object to an array (useful for Unit Testing). However casting to an array still won't allow you access to protected and private static variables.
In PHP 5.3.0+ use ReflectionProperty::setAccessable(true);
obj=newFoo;obj = new Foo;obj=newFoo;arr = (array)$obj;print_r($arr); echo "Accessing Public Static: ".Foo::$sfoo."\n"; // echo Foo::$sbar."\n"; // Fatal error: Cannot access protected property Foo::$sbar // echo Foo::$sbaz."\n"; // Fatal error: Cannot access private property Foo::$sbaz echo "Accessing Constant: ".Foo::COO."\n"; ?>PHP Version: 5.2.12
Array
(
[foo] => public
[*bar] => protected
[Foobaz] => private
)
Accessing Public Static: public static
Accessing Constant: const
PHP Version: 5.1.6
Array
(
[foo] => public
[*bar] => protected
[Foobaz] => private
)
Accessing Public Static: public static
Accessing Constant: const
`
david dot thalmann at gmail dot com ¶
16 years ago
`With PHP 5.3 protected or private properties are easy to access with setAccessible(). However, it's sometimes needed (e.g. Unit Tests) and here is a workaround for getValue():
props=props = props=class->getProperties(); // propsStatic=propsStatic = propsStatic=class->getStaticProperties();$myPrivatePropertyValue = $props['aPrivateProperty'];?>Note that it wont work if you access the property directly with getProperty().
`