pickles/docs/PICKLES/File.html

111 lines
No EOL
3.7 KiB
HTML

<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<!-- template designed by Marco Von Ballmoos -->
<title>Docs For Class File</title>
<link rel="stylesheet" href="../media/stylesheet.css" />
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
</head>
<body>
<div class="page-body">
<h2 class="class-name">Class File</h2>
<a name="sec-description"></a>
<div class="info-box">
<div class="info-box-title">Description</div>
<div class="nav-bar">
<span class="disabled">Description</span> |
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">File Class</p>
<p class="description"><p>Just a simple collection of static functions to accomplish some of the more redundant file related manipulation.</p></p>
<p class="notes">
Located in <a class="field" href="_classes---File.php.html">/classes/File.php</a> (line <span class="field">24</span>)
</p>
<pre></pre>
</div>
</div>
<a name="sec-method-summary"></a>
<div class="info-box">
<div class="info-box-title">Method Summary</span></div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<div class="method-summary">
<div class="method-definition">
static <span class="method-result">boolean</span>
<a href="#removeDirectory" title="details" class="method-name">removeDirectory</a>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$directory</span>)
</div>
</div>
</div>
</div>
<a name="sec-methods"></a>
<div class="info-box">
<div class="info-box-title">Methods</div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
</div>
<div class="info-box-body">
<A NAME='method_detail'></A>
<a name="methodremoveDirectory" id="removeDirectory"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">static method removeDirectory</span> (line <span class="line-number">37</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Remove a Directory, Recursively</p>
<p class="description"><p>Removes a directory by emptying all of the contents recursively and then removing the directory, as PHP will not let you rmdir() on ain non-empty directory. Use with caution, seriously.</p></p>
<ul class="tags">
<li><span class="field">return:</span> status of the final rmdir();</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
static
<span class="method-result">boolean</span>
<span class="method-name">
removeDirectory
</span>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$directory</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$directory</span><span class="var-description">: directory to remove</span> </li>
</ul>
</div>
</div>
</div>
<p class="notes" id="credit">
Documentation generated on Sun, 14 Oct 2012 14:02:18 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.4</a>
</p>
</div></body>
</html>