didou Sat Jun 9 22:17:42 2007 UTC
Modified files:
/phpdoc/en/reference/objaggregation/functions aggregate-info.xml
aggregate-methods-by-list.xml
aggregate-methods-by-regexp.xml
aggregate-methods.xml
aggregate-properties-by-list.xml
aggregate-properties-by-regexp.xml
aggregate-properties.xml
aggregate.xml
deaggregate.xml
Log:
ref.objaggregation: new doc style
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/objaggregation/functions/aggregate-info.xml?r1=1.6&r2=1.7&diff_format=u
Index: phpdoc/en/reference/objaggregation/functions/aggregate-info.xml
diff -u phpdoc/en/reference/objaggregation/functions/aggregate-info.xml:1.6
phpdoc/en/reference/objaggregation/functions/aggregate-info.xml:1.7
--- phpdoc/en/reference/objaggregation/functions/aggregate-info.xml:1.6 Fri Aug
20 09:36:59 2004
+++ phpdoc/en/reference/objaggregation/functions/aggregate-info.xml Sat Jun
9 22:17:42 2007
@@ -1,29 +1,55 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.6 $ -->
- <refentry id="function.aggregate-info">
- <refnamediv>
- <refname>aggregate_info</refname>
- <refpurpose>
- Returns an associative array of the methods and properties from
- each class that has been aggregated to the object
- </refpurpose>
- </refnamediv>
- <refsect1>
- <title>Description</title>
- <methodsynopsis>
- <type>array</type><methodname>aggregate_info</methodname>
-
<methodparam><type>object</type><parameter>object</parameter></methodparam>
- </methodsynopsis>
- <para>
- Will return the aggregation information for a particular object
- as an associative array of arrays of methods and properties. The
- key for the main array is the name of the aggregated class.
- </para>
- <para>
- For example the code below
- <example>
- <title>Using <function>aggregate_info</function></title>
- <programlisting role="php">
+<!-- $Revision: 1.7 $ -->
+<refentry id="function.aggregate-info">
+ <refnamediv>
+ <refname>aggregate_info</refname>
+ <refpurpose>
+ Gets aggregation information for a given object
+ </refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <type>array</type><methodname>aggregate_info</methodname>
+ <methodparam><type>object</type><parameter>object</parameter></methodparam>
+ </methodsynopsis>
+ <para>
+ Gets the aggregation information for the given
+ <parameter>object</parameter>.
+ </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>object</parameter></term>
+ <listitem>
+ <para>
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <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.
+ </para>
+ </refsect1>
+
+ <refsect1 role="examples">
+ &reftitle.examples;
+ <para>
+ <example>
+ <title>Using <function>aggregate_info</function></title>
+ <programlisting role="php">
<![CDATA[
<?php
@@ -83,9 +109,7 @@
?>
]]>
</programlisting>
- <para>
- Will produce the output
- </para>
+ &example.outputs;
<screen>
<![CDATA[
Array
@@ -107,27 +131,32 @@
)
]]>
- </screen>
- </example>
- As you can see, all properties and methods of the
- <classname>Dicer</classname> class have been aggregated
- into our new object, with the exception of the class
- constructor and the method <methodname>_secret_super_dicing</methodname>
- </para>
- <simpara>
- See also
- <function>aggregate</function>,
- <function>aggregate_methods</function>,
- <function>aggregate_methods_by_list</function>,
- <function>aggregate_methods_by_regexp</function>,
- <function>aggregate_properties</function>,
- <function>aggregate_properties_by_list</function>,
- <function>aggregate_properties_by_regexp</function>,
- <function>deaggregate</function>
-
- </simpara>
- </refsect1>
- </refentry>
+ </screen>
+ </example>
+ As you can see, all properties and methods of the
+ <classname>Dicer</classname> class have been aggregated
+ into our new object, with the exception of the class
+ constructor and the method <methodname>_secret_super_dicing</methodname>
+ </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_list</function></member>
+ <member><function>aggregate_properties_by_regexp</function></member>
+ <member><function>deaggregate</function></member>
+ </simplelist>
+ </para>
+ </refsect1>
+
+</refentry>
<!-- Keep this comment at the end of the file
Local variables:
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/objaggregation/functions/aggregate-methods-by-list.xml?r1=1.6&r2=1.7&diff_format=u
Index:
phpdoc/en/reference/objaggregation/functions/aggregate-methods-by-list.xml
diff -u
phpdoc/en/reference/objaggregation/functions/aggregate-methods-by-list.xml:1.6
phpdoc/en/reference/objaggregation/functions/aggregate-methods-by-list.xml:1.7
---
phpdoc/en/reference/objaggregation/functions/aggregate-methods-by-list.xml:1.6
Fri Aug 13 01:00:47 2004
+++ phpdoc/en/reference/objaggregation/functions/aggregate-methods-by-list.xml
Sat Jun 9 22:17:42 2007
@@ -1,49 +1,98 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.6 $ -->
- <refentry id="function.aggregate-methods-by-list">
- <refnamediv>
- <refname>aggregate_methods_by_list</refname>
- <refpurpose>
- Selective dynamic class methods aggregation to an object
- </refpurpose>
- </refnamediv>
- <refsect1>
- <title>Description</title>
- <methodsynopsis>
- <type>void</type><methodname>aggregate_methods_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>methods_list</parameter></methodparam>
- <methodparam
choice="opt"><type>bool</type><parameter>exclude</parameter></methodparam>
- </methodsynopsis>
- <para>
- Aggregates methods from a class to
- an existing object using a list of method names. The optional parameter
- <parameter>exclude</parameter> is used to decide whether the list
- contains the names of methods to include in the aggregation (i.e.
- <parameter>exclude</parameter> is &false;, which is the default value),
- or to exclude from the aggregation (<parameter>exclude</parameter> is
- &true;).
- </para>
- <para>
- The class constructor or methods
- whose names start with an underscore character (_), which are
- considered private to the aggregated class, are always
- excluded.
- </para>
- <simpara>
- See also
- <function>aggregate</function>,
- <function>aggregate_info</function>,
- <function>aggregate_methods</function>,
- <function>aggregate_methods_by_regexp</function>,
- <function>aggregate_properties</function>,
- <function>aggregate_properties_by_list</function>,
- <function>aggregate_properties_by_regexp</function>,
- <function>deaggregate</function>
- </simpara>
- </refsect1>
- </refentry>
+<!-- $Revision: 1.7 $ -->
+<refentry id="function.aggregate-methods-by-list">
+ <refnamediv>
+ <refname>aggregate_methods_by_list</refname>
+ <refpurpose>
+ Selective dynamic class methods aggregation to an object
+ </refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <type>void</type><methodname>aggregate_methods_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>methods_list</parameter></methodparam>
+ <methodparam
choice="opt"><type>bool</type><parameter>exclude</parameter></methodparam>
+ </methodsynopsis>
+ <para>
+ Aggregates methods from a class to an existing object using a list of
+ method names.
+ </para>
+ <para>
+ The class constructor or methods 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>methods_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 methods to include in
+ the aggregation (i.e. <parameter>exclude</parameter> is &false;, which
+ is the default value), 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_info</function></member>
+ <member><function>aggregate_methods</function></member>
+ <member><function>aggregate_methods_by_regexp</function></member>
+ <member><function>aggregate_properties</function></member>
+ <member><function>aggregate_properties_by_list</function></member>
+ <member><function>aggregate_properties_by_regexp</function></member>
+ <member><function>deaggregate</function></member>
+ </simplelist>
+ </para>
+ </refsect1>
+
+</refentry>
<!-- Keep this comment at the end of the file
Local variables:
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/objaggregation/functions/aggregate-methods-by-regexp.xml?r1=1.5&r2=1.6&diff_format=u
Index:
phpdoc/en/reference/objaggregation/functions/aggregate-methods-by-regexp.xml
diff -u
phpdoc/en/reference/objaggregation/functions/aggregate-methods-by-regexp.xml:1.5
phpdoc/en/reference/objaggregation/functions/aggregate-methods-by-regexp.xml:1.6
---
phpdoc/en/reference/objaggregation/functions/aggregate-methods-by-regexp.xml:1.5
Fri Aug 13 01:00:47 2004
+++
phpdoc/en/reference/objaggregation/functions/aggregate-methods-by-regexp.xml
Sat Jun 9 22:17:42 2007
@@ -1,52 +1,99 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.5 $ -->
- <refentry id="function.aggregate-methods-by-regexp">
- <refnamediv>
- <refname>aggregate_methods_by_regexp</refname>
- <refpurpose>
- Selective class methods aggregation to an object using a regular
- expression
- </refpurpose>
- </refnamediv>
- <refsect1>
- <title>Description</title>
- <methodsynopsis>
- <type>void</type><methodname>aggregate_methods_by_regexp</methodname>
-
<methodparam><type>object</type><parameter>object</parameter></methodparam>
-
<methodparam><type>string</type><parameter>class_name</parameter></methodparam>
-
<methodparam><type>string</type><parameter>regexp</parameter></methodparam>
- <methodparam
choice="opt"><type>bool</type><parameter>exclude</parameter></methodparam>
- </methodsynopsis>
- <para>
- Aggregates methods from a class to
- an existing object using a regular expression to match method names.
- The optional parameter
- <parameter>exclude</parameter> is used to decide whether the regular
- expression will select
- the names of methods to include in the aggregation (i.e.
- <parameter>exclude</parameter> is &false;, which is the default value),
- or to exclude from the aggregation (<parameter>exclude</parameter> is
- &true;).
- </para>
- <para>
- The class constructor or methods
- whose names start with an underscore character (_), which are
- considered private to the aggregated class, are always
- excluded.
- </para>
- <simpara>
- See also
- <function>aggregate</function>,
- <function>aggregate_info</function>,
- <function>aggregate_methods</function>,
- <function>aggregate_methods_by_list</function>,
- <function>aggregate_properties</function>,
- <function>aggregate_properties_by_list</function>,
- <function>aggregate_properties_by_regexp</function>,
- <function>deaggregate</function>
- </simpara>
- </refsect1>
- </refentry>
+<!-- $Revision: 1.6 $ -->
+<refentry id="function.aggregate-methods-by-regexp">
+ <refnamediv>
+ <refname>aggregate_methods_by_regexp</refname>
+ <refpurpose>
+ Selective class methods aggregation to an object using a regular
+ expression
+ </refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <type>void</type><methodname>aggregate_methods_by_regexp</methodname>
+ <methodparam><type>object</type><parameter>object</parameter></methodparam>
+
<methodparam><type>string</type><parameter>class_name</parameter></methodparam>
+ <methodparam><type>string</type><parameter>regexp</parameter></methodparam>
+ <methodparam
choice="opt"><type>bool</type><parameter>exclude</parameter></methodparam>
+ </methodsynopsis>
+ <para>
+ Aggregates methods from a class to an existing object using a regular
+ expression to match method names.
+ </para>
+ <para>
+ The class constructor or methods 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>regexp</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 regular expression will select the names of methods
+ to include in the aggregation (i.e. <parameter>exclude</parameter> is
+ &false;, which is the default value), 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_info</function></member>
+ <member><function>aggregate_methods</function></member>
+ <member><function>aggregate_methods_by_list</function></member>
+ <member><function>aggregate_properties</function></member>
+ <member><function>aggregate_properties_by_list</function></member>
+ <member><function>aggregate_properties_by_regexp</function></member>
+ <member><function>deaggregate</function></member>
+ </simplelist>
+ </para>
+ </refsect1>
+
+</refentry>
<!-- Keep this comment at the end of the file
Local variables:
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/objaggregation/functions/aggregate-methods.xml?r1=1.2&r2=1.3&diff_format=u
Index: phpdoc/en/reference/objaggregation/functions/aggregate-methods.xml
diff -u phpdoc/en/reference/objaggregation/functions/aggregate-methods.xml:1.2
phpdoc/en/reference/objaggregation/functions/aggregate-methods.xml:1.3
--- phpdoc/en/reference/objaggregation/functions/aggregate-methods.xml:1.2
Tue Mar 2 12:50:14 2004
+++ phpdoc/en/reference/objaggregation/functions/aggregate-methods.xml Sat Jun
9 22:17:42 2007
@@ -1,38 +1,73 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
- <refentry id="function.aggregate-methods">
- <refnamediv>
- <refname>aggregate_methods</refname>
- <refpurpose>
- Dynamic class and object aggregation of methods
- </refpurpose>
- </refnamediv>
- <refsect1>
- <title>Description</title>
- <methodsynopsis>
- <type>void</type><methodname>aggregate_methods</methodname>
-
<methodparam><type>object</type><parameter>object</parameter></methodparam>
-
<methodparam><type>string</type><parameter>class_name</parameter></methodparam>
- </methodsynopsis>
- <para>
- Aggregates all methods defined in a class to
- an existing object, except for the class constructor, or methods
- whose names start with an underscore character (_) which are
- considered private to the aggregated class.
- </para>
- <simpara>
- See also
- <function>aggregate</function>,
- <function>aggregate_info</function>,
- <function>aggregate_methods_by_list</function>,
- <function>aggregate_methods_by_regexp</function>,
- <function>aggregate_properties</function>,
- <function>aggregate_properties_by_list</function>,
- <function>aggregate_properties_by_regexp</function>,
- <function>deaggregate</function>
- </simpara>
- </refsect1>
- </refentry>
+<!-- $Revision: 1.3 $ -->
+<refentry id="function.aggregate-methods">
+ <refnamediv>
+ <refname>aggregate_methods</refname>
+ <refpurpose>
+ Dynamic class and object aggregation of methods
+ </refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <type>void</type><methodname>aggregate_methods</methodname>
+ <methodparam><type>object</type><parameter>object</parameter></methodparam>
+
<methodparam><type>string</type><parameter>class_name</parameter></methodparam>
+ </methodsynopsis>
+ <para>
+ Aggregates all methods defined in a class to an existing object, except
+ for the class constructor, or methods whose names start with an underscore
+ character (_) which are considered private to the aggregated class.
+ </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>
+ </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_info</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_list</function></member>
+ <member><function>aggregate_properties_by_regexp</function></member>
+ <member><function>deaggregate</function></member>
+ </simplelist>
+ </para>
+ </refsect1>
+
+</refentry>
<!-- Keep this comment at the end of the file
Local variables:
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/objaggregation/functions/aggregate-properties-by-list.xml?r1=1.5&r2=1.6&diff_format=u
Index:
phpdoc/en/reference/objaggregation/functions/aggregate-properties-by-list.xml
diff -u
phpdoc/en/reference/objaggregation/functions/aggregate-properties-by-list.xml:1.5
phpdoc/en/reference/objaggregation/functions/aggregate-properties-by-list.xml:1.6
---
phpdoc/en/reference/objaggregation/functions/aggregate-properties-by-list.xml:1.5
Thu Aug 12 15:29:05 2004
+++
phpdoc/en/reference/objaggregation/functions/aggregate-properties-by-list.xml
Sat Jun 9 22:17:42 2007
@@ -1,49 +1,97 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.5 $ -->
- <refentry id="function.aggregate-properties-by-list">
- <refnamediv>
- <refname>aggregate_properties_by_list</refname>
- <refpurpose>
- Selective dynamic class properties aggregation to an object
- </refpurpose>
- </refnamediv>
- <refsect1>
- <title>Description</title>
- <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></methodparam>
- </methodsynopsis>
- <para>
- Aggregates properties from a class to
- an existing object using a list of property names. 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;, which is the default value),
- or to exclude from the aggregation (<parameter>exclude</parameter> is
- &true;).
- </para>
- <para>
- The properties
- whose names start with an underscore character (_), which are
- considered private to the aggregated class, are always
- excluded.
- </para>
- <simpara>
- See also
- <function>aggregate</function>,
- <function>aggregate_methods</function>,
- <function>aggregate_methods_by_list</function>,
- <function>aggregate_methods_by_regexp</function>,
- <function>aggregate_properties</function>,
- <function>aggregate_properties_by_regexp</function>,
- <function>aggregate_info</function>,
- <function>deaggregate</function>
- </simpara>
- </refsect1>
- </refentry>
+<!-- $Revision: 1.6 $ -->
+<refentry id="function.aggregate-properties-by-list">
+ <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></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;, which is the default value), 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:
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/objaggregation/functions/aggregate-properties-by-regexp.xml?r1=1.5&r2=1.6&diff_format=u
Index:
phpdoc/en/reference/objaggregation/functions/aggregate-properties-by-regexp.xml
diff -u
phpdoc/en/reference/objaggregation/functions/aggregate-properties-by-regexp.xml:1.5
phpdoc/en/reference/objaggregation/functions/aggregate-properties-by-regexp.xml:1.6
---
phpdoc/en/reference/objaggregation/functions/aggregate-properties-by-regexp.xml:1.5
Thu Aug 12 15:00:49 2004
+++
phpdoc/en/reference/objaggregation/functions/aggregate-properties-by-regexp.xml
Sat Jun 9 22:17:42 2007
@@ -1,52 +1,99 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.5 $ -->
- <refentry id="function.aggregate-properties-by-regexp">
- <refnamediv>
- <refname>aggregate_properties_by_regexp</refname>
- <refpurpose>
- Selective class properties aggregation to an object using a regular
- expression
- </refpurpose>
- </refnamediv>
- <refsect1>
- <title>Description</title>
- <methodsynopsis>
- <type>void</type><methodname>aggregate_properties_by_regexp</methodname>
-
<methodparam><type>object</type><parameter>object</parameter></methodparam>
-
<methodparam><type>string</type><parameter>class_name</parameter></methodparam>
-
<methodparam><type>string</type><parameter>regexp</parameter></methodparam>
- <methodparam
choice="opt"><type>bool</type><parameter>exclude</parameter></methodparam>
- </methodsynopsis>
- <para>
- Aggregates properties from a class to
- an existing object using a regular expression to match their names.
- The optional parameter
- <parameter>exclude</parameter> is used to decide whether the regular
- expression will select
- the names of class properties to include in the aggregation (i.e.
- <parameter>exclude</parameter> is &false;, which is the default value),
- or to exclude from the aggregation (<parameter>exclude</parameter> is
- &true;).
- </para>
- <para>
- The properties
- whose names start with an underscore character (_), which are
- considered private to the aggregated class, are always
- excluded.
- </para>
- <simpara>
- See also
- <function>aggregate</function>,
- <function>aggregate_methods</function>,
- <function>aggregate_methods_by_list</function>,
- <function>aggregate_methods_by_regexp</function>,
- <function>aggregate_properties</function>,
- <function>aggregate_properties_by_list</function>,
- <function>aggregate_info</function>,
- <function>deaggregate</function>
- </simpara>
- </refsect1>
- </refentry>
+<!-- $Revision: 1.6 $ -->
+<refentry id="function.aggregate-properties-by-regexp">
+ <refnamediv>
+ <refname>aggregate_properties_by_regexp</refname>
+ <refpurpose>
+ Selective class properties aggregation to an object using a regular
+ expression
+ </refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <type>void</type><methodname>aggregate_properties_by_regexp</methodname>
+ <methodparam><type>object</type><parameter>object</parameter></methodparam>
+
<methodparam><type>string</type><parameter>class_name</parameter></methodparam>
+ <methodparam><type>string</type><parameter>regexp</parameter></methodparam>
+ <methodparam
choice="opt"><type>bool</type><parameter>exclude</parameter></methodparam>
+ </methodsynopsis>
+ <para>
+ Aggregates properties from a class to an existing object using a regular
+ expression to match their 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>regexp</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 regular expression will select the names of class
+ properties to include in the aggregation (i.e.
+ <parameter>exclude</parameter> is &false;, which is the default
+ value), 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_list</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:
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/objaggregation/functions/aggregate-properties.xml?r1=1.2&r2=1.3&diff_format=u
Index: phpdoc/en/reference/objaggregation/functions/aggregate-properties.xml
diff -u
phpdoc/en/reference/objaggregation/functions/aggregate-properties.xml:1.2
phpdoc/en/reference/objaggregation/functions/aggregate-properties.xml:1.3
--- phpdoc/en/reference/objaggregation/functions/aggregate-properties.xml:1.2
Tue Mar 2 12:50:14 2004
+++ phpdoc/en/reference/objaggregation/functions/aggregate-properties.xml
Sat Jun 9 22:17:42 2007
@@ -1,38 +1,73 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
- <refentry id="function.aggregate-properties">
- <refnamediv>
- <refname>aggregate_properties</refname>
- <refpurpose>
- Dynamic aggregation of class properties to an object
- </refpurpose>
- </refnamediv>
- <refsect1>
- <title>Description</title>
- <methodsynopsis>
- <type>void</type><methodname>aggregate_properties</methodname>
-
<methodparam><type>object</type><parameter>object</parameter></methodparam>
-
<methodparam><type>string</type><parameter>class_name</parameter></methodparam>
- </methodsynopsis>
- <para>
- Aggregates all properties defined in a class to
- an existing object, except for properties
- whose names start with an underscore character (_) which are
- considered private to the aggregated class.
- </para>
- <simpara>
- See also
- <function>aggregate</function>,
- <function>aggregate_methods</function>,
- <function>aggregate_methods_by_list</function>,
- <function>aggregate_methods_by_regexp</function>,
- <function>aggregate_properties_by_list</function>,
- <function>aggregate_properties_by_regexp</function>,
- <function>aggregate_info</function>,
- <function>deaggregate</function>
- </simpara>
- </refsect1>
- </refentry>
+<!-- $Revision: 1.3 $ -->
+<refentry id="function.aggregate-properties">
+ <refnamediv>
+ <refname>aggregate_properties</refname>
+ <refpurpose>
+ Dynamic aggregation of class properties to an object
+ </refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <type>void</type><methodname>aggregate_properties</methodname>
+ <methodparam><type>object</type><parameter>object</parameter></methodparam>
+
<methodparam><type>string</type><parameter>class_name</parameter></methodparam>
+ </methodsynopsis>
+ <para>
+ Aggregates all properties defined in a class to an existing object, except
+ for properties whose names start with an underscore character (_) which
+ are considered private to the aggregated class.
+ </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>
+ </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_list</function></member>
+ <member><function>aggregate_properties_by_regexp</function></member>
+ <member><function>deaggregate</function></member>
+ </simplelist>
+ </para>
+ </refsect1>
+
+</refentry>
<!-- Keep this comment at the end of the file
Local variables:
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/objaggregation/functions/aggregate.xml?r1=1.4&r2=1.5&diff_format=u
Index: phpdoc/en/reference/objaggregation/functions/aggregate.xml
diff -u phpdoc/en/reference/objaggregation/functions/aggregate.xml:1.4
phpdoc/en/reference/objaggregation/functions/aggregate.xml:1.5
--- phpdoc/en/reference/objaggregation/functions/aggregate.xml:1.4 Tue Mar
2 12:50:14 2004
+++ phpdoc/en/reference/objaggregation/functions/aggregate.xml Sat Jun 9
22:17:42 2007
@@ -1,39 +1,74 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.4 $ -->
- <refentry id="function.aggregate">
- <refnamediv>
- <refname>aggregate</refname>
- <refpurpose>
- Dynamic class and object aggregation of methods and properties
- </refpurpose>
- </refnamediv>
- <refsect1>
- <title>Description</title>
- <methodsynopsis>
- <type>void</type><methodname>aggregate</methodname>
-
<methodparam><type>object</type><parameter>object</parameter></methodparam>
-
<methodparam><type>string</type><parameter>class_name</parameter></methodparam>
- </methodsynopsis>
- <para>
- Aggregates methods and properties defined in a class to
- an existing object. Methods and properties with names starting with
- an underscore character (_) are considered private to
- the aggregated class and are not used, constructors are
- also excluded from the aggregation procedure.
- </para>
- <simpara>
- See also
- <function>aggregate_info</function>,
- <function>aggregate_methods</function>,
- <function>aggregate_methods_by_list</function>,
- <function>aggregate_methods_by_regexp</function>,
- <function>aggregate_properties</function>,
- <function>aggregate_properties_by_list</function>,
- <function>aggregate_properties_by_regexp</function>,
- <function>deaggregate</function>
- </simpara>
- </refsect1>
- </refentry>
+<!-- $Revision: 1.5 $ -->
+<refentry id="function.aggregate">
+ <refnamediv>
+ <refname>aggregate</refname>
+ <refpurpose>
+ Dynamic class and object aggregation of methods and properties
+ </refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <type>void</type><methodname>aggregate</methodname>
+ <methodparam><type>object</type><parameter>object</parameter></methodparam>
+
<methodparam><type>string</type><parameter>class_name</parameter></methodparam>
+ </methodsynopsis>
+ <para>
+ Aggregates methods and properties defined in a class to an existing
+ object. Methods and properties with names starting with an underscore
+ character (_) are considered private to the aggregated class and are not
+ used, constructors are also excluded from the aggregation procedure.
+ </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>
+ </variablelist>
+ </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ &return.void;
+ </para>
+ </refsect1>
+
+ <refsect1 role="seealso">
+ &reftitle.seealso;
+ <para>
+ <simplelist>
+ <member><function>aggregate_info</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_list</function></member>
+ <member><function>aggregate_properties_by_regexp</function></member>
+ <member><function>deaggregate</function></member>
+ </simplelist>
+ </para>
+ </refsect1>
+
+</refentry>
<!-- Keep this comment at the end of the file
Local variables:
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/objaggregation/functions/deaggregate.xml?r1=1.3&r2=1.4&diff_format=u
Index: phpdoc/en/reference/objaggregation/functions/deaggregate.xml
diff -u phpdoc/en/reference/objaggregation/functions/deaggregate.xml:1.3
phpdoc/en/reference/objaggregation/functions/deaggregate.xml:1.4
--- phpdoc/en/reference/objaggregation/functions/deaggregate.xml:1.3 Fri Feb
28 23:51:57 2003
+++ phpdoc/en/reference/objaggregation/functions/deaggregate.xml Sat Jun
9 22:17:42 2007
@@ -1,39 +1,75 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.3 $ -->
- <refentry id="function.deaggregate">
- <refnamediv>
- <refname>deaggregate</refname>
- <refpurpose>
- Removes the aggregated methods and properties from an object
- </refpurpose>
- </refnamediv>
- <refsect1>
- <title>Description</title>
- <methodsynopsis>
- <type>void</type><methodname>deaggregate</methodname>
-
<methodparam><type>object</type><parameter>object</parameter></methodparam>
- <methodparam
choice="opt"><type>string</type><parameter>class_name</parameter></methodparam>
- </methodsynopsis>
- <para>
- Removes the methods and properties from classes that were aggregated to
- an object.
- If the optional <parameter>class_name</parameter> parameters is passed,
- only those methods and properties defined in that class are removed,
- otherwise all aggregated methods and properties are eliminated.
- </para>
- <simpara>
- See also
- <function>aggregate</function>,
- <function>aggregate_methods</function>,
- <function>aggregate_methods_by_list</function>,
- <function>aggregate_methods_by_regexp</function>,
- <function>aggregate_properties</function>,
- <function>aggregate_properties_by_list</function>,
- <function>aggregate_properties_by_regexp</function>,
- <function>aggregate_info</function>
- </simpara>
- </refsect1>
- </refentry>
+<!-- $Revision: 1.4 $ -->
+<refentry id="function.deaggregate">
+ <refnamediv>
+ <refname>deaggregate</refname>
+ <refpurpose>
+ Removes the aggregated methods and properties from an object
+ </refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <type>void</type><methodname>deaggregate</methodname>
+ <methodparam><type>object</type><parameter>object</parameter></methodparam>
+ <methodparam
choice="opt"><type>string</type><parameter>class_name</parameter></methodparam>
+ </methodsynopsis>
+ <para>
+ Removes the methods and properties from classes that were aggregated to
+ an object.
+ </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>
+ If the optional <parameter>class_name</parameter> parameters is passed,
+ only those methods and properties defined in that class are removed,
+ otherwise all aggregated methods and properties are eliminated.
+ </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_list</function></member>
+ <member><function>aggregate_properties_by_regexp</function></member>
+ <member><function>deaggregate</function></member>
+ </simplelist>
+ </para>
+ </refsect1>
+
+</refentry>
<!-- Keep this comment at the end of the file
Local variables:
