Location: PHPKode > projects > Batch File Rename - BFR library > php-bfr.v1.5/doc/FileInf.class.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 FileInf</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"><img src="media/images/Class_logo.png"
														alt=" Class"
														title=" Class"
														style="vertical-align: middle"> FileInf (File information class)</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-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
						|											<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">PHP class to get file information.</p>
		<p class="notes">
			Located in <b>/class.fileinf.php</b> (line <span class="field"><a href="../__filesource/fsource_Batch__class.fileinf.php.html#a43">43</a></span>)
		</p>

				
		<pre></pre>
	
			</div>
</div>



	<a name="sec-var-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Variable Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
						<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
							| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
								</div>
		<div class="info-box-body">
			<div class="var-summary">
																																																								<div class="var-title">
					<img src="media/images/Variable.png" alt=" " />
					<span class="var-type">string</span>
					<a href="#$FileSrc" title="details" class="var-name">$FileSrc</a>
				</div>
																<div class="var-title">
					<img src="media/images/Variable.png" alt=" " />
					<span class="var-type">string</span>
					<a href="#$mod" title="details" class="var-name">$mod</a>
				</div>
																<div class="var-title">
					<img src="media/images/Variable.png" alt=" " />
					<span class="var-type">string</span>
					<a href="#$name" title="details" class="var-name">$name</a>
				</div>
																<div class="var-title">
					<img src="media/images/Variable.png" alt=" " />
					<span class="var-type">string</span>
					<a href="#$size" title="details" class="var-name">$size</a>
				</div>
																<div class="var-title">
					<img src="media/images/Variable.png" alt=" " />
					<span class="var-type">string</span>
					<a href="#$type" title="details" class="var-name">$type</a>
				</div>
											</div>
		</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> |
																		<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</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">
					<img src="media/images/Constructor.png" alt=" "/>
											<span class="method-result">void</span>
										<a href="#__construct" title="details" class="method-name">__construct</a>
											(<span class="var-type"></span>&nbsp;<span class="var-name">$file</span>)
									</div>
																<div class="method-definition">
					<img src="media/images/PrivateMethod.png" alt=" "/>
											<span class="method-result">string</span>
										<a href="#getBytesize_format" title="details" class="method-name">getBytesize_format</a>
											(<span class="var-type"></span>&nbsp;<span class="var-name">$number</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$decimals</span> = <span class="var-default">0</span>])
									</div>
																<div class="method-definition">
					<img src="media/images/PrivateMethod.png" alt=" "/>
											<span class="method-result">string</span>
										<a href="#getFileMod" title="details" class="method-name">getFileMod</a>
										()
									</div>
																<div class="method-definition">
					<img src="media/images/PrivateMethod.png" alt=" "/>
											<span class="method-result">string</span>
										<a href="#getFileSize" title="details" class="method-name">getFileSize</a>
										()
									</div>
																<div class="method-definition">
					<img src="media/images/PrivateMethod.png" alt=" "/>
											<span class="method-result">string</span>
										<a href="#getFileType" title="details" class="method-name">getFileType</a>
										()
									</div>
																<div class="method-definition">
					<img src="media/images/PrivateMethod.png" alt=" "/>
											<span class="method-result">void</span>
										<a href="#int" title="details" class="method-name">int</a>
										()
									</div>
											</div>
		</div>
	</div>		

	<a name="sec-vars"></a>
	<div class="info-box">
		<div class="info-box-title">Variables</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
										<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
						
			
										| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
					</div>
		<div class="info-box-body">
			
<a name="var$FileSrc" id="$FileSrc"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<img src="media/images/Variable.png" />
		<span class="var-title">
			<span class="var-type">string</span>
			<span class="var-name">$FileSrc</span>
						(line <span class="line-number"><a href="../__filesource/fsource_Batch__class.fileinf.php.html#a51">51</a></span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Contains the file path</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	
		
		

</div>
<a name="var$mod" id="$mod"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<img src="media/images/Variable.png" />
		<span class="var-title">
			<span class="var-type">string</span>
			<span class="var-name">$mod</span>
						(line <span class="line-number"><a href="../__filesource/fsource_Batch__class.fileinf.php.html#a79">79</a></span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Contains the file last modification date</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	
		
		

</div>
<a name="var$name" id="$name"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<img src="media/images/Variable.png" />
		<span class="var-title">
			<span class="var-type">string</span>
			<span class="var-name">$name</span>
						(line <span class="line-number"><a href="../__filesource/fsource_Batch__class.fileinf.php.html#a58">58</a></span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Contains the file name</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	
		
		

</div>
<a name="var$size" id="$size"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<img src="media/images/Variable.png" />
		<span class="var-title">
			<span class="var-type">string</span>
			<span class="var-name">$size</span>
						(line <span class="line-number"><a href="../__filesource/fsource_Batch__class.fileinf.php.html#a72">72</a></span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Contains the file size</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	
		
		

</div>
<a name="var$type" id="$type"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<img src="media/images/Variable.png" />
		<span class="var-title">
			<span class="var-type">string</span>
			<span class="var-name">$type</span>
						(line <span class="line-number"><a href="../__filesource/fsource_Batch__class.fileinf.php.html#a65">65</a></span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Contains the file type</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	
		
		

</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-var-summary">Vars</a> (<a href="#sec-vars">details</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="method__construct" id="__construct"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="media/images/Constructor.png" />
		<span class="method-title">Constructor __construct</span> (line <span class="line-number"><a href="../__filesource/fsource_Batch__class.fileinf.php.html#a87">87</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Constructor for initializing the class with default values.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			__construct
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">$file</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type"></span>
				<span class="var-name">$file</span>			</li>
				</ul>
		
			
	</div>
<a name="methodgetBytesize_format" id="getBytesize_format"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="media/images/PrivateMethod.png" />
		<span class="method-title">getBytesize_format</span> (line <span class="line-number"><a href="../__filesource/fsource_Batch__class.fileinf.php.html#a132">132</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Get file size with  KB/MB/GB</p>
	<ul class="tags">
				<li><span class="field">return:</span> file size</li>
				<li><span class="field">access:</span> private</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			getBytesize_format
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">$number</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$decimals</span> = <span class="var-default">0</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type"></span>
				<span class="var-name">$number</span>			</li>
					<li>
				<span class="var-type"></span>
				<span class="var-name">$decimals</span>			</li>
				</ul>
		
			
	</div>
<a name="methodgetFileMod" id="getFileMod"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="media/images/PrivateMethod.png" />
		<span class="method-title">getFileMod</span> (line <span class="line-number"><a href="../__filesource/fsource_Batch__class.fileinf.php.html#a213">213</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Get file last modification date</p>
	<ul class="tags">
				<li><span class="field">return:</span> file last modification date</li>
				<li><span class="field">access:</span> private</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			getFileMod
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodgetFileSize" id="getFileSize"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="media/images/PrivateMethod.png" />
		<span class="method-title">getFileSize</span> (line <span class="line-number"><a href="../__filesource/fsource_Batch__class.fileinf.php.html#a121">121</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Get file size in byets</p>
	<ul class="tags">
				<li><span class="field">return:</span> file size</li>
				<li><span class="field">access:</span> private</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			getFileSize
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodgetFileType" id="getFileType"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="media/images/PrivateMethod.png" />
		<span class="method-title">getFileType</span> (line <span class="line-number"><a href="../__filesource/fsource_Batch__class.fileinf.php.html#a202">202</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Get file size with  KB/MB/GB</p>
	<ul class="tags">
				<li><span class="field">return:</span> file size</li>
				<li><span class="field">access:</span> private</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			getFileType
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodint" id="int"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="media/images/PrivateMethod.png" />
		<span class="method-title">int</span> (line <span class="line-number"><a href="../__filesource/fsource_Batch__class.fileinf.php.html#a104">104</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">initializing the class with default values.</p>
	<ul class="tags">
				<li><span class="field">access:</span> private</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			int
		</span>
				()
			</div>
	
		
			
	</div>
						
		</div>
	</div>

	
	<p class="notes" id="credit">
		Documentation generated on Tue, 05 May 2009 23:38:29 +0300 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.1</a>
	</p>
	</div></body>
</html>
Return current item: Batch File Rename - BFR library