<!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>Monitor a directory for changes</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="function.fam-monitor-collection.html">fam_monitor_collection</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.fam-monitor-file.html">fam_monitor_file</a></div> <div class="up"><a href="ref.fam.html">FAM Functions</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div><hr /><div id="function.fam-monitor-directory" class="refentry"> <div class="refnamediv"> <h1 class="refname">fam_monitor_directory</h1> <p class="verinfo">(PHP 5 <= 5.0.5)</p><p class="refpurpose"><span class="refname">fam_monitor_directory</span> — <span class="dc-title">Monitor a directory for changes</span></p> </div> <div class="refsect1 description" id="refsect1-function.fam-monitor-directory-description"> <h3 class="title">Description</h3> <div class="methodsynopsis dc-description"> <span class="type">resource</span> <span class="methodname"><strong>fam_monitor_directory</strong></span> ( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$fam</code></span> , <span class="methodparam"><span class="type">string</span> <code class="parameter">$dirname</code></span> )</div> <p class="para rdfs-comment"> Requests monitoring for a directory and all contained files. </p> <p class="para"> A FAM event will be generated whenever the status of the directory (i.e. the result of function <span class="function"><a href="function.stat.html" class="function">stat()</a></span> on that directory) or its content (i.e. the results of <span class="function"><a href="function.readdir.html" class="function">readdir()</a></span>) changes. </p> <p class="para"> The possible event codes are described in detail in the <a href="fam.constants.html" class="link">constants part</a> of this section. </p> </div> <div class="refsect1 parameters" id="refsect1-function.fam-monitor-directory-parameters"> <h3 class="title">Parameters</h3> <p class="para"> <dl> <dt> <span class="term"><em><code class="parameter">fam</code></em></span> <dd> <p class="para"> A resource representing a connection to the FAM service returned by <span class="function"><a href="function.fam-open.html" class="function">fam_open()</a></span> </p> </dd> </dt> <dt> <span class="term"><em><code class="parameter">dirname</code></em></span> <dd> <p class="para"> Path to the monitored directory </p> </dd> </dt> </dl> </p> </div> <div class="refsect1 returnvalues" id="refsect1-function.fam-monitor-directory-returnvalues"> <h3 class="title">Return Values</h3> <p class="para"> Returns a monitoring resource or <strong><code>FALSE</code></strong> on errors. </p> </div> <div class="refsect1 seealso" id="refsect1-function.fam-monitor-directory-seealso"> <h3 class="title">See Also</h3> <p class="para"> <ul class="simplelist"> <li class="member"> <span class="function"><a href="function.fam-monitor-file.html" class="function" rel="rdfs-seeAlso">fam_monitor_file()</a> - Monitor a regular file for changes</span></li> <li class="member"> <span class="function"><a href="function.fam-monitor-collection.html" class="function" rel="rdfs-seeAlso">fam_monitor_collection()</a> - Monitor a collection of files in a directory for changes</span></li> <li class="member"> <span class="function"><a href="function.fam-cancel-monitor.html" class="function" rel="rdfs-seeAlso">fam_cancel_monitor()</a> - Terminate monitoring</span></li> <li class="member"> <span class="function"><a href="function.fam-suspend-monitor.html" class="function" rel="rdfs-seeAlso">fam_suspend_monitor()</a> - Temporarily suspend monitoring</span></li> <li class="member"> <span class="function"><a href="function.fam-resume-monitor.html" class="function" rel="rdfs-seeAlso">fam_resume_monitor()</a> - Resume suspended monitoring</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.fam-monitor-collection.html">fam_monitor_collection</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.fam-monitor-file.html">fam_monitor_file</a></div> <div class="up"><a href="ref.fam.html">FAM Functions</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div></body></html>