Location: PHPKode > projects > DIY Blog > diy-blog/lib/diy-framework/docs/diy-framework/controller/MultipartRequest.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 MultipartRequest</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 MultipartRequest</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">A utility class to handle multipart/form-data requests, the kind of requests that support file uploads.</p>
<p class="description"><p>Wraps PHP's functions and global arrays to emulate Java's MultipartRequest class.</p></p>
	<ul class="tags">
				<li><span class="field">author:</span> Martynas Jusevicius &lt;<a href="mailto:hide@address.com">hide@address.com</a>&gt;</li>
				<li><span class="field">link:</span> <a href="http://www.xml.lt">http://www.xml.lt</a></li>
			</ul>
		<p class="notes">
			Located in <a class="field" href="_diy-framework---controller---MultipartRequest.class.php.html">/diy-framework/controller/MultipartRequest.class.php</a> (line <span class="field">12</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">
											<span class="method-result">MultipartRequest</span>
										<a href="#__construct" title="details" class="method-name">__construct</a>
											(<span class="var-type"><a href="../../diy-framework/controller/Request.html">Request</a></span>&nbsp;<span class="var-name">$request</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$saveDir</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">string</span>
										<a href="#getContentType" title="details" class="method-name">getContentType</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$fileParam</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">string</span>
										<a href="#getFilesystemName" title="details" class="method-name">getFilesystemName</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$fileParam</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">string</span>
										<a href="#getOriginalFileName" title="details" class="method-name">getOriginalFileName</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$fileParam</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="method__construct" id="__construct"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">Constructor __construct</span> (line <span class="line-number">22</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Constructs MultipartRequest from a simple Request.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">MultipartRequest</span>
		<span class="method-name">
			__construct
		</span>
					(<span class="var-type"><a href="../../diy-framework/controller/Request.html">Request</a></span>&nbsp;<span class="var-name">$request</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$saveDir</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type"><a href="../../diy-framework/controller/Request.html">Request</a></span>
				<span class="var-name">$request</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$saveDir</span><span class="var-description">: Directory to save files to</span>			</li>
				</ul>
		
			
	</div>
<a name="methodgetContentType" id="getContentType"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">getContentType</span> (line <span class="line-number">33</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the content type of an uploaded file, or null if the file was not included in the upload.</p>
	<ul class="tags">
				<li><span class="field">return:</span> Content type</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			getContentType
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$fileParam</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$fileParam</span><span class="var-description">: The name of the file input in HTML</span>			</li>
				</ul>
		
			
	</div>
<a name="methodgetFilesystemName" id="getFilesystemName"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">getFilesystemName</span> (line <span class="line-number">45</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the filesystem name of an uploaded file, or null if the file was not included in the upload.</p>
	<ul class="tags">
				<li><span class="field">return:</span> Filesystem name</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			getFilesystemName
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$fileParam</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$fileParam</span><span class="var-description">: The name of the file input in HTML</span>			</li>
				</ul>
		
			
	</div>
<a name="methodgetOriginalFileName" id="getOriginalFileName"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">getOriginalFileName</span> (line <span class="line-number">57</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the original name of an uploaded file (as supplied by the client browser), or null if the file was not included in the upload.</p>
	<ul class="tags">
				<li><span class="field">return:</span> Original name</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			getOriginalFileName
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$fileParam</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$fileParam</span><span class="var-description">: The name of the file input in HTML</span>			</li>
				</ul>
		
			
	</div>
						
		</div>
	</div>


	<p class="notes" id="credit">
		Documentation generated on Tue, 25 Sep 2007 11:17:21 +0200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
	</p>
	</div></body>
</html>
Return current item: DIY Blog