<!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>Construct a ReflectionProperty object</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="reflectionproperty.clone.html">ReflectionProperty::__clone</a></div>
<div class="next" style="text-align: right; float: right;"><a href="reflectionproperty.export.html">ReflectionProperty::export</a></div>
<div class="up"><a href="class.reflectionproperty.html">ReflectionProperty</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="reflectionproperty.construct" class="refentry">
<div class="refnamediv">
<h1 class="refname">ReflectionProperty::__construct</h1>
<p class="verinfo">(PHP 5)</p><p class="refpurpose"><span class="refname">ReflectionProperty::__construct</span> — <span class="dc-title">Construct a ReflectionProperty object</span></p>
</div>
<div class="refsect1 description" id="refsect1-reflectionproperty.construct-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="methodname"><strong>ReflectionProperty::__construct</strong></span>
( <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$class</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$name</code></span>
)</div>
<p class="para rdfs-comment">
</p>
<div class="warning"><strong class="warning">Warning</strong><p class="simpara">This function is
currently not documented; only its argument list is available.
</p></div>
</div>
<div class="refsect1 parameters" id="refsect1-reflectionproperty.construct-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">class</code></em></span>
<dd>
<p class="para">
The class name, that contains the property.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">name</code></em></span>
<dd>
<p class="para">
The name of the property being reflected.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-reflectionproperty.construct-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
No value is returned.
</p>
</div>
<div class="refsect1 errors" id="refsect1-reflectionproperty.construct-errors">
<h3 class="title">Errors/Exceptions</h3>
<p class="para">
Trying to get or set private or protected class property's values
will result in an exception being thrown.
</p>
</div>
<div class="refsect1 examples" id="refsect1-reflectionproperty.construct-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-5239">
<p><strong>Example #1 <span class="methodname"><strong>ReflectionProperty::__construct()</strong></span> example</strong></p>
<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">String<br /></span><span style="color: #007700">{<br /> public </span><span style="color: #0000BB">$length </span><span style="color: #007700">= </span><span style="color: #0000BB">5</span><span style="color: #007700">;<br />}<br /><br /></span><span style="color: #FF8000">// Create an instance of the ReflectionProperty class<br /></span><span style="color: #0000BB">$prop </span><span style="color: #007700">= new </span><span style="color: #0000BB">ReflectionProperty</span><span style="color: #007700">(</span><span style="color: #DD0000">'String'</span><span style="color: #007700">, </span><span style="color: #DD0000">'length'</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// Print out basic information<br /></span><span style="color: #0000BB">printf</span><span style="color: #007700">(<br /> </span><span style="color: #DD0000">"===> The%s%s%s%s property '%s' (which was %s)\n" </span><span style="color: #007700">.<br /> </span><span style="color: #DD0000">" having the modifiers %s\n"</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">$prop</span><span style="color: #007700">-></span><span style="color: #0000BB">isPublic</span><span style="color: #007700">() ? </span><span style="color: #DD0000">' public' </span><span style="color: #007700">: </span><span style="color: #DD0000">''</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">$prop</span><span style="color: #007700">-></span><span style="color: #0000BB">isPrivate</span><span style="color: #007700">() ? </span><span style="color: #DD0000">' private' </span><span style="color: #007700">: </span><span style="color: #DD0000">''</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">$prop</span><span style="color: #007700">-></span><span style="color: #0000BB">isProtected</span><span style="color: #007700">() ? </span><span style="color: #DD0000">' protected' </span><span style="color: #007700">: </span><span style="color: #DD0000">''</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">$prop</span><span style="color: #007700">-></span><span style="color: #0000BB">isStatic</span><span style="color: #007700">() ? </span><span style="color: #DD0000">' static' </span><span style="color: #007700">: </span><span style="color: #DD0000">''</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">$prop</span><span style="color: #007700">-></span><span style="color: #0000BB">getName</span><span style="color: #007700">(),<br /> </span><span style="color: #0000BB">$prop</span><span style="color: #007700">-></span><span style="color: #0000BB">isDefault</span><span style="color: #007700">() ? </span><span style="color: #DD0000">'declared at compile-time' </span><span style="color: #007700">: </span><span style="color: #DD0000">'created at run-time'</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">var_export</span><span style="color: #007700">(</span><span style="color: #0000BB">Reflection</span><span style="color: #007700">::</span><span style="color: #0000BB">getModifierNames</span><span style="color: #007700">(</span><span style="color: #0000BB">$prop</span><span style="color: #007700">-></span><span style="color: #0000BB">getModifiers</span><span style="color: #007700">()), </span><span style="color: #0000BB">1</span><span style="color: #007700">)<br />);<br /><br /></span><span style="color: #FF8000">// Create an instance of String<br /></span><span style="color: #0000BB">$obj</span><span style="color: #007700">= new </span><span style="color: #0000BB">String</span><span style="color: #007700">();<br /><br /></span><span style="color: #FF8000">// Get current value<br /></span><span style="color: #0000BB">printf</span><span style="color: #007700">(</span><span style="color: #DD0000">"---> Value is: "</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$prop</span><span style="color: #007700">-></span><span style="color: #0000BB">getValue</span><span style="color: #007700">(</span><span style="color: #0000BB">$obj</span><span style="color: #007700">));<br /><br /></span><span style="color: #FF8000">// Change value<br /></span><span style="color: #0000BB">$prop</span><span style="color: #007700">-></span><span style="color: #0000BB">setValue</span><span style="color: #007700">(</span><span style="color: #0000BB">$obj</span><span style="color: #007700">, </span><span style="color: #0000BB">10</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">printf</span><span style="color: #007700">(</span><span style="color: #DD0000">"---> Setting value to 10, new value is: "</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$prop</span><span style="color: #007700">-></span><span style="color: #0000BB">getValue</span><span style="color: #007700">(</span><span style="color: #0000BB">$obj</span><span style="color: #007700">));<br /><br /></span><span style="color: #FF8000">// Dump object<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$obj</span><span style="color: #007700">);<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>
===> The public property 'length' (which was declared at compile-time)
having the modifiers array (
0 => 'public',
)
---> Value is: int(5)
---> Setting value to 10, new value is: int(10)
object(String)#2 (1) {
["length"]=>
int(10)
}
</pre></div>
</div>
</div>
<div class="example" id="example-5240">
<p><strong>Example #2 Getting value from private and protected properties using <a href="class.reflectionproperty.html" class="classname">ReflectionProperty</a> class</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /><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">$x </span><span style="color: #007700">= </span><span style="color: #0000BB">1</span><span style="color: #007700">;<br /> protected </span><span style="color: #0000BB">$y </span><span style="color: #007700">= </span><span style="color: #0000BB">2</span><span style="color: #007700">;<br /> private </span><span style="color: #0000BB">$z </span><span style="color: #007700">= </span><span style="color: #0000BB">3</span><span style="color: #007700">;<br />}<br /><br /></span><span style="color: #0000BB">$obj </span><span style="color: #007700">= new </span><span style="color: #0000BB">Foo</span><span style="color: #007700">;<br /><br /></span><span style="color: #0000BB">$prop </span><span style="color: #007700">= new </span><span style="color: #0000BB">ReflectionProperty</span><span style="color: #007700">(</span><span style="color: #DD0000">'Foo'</span><span style="color: #007700">, </span><span style="color: #DD0000">'y'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$prop</span><span style="color: #007700">-></span><span style="color: #0000BB">setAccessible</span><span style="color: #007700">(</span><span style="color: #0000BB">true</span><span style="color: #007700">); </span><span style="color: #FF8000">/* As of PHP 5.3.0 */<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$prop</span><span style="color: #007700">-></span><span style="color: #0000BB">getValue</span><span style="color: #007700">(</span><span style="color: #0000BB">$obj</span><span style="color: #007700">)); </span><span style="color: #FF8000">// int(2)<br /><br /></span><span style="color: #0000BB">$prop </span><span style="color: #007700">= new </span><span style="color: #0000BB">ReflectionProperty</span><span style="color: #007700">(</span><span style="color: #DD0000">'Foo'</span><span style="color: #007700">, </span><span style="color: #DD0000">'z'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$prop</span><span style="color: #007700">-></span><span style="color: #0000BB">setAccessible</span><span style="color: #007700">(</span><span style="color: #0000BB">true</span><span style="color: #007700">); </span><span style="color: #FF8000">/* As of PHP 5.3.0 */<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$prop</span><span style="color: #007700">-></span><span style="color: #0000BB">getValue</span><span style="color: #007700">(</span><span style="color: #0000BB">$obj</span><span style="color: #007700">)); </span><span style="color: #FF8000">// int(2)<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>
int(2)
int(3)
</pre></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-reflectionproperty.construct-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="methodname"><a href="reflectionproperty.getname.html" class="methodname" rel="rdfs-seeAlso">ReflectionProperty::getName()</a> - Gets property name</span></li>
<li class="member"><a href="language.oop5.decon.html#language.oop5.decon.constructor" class="link">Constructors</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="reflectionproperty.clone.html">ReflectionProperty::__clone</a></div>
<div class="next" style="text-align: right; float: right;"><a href="reflectionproperty.export.html">ReflectionProperty::export</a></div>
<div class="up"><a href="class.reflectionproperty.html">ReflectionProperty</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
