PageRenderTime 53ms CodeModel.GetById 17ms RepoModel.GetById 0ms app.codeStats 0ms

/docs/API/UnitCheckProject.html

#
HTML | 447 lines | 344 code | 89 blank | 14 comment | 0 complexity | 87e48712a0188f30e987ced3f9d142b2 MD5 | raw file
Possible License(s): GPL-3.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 UnitCheckProject</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 UnitCheckProject</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. 					</div>
    22. 

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

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

  24. <p class="short-description">UnitCheckProject class is a template for UnitCheck Project objects.</p>
    25. 

  25. <p class="description"><p>Copyright (C) 2011 Tom Kaczocha &lt;freedomdeveloper@yahoo.com&gt;</p><p>This file is part of UnitCheck.</p><p>UnitCheck is free software: you can redistribute it and/or modify  it under the terms of the GNU General Public License as published by  the Free Software Foundation, either version 3 of the License, or  (at your option) any later version.</p><p>UnitCheck is distributed in the hope that it will be useful,  but WITHOUT ANY WARRANTY; without even the implied warranty of  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the  GNU General Public License for more details.</p><p>You should have received a copy of the GNU General Public License  along with UnitCheck.  If not, see &lt;http://www.gnu.org/licenses/&gt;.</p></p>
    26. 

  26. 	<ul class="tags">
    27. 

  27. 				<li><span class="field">author:</span> Tom Kaczocha &lt;<a href="mailto:freedomdeveloper@yahoo.com">freedomdeveloper@yahoo.com</a>&gt;</li>
    28. 

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

  29. 				<li><span class="field">copyright:</span> 2011 Tom Kaczocha</li>
    30. 

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

  31. 			</ul>
    32. 

  32. 		<p class="notes">
    33. 

  33. 			Located in <a class="field" href="_UnitCheckProject.php.html">/UnitCheckProject.php</a> (line <span class="field">32</span>)
    34. 

  34. 		</p>
    35. 

  35. 		
    36. 

  36. 				
    37. 

  37. 		<pre></pre>
    38. 

  38. 	
    39. 

  39. 			</div>
    40. 

  40. </div>
    41. 

  41. 

  42. 

  43. 

  44. 

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

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

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

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

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

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

  51. 		</div>
    52. 

  52. 		<div class="info-box-body">			
    53. 

  53. 			<div class="method-summary">
    54. 

  54. 																																																																																												<div class="method-definition">
    55. 

  55. 					static 						<span class="method-result">void</span>
    56. 

  56. 										<a href="#getProjectResultSet" title="details" class="method-name">getProjectResultSet</a>
    57. 

  57. 										()
    58. 

  58. 									</div>
    59. 

  59. 																
    60. 

  60. 												<div class="method-definition">
    61. 

  61. 											<span class="method-result">UnitCheckProject</span>
    62. 

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

  63. 											([<span class="var-type"></span>&nbsp;<span class="var-name">$pID</span> = <span class="var-default">&quot;&quot;</span>])
    64. 

  64. 									</div>
    65. 

  65. 																<div class="method-definition">
    66. 

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

  67. 										<a href="#__destruct" title="details" class="method-name">__destruct</a>
    68. 

  68. 										()
    69. 

  69. 									</div>
    70. 

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

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

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

  73. 											(<span class="var-type"></span>&nbsp;<span class="var-name">$pName</span>)
    74. 

  74. 									</div>
    75. 

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

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

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

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

  79. 									</div>
    80. 

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

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

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

  83. 										()
    84. 

  84. 									</div>
    85. 

  85. 																<div class="method-definition">
    86. 

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

  87. 										<a href="#getProjectDataSetByID" title="details" class="method-name">getProjectDataSetByID</a>
    88. 

  88. 											(<span class="var-type"></span>&nbsp;<span class="var-name">$pID</span>)
    89. 

  89. 									</div>
    90. 

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

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

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

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

  94. 									</div>
    95. 

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

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

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

  98. 										()
    99. 

  99. 									</div>
    100. 

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

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

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

  103. 										()
    104. 

  104. 									</div>
    105. 

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

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

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

  108. 										()
    109. 

  109. 									</div>
    110. 

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

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

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

  113. 											(<span class="var-type"></span>&nbsp;<span class="var-name">$pName</span>)
    114. 

  114. 									</div>
    115. 

  115. 								</div>
    116. 

  116. 		</div>
    117. 

  117. 	</div>		
    118. 

  118. 

  119. 	
    120. 

  120. 	<a name="sec-methods"></a>
    121. 

  121. 	<div class="info-box">
    122. 

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

  123. 		<div class="nav-bar">
    124. 

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

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

  126. 						
    127. 

  127. 		</div>
    128. 

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

  129. 			<A NAME='method_detail'></A>
    130. 

  130. <a name="methodgetProjectResultSet" id="getProjectResultSet"><!-- --></a>
    131. 

  131. <div class="evenrow">
    132. 

  132. 	
    133. 

  133. 	<div class="method-header">
    134. 

  134. 		<span class="method-title">static method getProjectResultSet</span> (line <span class="line-number">144</span>)
    135. 

  135. 	</div> 
    136. 

  136. 	
    137. 

  137. 	<!-- ========== Info from phpDoc block ========= -->
    138. 

  138. 	<ul class="tags">
    139. 

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

  140. 			</ul>
    141. 

  141. 	
    142. 

  142. 	<div class="method-signature">
    143. 

  143. 	    static
    144. 

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

  145. 		<span class="method-name">
    146. 

  146. 			getProjectResultSet
    147. 

  147. 		</span>
    148. 

  148. 				()
    149. 

  149. 			</div>
    150. 

  150. 	
    151. 

  151. 		
    152. 

  152. 			
    153. 

  153. 	</div>
    154. 

  154. 

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

  156. <div class="oddrow">
    157. 

  157. 	
    158. 

  158. 	<div class="method-header">
    159. 

  159. 		<span class="method-title">Constructor __construct</span> (line <span class="line-number">39</span>)
    160. 

  160. 	</div> 
    161. 

  161. 	
    162. 

  162. 	<!-- ========== Info from phpDoc block ========= -->
    163. 

  163. 	<ul class="tags">
    164. 

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

  165. 			</ul>
    166. 

  166. 	
    167. 

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

  168. 		<span class="method-result">UnitCheckProject</span>
    169. 

  169. 		<span class="method-name">
    170. 

  170. 			__construct
    171. 

  171. 		</span>
    172. 

  172. 					([<span class="var-type"></span>&nbsp;<span class="var-name">$pID</span> = <span class="var-default">&quot;&quot;</span>])
    173. 

  173. 			</div>
    174. 

  174. 	
    175. 

  175. 			<ul class="parameters">
    176. 

  176. 					<li>
    177. 

  177. 				<span class="var-type"></span>
    178. 

  178. 				<span class="var-name">$pID</span>			</li>
    179. 

  179. 				</ul>
    180. 

  180. 		
    181. 

  181. 			
    182. 

  182. 	</div>
    183. 

  183. <a name="method__destruct" id="__destruct"><!-- --></a>
    184. 

  184. <div class="evenrow">
    185. 

  185. 	
    186. 

  186. 	<div class="method-header">
    187. 

  187. 		<span class="method-title">Destructor __destruct</span> (line <span class="line-number">47</span>)
    188. 

  188. 	</div> 
    189. 

  189. 	
    190. 

  190. 	<!-- ========== Info from phpDoc block ========= -->
    191. 

  191. 	<ul class="tags">
    192. 

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

  193. 			</ul>
    194. 

  194. 	
    195. 

  195. 	<div class="method-signature">
    196. 

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

  197. 		<span class="method-name">
    198. 

  198. 			__destruct
    199. 

  199. 		</span>
    200. 

  200. 				()
    201. 

  201. 			</div>
    202. 

  202. 	
    203. 

  203. 		
    204. 

  204. 			
    205. 

  205. 	</div>
    206. 

  206. <a name="methodcreateNewProject" id="createNewProject"><!-- --></a>
    207. 

  207. <div class="oddrow">
    208. 

  208. 	
    209. 

  209. 	<div class="method-header">
    210. 

  210. 		<span class="method-title">createNewProject</span> (line <span class="line-number">77</span>)
    211. 

  211. 	</div> 
    212. 

  212. 	
    213. 

  213. 	<!-- ========== Info from phpDoc block ========= -->
    214. 

  214. 	<ul class="tags">
    215. 

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

  216. 			</ul>
    217. 

  217. 	
    218. 

  218. 	<div class="method-signature">
    219. 

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

  220. 		<span class="method-name">
    221. 

  221. 			createNewProject
    222. 

  222. 		</span>
    223. 

  223. 					(<span class="var-type"></span>&nbsp;<span class="var-name">$pName</span>)
    224. 

  224. 			</div>
    225. 

  225. 	
    226. 

  226. 			<ul class="parameters">
    227. 

  227. 					<li>
    228. 

  228. 				<span class="var-type"></span>
    229. 

  229. 				<span class="var-name">$pName</span>			</li>
    230. 

  230. 				</ul>
    231. 

  231. 		
    232. 

  232. 			
    233. 

  233. 	</div>
    234. 

  234. <a name="methodcreateProjectDirectory" id="createProjectDirectory"><!-- --></a>
    235. 

  235. <div class="evenrow">
    236. 

  236. 	
    237. 

  237. 	<div class="method-header">
    238. 

  238. 		<span class="method-title">createProjectDirectory</span> (line <span class="line-number">161</span>)
    239. 

  239. 	</div> 
    240. 

  240. 	
    241. 

  241. 	<!-- ========== Info from phpDoc block ========= -->
    242. 

  242. 	<ul class="tags">
    243. 

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

  244. 			</ul>
    245. 

  245. 	
    246. 

  246. 	<div class="method-signature">
    247. 

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

  248. 		<span class="method-name">
    249. 

  249. 			createProjectDirectory
    250. 

  250. 		</span>
    251. 

  251. 					(<span class="var-type"></span>&nbsp;<span class="var-name">$projectName</span>)
    252. 

  252. 			</div>
    253. 

  253. 	
    254. 

  254. 			<ul class="parameters">
    255. 

  255. 					<li>
    256. 

  256. 				<span class="var-type"></span>
    257. 

  257. 				<span class="var-name">$projectName</span>			</li>
    258. 

  258. 				</ul>
    259. 

  259. 		
    260. 

  260. 			
    261. 

  261. 	</div>
    262. 

  262. <a name="methodgetProjectCreationDate" id="getProjectCreationDate"><!-- --></a>
    263. 

  263. <div class="oddrow">
    264. 

  264. 	
    265. 

  265. 	<div class="method-header">
    266. 

  266. 		<span class="method-title">getProjectCreationDate</span> (line <span class="line-number">69</span>)
    267. 

  267. 	</div> 
    268. 

  268. 	
    269. 

  269. 	<!-- ========== Info from phpDoc block ========= -->
    270. 

  270. 	<ul class="tags">
    271. 

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

  272. 			</ul>
    273. 

  273. 	
    274. 

  274. 	<div class="method-signature">
    275. 

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

  276. 		<span class="method-name">
    277. 

  277. 			getProjectCreationDate
    278. 

  278. 		</span>
    279. 

  279. 				()
    280. 

  280. 			</div>
    281. 

  281. 	
    282. 

  282. 		
    283. 

  283. 			
    284. 

  284. 	</div>
    285. 

  285. <a name="methodgetProjectDataSetByID" id="getProjectDataSetByID"><!-- --></a>
    286. 

  286. <div class="evenrow">
    287. 

  287. 	
    288. 

  288. 	<div class="method-header">
    289. 

  289. 		<span class="method-title">getProjectDataSetByID</span> (line <span class="line-number">125</span>)
    290. 

  290. 	</div> 
    291. 

  291. 	
    292. 

  292. 	<!-- ========== Info from phpDoc block ========= -->
    293. 

  293. 	<ul class="tags">
    294. 

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

  295. 			</ul>
    296. 

  296. 	
    297. 

  297. 	<div class="method-signature">
    298. 

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

  299. 		<span class="method-name">
    300. 

  300. 			getProjectDataSetByID
    301. 

  301. 		</span>
    302. 

  302. 					(<span class="var-type"></span>&nbsp;<span class="var-name">$pID</span>)
    303. 

  303. 			</div>
    304. 

  304. 	
    305. 

  305. 			<ul class="parameters">
    306. 

  306. 					<li>
    307. 

  307. 				<span class="var-type"></span>
    308. 

  308. 				<span class="var-name">$pID</span>			</li>
    309. 

  309. 				</ul>
    310. 

  310. 		
    311. 

  311. 			
    312. 

  312. 	</div>
    313. 

  313. <a name="methodgetProjectDataSetByName" id="getProjectDataSetByName"><!-- --></a>
    314. 

  314. <div class="oddrow">
    315. 

  315. 	
    316. 

  316. 	<div class="method-header">
    317. 

  317. 		<span class="method-title">getProjectDataSetByName</span> (line <span class="line-number">106</span>)
    318. 

  318. 	</div> 
    319. 

  319. 	
    320. 

  320. 	<!-- ========== Info from phpDoc block ========= -->
    321. 

  321. 	<ul class="tags">
    322. 

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

  323. 			</ul>
    324. 

  324. 	
    325. 

  325. 	<div class="method-signature">
    326. 

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

  327. 		<span class="method-name">
    328. 

  328. 			getProjectDataSetByName
    329. 

  329. 		</span>
    330. 

  330. 					(<span class="var-type"></span>&nbsp;<span class="var-name">$pName</span>)
    331. 

  331. 			</div>
    332. 

  332. 	
    333. 

  333. 			<ul class="parameters">
    334. 

  334. 					<li>
    335. 

  335. 				<span class="var-type"></span>
    336. 

  336. 				<span class="var-name">$pName</span>			</li>
    337. 

  337. 				</ul>
    338. 

  338. 		
    339. 

  339. 			
    340. 

  340. 	</div>
    341. 

  341. <a name="methodgetProjectID" id="getProjectID"><!-- --></a>
    342. 

  342. <div class="evenrow">
    343. 

  343. 	
    344. 

  344. 	<div class="method-header">
    345. 

  345. 		<span class="method-title">getProjectID</span> (line <span class="line-number">61</span>)
    346. 

  346. 	</div> 
    347. 

  347. 	
    348. 

  348. 	<!-- ========== Info from phpDoc block ========= -->
    349. 

  349. 	<ul class="tags">
    350. 

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

  351. 			</ul>
    352. 

  352. 	
    353. 

  353. 	<div class="method-signature">
    354. 

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

  355. 		<span class="method-name">
    356. 

  356. 			getProjectID
    357. 

  357. 		</span>
    358. 

  358. 				()
    359. 

  359. 			</div>
    360. 

  360. 	
    361. 

  361. 		
    362. 

  362. 			
    363. 

  363. 	</div>
    364. 

  364. <a name="methodgetProjectModDate" id="getProjectModDate"><!-- --></a>
    365. 

  365. <div class="oddrow">
    366. 

  366. 	
    367. 

  367. 	<div class="method-header">
    368. 

  368. 		<span class="method-title">getProjectModDate</span> (line <span class="line-number">73</span>)
    369. 

  369. 	</div> 
    370. 

  370. 	
    371. 

  371. 	<!-- ========== Info from phpDoc block ========= -->
    372. 

  372. 	<ul class="tags">
    373. 

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

  374. 			</ul>
    375. 

  375. 	
    376. 

  376. 	<div class="method-signature">
    377. 

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

  378. 		<span class="method-name">
    379. 

  379. 			getProjectModDate
    380. 

  380. 		</span>
    381. 

  381. 				()
    382. 

  382. 			</div>
    383. 

  383. 	
    384. 

  384. 		
    385. 

  385. 			
    386. 

  386. 	</div>
    387. 

  387. <a name="methodgetProjectName" id="getProjectName"><!-- --></a>
    388. 

  388. <div class="evenrow">
    389. 

  389. 	
    390. 

  390. 	<div class="method-header">
    391. 

  391. 		<span class="method-title">getProjectName</span> (line <span class="line-number">65</span>)
    392. 

  392. 	</div> 
    393. 

  393. 	
    394. 

  394. 	<!-- ========== Info from phpDoc block ========= -->
    395. 

  395. 	<ul class="tags">
    396. 

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

  397. 			</ul>
    398. 

  398. 	
    399. 

  399. 	<div class="method-signature">
    400. 

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

  401. 		<span class="method-name">
    402. 

  402. 			getProjectName
    403. 

  403. 		</span>
    404. 

  404. 				()
    405. 

  405. 			</div>
    406. 

  406. 	
    407. 

  407. 		
    408. 

  408. 			
    409. 

  409. 	</div>
    410. 

  410. <a name="methodprojectExists" id="projectExists"><!-- --></a>
    411. 

  411. <div class="oddrow">
    412. 

  412. 	
    413. 

  413. 	<div class="method-header">
    414. 

  414. 		<span class="method-title">projectExists</span> (line <span class="line-number">178</span>)
    415. 

  415. 	</div> 
    416. 

  416. 	
    417. 

  417. 	<!-- ========== Info from phpDoc block ========= -->
    418. 

  418. 	<ul class="tags">
    419. 

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

  420. 			</ul>
    421. 

  421. 	
    422. 

  422. 	<div class="method-signature">
    423. 

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

  424. 		<span class="method-name">
    425. 

  425. 			projectExists
    426. 

  426. 		</span>
    427. 

  427. 					(<span class="var-type"></span>&nbsp;<span class="var-name">$pName</span>)
    428. 

  428. 			</div>
    429. 

  429. 	
    430. 

  430. 			<ul class="parameters">
    431. 

  431. 					<li>
    432. 

  432. 				<span class="var-type"></span>
    433. 

  433. 				<span class="var-name">$pName</span>			</li>
    434. 

  434. 				</ul>
    435. 

  435. 		
    436. 

  436. 			
    437. 

  437. 	</div>
    438. 

  438. 						
    439. 

  439. 		</div>
    440. 

  440. 	</div>
    441. 

  441. 

  442. 

  443. 	<p class="notes" id="credit">
    444. 

  444. 		Documentation generated on Tue, 18 Jan 2011 17:56:51 +1100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
    445. 

  445. 	</p>
    446. 

  446. 	</div></body>
    447. 

  447. </html>
    448.