PageRenderTime 43ms CodeModel.GetById 14ms RepoModel.GetById 1ms app.codeStats 0ms

/yii/extensions/YOpenID/OpenId/doc/OpenID/Auth_OpenID_PAPE_Request.html

https://github.com/yupe/xomaprojects
HTML | 373 lines | 284 code | 78 blank | 11 comment | 0 complexity | f782f0641cdd48b4f61cbf4cfb7c80b5 MD5 | raw file
    

  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 Auth_OpenID_PAPE_Request</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 Auth_OpenID_PAPE_Request</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">A Provider Authentication Policy request, sent from a relying party  to a provider</p>

    26. 

  26. <p class="description"><p>preferred_auth_policies: The authentication policies that  the relying party prefers</p><p>max_auth_age: The maximum time, in seconds, that the relying party  wants to allow to have elapsed before the user must re-authenticate</p></p>

    27. 

  27. 		<p class="notes">

    28. 

  28. 			Located in <a class="field" href="_Auth---OpenID---PAPE.php.html">/Auth/OpenID/PAPE.php</a> (line <span class="field">35</span>)

    29. 

  29. 		</p>

    30. 

  30. 		

    31. 

  31. 				

    32. 

  32. 		<pre><a href="../OpenID/Auth_OpenID_Extension.html">Auth_OpenID_Extension</a>

    33. 

  33.    |

    34. 

  34.    --Auth_OpenID_PAPE_Request</pre>

    35. 

  35. 	

    36. 

  36. 			</div>

    37. 

  37. </div>

    38. 

  38. 

    39. 

  39. 

    40. 

  40. 

    41. 

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

    42. 

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

    43. 

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

    44. 

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

    45. 

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

    46. 

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

    47. 

  47. 							| 

    48. 

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

    49. 

  49. 							

    50. 

  50. 								</div>

    51. 

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

    52. 

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

    53. 

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

    54. 

  54. 					<span class="var-type">mixed</span>

    55. 

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

    56. 

  56. 				</div>

    57. 

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

    58. 

  58. 					<span class="var-type">mixed</span>

    59. 

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

    60. 

  60. 				</div>

    61. 

  61. 											</div>

    62. 

  62. 		</div>

    63. 

  63. 	</div>

    64. 

  64. 

    65. 

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

    66. 

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

    67. 

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

    68. 

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

    69. 

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

    70. 

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

    71. 

  71. 				 

    72. 

  72. 				|

    73. 

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

    74. 

  74. 		</div>

    75. 

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

    76. 

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

    77. 

  77. 																																																														

    78. 

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

    79. 

  79. 											<span class="method-result">Auth_OpenID_PAPE_Request</span>

    80. 

  80. 										<a href="#Auth_OpenID_PAPE_Request" title="details" class="method-name">Auth_OpenID_PAPE_Request</a>

    81. 

  81. 											([<span class="var-type"></span>&nbsp;<span class="var-name">$preferred_auth_policies</span> = <span class="var-default">null</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$max_auth_age</span> = <span class="var-default">null</span>])

    82. 

  82. 									</div>

    83. 

  83. 														

    84. 

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

    85. 

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

    86. 

  86. 										<a href="#addPolicyURI" title="details" class="method-name">addPolicyURI</a>

    87. 

  87. 											(<span class="var-type"></span>&nbsp;<span class="var-name">$policy_uri</span>)

    88. 

  88. 									</div>

    89. 

  89. 														

    90. 

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

    91. 

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

    92. 

  92. 										<a href="#fromOpenIDRequest" title="details" class="method-name">fromOpenIDRequest</a>

    93. 

  93. 											(<span class="var-type"></span>&nbsp;<span class="var-name">$request</span>)

    94. 

  94. 									</div>

    95. 

  95. 														

    96. 

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

    97. 

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

    98. 

  98. 										<a href="#getExtensionArgs" title="details" class="method-name">getExtensionArgs</a>

    99. 

  99. 										()

    100. 

  100. 									</div>

    101. 

  101. 														

    102. 

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

    103. 

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

    104. 

  104. 										<a href="#parseExtensionArgs" title="details" class="method-name">parseExtensionArgs</a>

    105. 

  105. 											(<span class="var-type">args:</span>&nbsp;<span class="var-name">$args</span>)

    106. 

  106. 									</div>

    107. 

  107. 														

    108. 

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

    109. 

  109. 											<span class="method-result">array</span>

    110. 

  110. 										<a href="#preferredTypes" title="details" class="method-name">preferredTypes</a>

    111. 

  111. 											(<span class="var-type">supported_types:</span>&nbsp;<span class="var-name">$supported_types</span>)

    112. 

  112. 									</div>

    113. 

  113. 											</div>

    114. 

  114. 		</div>

    115. 

  115. 	</div>		

    116. 

  116. 

    117. 

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

    118. 

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

    119. 

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

    120. 

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

    121. 

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

    122. 

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

    123. 

  123. 						

    124. 

  124. 			

    125. 

  125. 										| 

    126. 

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

    127. 

  127. 							

    128. 

  128. 					</div>

    129. 

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

    130. 

  130. 			

    131. 

  131. <a name="var$ns_alias" id="$ns_alias"><!-- --></A>

    132. 

  132. <div class="evenrow">

    133. 

  133. 

    134. 

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

    135. 

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

    136. 

  136. 			<span class="var-type">mixed</span>

    137. 

  137. 			<span class="var-name">$ns_alias</span>

    138. 

  138. 			 = <span class="var-default"> 'pape'</span>			(line <span class="line-number">37</span>)

    139. 

  139. 		</span>

    140. 

  140. 	</div>

    141. 

  141. 

    142. 

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

    143. 

  143. 	

    144. 

  144. 	

    145. 

  145. 			<hr class="separator" />

    146. 

  146. 		<div class="notes">Redefinition of:</div>

    147. 

  147. 		<dl>

    148. 

  148. 			<dt><a href="../OpenID/Auth_OpenID_Extension.html#var$ns_alias">Auth_OpenID_Extension::$ns_alias</a></dt>

    149. 

  149. 					</dl>

    150. 

  150. 		

    151. 

  151. 		

    152. 

  152. 

    153. 

  153. </div>

    154. 

  154. <a name="var$ns_uri" id="$ns_uri"><!-- --></A>

    155. 

  155. <div class="oddrow">

    156. 

  156. 

    157. 

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

    158. 

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

    159. 

  159. 			<span class="var-type">mixed</span>

    160. 

  160. 			<span class="var-name">$ns_uri</span>

    161. 

  161. 			 = <span class="var-default"> Auth_OpenID_PAPE_NS_URI</span>			(line <span class="line-number">38</span>)

    162. 

  162. 		</span>

    163. 

  163. 	</div>

    164. 

  164. 

    165. 

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

    166. 

  166. 	

    167. 

  167. 	

    168. 

  168. 			<hr class="separator" />

    169. 

  169. 		<div class="notes">Redefinition of:</div>

    170. 

  170. 		<dl>

    171. 

  171. 			<dt><a href="../OpenID/Auth_OpenID_Extension.html#var$ns_uri">Auth_OpenID_Extension::$ns_uri</a></dt>

    172. 

  172. 						<dd>ns_uri: The namespace to which to add the arguments for this</dd>

    173. 

  173. 					</dl>

    174. 

  174. 		

    175. 

  175. 		

    176. 

  176. 

    177. 

  177. </div>

    178. 

  178. 
						

    179. 

  179. 		</div>

    180. 

  180. 	</div>

    181. 

  181. 	

    182. 

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

    183. 

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

    184. 

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

    185. 

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

    186. 

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

    187. 

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

    188. 

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

    189. 

  189. 						

    190. 

  190. 		</div>

    191. 

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

    192. 

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

    193. 

  193. <a name="methodAuth_OpenID_PAPE_Request" id="Auth_OpenID_PAPE_Request"><!-- --></a>

    194. 

  194. <div class="evenrow">

    195. 

  195. 	

    196. 

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

    197. 

  197. 		<span class="method-title">Constructor Auth_OpenID_PAPE_Request</span> (line <span class="line-number">40</span>)

    198. 

  198. 	</div> 

    199. 

  199. 	

    200. 

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

    201. 

  201. 	

    202. 

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

    203. 

  203. 		<span class="method-result">Auth_OpenID_PAPE_Request</span>

    204. 

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

    205. 

  205. 			Auth_OpenID_PAPE_Request

    206. 

  206. 		</span>

    207. 

  207. 					([<span class="var-type"></span>&nbsp;<span class="var-name">$preferred_auth_policies</span> = <span class="var-default">null</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$max_auth_age</span> = <span class="var-default">null</span>])

    208. 

  208. 			</div>

    209. 

  209. 	

    210. 

  210. 			<ul class="parameters">

    211. 

  211. 					<li>

    212. 

  212. 				<span class="var-type"></span>

    213. 

  213. 				<span class="var-name">$preferred_auth_policies</span>			</li>

    214. 

  214. 					<li>

    215. 

  215. 				<span class="var-type"></span>

    216. 

  216. 				<span class="var-name">$max_auth_age</span>			</li>

    217. 

  217. 				</ul>

    218. 

  218. 		

    219. 

  219. 			

    220. 

  220. 	</div>

    221. 

  221. <a name="methodaddPolicyURI" id="addPolicyURI"><!-- --></a>

    222. 

  222. <div class="oddrow">

    223. 

  223. 	

    224. 

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

    225. 

  225. 		<span class="method-title">addPolicyURI</span> (line <span class="line-number">60</span>)

    226. 

  226. 	</div> 

    227. 

  227. 	

    228. 

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

    229. 

  229. <p class="short-description">Add an acceptable authentication policy URI to this request</p>

    230. 

  230. <p class="description"><p>This method is intended to be used by the relying party to add  acceptable authentication types to the request.</p><p>policy_uri: The identifier for the preferred type of  authentication.</p></p>

    231. 

  231. 	

    232. 

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

    233. 

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

    234. 

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

    235. 

  235. 			addPolicyURI

    236. 

  236. 		</span>

    237. 

  237. 					(<span class="var-type"></span>&nbsp;<span class="var-name">$policy_uri</span>)

    238. 

  238. 			</div>

    239. 

  239. 	

    240. 

  240. 			<ul class="parameters">

    241. 

  241. 					<li>

    242. 

  242. 				<span class="var-type"></span>

    243. 

  243. 				<span class="var-name">$policy_uri</span>			</li>

    244. 

  244. 				</ul>

    245. 

  245. 		

    246. 

  246. 			

    247. 

  247. 	</div>

    248. 

  248. <a name="methodfromOpenIDRequest" id="fromOpenIDRequest"><!-- --></a>

    249. 

  249. <div class="evenrow">

    250. 

  250. 	

    251. 

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

    252. 

  252. 		<span class="method-title">fromOpenIDRequest</span> (line <span class="line-number">85</span>)

    253. 

  253. 	</div> 

    254. 

  254. 	

    255. 

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

    256. 

  256. <p class="short-description">Instantiate a Request object from the arguments in a checkid_*</p>

    257. 

  257. <p class="description"><p>OpenID message</p></p>

    258. 

  258. 	

    259. 

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

    260. 

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

    261. 

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

    262. 

  262. 			fromOpenIDRequest

    263. 

  263. 		</span>

    264. 

  264. 					(<span class="var-type"></span>&nbsp;<span class="var-name">$request</span>)

    265. 

  265. 			</div>

    266. 

  266. 	

    267. 

  267. 			<ul class="parameters">

    268. 

  268. 					<li>

    269. 

  269. 				<span class="var-type"></span>

    270. 

  270. 				<span class="var-name">$request</span>			</li>

    271. 

  271. 				</ul>

    272. 

  272. 		

    273. 

  273. 			

    274. 

  274. 	</div>

    275. 

  275. <a name="methodgetExtensionArgs" id="getExtensionArgs"><!-- --></a>

    276. 

  276. <div class="oddrow">

    277. 

  277. 	

    278. 

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

    279. 

  279. 		<span class="method-title">getExtensionArgs</span> (line <span class="line-number">67</span>)

    280. 

  280. 	</div> 

    281. 

  281. 	

    282. 

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

    283. 

  283. 	

    284. 

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

    285. 

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

    286. 

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

    287. 

  287. 			getExtensionArgs

    288. 

  288. 		</span>

    289. 

  289. 				()

    290. 

  290. 			</div>

    291. 

  291. 	

    292. 

  292. 		

    293. 

  293. 			<hr class="separator" />

    294. 

  294. 		<div class="notes">Redefinition of:</div>

    295. 

  295. 		<dl>

    296. 

  296. 			<dt><a href="../OpenID/Auth_OpenID_Extension.html#methodgetExtensionArgs">Auth_OpenID_Extension::getExtensionArgs()</a></dt>

    297. 

  297. 						<dd>Get the string arguments that should be added to an OpenID  message for this extension.</dd>

    298. 

  298. 					</dl>

    299. 

  299. 			

    300. 

  300. 	</div>

    301. 

  301. <a name="methodparseExtensionArgs" id="parseExtensionArgs"><!-- --></a>

    302. 

  302. <div class="evenrow">

    303. 

  303. 	

    304. 

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

    305. 

  305. 		<span class="method-title">parseExtensionArgs</span> (line <span class="line-number">104</span>)

    306. 

  306. 	</div> 

    307. 

  307. 	

    308. 

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

    309. 

  309. <p class="short-description">Set the state of this request to be that expressed in these  PAPE arguments</p>

    310. 

  310. 	

    311. 

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

    312. 

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

    313. 

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

    314. 

  314. 			parseExtensionArgs

    315. 

  315. 		</span>

    316. 

  316. 					(<span class="var-type">args:</span>&nbsp;<span class="var-name">$args</span>)

    317. 

  317. 			</div>

    318. 

  318. 	

    319. 

  319. 			<ul class="parameters">

    320. 

  320. 					<li>

    321. 

  321. 				<span class="var-type">args:</span>

    322. 

  322. 				<span class="var-name">$args</span><span class="var-description">: The PAPE arguments without a namespace</span>			</li>

    323. 

  323. 				</ul>

    324. 

  324. 		

    325. 

  325. 			

    326. 

  326. 	</div>

    327. 

  327. <a name="methodpreferredTypes" id="preferredTypes"><!-- --></a>

    328. 

  328. <div class="oddrow">

    329. 

  329. 	

    330. 

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

    331. 

  331. 		<span class="method-title">preferredTypes</span> (line <span class="line-number">142</span>)

    332. 

  332. 	</div> 

    333. 

  333. 	

    334. 

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

    335. 

  335. <p class="short-description">Given a list of authentication policy URIs that a provider  supports, this method returns the subsequence of those types  that are preferred by the relying party.</p>

    336. 

  336. 	<ul class="tags">

    337. 

  337. 				<li><span class="field">return:</span> The sub-sequence of the supported types that are  preferred by the relying party. This list will be ordered in  the order that the types appear in the supported_types  sequence, and may be empty if the provider does not prefer any  of the supported authentication types.</li>

    338. 

  338. 			</ul>

    339. 

  339. 	

    340. 

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

    341. 

  341. 		<span class="method-result">array</span>

    342. 

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

    343. 

  343. 			preferredTypes

    344. 

  344. 		</span>

    345. 

  345. 					(<span class="var-type">supported_types:</span>&nbsp;<span class="var-name">$supported_types</span>)

    346. 

  346. 			</div>

    347. 

  347. 	

    348. 

  348. 			<ul class="parameters">

    349. 

  349. 					<li>

    350. 

  350. 				<span class="var-type">supported_types:</span>

    351. 

  351. 				<span class="var-name">$supported_types</span><span class="var-description">: A sequence of authentication policy  type URIs that are supported by a provider</span>			</li>

    352. 

  352. 				</ul>

    353. 

  353. 		

    354. 

  354. 			

    355. 

  355. 	</div>

    356. 

  356. 							<h4>Inherited Methods</h4>

    357. 

  357. 				<a name='inherited_methods'><!-- --></a>	

    358. 

  358. 									<!-- =========== Summary =========== -->

    359. 

  359. 					<p>Inherited From <span class="classname"><a href="../OpenID/Auth_OpenID_Extension.html">Auth_OpenID_Extension</a></span></p>

    360. 

  360. 					<blockquote>

    361. 

  361. 													<span class="method-name"><a href="../OpenID/Auth_OpenID_Extension.html#methodgetExtensionArgs">Auth_OpenID_Extension::getExtensionArgs()</a></span><br>

    362. 

  362. 													<span class="method-name"><a href="../OpenID/Auth_OpenID_Extension.html#methodtoMessage">Auth_OpenID_Extension::toMessage()</a></span><br>

    363. 

  363. 											</blockquote>

    364. 

  364. 										

    365. 

  365. 		</div>

    366. 

  366. 	</div>

    367. 

  367. 

    368. 

  368. 

    369. 

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

    370. 

  370. 		Documentation generated on Tue, 21 Apr 2009 11:31:32 -0700 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>

    371. 

  371. 	</p>

    372. 

  372. 	</div></body>

    373. 

  373. </html>

    374.