Source for file FreezableObject.php

Documentation is available at FreezableObject.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
  18. 18:  */
  19. 19:  
  20. 20:  
  21. 21:  
  22. 22: require_once dirname(__FILE__'/Object.php';
  23. 23:  
  24. 24:  
  25. 25:  
  26. 26: /**
  27. 27:  * Defines an object that has a modifiable state and a read-only (frozen) state.
  28. 28:  *
  29. 29:  * @author     David Grudl
  30. 30:  * @copyright  Copyright (c) 2004, 2009 David Grudl
  31. 31:  * @package    Nette
  32. 32:  *
  33. 33:  * @property-read bool $frozen 
  34. 34:  */
  35. 35: abstract class FreezableObject extends Object
  36. 36: {
  37. 37:     /** @var bool */
  38. 38:     private $frozen FALSE;
  39. 39:  
  40. 40:  
  41. 41:  
  42. 42:     /**
  43. 43:      * Makes the object unmodifiable.
  44. 44:      * @return void 
  45. 45:      */
  46. 46:     public function freeze()
  47. 47:     {
  48. 48:         $this->frozen TRUE;
  49. 49:     }
  50. 50:  
  51. 51:  
  52. 52:  
  53. 53:     /**
  54. 54:      * Is the object unmodifiable?
  55. 55:      * @return bool 
  56. 56:      */
  57. 57:     final public function isFrozen()
  58. 58:     {
  59. 59:         return $this->frozen;
  60. 60:     }
  61. 61:  
  62. 62:  
  63. 63:  
  64. 64:     /**
  65. 65:      * Creates a modifiable clone of the object.
  66. 66:      * @return void 
  67. 67:      */
  68. 68:     public function __clone()
  69. 69:     {
  70. 70:         $this->frozen FALSE;
  71. 71:     }
  72. 72:  
  73. 73:  
  74. 74:  
  75. 75:     /**
  76. 76:      * @return void 
  77. 77:      */
  78. 78:     protected function updating()
  79. 79:     {
  80. 80:         if ($this->frozen{
  81. 81:             throw new InvalidStateException("Cannot modify a frozen object '$this->class'.");
  82. 82:         }
  83. 83:     }
  84. 84:  
  85. 85: }