Packages

  • Nette
    • Application
      • Diagnostics
      • Responses
      • Routers
      • UI
    • Caching
      • Storages
    • ComponentModel
    • Config
      • Adapters
      • Extensions
    • Database
      • Diagnostics
      • Drivers
      • Reflection
      • Table
    • DI
      • Diagnostics
    • Diagnostics
    • Forms
      • Controls
      • Rendering
    • Http
    • Iterators
    • Latte
      • Macros
    • Loaders
    • Localization
    • Mail
    • Reflection
    • Security
      • Diagnostics
    • Templating
    • Utils
      • PhpGenerator
  • NetteModule
  • None
  • PHP

Classes

  • NAppForm
  • NControl
  • NMultiplier
  • NPresenter
  • NPresenterComponent

Interfaces

  • IRenderable
  • ISignalReceiver
  • IStatePersistent

Exceptions

  • NBadSignalException
  • NInvalidLinkException
  • Overview
  • Package
  • Class
  • Tree
  1: <?php
  2: 
  3: /**
  4:  * This file is part of the Nette Framework (http://nette.org)
  5:  *
  6:  * Copyright (c) 2004 David Grudl (http://davidgrudl.com)
  7:  *
  8:  * For the full copyright and license information, please view
  9:  * the file license.txt that was distributed with this source code.
 10:  * @package Nette\Application\UI
 11:  */
 12: 
 13: 
 14: 
 15: /**
 16:  * Control is renderable Presenter component.
 17:  *
 18:  * @author     David Grudl
 19:  *
 20:  * @property-read ITemplate $template
 21:  * @property-read string $snippetId
 22:  * @package Nette\Application\UI
 23:  */
 24: abstract class NControl extends NPresenterComponent implements IRenderable
 25: {
 26:     /** @var ITemplate */
 27:     private $template;
 28: 
 29:     /** @var array */
 30:     private $invalidSnippets = array();
 31: 
 32:     /** @var bool */
 33:     public $snippetMode;
 34: 
 35: 
 36: 
 37:     /********************* template factory ****************d*g**/
 38: 
 39: 
 40: 
 41:     /**
 42:      * @return ITemplate
 43:      */
 44:     final public function getTemplate()
 45:     {
 46:         if ($this->template === NULL) {
 47:             $value = $this->createTemplate();
 48:             if (!$value instanceof ITemplate && $value !== NULL) {
 49:                 $class2 = get_class($value); $class = get_class($this);
 50:                 throw new UnexpectedValueException("Object returned by $class::createTemplate() must be instance of ITemplate, '$class2' given.");
 51:             }
 52:             $this->template = $value;
 53:         }
 54:         return $this->template;
 55:     }
 56: 
 57: 
 58: 
 59:     /**
 60:      * @return ITemplate
 61:      */
 62:     protected function createTemplate($class = NULL)
 63:     {
 64:         $template = $class ? new $class : new NFileTemplate;
 65:         $presenter = $this->getPresenter(FALSE);
 66:         $template->onPrepareFilters[] = callback($this, 'templatePrepareFilters');
 67:         $template->registerHelperLoader('NTemplateHelpers::loader');
 68: 
 69:         // default parameters
 70:         $template->control = $template->_control = $this;
 71:         $template->presenter = $template->_presenter = $presenter;
 72:         if ($presenter instanceof NPresenter) {
 73:             $template->setCacheStorage($presenter->getContext()->nette->templateCacheStorage);
 74:             $template->user = $presenter->getUser();
 75:             $template->netteHttpResponse = $presenter->getHttpResponse();
 76:             $template->netteCacheStorage = $presenter->getContext()->getByType('ICacheStorage');
 77:             $template->baseUri = $template->baseUrl = rtrim($presenter->getHttpRequest()->getUrl()->getBaseUrl(), '/');
 78:             $template->basePath = preg_replace('#https?://[^/]+#A', '', $template->baseUrl);
 79: 
 80:             // flash message
 81:             if ($presenter->hasFlashSession()) {
 82:                 $id = $this->getParameterId('flash');
 83:                 $template->flashes = $presenter->getFlashSession()->$id;
 84:             }
 85:         }
 86:         if (!isset($template->flashes) || !is_array($template->flashes)) {
 87:             $template->flashes = array();
 88:         }
 89: 
 90:         return $template;
 91:     }
 92: 
 93: 
 94: 
 95:     /**
 96:      * Descendant can override this method to customize template compile-time filters.
 97:      * @param  NTemplate
 98:      * @return void
 99:      */
100:     public function templatePrepareFilters($template)
101:     {
102:         $template->registerFilter($this->getPresenter()->getContext()->nette->createLatte());
103:     }
104: 
105: 
106: 
107:     /**
108:      * Returns widget component specified by name.
109:      * @param  string
110:      * @return IComponent
111:      */
112:     public function getWidget($name)
113:     {
114:         trigger_error(__METHOD__ . '() is deprecated, use getComponent() instead.', E_USER_WARNING);
115:         return $this->getComponent($name);
116:     }
117: 
118: 
119: 
120:     /**
121:      * Saves the message to template, that can be displayed after redirect.
122:      * @param  string
123:      * @param  string
124:      * @return stdClass
125:      */
126:     public function flashMessage($message, $type = 'info')
127:     {
128:         $id = $this->getParameterId('flash');
129:         $messages = $this->getPresenter()->getFlashSession()->$id;
130:         $messages[] = $flash = (object) array(
131:             'message' => $message,
132:             'type' => $type,
133:         );
134:         $this->getTemplate()->flashes = $messages;
135:         $this->getPresenter()->getFlashSession()->$id = $messages;
136:         return $flash;
137:     }
138: 
139: 
140: 
141:     /********************* rendering ****************d*g**/
142: 
143: 
144: 
145:     /**
146:      * Forces control or its snippet to repaint.
147:      * @param  string
148:      * @return void
149:      */
150:     public function invalidateControl($snippet = NULL)
151:     {
152:         $this->invalidSnippets[$snippet] = TRUE;
153:     }
154: 
155: 
156: 
157:     /**
158:      * Allows control or its snippet to not repaint.
159:      * @param  string
160:      * @return void
161:      */
162:     public function validateControl($snippet = NULL)
163:     {
164:         if ($snippet === NULL) {
165:             $this->invalidSnippets = array();
166: 
167:         } else {
168:             unset($this->invalidSnippets[$snippet]);
169:         }
170:     }
171: 
172: 
173: 
174:     /**
175:      * Is required to repaint the control or its snippet?
176:      * @param  string  snippet name
177:      * @return bool
178:      */
179:     public function isControlInvalid($snippet = NULL)
180:     {
181:         if ($snippet === NULL) {
182:             if (count($this->invalidSnippets) > 0) {
183:                 return TRUE;
184: 
185:             } else {
186:                 $queue = array($this);
187:                 do {
188:                     foreach (array_shift($queue)->getComponents() as $component) {
189:                         if ($component instanceof IRenderable) {
190:                             if ($component->isControlInvalid()) {
191:                                 // $this->invalidSnippets['__child'] = TRUE; // as cache
192:                                 return TRUE;
193:                             }
194: 
195:                         } elseif ($component instanceof IComponentContainer) {
196:                             $queue[] = $component;
197:                         }
198:                     }
199:                 } while ($queue);
200: 
201:                 return FALSE;
202:             }
203: 
204:         } else {
205:             return isset($this->invalidSnippets[NULL]) || isset($this->invalidSnippets[$snippet]);
206:         }
207:     }
208: 
209: 
210: 
211:     /**
212:      * Returns snippet HTML ID.
213:      * @param  string  snippet name
214:      * @return string
215:      */
216:     public function getSnippetId($name = NULL)
217:     {
218:         // HTML 4 ID & NAME: [A-Za-z][A-Za-z0-9:_.-]*
219:         return 'snippet-' . $this->getUniqueId() . '-' . $name;
220:     }
221: 
222: }
223: 
Nette Framework 2.0.0 (for PHP 5.2, prefixed) API API documentation generated by ApiGen 2.7.0