webpage.class.inc.php 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482
  1. <?php
  2. // Copyright (C) 2010 Combodo SARL
  3. //
  4. // This program is free software; you can redistribute it and/or modify
  5. // it under the terms of the GNU General Public License as published by
  6. // the Free Software Foundation; version 3 of the License.
  7. //
  8. // This program is distributed in the hope that it will be useful,
  9. // but WITHOUT ANY WARRANTY; without even the implied warranty of
  10. // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  11. // GNU General Public License for more details.
  12. //
  13. // You should have received a copy of the GNU General Public License
  14. // along with this program; if not, write to the Free Software
  15. // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  16. /**
  17. * Class WebPage
  18. *
  19. * @author Erwan Taloc <erwan.taloc@combodo.com>
  20. * @author Romain Quetiez <romain.quetiez@combodo.com>
  21. * @author Denis Flaven <denis.flaven@combodo.com>
  22. * @license http://www.opensource.org/licenses/gpl-3.0.html LGPL
  23. */
  24. /**
  25. * Simple helper class to ease the production of HTML pages
  26. *
  27. * This class provide methods to add content, scripts, includes... to a web page
  28. * and renders the full web page by putting the elements in the proper place & order
  29. * when the output() method is called.
  30. * Usage:
  31. * $oPage = new WebPage("Title of my page");
  32. * $oPage->p("Hello World !");
  33. * $oPage->output();
  34. */
  35. class WebPage
  36. {
  37. protected $s_title;
  38. protected $s_content;
  39. protected $s_deferred_content;
  40. protected $a_scripts;
  41. protected $a_styles;
  42. protected $a_include_scripts;
  43. protected $a_include_stylesheets;
  44. protected $a_headers;
  45. protected $a_base;
  46. protected $iNextId;
  47. protected $iTransactionId;
  48. public function __construct($s_title)
  49. {
  50. $this->s_title = $s_title;
  51. $this->s_content = "";
  52. $this->s_deferred_content = '';
  53. $this->a_scripts = array();
  54. $this->a_styles = array();
  55. $this->a_linked_scripts = array();
  56. $this->a_linked_stylesheets = array();
  57. $this->a_headers = array();
  58. $this->a_base = array( 'href' => '', 'target' => '');
  59. $this->iNextId = 0;
  60. $this->iTransactionId = 0;
  61. ob_start(); // Start capturing the output
  62. }
  63. /**
  64. * Change the title of the page after its creation
  65. */
  66. public function set_title($s_title)
  67. {
  68. $this->s_title = $s_title;
  69. }
  70. /**
  71. * Specify a default URL and a default target for all links on a page
  72. */
  73. public function set_base($s_href = '', $s_target = '')
  74. {
  75. $this->a_base['href'] = $s_href;
  76. $this->a_base['target'] = $s_target;
  77. }
  78. /**
  79. * Add any text or HTML fragment to the body of the page
  80. */
  81. public function add($s_html)
  82. {
  83. $this->s_content .= $s_html;
  84. }
  85. /**
  86. * Add any text or HTML fragment at the end of the body of the page
  87. * This is useful to add hidden content, DIVs or FORMs that should not
  88. * be embedded into each other.
  89. */
  90. public function add_at_the_end($s_html)
  91. {
  92. $this->s_deferred_content .= $s_html;
  93. }
  94. /**
  95. * Add a paragraph to the body of the page
  96. */
  97. public function p($s_html)
  98. {
  99. $this->add($this->GetP($s_html));
  100. }
  101. /**
  102. * Add a pre-formatted text to the body of the page
  103. */
  104. public function pre($s_html)
  105. {
  106. $this->add('<pre>'.$s_html.'</pre>');
  107. }
  108. /**
  109. * Add a paragraph to the body of the page
  110. */
  111. public function GetP($s_html)
  112. {
  113. return "<p>$s_html</p>\n";
  114. }
  115. /**
  116. * Adds a tabular content to the web page
  117. * @param Hash $aConfig Configuration of the table: hash array of 'column_id' => 'Column Label'
  118. * @param Hash $aData Hash array. Data to display in the table: each row is made of 'column_id' => Data. A column 'pkey' is expected for each row
  119. * @param Hash $aParams Hash array. Extra parameters for the table.
  120. * @return void
  121. */
  122. public function table($aConfig, $aData, $aParams = array())
  123. {
  124. $this->add($this->GetTable($aConfig, $aData, $aParams));
  125. }
  126. public function GetTable($aConfig, $aData, $aParams = array())
  127. {
  128. $oAppContext = new ApplicationContext();
  129. static $iNbTables = 0;
  130. $iNbTables++;
  131. $sHtml = "";
  132. $sHtml .= "<table class=\"listResults\">\n";
  133. $sHtml .= "<thead>\n";
  134. $sHtml .= "<tr>\n";
  135. foreach($aConfig as $sName=>$aDef)
  136. {
  137. $sHtml .= "<th title=\"".$aDef['description']."\">".$aDef['label']."</th>\n";
  138. }
  139. $sHtml .= "</tr>\n";
  140. $sHtml .= "</thead>\n";
  141. $sHtml .= "<tbody>\n";
  142. foreach($aData as $aRow)
  143. {
  144. $sHtml .= $this->GetTableRow($aRow, $aConfig);
  145. }
  146. $sHtml .= "</tbody>\n";
  147. $sHtml .= "</table>\n";
  148. return $sHtml;
  149. }
  150. public function GetTableRow($aRow, $aConfig)
  151. {
  152. $sHtml = '';
  153. if (isset($aRow['@class'])) // Row specific class, for hilighting certain rows
  154. {
  155. $sHtml .= "<tr class=\"{$aRow['@class']}\">";
  156. }
  157. else
  158. {
  159. $sHtml .= "<tr>";
  160. }
  161. foreach($aConfig as $sName=>$aAttribs)
  162. {
  163. $sClass = isset($aAttribs['class']) ? 'class="'.$aAttribs['class'].'"' : '';
  164. $sValue = ($aRow[$sName] === '') ? '&nbsp;' : $aRow[$sName];
  165. $sHtml .= "<td $sClass>$sValue</td>";
  166. }
  167. $sHtml .= "</tr>";
  168. return $sHtml;
  169. }
  170. /**
  171. * Add some Javascript to the header of the page
  172. */
  173. public function add_script($s_script)
  174. {
  175. $this->a_scripts[] = $s_script;
  176. }
  177. /**
  178. * Add some Javascript to the header of the page
  179. */
  180. public function add_ready_script($s_script)
  181. {
  182. // Do nothing silently... this is not supported by this type of page...
  183. }
  184. /**
  185. * Add some CSS definitions to the header of the page
  186. */
  187. public function add_style($s_style)
  188. {
  189. $this->a_styles[] = $s_style;
  190. }
  191. /**
  192. * Add a script (as an include, i.e. link) to the header of the page
  193. */
  194. public function add_linked_script($s_linked_script)
  195. {
  196. $this->a_linked_scripts[$s_linked_script] = $s_linked_script;
  197. }
  198. /**
  199. * Add a CSS stylesheet (as an include, i.e. link) to the header of the page
  200. */
  201. public function add_linked_stylesheet($s_linked_stylesheet, $s_condition = "")
  202. {
  203. $this->a_linked_stylesheets[] = array( 'link' => $s_linked_stylesheet, 'condition' => $s_condition);
  204. }
  205. /**
  206. * Add some custom header to the page
  207. */
  208. public function add_header($s_header)
  209. {
  210. $this->a_headers[] = $s_header;
  211. }
  212. /**
  213. * Add needed headers to the page so that it will no be cached
  214. */
  215. public function no_cache()
  216. {
  217. $this->add_header("Cache-Control: no-cache, must-revalidate"); // HTTP/1.1
  218. $this->add_header("Expires: Fri, 17 Jul 1970 05:00:00 GMT"); // Date in the past
  219. }
  220. /**
  221. * Build a special kind of TABLE useful for displaying the details of an object from a hash array of data
  222. */
  223. public function details($aFields)
  224. {
  225. $this->add($this->GetDetails($aFields));
  226. }
  227. /**
  228. * Records the current state of the 'html' part of the page output
  229. * @return mixed The current state of the 'html' output
  230. */
  231. public function start_capture()
  232. {
  233. return strlen($this->s_content);
  234. }
  235. /**
  236. * Returns the part of the html output that occurred since the call to start_capture
  237. * and removes this part from the current html output
  238. * @param $offset mixed The value returned by start_capture
  239. * @return string The part of the html output that was added since the call to start_capture
  240. */
  241. public function end_capture($offset)
  242. {
  243. $sCaptured = substr($this->s_content, $offset);
  244. $this->s_content = substr($this->s_content, 0, $offset);
  245. return $sCaptured;
  246. }
  247. /**
  248. * Build a special kind of TABLE useful for displaying the details of an object from a hash array of data
  249. */
  250. public function GetDetails($aFields)
  251. {
  252. $sHtml = "<table class=\"details\">\n";
  253. $sHtml .= "<tbody>\n";
  254. foreach($aFields as $aAttrib)
  255. {
  256. $sHtml .= "<tr>\n";
  257. // By Rom, for csv import, proposed to show several values for column selection
  258. if (is_array($aAttrib['value']))
  259. {
  260. $sHtml .= "<td class=\"label\">".$aAttrib['label']."</td><td>".implode("</td><td>", $aAttrib['value'])."</td>\n";
  261. }
  262. else
  263. {
  264. $sHtml .= "<td class=\"label\">".$aAttrib['label']."</td><td>".$aAttrib['value']."</td>\n";
  265. }
  266. $sComment = (isset($aAttrib['comments'])) ? $aAttrib['comments'] : '&nbsp;';
  267. $sInfo = (isset($aAttrib['infos'])) ? $aAttrib['infos'] : '&nbsp;';
  268. $sHtml .= "<td>$sComment</td><td>$sInfo</td>\n";
  269. $sHtml .= "</tr>\n";
  270. }
  271. $sHtml .= "</tbody>\n";
  272. $sHtml .= "</table>\n";
  273. return $sHtml;
  274. }
  275. /**
  276. * Build a set of radio buttons suitable for editing a field/attribute of an object (including its validation)
  277. * @param $aAllowedValues hash Array of value => display_value
  278. * @param $value mixed Current value for the field/attribute
  279. * @param $iId mixed Unique Id for the input control in the page
  280. * @param $sFieldName string The name of the field, attr_<$sFieldName> will hold the value for the field
  281. * @param $bMandatory bool Whether or not the field is mandatory
  282. * @param $bVertical bool Disposition of the radio buttons vertical or horizontal
  283. * @param $sValidationField string HTML fragment holding the validation field (exclamation icon...)
  284. * @return string The HTML fragment corresponding to the radio buttons
  285. */
  286. public function GetRadioButtons($aAllowedValues, $value, $iId, $sFieldName, $bMandatory, $bVertical, $sValidationField)
  287. {
  288. $idx = 0;
  289. $sHTMLValue = '';
  290. foreach($aAllowedValues as $key => $display_value)
  291. {
  292. if ((count($aAllowedValues) == 1) && ($bMandatory == 'true') )
  293. {
  294. // When there is only once choice, select it by default
  295. $sSelected = ' checked';
  296. }
  297. else
  298. {
  299. $sSelected = ($value == $key) ? ' checked' : '';
  300. }
  301. $sHTMLValue .= "<input type=\"radio\" id=\"{$iId}_{$key}\" name=\"radio_$sFieldName\" onChange=\"$('#{$iId}').val(this.value).trigger('change');\" value=\"$key\"$sSelected><label class=\"radio\" for=\"{$iId}_{$key}\">&nbsp;$display_value</label>&nbsp;";
  302. if ($bVertical)
  303. {
  304. if ($idx == 0)
  305. {
  306. // Validation icon at the end of the first line
  307. $sHTMLValue .= "&nbsp;{$sValidationField}\n";
  308. }
  309. $sHTMLValue .= "<br>\n";
  310. }
  311. $idx++;
  312. }
  313. $sHTMLValue .= "<input type=\"hidden\" id=\"$iId\" name=\"$sFieldName\" value=\"$value\"/>";
  314. if (!$bVertical)
  315. {
  316. // Validation icon at the end of the line
  317. $sHTMLValue .= "&nbsp;{$sValidationField}\n";
  318. }
  319. return $sHTMLValue;
  320. }
  321. /**
  322. * Outputs (via some echo) the complete HTML page by assembling all its elements
  323. */
  324. public function output()
  325. {
  326. foreach($this->a_headers as $s_header)
  327. {
  328. header($s_header);
  329. }
  330. $s_captured_output = ob_get_contents();
  331. ob_end_clean();
  332. echo "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Strict//EN\" \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd\">\n";
  333. echo "<html>\n";
  334. echo "<head>\n";
  335. echo "<meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\" />\n";
  336. echo "<title>{$this->s_title}</title>\n";
  337. echo $this->get_base_tag();
  338. foreach($this->a_linked_scripts as $s_script)
  339. {
  340. // Make sure that the URL to the script contains the application's version number
  341. // so that the new script do NOT get reloaded from the cache when the application is upgraded
  342. if (strpos('?', $s_script) === false)
  343. {
  344. $s_script .= "?version=".ITOP_VERSION;
  345. }
  346. else
  347. {
  348. $s_script .= "&version=".ITOP_VERSION;
  349. }
  350. echo "<script type=\"text/javascript\" src=\"$s_script\"></script>\n";
  351. }
  352. if (count($this->a_scripts)>0)
  353. {
  354. echo "<script type=\"text/javascript\">\n";
  355. foreach($this->a_scripts as $s_script)
  356. {
  357. echo "$s_script\n";
  358. }
  359. echo "</script>\n";
  360. }
  361. foreach($this->a_linked_stylesheets as $a_stylesheet)
  362. {
  363. if ($a_stylesheet['condition'] != "")
  364. {
  365. echo "<!--[if {$a_stylesheet['condition']}]>\n";
  366. }
  367. echo "<link rel=\"stylesheet\" type=\"text/css\" href=\"{$a_stylesheet['link']}\" />\n";
  368. if ($a_stylesheet['condition'] != "")
  369. {
  370. echo "<![endif]-->\n";
  371. }
  372. }
  373. if (count($this->a_styles)>0)
  374. {
  375. echo "<style>\n";
  376. foreach($this->a_styles as $s_style)
  377. {
  378. echo "$s_style\n";
  379. }
  380. echo "</style>\n";
  381. }
  382. echo "</head>\n";
  383. echo "<body>\n";
  384. echo $this->s_content;
  385. if (trim($s_captured_output) != "")
  386. {
  387. echo "<div class=\"raw_output\">$s_captured_output</div>\n";
  388. }
  389. echo '<div id="at_the_end">'.$this->s_deferred_content.'</div>';
  390. echo "</body>\n";
  391. echo "</html>\n";
  392. }
  393. /**
  394. * Build a series of hidden field[s] from an array
  395. */
  396. // By Rom - je verrais bien une serie d'outils pour gerer des parametres que l'on retransmet entre pages d'un wizard...
  397. // ptet deriver webpage en webwizard
  398. public function add_input_hidden($sLabel, $aData)
  399. {
  400. foreach($aData as $sKey=>$sValue)
  401. {
  402. $this->add("<input type=\"hidden\" name=\"".$sLabel."[$sKey]\" value=\"$sValue\">");
  403. }
  404. }
  405. protected function get_base_tag()
  406. {
  407. $sTag = '';
  408. if (($this->a_base['href'] != '') || ($this->a_base['target'] != ''))
  409. {
  410. $sTag = '<base ';
  411. if (($this->a_base['href'] != ''))
  412. {
  413. $sTag .= "href =\"{$this->a_base['href']}\" ";
  414. }
  415. if (($this->a_base['target'] != ''))
  416. {
  417. $sTag .= "target =\"{$this->a_base['target']}\" ";
  418. }
  419. $sTag .= " />\n";
  420. }
  421. return $sTag;
  422. }
  423. /**
  424. * Get an ID (for any kind of HTML tag) that is guaranteed unique in this page
  425. * @return int The unique ID (in this page)
  426. */
  427. public function GetUniqueId()
  428. {
  429. return $this->iNextId++;
  430. }
  431. /**
  432. * Set the transactionId of the current form
  433. * @param $iTransactionId integer
  434. * @return void
  435. */
  436. public function SetTransactionId($iTransactionId)
  437. {
  438. $this->iTransactionId = $iTransactionId;
  439. }
  440. /**
  441. * Returns the transactionId of the current form
  442. * @return integer The current transactionID
  443. */
  444. public function GetTransactionId()
  445. {
  446. return $this->iTransactionId;
  447. }
  448. }
  449. ?>