Location: PHPKode > projects > Moc10 PHP Library > docs/api-docs/Moc10_Image/Moc10_Image_Upload.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>
		<head>
			<!-- template designed by Marco Von Ballmoos -->
			<title>Docs For Class Moc10_Image_Upload</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 Moc10_Image_Upload</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">Moc10_Image_Upload</p>
	<ul class="tags">
				<li><span class="field">author:</span> Nick Sagona, III &lt;<a href="mailto:hide@address.com">hide@address.com</a>&gt;</li>
				<li><span class="field">version:</span> 1.9.7</li>
				<li><span class="field">copyright:</span> Copyright (c) 2009-2011 Moc 10 Media, LLC. (http://www.moc10media.com)</li>
				<li><span class="field">license:</span> <a href="http://www.moc10phplibrary.com/LICENSE.TXT">New BSD License</a></li>
			</ul>
		<p class="notes">
			Located in <a class="field" href="_Image---Upload.php.html">/Image/Upload.php</a> (line <span class="field">33</span>)
		</p>
		
				
		<pre><a href="../Moc10_File/Moc10_File.html">Moc10_File</a>
   |
   --<a href="../Moc10_Image/Moc10_Image.html">Moc10_Image</a>
      |
      --Moc10_Image_Upload</pre>
	
			</div>
</div>



	<a name="sec-var-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Variable Summary</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">
					<span class="var-type">int</span>
					<a href="#$_max" title="details" class="var-name">$_max</a>
				</div>
											</div>
		</div>
	</div>

	<a name="sec-method-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Method Summary</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">
											<span class="method-result">void</span>
										<a href="#__construct" title="details" class="method-name">__construct</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$upload</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$file</span>, [<span class="var-type">int</span>&nbsp;<span class="var-name">$size</span> = <span class="var-default">null</span>], [<span class="var-type">array</span>&nbsp;<span class="var-name">$types</span> = <span class="var-default">null</span>])
									</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$_max" id="$_max"><!-- --></a>
<div class="oddrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">int</span>
			<span class="var-name">$_max</span>
			 = <span class="var-default"> 5000000</span>			(line <span class="line-number">40</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Set the maximum allowed image file size. Set to null to allow any size.</p>
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	
		
		

</div>
							<h4>Inherited Variables</h4>
				<a name='inherited_vars'><!-- --></a>
									<p>Inherited from <span class="classname"><a href="../Moc10_Image/Moc10_Image.html">Moc10_Image</a></span></p>
					<blockquote>
													<span class="var-title">
								<span class="var-name"><a href="../Moc10_Image/Moc10_Image.html#var$channels">Moc10_Image::$channels</a></span><br />
							</span>
													<span class="var-title">
								<span class="var-name"><a href="../Moc10_Image/Moc10_Image.html#var$height">Moc10_Image::$height</a></span><br />
							</span>
													<span class="var-title">
								<span class="var-name"><a href="../Moc10_Image/Moc10_Image.html#var$width">Moc10_Image::$width</a></span><br />
							</span>
													<span class="var-title">
								<span class="var-name"><a href="../Moc10_Image/Moc10_Image.html#var$_allowed">Moc10_Image::$_allowed</a></span><br />
							</span>
													<span class="var-title">
								<span class="var-name"><a href="../Moc10_Image/Moc10_Image.html#var$_lang">Moc10_Image::$_lang</a></span><br />
							</span>
													<span class="var-title">
								<span class="var-name"><a href="../Moc10_Image/Moc10_Image.html#var$_quality">Moc10_Image::$_quality</a></span><br />
							</span>
											</blockquote> 
									<p>Inherited from <span class="classname"><a href="../Moc10_File/Moc10_File.html">Moc10_File</a></span></p>
					<blockquote>
													<span class="var-title">
								<span class="var-name"><a href="../Moc10_File/Moc10_File.html#var$basename">Moc10_File::$basename</a></span><br />
							</span>
													<span class="var-title">
								<span class="var-name"><a href="../Moc10_File/Moc10_File.html#var$dir">Moc10_File::$dir</a></span><br />
							</span>
													<span class="var-title">
								<span class="var-name"><a href="../Moc10_File/Moc10_File.html#var$ext">Moc10_File::$ext</a></span><br />
							</span>
													<span class="var-title">
								<span class="var-name"><a href="../Moc10_File/Moc10_File.html#var$filename">Moc10_File::$filename</a></span><br />
							</span>
													<span class="var-title">
								<span class="var-name"><a href="../Moc10_File/Moc10_File.html#var$fullpath">Moc10_File::$fullpath</a></span><br />
							</span>
													<span class="var-title">
								<span class="var-name"><a href="../Moc10_File/Moc10_File.html#var$mime">Moc10_File::$mime</a></span><br />
							</span>
													<span class="var-title">
								<span class="var-name"><a href="../Moc10_File/Moc10_File.html#var$size">Moc10_File::$size</a></span><br />
							</span>
													<span class="var-title">
								<span class="var-name"><a href="../Moc10_File/Moc10_File.html#var$_output">Moc10_File::$_output</a></span><br />
							</span>
													<span class="var-title">
								<span class="var-name"><a href="../Moc10_File/Moc10_File.html#var$_perm">Moc10_File::$_perm</a></span><br />
							</span>
											</blockquote> 
										
		</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">
		<span class="method-title">Constructor __construct</span> (line <span class="line-number">54</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Constructor</p>
<p class="description">Instantiate a image file object based on an image file that has been uploaded.</p>
	<ul class="tags">
				<li><span class="field">throws:</span> Exception</li>
				<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">string</span>&nbsp;<span class="var-name">$upload</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$file</span>, [<span class="var-type">int</span>&nbsp;<span class="var-name">$size</span> = <span class="var-default">null</span>], [<span class="var-type">array</span>&nbsp;<span class="var-name">$types</span> = <span class="var-default">null</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$upload</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$file</span>			</li>
					<li>
				<span class="var-type">int</span>
				<span class="var-name">$size</span>			</li>
					<li>
				<span class="var-type">array</span>
				<span class="var-name">$types</span>			</li>
				</ul>
		
			<hr class="separator" />
		<div class="notes">Redefinition of:</div>
		<dl>
			<dt><a href="../Moc10_Image/Moc10_Image.html#method__construct">Moc10_Image::__construct()</a></dt>
						<dd>Constructor</dd>
					</dl>
			
	</div>
							<h4>Inherited Methods</h4>
				<a name='inherited_methods'><!-- --></a>	
									<!-- =========== Summary =========== -->
					<p>Inherited From <span class="classname"><a href="../Moc10_Image/Moc10_Image.html">Moc10_Image</a></span></p>
					<blockquote>
													<span class="method-name"><a href="../Moc10_Image/Moc10_Image.html#method__construct">Moc10_Image::__construct()</a></span><br />
													<span class="method-name"><a href="../Moc10_Image/Moc10_Image.html#methodcolorTotal">Moc10_Image::colorTotal()</a></span><br />
													<span class="method-name"><a href="../Moc10_Image/Moc10_Image.html#methodconvert">Moc10_Image::convert()</a></span><br />
													<span class="method-name"><a href="../Moc10_Image/Moc10_Image.html#methodcrop">Moc10_Image::crop()</a></span><br />
													<span class="method-name"><a href="../Moc10_Image/Moc10_Image.html#methodgetColors">Moc10_Image::getColors()</a></span><br />
													<span class="method-name"><a href="../Moc10_Image/Moc10_Image.html#methodresize">Moc10_Image::resize()</a></span><br />
													<span class="method-name"><a href="../Moc10_Image/Moc10_Image.html#methodscale">Moc10_Image::scale()</a></span><br />
													<span class="method-name"><a href="../Moc10_Image/Moc10_Image.html#methodtext">Moc10_Image::text()</a></span><br />
													<span class="method-name"><a href="../Moc10_Image/Moc10_Image.html#method_createImage">Moc10_Image::_createImage()</a></span><br />
													<span class="method-name"><a href="../Moc10_Image/Moc10_Image.html#method_createNew">Moc10_Image::_createNew()</a></span><br />
													<span class="method-name"><a href="../Moc10_Image/Moc10_Image.html#method_save">Moc10_Image::_save()</a></span><br />
													<span class="method-name"><a href="../Moc10_Image/Moc10_Image.html#method_setQuality">Moc10_Image::_setQuality()</a></span><br />
											</blockquote>
									<!-- =========== Summary =========== -->
					<p>Inherited From <span class="classname"><a href="../Moc10_File/Moc10_File.html">Moc10_File</a></span></p>
					<blockquote>
													<span class="method-name"><a href="../Moc10_File/Moc10_File.html#method__construct">Moc10_File::__construct()</a></span><br />
													<span class="method-name"><a href="../Moc10_File/Moc10_File.html#methodcopy">Moc10_File::copy()</a></span><br />
													<span class="method-name"><a href="../Moc10_File/Moc10_File.html#methoddelete">Moc10_File::delete()</a></span><br />
													<span class="method-name"><a href="../Moc10_File/Moc10_File.html#methodexport">Moc10_File::export()</a></span><br />
													<span class="method-name"><a href="../Moc10_File/Moc10_File.html#methodgetAllowedTypes">Moc10_File::getAllowedTypes()</a></span><br />
													<span class="method-name"><a href="../Moc10_File/Moc10_File.html#methodgetMode">Moc10_File::getMode()</a></span><br />
													<span class="method-name"><a href="../Moc10_File/Moc10_File.html#methodimport">Moc10_File::import()</a></span><br />
													<span class="method-name"><a href="../Moc10_File/Moc10_File.html#methodmove">Moc10_File::move()</a></span><br />
													<span class="method-name"><a href="../Moc10_File/Moc10_File.html#methodoutput">Moc10_File::output()</a></span><br />
													<span class="method-name"><a href="../Moc10_File/Moc10_File.html#methodread">Moc10_File::read()</a></span><br />
													<span class="method-name"><a href="../Moc10_File/Moc10_File.html#methodsetFile">Moc10_File::setFile()</a></span><br />
													<span class="method-name"><a href="../Moc10_File/Moc10_File.html#methodsetMode">Moc10_File::setMode()</a></span><br />
													<span class="method-name"><a href="../Moc10_File/Moc10_File.html#methodwrite">Moc10_File::write()</a></span><br />
													<span class="method-name"><a href="../Moc10_File/Moc10_File.html#method_checkPermissions">Moc10_File::_checkPermissions()</a></span><br />
													<span class="method-name"><a href="../Moc10_File/Moc10_File.html#method_setAllowedTypes">Moc10_File::_setAllowedTypes()</a></span><br />
											</blockquote>
										
		</div>
	</div>


	<p class="notes" id="credit">
		Documentation generated on Wed, 12 Jan 2011 01:17:46 -0600 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
	</p>
	</div></body>
</html>
Return current item: Moc10 PHP Library