Source of: /manual/en/function.aggregate-properties-by-list.php
<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.objaggregation.inc";
$setup = array (
'home' =>
array (
0 => 'index.php',
1 => 'PHP Manual',
),
'head' =>
array (
0 => 'UTF-8',
1 => 'en',
),
'this' =>
array (
0 => 'function.aggregate-properties-by-list.php',
1 => 'aggregate_properties_by_list',
),
'up' =>
array (
0 => 'ref.objaggregation.php',
1 => 'Object Aggregation Functions',
),
'prev' =>
array (
0 => 'function.aggregate-methods.php',
1 => 'aggregate_methods',
),
'next' =>
array (
0 => 'function.aggregate-properties-by-regexp.php',
1 => 'aggregate_properties_by_regexp',
),
);
$setup["toc"] = $TOC;
$setup["parents"] = $PARENTS;
manual_setup($setup);
manual_header();
?>
<div id="function.aggregate-properties-by-list" class="refentry">
<div class="refnamediv">
<h1 class="refname">aggregate_properties_by_list</h1>
<p class="verinfo">(PHP 4 >= 4.2.0)</p><p class="refpurpose"><span class="refname">aggregate_properties_by_list</span> — <span class="dc-title">
Selective dynamic class properties aggregation to an object
</span></p>
</div>
<a name="function.aggregate-properties-by-list.description"></a><div class="refsect1 description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type"><span class="type void">void</span></span> <span class="methodname"><b>aggregate_properties_by_list</b></span>
( <span class="methodparam"><span class="type">object</span> <tt class="parameter">$object</tt></span>
, <span class="methodparam"><span class="type">string</span> <tt class="parameter">$class_name</tt></span>
, <span class="methodparam"><span class="type">array</span> <tt class="parameter">$properties_list</tt></span>
[, <span class="methodparam"><span class="type">bool</span> <tt class="parameter">$exclude</tt></span>
] )</div>
<p class="para rdfs-comment">
Aggregates properties from a class to an existing object using a list of
property names.
</p>
<p class="para">
The properties whose names start with an underscore character (_), which
are considered private to the aggregated class, are always excluded.
</p>
</div>
<a name="function.aggregate-properties-by-list.parameters"></a><div class="refsect1 parameters">
<h3 class="title">Parameters</h3>
<p class="para">
</p><dl>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">object</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
</p>
</dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">class_name</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
</p>
</dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">properties_list</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
</p>
</dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">exclude</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
The optional parameter <i><tt class="parameter">exclude</tt></i>
is used to
decide whether the list contains the names of class properties to
include in the aggregation (i.e. <i><tt class="parameter">exclude</tt></i>
is
<b><tt class="constant">FALSE</tt></b>, which is the default value), or to exclude from the
aggregation (<i><tt class="parameter">exclude</tt></i>
is <b><tt class="constant">TRUE</tt></b>).
</p>
</dd>
</dl>
<p>
</p>
</div>
<a name="function.aggregate-properties-by-list.returnvalues"></a><div class="refsect1 returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
No value is returned.
</p>
</div>
<a name="function.aggregate-properties-by-list.seealso"></a><div class="refsect1 seealso">
<h3 class="title">See Also</h3>
<p class="para">
</p><ul class="simplelist">
<li class="member"><a href="function.aggregate.php" class="function" rel="rdfs-seeAlso">aggregate()</a> - Dynamic class and object aggregation of methods and properties</li>
<li class="member"><a href="function.aggregate-methods.php" class="function" rel="rdfs-seeAlso">aggregate_methods()</a> - Dynamic class and object aggregation of methods</li>
<li class="member"><a href="function.aggregate-methods-by-list.php" class="function" rel="rdfs-seeAlso">aggregate_methods_by_list()</a> - Selective dynamic class methods aggregation to an object</li>
<li class="member"><a href="function.aggregate-methods-by-regexp.php" class="function" rel="rdfs-seeAlso">aggregate_methods_by_regexp()</a> - Selective class methods aggregation to an object using a regular
expression</li>
<li class="member"><a href="function.aggregate-properties.php" class="function" rel="rdfs-seeAlso">aggregate_properties()</a> - Dynamic aggregation of class properties to an object</li>
<li class="member"><a href="function.aggregate-properties-by-regexp.php" class="function" rel="rdfs-seeAlso">aggregate_properties_by_regexp()</a> - Selective class properties aggregation to an object using a regular
expression</li>
<li class="member"><a href="function.aggregate-info.php" class="function" rel="rdfs-seeAlso">aggregate_info()</a> - Gets aggregation information for a given object</li>
<li class="member"><a href="function.deaggregate.php" class="function" rel="rdfs-seeAlso">deaggregate()</a> - Removes the aggregated methods and properties from an object</li>
</ul><p>
</p>
</div>
</div><?php manual_footer(); ?>
