Source for file HiddenField.php

Documentation is available at HiddenField.php

  1. 1: <?php
  2. 2:  
  3. 3: /**
  4. 4:  * Nette Framework
  5. 5:  *
  6. 6:  * Copyright (c) 2004, 2009 David Grudl (http://davidgrudl.com)
  7. 7:  *
  8. 8:  * This source file is subject to the "Nette license" that is bundled
  9. 9:  * with this package in the file license.txt.
  10. 10:  *
  11. 11:  * For more information please see http://nettephp.com
  12. 12:  *
  13. 13:  * @copyright  Copyright (c) 2004, 2009 David Grudl
  14. 14:  * @license    http://nettephp.com/license  Nette license
  15. 15:  * @link       http://nettephp.com
  16. 16:  * @category   Nette
  17. 17:  * @package    Nette\Forms
  18. 18:  */
  19. 19:  
  20. 20:  
  21. 21:  
  22. 22: require_once dirname(__FILE__'/../../Forms/Controls/FormControl.php';
  23. 23:  
  24. 24:  
  25. 25:  
  26. 26: /**
  27. 27:  * Hidden form control used to store a non-displayed value.
  28. 28:  *
  29. 29:  * @author     David Grudl
  30. 30:  * @copyright  Copyright (c) 2004, 2009 David Grudl
  31. 31:  * @package    Nette\Forms
  32. 32:  */
  33. 33: class HiddenField extends FormControl
  34. 34: {
  35. 35:     /** @var string */
  36. 36:     private $forcedValue;
  37. 37:  
  38. 38:  
  39. 39:  
  40. 40:     public function __construct($forcedValue NULL)
  41. 41:     {
  42. 42:         parent::__construct();
  43. 43:         $this->control->type 'hidden';
  44. 44:         $this->value = (string) $forcedValue;
  45. 45:         $this->forcedValue $forcedValue;
  46. 46:     }
  47. 47:  
  48. 48:  
  49. 49:  
  50. 50:     /**
  51. 51:      * Bypasses label generation.
  52. 52:      * @return void 
  53. 53:      */
  54. 54:     public function getLabel($caption NULL)
  55. 55:     {
  56. 56:         return NULL;
  57. 57:     }
  58. 58:  
  59. 59:  
  60. 60:  
  61. 61:     /**
  62. 62:      * Sets control's value.
  63. 63:      * @param  string 
  64. 64:      * @return HiddenField  provides a fluent interface
  65. 65:      */
  66. 66:     public function setValue($value)
  67. 67:     {
  68. 68:         $this->value = is_scalar($value? (string) $value '';
  69. 69:         return $this;
  70. 70:     }
  71. 71:  
  72. 72:  
  73. 73:  
  74. 74:     /**
  75. 75:      * Generates control's HTML element.
  76. 76:      * @return Html 
  77. 77:      */
  78. 78:     public function getControl()
  79. 79:     {
  80. 80:         return parent::getControl()->value($this->forcedValue === NULL $this->value : $this->forcedValue);
  81. 81:     }
  82. 82:  
  83. 83: }