Location: PHPKode > projects > Aukyla Platform > aukyla/doc/html/a00163.html
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
  <head>
    <title>Aukyla PHP Framework</title>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
    <link rel="StyleSheet" href="auton.css" type="text/css" media="screen">
  </head>

  <body>
    <div id="mainmenu">
      <a href="http://www.auton.nl/" class="home">Home</a>
    </div>
    <div id="submenu">
      <a class="logo" href="http://www.auton.nl/"></a>

      <div class="head">Ads</div>
      <a href="http://sourceforge.net/"><img src="http://sourceforge.net/sflogo.php?group_id=116358&amp;type=1" alt="SourceForge.net Logo" style="padding: 2px 4px; width: 88px; height: 31px; border: 0px"></a>
      <a href="http://getfirefox.com/" title="Get Firefox - The Browser, Reloaded."><img src="http://www.mozilla.org/products/firefox/buttons/getfirefox_small.png" alt="Get Firefox" style="width: 110px; height: 32px; border: 0px"></a>
    </div>
    <div id="main">
<!-- Generated by Doxygen 1.3.9.1 -->
<div class="qindex"><a class="qindex" href="index.html">Main&nbsp;Page</a> | <a class="qindex" href="hierarchy.html">Class&nbsp;Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical&nbsp;List</a> | <a class="qindex" href="annotated.html">Class&nbsp;List</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="functions.html">Class&nbsp;Members</a> | <a class="qindex" href="pages.html">Related&nbsp;Pages</a></div>
<h1>URI Class Reference</h1><a href="a00072.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
Performs file operations on local URI's. 
<p>
Most functions correspond more or less to regular functions for file operations which already exist in PHP. The most important differences with the regular PHP functions are that these functions will always check whether the currently logged in user has permission to perform the requested action according to the specified namespace and these functions only work with URI's using a registered namespace.<p>
If you are using Local URI's use these functions whenever you can. They provide some handy functions and, as said, will check all permissions automatically. If you want to do something with a Local URI that's not possible with these functions however, you should use <a class="el" href="a00163.html#e15">URI::permissions()</a> to at least check what you are going to do is permitted.<p>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="a00120.html">LocalURIManager</a> </dd></dl>

<p>

<p>
Definition at line <a class="el" href="a00237.html#l00281">281</a> of file <a class="el" href="a00237.html">URI.php</a>.<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00163.html#e0">isLocalURI</a> ($uri)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00163.html#e1">uniquePath</a> ($path, $suggestion)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00163.html#e2">fopen</a> ($path, $mode)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00163.html#e3">fread</a> ($handle, $length)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00163.html#e4">fwrite</a> ($handle, $string)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00163.html#e5">feof</a> ($handle)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00163.html#e6">ftell</a> ($handle)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00163.html#e7">fseek</a> ($handle, $offset, $whence=SEEK_SET)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00163.html#e8">fflush</a> ($handle)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00163.html#e9">fstat</a> ($handle)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00163.html#e10">fclose</a> ($handle)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00163.html#e11">file</a> ($path)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00163.html#e12">fileGetContents</a> ($path)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00163.html#e13">copy</a> ($source, $destination, &amp;$realDestination= '')</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00163.html#e14">fileSize</a> ($path)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00163.html#e15">permissions</a> ($path)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00163.html#e16">permissionsArray</a> ($path)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00163.html#e17">setPermissionsArray</a> ($path, $permissions, $recursive=false)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00163.html#e18">mkdir</a> ($path, $options=STREAM_REPORT_ERRORS)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00163.html#e19">rmdir</a> ($path, $recursive=false)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00163.html#e20">touch</a> ($path)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00163.html#e21">unlink</a> ($path)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00163.html#e22">rename</a> ($pathFrom, $pathTo, &amp;$realPathTo= '')</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00163.html#e23">opendir</a> ($path)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00163.html#e24">readdir</a> ($handle)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00163.html#e25">rewinddir</a> ($handle)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00163.html#e26">closedir</a> ($handle)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00163.html#e27">entries</a> ($path)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00163.html#e28">stat</a> ($path)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00163.html#e29">fileExists</a> ($path)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00163.html#e30">isDir</a> ($path)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00163.html#e31">isFile</a> ($path)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00163.html#e32">isLink</a> ($path)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00163.html#e33">metaData</a> ($path, $key, $default=false)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00163.html#e34">setMetaData</a> ($path, $key, $value=false, $recursive=false)</td></tr>

</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="e26" doxytag="URI::closedir"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">URI::closedir           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">$&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>handle</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap><code> [static]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Closes the directory handle. This will free the resources associated with the handle and the handle is no longer valid.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>handle</em>&nbsp;</td><td>A valid directory handle as returned by <a class="el" href="a00163.html#e23">URI::opendir()</a>. </td></tr>
  </table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd><code>true</code> on success or <code>false</code> if an error occurred.</dd></dl>

<p>
Definition at line <a class="el" href="a00237.html#l00978">978</a> of file <a class="el" href="a00237.html">URI.php</a>.    </td>
  </tr>
</table>
<a class="anchor" name="e13" doxytag="URI::copy"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">URI::copy           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">$&nbsp;</td>
          <td class="mdname" nowrap> <em>source</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td class="md"></td>
          <td class="md" nowrap>$&nbsp;</td>
          <td class="mdname" nowrap> <em>destination</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td class="md"></td>
          <td class="md" nowrap>&amp;$&nbsp;</td>
          <td class="mdname" nowrap> <em>realDestination</em> = <code>''</code></td>
        </tr>
        <tr>
          <td class="md"></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"><code> [static]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Copy command for use with Local URI's.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>source</em>&nbsp;</td><td>Source file to copy. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>destination</em>&nbsp;</td><td>Destination file or directory to copy to. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>realDestination</em>&nbsp;</td><td>If <code>destination</code> was a directory, this parameter if set to the full path the file was saved under. This usually is something like the destination directory plus the basename of the source file, but it doesn't have to be. </td></tr>
  </table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd><code>true</code> if the source file was successfully copied, <code>false</code> if an error occurred.</dd></dl>

<p>
Definition at line <a class="el" href="a00237.html#l00551">551</a> of file <a class="el" href="a00237.html">URI.php</a>.    </td>
  </tr>
</table>
<a class="anchor" name="e27" doxytag="URI::entries"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">URI::entries           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">$&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>path</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap><code> [static]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Returns all entries in a directory. Basically it opens the directory, reads all entries, closes it and returns the collected entries in an array.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>path</em>&nbsp;</td><td>Path to the directory to be opened. </td></tr>
  </table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>An array of strings containing all entries in the directory, or <code>false</code> if an error occurred.</dd></dl>

<p>
Definition at line <a class="el" href="a00237.html#l00992">992</a> of file <a class="el" href="a00237.html">URI.php</a>.    </td>
  </tr>
</table>
<a class="anchor" name="e10" doxytag="URI::fclose"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">URI::fclose           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">$&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>handle</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap><code> [static]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Closes an open file handle. After calling this function, the given <code>handle</code> is no longer valid.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>handle</em>&nbsp;</td><td>A valid file handle as returned by <a class="el" href="a00163.html#e2">URI::fopen()</a>. </td></tr>
  </table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd><code>true</code> on success or <code>false</code> if an error occurred.</dd></dl>

<p>
Definition at line <a class="el" href="a00237.html#l00479">479</a> of file <a class="el" href="a00237.html">URI.php</a>.    </td>
  </tr>
</table>
<a class="anchor" name="e5" doxytag="URI::feof"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">URI::feof           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">$&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>handle</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap><code> [static]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Returns whether the current file position is at the end of a file.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>handle</em>&nbsp;</td><td>A valid file handle as returned by <a class="el" href="a00163.html#e2">URI::fopen()</a>. </td></tr>
  </table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd><code>true</code> if the current file position is at the end of the file, <code>false</code> otherwise.</dd></dl>

<p>
Definition at line <a class="el" href="a00237.html#l00416">416</a> of file <a class="el" href="a00237.html">URI.php</a>.    </td>
  </tr>
</table>
<a class="anchor" name="e8" doxytag="URI::fflush"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">URI::fflush           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">$&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>handle</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap><code> [static]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Flushes any cached data for a file to disk.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>handle</em>&nbsp;</td><td>A valid file handle as returned by <a class="el" href="a00163.html#e2">URI::fopen()</a>. </td></tr>
  </table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd><code>true</code> if the data was successfully flushed (or no data needed to be flushed) or <code>false</code> if an error occurred.</dd></dl>

<p>
Definition at line <a class="el" href="a00237.html#l00454">454</a> of file <a class="el" href="a00237.html">URI.php</a>.    </td>
  </tr>
</table>
<a class="anchor" name="e11" doxytag="URI::file"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">URI::file           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">$&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>path</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap><code> [static]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Reads the entire contents of a file to an array of strings.<p>
Unlike the PHP <a class="el" href="a00163.html#e11">file()</a> function, the newline characters are stripped from the individual strings.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>path</em>&nbsp;</td><td>Path to the file to be read. </td></tr>
  </table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>An array of strings containing the entire file contents. Every string in the array represents a line in the file, or <code>false</code> if an error occurred.</dd></dl>

<p>
Definition at line <a class="el" href="a00237.html#l00495">495</a> of file <a class="el" href="a00237.html">URI.php</a>.    </td>
  </tr>
</table>
<a class="anchor" name="e29" doxytag="URI::fileExists"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">URI::fileExists           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">$&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>path</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap><code> [static]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Returns whether the location pointed to by the given URI exists.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>path</em>&nbsp;</td><td>Path to check for its existence </td></tr>
  </table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd><code>true</code> if the URI exists, <code>false</code> otherwise.</dd></dl>

<p>
Definition at line <a class="el" href="a00237.html#l01038">1038</a> of file <a class="el" href="a00237.html">URI.php</a>.
<p>
Referenced by <a class="el" href="a00228.html#l00118">OpenOffice::convertSXW2XHTML()</a>, <a class="el" href="a00227.html#l00333">OpenDocument::convertToXHTML()</a>, and <a class="el" href="a00228.html#l00045">OpenOffice::convertXHTML2SXW()</a>.    </td>
  </tr>
</table>
<a class="anchor" name="e12" doxytag="URI::fileGetContents"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">URI::fileGetContents           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">$&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>path</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap><code> [static]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Reads the entire contents of a file to a string.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>path</em>&nbsp;</td><td>Path to the file to be read. </td></tr>
  </table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>A string containing the entire file contents or <code>false</code> if an error occurred.</dd></dl>

<p>
Definition at line <a class="el" href="a00237.html#l00516">516</a> of file <a class="el" href="a00237.html">URI.php</a>.    </td>
  </tr>
</table>
<a class="anchor" name="e14" doxytag="URI::fileSize"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">URI::fileSize           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">$&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>path</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap><code> [static]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Returns the size of a file.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>path</em>&nbsp;</td><td>Path to the file whose file size should be returned. </td></tr>
  </table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>The size of the file or <code>false</code> if an error occurred.</dd></dl>

<p>
Definition at line <a class="el" href="a00237.html#l00614">614</a> of file <a class="el" href="a00237.html">URI.php</a>.    </td>
  </tr>
</table>
<a class="anchor" name="e2" doxytag="URI::fopen"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">URI::fopen           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">$&nbsp;</td>
          <td class="mdname" nowrap> <em>path</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td class="md"></td>
          <td class="md" nowrap>$&nbsp;</td>
          <td class="mdname" nowrap> <em>mode</em></td>
        </tr>
        <tr>
          <td class="md"></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"><code> [static]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Opens a file.<p>
If a new file has to be created, it's access permissions are inherited from the parent directory.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>path</em>&nbsp;</td><td>Path to the file to be opened. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>mode</em>&nbsp;</td><td>The <a class="el" href="a00163.html#e2">fopen()</a> mode to open the file with. </td></tr>
  </table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>File handle or <code>false</code> if an error occurred.</dd></dl>

<p>
Definition at line <a class="el" href="a00237.html#l00355">355</a> of file <a class="el" href="a00237.html">URI.php</a>.    </td>
  </tr>
</table>
<a class="anchor" name="e3" doxytag="URI::fread"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">URI::fread           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">$&nbsp;</td>
          <td class="mdname" nowrap> <em>handle</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td class="md"></td>
          <td class="md" nowrap>$&nbsp;</td>
          <td class="mdname" nowrap> <em>length</em></td>
        </tr>
        <tr>
          <td class="md"></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"><code> [static]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Reads a number of bytes from a file.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>handle</em>&nbsp;</td><td>A valid file handle as returned by <a class="el" href="a00163.html#e2">URI::fopen()</a>. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>length</em>&nbsp;</td><td>The maximum number of bytes to be read. </td></tr>
  </table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>The read string or <code>false</code> if an error occurred.</dd></dl>

<p>
Definition at line <a class="el" href="a00237.html#l00392">392</a> of file <a class="el" href="a00237.html">URI.php</a>.    </td>
  </tr>
</table>
<a class="anchor" name="e7" doxytag="URI::fseek"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">URI::fseek           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">$&nbsp;</td>
          <td class="mdname" nowrap> <em>handle</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td class="md"></td>
          <td class="md" nowrap>$&nbsp;</td>
          <td class="mdname" nowrap> <em>offset</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td class="md"></td>
          <td class="md" nowrap>$&nbsp;</td>
          <td class="mdname" nowrap> <em>whence</em> = <code>SEEK_SET</code></td>
        </tr>
        <tr>
          <td class="md"></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"><code> [static]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Sets the file position on an open handle.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>handle</em>&nbsp;</td><td>A valid file handle as returned by <a class="el" href="a00163.html#e2">URI::fopen()</a>. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>offset</em>&nbsp;</td><td>The new byte position in the file. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>whence</em>&nbsp;</td><td>Please refer to the <a href="http://www.php.net/manual/en/function.fseek.php">PHP fseek() documentation</a>. </td></tr>
  </table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>The current byte position in the file, or <code>false</code> if an error occurred.</dd></dl>

<p>
Definition at line <a class="el" href="a00237.html#l00442">442</a> of file <a class="el" href="a00237.html">URI.php</a>.    </td>
  </tr>
</table>
<a class="anchor" name="e9" doxytag="URI::fstat"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">URI::fstat           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">$&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>handle</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap><code> [static]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Returns statistics about an open file.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>handle</em>&nbsp;</td><td>A valid file handle as returned by <a class="el" href="a00163.html#e2">URI::fopen()</a>. </td></tr>
  </table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>An array containing stats information. See the <a href="http://nl2.php.net/manual/en/function.stat.php">PHP stat() documentation</a> for details.</dd></dl>

<p>
Definition at line <a class="el" href="a00237.html#l00467">467</a> of file <a class="el" href="a00237.html">URI.php</a>.    </td>
  </tr>
</table>
<a class="anchor" name="e6" doxytag="URI::ftell"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">URI::ftell           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">$&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>handle</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap><code> [static]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Returns the file position of an open handle.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>handle</em>&nbsp;</td><td>A valid file handle as returned by <a class="el" href="a00163.html#e2">URI::fopen()</a>. </td></tr>
  </table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>The current byte position in the file.</dd></dl>

<p>
Definition at line <a class="el" href="a00237.html#l00427">427</a> of file <a class="el" href="a00237.html">URI.php</a>.    </td>
  </tr>
</table>
<a class="anchor" name="e4" doxytag="URI::fwrite"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">URI::fwrite           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">$&nbsp;</td>
          <td class="mdname" nowrap> <em>handle</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td class="md"></td>
          <td class="md" nowrap>$&nbsp;</td>
          <td class="mdname" nowrap> <em>string</em></td>
        </tr>
        <tr>
          <td class="md"></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"><code> [static]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Writes a string to a file.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>handle</em>&nbsp;</td><td>A valid file handle as returned by <a class="el" href="a00163.html#e2">URI::fopen()</a>. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>string</em>&nbsp;</td><td>The string to be written. </td></tr>
  </table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>The number of bytes actually written, might be 0 on error.</dd></dl>

<p>
Definition at line <a class="el" href="a00237.html#l00404">404</a> of file <a class="el" href="a00237.html">URI.php</a>.    </td>
  </tr>
</table>
<a class="anchor" name="e30" doxytag="URI::isDir"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">URI::isDir           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">$&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>path</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap><code> [static]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Returns whether the given path points to a directory or not.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>path</em>&nbsp;</td><td>Path to check whether it's a directory. </td></tr>
  </table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd><code>true</code> if it's a directory, <code>false</code> otherwise.</dd></dl>

<p>
Definition at line <a class="el" href="a00237.html#l01050">1050</a> of file <a class="el" href="a00237.html">URI.php</a>.    </td>
  </tr>
</table>
<a class="anchor" name="e31" doxytag="URI::isFile"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">URI::isFile           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">$&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>path</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap><code> [static]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Returns whether the given path points to a file or not.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>path</em>&nbsp;</td><td>Path to check whether it's a file. </td></tr>
  </table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd><code>true</code> if it's a file, <code>false</code> otherwise.</dd></dl>

<p>
Definition at line <a class="el" href="a00237.html#l01062">1062</a> of file <a class="el" href="a00237.html">URI.php</a>.    </td>
  </tr>
</table>
<a class="anchor" name="e32" doxytag="URI::isLink"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">URI::isLink           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">$&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>path</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap><code> [static]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Returns whether the given path points to a symbolic link or not.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>path</em>&nbsp;</td><td>Path to check whether it's a symlink. </td></tr>
  </table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd><code>true</code> if it's a symlink, <code>false</code> otherwise.</dd></dl>

<p>
Definition at line <a class="el" href="a00237.html#l01074">1074</a> of file <a class="el" href="a00237.html">URI.php</a>.    </td>
  </tr>
</table>
<a class="anchor" name="e0" doxytag="URI::isLocalURI"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">URI::isLocalURI           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">$&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>uri</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap><code> [static]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Determines whether <code>URI</code> is an Aukyla Local URI.<p>
A URI is found to be an Aukyla Local URI if the supplied protocol portion of the URI is recognized as a valid namespace for an Aukyla Local URI.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>uri</em>&nbsp;</td><td>The URI to check whether it's found to be an Aukyla Local URI. </td></tr>
  </table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd><code>true</code> if the URI is an Aukyla Local URI, <code>false</code> otherwise.</dd></dl>
<dl compact><dt><b>Since:</b></dt><dd>Aukyla 1.1</dd></dl>

<p>
Definition at line <a class="el" href="a00237.html#l00294">294</a> of file <a class="el" href="a00237.html">URI.php</a>.
<p>
References <a class="el" href="a00237.html#l00192">LocalURIManager::loadNamespace()</a>, and <a class="el" href="a00235.html#l00087">String::stripSpecialChars()</a>.    </td>
  </tr>
</table>
<a class="anchor" name="e33" doxytag="URI::metaData"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">URI::metaData           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">$&nbsp;</td>
          <td class="mdname" nowrap> <em>path</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td class="md"></td>
          <td class="md" nowrap>$&nbsp;</td>
          <td class="mdname" nowrap> <em>key</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td class="md"></td>
          <td class="md" nowrap>$&nbsp;</td>
          <td class="mdname" nowrap> <em>default</em> = <code>false</code></td>
        </tr>
        <tr>
          <td class="md"></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"><code> [static]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Returns meta-data about the given path.<p>
<dl compact><dt><b>Note:</b></dt><dd>Many namespaces use the "name" meta-data key to identify the display name of the file or directory. This display name should take precedence over the real name when showing the path to the user.</dd></dl>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>path</em>&nbsp;</td><td>Path to the file or directory to get the meta-data from. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>key</em>&nbsp;</td><td>The meta-data key to request. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>default</em>&nbsp;</td><td>The default value returned if the key does not exist. </td></tr>
  </table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>The meta-data associated with the path under the given key, or <code>default</code> if an error occurred.</dd></dl>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="a00163.html#e34">setMetaData()</a></dd></dl>

<p>
Definition at line <a class="el" href="a00237.html#l01097">1097</a> of file <a class="el" href="a00237.html">URI.php</a>.
<p>
Referenced by <a class="el" href="a00214.html#l00189">DocumentHandler::index()</a>.    </td>
  </tr>
</table>
<a class="anchor" name="e18" doxytag="URI::mkdir"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">URI::mkdir           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">$&nbsp;</td>
          <td class="mdname" nowrap> <em>path</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td class="md"></td>
          <td class="md" nowrap>$&nbsp;</td>
          <td class="mdname" nowrap> <em>options</em> = <code>STREAM_REPORT_ERRORS</code></td>
        </tr>
        <tr>
          <td class="md"></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"><code> [static]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Creates a new directory.<p>
Access permissions are inherited from the parent directory.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>path</em>&nbsp;</td><td>Path to the directory to be created. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>options</em>&nbsp;</td><td>Use 0 to suppress errors. </td></tr>
  </table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd><code>true</code> on success or <code>false</code> if an error occurred.</dd></dl>

<p>
Definition at line <a class="el" href="a00237.html#l00754">754</a> of file <a class="el" href="a00237.html">URI.php</a>.
<p>
Referenced by <a class="el" href="a00228.html#l00118">OpenOffice::convertSXW2XHTML()</a>, and <a class="el" href="a00227.html#l00333">OpenDocument::convertToXHTML()</a>.    </td>
  </tr>
</table>
<a class="anchor" name="e23" doxytag="URI::opendir"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">URI::opendir           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">$&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>path</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap><code> [static]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Opens a directory and returns a handle for use with subsequent <a class="el" href="a00163.html#e24">readdir()</a>, <a class="el" href="a00163.html#e25">rewinddir()</a> and <a class="el" href="a00163.html#e26">closedir()</a> calls.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>path</em>&nbsp;</td><td>Path to the directory to be opened. </td></tr>
  </table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>A handle to the open directory, or <code>false</code> if an error occurred.</dd></dl>

<p>
Definition at line <a class="el" href="a00237.html#l00937">937</a> of file <a class="el" href="a00237.html">URI.php</a>.    </td>
  </tr>
</table>
<a class="anchor" name="e15" doxytag="URI::permissions"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">URI::permissions           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">$&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>path</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap><code> [static]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Returns the access permissions for the current user to the given path.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>path</em>&nbsp;</td><td>Path to the file or directory to get the access permissions from. </td></tr>
  </table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>The permissions using the predefined PERMISSION_* constants, OR'd together, or <code>false</code> if an error occurred.</dd></dl>
<dl compact><dt><b>Note:</b></dt><dd>The PERMISSION_* constants are defined as follows: <ul>
<li>
<code>PERMISSION_NONE = 0x00000000</code> </li>
<li>
<code>PERMISSION_READ = 0x00000001</code> </li>
<li>
<code>PERMISSION_APPEND = 0x00000002</code> </li>
<li>
<code>PERMISSION_MODIFY = 0x00000004</code> </li>
<li>
<code>PERMISSION_DELETE = 0x00000008</code> </li>
<li>
<code>PERMISSION_ADMINISTRATE = 0x00000010</code> </li>
<li>
<code>PERMISSION_CUSTOM = 0x00010000</code> </li>
</ul>
</dd></dl>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="a00163.html#e16">permissionsArray()</a></dd></dl>

<p>
Definition at line <a class="el" href="a00237.html#l00647">647</a> of file <a class="el" href="a00237.html">URI.php</a>.
<p>
Referenced by <a class="el" href="a00228.html#l00118">OpenOffice::convertSXW2XHTML()</a>, <a class="el" href="a00227.html#l00333">OpenDocument::convertToXHTML()</a>, <a class="el" href="a00228.html#l00045">OpenOffice::convertXHTML2SXW()</a>, <a class="el" href="a00227.html#l00059">OpenDocument::load()</a>, and <a class="el" href="a00227.html#l00419">OpenDocument::scaleImages()</a>.    </td>
  </tr>
</table>
<a class="anchor" name="e16" doxytag="URI::permissionsArray"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">URI::permissionsArray           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">$&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>path</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap><code> [static]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Returns all access permissions set on the given path in an array.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>path</em>&nbsp;</td><td>Path to the file or directory to get the access permissions from. </td></tr>
  </table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>The current permissions. This is an array containing any out of three keys: "user", "group" and "other", where both user and group are arrays containing user/group =&gt; permissions pairs and where other contains the permissions for other users. Permissions are specified with the PERMISSION_* constants, OR'd together. Returns <code>false</code> if an error occurred.</dd></dl>
<b>Example array: </b> <div class="fragment"><pre class="fragment"> Array
 (
     [user] =&gt; Array
               (
                   [junior] =&gt; PERMISSION_READ |
                               PERMISSION_APPEND |
                               PERMISSION_MODIFY |
                               PERMISSION_DELETE |
                               PERMISSION_ADMINISTRATE
               )
     [group] =&gt; Array
                (
                    [users] =&gt; PERMISSION_READ
                )
     [other] =&gt; PERMISSION_NONE
 )
</pre></div><p>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="a00163.html#e15">permissions()</a> <a class="el" href="a00163.html#e17">setPermissionsArray()</a></dd></dl>

<p>
Definition at line <a class="el" href="a00237.html#l00687">687</a> of file <a class="el" href="a00237.html">URI.php</a>.    </td>
  </tr>
</table>
<a class="anchor" name="e24" doxytag="URI::readdir"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">URI::readdir           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">$&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>handle</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap><code> [static]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Returns an entry from the passed directory handle.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>handle</em>&nbsp;</td><td>A valid directory handle as returned by <a class="el" href="a00163.html#e23">URI::opendir()</a>. </td></tr>
  </table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>The name of the next entry in the open directory, or <code>false</code> if an error occurred.</dd></dl>

<p>
Definition at line <a class="el" href="a00237.html#l00954">954</a> of file <a class="el" href="a00237.html">URI.php</a>.    </td>
  </tr>
</table>
<a class="anchor" name="e22" doxytag="URI::rename"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">URI::rename           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">$&nbsp;</td>
          <td class="mdname" nowrap> <em>pathFrom</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td class="md"></td>
          <td class="md" nowrap>$&nbsp;</td>
          <td class="mdname" nowrap> <em>pathTo</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td class="md"></td>
          <td class="md" nowrap>&amp;$&nbsp;</td>
          <td class="mdname" nowrap> <em>realPathTo</em> = <code>''</code></td>
        </tr>
        <tr>
          <td class="md"></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"><code> [static]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Renames or moves a file or directory.<p>
<dl compact><dt><b>Note:</b></dt><dd>Moving files between different URI namespaces is not supported.</dd></dl>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>pathFrom</em>&nbsp;</td><td>The file or directory to move. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>pathTo</em>&nbsp;</td><td>The path to move the file or directory to. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>realPathTo</em>&nbsp;</td><td>You can give this argument to know what the real location of the entry is after it has been moved. </td></tr>
  </table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd><code>true</code> on success or <code>false</code> if an error occurred.</dd></dl>

<p>
Definition at line <a class="el" href="a00237.html#l00889">889</a> of file <a class="el" href="a00237.html">URI.php</a>.
<p>
References <a class="el" href="a00235.html#l00038">String::substringBefore()</a>.    </td>
  </tr>
</table>
<a class="anchor" name="e25" doxytag="URI::rewinddir"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">URI::rewinddir           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">$&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>handle</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap><code> [static]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Rewinds the directory handle so the next <a class="el" href="a00163.html#e24">readdir()</a> call will return the first entry again.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>handle</em>&nbsp;</td><td>A valid directory handle as returned by <a class="el" href="a00163.html#e23">URI::opendir()</a>. </td></tr>
  </table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd><code>true</code> on success or <code>false</code> if an error occurred.</dd></dl>

<p>
Definition at line <a class="el" href="a00237.html#l00966">966</a> of file <a class="el" href="a00237.html">URI.php</a>.    </td>
  </tr>
</table>
<a class="anchor" name="e19" doxytag="URI::rmdir"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">URI::rmdir           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">$&nbsp;</td>
          <td class="mdname" nowrap> <em>path</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td class="md"></td>
          <td class="md" nowrap>$&nbsp;</td>
          <td class="mdname" nowrap> <em>recursive</em> = <code>false</code></td>
        </tr>
        <tr>
          <td class="md"></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"><code> [static]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Recursively removes an entire directory.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>path</em>&nbsp;</td><td>Path to the directory to be removed. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>recursive</em>&nbsp;</td><td>If <code>true</code>, this will remove the directory, and all contents in it. </td></tr>
  </table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd><code>true</code> on success or <code>false</code> if an error occurred.</dd></dl>

<p>
Definition at line <a class="el" href="a00237.html#l00772">772</a> of file <a class="el" href="a00237.html">URI.php</a>.    </td>
  </tr>
</table>
<a class="anchor" name="e34" doxytag="URI::setMetaData"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">URI::setMetaData           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">$&nbsp;</td>
          <td class="mdname" nowrap> <em>path</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td class="md"></td>
          <td class="md" nowrap>$&nbsp;</td>
          <td class="mdname" nowrap> <em>key</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td class="md"></td>
          <td class="md" nowrap>$&nbsp;</td>
          <td class="mdname" nowrap> <em>value</em> = <code>false</code>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td class="md"></td>
          <td class="md" nowrap>$&nbsp;</td>
          <td class="mdname" nowrap> <em>recursive</em> = <code>false</code></td>
        </tr>
        <tr>
          <td class="md"></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"><code> [static]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Sets meta-data on the given path.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>path</em>&nbsp;</td><td>Path to the file or directory to set the meta-data on. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>key</em>&nbsp;</td><td>The meta-data key to set. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>value</em>&nbsp;</td><td>The value of the meta-data to set. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>recursive</em>&nbsp;</td><td>If this parameter is <code>true</code>, then all files and directories under this directory will get assigned the same meta key. This parameter has no effect on files. This parameter was introduced in Aukyla 1.1. </td></tr>
  </table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd><code>true</code> on success or <code>false</code> if an error occurred.</dd></dl>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="a00163.html#e33">metaData()</a></dd></dl>

<p>
Definition at line <a class="el" href="a00237.html#l01122">1122</a> of file <a class="el" href="a00237.html">URI.php</a>.    </td>
  </tr>
</table>
<a class="anchor" name="e17" doxytag="URI::setPermissionsArray"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">URI::setPermissionsArray           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">$&nbsp;</td>
          <td class="mdname" nowrap> <em>path</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td class="md"></td>
          <td class="md" nowrap>$&nbsp;</td>
          <td class="mdname" nowrap> <em>permissions</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td class="md"></td>
          <td class="md" nowrap>$&nbsp;</td>
          <td class="mdname" nowrap> <em>recursive</em> = <code>false</code></td>
        </tr>
        <tr>
          <td class="md"></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"><code> [static]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Changes the permissions of the given file or directory.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>path</em>&nbsp;</td><td>Path to the file or directory to change the permissions on, including namespace. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>permissions</em>&nbsp;</td><td>The new permissions. Permissions is supposed to be an array containing any out of three keys: "user", "group" and "other", where both user and group are arrays containing user/group =&gt; permissions pairs and where other contains the permissions value for other users. Permissions values are specified by or'ing Permission* constants. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>recursive</em>&nbsp;</td><td>If this parameter is <code>true</code>, then all files and directories under this directory will get assigned the same permissions. This parameter has no effect on files. This parameter was introduced in Aukyla 1.1. </td></tr>
  </table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd><code>true</code> on success or <code>false</code> if an error occurred.</dd></dl>

<p>
Definition at line <a class="el" href="a00237.html#l00715">715</a> of file <a class="el" href="a00237.html">URI.php</a>.    </td>
  </tr>
</table>
<a class="anchor" name="e28" doxytag="URI::stat"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">URI::stat           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">$&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>path</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap><code> [static]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Returns statistics about a file or directory.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>path</em>&nbsp;</td><td>Path to the file or directory to be examined. </td></tr>
  </table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>An array containing stats information. See the <a href="http://nl2.php.net/manual/en/function.stat.php">PHP stat() documentation</a> for details.</dd></dl>

<p>
Definition at line <a class="el" href="a00237.html#l01022">1022</a> of file <a class="el" href="a00237.html">URI.php</a>.    </td>
  </tr>
</table>
<a class="anchor" name="e20" doxytag="URI::touch"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">URI::touch           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">$&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>path</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap><code> [static]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Updates the time stamp on a file or creates the file if it doesn't exist yet.<p>
If a new file has to be created, it's access permissions are inherited from the parent directory.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>path</em>&nbsp;</td><td>Path to the file to be touched. </td></tr>
  </table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd><code>true</code> on success or <code>false</code> if an error occurred.</dd></dl>

<p>
Definition at line <a class="el" href="a00237.html#l00836">836</a> of file <a class="el" href="a00237.html">URI.php</a>.    </td>
  </tr>
</table>
<a class="anchor" name="e1" doxytag="URI::uniquePath"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">URI::uniquePath           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">$&nbsp;</td>
          <td class="mdname" nowrap> <em>path</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td class="md"></td>
          <td class="md" nowrap>$&nbsp;</td>
          <td class="mdname" nowrap> <em>suggestion</em></td>
        </tr>
        <tr>
          <td class="md"></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"><code> [static]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Returns a unique path which may be created in the given directory.<p>
If you wish to create a new file or directory in a directory, you are strongly advised to use this function to determine what name to give to the new file. The actual name that should be displayed to the user can then be set using <a class="el" href="a00163.html#e34">setMetaData()</a>, with the "name" key.<p>
No file or directory is created by this function.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>path</em>&nbsp;</td><td>Path to the directory in which to find a unique file or directory name. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>suggestion</em>&nbsp;</td><td>The basename you wish to suggest for the file or directory. The resulting filename may include or use this suggestion, but it might also be entirely ignored. </td></tr>
  </table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>A unique path or <code>false</code> if an error occurred.</dd></dl>
<b>Example: </b> <div class="fragment"><pre class="fragment"> <a class="code" href="a00163.html#e1">URI::uniquePath</a>('tmp:<span class="comment">//Foo', 'Bar')</span>
</pre></div>may return "tmp://Foo/Bar0".
<p>
Definition at line <a class="el" href="a00237.html#l00335">335</a> of file <a class="el" href="a00237.html">URI.php</a>.    </td>
  </tr>
</table>
<a class="anchor" name="e21" doxytag="URI::unlink"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">URI::unlink           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">$&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>path</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap><code> [static]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Removes a file.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>path</em>&nbsp;</td><td>Path to the file to be removed. </td></tr>
  </table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd><code>true</code> on success or <code>false</code> if an error occurred.</dd></dl>

<p>
Definition at line <a class="el" href="a00237.html#l00868">868</a> of file <a class="el" href="a00237.html">URI.php</a>.    </td>
  </tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="a00237.html">URI.php</a></ul>
    </div>
  </body>
</html>
Return current item: Aukyla Platform