PageRenderTime 53ms CodeModel.GetById 13ms RepoModel.GetById 1ms app.codeStats 0ms

/lib/functions/print.inc.php

https://bitbucket.org/pfernandez/testlink1.9.6
PHP | 1296 lines | 1088 code | 63 blank | 145 comment | 37 complexity | 6bf6d883ae009642e30dd070fc79bb06 MD5 | raw file
Possible License(s): GPL-2.0, LGPL-2.1, GPL-3.0 
    

  1. <?php

    2. 

  2. /**

    3. 

  3.  * TestLink Open Source Project - http://testlink.sourceforge.net/

    4. 

  4.  * This script is distributed under the GNU General Public License 2 or later.

    5. 

  5.  *

    6. 

  6.  * Library for documents generation

    7. 

  7.  *

    8. 

  8.  * @package TestLink

    9. 

  9.  * @author	Martin Havlat <havlat@users.sourceforge.net>

    10. 

  10.  * @copyright 2007-2009, TestLink community 

    11. 

  11.  * @version $Id: print.inc.php,v 1.106 2010/08/04 03:08:24 amkhullar Exp $

    12. 

  12.  * @uses printDocument.php

    13. 

  13.  *

    14. 

  14.  *

    15. 

  15.  * @internal 

    16. 

  16.  *

    17. 

  17.  * Revisions:

    18. 

  18.  *  20100803 - amitkhullar - Added condition check for null req. custom fields @line 230/346  

    19. 

  19.  *  20100723 - asimon - BUGID 3459: added platform ID to renderTestCaseForPrinting(),

    20. 

  20.  *                                  renderTestSpecTreeForPrinting() and

    21. 

  21.  *                                  renderTestPlanForPrinting()

    22. 

  22.  *  20100723 - asimon - BUGID 3451 and related: solved by changes in renderTestCaseForPrinting()

    23. 

  23.  *  20100326 - asimon - started refactoring and moving of requirement printing functions from 

    24. 

  24.  *                      req classes to this file for generation of req spec document

    25. 

  25.  *                      like it is done for testcases (BUGID 3067)

    26. 

  26.  *  20100306 - contribution by romans - BUGID 0003235: Printing Out Test Report Shows

    27. 

  27.  *                                     empty Column Headers for "Steps" and "Step Actions"

    28. 

  28.  *

    29. 

  29.  *  20100106 - franciscom - Multiple Test Case Steps Feature

    30. 

  30.  *  20100105 - franciscom - added tableColspan,firstColWidth config 

    31. 

  31.  *  20090906 - franciscom - added contribution by Eloff:

    32. 

  32.  *                          - regarding platforms feature

    33. 

  33.  *                          - Moved toc to be outside of report content

    34. 

  34.  *                          - Changed the anchor ids

    35. 

  35.  *

    36. 

  36.  *  20090902 - franciscom - preconditions (printed only if not empty).

    37. 

  37.  *  20090719 - franciscom - added Test Case CF location management 

    38. 

  38.  *                          added utility functions to clean up code

    39. 

  39.  *                          and have  a more modular design

    40. 

  40.  *

    41. 

  41.  *  20090330 - franciscom - fixed internal bug when decoding user names

    42. 

  42.  *	20090410 - amkhullar - BUGID 2368

    43. 

  43.  *  20090330 - franciscom - renderTestSpecTreeForPrinting() - 

    44. 

  44.  *                          added logic to print ALWAYS test plan custom fields

    45. 

  45.  *  20090329 - franciscom - renderTestCaseForPrinting() refactoring of code regarding custom fields

    46. 

  46.  *                          renderTestSuiteNodeForPrinting() - print ALWAYS custom fields

    47. 

  47.  * 	20090326 - amkhullar - BUGID 2207 - Code to Display linked bugs to a TC in Test Report

    48. 

  48.  *	20090322 - amkhullar - added check box for Test Case Custom Field display on Test Plan/Report

    49. 

  49.  *  20090223 - havlatm - estimated execution moved to extra chapter, refactoring a few functions

    50. 

  50.  * 	20090129 - havlatm - removed base tag from header (problems with internal links for some browsers)

    51. 

  51.  *  20081207 - franciscom - BUGID 1910 - changes on display of estimated execution time

    52. 

  52.  *                          added code to display CF with scope='execution'

    53. 

  53.  * 

    54. 

  54.  *  20080820 - franciscom - added contribution (BUGID 1670)

    55. 

  55.  *                         Test Plan report:

    56. 

  56.  *                         Total Estimated execution time will be printed

    57. 

  57.  *                         on table of contents. 

    58. 

  58.  *                         Compute of this time can be done if: 

    59. 

  59.  *                         - Custom Field with Name CF_ESTIMATED_EXEC_TIME exists

    60. 

  60.  *                         - Custom Field is managed at design time

    61. 

  61.  *                         - Custom Field is assigned to Test Cases

    62. 

  62.  *                         

    63. 

  63.  *                         Important Note:

    64. 

  64.  *                         Lots of controls must be developed to avoid problems 

    65. 

  65.  *                         presenting with results, when user use time with decimal part.

    66. 

  66.  *                         Example:

    67. 

  67.  *                         14.6 minuts what does means? 

    68. 

  68.  *                         a) 14 min and 6 seconds?  

    69. 

  69.  *                         b) 14 min and 6% of 1 minute => 14 min 3.6 seconds ?

    70. 

  70.  *

    71. 

  71.  *                         Implementation at (20080820) is very simple => is user

    72. 

  72.  *                         responsibility to use good times (may be always interger values)

    73. 

  73.  *                         to avoid problems.

    74. 

  74.  *                         Another choice: TL must round individual times before doing sum.

    75. 

  75.  *

    76. 

  76.  *	20080819 - franciscom - renderTestCaseForPrinting() - removed mysql only code

    77. 

  77.  *	20080602 - franciscom - display testcase external id

    78. 

  78.  *	20080525 - havlatm - fixed missing test result

    79. 

  79.  *	20080505 - franciscom - renderTestCaseForPrinting() - added custom fields

    80. 

  80.  *	20080418 - franciscom - document_generation configuration .

    81. 

  81.  *                             removed tlCfg global coupling

    82. 

  82.  *	20071014 - franciscom - renderTestCaseForPrinting() added printing of test case version

    83. 

  83.  *	20070509 - franciscom - changes in renderTestSpecTreeForPrinting() interface

    84. 

  84.  *

    85. 

  85.  */ 

    86. 

  86. 

    87. 

  87. /** uses get_bugs_for_exec() */

    88. 

  88. require_once("exec.inc.php");

    89. 

  89. 

    90. 

  90. 

    91. 

  91. /**

    92. 

  92.  * render a requirement as HTML code for printing

    93. 

  93.  * 

    94. 

  94.  * @author Andreas Simon

    95. 

  95.  * 

    96. 

  96.  * @param resource $db

    97. 

  97.  * @param array $node the node to be printed

    98. 

  98.  * @param array $printingOptions

    99. 

  99.  * @param string $tocPrefix Prefix to be printed in TOC before title of node

    100. 

  100.  * @param int $level

    101. 

  101.  * @param int $tprojectID

    102. 

  102.  * 

    103. 

  103.  * @return string $output HTML Code

    104. 

  104.  */

    105. 

  105. function renderRequirementNodeForPrinting(&$db,$node, &$printingOptions, $tocPrefix, $level, $tprojectID) {

    106. 

  106. 	

    107. 

  107. 	static $tableColspan;

    108. 

  108. 	static $firstColWidth;

    109. 

  109. 	static $labels;

    110. 

  110. 	static $title_separator;

    111. 

  111. 	static $req_mgr;

    112. 

  112. 	static $tplan_mgr;

    113. 

  113. 	static $req_cfg;

    114. 

  114. 	static $req_spec_cfg;

    115. 

  115. 	static $reqStatusLabels;

    116. 

  116. 	static $reqTypeLabels;

    117. 

  117. 	

    118. 

  118. 	if (!$req_mgr) {

    119. 

  119. 		$req_cfg = config_get('req_cfg');

    120. 

  120. 		$req_spec_cfg = config_get('req_spec_cfg');

    121. 

  121. 		$firstColWidth = '20%';

    122. 

  122. 		$tableColspan = 2;

    123. 

  123. 		$labels = array('requirement' => 'requirement', 'status' => 'status', 

    124. 

  124. 		                'scope' => 'scope', 'type' => 'type', 'author' => 'author',

    125. 

  125. 		                'relations' => 'relations',

    126. 

  126. 		                'coverage' => 'coverage',

    127. 

  127. 		                'custom_field' => 'custom_field', 'relation_project' => 'relation_project',

    128. 

  128. 		                'related_tcs' => 'related_tcs');

    129. 

  129. 		$labels = init_labels($labels);

    130. 

  130. 		$reqStatusLabels = init_labels($req_cfg->status_labels);

    131. 

  131. 	    $reqTypeLabels = init_labels($req_cfg->type_labels);

    132. 

  132. 		$title_separator = config_get('gui_title_separator_1');

    133. 

  133. 		$req_mgr = new requirement_mgr($db);

    134. 

  134. 		$tplan_mgr = new testplan($db);

    135. 

  135. 	}

    136. 

  136. 	

    137. 

  137. 	$arrReq = $req_mgr->get_by_id($node['id']);

    138. 

  138. 	$req = $arrReq[0];

    139. 

  139. 	$name =  htmlspecialchars($req["req_doc_id"] . $title_separator . $req['title']);

    140. 

  140. 		

    141. 

  141. 	$output = "<table class=\"req\"><tr><th colspan=\"$tableColspan\">" .

    142. 

  142. 	          "<span class=\"label\">{$labels['requirement']}:</span> " . $name . "</th></tr>\n";	

    143. 

  143. 	

    144. 

  144. 	if ($printingOptions['toc']) {

    145. 

  145. 		$printingOptions['tocCode'] .= '<p style="padding-left: ' . 

    146. 

  146. 	                                     (15*$level).'px;"><a href="#' . prefixToHTMLID('req'.$node['id']) . '">' .

    147. 

  147. 	       	                             $name . '</a></p>';

    148. 

  148. 		$output .= '<a name="' . prefixToHTMLID('req'.$node['id']) . '"></a>';

    149. 

  149. 	}

    150. 

  150. 

    151. 

  151. 	if ($printingOptions['req_author']) {

    152. 

  152. 		$author = tlUser::getById($db,$req['author_id']);

    153. 

  153. 		$output .=  '<tr><td width="' . $firstColWidth . '"><span class="label">' . 

    154. 

  154. 		            $labels['author'] . "</span></td><td> " . 

    155. 

  155. 		            htmlspecialchars($author->getDisplayName()) . "</td></tr>\n";

    156. 

  156. 	}

    157. 

  157. 	          	

    158. 

  158. 	if ($printingOptions['req_status']) {

    159. 

  159. 		$output .= '<tr><td width="' . $firstColWidth . '"><span class="label">' . 

    160. 

  160. 		           $labels['status'] . "</span></td>" .

    161. 

  161. 		           "<td>" . $reqStatusLabels[$req['status']] . "</td></tr>";

    162. 

  162. 	}

    163. 

  163. 	

    164. 

  164. 	if ($printingOptions['req_type']) {

    165. 

  165. 		$output .= '<tr><td width="' . $firstColWidth . '"><span class="label">' . 

    166. 

  166. 		           $labels['type'] . "</span></td>" .

    167. 

  167. 		           "<td>" . $reqTypeLabels[$req['type']] . "</td></tr>";

    168. 

  168. 	} 

    169. 

  169. 	

    170. 

  170. 	if ($printingOptions['req_coverage']) {

    171. 

  171. 		$current = count($req_mgr->get_coverage($req['id']));

    172. 

  172. 		$expected = $req['expected_coverage'];

    173. 

  173.     	$coverage = lang_get('not_aplicable') . " ($current/0)";

    174. 

  174.     	if ($expected) {

    175. 

  175.     		$percentage = round(100 / $expected * $current, 2);

    176. 

  176. 			$coverage = "{$percentage}% ({$current}/{$expected})";

    177. 

  177.     	}

    178. 

  178.     	

    179. 

  179.     	$output .= "<tr><td width=\"$firstColWidth\"><span class=\"label\">" . $labels['coverage'] . "</span></td>" .

    180. 

  180. 		           "<td>$coverage</td></tr>";

    181. 

  181. 	} 

    182. 

  182. 	

    183. 

  183. 	if ($printingOptions['req_scope']) {

    184. 

  184. 		$output .= "<tr><td colspan=\"$tableColspan\"><span class=\"label\">" . $labels['scope'] . 

    185. 

  185. 		           "</span><br/>" . $req['scope'] . "</td></tr>";

    186. 

  186. 	}

    187. 

  187. 		

    188. 

  188. 	if ($printingOptions['req_relations']) {

    189. 

  189. 		$relations = $req_mgr->get_relations($req['id']);

    190. 

  190. 

    191. 

  191. 		if ($relations['num_relations']) {

    192. 

  192. 			$output .= "<tr><td width=\"$firstColWidth\"><span class=\"label\">" . $labels['relations'] . "</span></td>" .

    193. 

  193. 			           "<td>";

    194. 

  194. 			

    195. 

  195. 			foreach ($relations['relations'] as $rel) {

    196. 

  196. 				$output .= "{$rel['type_localized']}: <br/>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;" . 

    197. 

  197. 				           htmlspecialchars($rel['related_req']['req_doc_id']) . $title_separator .

    198. 

  198. 			               htmlspecialchars($rel['related_req']['title']) . "</br>" .

    199. 

  199. 				           "&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{$labels['status']}: " .

    200. 

  200. 				           "{$reqStatusLabels[$rel['related_req']['status']]} <br/>";

    201. 

  201. 				if ($req_cfg->relations->interproject_linking) {

    202. 

  202. 					$output .= "&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{$labels['relation_project']}: " .

    203. 

  203. 					           htmlspecialchars($rel['related_req']['testproject_name']) . " <br/>";

    204. 

  204. 				}

    205. 

  205. 			}

    206. 

  206. 			

    207. 

  207. 			$output .= "</td></tr>";

    208. 

  208. 		}

    209. 

  209. 	} 

    210. 

  210. 	

    211. 

  211. 	if ($printingOptions['req_linked_tcs']) {

    212. 

  212. 		$req_coverage = $req_mgr->get_coverage($req['id']);

    213. 

  213. 		

    214. 

  214. 		if (count($req_coverage)) {

    215. 

  215. 			$output .= "<tr><td width=\"$firstColWidth\"><span class=\"label\">" . $labels['related_tcs'] . "</span></td>" .

    216. 

  216. 			           "<td>";

    217. 

  217. 			           

    218. 

  218. 			foreach ($req_coverage as $tc) {

    219. 

  219. 				$output .= htmlentities($tc['tc_external_id'] . $title_separator .

    220. 

  220. 				                        $tc['name']) . "<br/>";

    221. 

  221. 			}

    222. 

  222. 			           

    223. 

  223. 			$output .= "</td></tr>";

    224. 

  224. 		}

    225. 

  225. 	}

    226. 

  226. 	

    227. 

  227. 	if ($printingOptions['req_cf']) 

    228. 

  228. 	{

    229. 

  229. 		$linked_cf = $req_mgr->get_linked_cfields($req['id']);

    230. 

  230. 		if ($linked_cf)

    231. 

  231. 		{

    232. 

  232. 			foreach ($linked_cf as $key => $cf) 

    233. 

  233. 			{

    234. 

  234. 				$cflabel = htmlspecialchars($cf['label']);

    235. 

  235. 				$value = htmlspecialchars($cf['value']);

    236. 

  236. 				

    237. 

  237. 				$output .= "<tr><td width=\"$firstColWidth\"><span class=\"label\">" . 

    238. 

  238. 				           $cflabel . "</span></td>" .

    239. 

  239. 				           "<td>$value</td></tr>";

    240. 

  240. 			}

    241. 

  241. 		}

    242. 

  242. 	}

    243. 

  243. 	

    244. 

  244. 	$output .= "</table><br/>";

    245. 

  245. 

    246. 

  246. 	return $output;

    247. 

  247. }

    248. 

  248. 

    249. 

  249. 

    250. 

  250. /**

    251. 

  251.  * render a requirement specification node as HTML code for printing

    252. 

  252.  * 

    253. 

  253.  * @author Andreas Simon

    254. 

  254.  * 

    255. 

  255.  * @param resource $db

    256. 

  256.  * @param array $node the node to be printed

    257. 

  257.  * @param array $printingOptions

    258. 

  258.  * @param string $tocPrefix Prefix to be printed in TOC before title of node

    259. 

  259.  * @param int $level

    260. 

  260.  * @param int $tprojectID

    261. 

  261.  * 

    262. 

  262.  * @return string $output HTML Code

    263. 

  263.  */

    264. 

  264. function renderReqSpecNodeForPrinting(&$db, &$node, &$printingOptions, $tocPrefix, $level, $tprojectID) {

    265. 

  265. 	static $tableColspan;

    266. 

  266. 	static $firstColWidth;

    267. 

  267. 	static $labels;

    268. 

  268. 	static $title_separator;

    269. 

  269. 	static $req_spec_mgr;

    270. 

  270. 	static $tplan_mgr;

    271. 

  271. 	static $req_spec_cfg;

    272. 

  272. 	static $reqSpecTypeLabels;

    273. 

  273. 	

    274. 

  274. 	if (!$req_spec_mgr) {

    275. 

  275. 		$req_spec_cfg = config_get('req_spec_cfg');

    276. 

  276. 		$firstColWidth = '20%';

    277. 

  277. 		$tableColspan = 2;

    278. 

  278. 		$labels = array('requirements_spec' => 'requirements_spec', 

    279. 

  279. 		                'scope' => 'scope', 'type' => 'type', 'author' => 'author',

    280. 

  280. 		                'relations' => 'relations', 'overwritten_count' => 'req_total',

    281. 

  281. 		                'coverage' => 'coverage',

    282. 

  282. 		                'custom_field' => 'custom_field', 'not_aplicable' => 'not_aplicable');

    283. 

  283. 		$labels = init_labels($labels);

    284. 

  284. 		$reqSpecTypeLabels = init_labels($req_spec_cfg->type_labels);

    285. 

  285. 		$title_separator = config_get('gui_title_separator_1');

    286. 

  286. 		$req_spec_mgr = new requirement_spec_mgr($db);

    287. 

  287. 		$tplan_mgr = new testplan($db);

    288. 

  288. 	}

    289. 

  289. 	

    290. 

  290. 	$spec = $req_spec_mgr->get_by_id($node['id']);

    291. 

  291. 	

    292. 

  292. 	$name = htmlspecialchars($spec['doc_id'] . $title_separator . $spec['title']);

    293. 

  293. 	

    294. 

  294. 	$docHeadingNumbering = '';

    295. 

  295. 	if ($printingOptions['headerNumbering']) {

    296. 

  296. 		$docHeadingNumbering = "$tocPrefix. ";

    297. 

  297. 	}

    298. 

  298. 	

    299. 

  299. 	$output = "<table class=\"req_spec\"><tr><th colspan=\"$tableColspan\">" .

    300. 

  300. 	        "<span class=\"label\">{$docHeadingNumbering}{$labels['requirements_spec']}:</span> " .

    301. 

  301.  			$name . "</th></tr>\n";

    302. 

  302.  		

    303. 

  303. 	if ($printingOptions['toc'])

    304. 

  304. 	{

    305. 

  305. 		$spacing = ($level == 2) ? "<br>" : "";

    306. 

  306. 	 	$printingOptions['tocCode'] .= $spacing.'<b><p style="padding-left: '.(10*$level).'px;">' .

    307. 

  307. 				'<a href="#' . prefixToHTMLID($tocPrefix) . '">' . $docHeadingNumbering . $name . "</a></p></b>\n";

    308. 

  308. 		$output .= "<a name='". prefixToHTMLID($tocPrefix) . "'></a>\n";

    309. 

  309. 	}

    310. 

  310. 	

    311. 

  311. 	if ($printingOptions['req_spec_author']) {

    312. 

  312. 		// get author name for node

    313. 

  313. 		$author = tlUser::getById($db, $spec['author_id']);

    314. 

  314. 		$output .=  '<tr><td width="' . $firstColWidth . '"><span class="label">' . 

    315. 

  315. 		            $labels['author'] . "</span></td><td> " . 

    316. 

  316. 		            htmlspecialchars($author->getDisplayName()) . "</td></tr>\n";

    317. 

  317. 	}

    318. 

  318. 	

    319. 

  319. 	if ($printingOptions['req_spec_type']) {

    320. 

  320. 		$output .= '<tr><td width="' . $firstColWidth . '"><span class="label">' . 

    321. 

  321. 		           $labels['type'] . "</span></td>" .

    322. 

  322. 		           "<td>" . $reqSpecTypeLabels[$spec['type']] . "</td></tr>";

    323. 

  323. 	}

    324. 

  324. 	

    325. 

  325. 	if ($printingOptions['req_spec_overwritten_count_reqs']) {

    326. 

  326. 		$current = $req_spec_mgr->get_requirements_count($spec['id']);

    327. 

  327. 		$expected = $spec['total_req'];

    328. 

  328.     	$coverage = $labels['not_aplicable'] . " ($current/0)";

    329. 

  329.     	if ($expected) {

    330. 

  330.     		$percentage = round(100 / $expected * $current, 2);

    331. 

  331. 			$coverage = "{$percentage}% ({$current}/{$expected})";

    332. 

  332.     	}

    333. 

  333. 		

    334. 

  334. 		$output .= '<tr><td width="' . $firstColWidth . '"><span class="label">' . 

    335. 

  335. 		           $labels['overwritten_count'] . " (" . $labels['coverage'] . ")</span></td>" .

    336. 

  336. 		           "<td>" . $coverage . "</td></tr>";

    337. 

  337. 	}

    338. 

  338. 

    339. 

  339. 	if ($printingOptions['req_spec_scope']) {

    340. 

  340. 		$output .= "<tr><td colspan=\"$tableColspan\"><span class=\"label\">" . $labels['scope'] . 

    341. 

  341. 		           "</span><br/>" . $spec['scope'] . "</td></tr>";

    342. 

  342. 	}

    343. 

  343. 	

    344. 

  344. 	if ($printingOptions['req_spec_cf']) {

    345. 

  345. 		$linked_cf = $req_spec_mgr->get_linked_cfields($spec['id']);

    346. 

  346. 		if ($linked_cf){

    347. 

  347. 			foreach ($linked_cf as $key => $cf) {

    348. 

  348. 				$cflabel = htmlspecialchars($cf['label']);

    349. 

  349. 				$value = htmlspecialchars($cf['value']);

    350. 

  350. 				

    351. 

  351. 				$output .= "<tr><td width=\"$firstColWidth\"><span class=\"label\">" . 

    352. 

  352. 				           $cflabel . "</span></td>" .

    353. 

  353. 				           "<td>$value</td></tr>";

    354. 

  354. 			}

    355. 

  355. 		}

    356. 

  356. 	}

    357. 

  357. 	

    358. 

  358. 	$output .= "</table><br/>\n";

    359. 

  359. 	

    360. 

  360. 	return $output;

    361. 

  361. }

    362. 

  362. 

    363. 

  363. 

    364. 

  364. /**

    365. 

  365.  * render a complete tree, consisting of mixed requirement and req spec nodes, 

    366. 

  366.  * as HTML code for printing

    367. 

  367.  * 

    368. 

  368.  * @author Andreas Simon

    369. 

  369.  * 

    370. 

  370.  * @param resource $db

    371. 

  371.  * @param array $node the node to be printed

    372. 

  372.  * @param array $printingOptions

    373. 

  373.  * @param string $tocPrefix Prefix to be printed in TOC before title of each node

    374. 

  374.  * @param int $level

    375. 

  375.  * @param int $tprojectID

    376. 

  376.  * @param int $user_id ID of user which shall be printed as author of the document

    377. 

  377.  * 

    378. 

  378.  * @return string $output HTML Code

    379. 

  379.  */

    380. 

  380. function renderReqSpecTreeForPrinting(&$db, &$node, &$printingOptions,

    381. 

  381.                                        $tocPrefix, $rsCnt, $level, $user_id,

    382. 

  382.                                        $tplan_id = 0, $tprojectID = 0) {

    383. 

  383. 	

    384. 

  384. 	static $tree_mgr;

    385. 

  385. 	static $map_id_descr;

    386. 

  386. 	static $tplan_mgr;

    387. 

  387.  	$code = null;

    388. 

  388. 

    389. 

  389. 	if(!$tree_mgr)

    390. 

  390. 	{ 

    391. 

  391.  	    $tplan_mgr = new testplan($db);

    392. 

  392. 	    $tree_mgr = new tree($db);

    393. 

  393.  	    $map_id_descr = $tree_mgr->node_types;

    394. 

  394.  	}

    395. 

  395.  	$verbose_node_type = $map_id_descr[$node['node_type_id']];

    396. 

  396.  	

    397. 

  397.     switch($verbose_node_type)

    398. 

  398. 	{

    399. 

  399. 		case 'testproject':

    400. 

  400. 

    401. 

  401. 			break;

    402. 

  402. 

    403. 

  403. 		case 'requirement_spec':

    404. 

  404.             $tocPrefix .= (!is_null($tocPrefix) ? "." : '') . $rsCnt;

    405. 

  405.             $code .= renderReqSpecNodeForPrinting($db,$node,$printingOptions,

    406. 

  406.                                $tocPrefix, $level, $tprojectID);

    407. 

  407. 		break;

    408. 

  408. 

    409. 

  409. 		case 'requirement':

    410. 

  410. 			$tocPrefix .= (!is_null($tocPrefix) ? "." : '') . $rsCnt;

    411. 

  411. 			$code .= renderRequirementNodeForPrinting($db, $node, $printingOptions,

    412. 

  412. 			                              $tocPrefix, $level, $tprojectID);

    413. 

  413. 	    break;

    414. 

  414. 	}

    415. 

  415. 	

    416. 

  416. 	if (isset($node['childNodes']) && $node['childNodes'])

    417. 

  417. 	{

    418. 

  418. 	  

    419. 

  419. 		$childNodes = $node['childNodes'];

    420. 

  420. 		$rsCnt = 0;

    421. 

  421.    	    $children_qty = sizeof($childNodes);

    422. 

  422. 		for($i = 0;$i < $children_qty ;$i++)

    423. 

  423. 		{

    424. 

  424. 			$current = $childNodes[$i];

    425. 

  425. 			if(is_null($current))

    426. 

  426. 			{

    427. 

  427. 				continue;

    428. 

  428.             }

    429. 

  429.             

    430. 

  430. 			if (isset($current['node_type_id']) && 

    431. 

  431. 			    $map_id_descr[$current['node_type_id']] == 'requirement_spec')

    432. 

  432. 			{

    433. 

  433. 			    $rsCnt++;

    434. 

  434. 			}

    435. 

  435. 			

    436. 

  436. 			$code .= renderReqSpecTreeForPrinting($db, $current, $printingOptions,

    437. 

  437. 			                                       $tocPrefix, $rsCnt, $level+1, $user_id,

    438. 

  438. 			                                       $tplan_id, $tprojectID);

    439. 

  439. 		}

    440. 

  440. 	}

    441. 

  441. 	

    442. 

  442. 	if ($verbose_node_type == 'testproject')

    443. 

  443. 	{

    444. 

  444. 		if ($printingOptions['toc'])

    445. 

  445. 		{

    446. 

  446. 			$code = str_replace("{{INSERT_TOC}}",$printingOptions['tocCode'],$code);

    447. 

  447. 		}

    448. 

  448. 	}

    449. 

  449. 

    450. 

  450. 	return $code;

    451. 

  451. }

    452. 

  452. 

    453. 

  453. 

    454. 

  454. /**

    455. 

  455.  * render HTML header

    456. 

  456.  * Standard: HTML 4.01 trans (because is more flexible to bugs in user data)

    457. 

  457.  * 

    458. 

  458.  * @param string $title

    459. 

  459.  * @param string $base_href Base URL

    460. 

  460.  * 

    461. 

  461.  * @return string html data

    462. 

  462.  */

    463. 

  463. function renderHTMLHeader($title,$base_href)

    464. 

  464. {

    465. 

  465. 	// BUGID 3424

    466. 

  466. 	$themeDir = config_get('theme_dir');

    467. 

  467. 	$docCfg = config_get('document_generator');

    468. 

  468.     $cssFile = $base_href . $themeDir . $docCfg->css_template;

    469. 

  469. 

    470. 

  470. 	$output = "<!DOCTYPE HTML PUBLIC '-//W3C//DTD HTML 4.01 Transitional//EN'>\n";

    471. 

  471. 	$output .= "<html>\n<head>\n";

    472. 

  472. 	$output .= '<meta http-equiv="Content-Type" content="text/html; charset=' . config_get('charset') . '">';

    473. 

  473. 	$output .= '<title>' . htmlspecialchars($title). "</title>\n";

    474. 

  474. 	// $output .= '<link type="text/css" rel="stylesheet" href="'. $base_href . $docCfg->css_template ."\" />\n";

    475. 

  475. 	$output .= '<link type="text/css" rel="stylesheet" href="'. $cssFile ."\" />\n";

    476. 

  476. 	

    477. 

  477. 	// way to add CSS directly to the exported file (not used - test required)

    478. 

  478.     // $docCss = file_get_contents(TL_ABS_PATH . $docCfg->css_template);

    479. 

  479.     // $output .= '<style type="text/css" media="all">'."\n<!--\n".$docCss."\n-->\n</style>\n";

    480. 

  480. 	$output .= '<style type="text/css" media="print">.notprintable { display:none;}</style>';

    481. 

  481. 	$output .= "\n</head>\n";

    482. 

  482. 

    483. 

  483. 	return $output;

    484. 

  484. }

    485. 

  485. 

    486. 

  486. 

    487. 

  487. /**

    488. 

  488.  * Generate initial page of document

    489. 

  489.  * 

    490. 

  490.  * @param object $doc_info data with the next string values: 

    491. 

  491.  *                  title

    492. 

  492.  *                  type_name: what does this means ???

    493. 

  493.  *                  author, tproject_name, testplan_name  

    494. 

  494.  * @return string html

    495. 

  495.  * @author havlatm

    496. 

  496.  */

    497. 

  497. function renderFirstPage($doc_info)

    498. 

  498. {

    499. 

  499.     $docCfg = config_get('document_generator');

    500. 

  500.     $date_format_cfg = config_get('date_format');

    501. 

  501.   	$output = "<body>\n<div>\n";

    502. 

  502. 

    503. 

  503. 	// Print header

    504. 

  504. 	if ($docCfg->company_name != '' )

    505. 

  505. 	{

    506. 

  506. 		$output .= '<div style="float:right;">' . htmlspecialchars($docCfg->company_name) ."</div>\n";

    507. 

  507. 	}

    508. 

  508. 	$output .= '<div>'. $doc_info->tproject_name . "</div><hr />\n";

    509. 

  509.     

    510. 

  510. 	if ($docCfg->company_logo != '' )

    511. 

  511. 	{

    512. 

  512. 		$output .= '<p style="text-align: center;"><img alt="TestLink logo" ' .

    513. 

  513. 		           'title="configure using $tlCfg->company->logo_image"'.

    514. 

  514.         	     ' src="' . $_SESSION['basehref'] . TL_THEME_IMG_DIR . $docCfg->company_logo . '" /></p>';

    515. 

  515. 	}

    516. 

  516. 	$output .= "</div>\n";

    517. 

  517. 	$output .= '<div class="doc_title"><p>' . $doc_info->title . '</p>';

    518. 

  518. 	$output .= '<p>'.$doc_info->type_name.'</p>';

    519. 

  519. 	$output .= "</div>\n";

    520. 

  520.     

    521. 

  521. 	// Print summary on the first page

    522. 

  522. 	$output .= '<div class="summary">' .

    523. 

  523. 		         '<p id="prodname">'. lang_get('project') .": " . $doc_info->tproject_name . "</p>\n";

    524. 

  524.     

    525. 

  525. 	$output .= '<p id="author">' . lang_get('author').": " . $doc_info->author . "</p>\n" .

    526. 

  526. 		         '<p id="printedby">' . lang_get('printed_by_TestLink_on')." ".

    527. 

  527. 		         strftime($date_format_cfg, time()) . "</p></div>\n";

    528. 

  528.     

    529. 

  529. 	// Print legal notes

    530. 

  530. 	if ($docCfg->company_copyright != '')

    531. 

  531. 	{

    532. 

  532. 		$output .= '<div class="pagefooter" id="copyright">' . $docCfg->company_copyright."</div>\n";

    533. 

  533. 	}

    534. 

  534. 		           

    535. 

  535. 	if ($docCfg->confidential_msg != '')

    536. 

  536. 	{

    537. 

  537. 		$output .= '<div class="pagefooter" id="confidential">' .	$docCfg->confidential_msg . "</div>\n";

    538. 

  538. 	}

    539. 

  539. 	

    540. 

  540. 	return $output;

    541. 

  541. }

    542. 

  542. 

    543. 

  543. 

    544. 

  544. /**

    545. 

  545.  * Generate a chapter to a document

    546. 

  546.  * 

    547. 

  547.  * @param string $title

    548. 

  548.  * @param string $content

    549. 

  549.  * 

    550. 

  550.  * @return string html

    551. 

  551.  * @author havlatm

    552. 

  552.  */

    553. 

  553. function renderSimpleChapter($title, $content)

    554. 

  554. {

    555. 

  555. 	$output = '';

    556. 

  556. 	if ($content != "")

    557. 

  557. 	{

    558. 

  558. 		$output .= '<h1 class="doclevel">'.$title."</h1>\n";

    559. 

  559. 		$output .= '<div class="txtlevel">' .$content . "</div>\n <br/>";

    560. 

  560. 	}

    561. 

  561. 	return $output;

    562. 

  562. }

    563. 

  563. 

    564. 

  564. 

    565. 

  565. /*

    566. 

  566.   function: renderTestSpecTreeForPrinting

    567. 

  567.   args :

    568. 

  568.   returns:

    569. 

  569. 

    570. 

  570.   rev :

    571. 

  571.        20100723 - asimon - BUGID 3459 - $added platform_id

    572. 

  572.        20070509 - franciscom - added $tplan_id in order to refactor and

    573. 

  573.                                add contribution BUGID

    574. 

  574. */

    575. 

  575. function renderTestSpecTreeForPrinting(&$db,&$node,$item_type,&$printingOptions,

    576. 

  576.                                        $tocPrefix,$tcCnt,$level,$user_id,

    577. 

  577.                                        $tplan_id = 0,$tcPrefix = null,

    578. 

  578.                                        $tprojectID = 0, $platform_id = 0)

    579. 

  579. {

    580. 

  580. 	static $tree_mgr;

    581. 

  581. 	static $map_id_descr;

    582. 

  582. 	static $tplan_mgr;

    583. 

  583.  	$code = null;

    584. 

  584.  	

    585. 

  585. 	if(!$tree_mgr)

    586. 

  586. 	{ 

    587. 

  587.  	    $tplan_mgr = new testplan($db);

    588. 

  588. 	    $tree_mgr = new tree($db);

    589. 

  589.  	    $map_id_descr = $tree_mgr->node_types;

    590. 

  590.  	}

    591. 

  591.  	$verbose_node_type = $map_id_descr[intval($node['node_type_id'])];

    592. 

  592.     switch($verbose_node_type)

    593. 

  593. 	{

    594. 

  594. 		case 'testproject':

    595. 

  595. 		    if($tplan_id != 0)

    596. 

  596. 		    {

    597. 

  597. 		        // 20090330 - franciscom

    598. 

  598. 		        // we are printing a test plan, get it's custom fields

    599. 

  599.                 $cfieldFormatting=array('table_css_style' => 'class="cf"');

    600. 

  600.                 if ($printingOptions['cfields'])

    601. 

  601.         		{

    602. 

  602. 	            	$cfields = $tplan_mgr->html_table_of_custom_field_values($tplan_id,'design',null,$cfieldFormatting);

    603. 

  603. 	            	$code .= '<p>' . $cfields . '</p>';

    604. 

  604. 	       		}

    605. 

  605. 		    }

    606. 

  606. 			// platform changes - $code .= renderTOC($printingOptions);

    607. 

  607. 		break;

    608. 

  608. 

    609. 

  609. 		case 'testsuite':

    610. 

  610.             $tocPrefix .= (!is_null($tocPrefix) ? "." : '') . $tcCnt;

    611. 

  611.             $code .= renderTestSuiteNodeForPrinting($db,$node,$printingOptions,

    612. 

  612.                                                     $tocPrefix,$level,$tplan_id,$tprojectID);

    613. 

  613. 		break;

    614. 

  614. 

    615. 

  615. 		case 'testcase':

    616. 

  616. 			// 3459 - added $platform_id

    617. 

  617. 			$code .= renderTestCaseForPrinting($db, $node, $printingOptions, $level,

    618. 

  618. 			                                   $tplan_id, $tcPrefix, $tprojectID, $platform_id);

    619. 

  619. 	    break;

    620. 

  620. 	}

    621. 

  621. 	

    622. 

  622. 	if (isset($node['childNodes']) && $node['childNodes'])

    623. 

  623. 	{

    624. 

  624. 	  

    625. 

  625. 		$childNodes = $node['childNodes'];

    626. 

  626. 		$tsCnt = 0;

    627. 

  627.    	    $children_qty = sizeof($childNodes);

    628. 

  628. 		for($i = 0;$i < $children_qty ;$i++)

    629. 

  629. 		{

    630. 

  630. 			$current = $childNodes[$i];

    631. 

  631. 			if(is_null($current))

    632. 

  632. 			{

    633. 

  633. 				continue;

    634. 

  634.             }

    635. 

  635.             

    636. 

  636. 			if (isset($current['node_type_id']) && 

    637. 

  637. 			    $map_id_descr[$current['node_type_id']] == 'testsuite')

    638. 

  638. 			{

    639. 

  639. 			    $tsCnt++;

    640. 

  640. 			}

    641. 

  641. 			// 3459 - added $platform_id

    642. 

  642. 			$code .= renderTestSpecTreeForPrinting($db, $current, $item_type, $printingOptions,

    643. 

  643. 			                                       $tocPrefix, $tsCnt, $level+1, $user_id,

    644. 

  644. 			                                       $tplan_id, $tcPrefix, $tprojectID, $platform_id);

    645. 

  645. 		}

    646. 

  646. 	}

    647. 

  647. 	

    648. 

  648. 	if ($verbose_node_type == 'testproject')

    649. 

  649. 	{

    650. 

  650. 		if ($printingOptions['toc'])

    651. 

  651. 		{

    652. 

  652. 			// remove for platforms feature  

    653. 

  653. 			// $printingOptions['tocCode'] .= '</div><hr />';

    654. 

  654. 			$code = str_replace("{{INSERT_TOC}}",$printingOptions['tocCode'],$code);

    655. 

  655. 		}

    656. 

  656. 	}

    657. 

  657. 

    658. 

  658. 	return $code;

    659. 

  659. }

    660. 

  660. 

    661. 

  661. 

    662. 

  662. /**

    663. 

  663.  * get user name from pool (save used names in session to improve performance)

    664. 

  664.  * 

    665. 

  665.  * @param integer $db DB connection identifier 

    666. 

  666.  * @param integer $userId

    667. 

  667.  * 

    668. 

  668.  * @return string readable user name

    669. 

  669.  * @author havlatm

    670. 

  670.  */

    671. 

  671. function gendocGetUserName(&$db, $userId)

    672. 

  672. {

    673. 

  673. 	$authorName = null;

    674. 

  674. 	      

    675. 

  675. 	if(isset($_SESSION['userNamePool'][$userId]))

    676. 

  676. 	{

    677. 

  677. 		$authorName	= $_SESSION['userNamePool'][$userId];

    678. 

  678. 	}

    679. 

  679. 	else

    680. 

  680. 	{

    681. 

  681. 		$user = tlUser::getByID($db,$userId);

    682. 

  682. 		if ($user)

    683. 

  683. 		{

    684. 

  684. 			$authorName = $user->getDisplayName();

    685. 

  685. 			$authorName = htmlspecialchars($authorName);

    686. 

  686. 			$_SESSION['userNamePool'][$userId] = $authorName;

    687. 

  687. 		}

    688. 

  688. 		else

    689. 

  689. 		{

    690. 

  690. 			$authorName = lang_get('undefined');

    691. 

  691. 			tLog('tlUser::getByID($db,$userId) failed', 'ERROR');

    692. 

  692. 		}

    693. 

  693. 	}

    694. 

  694. 	

    695. 

  695. 	return $authorName;	

    696. 

  696. }

    697. 

  697. 

    698. 

  698. 

    699. 

  699. /**

    700. 

  700.  * render Test Case content for generated documents

    701. 

  701.  * 

    702. 

  702.  * @param $integer db DB connection identifier 

    703. 

  703.  * @return string generated html code

    704. 

  704.  * @internal 

    705. 

  705.  *      20100724 - asimon - BUGID 3459 - added platform ID

    706. 

  706.  *      20100723 - asimon - BUGID 3451 and related finally solved

    707. 

  707.  *      20090517 - havlatm - fixed execution layot; added tester name

    708. 

  708.  *      20080819 - franciscom - removed mysql only code

    709. 

  709.  *      20071014 - franciscom - display test case version

    710. 

  710.  *      20070509 - franciscom - added Contribution

    711. 

  711.  */

    712. 

  712. function renderTestCaseForPrinting(&$db, &$node, &$printingOptions, $level, $tplan_id = 0,

    713. 

  713.                                    $prefix = null, $tprojectID = 0, $platform_id = 0)

    714. 

  714. {

    715. 

  715.     static $req_mgr;

    716. 

  716. 	static $tc_mgr;

    717. 

  717. 	static $labels;

    718. 

  718. 	static $tcase_prefix;

    719. 

  719.     static $userMap = array();

    720. 

  720.     static $cfg;

    721. 

  721.     static $locationFilters;

    722. 

  722.     static $tables = null;

    723. 

  723.     

    724. 

  724.     if (!$tables)

    725. 

  725.     {

    726. 

  726.     	$tables = tlDBObject::getDBTables(array('executions','builds'));

    727. 

  727.     }

    728. 

  728.     

    729. 

  729. 	$code = null;

    730. 

  730. 	$tcInfo = null;

    731. 

  731.     $tcResultInfo = null;

    732. 

  732.     $tcase_pieces = null;

    733. 

  733. 	$cfieldFormatting = array('td_css_style' => '','add_table' => false);

    734. 

  734.     

    735. 

  735.     // init static elements

    736. 

  736.     $id = $node['id'];

    737. 

  737. 	if(!$cfg)

    738. 

  738. 	{

    739. 

  739.  	    $tc_mgr = new testcase($db);

    740. 

  740.  	    list($cfg,$labels) = initRenderTestCaseCfg($tc_mgr);

    741. 

  741. 	    if(!is_null($prefix))

    742. 

  742. 	    {

    743. 

  743. 	        $tcase_prefix = $prefix;

    744. 

  744. 	    }

    745. 

  745. 	    else

    746. 

  746. 	    {

    747. 

  747. 	    	list($tcase_prefix,$dummy) = $tc_mgr->getPrefix($id);

    748. 

  748. 	    }

    749. 

  749. 	    $tcase_prefix .= $cfg['testcase']->glue_character;

    750. 

  750. 	}

    751. 

  751. 	$versionID = isset($node['tcversion_id']) ? $node['tcversion_id'] : testcase::LATEST_VERSION;

    752. 

  752.     $tcInfo = $tc_mgr->get_by_id($id,$versionID);

    753. 

  753.     if ($tcInfo)

    754. 

  754.     {

    755. 

  755.     	$tcInfo = $tcInfo[0];

    756. 

  756.     }

    757. 

  757.     $external_id = $tcase_prefix . $tcInfo['tc_external_id'];

    758. 

  758. 	$name = htmlspecialchars($node['name']);

    759. 

  759. 

    760. 

  760. 	// ----- BUGID 3451 and related ---------------------------------------

    761. 

  761. 	// asimon: I finally found the real problem here:

    762. 

  762. 	// $versionID was used in the following "dirty" SQL statement, but was still set to "-1" 

    763. 

  763. 	//(the value to load all tc versions) instead of a real testcase version ID.

    764. 

  764. 	$versionID = $tcInfo['id'];

    765. 

  765. 	// This still does not change the fact that this marked SQL statement below

    766. 

  766. 	// should be removed and replaced by existing functions.

    767. 

  767. 	// ----- BUGID 3451 and related ---------------------------------------

    768. 

  768. 	

    769. 

  769.   	$cfields = array('specScope' => null, 'execScope' => null);

    770. 

  770. 

    771. 

  771.   	// get custom fields that has specification scope

    772. 

  772.   	if ($printingOptions['cfields'])

    773. 

  773. 	{

    774. 

  774. 		if (!$locationFilters)

    775. 

  775.         	$locationFilters = $tc_mgr->buildCFLocationMap();

    776. 

  776. 		// 20090719 - franciscom - cf location

    777. 

  777.      	foreach($locationFilters as $fkey => $fvalue)

    778. 

  778. 		{ 

    779. 

  779. 			$cfields['specScope'][$fkey] = 

    780. 

  780. 					$tc_mgr->html_table_of_custom_field_values($id,'design',$fvalue,null,$tplan_id,

    781. 

  781. 			                                               $tprojectID,$cfieldFormatting);

    782. 

  782. 		}	                                               

    783. 

  783. 	}

    784. 

  784. 

    785. 

  785. /** 

    786. 

  786.  * @TODO THIS IS NOT THE WAY TO DO THIS IS ABSOLUTELY WRONG AND MUST BE REFACTORED, 

    787. 

  787.  * using existent methods - franciscom - 20090329 

    788. 

  788.  * Need to get CF with execution scope

    789. 

  789.  */

    790. 

  790. 	$exec_info = null;

    791. 

  791. 	$bGetExecutions = false;

    792. 

  792. 	if ($printingOptions["docType"] != DOC_TEST_SPEC)

    793. 

  793. 		$bGetExecutions = ($printingOptions['cfields'] || $printingOptions['passfail']);

    794. 

  794. 	if ($bGetExecutions)

    795. 

  795. 	{

    796. 

  796. 		$sql =  " SELECT E.id AS execution_id, E.status, E.execution_ts, E.tester_id," .

    797. 

  797. 		        " E.notes, E.build_id, E.tcversion_id,E.tcversion_number,E.testplan_id," .

    798. 

  798. 		        " B.name AS build_name " .

    799. 

  799. 		        " FROM {$tables['executions']} E, {$tables['builds']} B" .

    800. 

  800. 		        " WHERE E.build_id= B.id " . 

    801. 

  801. 		        " AND E.tcversion_id = {$versionID} " .

    802. 

  802. 		        " AND E.testplan_id = {$tplan_id} " .

    803. 

  803. 		        " AND E.platform_id = {$platform_id} " .

    804. 

  804. 		  		" ORDER BY execution_id DESC";

    805. 

  805. 		$exec_info = $db->get_recordset($sql,null,1);

    806. 

  806. 	}

    807. 

  807. 	// Added condition for the display on/off of the custom fields on test cases.

    808. 

  808.     if ($printingOptions['cfields'] && !is_null($exec_info))

    809. 

  809.     {

    810. 

  810.     	$execution_id = $exec_info[0]['execution_id'];

    811. 

  811.         $cfields['execScope'] = $tc_mgr->html_table_of_custom_field_values($versionID,'execution',null,

    812. 

  812.                                                                            $execution_id, $tplan_id,

    813. 

  813.                                                                            $tprojectID,$cfieldFormatting);

    814. 

  814.     }

    815. 

  815. 	  

    816. 

  816. 	if ($printingOptions['toc'])

    817. 

  817. 	{

    818. 

  818. 		$printingOptions['tocCode'] .= '<p style="padding-left: ' . 

    819. 

  819. 	                                     (15*$level).'px;"><a href="#' . prefixToHTMLID('tc'.$id) . '">' .

    820. 

  820. 	       	                             $name . '</a></p>';

    821. 

  821. 		$code .= '<a name="' . prefixToHTMLID('tc'.$id) . '"></a>';

    822. 

  822. 	}

    823. 

  823.       

    824. 

  824.  	$code .= '<p>&nbsp;</p><div> <table class="tc" width="90%">';

    825. 

  825.  	$code .= '<tr><th colspan="' . $cfg['tableColspan'] . '">' . $labels['test_case'] . " " . 

    826. 

  826.  			htmlspecialchars($external_id) . ": " . $name;

    827. 

  827. 

    828. 

  828.     

    829. 

  829. 	// add test case version

    830. 

  830. 	if($cfg['doc']->tc_version_enabled && isset($node['version'])) 

    831. 

  831. 	{

    832. 

  832. 		$code .= '&nbsp;<span style="font-size: 80%;"' . $cfg['gui']->role_separator_open . 

    833. 

  833.         	   	$labels['version'] . $cfg['gui']->title_separator_1 .  $node['version'] . 

    834. 

  834.            		$cfg['gui']->role_separator_close . '</span>';

    835. 

  835.   	}

    836. 

  836.    	$code .= "</th></tr>\n";

    837. 

  837. 

    838. 

  838.   	if ($printingOptions['author'])

    839. 

  839.   	{

    840. 

  840. 		$authorName = gendocGetUserName($db, $tcInfo['author_id']);

    841. 

  841. 		$code .= '<tr><td width="' . $cfg['firstColWidth'] . '" valign="top">' . 

    842. 

  842. 		         '<span class="label">'.$labels['author'].':</span></td>';

    843. 

  843.         $code .= '<td colspan="' .  ($cfg['tableColspan']-1) . '">' . $authorName;

    844. 

  844. 

    845. 

  845. 

    846. 

  846. 		if (($tcInfo['updater_id'] > 0) && $tcInfo['updater_id'] != $tcInfo['author_id']) 

    847. 

  847. 		{

    848. 

  848. 		    // add updater if available and differs from author

    849. 

  849. 			$updaterName = gendocGetUserName($db, $tcInfo['updater_id']);

    850. 

  850. 			$code .= '<br />' . $labels['last_edit'] . " " . $updaterName;

    851. 

  851. 		}

    852. 

  852. 		$code .= "</td></tr>\n";

    853. 

  853.   	}

    854. 

  854. 

    855. 

  855.     if ($printingOptions['body'] || $printingOptions['summary'])

    856. 

  856.     {

    857. 

  857.         $tcase_pieces = array('summary');

    858. 

  858.     }

    859. 

  859.     

    860. 

  860.     if ($printingOptions['body'])

    861. 

  861.     {

    862. 

  862.         $tcase_pieces[] = 'preconditions';

    863. 

  863.         $tcase_pieces[] = 'steps';

    864. 

  864.         // $tcase_pieces[] = 'expected_results';        

    865. 

  865.     }

    866. 

  866.     

    867. 

  867.     if(!is_null($tcase_pieces))

    868. 

  868.     {

    869. 

  869.     	// Multiple Test Case Steps Feature

    870. 

  870.         foreach($tcase_pieces as $key)

    871. 

  871.         {

    872. 

  872.             // 20090719 - franciscom - cf location

    873. 

  873.             if( $key == 'steps' )

    874. 

  874.             {

    875. 

  875.             	if( isset($cfields['specScope']['before_steps_results']) )

    876. 

  876.             	{

    877. 

  877.         		 	$code .= $cfields['specScope']['before_steps_results'];    

    878. 

  878.                 }

    879. 

  879.                 if ($tcInfo[$key] != '')

    880. 

  880.                 {

    881. 

  881.             		$code .= '<tr>' .

    882. 

  882.             		         '<td><span class="label">' . $labels['step_number'] .':</span></td>' .

    883. 

  883.             		         '<td><span class="label">' . $labels['step_actions'] .':</span></td>' .

    884. 

  884.             		         '<td><span class="label">' . $labels['expected_results'] .':</span></td></tr>';

    885. 

  885.                 	

    886. 

  886.                 	$loop2do = count($tcInfo[$key]);

    887. 

  887.                 	for($ydx=0 ; $ydx < $loop2do; $ydx++)

    888. 

  888.                 	{

    889. 

  889.             			$code .= '<tr>' .

    890. 

  890.             			         '<td width="5">' .  $tcInfo[$key][$ydx]['step_number'] . '</td>' .

    891. 

  891.             			         '<td>' .  $tcInfo[$key][$ydx]['actions'] . '</td>' .

    892. 

  892.             			         '<td>' .  $tcInfo[$key][$ydx]['expected_results'] . '</td>' .

    893. 

  893.             				     '</tr>';

    894. 

  894.                 	}

    895. 

  895. 

    896. 

  896.                 }

    897. 

  897.                 

    898. 

  898.             }

    899. 

  899.         	else

    900. 

  900.         	{

    901. 

  901.         		// disable the field if it's empty

    902. 

  902.         		if ($tcInfo[$key] != '')

    903. 

  903.         		{

    904. 

  904.             		$code .= '<tr><td colspan="' .  $cfg['tableColspan'] . '"><span class="label">' . $labels[$key] .

    905. 

  905.             	         ':</span><br />' .  $tcInfo[$key] . "</td></tr>";

    906. 

  906.             	}

    907. 

  907.             }         

    908. 

  908.         }

    909. 

  909.     }

    910. 

  910.     // Spacer

    911. 

  911.     $code .= '<tr><td colspan="' .  $cfg['tableColspan'] . '">' . "</td></tr>";

    912. 

  912.     

    913. 

  913.     // 20090719 - franciscom - cf location

    914. 

  914.     $code .= $cfields['specScope']['standard_location'] . $cfields['execScope'];

    915. 

  915. 	

    916. 

  916. 	// generate test results data for test report 

    917. 

  917. 	if ($printingOptions['passfail'])

    918. 

  918. 	{

    919. 

  919. 		if ($exec_info) 

    920. 

  920. 		{

    921. 

  921. 			$code .= buildTestExecResults($db,$cfg,$labels,$exec_info);

    922. 

  922. 		}

    923. 

  923. 		else

    924. 

  924. 		{

    925. 

  925. 		  	$code .= '<tr><td width="' . $cfg['firstColWidth'] . '" valign="top">' . 

    926. 

  926. 		  			'<span class="label">' . $labels['last_exec_result'] . '</span></td>' . 

    927. 

  927. 		  			'<td colspan="' . ($cfg['tableColspan']-1) . '"><b>' . $labels["test_status_not_run"] . 

    928. 

  928. 		  			"</b></td></tr>\n";

    929. 

  929. 

    930. 

  930. 		}

    931. 

  931. 	}

    932. 

  932. 

    933. 

  933. 	// collect REQ for TC

    934. 

  934. 	// based on contribution by JMU (#1045)

    935. 

  935. 	if ($printingOptions['requirement'])

    936. 

  936. 	{

    937. 

  937. 	    if(!$req_mgr)

    938. 

  938. 	    {

    939. 

  939. 	        $req_mgr = new requirement_mgr($db);

    940. 

  940. 	  	}

    941. 

  941. 	  	$requirements = $req_mgr->get_all_for_tcase($id);

    942. 

  942. 	  	$code .= '<tr><td width="' . $cfg['firstColWidth'] . '" valign="top"><span class="label">'. 

    943. 

  943. 	  	         $labels['reqs'].'</span>'; 

    944. 

  944. 	  	$code .= '<td colspan="' . ($cfg['tableColspan']-1) . '">';

    945. 

  945. 

    946. 

  946. 	  	if (sizeof($requirements))

    947. 

  947. 	  	{

    948. 

  948. 	  		foreach ($requirements as $req)

    949. 

  949. 	  		{

    950. 

  950. 	  			$code .=  htmlspecialchars($req['req_doc_id'] . ":  " . $req['title']) . "<br />";

    951. 

  951. 	  		}

    952. 

  952. 	  	}

    953. 

  953. 	  	else

    954. 

  954. 	  	{

    955. 

  955. 	  		$code .= '&nbsp;' . $labels['none'] . '<br />';

    956. 

  956. 	  	}

    957. 

  957. 	  	$code .= "</td></tr>\n";

    958. 

  958. 	}

    959. 

  959. 	  

    960. 

  960. 	// collect keywords for TC

    961. 

  961. 	// based on contribution by JMU (#1045)

    962. 

  962. 	if ($printingOptions['keyword'])

    963. 

  963. 	{

    964. 

  964. 	  	$code .= '<tr><td width="' . $cfg['firstColWidth'] . '" valign="top"><span class="label">'. 

    965. 

  965. 	  	         $labels['keywords'].':</span>';

    966. 

  966.       	$code .= '<td colspan="' . ($cfg['tableColspan']-1) . '">';

    967. 

  967. 	  	$arrKeywords = $tc_mgr->getKeywords($id);

    968. 

  968. 	  	if (sizeof($arrKeywords))

    969. 

  969. 	  	{

    970. 

  970. 	  		foreach ($arrKeywords as $kw)

    971. 

  971. 	  		{

    972. 

  972. 	  			$code .= htmlspecialchars($kw['keyword']) . "<br />";

    973. 

  973. 	  		}

    974. 

  974. 	  	}

    975. 

  975. 	  	else

    976. 

  976. 	  	{

    977. 

  977. 	  		$code .= '&nbsp;' . $labels['none'] . '<br>';

    978. 

  978. 	  	}

    979. 

  979. 	  	$code .= "</td></tr>\n";

    980. 

  980. 	  }

    981. 

  981. 

    982. 

  982. 	  $code .= "</table>\n</div>\n";

    983. 

  983. 	  return $code;

    984. 

  984. }

    985. 

  985. 

    986. 

  986. 

    987. 

  987. /**

    988. 

  988.  * Remaining part of renderProjectNodeForPrinting

    989. 

  989.  * 

    990. 

  990.  * @todo havlatm: refactor

    991. 

  991.  */

    992. 

  992. function renderTOC(&$printingOptions)

    993. 

  993. {

    994. 

  994. 	$code = '';

    995. 

  995. 	$printingOptions['toc_numbers'][1] = 0;

    996. 

  996. 	if ($printingOptions['toc'])

    997. 

  997. 	{

    998. 

  998. 		$printingOptions['tocCode'] = '<h1 class="doclevel">' . lang_get('title_toc').'</h1><div class="toc">';

    999. 

  999. 		$code .= "{{INSERT_TOC}}";

    1000. 

  1000. 	}

    1001. 

  1001. 

    1002. 

  1002. 	return $code;

    1003. 

  1003. }

    1004. 

  1004. 

    1005. 

  1005. 

    1006. 

  1006. /*

    1007. 

  1007.   function: renderTestSuiteNodeForPrinting

    1008. 

  1008.   args :

    1009. 

  1009.   returns:

    1010. 

  1010.   

    1011. 

  1011.   rev: 20090329 - franciscom - added ALWAYS Custom Fields

    1012. 

  1012.        20081207 - franciscom - refactoring using static to decrease exec time.

    1013. 

  1013. */

    1014. 

  1014. function renderTestSuiteNodeForPrinting(&$db,&$node,&$printingOptions,$tocPrefix,$level,$tplan_id,$tproject_id)

    1015. 

  1015. {

    1016. 

  1016.     static $tsuite_mgr;

    1017. 

  1017.     $labels = array('test_suite' => lang_get('test_suite'),'details' => lang_get('details'));

    1018. 

  1018.   

    1019. 

  1019. 	$code = null;

    1020. 

  1020. 	$name = isset($node['name']) ? htmlspecialchars($node['name']) : '';

    1021. 

  1021. 	$title_separator = config_get('gui_title_separator_1');

    1022. 

  1022.   	$cfields = array('design' => '');

    1023. 

  1023.     $cfieldFormatting=array('table_css_style' => 'class="cf"');

    1024. 

  1024.     

    1025. 

  1025. 	$docHeadingNumbering = '';

    1026. 

  1026. 	if ($printingOptions['headerNumbering']) {

    1027. 

  1027. 		$docHeadingNumbering = "$tocPrefix. ";

    1028. 

  1028. 	}

    1029. 

  1029.     

    1030. 

  1030. 	if ($printingOptions['toc'])

    1031. 

  1031. 	{

    1032. 

  1032. 		$spacing = ($level == 2 && $tocPrefix != 1) ? "<br>" : "";

    1033. 

  1033. 	 	$printingOptions['tocCode'] .= $spacing.'<b><p style="padding-left: '.(10*$level).'px;">' .

    1034. 

  1034. 				'<a href="#' . prefixToHTMLID($tocPrefix) . '">' . $docHeadingNumbering . $name . "</a></p></b>\n";

    1035. 

  1035. 		$code .= "<a name='". prefixToHTMLID($tocPrefix) . "'></a>\n";

    1036. 

  1036. 	}

    1037. 

  1037. 	$docHeadingLevel = $level - 1; //we would like to have html top heading H1 - H6

    1038. 

  1038. 	$docHeadingLevel = ($docHeadingLevel > 6) ? 6 : $docHeadingLevel;

    1039. 

  1039.  	$code .= "<h{$docHeadingLevel} class='doclevel'>" . $docHeadingNumbering . $labels['test_suite'] .

    1040. 

  1040.  			$title_separator . $name . "</h{$docHeadingLevel}>\n";

    1041. 

  1041. 

    1042. 

  1042. 	// ----- get Test Suite text -----------------

    1043. 

  1043. 	if ($printingOptions['header'])

    1044. 

  1044.     {

    1045. 

  1045.         if( !$tsuite_mgr)

    1046. 

  1046.         { 

    1047. 

  1047. 		    $tsuite_mgr = new testsuite($db);

    1048. 

  1048. 		}

    1049. 

  1049. 		$tInfo = $tsuite_mgr->get_by_id($node['id']);

    1050. 

  1050. 		if ($tInfo['details'] != '')

    1051. 

  1051. 		{

    1052. 

  1052. 	   	    $code .= '<div>'.$tInfo['details']. '</div>';

    1053. 

  1053. 		}

    1054. 

  1054.    	

    1055. 

  1055.    	    // get Custom fields    

    1056. 

  1056.    	    // Attention: for test suites custom fields can not be edited during execution,

    1057. 

  1057.    	    //            then we need to get just custom fields with scope  'design'

    1058. 

  1058.         foreach($cfields as $key => $value)

    1059. 

  1059.         {

    1060. 

  1060.             $cfields[$key] = $tsuite_mgr->html_table_of_custom_field_values($node['id'],$key,null,

    1061. 

  1061. 	                                                                       $tproject_id,$cfieldFormatting);

    1062. 

  1062.    	        if($cfields[$key] != "")

    1063. 

  1063.    	        {

    1064. 

  1064.    	            $add_br = true;

    1065. 

  1065.    	            $code .= '<p>' . $cfields[$key] . '</p>';    

    1066. 

  1066.    	        }

    1067. 

  1067.    	    }

    1068. 

  1068.  	}

    1069. 

  1069. 

    1070. 

  1070. 	return $code;

    1071. 

  1071. }

    1072. 

  1072. 

    1073. 

  1073. 

    1074. 

  1074. 

    1075. 

  1075. /*

    1076. 

  1076.   function: renderTestPlanForPrinting

    1077. 

  1077.   args:

    1078. 

  1078.   returns:

    1079. 

  1079.   

    1080. 

  1080.   @internal revisions:

    1081. 

  1081.      20100723 - asimon - BUGID 3459: added $platform_id

    1082. 

  1082. */

    1083. 

  1083. function renderTestPlanForPrinting(&$db, &$node, $item_type, &$printingOptions, $tocPrefix,

    1084. 

  1084.                                    $tcCnt, $level, $user_id, $tplan_id, $tprojectID, $platform_id)

    1085. 

  1085. 

    1086. 

  1086. {

    1087. 

  1087. 	$tProjectMgr = new testproject($db);

    1088. 

  1088. 	$tcPrefix = $tProjectMgr->getTestCasePrefix($tprojectID);

    1089. 

  1089. 	$code =  renderTestSpecTreeForPrinting($db, $node, $item_type, $printingOptions,

    1090. 

  1090.                                            $tocPrefix, $tcCnt, $level, $user_id,

    1091. 

  1091.                                            $tplan_id, $tcPrefix, $tprojectID, $platform_id);

    1092. 

  1092. 	return $code;

    1093. 

  1093. }

    1094. 

  1094. 

    1095. 

  1095. 

    1096. 

  1096. /** 

    1097. 

  1097.  * Render HTML for estimated and real execute duration 

    1098. 

  1098.  * based on contribution (BUGID 1670)

    1099. 

  1099.  * 

    1100. 

  1100.  * @param array_of_strings $statistics

    1101. 

  1101.  * @return string HTML code

    1102. 

  1102.  */

    1103. 

  1103. function renderTestDuration($statistics)

    1104. 

  1104. {

    1105. 

  1105.     $output = '';

    1106. 

  1106. 	$estimated_string = '';

    1107. 

  1107. 	$real_string = '';

    1108. 

  1108. 	$bEstimatedTimeAvailable = isset($statistics['estimated_execution']);

    1109. 

  1109. 	$bRealTimeAvailable = isset($statistics['real_execution']);

    1110. 

  1110.     

    1111. 

  1111. 	if( $bEstimatedTimeAvailable || $bRealTimeAvailable)

    1112. 

  1112. 	{ 

    1113. 

  1113. 	    $output = "<div>\n";

    1114. 

  1114. 	    

    1115. 

  1115. 		if($bEstimatedTimeAvailable) 

    1116. 

  1116. 		{

    1117. 

  1117. 			$estimated_minutes = $statistics['estimated_execution']['minutes'];

    1118. 

  1118. 	    	$tcase_qty = $statistics['estimated_execution']['tcase_qty'];

    1119. 

  1119. 		         

    1120. 

  1120.     	   	if($estimated_minutes > 60)

    1121. 

  1121.     	   	{

    1122. 

  1122. 				$estimated_string = lang_get('estimated_time_hours') . round($estimated_minutes/60,2) ;

    1123. 

  1123. 			}

    1124. 

  1124. 			else

    1125. 

  1125. 			{

    1126. 

  1126. 				$estimated_string = lang_get('estimated_time_min') . $estimated_minutes;

    1127. 

  1127.             }

    1128. 

  1128. 			$estimated_string = sprintf($estimated_string,$tcase_qty);

    1129. 

  1129. 

    1130. 

  1130. 			$output .= '<p>' . $estimated_string . "</p>\n";

    1131. 

  1131. 		}

    1132. 

  1132. 		  

    1133. 

  1133. 		if($bRealTimeAvailable) 

    1134. 

  1134. 		{

    1135. 

  1135. 			$real_minutes = $statistics['real_execution']['minutes'];

    1136. 

  1136. 			$tcase_qty = $statistics['real_execution']['tcase_qty'];

    1137. 

  1137. 			if($real_minutes > 0)

    1138. 

  1138. 		    {

    1139. 

  1139. 	        	if($real_minutes > 60)

    1140. 

  1140. 	        	{

    1141. 

  1141. 		        	$real_string = lang_get('real_time_hours') . round($real_minutes/60,2) ;

    1142. 

  1142. 			    }

    1143. 

  1143. 			    else

    1144. 

  1144. 			    {

    1145. 

  1145. 			      	$real_string = lang_get('real_time_min') . $real_minutes;

    1146. 

  1146.                 } 

    1147. 

  1147. 				$real_string = sprintf($real_string,$tcase_qty);    

    1148. 

  1148. 			}

    1149. 

  1149. 			$output .= '<p>' . $real_string . "</p>\n";

    1150. 

  1150. 		}

    1151. 

  1151.     $output .= "</div>\n";

    1152. 

  1152. 	}

    1153. 

  1153. 

    1154. 

  1154. 	return $output;	

    1155. 

  1155. }

    1156. 

  1156. 

    1157. 

  1157. 

    1158. 

  1158. /** 

    1159. 

  1159.  * get final markup for HTML

    1160. 

  1160.  * 

    1161. 

  1161.  * @return string HTML 

    1162. 

  1162.  **/

    1163. 

  1163. function renderEOF()

    1164. 

  1164. {

    1165. 

  1165. 	return "\n</body>\n</html>";

    1166. 

  1166. }

    1167. 

  1167. 

    1168. 

  1168. 

    1169. 

  1169. /**

    1170. 

  1170.  * compose html text for metrics (meantime estimated time only)

    1171. 

  1171.  * 

    1172. 

  1172.  * @return string html

    1173. 

  1173.  */

    1174. 

  1174. function buildTestPlanMetrics($statistics)

    1175. 

  1175. {

    1176. 

  1176.     $output = '<h1 class="doclevel">'.lang_get('title_nav_results')."</h1>\n";

    1177. 

  1177.     $output .= renderTestDuration($statistics);

    1178. 

  1178.     

    1179. 

  1179. 	return $output;	

    1180. 

  1180. }

    1181. 

  1181. 

    1182. 

  1182. 

    1183. 

  1183. /**

    1184. 

  1184.  * utility function to allow easy reading of code

    1185. 

  1185.  * on renderTestCaseForPrinting()

    1186. 

  1186.  * 

    1187. 

  1187.  * @return map with configuration and labels

    1188. 

  1188.  */

    1189. 

  1189. 

    1190. 

  1190. function initRenderTestCaseCfg(&$tcaseMgr)

    1191. 

  1191. {

    1192. 

  1192. 	$config = null;

    1193. 

  1193. 	$config['firstColWidth'] = '20%';

    1194. 

  1194. 	$config['tableColspan'] = 3;

    1195. 

  1195. 	$config['doc'] = config_get('document_generator');

    1196. 

  1196. 	$config['gui'] = config_get('gui');

    1197. 

  1197. 	$config['testcase'] = config_get('testcase_cfg');

    1198. 

  1198. 	$config['results'] = config_get('results');

    1199. 

  1199.     

    1200. 

  1200.     foreach($config['results']['code_status'] as $key => $value)

    1201. 

  1201.     {

    1202. 

  1202.         $config['status_labels'][$key] = 

    1203. 

  1203.         	"check your \$tlCfg->results['status_label'] configuration ";

    1204. 

  1204.         if( isset($config['results']['status_label'][$value]) )

    1205. 

  1205.         {

    1206. 

  1206.             $config['status_labels'][$key] = lang_get($config['results']['status_label'][$value]);

    1207. 

  1207.         }    

    1208. 

  1208.     }

    1209. 

  1209. 

    1210. 

  1210.     // 20100306 - contribution by romans

    1211. 

  1211. 	// BUGID 0003235: Printing Out Test Report Shows empty Column Headers for "Steps" and "Step Actions"

    1212. 

  1212.     $labelsKeys=array('last_exec_result', 'testnotes', 'none', 'reqs','author', 'summary',

    1213. 

  1213.                       'steps', 'expected_results','build', 'test_case', 'keywords','version', 

    1214. 

  1214.                       'test_status_not_run', 'not_aplicable', 'bugs','tester','preconditions',

    1215. 

  1215.                       'step_number', 'step_actions', 'last_edit');

    1216. 

  1216.     $labelsQty=count($labelsKeys);         

    1217. 

  1217.     for($idx=0; $idx < $labelsQty; $idx++)

    1218. 

  1218.     {

    1219. 

  1219.         $labels[$labelsKeys[$idx]] = lang_get($labelsKeys[$idx]);

    1220. 

  1220.     }

    1221. 

  1221.     return array($config,$labels);

    1222. 

  1222. }

    1223. 

  1223. 

    1224. 

  1224. 

    1225. 

  1225. /**

    1226. 

  1226.  * 

    1227. 

  1227.  *

    1228. 

  1228.  */

    1229. 

  1229. function buildTestExecResults(&$dbHandler,$cfg,$labels,$exec_info)

    1230. 

  1230. {

    1231. 

  1231. 	$out='';

    1232. 

  1232. 	$testStatus = $cfg['status_labels'][$exec_info[0]['status']];

    1233. 

  1233. 	$testerName = gendocGetUserName($dbHandler, $exec_info[0]['tester_id']);

    1234. 

  1234. 	$executionNotes = $exec_info[0]['notes'];

    1235. 

  1235. 	    

    1236. 

  1236. 	$out .= '<tr><td width="20%" valign="top">' .

    1237. 

  1237. 			'<span class="label">' . $labels['last_exec_result'] . ':</span></td>' .

    1238. 

  1238. 			'<td><b>' . $testStatus . "</b></td></tr>\n" .

    1239. 

  1239.     		'<tr><td width="' . $cfg['firstColWidth'] . '" valign="top">' . $labels['build'] .'</td>' . 

    1240. 

  1240.     		'<td>' . htmlspecialchars($exec_info[0]['build_name']) . "</b></td></tr>\n" .

    1241. 

  1241.     		'<tr><td width="' . $cfg['firstColWidth'] . '" valign="top">' . $labels['tester'] .'</td>' . 

    1242. 

  1242.     		'<td>' . $testerName . "</b></td></tr>\n";

    1243. 

  1243. 

    1244. 

  1244.     if ($executionNotes != '') // show exection notes is not empty

    1245. 

  1245.     {

    1246. 

  1246. 		$out .= '<tr><td width="' . $cfg['firstColWidth'] . '" valign="top">'.$labels['testnotes'] . '</td>' .

    1247. 

  1247. 			    '<td>' . nl2br($executionNotes)  . "</td></tr>\n"; 

    1248. 

  1248.     }

    1249. 

  1249. 

    1250. 

  1250. 	$bug_interface = config_get('bugInterface');

    1251. 

  1251. 	if ($bug_interface != 'NO') 

    1252. 

  1252. 	{

    1253. 

  1253.     	// amitkhullar-BUGID 2207 - Code to Display linked bugs to a TC in Test Report

    1254. 

  1254. 		$bugs = get_bugs_for_exec($dbHandler,$bug_interface,$exec_info[0]['execution_id']);

    1255. 

  1255. 		if ($bugs) 

    1256. 

  1256. 		{

    1257. 

  1257. 			$bugString = '';

    1258. 

  1258. 			foreach($bugs as $bugID => $bugInfo) 

    1259. 

  1259. 			{

    1260. 

  1260. 				$bugString .= $bugInfo['link_to_bts']."<br />";

    1261. 

  1261. 			}

    1262. 

  1262. 			$out .= '<tr><td colspan="' .  $cfg['tableColspan'] . 

    1263. 

  1263. 			        '" width="' . $cfg['firstColWidth'] . '" valign="top">' . 

    1264. 

  1264. 			        $labels['bugs'] . '</td><td>' . $bugString ."</td></tr>\n"; 

    1265. 

  1265. 					

    1266. 

  1266. 		}

    1267. 

  1267. 	}

    1268. 

  1268. 	

    1269. 

  1269. 	return $out;

    1270. 

  1270. }

    1271. 

  1271. 

    1272. 

  1272. 

    1273. 

  1273. /**

    1274. 

  1274.  * Render HTML header for a given platform. 

    1275. 

  1275.  * Also adds code to $printingOptions['tocCode']

    1276. 

  1276.  */

    1277. 

  1277. function renderPlatformHeading($tocPrefix, $platform_id, $platform_name, &$printingOptions)

    1278. 

  1278. {

    1279. 

  1279. 	$platformLabel = lang_get('platform');

    1280. 

  1280. 	$platform_name = htmlspecialchars($platform_name);

    1281. 

  1281. 	$printingOptions['tocCode'] .= '<p><a href="#' . prefixToHTMLID($tocPrefix) . '">' .

    1282. 

  1282. 	                               $platformLabel . ':' . $platform_name . '</a></p>';

    1283. 

  1283. 	return '<h1 class="doclevel" id="' . prefixToHTMLID($tocPrefix) . "\">$tocPrefix $platformLabel: $platform_name</h1>";

    1284. 

  1284. }

    1285. 

  1285. 

    1286. 

  1286. 

    1287. 

  1287. /**

    1288. 

  1288.  * simple utility function, to avoid lot of copy and paste

    1289. 

  1289.  * given an string, return an string useful to jump to an anchor on document

    1290. 

  1290.  */

    1291. 

  1291. function prefixToHTMLID($string2convert,$anchor_prefix='toc_')

    1292. 

  1292. {

    1293. 

  1293. 	return $anchor_prefix . str_replace('.', '_', $string2convert);

    1294. 

  1294. }

    1295. 

  1295. 

    1296. 

  1296. ?>
    1297.