Source for file PresenterComponent.php

Documentation is available at PresenterComponent.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__) . '/../ComponentContainer.php';
24:
25: require_once dirname(__FILE__) . '/../Application/ISignalReceiver.php';
26:
27: require_once dirname(__FILE__) . '/../Application/IStatePersistent.php';
28:
29:
30:
31: /**
32: * PresenterComponent is the base class for all presenters components.
33: *
34: * Components are persistent objects located on a presenter. They have ability to own
35: * other child components, and interact with user. Components have properties
36: * for storing their status, and responds to user command.
37: *
38: * @author David Grudl
39: * @copyright Copyright (c) 2004, 2009 David Grudl
40: * @package Nette\Application
41: */
42: abstract class PresenterComponent extends ComponentContainer implements ISignalReceiver, IStatePersistent
43: {
44: /** @var array */
45: protected $params = array();
46:
47:
48:
49: /**
50: */
51: public function __construct(IComponentContainer $parent = NULL, $name = NULL)
52: {
53: $this->monitor('Nette\Application\Presenter');
54: parent::__construct($parent, $name);
55: }
56:
57:
58:
59: /**
60: * Returns the presenter where this component belongs to.
61: * @param bool throw exception if presenter doesn't exist?
62: * @return Presenter|NULL
63: */
64: public function getPresenter($need = TRUE)
65: {
66: return $this->lookup('Nette\Application\Presenter', $need);
67: }
68:
69:
70:
71: /**
72: * Returns a fully-qualified name that uniquely identifies the component
73: * within the presenter hierarchy.
74: * @return string
75: */
76: public function getUniqueId()
77: {
78: return $this->lookupPath('Nette\Application\Presenter', TRUE);
79: }
80:
81:
82:
83: /**
84: * This method will be called when the component (or component's parent)
85: * becomes attached to a monitored object. Do not call this method yourself.
86: * @param IComponent
87: * @return void
88: */
89: protected function attached($presenter)
90: {
91: if ($presenter instanceof Presenter) {
92: $this->loadState($presenter->popGlobalParams($this->getUniqueId()));
93: }
94: }
95:
96:
97:
98: /**
99: * Calls public method if exists.
100: * @param string
101: * @param array
102: * @return bool does method exist?
103: */
104: protected function tryCall($method, array $params)
105: {
106: $class = $this->getClass();
107: if (PresenterHelpers::isMethodCallable($class, $method)) {
108: $args = PresenterHelpers::paramsToArgs($class, $method, $params);
109: call_user_func_array(array($this, $method), $args);
110: return TRUE;
111: }
112: return FALSE;
113: }
114:
115:
116:
117: /********************* interface IStatePersistent ****************d*g**/
118:
119:
120:
121: /**
122: * Loads state informations.
123: * @param array
124: * @return void
125: */
126: public function loadState(array $params)
127: {
128: foreach (PresenterHelpers::getPersistentParams($this->getClass()) as $nm => $meta)
129: {
130: if (isset($params[$nm])) { // ignore NULL values
131: if (isset($meta['def'])) {
132: settype($params[$nm], gettype($meta['def']));
133: }
134: $this->$nm = & $params[$nm];
135: }
136: }
137: $this->params = $params;
138: }
139:
140:
141:
142: /**
143: * Saves state informations for next request.
144: * @param array
145: * @param portion specified by class name (used by Presenter)
146: * @return void
147: */
148: public function saveState(array & $params, $forClass = NULL)
149: {
150: foreach (PresenterHelpers::getPersistentParams($forClass === NULL ? $this->getClass() : $forClass) as $nm => $meta)
151: {
152: if (isset($params[$nm])) {
153: $val = $params[$nm]; // injected value
154:
155: } elseif (array_key_exists($nm, $params)) { // $params[$nm] === NULL
156: continue; // means skip
157:
158: } elseif (!isset($meta['since']) || $this instanceof $meta['since']) {
159: $val = $this->$nm; // object property value
160:
161: } else {
162: continue; // ignored parameter
163: }
164:
165: if (is_object($val)) {
166: throw new InvalidStateException("Persistent parameter must be scalar or array, '$this->class::\$$nm' is " . gettype($val));
167:
168: } else {
169: if (isset($meta['def'])) {
170: settype($val, gettype($meta['def']));
171: if ($val === $meta['def']) $val = NULL;
172: } else {
173: if ((string) $val === '') $val = NULL;
174: }
175: $params[$nm] = $val;
176: }
177: }
178: }
179:
180:
181:
182: /**
183: * Returns component param.
184: * If no key is passed, returns the entire array.
185: * @param string key
186: * @param mixed default value
187: * @return mixed
188: */
189: final public function getParam($name = NULL, $default = NULL)
190: {
191: if (func_num_args() === 0) {
192: return $this->params;
193:
194: } elseif (isset($this->params[$name])) {
195: return $this->params[$name];
196:
197: } else {
198: return $default;
199: }
200: }
201:
202:
203:
204: /**
205: * Returns a fully-qualified name that uniquely identifies the parameter.
206: * @return string
207: */
208: final public function getParamId($name)
209: {
210: $uid = $this->getUniqueId();
211: return $uid === '' ? $name : $uid . self::NAME_SEPARATOR . $name;
212: }
213:
214:
215:
216: /**
217: * Returns array of classes persistent parameters. They have public visibility and are non-static.
218: * This default implementation detects persistent parameters by annotation @persistent.
219: * @return array
220: */
221: public static function getPersistentParams()
222: {
223: $rc = new ReflectionClass(func_get_arg(0));
224: $params = array();
225: foreach ($rc->getProperties() as $rp) {
226: if ($rp->isPublic() && !$rp->isStatic() && Annotations::get($rp, 'persistent')) {
227: $params[] = $rp->getName();
228: }
229: }
230: return $params;
231: }
232:
233:
234:
235: /********************* interface ISignalReceiver ****************d*g**/
236:
237:
238:
239: /**
240: * Calls signal handler method.
241: * @param string
242: * @return void
243: * @throws BadSignalException if there is not handler method
244: */
245: public function signalReceived($signal)
246: {
247: if (!$this->tryCall($this->formatSignalMethod($signal), $this->params)) {
248: throw new BadSignalException("There is no handler for signal '$signal' in '{$this->getClass()}' class.");
249: }
250: }
251:
252:
253:
254: /**
255: * Formats signal handler method name -> case sensitivity doesn't matter.
256: * @param string
257: * @return string
258: */
259: public function formatSignalMethod($signal)
260: {
261: return $signal == NULL ? NULL : 'handle' . $signal; // intentionally ==
262: }
263:
264:
265:
266: /********************* navigation ****************d*g**/
267:
268:
269:
270: /**
271: * Generates URL to presenter, action or signal.
272: * @param string destination in format "[[module:]presenter:]action" or "signal!"
273: * @param array|mixed
274: * @return string
275: * @throws InvalidLinkException
276: */
277: public function link($destination, $args = array())
278: {
279: if (!is_array($args)) {
280: $args = func_get_args();
281: array_shift($args);
282: }
283:
284: try {
285: return $this->getPresenter()->createRequest($this, $destination, $args, 'link');
286:
287: } catch (InvalidLinkException $e) {
288: return $this->getPresenter()->handleInvalidLink($e);
289: }
290: }
291:
292:
293:
294: public function lazyLink($destination, $args = array())
295: {
296: if (!is_array($args)) {
297: $args = func_get_args();
298: array_shift($args);
299: }
300:
301: return new Link($this, $destination, $args);
302: }
303:
304:
305:
306: public function ajaxLink($destination, $args = array())
307: {
308: return $this->getPresenter()->getAjaxDriver()->link($destination === NULL ? NULL : $this->link($destination, $args));
309: }
310:
311:
312:
313: /**
314: * Redirect to another presenter, action or signal.
315: * @param int [optional] HTTP error code
316: * @param string destination in format "[[module:]presenter:]view" or "signal!"
317: * @param array|mixed
318: * @return void
319: * @throws RedirectingException
320: */
321: public function redirect($code, $destination = NULL, $args = array())
322: {
323: if (!is_numeric($code)) { // first parameter is optional
324: $args = $destination;
325: $destination = $code;
326: $code = IHttpResponse::S303_POST_GET;
327: }
328:
329: if (!is_array($args)) {
330: $args = func_get_args();
331: if (is_numeric(array_shift($args))) array_shift($args);
332: }
333:
334: $presenter = $this->getPresenter();
335: $presenter->redirectUri($presenter->createRequest($this, $destination, $args, 'redirect'), $code);
336: }
337:
338: }

Source for file PresenterComponent.php

Namespaces