Source for file WizardStep.class.php

Documentation is available at WizardStep.class.php

  1. <?php
  2. /**
  3. * @package polyphony.wizard
  4. *
  5. * @copyright Copyright &copy; 2005, Middlebury College
  6. * @license http://www.gnu.org/copyleft/gpl.html GNU General Public License (GPL)
  7. *
  8. * @version $Id: WizardStep.class.php,v 1.5 2007/09/19 14:04:51 adamfranco Exp $
  9. */
  10.  
  11. require_once(POLYPHONY."/main/library/Wizard/WizardComponentWithChildren.abstract.php");
  12.  
  13. /**
  14. * The Wizard class provides a system for registering Wizard properties and
  15. * associating those properties with the appropriate form elements.
  16. *
  17. * @package polyphony.wizard
  18. *
  19. * @copyright Copyright &copy; 2005, Middlebury College
  20. * @license http://www.gnu.org/copyleft/gpl.html GNU General Public License (GPL)
  21. *
  22. * @version $Id: WizardStep.class.php,v 1.5 2007/09/19 14:04:51 adamfranco Exp $
  23. * @author Gabe Schine
  24. */
  25. class WizardStep extends WizardComponentWithChildren {
  26. var $_displayName;
  27. var $_contentText;
  28. /**
  29. * Returns the displayName of this WizardStep
  30. * @return string
  31. */
  32. function getDisplayName () {
  33. return $this->_displayName;
  34. }
  35. /**
  36. * Sets the display name of this wizard step
  37. * @param string $displayName
  38. * @return void
  39. */
  40. function setDisplayName($displayName) {
  41. $this->_displayName = $displayName;
  42. }
  43.  
  44. /**
  45. * Sets this step's content text. This text will be parsed with {@link Wizard::parseText()}
  46. * @param string $content;
  47. * @access public
  48. * @return void
  49. */
  50. function setContent ($content) {
  51. $this->_contentText = $content;
  52. }
  53. /**
  54. * Answer the step's conent text. Useful for appending new properties to the
  55. * step
  56. *
  57. * @return string
  58. * @access public
  59. * @since 5/11/07
  60. */
  61. function getContent () {
  62. return $this->_contentText;
  63. }
  64. /**
  65. * Returns a block of XHTML-valid code that contains markup for this specific
  66. * component.
  67. * @param string $fieldName The field name to use when outputting form data or
  68. * similar parameters/information.
  69. * @access public
  70. * @return string
  71. */
  72. function getMarkup ($fieldName) {
  73. return Wizard::parseText($this->_contentText, $this->getChildren(), $fieldName."_");
  74. }
  75. }
  76.  
  77. ?>

Documentation generated on Wed, 19 Sep 2007 10:28:05 -0400 by phpDocumentor 1.3.0RC3