<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Gets properties</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="reflectionclass.getparentclass.html">ReflectionClass::getParentClass</a></div>
<div class="next" style="text-align: right; float: right;"><a href="reflectionclass.getproperty.html">ReflectionClass::getProperty</a></div>
<div class="up"><a href="class.reflectionclass.html">ReflectionClass</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="reflectionclass.getproperties" class="refentry">
<div class="refnamediv">
<h1 class="refname">ReflectionClass::getProperties</h1>
<p class="verinfo">(PHP 5)</p><p class="refpurpose"><span class="refname">ReflectionClass::getProperties</span> — <span class="dc-title">Gets properties</span></p>
</div>
<div class="refsect1 description" id="refsect1-reflectionclass.getproperties-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">array</span> <span class="methodname"><strong>ReflectionClass::getProperties</strong></span>
([ <span class="methodparam"><span class="type">int</span> <code class="parameter">$filter</code></span>
] )</div>
<p class="para rdfs-comment">
Retrieves reflected properties.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-reflectionclass.getproperties-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">filter</code></em></span>
<dd>
<p class="para">
The optional filter, for filtering desired property types. It's configured using
the <a href="class.reflectionproperty.html#reflectionproperty.constants.modifiers" class="link">ReflectionProperty constants</a>,
and defaults to all property types.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-reflectionclass.getproperties-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
An array of <a href="class.reflectionproperty.html" class="classname">ReflectionProperty</a> objects.
</p>
</div>
<div class="refsect1 examples" id="refsect1-reflectionclass.getproperties-examples">
<h3 class="title">Examples</h3>
<div class="example" id="reflectionclass.getproperties.example.filter">
<p><strong>Example #1 <span class="function"><strong>ReflectionClass::getProperties()</strong></span> filtering example</strong></p>
<div class="example-contents"><p>
This example demonstrates usage of the optional <em><code class="parameter">filter</code></em>
parameter, where it essentially skips private properties.
</p></div>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /></span><span style="color: #007700">class </span><span style="color: #0000BB">Foo </span><span style="color: #007700">{<br /> public </span><span style="color: #0000BB">$foo </span><span style="color: #007700">= </span><span style="color: #0000BB">1</span><span style="color: #007700">;<br /> protected </span><span style="color: #0000BB">$bar </span><span style="color: #007700">= </span><span style="color: #0000BB">2</span><span style="color: #007700">;<br /> private </span><span style="color: #0000BB">$baz </span><span style="color: #007700">= </span><span style="color: #0000BB">3</span><span style="color: #007700">;<br />}<br /><br /></span><span style="color: #0000BB">$foo </span><span style="color: #007700">= new </span><span style="color: #0000BB">Foo</span><span style="color: #007700">();<br /><br /></span><span style="color: #0000BB">$reflect </span><span style="color: #007700">= new </span><span style="color: #0000BB">ReflectionClass</span><span style="color: #007700">(</span><span style="color: #0000BB">$foo</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$props </span><span style="color: #007700">= </span><span style="color: #0000BB">$reflect</span><span style="color: #007700">-></span><span style="color: #0000BB">getProperties</span><span style="color: #007700">(</span><span style="color: #0000BB">ReflectionProperty</span><span style="color: #007700">::</span><span style="color: #0000BB">IS_PUBLIC </span><span style="color: #007700">| </span><span style="color: #0000BB">ReflectionProperty</span><span style="color: #007700">::</span><span style="color: #0000BB">IS_PROTECTED</span><span style="color: #007700">);<br /><br />foreach (</span><span style="color: #0000BB">$props </span><span style="color: #007700">as </span><span style="color: #0000BB">$prop</span><span style="color: #007700">) {<br /> print </span><span style="color: #0000BB">$prop</span><span style="color: #007700">-></span><span style="color: #0000BB">getName</span><span style="color: #007700">() . </span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br />}<br /><br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$props</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
<div class="example-contents"><p>The above example will output
something similar to:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
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"
}
}
</pre></div>
</div>
</div>
</div>
<div class="refsect1 seealso" id="refsect1-reflectionclass.getproperties-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="methodname"><a href="reflectionclass.getproperty.html" class="methodname" rel="rdfs-seeAlso">ReflectionClass::getProperty()</a> - Gets a ReflectionProperty for a class's property</span></li>
<li class="member"><a href="class.reflectionproperty.html" class="classname">ReflectionProperty</a></li>
<li class="member"><a href="class.reflectionproperty.html#reflectionproperty.constants.modifiers" class="link">ReflectionProperty modifier constants</a></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="reflectionclass.getparentclass.html">ReflectionClass::getParentClass</a></div>
<div class="next" style="text-align: right; float: right;"><a href="reflectionclass.getproperty.html">ReflectionClass::getProperty</a></div>
<div class="up"><a href="class.reflectionclass.html">ReflectionClass</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
