jmcastagnetto Sat Aug 3 19:48:48 2002 EDT
Added files:
/phpdoc/en/reference/objaggregation/functions aggregate-methods.xml
aggregate-methods-by-list.xml
Modified files:
/phpdoc/en/reference/objaggregation/functions aggregate.xml
Log:
Some of the aggregate functions. Simple doc, examples in main ref page.
Index: phpdoc/en/reference/objaggregation/functions/aggregate.xml
diff -u phpdoc/en/reference/objaggregation/functions/aggregate.xml:1.2
phpdoc/en/reference/objaggregation/functions/aggregate.xml:1.3
--- phpdoc/en/reference/objaggregation/functions/aggregate.xml:1.2 Sat Aug 3
19:24:45 2002
+++ phpdoc/en/reference/objaggregation/functions/aggregate.xml Sat Aug 3 19:48:48
+2002
@@ -1,10 +1,10 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<refentry id="function.aggregate">
<refnamediv>
<refname>aggregate</refname>
<refpurpose>
- dynamic class and object aggregation
+ dynamic class and object aggregation of methods and properties
</refpurpose>
</refnamediv>
<refsect1>
@@ -16,13 +16,14 @@
</methodsynopsis>
<para>
Aggregates methods and properties defined in a class to
- an existing object. Methods and properties starting with
+ 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>,
Index: phpdoc/en/reference/objaggregation/functions/aggregate-methods.xml
+++ phpdoc/en/reference/objaggregation/functions/aggregate-methods.xml
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<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>
<!-- 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:"../../../../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
-->
Index: phpdoc/en/reference/objaggregation/functions/aggregate-methods-by-list.xml
+++ phpdoc/en/reference/objaggregation/functions/aggregate-methods-by-list.xml
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry id="function.aggregate-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>boolean</type><parameter>exclude</parameter></methodparam>
</methodsynopsis>
<para>
Aggregates methods from a class to
an existing object using a list of method names. The optional paramater
<parameter>exclude</parameter> is used to decide whether the list
contains the names of methods to include in the aggregation (i.e.
<parameter>exclude</paramete> 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>
<!-- 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:"../../../../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
-->
--
PHP Documentation Mailing List (http://www.php.net/)
To unsubscribe, visit: http://www.php.net/unsub.php
