<!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>Get the default properties of the class</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.get-class-methods.html">get_class_methods</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.get-class.html">get_class</a></div>
<div class="up"><a href="ref.classobj.html">Classes/Object Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.get-class-vars" class="refentry">
<div class="refnamediv">
<h1 class="refname">get_class_vars</h1>
<p class="verinfo">(PHP 4, PHP 5)</p><p class="refpurpose"><span class="refname">get_class_vars</span> — <span class="dc-title">Get the default properties of the class</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.get-class-vars-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">array</span> <span class="methodname"><strong>get_class_vars</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$class_name</code></span>
)</div>
<p class="para rdfs-comment">
Get the default properties of the given class.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.get-class-vars-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">class_name</code></em></span>
<dd>
<p class="para">
The class name
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.get-class-vars-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns an associative array of declared properties visible from the
current scope, with their default value.
The resulting array elements are in the form of
<em>varname => value</em>.
In case of an error, it returns <strong><code>FALSE</code></strong>.
</p>
</div>
<div class="refsect1 changelog" id="refsect1-function.get-class-vars-changelog">
<h3 class="title">Changelog</h3>
<p class="para">
<table class="doctable informaltable">
<thead>
<tr>
<th>Version</th>
<th>Description</th>
</tr>
</thead>
<tbody class="tbody">
<tr>
<td>5.0.3</td>
<td>
Depending on the scope, <span class="function"><strong>get_class_vars()</strong></span> will
only return the properties that can be accessed from the current
scope.
</td>
</tr>
<tr>
<td>5.0.2</td>
<td>
Calling <span class="function"><strong>get_class_vars()</strong></span> will now expose
all the properties as an array, unlike previous behaviour where
protected and private properties were prefixed with nul bytes.
</td>
</tr>
<tr>
<td>5.0.1</td>
<td>
Calling <span class="function"><strong>get_class_vars()</strong></span> will expose all
properties, as when converting an object to a class.
</td>
</tr>
<tr>
<td>4.2.0</td>
<td>
Uninitialized class variables are now also reported by
<span class="function"><strong>get_class_vars()</strong></span>.
</td>
</tr>
</tbody>
</table>
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.get-class-vars-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-5049">
<p><strong>Example #1 <span class="function"><strong>get_class_vars()</strong></span> example</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">myclass </span><span style="color: #007700">{<br /><br /> var </span><span style="color: #0000BB">$var1</span><span style="color: #007700">; </span><span style="color: #FF8000">// this has no default value...<br /> </span><span style="color: #007700">var </span><span style="color: #0000BB">$var2 </span><span style="color: #007700">= </span><span style="color: #DD0000">"xyz"</span><span style="color: #007700">;<br /> var </span><span style="color: #0000BB">$var3 </span><span style="color: #007700">= </span><span style="color: #0000BB">100</span><span style="color: #007700">;<br /> private </span><span style="color: #0000BB">$var4</span><span style="color: #007700">; </span><span style="color: #FF8000">// PHP 5<br /><br /> // constructor<br /> </span><span style="color: #007700">function </span><span style="color: #0000BB">myclass</span><span style="color: #007700">() {<br /> </span><span style="color: #FF8000">// change some properties<br /> </span><span style="color: #0000BB">$this</span><span style="color: #007700">-></span><span style="color: #0000BB">var1 </span><span style="color: #007700">= </span><span style="color: #DD0000">"foo"</span><span style="color: #007700">;<br /> </span><span style="color: #0000BB">$this</span><span style="color: #007700">-></span><span style="color: #0000BB">var2 </span><span style="color: #007700">= </span><span style="color: #DD0000">"bar"</span><span style="color: #007700">;<br /> return </span><span style="color: #0000BB">true</span><span style="color: #007700">;<br /> }<br /><br />}<br /><br /></span><span style="color: #0000BB">$my_class </span><span style="color: #007700">= new </span><span style="color: #0000BB">myclass</span><span style="color: #007700">();<br /><br /></span><span style="color: #0000BB">$class_vars </span><span style="color: #007700">= </span><span style="color: #0000BB">get_class_vars</span><span style="color: #007700">(</span><span style="color: #0000BB">get_class</span><span style="color: #007700">(</span><span style="color: #0000BB">$my_class</span><span style="color: #007700">));<br /><br />foreach (</span><span style="color: #0000BB">$class_vars </span><span style="color: #007700">as </span><span style="color: #0000BB">$name </span><span style="color: #007700">=> </span><span style="color: #0000BB">$value</span><span style="color: #007700">) {<br /> echo </span><span style="color: #DD0000">"</span><span style="color: #0000BB">$name</span><span style="color: #DD0000"> : </span><span style="color: #0000BB">$value</span><span style="color: #DD0000">\n"</span><span style="color: #007700">;<br />}<br /><br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
<div class="example-contents"><p>The above example will output:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
// Before PHP 4.2.0
var2 : xyz
var3 : 100
// As of PHP 4.2.0
var1 :
var2 : xyz
var3 : 100
</pre></div>
</div>
</div>
</p>
<p class="para">
<div class="example" id="example-5050">
<p><strong>Example #2 <span class="function"><strong>get_class_vars()</strong></span> and scoping behaviour</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">function </span><span style="color: #0000BB">format</span><span style="color: #007700">(</span><span style="color: #0000BB">$array</span><span style="color: #007700">)<br />{<br /> return </span><span style="color: #0000BB">implode</span><span style="color: #007700">(</span><span style="color: #DD0000">'|'</span><span style="color: #007700">, </span><span style="color: #0000BB">array_keys</span><span style="color: #007700">(</span><span style="color: #0000BB">$array</span><span style="color: #007700">)) . </span><span style="color: #DD0000">"\r\n"</span><span style="color: #007700">;<br />}<br /><br />class </span><span style="color: #0000BB">TestCase<br /></span><span style="color: #007700">{<br /> public </span><span style="color: #0000BB">$a </span><span style="color: #007700">= </span><span style="color: #0000BB">1</span><span style="color: #007700">;<br /> protected </span><span style="color: #0000BB">$b </span><span style="color: #007700">= </span><span style="color: #0000BB">2</span><span style="color: #007700">;<br /> private </span><span style="color: #0000BB">$c </span><span style="color: #007700">= </span><span style="color: #0000BB">3</span><span style="color: #007700">;<br /><br /> public static function </span><span style="color: #0000BB">expose</span><span style="color: #007700">()<br /> {<br /> echo </span><span style="color: #0000BB">format</span><span style="color: #007700">(</span><span style="color: #0000BB">get_class_vars</span><span style="color: #007700">(</span><span style="color: #0000BB">__CLASS__</span><span style="color: #007700">));<br /> }<br />}<br /><br /></span><span style="color: #0000BB">TestCase</span><span style="color: #007700">::</span><span style="color: #0000BB">expose</span><span style="color: #007700">();<br />echo </span><span style="color: #0000BB">format</span><span style="color: #007700">(</span><span style="color: #0000BB">get_class_vars</span><span style="color: #007700">(</span><span style="color: #DD0000">'TestCase'</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:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
// 5.0.0
a| * b| TestCase c
a| * b| TestCase c
// 5.0.1 - 5.0.2
a|b|c
a|b|c
// 5.0.3 +
a|b|c
a
</pre></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.get-class-vars-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.get-class-methods.html" class="function" rel="rdfs-seeAlso">get_class_methods()</a> - Gets the class methods' names</span></li>
<li class="member"> <span class="function"><a href="function.get-object-vars.html" class="function" rel="rdfs-seeAlso">get_object_vars()</a> - Gets the properties of the given object</span></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.get-class-methods.html">get_class_methods</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.get-class.html">get_class</a></div>
<div class="up"><a href="ref.classobj.html">Classes/Object Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
