PageRenderTime 36ms CodeModel.GetById 10ms RepoModel.GetById 0ms app.codeStats 0ms

/doc/APIDoc/Usermanagement/Model/Models_Usermanagement_Auth.html

http://vaselinengine.googlecode.com/
HTML | 459 lines | 345 code | 100 blank | 14 comment | 0 complexity | 6a07a5a53d7e0781c600816135e8ff16 MD5 | raw file
Possible License(s): LGPL-2.1, AGPL-1.0, GPL-2.0 
    

  1. <?xml version="1.0" encoding="iso-8859-1"?>

    2. 

  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

    3. 

  3.   <html xmlns="http://www.w3.org/1999/xhtml">

    4. 

  4. 		<head>

    5. 

  5. 			<!-- template designed by Marco Von Ballmoos -->

    6. 

  6. 			<title>Docs For Class Models_Usermanagement_Auth</title>

    7. 

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

    8. 

  8. 			<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>

    9. 

  9. 		</head>

    10. 

  10. 		<body>

    11. 

  11. 			<div class="page-body">			


    12. 

  12. <h2 class="class-name">Class Models_Usermanagement_Auth</h2>

    13. 

  13. 

    14. 

  14. <a name="sec-description"></a>

    15. 

  15. <div class="info-box">

    16. 

  16. 	<div class="info-box-title">Description</div>

    17. 

  17. 	<div class="nav-bar">

    18. 

  18. 					<span class="disabled">Description</span> |

    19. 

  19. 													<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)

    20. 

  20. 						|											<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)

    21. 

  21. 						

    22. 

  22. 					</div>

    23. 

  23. 	<div class="info-box-body">

    24. 

  24.         		<!-- ========== Info from phpDoc block ========= -->

    25. 

  25. <p class="short-description">Auth Model. Singleton</p>

    26. 

  26. 	<ul class="tags">

    27. 

  27. 				<li><span class="field">author:</span> Konstantin Shamko &lt;<a href="mailto:konstantin.shamko@gmail.com">konstantin.shamko@gmail.com</a>&gt;</li>

    28. 

  28. 				<li><span class="field">version:</span> 0.0.1</li>

    29. 

  29. 				<li><span class="field">copyright:</span> Copyright (c) 2009 Konstantin Shamko</li>

    30. 

  30. 				<li><span class="field">license:</span> New</li>

    31. 

  31. 			</ul>

    32. 

  32. 		<p class="notes">

    33. 

  33. 			Located in <a class="field" href="_app---Models---Usermanagement---Auth.php.html">/app/Models/Usermanagement/Auth.php</a> (line <span class="field">14</span>)

    34. 

  34. 		</p>

    35. 

  35. 		

    36. 

  36. 				

    37. 

  37. 		<pre>Zend_Auth_Adapter_DbTable
    38. 

  38.    |
    39. 

  39.    --Models_Usermanagement_Auth</pre>

    40. 

  40. 	

    41. 

  41. 			</div>

    42. 

  42. </div>

    43. 

  43. 

    44. 

  44. 

    45. 

  45. 

    46. 

  46. 	<a name="sec-var-summary"></a>

    47. 

  47. 	<div class="info-box">

    48. 

  48. 		<div class="info-box-title">Variable Summary</span></div>

    49. 

  49. 		<div class="nav-bar">

    50. 

  50. 			<a href="#sec-description">Description</a> |

    51. 

  51. 						<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)

    52. 

  52. 							| 

    53. 

  53. 									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)

    54. 

  54. 							

    55. 

  55. 								</div>

    56. 

  56. 		<div class="info-box-body">

    57. 

  57. 			<div class="var-summary">

    58. 

  58. 																																																								<div class="var-title">

    59. 

  59. 					<span class="var-type">string</span>

    60. 

  60. 					<a href="#$_credentialColumn" title="details" class="var-name">$_credentialColumn</a>

    61. 

  61. 				</div>

    62. 

  62. 																<div class="var-title">

    63. 

  63. 					<span class="var-type">string</span>

    64. 

  64. 					<a href="#$_credentialTreatment" title="details" class="var-name">$_credentialTreatment</a>

    65. 

  65. 				</div>

    66. 

  66. 																<div class="var-title">

    67. 

  67. 					<span class="var-type">string</span>

    68. 

  68. 					<a href="#$_identityColumn" title="details" class="var-name">$_identityColumn</a>

    69. 

  69. 				</div>

    70. 

  70. 																<div class="var-title">

    71. 

  71. 					<span class="var-type">Zend_Session_Namespace</span>

    72. 

  72. 					<a href="#$_session" title="details" class="var-name">$_session</a>

    73. 

  73. 				</div>

    74. 

  74. 																<div class="var-title">

    75. 

  75. 					<span class="var-type">Zend_Db</span>

    76. 

  76. 					<a href="#$_zendDB" title="details" class="var-name">$_zendDB</a>

    77. 

  77. 				</div>

    78. 

  78. 											</div>

    79. 

  79. 		</div>

    80. 

  80. 	</div>

    81. 

  81. 

    82. 

  82. 	<a name="sec-method-summary"></a>

    83. 

  83. 	<div class="info-box">

    84. 

  84. 		<div class="info-box-title">Method Summary</span></div>

    85. 

  85. 		<div class="nav-bar">

    86. 

  86. 			<a href="#sec-description">Description</a> |

    87. 

  87. 																		<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)

    88. 

  88. 				 

    89. 

  89. 				|

    90. 

  90. 						<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)

    91. 

  91. 		</div>

    92. 

  92. 		<div class="info-box-body">			

    93. 

  93. 			<div class="method-summary">

    94. 

  94. 																				<div class="method-definition">

    95. 

  95. 					static 						<span class="method-result"><a href="../../Usermanagement/Model/Models_Usermanagement_Auth.html">Models_Usermanagement_Auth</a></span>

    96. 

  96. 										<a href="#getInstance" title="details" class="method-name">getInstance</a>

    97. 

  97. 										()

    98. 

  98. 									</div>

    99. 

  99. 																																																

    100. 

  100. 												<div class="method-definition">

    101. 

  101. 											<span class="method-result">Models_Usermanagement_Auth</span>

    102. 

  102. 										<a href="#__construct" title="details" class="method-name">__construct</a>

    103. 

  103. 										()

    104. 

  104. 									</div>

    105. 

  105. 																								<div class="method-definition">

    106. 

  106. 											<span class="method-result">Zend_Db_Table_Row</span>

    107. 

  107. 										<a href="#getUserSession" title="details" class="method-name">getUserSession</a>

    108. 

  108. 										()

    109. 

  109. 									</div>

    110. 

  110. 																<div class="method-definition">

    111. 

  111. 											<span class="method-result">bool</span>

    112. 

  112. 										<a href="#isLoggedIn" title="details" class="method-name">isLoggedIn</a>

    113. 

  113. 										()

    114. 

  114. 									</div>

    115. 

  115. 																<div class="method-definition">

    116. 

  116. 											<span class="method-result">object</span>

    117. 

  117. 										<a href="#login" title="details" class="method-name">login</a>

    118. 

  118. 											(<span class="var-type">string</span>&nbsp;<span class="var-name">$username</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$password</span>)

    119. 

  119. 									</div>

    120. 

  120. 																<div class="method-definition">

    121. 

  121. 											<span class="method-result">void</span>

    122. 

  122. 										<a href="#logout" title="details" class="method-name">logout</a>

    123. 

  123. 										()

    124. 

  124. 									</div>

    125. 

  125. 																<div class="method-definition">

    126. 

  126. 											<span class="method-result">void</span>

    127. 

  127. 										<a href="#setUserSession" title="details" class="method-name">setUserSession</a>

    128. 

  128. 										()

    129. 

  129. 									</div>

    130. 

  130. 								</div>

    131. 

  131. 		</div>

    132. 

  132. 	</div>		

    133. 

  133. 

    134. 

  134. 	<a name="sec-vars"></a>

    135. 

  135. 	<div class="info-box">

    136. 

  136. 		<div class="info-box-title">Variables</div>

    137. 

  137. 		<div class="nav-bar">

    138. 

  138. 			<a href="#sec-description">Description</a> |

    139. 

  139. 										<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)

    140. 

  140. 						

    141. 

  141. 			

    142. 

  142. 										| 

    143. 

  143. 									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)

    144. 

  144. 							

    145. 

  145. 					</div>

    146. 

  146. 		<div class="info-box-body">

    147. 

  147. 			<a name="var$_credentialColumn" id="$_credentialColumn"><!-- --></A>

    148. 

  148. <div class="oddrow">

    149. 

  149. 

    150. 

  150. 	<div class="var-header">

    151. 

  151. 		<span class="var-title">

    152. 

  152. 			<span class="var-type">string</span>

    153. 

  153. 			<span class="var-name">$_credentialColumn</span>

    154. 

  154. 			 = <span class="var-default"> 'user_password'</span>			(line <span class="line-number">28</span>)

    155. 

  155. 		</span>

    156. 

  156. 	</div>

    157. 

  157. 

    158. 

  158. 	<!-- ========== Info from phpDoc block ========= -->

    159. 

  159. <p class="short-description">name of the DB field to use as password</p>

    160. 

  160. 	<ul class="tags">

    161. 

  161. 				<li><span class="field">access:</span> protected</li>

    162. 

  162. 			</ul>

    163. 

  163. 	

    164. 

  164. 	

    165. 

  165. 		

    166. 

  166. 		

    167. 

  167. 

    168. 

  168. </div>

    169. 

  169. <a name="var$_credentialTreatment" id="$_credentialTreatment"><!-- --></A>

    170. 

  170. <div class="evenrow">

    171. 

  171. 

    172. 

  172. 	<div class="var-header">

    173. 

  173. 		<span class="var-title">

    174. 

  174. 			<span class="var-type">string</span>

    175. 

  175. 			<span class="var-name">$_credentialTreatment</span>

    176. 

  176. 			 = <span class="var-default"> 'MD5(?) AND user_active =1'</span>			(line <span class="line-number">35</span>)

    177. 

  177. 		</span>

    178. 

  178. 	</div>

    179. 

  179. 

    180. 

  180. 	<!-- ========== Info from phpDoc block ========= -->

    181. 

  181. <p class="short-description">Password encryption type</p>

    182. 

  182. 	<ul class="tags">

    183. 

  183. 				<li><span class="field">access:</span> protected</li>

    184. 

  184. 			</ul>

    185. 

  185. 	

    186. 

  186. 	

    187. 

  187. 		

    188. 

  188. 		

    189. 

  189. 

    190. 

  190. </div>

    191. 

  191. <a name="var$_identityColumn" id="$_identityColumn"><!-- --></A>

    192. 

  192. <div class="oddrow">

    193. 

  193. 

    194. 

  194. 	<div class="var-header">

    195. 

  195. 		<span class="var-title">

    196. 

  196. 			<span class="var-type">string</span>

    197. 

  197. 			<span class="var-name">$_identityColumn</span>

    198. 

  198. 			 = <span class="var-default"> 'user_login'</span>			(line <span class="line-number">21</span>)

    199. 

  199. 		</span>

    200. 

  200. 	</div>

    201. 

  201. 

    202. 

  202. 	<!-- ========== Info from phpDoc block ========= -->

    203. 

  203. <p class="short-description">name of the DB field to use as login</p>

    204. 

  204. 	<ul class="tags">

    205. 

  205. 				<li><span class="field">access:</span> protected</li>

    206. 

  206. 			</ul>

    207. 

  207. 	

    208. 

  208. 	

    209. 

  209. 		

    210. 

  210. 		

    211. 

  211. 

    212. 

  212. </div>

    213. 

  213. <a name="var$_session" id="$_session"><!-- --></A>

    214. 

  214. <div class="evenrow">

    215. 

  215. 

    216. 

  216. 	<div class="var-header">

    217. 

  217. 		<span class="var-title">

    218. 

  218. 			<span class="var-type">Zend_Session_Namespace</span>

    219. 

  219. 			<span class="var-name">$_session</span>

    220. 

  220. 			 = <span class="var-default"> false</span>			(line <span class="line-number">42</span>)

    221. 

  221. 		</span>

    222. 

  222. 	</div>

    223. 

  223. 

    224. 

  224. 	<!-- ========== Info from phpDoc block ========= -->

    225. 

  225. <p class="short-description">Session to store userdata</p>

    226. 

  226. 	<ul class="tags">

    227. 

  227. 				<li><span class="field">access:</span> protected</li>

    228. 

  228. 			</ul>

    229. 

  229. 	

    230. 

  230. 	

    231. 

  231. 		

    232. 

  232. 		

    233. 

  233. 

    234. 

  234. </div>

    235. 

  235. <a name="var$_zendDB" id="$_zendDB"><!-- --></A>

    236. 

  236. <div class="oddrow">

    237. 

  237. 

    238. 

  238. 	<div class="var-header">

    239. 

  239. 		<span class="var-title">

    240. 

  240. 			<span class="var-type">Zend_Db</span>

    241. 

  241. 			<span class="var-name">$_zendDB</span>

    242. 

  242. 						(line <span class="line-number">49</span>)

    243. 

  243. 		</span>

    244. 

  244. 	</div>

    245. 

  245. 

    246. 

  246. 	<!-- ========== Info from phpDoc block ========= -->

    247. 

  247. <p class="short-description">DB object</p>

    248. 

  248. 	<ul class="tags">

    249. 

  249. 				<li><span class="field">access:</span> protected</li>

    250. 

  250. 			</ul>

    251. 

  251. 	

    252. 

  252. 	

    253. 

  253. 		

    254. 

  254. 		

    255. 

  255. 

    256. 

  256. </div>

    257. 

  257. 
						

    258. 

  258. 		</div>

    259. 

  259. 	</div>

    260. 

  260. 	

    261. 

  261. 	<a name="sec-methods"></a>

    262. 

  262. 	<div class="info-box">

    263. 

  263. 		<div class="info-box-title">Methods</div>

    264. 

  264. 		<div class="nav-bar">

    265. 

  265. 			<a href="#sec-description">Description</a> |

    266. 

  266. 															<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)

    267. 

  267. 																	<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)

    268. 

  268. 						

    269. 

  269. 		</div>

    270. 

  270. 		<div class="info-box-body">

    271. 

  271. 			<A NAME='method_detail'></A>

    272. 

  272. <a name="methodgetInstance" id="getInstance"><!-- --></a>

    273. 

  273. <div class="evenrow">

    274. 

  274. 	

    275. 

  275. 	<div class="method-header">

    276. 

  276. 		<span class="method-title">static method getInstance</span> (line <span class="line-number">80</span>)

    277. 

  277. 	</div> 

    278. 

  278. 	

    279. 

  279. 	<!-- ========== Info from phpDoc block ========= -->

    280. 

  280. <p class="short-description">Singleton realization. Call this to get instance of this class</p>

    281. 

  281. 	<ul class="tags">

    282. 

  282. 				<li><span class="field">access:</span> public</li>

    283. 

  283. 			</ul>

    284. 

  284. 	

    285. 

  285. 	<div class="method-signature">

    286. 

  286. 	    static

    287. 

  287. 		<span class="method-result"><a href="../../Usermanagement/Model/Models_Usermanagement_Auth.html">Models_Usermanagement_Auth</a></span>

    288. 

  288. 		<span class="method-name">

    289. 

  289. 			getInstance

    290. 

  290. 		</span>

    291. 

  291. 				()

    292. 

  292. 			</div>

    293. 

  293. 	

    294. 

  294. 		

    295. 

  295. 			

    296. 

  296. 	</div>

    297. 

  297. 

    298. 

  298. <a name="method__construct" id="__construct"><!-- --></a>

    299. 

  299. <div class="oddrow">

    300. 

  300. 	

    301. 

  301. 	<div class="method-header">

    302. 

  302. 		<span class="method-title">Constructor __construct</span> (line <span class="line-number">69</span>)

    303. 

  303. 	</div> 

    304. 

  304. 	

    305. 

  305. 	<!-- ========== Info from phpDoc block ========= -->

    306. 

  306. <p class="short-description">Constructor</p>

    307. 

  307. 	<ul class="tags">

    308. 

  308. 				<li><span class="field">access:</span> public</li>

    309. 

  309. 			</ul>

    310. 

  310. 	

    311. 

  311. 	<div class="method-signature">

    312. 

  312. 		<span class="method-result">Models_Usermanagement_Auth</span>

    313. 

  313. 		<span class="method-name">

    314. 

  314. 			__construct

    315. 

  315. 		</span>

    316. 

  316. 				()

    317. 

  317. 			</div>

    318. 

  318. 	

    319. 

  319. 		

    320. 

  320. 			

    321. 

  321. 	</div>

    322. 

  322. <a name="methodgetUserSession" id="getUserSession"><!-- --></a>

    323. 

  323. <div class="evenrow">

    324. 

  324. 	

    325. 

  325. 	<div class="method-header">

    326. 

  326. 		<span class="method-title">getUserSession</span> (line <span class="line-number">118</span>)

    327. 

  327. 	</div> 

    328. 

  328. 	

    329. 

  329. 	<!-- ========== Info from phpDoc block ========= -->

    330. 

  330. <p class="short-description">Returns userdata from session</p>

    331. 

  331. 	<ul class="tags">

    332. 

  332. 				<li><span class="field">access:</span> public</li>

    333. 

  333. 			</ul>

    334. 

  334. 	

    335. 

  335. 	<div class="method-signature">

    336. 

  336. 		<span class="method-result">Zend_Db_Table_Row</span>

    337. 

  337. 		<span class="method-name">

    338. 

  338. 			getUserSession

    339. 

  339. 		</span>

    340. 

  340. 				()

    341. 

  341. 			</div>

    342. 

  342. 	

    343. 

  343. 		

    344. 

  344. 			

    345. 

  345. 	</div>

    346. 

  346. <a name="methodisLoggedIn" id="isLoggedIn"><!-- --></a>

    347. 

  347. <div class="oddrow">

    348. 

  348. 	

    349. 

  349. 	<div class="method-header">

    350. 

  350. 		<span class="method-title">isLoggedIn</span> (line <span class="line-number">135</span>)

    351. 

  351. 	</div> 

    352. 

  352. 	

    353. 

  353. 	<!-- ========== Info from phpDoc block ========= -->

    354. 

  354. <p class="short-description">Checks if user is logged in</p>

    355. 

  355. 	<ul class="tags">

    356. 

  356. 				<li><span class="field">access:</span> public</li>

    357. 

  357. 			</ul>

    358. 

  358. 	

    359. 

  359. 	<div class="method-signature">

    360. 

  360. 		<span class="method-result">bool</span>

    361. 

  361. 		<span class="method-name">

    362. 

  362. 			isLoggedIn

    363. 

  363. 		</span>

    364. 

  364. 				()

    365. 

  365. 			</div>

    366. 

  366. 	

    367. 

  367. 		

    368. 

  368. 			

    369. 

  369. 	</div>

    370. 

  370. <a name="methodlogin" id="login"><!-- --></a>

    371. 

  371. <div class="evenrow">

    372. 

  372. 	

    373. 

  373. 	<div class="method-header">

    374. 

  374. 		<span class="method-title">login</span> (line <span class="line-number">95</span>)

    375. 

  375. 	</div> 

    376. 

  376. 	

    377. 

  377. 	<!-- ========== Info from phpDoc block ========= -->

    378. 

  378. <p class="short-description">Login</p>

    379. 

  379. 	<ul class="tags">

    380. 

  380. 				<li><span class="field">access:</span> public</li>

    381. 

  381. 			</ul>

    382. 

  382. 	

    383. 

  383. 	<div class="method-signature">

    384. 

  384. 		<span class="method-result">object</span>

    385. 

  385. 		<span class="method-name">

    386. 

  386. 			login

    387. 

  387. 		</span>

    388. 

  388. 					(<span class="var-type">string</span>&nbsp;<span class="var-name">$username</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$password</span>)

    389. 

  389. 			</div>

    390. 

  390. 	

    391. 

  391. 			<ul class="parameters">

    392. 

  392. 					<li>

    393. 

  393. 				<span class="var-type">string</span>

    394. 

  394. 				<span class="var-name">$username</span>			</li>

    395. 

  395. 					<li>

    396. 

  396. 				<span class="var-type">string</span>

    397. 

  397. 				<span class="var-name">$password</span>			</li>

    398. 

  398. 				</ul>

    399. 

  399. 		

    400. 

  400. 			

    401. 

  401. 	</div>

    402. 

  402. <a name="methodlogout" id="logout"><!-- --></a>

    403. 

  403. <div class="oddrow">

    404. 

  404. 	

    405. 

  405. 	<div class="method-header">

    406. 

  406. 		<span class="method-title">logout</span> (line <span class="line-number">145</span>)

    407. 

  407. 	</div> 

    408. 

  408. 	

    409. 

  409. 	<!-- ========== Info from phpDoc block ========= -->

    410. 

  410. <p class="short-description">Performs logout action</p>

    411. 

  411. 	<ul class="tags">

    412. 

  412. 				<li><span class="field">access:</span> public</li>

    413. 

  413. 			</ul>

    414. 

  414. 	

    415. 

  415. 	<div class="method-signature">

    416. 

  416. 		<span class="method-result">void</span>

    417. 

  417. 		<span class="method-name">

    418. 

  418. 			logout

    419. 

  419. 		</span>

    420. 

  420. 				()

    421. 

  421. 			</div>

    422. 

  422. 	

    423. 

  423. 		

    424. 

  424. 			

    425. 

  425. 	</div>

    426. 

  426. <a name="methodsetUserSession" id="setUserSession"><!-- --></a>

    427. 

  427. <div class="evenrow">

    428. 

  428. 	

    429. 

  429. 	<div class="method-header">

    430. 

  430. 		<span class="method-title">setUserSession</span> (line <span class="line-number">109</span>)

    431. 

  431. 	</div> 

    432. 

  432. 	

    433. 

  433. 	<!-- ========== Info from phpDoc block ========= -->

    434. 

  434. <p class="short-description">Saves userdata into session</p>

    435. 

  435. 	<ul class="tags">

    436. 

  436. 				<li><span class="field">access:</span> public</li>

    437. 

  437. 			</ul>

    438. 

  438. 	

    439. 

  439. 	<div class="method-signature">

    440. 

  440. 		<span class="method-result">void</span>

    441. 

  441. 		<span class="method-name">

    442. 

  442. 			setUserSession

    443. 

  443. 		</span>

    444. 

  444. 				()

    445. 

  445. 			</div>

    446. 

  446. 	

    447. 

  447. 		

    448. 

  448. 			

    449. 

  449. 	</div>

    450. 

  450. 						

    451. 

  451. 		</div>

    452. 

  452. 	</div>

    453. 

  453. 

    454. 

  454. 

    455. 

  455. 	<p class="notes" id="credit">

    456. 

  456. 		Documentation generated on Mon, 01 Mar 2010 18:58:50 +0200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.0</a>

    457. 

  457. 	</p>

    458. 

  458. 	</div></body>

    459. 

  459. </html>

    460.