ReflectionClass::getProperties

(PHP 5, PHP 7)
Gets properties
public array ReflectionClass::getProperties ([ int $filter ] )

Retrieves reflected properties.

Parameters:
filter

The optional filter, for filtering desired property types. It's configured using the ReflectionProperty constants, and defaults to all property types.

Returns:

An array of ReflectionProperty objects.

Examples:
ReflectionClass::getProperties() filtering example

This example demonstrates usage of the optional filter parameter, where it essentially skips private properties.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
<?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);
 
?>

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

ReflectionProperty -

ReflectionProperty modifier constants -

doc_php
2025-01-10 15:47:30
Comments
Leave a Comment

Please login to continue.