1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
|
<?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>
<!-- 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
-->
|
