mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-19 10:28:54 +00:00
48fd1c391d
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@90849 c90b9560-bf6c-de11-be94-00142212c4b1
70 lines
2.4 KiB
XML
70 lines
2.4 KiB
XML
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!-- $Revision: 1.2 $ -->
|
|
<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>boolean</type><parameter>exclude</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Aggregates properties from a class to
|
|
an existing object using a regular expresion to match their names.
|
|
The optional paramater
|
|
<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
|
|
-->
|