Source for file Control.php

Documentation is available at Control.php

1: <?php
2:
3: /**
4: * Nette Framework
5: *
6: * Copyright (c) 2004, 2009 David Grudl (http://davidgrudl.com)
7: *
8: * This source file is subject to the "Nette license" that is bundled
9: * with this package in the file license.txt.
10: *
11: * For more information please see https://nette.org
12: *
13: * @copyright Copyright (c) 2004, 2009 David Grudl
14: * @license https://nette.org/license Nette license
15: * @link https://nette.org
16: * @category Nette
17: * @package Nette\Application
18: * @version $Id$
19: */
20:
21:
22:
23: require_once dirname(__FILE__) . '/../Application/PresenterComponent.php';
24:
25: require_once dirname(__FILE__) . '/../Application/IRenderable.php';
26:
27:
28:
29: /**
30: * Control is renderable component.
31: *
32: * @author David Grudl
33: * @copyright Copyright (c) 2004, 2009 David Grudl
34: * @package Nette\Application
35: */
36: abstract class Control extends PresenterComponent implements IPartiallyRenderable
37: {
38: /** @var ITemplate */
39: private $template;
40:
41: /** @var array */
42: private $invalidSnippets = array();
43:
44:
45:
46: /********************* template factory ****************d*g**/
47:
48:
49:
50: /**
51: * @return ITemplate
52: */
53: final public function getTemplate()
54: {
55: if ($this->template === NULL) {
56: $value = $this->createTemplate();
57: if (!($value instanceof ITemplate || $value === NULL)) {
58: $class = get_class($value);
59: throw new UnexpectedValueException("Object returned by $this->class::createTemplate() must be instance of Nette\\Templates\\ITemplate, '$class' given.");
60: }
61: $this->template = $value;
62: }
63: return $this->template;
64: }
65:
66:
67:
68: /**
69: * @return ITemplate
70: */
71: protected function createTemplate()
72: {
73: $template = new Template;
74: $presenter = $this->getPresenter(FALSE);
75:
76: // default parameters
77: $template->component = $this; // DEPRECATED!
78: $template->control = $this;
79: $template->presenter = $presenter;
80: $template->baseUri = Environment::getVariable('baseUri');
81:
82: // flash message
83: if ($presenter !== NULL && $presenter->hasFlashSession()) {
84: $id = $this->getParamId('flash');
85: $template->flashes = $presenter->getFlashSession()->$id;
86: }
87: if (!isset($template->flashes) || !is_array($template->flashes)) {
88: $template->flashes = array();
89: }
90:
91: // default helpers
92: $template->registerHelper('escape', 'Nette\Templates\TemplateHelpers::escapeHtml');
93: $template->registerHelper('cache', 'Nette\Templates\CachingHelper::create');
94: $template->registerHelper('snippet', 'Nette\Templates\SnippetHelper::create');
95: $template->registerHelper('stripTags', 'strip_tags');
96: $template->registerHelper('nl2br', 'nl2br');
97: $template->registerHelperLoader('Nette\Templates\TemplateHelpers::loader');
98:
99: return $template;
100: }
101:
102:
103:
104: /**
105: * Saves the message to template, that can be displayed after redirect.
106: * @param string
107: * @param string
108: * @return stdClass
109: */
110: public function flashMessage($message, $type = 'info')
111: {
112: $id = $this->getParamId('flash');
113: $messages = $this->getPresenter()->getFlashSession()->$id;
114: $messages[] = $flash = (object) array(
115: 'message' => $message,
116: 'type' => $type,
117: );
118: $this->getTemplate()->flashes = $messages;
119: $this->getPresenter()->getFlashSession()->$id = $messages;
120: return $flash;
121: }
122:
123:
124:
125: /********************* rendering ****************d*g**/
126:
127:
128:
129: /**
130: * Forces control or its snippet to repaint.
131: * @param string
132: * @return void
133: */
134: public function invalidateControl($snippet = NULL)
135: {
136: $this->invalidSnippets[$snippet] = TRUE;
137: }
138:
139:
140:
141: /**
142: * Allows control or its snippet to not repaint.
143: * @param string
144: * @return void
145: */
146: public function validateControl($snippet = NULL)
147: {
148: if ($snippet === NULL) {
149: $this->invalidSnippets = array();
150:
151: } else {
152: unset($this->invalidSnippets[$snippet]);
153: }
154: }
155:
156:
157:
158: /**
159: * Is required to repaint the control or its snippet?
160: * @param string snippet name
161: * @return bool
162: */
163: public function isControlInvalid($snippet = NULL)
164: {
165: if ($snippet === NULL) {
166: if (count($this->invalidSnippets) > 0) {
167: return TRUE;
168:
169: } else {
170: foreach ($this->getComponents() as $component) {
171: if ($component instanceof IRenderable && $component->isControlInvalid()) {
172: // $this->invalidSnippets['__child'] = TRUE; // as cache
173: return TRUE;
174: }
175: }
176: return FALSE;
177: }
178:
179: } else {
180: return isset($this->invalidSnippets[NULL]) || isset($this->invalidSnippets[$snippet]);
181: }
182: }
183:
184:
185:
186: /**
187: * Returns snippet HTML ID.
188: * @param string snippet name
189: * @return string
190: */
191: public function getSnippetId($name = NULL)
192: {
193: // HTML 4 ID & NAME: [A-Za-z][A-Za-z0-9:_.-]*
194: return $this->getUniqueId() . '__' . $name;
195: }
196:
197: }

Source for file Control.php

Namespaces