Location: PHPKode > scripts > IAM Backup > iam-backup/docs/iam_backup/iam_restore.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 iam_restore</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 iam_restore</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">IAM_restore A class for restoring a database from a backup file</p>
		<p class="notes">
			Located in <a class="field" href="_iam_restore_php.html">/iam_restore.php</a> (line <span class="field"><a href="..//__filesource/fsource_iam_backup__iam_restore.php.html#a26">26</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">
					<span class="var-type">string</span>
					<a href="#$dbname" title="details" class="var-name">$dbname</a>
				</div>
								<div class="var-title">
					<span class="var-type">string</span>
					<a href="#$dbpass" title="details" class="var-name">$dbpass</a>
				</div>
								<div class="var-title">
					<span class="var-type">string</span>
					<a href="#$dbuser" title="details" class="var-name">$dbuser</a>
				</div>
								<div class="var-title">
					<span class="var-type">String</span>
					<a href="#$filename" title="details" class="var-name">$filename</a>
				</div>
								<div class="var-title">
					<span class="var-type">string</span>
					<a href="#$host" title="details" class="var-name">$host</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">
											<span class="method-result">iam_restore</span>
										<a href="#iam_restore" title="details" class="method-name">iam_restore</a>
											(<span class="var-type">String</span>&nbsp;<span class="var-name">$filename</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$host</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$dbname</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$dbuser</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$dbpass</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$dbanme</span>)
									</div>
								
				<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#perform_restore" title="details" class="method-name">perform_restore</a>
										()
									</div>
								
				<div class="method-definition">
											<span class="method-result">String</span>
										<a href="#_Open" title="details" class="method-name">_Open</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$dbname" id="$dbname"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">string</span>
			<span class="var-name">$dbname</span>
			 = <span class="var-default">&quot;mysql&quot;</span>			(line <span class="line-number"><a href="..//__filesource/fsource_iam_backup__iam_restore.php.html#a38">38</a></span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">var:</span> Database to restore</li>
				<li><span class="field">access:</span> private</li>
			</ul>
	
	
		
		

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

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">string</span>
			<span class="var-name">$dbpass</span>
			 = <span class="var-default">&quot;&quot;</span>			(line <span class="line-number"><a href="..//__filesource/fsource_iam_backup__iam_restore.php.html#a51">51</a></span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">var:</span> Password to access the Database</li>
				<li><span class="field">access:</span> private</li>
			</ul>
	
	
		
		

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

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">string</span>
			<span class="var-name">$dbuser</span>
			 = <span class="var-default">&quot;root&quot;</span>			(line <span class="line-number"><a href="..//__filesource/fsource_iam_backup__iam_restore.php.html#a45">45</a></span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">var:</span> User to access the Database</li>
				<li><span class="field">access:</span> private</li>
			</ul>
	
	
		
		

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

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">String</span>
			<span class="var-name">$filename</span>
						(line <span class="line-number"><a href="..//__filesource/fsource_iam_backup__iam_restore.php.html#a58">58</a></span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">var:</span> Filename from which the class will restore the DB</li>
				<li><span class="field">access:</span> private</li>
			</ul>
	
	
		
		

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

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">string</span>
			<span class="var-name">$host</span>
			 = <span class="var-default">&quot;localhost&quot;</span>			(line <span class="line-number"><a href="..//__filesource/fsource_iam_backup__iam_restore.php.html#a32">32</a></span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">var:</span> Host that holds the DB</li>
				<li><span class="field">access:</span> private</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="methodiam_restore" id="iam_restore"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">Constructor iam_restore</span> (line <span class="line-number"><a href="..//__filesource/fsource_iam_backup__iam_restore.php.html#a69">69</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Initialize this class. Constructor</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">iam_restore</span>
		<span class="method-name">
			iam_restore
		</span>
					(<span class="var-type">String</span>&nbsp;<span class="var-name">$filename</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$host</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$dbname</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$dbuser</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$dbpass</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$dbanme</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">String</span>
				<span class="var-name">$filename</span><span class="var-description">: Filename from which the class will restore the DB</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$host</span><span class="var-description">: Host that holds the DB</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$dbanme</span><span class="var-description">: Database to restore</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$dbuser</span><span class="var-description">: User to access the Database</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$dbpass</span><span class="var-description">: Password to access the Database</span>			</li>
				</ul>
		
		
	</div>
<a name="methodperform_restore" id="perform_restore"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">perform_restore</span> (line <span class="line-number"><a href="..//__filesource/fsource_iam_backup__iam_restore.php.html#a98">98</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Restore the data from file</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">
			perform_restore
		</span>
				()
			</div>
	
		
		
	</div>
<a name="method_Open" id="_Open"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">_Open</span> (line <span class="line-number"><a href="..//__filesource/fsource_iam_backup__iam_restore.php.html#a83">83</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Open the file containing the backup data</p>
	<ul class="tags">
				<li><span class="field">return:</span> a String containing the DB Dump</li>
				<li><span class="field">access:</span> private</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">String</span>
		<span class="method-name">
			_Open
		</span>
				()
			</div>
	
		
		
	</div>
						
		</div>
	</div>
	
	<p class="notes" id="credit">
		Documentation generated on Thu, 11 Dec 2003 15:35:29 -0300 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.2.3</a>
	</p>
	</div></body>
</html>
Return current item: IAM Backup