Location: PHPKode > projects > Tagging manager > version 1.02/DOC/userclass/User.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>
  <title>Docs For Class User</title>
  <link rel="stylesheet" href="../media/stylesheet.css" />
  <script src="../media/lib/classTree.js"></script>
<link id="webfx-tab-style-sheet" type="text/css" rel="stylesheet" href="../media/lib/tab.webfx.css" />
<script type="text/javascript" src="../media/lib/tabpane.js"></script>
  <script language="javascript" type="text/javascript" src="../media/lib/ua.js"></script>
<script language="javascript" type="text/javascript">
	var imgPlus = new Image();
	var imgMinus = new Image();
	imgPlus.src = "../media/images/plus.gif";
	imgMinus.src = "../media/images/minus.gif";
	
	function showNode(Node){
        switch(navigator.family){
        	case 'nn4':
        		// Nav 4.x code fork...
				var oTable = document.layers["span" + Node];
				var oImg = document.layers["img" + Node];
        		break;
        	case 'ie4':
        		// IE 4/5 code fork...
				var oTable = document.all["span" + Node];
				var oImg = document.all["img" + Node];
        		break;
        	case 'gecko':
        		// Standards Compliant code fork...
				var oTable = document.getElementById("span" + Node);
				var oImg = document.getElementById("img" + Node);
        		break;
        }
		oImg.src = imgMinus.src;
		oTable.style.display = "block";
	}
	
	function hideNode(Node){
        switch(navigator.family){
        	case 'nn4':
        		// Nav 4.x code fork...
				var oTable = document.layers["span" + Node];
				var oImg = document.layers["img" + Node];
        		break;
        	case 'ie4':
        		// IE 4/5 code fork...
				var oTable = document.all["span" + Node];
				var oImg = document.all["img" + Node];
        		break;
        	case 'gecko':
        		// Standards Compliant code fork...
				var oTable = document.getElementById("span" + Node);
				var oImg = document.getElementById("img" + Node);
        		break;
        }
		oImg.src = imgPlus.src;
		oTable.style.display = "none";
	}
	
	function nodeIsVisible(Node){
        switch(navigator.family){
        	case 'nn4':
        		// Nav 4.x code fork...
				var oTable = document.layers["span" + Node];
        		break;
        	case 'ie4':
        		// IE 4/5 code fork...
				var oTable = document.all["span" + Node];
        		break;
        	case 'gecko':
        		// Standards Compliant code fork...
				var oTable = document.getElementById("span" + Node);
        		break;
        }
		return (oTable && oTable.style.display == "block");
	}
	
	function toggleNodeVisibility(Node){
		if (nodeIsVisible(Node)){
			hideNode(Node);
		}else{
			showNode(Node);
		}
	}
</script>
<!-- template designed by Julien Damon based on PHPEdit's generated templates, and tweaked by Greg Beaver -->
<body bgcolor="#ffffff" ><!-- Start of Class Data -->
<h2>
	Class User
</h2> (line <span class="linenumber">24</span>)
<div class="tab-pane" id="tabPane1">
<script type="text/javascript">
tp1 = new WebFXTabPane( document.getElementById( "tabPane1" ));
</script>

<div class="tab-page" id="Description">
<h2 class="tab">Description</h2>
<pre>
</pre>
<p>
	<b><i>Located in File: <a href="_includes_user_php.html">/includes/user.php</a></i></b><br>
</p>
<!-- ========== Info from phpDoc block ========= -->
<h5>userclass</h5>
<ul>
	</ul>
<br /><hr />
</div>
<script type="text/javascript">tp1.addTabPage( document.getElementById( "Description" ) );</script>
<div class="tab-page" id="tabPage1">

<h2 class="tab">Class Variables</h2>
<!-- ============ VARIABLE DETAIL =========== -->
<strong>Summary:</strong><br />
<div class="var-title">
    <span class="var-type">mixed</span>
    <a href="#var$active" title="details" class="property"><strong>$active</strong></a>
</div>
<div class="var-title">
    <span class="var-type">mixed</span>
    <a href="#var$userID" title="details" class="property"><strong>$userID</strong></a>
</div>
<div class="var-title">
    <span class="var-type">mixed</span>
    <a href="#var$userName" title="details" class="property"><strong>$userName</strong></a>
</div>
<div class="var-title">
    <span class="var-type">mixed</span>
    <a href="#var$userPassword" title="details" class="property"><strong>$userPassword</strong></a>
</div>
<hr />
<a name="var$active" id="var$active"><!-- --></A>
<div style="background='#eeeeee'">
<h4>
<img src="../media/images/PublicProperty.gif" border="0" /> <strong class="property">$active</strong> (line <span class="linenumber">29</span>)
 </h4>
<h4>Data type : mixed</h4>
<!-- ========== Info from phpDoc block ========= -->
<ul>
	</ul>
</div>
<a name="var$userID" id="var$userID"><!-- --></A>
<div style="background='#ffffff'">
<h4>
<img src="../media/images/PublicProperty.gif" border="0" /> <strong class="property">$userID</strong> (line <span class="linenumber">26</span>)
 </h4>
<h4>Data type : mixed</h4>
<!-- ========== Info from phpDoc block ========= -->
<ul>
	</ul>
</div>
<a name="var$userName" id="var$userName"><!-- --></A>
<div style="background='#eeeeee'">
<h4>
<img src="../media/images/PublicProperty.gif" border="0" /> <strong class="property">$userName</strong> (line <span class="linenumber">27</span>)
 </h4>
<h4>Data type : mixed</h4>
<!-- ========== Info from phpDoc block ========= -->
<ul>
	</ul>
</div>
<a name="var$userPassword" id="var$userPassword"><!-- --></A>
<div style="background='#ffffff'">
<h4>
<img src="../media/images/PublicProperty.gif" border="0" /> <strong class="property">$userPassword</strong> (line <span class="linenumber">28</span>)
 </h4>
<h4>Data type : mixed</h4>
<!-- ========== Info from phpDoc block ========= -->
<ul>
	</ul>
</div>
<script type="text/javascript">tp1.addTabPage( document.getElementById( "tabPage1" ) );</script>
</div>
<div class="tab-page" id="constantsTabpage">

<h2 class="tab">Class Constants</h2>
<!-- ============ VARIABLE DETAIL =========== -->
<strong>Summary:</strong><br />
<hr />
<script type="text/javascript">tp1.addTabPage( document.getElementById( "constantsTabpage" ) );</script>
</div>
<div class="tab-page" id="tabPage2">
<h2 class="tab">Method Detail</h2>
<!-- ============ METHOD DETAIL =========== -->
<strong>Summary:</strong><br />
<div class="method-summary">
				
    <div class="method-definition">
            <span class="method-result">User</span>
        <a href="#methodUser" title="details" class="method-name">User</a>
        ()
        </div>
				
    <div class="method-definition">
            <span class="method-result">void</span>
        <a href="#methodchangePassword" title="details" class="method-name">changePassword</a>
        (<span class="var-type">string</span>&nbsp;<span class="var-name">$newPassword</span>)
        </div>
				
    <div class="method-definition">
            <span class="method-result">void</span>
        <a href="#methoddelete" title="details" class="method-name">delete</a>
        (<span class="var-type">integer</span>&nbsp;<span class="var-name">$id</span>)
        </div>
				
    <div class="method-definition">
            <span class="method-result">void</span>
        <a href="#methoddisplayUserInfo" title="details" class="method-name">displayUserInfo</a>
        ()
        </div>
				
    <div class="method-definition">
            <span class="method-result">void</span>
        <a href="#methodgetUser" title="details" class="method-name">getUser</a>
        (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$userName</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$username</span>)
        </div>
				
    <div class="method-definition">
            <span class="method-result">void</span>
        <a href="#methodgetUserbyid" title="details" class="method-name">getUserbyid</a>
        (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$user_id</span>, <span class="var-type">integer</span>&nbsp;<span class="var-name">$id</span>)
        </div>
				
    <div class="method-definition">
            <span class="method-result">void</span>
        <a href="#methodsetUser" title="details" class="method-name">setUser</a>
        ()
        </div>
				
    <div class="method-definition">
            <span class="method-result">void</span>
        <a href="#methodupdateUser" title="details" class="method-name">updateUser</a>
        (<span class="var-type">integer</span>&nbsp;<span class="var-name">$id</span>)
        </div>
				
    <div class="method-definition">
            <span class="method-result">void</span>
        <a href="#methodverifyPassword" title="details" class="method-name">verifyPassword</a>
        ()
        </div>
</div>
<hr />
<A NAME='method_detail'></A>


<a name="methodUser" id="methodUser"><!-- --></a>
<div style="background='#eeeeee'"><h4>
<img src="../media/images/Constructor.gif" border="0" /> <strong class="method">Constructor User</strong> (line <span class="linenumber">34</span>)
 </h4> 
<h4><i>User</i> <strong>User(
)</strong></h4>

<!-- ========== Info from phpDoc block ========= -->
<h5>user constructor</h5>
		
	<h4>Info</h4>
	<ul>
		</ul>
</div>
<a name="methodchangePassword" id="methodchangePassword"><!-- --></a>
<div style="background='#ffffff'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method changePassword</strong> (line <span class="linenumber">137</span>)
 </h4> 
<h4><i>void</i> <strong>changePassword(
string
$newPassword)</strong></h4>

<!-- ========== Info from phpDoc block ========= -->
<h5>Quickway to update a password for a user</h5>
		<h4>Parameters</h4>
	<ul>
			<li><strong>string $newPassword</strong>: New password you want to set for this user</li>
		</ul>
		
	<h4>Info</h4>
	<ul>
		</ul>
</div>
<a name="methoddelete" id="methoddelete"><!-- --></a>
<div style="background='#eeeeee'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method delete</strong> (line <span class="linenumber">76</span>)
 </h4> 
<h4><i>void</i> <strong>delete(
integer
$id)</strong></h4>

<!-- ========== Info from phpDoc block ========= -->
<h5>To delete a user in the database</h5>
		<h4>Parameters</h4>
	<ul>
			<li><strong>integer $id</strong>: the id of the user you want to update</li>
		</ul>
		
	<h4>Info</h4>
	<ul>
		</ul>
</div>
<a name="methoddisplayUserInfo" id="methoddisplayUserInfo"><!-- --></a>
<div style="background='#ffffff'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method displayUserInfo</strong> (line <span class="linenumber">148</span>)
 </h4> 
<h4><i>void</i> <strong>displayUserInfo(
)</strong></h4>

<!-- ========== Info from phpDoc block ========= -->
<h5>Just to display some basic userinfo (mostly used in testing)</h5>
		
	<h4>Info</h4>
	<ul>
		</ul>
</div>
<a name="methodgetUser" id="methodgetUser"><!-- --></a>
<div style="background='#eeeeee'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method getUser</strong> (line <span class="linenumber">85</span>)
 </h4> 
<h4><i>void</i> <strong>getUser(
mixed
$userName, string
$username)</strong></h4>

<!-- ========== Info from phpDoc block ========= -->
<h5>To get userdata: search on username</h5>
		<h4>Parameters</h4>
	<ul>
			<li><strong>string $username</strong>: username of the user you want to get info from</li>
		</ul>
		
	<h4>Info</h4>
	<ul>
		</ul>
</div>
<a name="methodgetUserbyid" id="methodgetUserbyid"><!-- --></a>
<div style="background='#ffffff'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method getUserbyid</strong> (line <span class="linenumber">99</span>)
 </h4> 
<h4><i>void</i> <strong>getUserbyid(
mixed
$user_id, integer
$id)</strong></h4>

<!-- ========== Info from phpDoc block ========= -->
<h5>To get userdata: search on userid</h5>
		<h4>Parameters</h4>
	<ul>
			<li><strong>integer $id</strong>: the id of the user you want to update</li>
		</ul>
		
	<h4>Info</h4>
	<ul>
		</ul>
</div>
<a name="methodsetUser" id="methodsetUser"><!-- --></a>
<div style="background='#eeeeee'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method setUser</strong> (line <span class="linenumber">39</span>)
 </h4> 
<h4><i>void</i> <strong>setUser(
)</strong></h4>

<!-- ========== Info from phpDoc block ========= -->
<h5>To insert a user in the database</h5>
		
	<h4>Info</h4>
	<ul>
		</ul>
</div>
<a name="methodupdateUser" id="methodupdateUser"><!-- --></a>
<div style="background='#ffffff'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method updateUser</strong> (line <span class="linenumber">62</span>)
 </h4> 
<h4><i>void</i> <strong>updateUser(
integer
$id)</strong></h4>

<!-- ========== Info from phpDoc block ========= -->
<h5>To update a user in the database</h5>
		<h4>Parameters</h4>
	<ul>
			<li><strong>integer $id</strong>: the id of the user you want to update</li>
		</ul>
		
	<h4>Info</h4>
	<ul>
		</ul>
</div>
<a name="methodverifyPassword" id="methodverifyPassword"><!-- --></a>
<div style="background='#eeeeee'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method verifyPassword</strong> (line <span class="linenumber">112</span>)
 </h4> 
<h4><i>void</i> <strong>verifyPassword(
)</strong></h4>

<!-- ========== Info from phpDoc block ========= -->
<h5>Quickcheck for the password only (die's if password is incorrect)</h5>
		
	<h4>Info</h4>
	<ul>
		</ul>
</div>
<script type="text/javascript">tp1.addTabPage( document.getElementById( "tabPage2" ) );</script></div>
<div class="tab-page" id="iVars">
<h2 class="tab">Inherited Variables</h2>
<script type="text/javascript">tp1.addTabPage( document.getElementById( "iVars" ) );</script>
<!-- =========== VAR INHERITED SUMMARY =========== -->
<A NAME='var_inherited_summary'><!-- --></A>
<h3>Inherited Class Variable Summary</h3>

	</div>
<div class="tab-page" id="iMethods">
<h2 class="tab">Inherited Methods</h2>
<script type="text/javascript">tp1.addTabPage( document.getElementById( "iMethods" ) );</script>
<!-- =========== INHERITED METHOD SUMMARY =========== -->
<A NAME='functions_inherited'><!-- --></A>
<h3>Inherited Method Summary</h3>

	</div>
</div>
<script type="text/javascript">
//<![CDATA[

setupAllTabs();

//]]>
</script>
	<div id="credit">
		<hr />
		Documentation generated on Tue, 08 Aug 2006 16:47:15 +0200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.0RC3</a>
	</div>
</body>
</html>
Return current item: Tagging manager