PageRenderTime 57ms CodeModel.GetById 32ms RepoModel.GetById 1ms app.codeStats 0ms

/manual/elementindex_phpUserClass.html

https://github.com/HumanWorks/phpUserClass
HTML | 200 lines | 195 code | 5 blank | 0 comment | 0 complexity | 5f4ac30bc5cb44ffb46440c9bf67ee02 MD5 | raw file
    

  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">

    2. 

  2. <html>

    3. 

  3. <head>

    4. 

  4. 	<title>Package phpUserClass Element Index</title>

    5. 

  5. 	<link rel="stylesheet" type="text/css" id="layout" href="media/layout.css" media="screen">

    6. 

  6. 	<link rel="stylesheet" type="text/css" href="media/style.css" media="all">

    7. 

  7. 	<link rel="stylesheet" type="text/css" href="media/print.css" media="print">

    8. 

  8. </head>

    9. 

  9. 

    10. 

  10. <body>

    11. 

  11. <div id="header">

    12. 

  12. 	<div id="navLinks">

    13. 

  13. 		[ <a href="classtrees_phpUserClass.html">Class Tree: phpUserClass</a> ]

    14. 

  14. 		[ <a href="elementindex_phpUserClass.html">Index: phpUserClass</a> ]

    15. 

  15. 		[ <a href="elementindex.html">All elements</a> ]

    16. 

  16. 	</div>

    17. 

  17. 	<div id="packagePosition">

    18. 

  18. 		<div id="packageTitle2">phpUserClass</div>

    19. 

  19. 		<div id="packageTitle">phpUserClass</div>

    20. 

  20. 		<div id="elementPath"> &middot; </div>

    21. 

  21. 	</div>

    22. 

  22. </div>

    23. 

  23. 

    24. 

  24. <div id="nav" class="small">

    25. 

  25. 	<div id="packages">

    26. 

  26. 		Packages:

    27. 

  27. 					<p><a href="li_phpUserClass.html">phpUserClass</a></p>

    28. 

  28. 			</div>

    29. 

  29. 

    30. 

  30. 				<div id="index">

    31. 

  31. 			<div id="files">

    32. 

  32. 								Files:<br>

    33. 

  33. 								<a href="phpUserClass/_access.class.php.html">		access.class.php

    34. 

  34. 		</a><br>

    35. 

  35. 				</div>

    36. 

  36. 			<div id="interfaces">

    37. 

  37. 							</div>

    38. 

  38. 			<div id="classes">

    39. 

  39. 				Classes:<br>

    40. 

  40. 								<a href="phpUserClass/flexibleAccess.html">		flexibleAccess

    41. 

  41. 		</a><br>

    42. 

  42. 				</div>

    43. 

  43. 		</div>

    44. 

  44. 	</div>

    45. 

  45. 

    46. 

  46. <div id="body">

    47. 

  47. 	    	<a name="top"></a>

    48. 

  48. <h1>Element index for package phpUserClass</h1>

    49. 

  49. 	<a href="elementindex_phpUserClass.html#a">a</a>

    50. 

  50. 	<a href="elementindex_phpUserClass.html#d">d</a>

    51. 

  51. 	<a href="elementindex_phpUserClass.html#f">f</a>

    52. 

  52. 	<a href="elementindex_phpUserClass.html#g">g</a>

    53. 

  53. 	<a href="elementindex_phpUserClass.html#i">i</a>

    54. 

  54. 	<a href="elementindex_phpUserClass.html#l">l</a>

    55. 

  55. 	<a href="elementindex_phpUserClass.html#p">p</a>

    56. 

  56. 	<a href="elementindex_phpUserClass.html#r">r</a>

    57. 

  57. 	<a href="elementindex_phpUserClass.html#s">s</a>

    58. 

  58. 	<a href="elementindex_phpUserClass.html#t">t</a>

    59. 

  59. 	<a href="elementindex_phpUserClass.html#u">u</a>

    60. 

  60. 

    61. 

  61. 	<a name="a"></a>

    62. 

  62. 	<a href="elementindex_phpUserClass.html#top">top</a><br>

    63. 

  63. 	<div>

    64. 

  64. 		<h2>a</h2>

    65. 

  65. 		<dl class="lettercontents">

    66. 

  66. 							<dt>access.class.php</dt>

    67. 

  67. 				<dd>procedural page <a href="phpUserClass/_access.class.php.html">access.class.php</a></dd>

    68. 

  68. 							<dt>activate</dt>

    69. 

  69. 				<dd>in file access.class.php, method <a href="phpUserClass/flexibleAccess.html#methodactivate">flexibleAccess::activate()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Activates the user account</dd>

    70. 

  70. 					</dl>

    71. 

  71. 	</div>

    72. 

  72. 	<a name="d"></a>

    73. 

  73. 	<a href="elementindex_phpUserClass.html#top">top</a><br>

    74. 

  74. 	<div>

    75. 

  75. 		<h2>d</h2>

    76. 

  76. 		<dl class="lettercontents">

    77. 

  77. 							<dt>$dbConn</dt>

    78. 

  78. 				<dd>in file access.class.php, variable <a href="phpUserClass/flexibleAccess.html#var$dbConn">flexibleAccess::$dbConn</a></dd>

    79. 

  79. 							<dt>$dbHost</dt>

    80. 

  80. 				<dd>in file access.class.php, variable <a href="phpUserClass/flexibleAccess.html#var$dbHost">flexibleAccess::$dbHost</a><br>&nbsp;&nbsp;&nbsp;&nbsp;The database host</dd>

    81. 

  81. 							<dt>$dbName</dt>

    82. 

  82. 				<dd>in file access.class.php, variable <a href="phpUserClass/flexibleAccess.html#var$dbName">flexibleAccess::$dbName</a><br>&nbsp;&nbsp;&nbsp;&nbsp;The database that we will use</dd>

    83. 

  83. 							<dt>$dbPass</dt>

    84. 

  84. 				<dd>in file access.class.php, variable <a href="phpUserClass/flexibleAccess.html#var$dbPass">flexibleAccess::$dbPass</a><br>&nbsp;&nbsp;&nbsp;&nbsp;The database password</dd>

    85. 

  85. 							<dt>$dbPort</dt>

    86. 

  86. 				<dd>in file access.class.php, variable <a href="phpUserClass/flexibleAccess.html#var$dbPort">flexibleAccess::$dbPort</a><br>&nbsp;&nbsp;&nbsp;&nbsp;The database port</dd>

    87. 

  87. 							<dt>$dbTable</dt>

    88. 

  88. 				<dd>in file access.class.php, variable <a href="phpUserClass/flexibleAccess.html#var$dbTable">flexibleAccess::$dbTable</a><br>&nbsp;&nbsp;&nbsp;&nbsp;The database table that holds all the information</dd>

    89. 

  89. 							<dt>$dbUser</dt>

    90. 

  90. 				<dd>in file access.class.php, variable <a href="phpUserClass/flexibleAccess.html#var$dbUser">flexibleAccess::$dbUser</a><br>&nbsp;&nbsp;&nbsp;&nbsp;The database user</dd>

    91. 

  91. 							<dt>$displayErrors</dt>

    92. 

  92. 				<dd>in file access.class.php, variable <a href="phpUserClass/flexibleAccess.html#var$displayErrors">flexibleAccess::$displayErrors</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Display errors? Set this to true if you are going to seek for help, or have troubles with the script</dd>

    93. 

  93. 					</dl>

    94. 

  94. 	</div>

    95. 

  95. 	<a name="f"></a>

    96. 

  96. 	<a href="elementindex_phpUserClass.html#top">top</a><br>

    97. 

  97. 	<div>

    98. 

  98. 		<h2>f</h2>

    99. 

  99. 		<dl class="lettercontents">

    100. 

  100. 							<dt>flexibleAccess</dt>

    101. 

  101. 				<dd>in file access.class.php, method <a href="phpUserClass/flexibleAccess.html#methodflexibleAccess">flexibleAccess::flexibleAccess()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Class Constructure</dd>

    102. 

  102. 							<dt>flexibleAccess</dt>

    103. 

  103. 				<dd>in file access.class.php, class <a href="phpUserClass/flexibleAccess.html">flexibleAccess</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Flexible Access - The main class</dd>

    104. 

  104. 					</dl>

    105. 

  105. 	</div>

    106. 

  106. 	<a name="g"></a>

    107. 

  107. 	<a href="elementindex_phpUserClass.html#top">top</a><br>

    108. 

  108. 	<div>

    109. 

  109. 		<h2>g</h2>

    110. 

  110. 		<dl class="lettercontents">

    111. 

  111. 							<dt>get_property</dt>

    112. 

  112. 				<dd>in file access.class.php, method <a href="phpUserClass/flexibleAccess.html#methodget_property">flexibleAccess::get_property()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Get a property of a user. You should give here the name of the field that you seek from the user table</dd>

    113. 

  113. 					</dl>

    114. 

  114. 	</div>

    115. 

  115. 	<a name="i"></a>

    116. 

  116. 	<a href="elementindex_phpUserClass.html#top">top</a><br>

    117. 

  117. 	<div>

    118. 

  118. 		<h2>i</h2>

    119. 

  119. 		<dl class="lettercontents">

    120. 

  120. 							<dt>insertUser</dt>

    121. 

  121. 				<dd>in file access.class.php, method <a href="phpUserClass/flexibleAccess.html#methodinsertUser">flexibleAccess::insertUser()</a></dd>

    122. 

  122. 							<dt>is</dt>

    123. 

  123. 				<dd>in file access.class.php, method <a href="phpUserClass/flexibleAccess.html#methodis">flexibleAccess::is()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Function to determine if a property is true or false</dd>

    124. 

  124. 							<dt>is_active</dt>

    125. 

  125. 				<dd>in file access.class.php, method <a href="phpUserClass/flexibleAccess.html#methodis_active">flexibleAccess::is_active()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Is the user an active user?</dd>

    126. 

  126. 							<dt>is_loaded</dt>

    127. 

  127. 				<dd>in file access.class.php, method <a href="phpUserClass/flexibleAccess.html#methodis_loaded">flexibleAccess::is_loaded()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Is the user loaded?</dd>

    128. 

  128. 					</dl>

    129. 

  129. 	</div>

    130. 

  130. 	<a name="l"></a>

    131. 

  131. 	<a href="elementindex_phpUserClass.html#top">top</a><br>

    132. 

  132. 	<div>

    133. 

  133. 		<h2>l</h2>

    134. 

  134. 		<dl class="lettercontents">

    135. 

  135. 							<dt>login</dt>

    136. 

  136. 				<dd>in file access.class.php, method <a href="phpUserClass/flexibleAccess.html#methodlogin">flexibleAccess::login()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Login function</dd>

    137. 

  137. 							<dt>logout</dt>

    138. 

  138. 				<dd>in file access.class.php, method <a href="phpUserClass/flexibleAccess.html#methodlogout">flexibleAccess::logout()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Logout function</dd>

    139. 

  139. 					</dl>

    140. 

  140. 	</div>

    141. 

  141. 	<a name="p"></a>

    142. 

  142. 	<a href="elementindex_phpUserClass.html#top">top</a><br>

    143. 

  143. 	<div>

    144. 

  144. 		<h2>p</h2>

    145. 

  145. 		<dl class="lettercontents">

    146. 

  146. 							<dt>$passMethod</dt>

    147. 

  147. 				<dd>in file access.class.php, variable <a href="phpUserClass/flexibleAccess.html#var$passMethod">flexibleAccess::$passMethod</a><br>&nbsp;&nbsp;&nbsp;&nbsp;The method used to encrypt the password. It can be sha1, md5 or nothing (no encryption)</dd>

    148. 

  148. 					</dl>

    149. 

  149. 	</div>

    150. 

  150. 	<a name="r"></a>

    151. 

  151. 	<a href="elementindex_phpUserClass.html#top">top</a><br>

    152. 

  152. 	<div>

    153. 

  153. 		<h2>r</h2>

    154. 

  154. 		<dl class="lettercontents">

    155. 

  155. 							<dt>$remCookieDomain</dt>

    156. 

  156. 				<dd>in file access.class.php, variable <a href="phpUserClass/flexibleAccess.html#var$remCookieDomain">flexibleAccess::$remCookieDomain</a><br>&nbsp;&nbsp;&nbsp;&nbsp;The cookie domain</dd>

    157. 

  157. 							<dt>$remCookieName</dt>

    158. 

  158. 				<dd>in file access.class.php, variable <a href="phpUserClass/flexibleAccess.html#var$remCookieName">flexibleAccess::$remCookieName</a><br>&nbsp;&nbsp;&nbsp;&nbsp;The name of the cookie which we will use if user wants to be remembered by the system</dd>

    159. 

  159. 							<dt>$remTime</dt>

    160. 

  160. 				<dd>in file access.class.php, variable <a href="phpUserClass/flexibleAccess.html#var$remTime">flexibleAccess::$remTime</a><br>&nbsp;&nbsp;&nbsp;&nbsp;When user wants the system to remember him/her, how much time to keep the cookie? (seconds)</dd>

    161. 

  161. 							<dt>randomPass</dt>

    162. 

  162. 				<dd>in file access.class.php, method <a href="phpUserClass/flexibleAccess.html#methodrandomPass">flexibleAccess::randomPass()</a></dd>

    163. 

  163. 					</dl>

    164. 

  164. 	</div>

    165. 

  165. 	<a name="s"></a>

    166. 

  166. 	<a href="elementindex_phpUserClass.html#top">top</a><br>

    167. 

  167. 	<div>

    168. 

  168. 		<h2>s</h2>

    169. 

  169. 		<dl class="lettercontents">

    170. 

  170. 							<dt>$sessionVariable</dt>

    171. 

  171. 				<dd>in file access.class.php, variable <a href="phpUserClass/flexibleAccess.html#var$sessionVariable">flexibleAccess::$sessionVariable</a><br>&nbsp;&nbsp;&nbsp;&nbsp;The session variable ($_SESSION[$sessionVariable]) which will hold the data while the user is logged on</dd>

    172. 

  172. 					</dl>

    173. 

  173. 	</div>

    174. 

  174. 	<a name="t"></a>

    175. 

  175. 	<a href="elementindex_phpUserClass.html#top">top</a><br>

    176. 

  176. 	<div>

    177. 

  177. 		<h2>t</h2>

    178. 

  178. 		<dl class="lettercontents">

    179. 

  179. 							<dt>$tbFields</dt>

    180. 

  180. 				<dd>in file access.class.php, variable <a href="phpUserClass/flexibleAccess.html#var$tbFields">flexibleAccess::$tbFields</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Those are the fields that our table uses in order to fetch the needed data. The structure is 'fieldType' =&gt; 'fieldName'</dd>

    181. 

  181. 					</dl>

    182. 

  182. 	</div>

    183. 

  183. 	<a name="u"></a>

    184. 

  184. 	<a href="elementindex_phpUserClass.html#top">top</a><br>

    185. 

  185. 	<div>

    186. 

  186. 		<h2>u</h2>

    187. 

  187. 		<dl class="lettercontents">

    188. 

  188. 							<dt>$userData</dt>

    189. 

  189. 				<dd>in file access.class.php, variable <a href="phpUserClass/flexibleAccess.html#var$userData">flexibleAccess::$userData</a></dd>

    190. 

  190. 							<dt>$userID</dt>

    191. 

  191. 				<dd>in file access.class.php, variable <a href="phpUserClass/flexibleAccess.html#var$userID">flexibleAccess::$userID</a></dd>

    192. 

  192. 					</dl>

    193. 

  193. 	</div>

    194. 

  194. 	<div id="credit">

    195. 

  195. 		<hr>

    196. 

  196. 		Documentation generated on Sat, 10 Nov 2007 12:38:06 +0200 by <a href="http://www.phpdoc.org">phpDocumentor 1.3.2</a>

    197. 

  197. 	</div>

    198. 

  198. </div>

    199. 

  199. </body>

    200. 

  200. </html>

    201.