PHP - Manual: ReflectionClass::getProperties

2024-11-15

ReflectionClass::getProperty »

« ReflectionClass::getParentClass

ReflectionClass::getProperties

(PHP 5, PHP 7, PHP 8)

ReflectionClass::getProperties — 获取一组属性

说明

public ReflectionClass::getProperties(int $filter = ?): array

获取反射过的属性。

参数

filter: 可选的过滤器，过滤为所需类型的属性。它使用 ReflectionProperty 常量来配置，默认获取所有类型的属性。

返回值

ReflectionProperty 对象的数组。

范例

示例 #1 ReflectionClass::getProperties() 过滤例子

这个例子延时了可选 filter 参数的用法，例子里实际上忽略了私有属性。


<?php
class Foo {
    public    $foo  = 1;
    protected $bar  = 2;
    private   $baz  = 3;
}

$foo = new Foo();

$reflect = new ReflectionClass($foo);
$props   = $reflect->getProperties(ReflectionProperty::IS_PUBLIC | ReflectionProperty::IS_PROTECTED);

foreach ($props as $prop) {
    print $prop->getName() . "\n";
}

var_dump($props);

?>

以上例程的输出类似于：

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"
  }
}

参见

ReflectionClass::getProperty() - 获取类的一个属性的 ReflectionProperty
ReflectionProperty
ReflectionProperty 修饰符常量

add a note

User Contributed Notes 6 notes

down

kelunik at php dot net ¶

4 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());

down

muratyaman at gmail dot com ¶

13 years ago


Some may find this useful.


<?php

/**

 * Recursive function to get an associative array of class properties by property name => ReflectionProperty() object

 * including inherited ones from extended classes

 * @param string $className Class name

 * @param string $types Any combination of <b>public, private, protected, static</b>

 * @return array

 */

function getClassProperties($className, $types='public'){

    $ref = new ReflectionClass($className);

    $props = $ref->getProperties();

    $props_arr = array();

    foreach($props as $prop){

        $f = $prop->getName();

        

        if($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()){

        $parent_props_arr = getClassProperties($parentClass->getName());//RECURSION

        if(count($parent_props_arr) > 0)

            $props_arr = array_merge($parent_props_arr, $props_arr);

    }

    return $props_arr;

}


//USAGE


class 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 = $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)


*/


?>

down

postmaster at greg0ire dot fr ¶

7 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"
     }
    }

down

-3

mcurtis ¶

13 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.

down

-5

Yzmir Ramirez ¶

11 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);

<?php

echo "PHP Version: ".phpversion()."\n";

class Foo {
    public    $foo  = 'public';
    protected $bar  = 'protected';
    private   $baz  = 'private';

    public static    $sfoo  = 'public static';
    protected static $sbar  = 'protected static';
    private static   $sbaz  = 'private static';

    const COO = 'const';

}

$obj = new Foo;

$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

down

-5

david dot thalmann at gmail dot com ¶

13 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():


<?php


$class = new ReflectionClass('SomeClass');

$props = $class->getProperties();

// $propsStatic = $class->getStaticProperties();


$myPrivatePropertyValue = $props['aPrivateProperty'];


?>



Note that it wont work if you access the property directly with getProperty().

add a note

官方地址：https://www.php.net/manual/en/reflectionclass.getproperties.php

有任何技术问题请点击这里网站运营推广招聘

IT PHP 编程语言 Linux 开发编程科技 Elasticsearch HTML/CSS/XML 网络 JAVA NoSQL 数据库面试 C/C++ Golang Git 算法操作系统正则表达式 Redis 互联网 MySql JavaScript 运维软件国际架构设计 Mac OS TCP/IP Excel Vim Windows Socket Oracle VR MongoDB Python 运营 MemCache 商业硬件电子娱乐设计 nginx 摄影游戏 WordPress HTTP 团建数码电器

php7 安装fileinfo扩展 preg_split — 通过一个正则表达式分隔字符串 php位值,解决 PHP 中 usort 在值相同时改变原始位置的问题 [PHP] inet_pton/inet_ntop IP地址转换函数 array_multisort() 多字段排序 PHPMailer设置utf8 PHPMailer字符集CharSet ADORecordSet对象 adodb手册 PHP 8.1 [鸟哥]PHP_INT_MIN 和 -9223372036854775808 opcache预加载 Composer的Packagist资源 mysql面试题 [鸟哥]PHP FFI详解 - 一种全新的PHP扩展方式 PHP7添加redis扩展 PHP获取指定函数定义在哪个文件中及行号 PHP mkdir()写出来的权限与mode值不符合 Packagist / Composer 中国全量镜像 adodb连接mysql多个数据库的问题常用的php ADODB使用方法集锦

略微加速

PHP官方手册 - 互联网笔记

ReflectionClass::getProperties

说明

参数

返回值

范例

参见

User Contributed Notes 6 notes