<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Selective class methods aggregation to an object using a regular
expression</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.aggregate-methods-by-list.html">aggregate_methods_by_list</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.aggregate-methods.html">aggregate_methods</a></div>
<div class="up"><a href="ref.objaggregation.html">Object Aggregation Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.aggregate-methods-by-regexp" class="refentry">
<div class="refnamediv">
<h1 class="refname">aggregate_methods_by_regexp</h1>
<p class="verinfo">(PHP 4 >= 4.2.0)</p><p class="refpurpose"><span class="refname">aggregate_methods_by_regexp</span> — <span class="dc-title">
Selective class methods aggregation to an object using a regular
expression
</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.aggregate-methods-by-regexp-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type"><span class="type void">void</span></span> <span class="methodname"><strong>aggregate_methods_by_regexp</strong></span>
( <span class="methodparam"><span class="type">object</span> <code class="parameter">$object</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$class_name</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$regexp</code></span>
[, <span class="methodparam"><span class="type">bool</span> <code class="parameter">$exclude</code><span class="initializer"> = false</span></span>
] )</div>
<p class="para rdfs-comment">
Aggregates methods from a class to an existing object using a regular
expression to match method names.
</p>
<p class="para">
The class constructor or methods whose names start with an underscore
character (_), which are considered private to the aggregated class, are
always excluded.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.aggregate-methods-by-regexp-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">object</code></em></span>
<dd>
<p class="para">
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">class_name</code></em></span>
<dd>
<p class="para">
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">regexp</code></em></span>
<dd>
<p class="para">
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">exclude</code></em></span>
<dd>
<p class="para">
The optional parameter <em><code class="parameter">exclude</code></em> is used to
decide whether the regular expression will select the names of methods
to include in the aggregation (i.e. <em><code class="parameter">exclude</code></em> is
<strong><code>FALSE</code></strong>), or to exclude from the
aggregation (<em><code class="parameter">exclude</code></em> is <strong><code>TRUE</code></strong>).
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.aggregate-methods-by-regexp-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
No value is returned.
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.aggregate-methods-by-regexp-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.aggregate.html" class="function" rel="rdfs-seeAlso">aggregate()</a> - Dynamic class and object aggregation of methods and properties</span></li>
<li class="member"> <span class="function"><a href="function.aggregate-info.html" class="function" rel="rdfs-seeAlso">aggregate_info()</a> - Gets aggregation information for a given object</span></li>
<li class="member"> <span class="function"><a href="function.aggregate-methods.html" class="function" rel="rdfs-seeAlso">aggregate_methods()</a> - Dynamic class and object aggregation of methods</span></li>
<li class="member"> <span class="function"><a href="function.aggregate-methods-by-list.html" class="function" rel="rdfs-seeAlso">aggregate_methods_by_list()</a> - Selective dynamic class methods aggregation to an object</span></li>
<li class="member"> <span class="function"><a href="function.aggregate-properties.html" class="function" rel="rdfs-seeAlso">aggregate_properties()</a> - Dynamic aggregation of class properties to an object</span></li>
<li class="member"> <span class="function"><a href="function.aggregate-properties-by-list.html" class="function" rel="rdfs-seeAlso">aggregate_properties_by_list()</a> - Selective dynamic class properties aggregation to an object</span></li>
<li class="member"> <span class="function"><a href="function.aggregate-properties-by-regexp.html" class="function" rel="rdfs-seeAlso">aggregate_properties_by_regexp()</a> - Selective class properties aggregation to an object using a regular
expression</span></li>
<li class="member"> <span class="function"><a href="function.deaggregate.html" class="function" rel="rdfs-seeAlso">deaggregate()</a> - Removes the aggregated methods and properties from an object</span></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.aggregate-methods-by-list.html">aggregate_methods_by_list</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.aggregate-methods.html">aggregate_methods</a></div>
<div class="up"><a href="ref.objaggregation.html">Object Aggregation Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
