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  Copyright (c) 2004, 2010 David Grudl
  7. 7:  * @license    http://nettephp.com/license  Nette license
  8. 8:  * @link       http://nettephp.com
  9. 9:  * @category   Nette
  10. 10:  * @package    Nette
  11. 11:  */
  12. 12:  
  13. 13:  
  14. 14:  
  15. 15: /**
  16. 16:  * Defines an object that has a modifiable state and a read-only (frozen) state.
  17. 17:  *
  18. 18:  * @copyright  Copyright (c) 2004, 2010 David Grudl
  19. 19:  * @package    Nette
  20. 20:  *
  21. 21:  * @property-read bool $frozen 
  22. 22:  */
  23. 23: abstract class FreezableObject extends Object
  24. 24: {
  25. 25:     /** @var bool */
  26. 26:     private $frozen FALSE;
  27. 27:  
  28. 28:  
  29. 29:  
  30. 30:     /**
  31. 31:      * Makes the object unmodifiable.
  32. 32:      * @return void 
  33. 33:      */
  34. 34:     public function freeze()
  35. 35:     {
  36. 36:         $this->frozen TRUE;
  37. 37:     }
  38. 38:  
  39. 39:  
  40. 40:  
  41. 41:     /**
  42. 42:      * Is the object unmodifiable?
  43. 43:      * @return bool 
  44. 44:      */
  45. 45:     final public function isFrozen()
  46. 46:     {
  47. 47:         return $this->frozen;
  48. 48:     }
  49. 49:  
  50. 50:  
  51. 51:  
  52. 52:     /**
  53. 53:      * Creates a modifiable clone of the object.
  54. 54:      * @return void 
  55. 55:      */
  56. 56:     public function __clone()
  57. 57:     {
  58. 58:         $this->frozen FALSE;
  59. 59:     }
  60. 60:  
  61. 61:  
  62. 62:  
  63. 63:     /**
  64. 64:      * @return void 
  65. 65:      */
  66. 66:     protected function updating()
  67. 67:     {
  68. 68:         if ($this->frozen{
  69. 69:             throw new InvalidStateException("Cannot modify a frozen object {$this->reflection->name}.");
  70. 70:         }
  71. 71:     }
  72. 72:  
  73. 73: }