Source for file SnippetHelper.php

Documentation is available at SnippetHelper.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\Templates
  11. 11:  */
  12. 12:  
  13. 13:  
  14. 14:  
  15. 15: /**
  16. 16:  * Control snippet template helper.
  17. 17:  *
  18. 18:  * @copyright  Copyright (c) 2004, 2010 David Grudl
  19. 19:  * @package    Nette\Templates
  20. 20:  */
  21. 21: class SnippetHelper extends Object
  22. 22: {
  23. 23:     /** @var bool */
  24. 24:     public static $outputAllowed TRUE;
  25. 25:  
  26. 26:     /** @var string */
  27. 27:     private $id;
  28. 28:  
  29. 29:     /** @var string */
  30. 30:     private $tag;
  31. 31:  
  32. 32:     /** @var ArrayObject */
  33. 33:     private $payload;
  34. 34:  
  35. 35:     /** @var int */
  36. 36:     private $level;
  37. 37:  
  38. 38:  
  39. 39:  
  40. 40:     /**
  41. 41:      * Starts conditional snippet rendering. Returns SnippetHelper object if snippet was started.
  42. 42:      * @param  Control control
  43. 43:      * @param  string  snippet name
  44. 44:      * @param  string  start element
  45. 45:      * @return SnippetHelper 
  46. 46:      */
  47. 47:     public static function create(Control $control$name NULL$tag 'div')
  48. 48:     {
  49. 49:         if (self::$outputAllowed// rendering flow or non-AJAX request
  50. 50:             $obj new self;
  51. 51:             $obj->tag trim($tag'<>');
  52. 52:             if ($obj->tagecho '<'$obj->tag' id="'$control->getSnippetId($name)'">';
  53. 53:             return $obj// or string?
  54. 54:  
  55. 55:         elseif ($control->isControlInvalid($name)) // start snippet buffering
  56. 56:             $obj new self;
  57. 57:             $obj->id $control->getSnippetId($name);
  58. 58:             $obj->payload $control->getPresenter()->getPayload();
  59. 59:             ob_start();
  60. 60:             $obj->level ob_get_level();
  61. 61:             self::$outputAllowed TRUE;
  62. 62:             return $obj;
  63. 63:  
  64. 64:         else {
  65. 65:             return FALSE;
  66. 66:         }
  67. 67:     }
  68. 68:  
  69. 69:  
  70. 70:  
  71. 71:     /**
  72. 72:      * Finishes and saves the snippet.
  73. 73:      * @return void 
  74. 74:      */
  75. 75:     public function finish()
  76. 76:     {
  77. 77:         if ($this->tag !== NULL// rendering flow or non-AJAX request
  78. 78:             if ($this->tagecho "</$this->tag>";
  79. 79:  
  80. 80:         else {  // finish snippet buffering
  81. 81:             if ($this->level !== ob_get_level()) {
  82. 82:                 throw new InvalidStateException("Snippet '$this->id' cannot be ended here.");
  83. 83:             }
  84. 84:             $this->payload->snippets[$this->idob_get_clean();
  85. 85:             self::$outputAllowed FALSE;
  86. 86:         }
  87. 87:     }
  88. 88:  
  89. 89: }