<!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 aggregation information for a given object</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="ref.objaggregation.html">Object Aggregation Functions</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.aggregate-methods-by-list.html">aggregate_methods_by_list</a></div>
<div class="up"><a href="ref.objaggregation.html">Object Aggregation Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.aggregate-info" class="refentry">
<div class="refnamediv">
<h1 class="refname">aggregate_info</h1>
<p class="verinfo">(PHP 4 >= 4.3.0)</p><p class="refpurpose"><span class="refname">aggregate_info</span> — <span class="dc-title">
Gets aggregation information for a given object
</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.aggregate-info-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">array</span> <span class="methodname"><strong>aggregate_info</strong></span>
( <span class="methodparam"><span class="type">object</span> <code class="parameter">$object</code></span>
)</div>
<p class="para rdfs-comment">
Gets the aggregation information for the given
<em><code class="parameter">object</code></em>.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.aggregate-info-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">object</code></em></span>
<dd>
<p class="para">
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.aggregate-info-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns the aggregation information as an associative array of arrays of
methods and properties. The key for the main array is the name of the
aggregated class.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.aggregate-info-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-5124">
<p><strong>Example #1 Using <span class="function"><strong>aggregate_info()</strong></span></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">Slicer </span><span style="color: #007700">{<br /> var </span><span style="color: #0000BB">$vegetable</span><span style="color: #007700">;<br /><br /> function </span><span style="color: #0000BB">Slicer</span><span style="color: #007700">(</span><span style="color: #0000BB">$vegetable</span><span style="color: #007700">) <br /> {<br /> </span><span style="color: #0000BB">$this</span><span style="color: #007700">-></span><span style="color: #0000BB">vegetable </span><span style="color: #007700">= </span><span style="color: #0000BB">$vegetable</span><span style="color: #007700">;<br /> }<br /><br /> function </span><span style="color: #0000BB">slice_it</span><span style="color: #007700">(</span><span style="color: #0000BB">$num_cuts</span><span style="color: #007700">) <br /> {<br /> echo </span><span style="color: #DD0000">"Doing some simple slicing\n"</span><span style="color: #007700">;<br /> for (</span><span style="color: #0000BB">$i</span><span style="color: #007700">=</span><span style="color: #0000BB">0</span><span style="color: #007700">; </span><span style="color: #0000BB">$i </span><span style="color: #007700">< </span><span style="color: #0000BB">$num_cuts</span><span style="color: #007700">; </span><span style="color: #0000BB">$i</span><span style="color: #007700">++) {<br /> </span><span style="color: #FF8000">// do some slicing<br /> </span><span style="color: #007700">}<br /> }<br />}<br /><br />class </span><span style="color: #0000BB">Dicer </span><span style="color: #007700">{<br /> var </span><span style="color: #0000BB">$vegetable</span><span style="color: #007700">;<br /> var </span><span style="color: #0000BB">$rotation_angle </span><span style="color: #007700">= </span><span style="color: #0000BB">90</span><span style="color: #007700">; </span><span style="color: #FF8000">// degrees<br /><br /> </span><span style="color: #007700">function </span><span style="color: #0000BB">Dicer</span><span style="color: #007700">(</span><span style="color: #0000BB">$vegetable</span><span style="color: #007700">) <br /> {<br /> </span><span style="color: #0000BB">$this</span><span style="color: #007700">-></span><span style="color: #0000BB">vegetable </span><span style="color: #007700">= </span><span style="color: #0000BB">$vegetable</span><span style="color: #007700">;<br /> }<br /><br /> function </span><span style="color: #0000BB">dice_it</span><span style="color: #007700">(</span><span style="color: #0000BB">$num_cuts</span><span style="color: #007700">) <br /> {<br /> echo </span><span style="color: #DD0000">"Cutting in one direction\n"</span><span style="color: #007700">;<br /> for (</span><span style="color: #0000BB">$i</span><span style="color: #007700">=</span><span style="color: #0000BB">0</span><span style="color: #007700">; </span><span style="color: #0000BB">$i </span><span style="color: #007700">< </span><span style="color: #0000BB">$num_cuts</span><span style="color: #007700">; </span><span style="color: #0000BB">$i</span><span style="color: #007700">++) {<br /> </span><span style="color: #FF8000">// do some cutting<br /> </span><span style="color: #007700">}<br /> </span><span style="color: #0000BB">$this</span><span style="color: #007700">-></span><span style="color: #0000BB">rotate</span><span style="color: #007700">(</span><span style="color: #0000BB">$this</span><span style="color: #007700">-></span><span style="color: #0000BB">rotation_angle</span><span style="color: #007700">);<br /> echo </span><span style="color: #DD0000">"Cutting in a second direction\n"</span><span style="color: #007700">;<br /> for (</span><span style="color: #0000BB">$i</span><span style="color: #007700">=</span><span style="color: #0000BB">0</span><span style="color: #007700">; </span><span style="color: #0000BB">$i </span><span style="color: #007700">< </span><span style="color: #0000BB">$num_cuts</span><span style="color: #007700">; </span><span style="color: #0000BB">$i</span><span style="color: #007700">++) {<br /> </span><span style="color: #FF8000">// do some more cutting<br /> </span><span style="color: #007700">}<br /> }<br /><br /> function </span><span style="color: #0000BB">rotate</span><span style="color: #007700">(</span><span style="color: #0000BB">$deg</span><span style="color: #007700">) <br /> {<br /> echo </span><span style="color: #DD0000">"Now rotating </span><span style="color: #007700">{</span><span style="color: #0000BB">$this</span><span style="color: #007700">-></span><span style="color: #0000BB">vegetable</span><span style="color: #007700">}</span><span style="color: #DD0000"> </span><span style="color: #007700">{</span><span style="color: #0000BB">$deg</span><span style="color: #007700">}</span><span style="color: #DD0000"> degrees\n"</span><span style="color: #007700">;<br /> }<br /><br /> function </span><span style="color: #0000BB">_secret_super_dicing</span><span style="color: #007700">(</span><span style="color: #0000BB">$num_cuts</span><span style="color: #007700">) <br /> {<br /> </span><span style="color: #FF8000">// so secret we cannot show you ;-)<br /> </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">Slicer</span><span style="color: #007700">(</span><span style="color: #DD0000">'onion'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">aggregate</span><span style="color: #007700">(</span><span style="color: #0000BB">$obj</span><span style="color: #007700">, </span><span style="color: #DD0000">'Dicer'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">print_r</span><span style="color: #007700">(</span><span style="color: #0000BB">aggregate_info</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:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
Array
(
[dicer] => Array
(
[methods] => Array
(
[0] => dice_it
[1] => rotate
)
[properties] => Array
(
[0] => rotation_angle
)
)
)
</pre></div>
</div>
</div>
As you can see, all properties and methods of the
<strong class="classname">Dicer</strong> class have been aggregated
into our new object, with the exception of the class
constructor and the method <span class="methodname"><strong>_secret_super_dicing()</strong></span>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.aggregate-info-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.aggregate.html" class="function" rel="rdfs-seeAlso">aggregate()</a> - Dynamic class and object aggregation of methods and properties</span></li>
<li class="member"> <span class="function"><a href="function.aggregate-methods.html" class="function" rel="rdfs-seeAlso">aggregate_methods()</a> - Dynamic class and object aggregation of methods</span></li>
<li class="member"> <span class="function"><a href="function.aggregate-methods-by-list.html" class="function" rel="rdfs-seeAlso">aggregate_methods_by_list()</a> - Selective dynamic class methods aggregation to an object</span></li>
<li class="member"> <span class="function"><a href="function.aggregate-methods-by-regexp.html" class="function" rel="rdfs-seeAlso">aggregate_methods_by_regexp()</a> - Selective class methods aggregation to an object using a regular
expression</span></li>
<li class="member"> <span class="function"><a href="function.aggregate-properties.html" class="function" rel="rdfs-seeAlso">aggregate_properties()</a> - Dynamic aggregation of class properties to an object</span></li>
<li class="member"> <span class="function"><a href="function.aggregate-properties-by-list.html" class="function" rel="rdfs-seeAlso">aggregate_properties_by_list()</a> - Selective dynamic class properties aggregation to an object</span></li>
<li class="member"> <span class="function"><a href="function.aggregate-properties-by-regexp.html" class="function" rel="rdfs-seeAlso">aggregate_properties_by_regexp()</a> - Selective class properties aggregation to an object using a regular
expression</span></li>
<li class="member"> <span class="function"><a href="function.deaggregate.html" class="function" rel="rdfs-seeAlso">deaggregate()</a> - Removes the aggregated methods and properties from an 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="ref.objaggregation.html">Object Aggregation Functions</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.aggregate-methods-by-list.html">aggregate_methods_by_list</a></div>
<div class="up"><a href="ref.objaggregation.html">Object Aggregation Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
