phpDocumentor page
[ class tree: page ] [ index: page ] [ all elements ]

Source for file Header.php

Documentation is available at Header.php

  1. <?
  2. /**
  3. * @package page
  4. * @filesource
  5. * @see HTML_PAGE_UTIL_PATH.'/Header.php'
  6. * @copyright (c) http://Finn-Rasmussen.com
  7. * @license http://Finn-Rasmussen.com/license/ myPHP License conditions
  8. * @author http://Finn-Rasmussen.com
  9. * @version 1.9
  10. * @since 21-oct-2005
  11. */
  12.  
  13. /**
  14. * The required files
  15. */
  16. require_once(HTML_PAGE_UTIL_PATH.'/Text.php');
  17.  
  18. /**
  19. * Generates a plain Header object, surronded by a html element
  20. * <code>
  21. * Usage:
  22. * $text = new Header($text,$type,$class);
  23. * print $text->getHtml();
  24. * Or
  25. * Header::display($text,$type,$class);
  26. * </code>
  27. * @package page
  28. */
  29.  
  30. class Header extends Text {
  31. /**
  32. * Constructor
  33. * @param String $text The text to show
  34. * @param String $type The Hx type x=1..6, default h1
  35. * @param String $class The css class name
  36. */
  37. function Header($text='',$type='',$class='') {
  38. $this->Text($text,$type!=''?$type:'h1',$class);
  39. }
  40.  
  41. /**
  42. * Display html
  43. * <code>
  44. * Usage:
  45. * Header::display($text,$type,$class);
  46. * </code>
  47. * @static
  48. * @param String $text The Header text
  49. * @param String $type The Hx type x=1..6, default h1
  50. * @param String $class The css class name
  51. */
  52. function display($text='',$type='',$class='') {
  53. $html = new Header($text,$type,$class);
  54. $html->addHtml();
  55. }
  56. }
  57. ?>

Documentation generated on Thu, 22 Dec 2005 17:09:07 +0100 by phpDocumentor 1.3.0RC3