<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.aggregate-properties-by-list" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>aggregate_properties_by_list</refname>
  <refpurpose>
   Selective dynamic class properties aggregation to an object
  </refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>void</type><methodname>aggregate_properties_by_list</methodname>
   <methodparam><type>object</type><parameter>object</parameter></methodparam>
   <methodparam><type>string</type><parameter>class_name</parameter></methodparam>
   <methodparam><type>array</type><parameter>properties_list</parameter></methodparam>
   <methodparam choice="opt"><type>bool</type><parameter>exclude</parameter><initializer>false</initializer></methodparam>
  </methodsynopsis>
  <para>
   Aggregates properties from a class to an existing object using a list of
   property names. 
  </para>
  <para>
   The properties whose names start with an underscore character (_), which
   are considered private to the aggregated class, are always excluded.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>object</parameter></term>
     <listitem>
      <para>
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>class_name</parameter></term>
     <listitem>
      <para>
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>properties_list</parameter></term>
     <listitem>
      <para>
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>exclude</parameter></term>
     <listitem>
      <para>
       The optional parameter <parameter>exclude</parameter> is used to
       decide whether the list contains the names of class properties to
       include in the aggregation (i.e. <parameter>exclude</parameter> is
       &false;), or to exclude from the
       aggregation (<parameter>exclude</parameter> is &true;).
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.void;
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>aggregate</function></member>
    <member><function>aggregate_methods</function></member>
    <member><function>aggregate_methods_by_list</function></member>
    <member><function>aggregate_methods_by_regexp</function></member>
    <member><function>aggregate_properties</function></member>
    <member><function>aggregate_properties_by_regexp</function></member>
    <member><function>aggregate_info</function></member>
    <member><function>deaggregate</function></member>
   </simplelist>
  </para>
 </refsect1>

</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->