Location: PHPKode > projects > DIY Blog > diy-blog/docs/diy-blog-model-map/UserMapBuilder.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 UserMapBuilder</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 UserMapBuilder</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>)
						
											<a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
						
			</div>
	<div class="info-box-body">
        		<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">This class adds structure of 'User' table to 'diy-blog' DatabaseMap object.</p>
<p class="description"><p>This class was autogenerated by Propel on:</p><p>09/26/07 22:26:20</p><p>These statically-built map classes are used by Propel to do runtime db structure discovery.  For example, the createSelectSql() method checks the type of a given column used in an  ORDER BY clause to know whether it needs to apply SQL to make the ORDER BY case-insensitive  (i.e. if it's a text column type).</p></p>
		<p class="notes">
			Located in <a class="field" href="_model---map---UserMapBuilder.php.html">/model/map/UserMapBuilder.php</a> (line <span class="field">23</span>)
		</p>
		
				
		<pre></pre>
	
			</div>
</div>


	<a name="sec-const-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Class Constant Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
						<span class="disabled">Constants</span> (<a href="#sec-consts">details</a>)
										| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
					</div>
		<div class="info-box-body">
			<div class="const-summary">
								<div class="const-title">
					<img src="../media/images/Constant.png" alt=" " />
					<a href="#CLASS_NAME" title="details" class="const-name">CLASS_NAME</a> = 					<span class="var-type"> 'diy-blog.model.map.UserMapBuilder'</span>

				</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-const-summary">Constants</a> (<a href="#sec-consts">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="#doBuild" title="details" class="method-name">doBuild</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">the</span>
										<a href="#getDatabaseMap" title="details" class="method-name">getDatabaseMap</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">boolean</span>
										<a href="#isBuilt" title="details" class="method-name">isBuilt</a>
										()
									</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-const-summary">Constants</a> (<a href="#sec-consts">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="methoddoBuild" id="doBuild"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">doBuild</span> (line <span class="line-number">62</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The doBuild() method builds the DatabaseMap</p>
	<ul class="tags">
				<li><span class="field">throws:</span> PropelException</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			doBuild
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodgetDatabaseMap" id="getDatabaseMap"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">getDatabaseMap</span> (line <span class="line-number">51</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Gets the databasemap this map builder built.</p>
	<ul class="tags">
				<li><span class="field">return:</span> databasemap</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">the</span>
		<span class="method-name">
			getDatabaseMap
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodisBuilt" id="isBuilt"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">isBuilt</span> (line <span class="line-number">41</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Tells us if this DatabaseMapBuilder is built so that we  don't have to re-build it every time.</p>
	<ul class="tags">
				<li><span class="field">return:</span> true if this DatabaseMapBuilder is built, false otherwise.</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">boolean</span>
		<span class="method-name">
			isBuilt
		</span>
				()
			</div>
	
		
			
	</div>
						
		</div>
	</div>

	<a name="sec-consts"></a>
	<div class="info-box">
		<div class="info-box-title">Class Constants</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
										<a href="#sec-var-summary">Constants</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="constCLASS_NAME" id="CLASS_NAME"><!-- --></A>
<div class="oddrow">

	<div class="const-header">
		<img src="../media/images/Variable.png" />
		<span class="const-title">
			<span class="const-name">CLASS_NAME</span>
			 = <span class="const-default"> 'diy-blog.model.map.UserMapBuilder'</span>
			(line <span class="line-number">28</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The (dot-path) name of this class</p>
	
	
</div>

						
		</div>
	</div>

	<p class="notes" id="credit">
		Documentation generated on Wed, 26 Sep 2007 23:20:09 +0200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
	</p>
	</div></body>
</html>
Return current item: DIY Blog