PageRenderTime 24ms CodeModel.GetById 22ms RepoModel.GetById 0ms app.codeStats 0ms

/evolution/docs/phpdoc/default/Options.html

https://code.google.com/
HTML | 238 lines | 184 code | 48 blank | 6 comment | 0 complexity | 9e3fae812ff15fa3c2475382faea50e8 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 Options</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 Options</h2>
    13. 

  13. 

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

  20. 						
    21. 

  21. 											<a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
    22. 

  22. 						
    23. 

  23. 			</div>
    24. 

  24. 	<div class="info-box-body">
    25. 

  25.         		<!-- ========== Info from phpDoc block ========= -->
    26. 

  26. 		<p class="notes">
    27. 

  27. 			Located in <a class="field" href="_evolution---assets---modules---phpids---classes---class.options.php.html">/evolution/assets/modules/phpids/classes/class.options.php</a> (line <span class="field">15</span>)
    28. 

  28. 		</p>
    29. 

  29. 		
    30. 

  30. 				
    31. 

  31. 		<pre></pre>
    32. 

  32. 	
    33. 

  33. 			</div>
    34. 

  34. </div>
    35. 

  35. 

  36. 

  37. 	<a name="sec-const-summary"></a>
    38. 

  38. 	<div class="info-box">
    39. 

  39. 		<div class="info-box-title">Class Constant Summary</span></div>
    40. 

  40. 		<div class="nav-bar">
    41. 

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

  42. 						<span class="disabled">Constants</span> (<a href="#sec-consts">details</a>)
    43. 

  43. 										| 
    44. 

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

  45. 							
    46. 

  46. 					</div>
    47. 

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

  48. 			<div class="const-summary">
    49. 

  49. 								<div class="const-title">
    50. 

  50. 					<img src="../media/images/Constant.png" alt=" " />
    51. 

  51. 					<a href="#OPTION_LAST_FILTER_UPDATE" title="details" class="const-name">OPTION_LAST_FILTER_UPDATE</a> = 					<span class="var-type"> 'LAST_FILTER_UPDATE'</span>
    52. 

  52. 

  53. 				</div>
    54. 

  54. 							</div>
    55. 

  55. 		</div>
    56. 

  56. 	</div>
    57. 

  57. 

  58. 

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

  60. 	<div class="info-box">
    61. 

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

  62. 		<div class="nav-bar">
    63. 

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

  64. 															<a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
    65. 

  65. 							
    66. 

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

  67. 		</div>
    68. 

  68. 		<div class="info-box-body">			
    69. 

  69. 			<div class="method-summary">
    70. 

  70. 																												
    71. 

  71. 												<div class="method-definition">
    72. 

  72. 											<span class="method-result">Options</span>
    73. 

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

  74. 											(<span class="var-type">string</span>&nbsp;<span class="var-name">$tableName</span>)
    75. 

  75. 									</div>
    76. 

  76. 																<div class="method-definition">
    77. 

  77. 											<span class="method-result">string</span>
    78. 

  78. 										<a href="#getOption" title="details" class="method-name">getOption</a>
    79. 

  79. 											(<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>)
    80. 

  80. 									</div>
    81. 

  81. 																<div class="method-definition">
    82. 

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

  83. 										<a href="#setOption" title="details" class="method-name">setOption</a>
    84. 

  84. 											(<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>)
    85. 

  85. 									</div>
    86. 

  86. 								</div>
    87. 

  87. 		</div>
    88. 

  88. 	</div>		
    89. 

  89. 

  90. 	
    91. 

  91. 	<a name="sec-methods"></a>
    92. 

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

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

  94. 		<div class="nav-bar">
    95. 

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

  96. 																		<a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
    97. 

  97. 							
    98. 

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

  99. 						
    100. 

  100. 		</div>
    101. 

  101. 		<div class="info-box-body">
    102. 

  102. 			<A NAME='method_detail'></A>
    103. 

  103. 

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

  105. <div class="oddrow">
    106. 

  106. 	
    107. 

  107. 	<div class="method-header">
    108. 

  108. 		<span class="method-title">Constructor __construct</span> (line <span class="line-number">37</span>)
    109. 

  109. 	</div> 
    110. 

  110. 	
    111. 

  111. 	<!-- ========== Info from phpDoc block ========= -->
    112. 

  112. <p class="short-description">Creates the option object</p>
    113. 

  113. 	<ul class="tags">
    114. 

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

  115. 			</ul>
    116. 

  116. 	
    117. 

  117. 	<div class="method-signature">
    118. 

  118. 		<span class="method-result">Options</span>
    119. 

  119. 		<span class="method-name">
    120. 

  120. 			__construct
    121. 

  121. 		</span>
    122. 

  122. 					(<span class="var-type">string</span>&nbsp;<span class="var-name">$tableName</span>)
    123. 

  123. 			</div>
    124. 

  124. 	
    125. 

  125. 			<ul class="parameters">
    126. 

  126. 					<li>
    127. 

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

  128. 				<span class="var-name">$tableName</span><span class="var-description">: The name of the table used to store the options</span>			</li>
    129. 

  129. 				</ul>
    130. 

  130. 		
    131. 

  131. 			
    132. 

  132. 	</div>
    133. 

  133. <a name="methodgetOption" id="getOption"><!-- --></a>
    134. 

  134. <div class="evenrow">
    135. 

  135. 	
    136. 

  136. 	<div class="method-header">
    137. 

  137. 		<span class="method-title">getOption</span> (line <span class="line-number">110</span>)
    138. 

  138. 	</div> 
    139. 

  139. 	
    140. 

  140. 	<!-- ========== Info from phpDoc block ========= -->
    141. 

  141. <p class="short-description">Returns the option value for the given name, empty if the option does not  exist.</p>
    142. 

  142. 	<ul class="tags">
    143. 

  143. 				<li><span class="field">return:</span> The option value for the given name, empty if the option does not exist</li>
    144. 

  144. 				<li><span class="field">throws:</span> If $name is empty</li>
    145. 

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

  146. 			</ul>
    147. 

  147. 	
    148. 

  148. 	<div class="method-signature">
    149. 

  149. 		<span class="method-result">string</span>
    150. 

  150. 		<span class="method-name">
    151. 

  151. 			getOption
    152. 

  152. 		</span>
    153. 

  153. 					(<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>)
    154. 

  154. 			</div>
    155. 

  155. 	
    156. 

  156. 			<ul class="parameters">
    157. 

  157. 					<li>
    158. 

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

  159. 				<span class="var-name">$name</span><span class="var-description">: The name of the option</span>			</li>
    160. 

  160. 				</ul>
    161. 

  161. 		
    162. 

  162. 			
    163. 

  163. 	</div>
    164. 

  164. <a name="methodsetOption" id="setOption"><!-- --></a>
    165. 

  165. <div class="oddrow">
    166. 

  166. 	
    167. 

  167. 	<div class="method-header">
    168. 

  168. 		<span class="method-title">setOption</span> (line <span class="line-number">75</span>)
    169. 

  169. 	</div> 
    170. 

  170. 	
    171. 

  171. 	<!-- ========== Info from phpDoc block ========= -->
    172. 

  172. <p class="short-description">Write an option value with the given option name to the database.</p>
    173. 

  173. 	<ul class="tags">
    174. 

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

  175. 			</ul>
    176. 

  176. 	
    177. 

  177. 	<div class="method-signature">
    178. 

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

  179. 		<span class="method-name">
    180. 

  180. 			setOption
    181. 

  181. 		</span>
    182. 

  182. 					(<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>)
    183. 

  183. 			</div>
    184. 

  184. 	
    185. 

  185. 			<ul class="parameters">
    186. 

  186. 					<li>
    187. 

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

  188. 				<span class="var-name">$name</span><span class="var-description">: The name of the option</span>			</li>
    189. 

  189. 					<li>
    190. 

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

  191. 				<span class="var-name">$value</span><span class="var-description">: The value of the option</span>			</li>
    192. 

  192. 				</ul>
    193. 

  193. 		
    194. 

  194. 			
    195. 

  195. 	</div>
    196. 

  196. 						
    197. 

  197. 		</div>
    198. 

  198. 	</div>
    199. 

  199. 

  200. 	<a name="sec-consts"></a>
    201. 

  201. 	<div class="info-box">
    202. 

  202. 		<div class="info-box-title">Class Constants</div>
    203. 

  203. 		<div class="nav-bar">
    204. 

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

  205. 										<a href="#sec-var-summary">Constants</a> (<span class="disabled">details</span>)
    206. 

  206. 						
    207. 

  207. 			
    208. 

  208. 										| 
    209. 

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

  210. 							
    211. 

  211. 					</div>
    212. 

  212. 		<div class="info-box-body">
    213. 

  213. 			<a name="constOPTION_LAST_FILTER_UPDATE" id="OPTION_LAST_FILTER_UPDATE"><!-- --></A>
    214. 

  214. <div class="evenrow">
    215. 

  215. 

  216. 	<div class="const-header">
    217. 

  217. 		<img src="../media/images/Variable.png" />
    218. 

  218. 		<span class="const-title">
    219. 

  219. 			<span class="const-name">OPTION_LAST_FILTER_UPDATE</span>
    220. 

  220. 			 = <span class="const-default"> 'LAST_FILTER_UPDATE'</span>
    221. 

  221. 			(line <span class="line-number">19</span>)
    222. 

  222. 		</span>
    223. 

  223. 	</div>
    224. 

  224. 

  225. 	<!-- ========== Info from phpDoc block ========= -->
    226. 

  226. <p class="short-description">Constant string with the option name for last filter update</p>
    227. 

  227. 	
    228. 

  228. 	
    229. 

  229. </div>
    230. 

  230. 						
    231. 

  231. 		</div>
    232. 

  232. 	</div>
    233. 

  233. 

  234. 	<p class="notes" id="credit">
    235. 

  235. 		Documentation generated on Mon, 27 Feb 2012 21:57:01 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
    236. 

  236. 	</p>
    237. 

  237. 	</div></body>
    238. 

  238. </html>
    239.