Source for file Presenter.php

Documentation is available at Presenter.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/Control.php';
24:
25: require_once dirname(__FILE__) . '/../Application/IPresenter.php';
26:
27:
28:
29: /**
30: * Presenter object represents a webpage instance. It executes all the logic for the request.
31: *
32: * @author David Grudl
33: * @copyright Copyright (c) 2004, 2009 David Grudl
34: * @package Nette\Application
35: */
36: abstract class Presenter extends Control implements IPresenter
37: {
38: /**#@+ life cycle phases {@link Presenter::getPhase()} */
39: const PHASE_STARTUP = 1;
40: const PHASE_PREPARE = 2;
41: const PHASE_SIGNAL = 3;
42: const PHASE_RENDER = 4;
43: const PHASE_SHUTDOWN = 5;
44: /**#@-*/
45:
46: /**#@+ bad link handling {@link Presenter::$invalidLinkMode} */
47: const INVALID_LINK_SILENT = 1;
48: const INVALID_LINK_WARNING = 2;
49: const INVALID_LINK_EXCEPTION = 3;
50: /**#@-*/
51:
52: /**#@+ special parameter key */
53: const SIGNAL_KEY = 'do';
54: const ACTION_KEY = 'action';
55: const FLASH_KEY = '_fid';
56: /**#@-*/
57:
58: /** @var string */
59: public static $defaultAction = 'default';
60:
61: /** @var int */
62: public static $invalidLinkMode;
63:
64: /** @var array of event handlers; Occurs when the presenter is shutting down; function(Presenter $sender, Exception $exception = NULL) */
65: public $onShutdown;
66:
67: /** @var bool (experimental) */
68: public $oldLayoutMode = TRUE;
69:
70: /** @var PresenterRequest */
71: private $request;
72:
73: /** @var int */
74: private $phase;
75:
76: /** @var bool automatically call canonicalize() */
77: public $autoCanonicalize = TRUE;
78:
79: /** @var bool use absolute Urls or paths? */
80: public $absoluteUrls = FALSE;
81:
82: /** @var array */
83: private $globalParams;
84:
85: /** @var array */
86: private $globalState;
87:
88: /** @var array */
89: private $globalStateSinces;
90:
91: /** @var string */
92: private $action;
93:
94: /** @var string */
95: private $view;
96:
97: /** @var string */
98: private $layout = 'layout';
99:
100: /** @var IAjaxDriver */
101: private $ajaxDriver;
102:
103: /** @var string */
104: private $signalReceiver;
105:
106: /** @var string */
107: private $signal;
108:
109: /** @var bool */
110: private $ajaxMode;
111:
112: /** @var PresenterRequest */
113: private $lastCreatedRequest;
114:
115: /** @var array */
116: private $lastCreatedRequestFlag;
117:
118:
119:
120: /**
121: * @param PresenterRequest
122: */
123: public function __construct(PresenterRequest $request)
124: {
125: $this->request = $request;
126: parent::__construct(NULL, $request->getPresenterName());
127: }
128:
129:
130:
131: /**
132: * @param bool
133: * @return PresenterRequest
134: */
135: final public function getRequest($clone = TRUE)
136: {
137: return $clone ? clone $this->request : $this->request;
138: }
139:
140:
141:
142: /**
143: * Returns self.
144: * @return Presenter
145: */
146: final public function getPresenter($need = TRUE)
147: {
148: return $this;
149: }
150:
151:
152:
153: /**
154: * Returns a name that uniquely identifies component.
155: * @return string
156: */
157: final public function getUniqueId()
158: {
159: return '';
160: }
161:
162:
163:
164: /********************* interface IPresenter ****************d*g**/
165:
166:
167:
168: /**
169: * @return void
170: * @throws AbortException
171: */
172: public function run()
173: {
174: try {
175: // PHASE 1: STARTUP
176: $this->phase = self::PHASE_STARTUP;
177: if ($this->isAjax()) {
178: $this->getAjaxDriver()->open($this->getHttpResponse());
179: }
180: $this->initGlobalParams();
181: $this->startup();
182: // calls $this->action{action}();
183: $this->tryCall($this->formatActionMethod($this->getAction()), $this->params);
184: if ($this->tryCall('present'. $this->getAction(), $this->params)) { // deprecated
185: trigger_error('Method name present' . $this->getAction() . '() is deprecated; use ' . $this->formatActionMethod($this->getAction()) . '() instead.', E_USER_WARNING);
186: }
187:
188: if ($this->autoCanonicalize) {
189: $this->canonicalize();
190: }
191: if ($this->getHttpRequest()->isMethod('head')) {
192: $this->terminate();
193: }
194:
195: // PHASE 2: PREPARING VIEW
196: $this->phase = self::PHASE_PREPARE;
197: $this->beforePrepare();
198: // calls $this->prepare{view}();
199: $this->tryCall($this->formatPrepareMethod($this->getView()), $this->params);
200:
201: // PHASE 3: SIGNAL HANDLING
202: $this->phase = self::PHASE_SIGNAL;
203: $this->processSignal();
204:
205: // PHASE 4: RENDERING VIEW
206: $this->phase = self::PHASE_RENDER;
207:
208: $this->beforeRender();
209: // calls $this->render{view}();
210: $this->tryCall($this->formatRenderMethod($this->getView()), $this->params);
211: $this->afterRender();
212:
213: // save component tree persistent state
214: $this->saveGlobalState();
215: if ($this->isAjax()) {
216: $this->getPayload()->state = $this->getGlobalState();
217: }
218:
219: // finish template rendering
220: $this->renderTemplate();
221:
222: $e = NULL;
223:
224: } catch (AbortException $e) {
225: // continue with shutting down
226: } /* finally */ {
227:
228: // PHASE 5: SHUTDOWN
229: $this->phase = self::PHASE_SHUTDOWN;
230:
231: if ($this->isAjax()) {
232: $this->ajaxDriver->close();
233: }
234:
235: if ($this->hasFlashSession()) {
236: $this->getFlashSession()->setExpiration($e instanceof RedirectingException ? 30 : 3);
237: }
238:
239: $this->onShutdown($this, $e);
240: $this->shutdown($e);
241:
242: if (isset($e)) throw $e;
243: }
244: }
245:
246:
247:
248: /**
249: * Returns current presenter life cycle phase.
250: * @return int
251: */
252: final public function getPhase()
253: {
254: return $this->phase;
255: }
256:
257:
258:
259: /**
260: * @return void
261: */
262: protected function startup()
263: {
264: }
265:
266:
267:
268: /**
269: * Common prepare method.
270: * @return void
271: */
272: protected function beforePrepare()
273: {
274: }
275:
276:
277:
278: /**
279: * Common render method.
280: * @return void
281: */
282: protected function beforeRender()
283: {
284: }
285:
286:
287:
288: /**
289: * Common render method.
290: * @return void
291: */
292: protected function afterRender()
293: {
294: }
295:
296:
297:
298: /**
299: * @param Exception optional catched exception
300: * @return void
301: */
302: protected function shutdown($exception)
303: {
304: }
305:
306:
307:
308: /********************* signal handling ****************d*g**/
309:
310:
311:
312: /**
313: * @return void
314: * @throws BadSignalException
315: */
316: public function processSignal()
317: {
318: if ($this->signal === NULL) return;
319:
320: $component = $this->signalReceiver === '' ? $this : $this->getComponent($this->signalReceiver, FALSE);
321: if ($component === NULL) {
322: throw new BadSignalException("The signal receiver component '$this->signalReceiver' is not found.");
323:
324: } elseif (!$component instanceof ISignalReceiver) {
325: throw new BadSignalException("The signal receiver component '$this->signalReceiver' is not ISignalReceiver implementor.");
326: }
327:
328: // auto invalidate
329: if ($component instanceof IRenderable) {
330: $component->invalidateControl();
331: }
332:
333: $component->signalReceived($this->signal);
334: $this->signal = NULL;
335: }
336:
337:
338:
339: /**
340: * Returns pair signal receiver and name.
341: * @return array|NULL
342: */
343: final public function getSignal()
344: {
345: return $this->signal === NULL ? NULL : array($this->signalReceiver, $this->signal);
346: }
347:
348:
349:
350: /**
351: * Checks if the signal receiver is the given one.
352: * @param mixed component or its id
353: * @param string signal name (optional)
354: * @return bool
355: */
356: final public function isSignalReceiver($component, $signal = NULL)
357: {
358: if ($component instanceof Component) {
359: $component = $component === $this ? '' : $component->lookupPath(__CLASS__, TRUE);
360: }
361:
362: if ($this->signal === NULL) {
363: return FALSE;
364:
365: } elseif ($signal === TRUE) {
366: return $component === ''
367: || strncmp($this->signalReceiver . '-', $component . '-', strlen($component) + 1) === 0;
368:
369: } elseif ($signal === NULL) {
370: return $this->signalReceiver === $component;
371:
372: } else {
373: return $this->signalReceiver === $component && strcasecmp($signal, $this->signal) === 0;
374: }
375: }
376:
377:
378:
379: /********************* rendering ****************d*g**/
380:
381:
382:
383: /**
384: * Returns current action name.
385: * @return string
386: */
387: final public function getAction($fullyQualified = FALSE)
388: {
389: return $fullyQualified ? ':' . $this->getName() . ':' . $this->action : $this->action;
390: }
391:
392:
393:
394: /**
395: * Changes current action. Only alphanumeric characters are allowed.
396: * @param string
397: * @return void
398: */
399: public function changeAction($action)
400: {
401: if (preg_match("#^[a-zA-Z0-9][a-zA-Z0-9_\x7f-\xff]*$#", $action)) {
402: $this->action = $action;
403: $this->view = $action;
404:
405: } else {
406: throw new BadRequestException("Action name '$action' is not alphanumeric string.");
407: }
408: }
409:
410:
411:
412: /**
413: * Returns current view.
414: * @return string
415: */
416: final public function getView()
417: {
418: return $this->view;
419: }
420:
421:
422:
423: /**
424: * Changes current view. Any name is allowed.
425: * @param string
426: * @return void
427: */
428: public function setView($view)
429: {
430: $this->view = (string) $view;
431: }
432:
433:
434:
435: /**
436: * Returns current layout name.
437: * @return string|FALSE
438: */
439: final public function getLayout()
440: {
441: return $this->layout;
442: }
443:
444:
445:
446: /**
447: * Changes or disables layout.
448: * @param string|FALSE
449: * @return void
450: */
451: public function setLayout($layout)
452: {
453: $this->layout = (string) $layout;
454: }
455:
456:
457:
458: /**
459: * @deprecated
460: */
461: public function changeView($view)
462: {
463: trigger_error('Presenter::changeView() is deprecated; use Presenter::setView(...) instead.', E_USER_WARNING);
464: $this->view = (string) $view;
465: }
466:
467:
468:
469: /**
470: * @deprecated
471: */
472: final public function getScene()
473: {
474: trigger_error('Presenter::getScene() is deprecated; use Presenter::getView() instead.', E_USER_WARNING);
475: return $this->view;
476: }
477:
478:
479:
480: /**
481: * @deprecated
482: */
483: public function changeScene($view)
484: {
485: trigger_error('Presenter::changeScene() is deprecated; use Presenter::setView(...) instead.', E_USER_WARNING);
486: $this->view = (string) $view;
487: }
488:
489:
490:
491: /**
492: * @deprecated
493: */
494: public function changeLayout($layout)
495: {
496: trigger_error('Presenter::changeLayout() is deprecated; use Presenter::setLayout(...) instead.', E_USER_WARNING);
497: $this->layout = (string) $layout;
498: }
499:
500:
501:
502: /**
503: * @return void
504: * @throws BadRequestException if no template found
505: */
506: public function renderTemplate()
507: {
508: $template = $this->getTemplate();
509: if (!$template) return;
510:
511: if ($this->isAjax()) { // TODO!
512: SnippetHelper::$outputAllowed = FALSE;
513: }
514:
515: if ($template instanceof IFileTemplate && !$template->getFile()) {
516:
517: if (isset($template->layout)) {
518: trigger_error('Parameter $template->layout is about to be reserved.', E_USER_WARNING);
519: }
520:
521: unset($template->layout, $template->content);
522:
523: // content template
524: $files = $this->formatTemplateFiles($this->getName(), $this->view);
525: foreach ($files as $file) {
526: if (is_file($file)) {
527: $template->setFile($file);
528: break;
529: }
530: }
531:
532: if (!$template->getFile()) {
533: $file = reset($files);
534: throw new BadRequestException("Page not found. Missing template '$file'.");
535: }
536:
537: // layout template
538: if ($this->layout) {
539: foreach ($this->formatLayoutTemplateFiles($this->getName(), $this->layout) as $file) {
540: if (is_file($file)) {
541: if ($this->oldLayoutMode) {
542: $template->content = $template instanceof Template ? $template->subTemplate($template->getFile()) : $template->getFile();
543: $template->setFile($file);
544: } else {
545: $template->layout = $file; // experimental
546: }
547: break;
548: }
549: }
550: }
551: }
552:
553: $template->render();
554: }
555:
556:
557:
558: /**
559: * Formats layout template file names.
560: * @param string
561: * @param string
562: * @return array
563: */
564: public function formatLayoutTemplateFiles($presenter, $layout)
565: {
566: $root = Environment::getVariable('templatesDir');
567: $presenter = str_replace(':', 'Module/', $presenter);
568: $module = substr($presenter, 0, (int) strrpos($presenter, '/'));
569: $base = '';
570: if ($root === Environment::getVariable('presentersDir')) {
571: $base = 'templates/';
572: if ($module === '') {
573: $presenter = 'templates/' . $presenter;
574: } else {
575: $presenter = substr_replace($presenter, '/templates', strrpos($presenter, '/'), 0);
576: }
577: }
578:
579: return array(
580: "$root/$presenter/@$layout.phtml",
581: "$root/$presenter.@$layout.phtml",
582: "$root/$module/$base@$layout.phtml",
583: "$root/$base@$layout.phtml",
584: );
585: }
586:
587:
588:
589: /**
590: * Formats view template file names.
591: * @param string
592: * @param string
593: * @return array
594: */
595: public function formatTemplateFiles($presenter, $view)
596: {
597: $root = Environment::getVariable('templatesDir');
598: $presenter = str_replace(':', 'Module/', $presenter);
599: $dir = '';
600: if ($root === Environment::getVariable('presentersDir')) { // special supported case
601: $pos = strrpos($presenter, '/');
602: $presenter = $pos === FALSE ? 'templates/' . $presenter : substr_replace($presenter, '/templates', $pos, 0);
603: $dir = 'templates/';
604: }
605: return array(
606: "$root/$presenter/$view.phtml",
607: "$root/$presenter.$view.phtml",
608: "$root/$dir@global.$view.phtml",
609: );
610: }
611:
612:
613:
614: /**
615: * Formats action method name.
616: * @param string
617: * @return string
618: */
619: protected static function formatActionMethod($action)
620: {
621: return 'action' . $action;
622: }
623:
624:
625:
626: /**
627: * Formats prepare view method name.
628: * @param string
629: * @return string
630: */
631: protected static function formatPrepareMethod($view)
632: {
633: return 'prepare' . $view;
634: }
635:
636:
637:
638: /**
639: * Formats render view method name.
640: * @param string
641: * @return string
642: */
643: protected static function formatRenderMethod($view)
644: {
645: return 'render' . $view;
646: }
647:
648:
649:
650: /********************* partial AJAX rendering ****************d*g**/
651:
652:
653:
654: /**
655: * @return mixed
656: */
657: public function getPayload()
658: {
659: return $this->getAjaxDriver();
660: }
661:
662:
663:
664: /**
665: * Is AJAX request?
666: * @return bool
667: */
668: public function isAjax()
669: {
670: if ($this->ajaxMode === NULL) {
671: $this->ajaxMode = $this->getHttpRequest()->isAjax();
672: }
673: return $this->ajaxMode;
674: }
675:
676:
677:
678: /**
679: * @return IAjaxDriver|NULL
680: */
681: public function getAjaxDriver()
682: {
683: if ($this->ajaxDriver === NULL) {
684: $value = $this->createAjaxDriver();
685: if (!($value instanceof IAjaxDriver)) {
686: $class = get_class($value);
687: throw new UnexpectedValueException("Object returned by $this->class::getAjaxDriver() must be instance of Nette\\Application\\IAjaxDriver, '$class' given.");
688: }
689: $this->ajaxDriver = $value;
690: }
691: return $this->ajaxDriver;
692: }
693:
694:
695:
696: /**
697: * @return IAjaxDriver
698: */
699: protected function createAjaxDriver()
700: {
701: return new AjaxDriver;
702: }
703:
704:
705:
706: /********************* navigation & flow ****************d*g**/
707:
708:
709:
710: /**
711: * Forward to another presenter or action.
712: * @param string|PresenterRequest
713: * @param array|mixed
714: * @return void
715: * @throws ForwardingException
716: */
717: public function forward($destination, $args = array())
718: {
719: if ($destination instanceof PresenterRequest) {
720: throw new ForwardingException($destination);
721:
722: } elseif (!is_array($args)) {
723: $args = func_get_args();
724: array_shift($args);
725: }
726:
727: $this->createRequest($this, $destination, $args, 'forward');
728: throw new ForwardingException($this->lastCreatedRequest);
729: }
730:
731:
732:
733: /**
734: * Redirect to another URL and ends presenter execution.
735: * @param string
736: * @param int HTTP error code
737: * @return void
738: * @throws RedirectingException
739: */
740: public function redirectUri($uri, $code = IHttpResponse::S303_POST_GET)
741: {
742: if ($this->isAjax()) {
743: $this->getPayload()->redirect = $uri;
744: $this->terminate();
745:
746: } else {
747: throw new RedirectingException($uri, $code);
748: }
749: }
750:
751:
752:
753: /**
754: * Link to myself.
755: * @return string
756: */
757: public function backlink()
758: {
759: return $this->getAction(TRUE);
760: }
761:
762:
763:
764: /**
765: * Returns the last created PresenterRequest.
766: * @return PresenterRequest
767: */
768: public function getLastCreatedRequest()
769: {
770: return $this->lastCreatedRequest;
771: }
772:
773:
774:
775: /**
776: * Returns the last created PresenterRequest flag.
777: * @param string
778: * @return bool
779: */
780: public function getLastCreatedRequestFlag($flag)
781: {
782: return !empty($this->lastCreatedRequestFlag[$flag]);
783: }
784:
785:
786:
787: /**
788: * Correctly terminates presenter.
789: * @return void
790: * @throws TerminateException
791: */
792: public function terminate()
793: {
794: throw new TerminateException();
795: }
796:
797:
798:
799: /**
800: * Conditional redirect to canonicalized URI.
801: * @return void
802: * @throws RedirectingException
803: */
804: public function canonicalize()
805: {
806: if (!$this->isAjax() && ($this->request->isMethod('get') || $this->request->isMethod('head'))) {
807: $uri = $this->createRequest($this, $this->action, $this->getGlobalState() + $this->request->params, 'redirectX');
808: if ($uri !== NULL && !$this->getHttpRequest()->getUri()->isEqual($uri)) {
809: throw new RedirectingException($uri, IHttpResponse::S301_MOVED_PERMANENTLY);
810: }
811: }
812: }
813:
814:
815:
816: /**
817: * Attempts to cache the sent entity by its last modification date
818: * @param int last modified time as unix timestamp
819: * @param string strong entity tag validator
820: * @param int optional expiration time
821: * @return int date of the client's cache version, if available
822: * @throws TerminateException
823: */
824: public function lastModified($lastModified, $etag = NULL, $expire = NULL)
825: {
826: if (!Environment::isProduction()) {
827: return NULL;
828: }
829:
830: $httpResponse = $this->getHttpResponse();
831: $match = FALSE;
832:
833: if ($lastModified > 0) {
834: $httpResponse->setHeader('Last-Modified', HttpResponse::date($lastModified));
835: }
836:
837: if ($etag != NULL) { // intentionally ==
838: $etag = '"' . addslashes($etag) . '"';
839: $httpResponse->setHeader('ETag', $etag);
840: }
841:
842: if ($expire !== NULL) {
843: $httpResponse->expire($expire);
844: }
845:
846: $ifNoneMatch = $this->getHttpRequest()->getHeader('if-none-match');
847: $ifModifiedSince = $this->getHttpRequest()->getHeader('if-modified-since');
848: if ($ifModifiedSince !== NULL) {
849: $ifModifiedSince = strtotime($ifModifiedSince);
850: }
851:
852: if ($ifNoneMatch !== NULL) {
853: if ($ifNoneMatch === '*') {
854: $match = TRUE; // match, check if-modified-since
855:
856: } elseif ($etag == NULL || strpos(' ' . strtr($ifNoneMatch, ",\t", ' '), ' ' . $etag) === FALSE) {
857: return $ifModifiedSince; // no match, ignore if-modified-since
858:
859: } else {
860: $match = TRUE; // match, check if-modified-since
861: }
862: }
863:
864: if ($ifModifiedSince !== NULL) {
865: if ($lastModified > 0 && $lastModified <= $ifModifiedSince) {
866: $match = TRUE;
867:
868: } else {
869: return $ifModifiedSince;
870: }
871: }
872:
873: if ($match) {
874: $httpResponse->setCode(IHttpResponse::S304_NOT_MODIFIED);
875: $httpResponse->setHeader('Content-Length', '0');
876: $this->terminate();
877:
878: } else {
879: return $ifModifiedSince;
880: }
881:
882: return NULL;
883: }
884:
885:
886:
887: /**
888: * PresenterRequest/URL factory.
889: * @param PresenterComponent base
890: * @param string destination in format "[[module:]presenter:]action" or "signal!"
891: * @param array array of arguments
892: * @param string forward|redirect|link
893: * @return string URL
894: * @throws InvalidLinkException
895: * @ignore internal
896: */
897: final protected function createRequest($component, $destination, array $args, $mode)
898: {
899: // note: createRequest supposes that saveState(), run() & tryCall() behaviour is final
900:
901: // cached services for better performance
902: static $presenterLoader, $router, $httpRequest;
903: if ($presenterLoader === NULL) {
904: $presenterLoader = $this->getApplication()->getPresenterLoader();
905: $router = $this->getApplication()->getRouter();
906: $httpRequest = $this->getHttpRequest();
907: }
908:
909: $this->lastCreatedRequest = $this->lastCreatedRequestFlag = NULL;
910:
911: // PARSE DESTINATION
912: // 1) fragment
913: $a = strpos($destination, '#');
914: if ($a === FALSE) {
915: $fragment = '';
916: } else {
917: $fragment = substr($destination, $a);
918: $destination = substr($destination, 0, $a);
919: }
920:
921: // 2) ?query syntax
922: $a = strpos($destination, '?');
923: if ($a !== FALSE) {
924: parse_str(substr($destination, $a + 1), $args); // requires disabled magic quotes
925: $destination = substr($destination, 0, $a);
926: }
927:
928: // 3) URL scheme
929: $a = strpos($destination, '//');
930: if ($a === FALSE) {
931: $scheme = FALSE;
932: } else {
933: $scheme = substr($destination, 0, $a);
934: $destination = substr($destination, $a + 2);
935: }
936:
937: // 4) signal or empty
938: if (!($component instanceof Presenter) || substr($destination, -1) === '!') {
939: $signal = rtrim($destination, '!');
940: if ($signal == NULL) { // intentionally ==
941: throw new InvalidLinkException("Signal must be non-empty string.");
942: }
943: $destination = 'this';
944: }
945:
946: if ($destination == NULL) { // intentionally ==
947: throw new InvalidLinkException("Destination must be non-empty string.");
948: }
949:
950: // 5) presenter: action
951: $current = FALSE;
952: $a = strrpos($destination, ':');
953: if ($a === FALSE) {
954: $action = $destination === 'this' ? $this->action : $destination;
955: $presenter = $this->getName();
956: $presenterClass = $this->getClass();
957:
958: } else {
959: $action = (string) substr($destination, $a + 1);
960: if ($destination[0] === ':') { // absolute
961: if ($a < 2) {
962: throw new InvalidLinkException("Missing presenter name in '$destination'.");
963: }
964: $presenter = substr($destination, 1, $a - 1);
965:
966: } else { // relative
967: $presenter = $this->getName();
968: $b = strrpos($presenter, ':');
969: if ($b === FALSE) { // no module
970: $presenter = substr($destination, 0, $a);
971: } else { // with module
972: $presenter = substr($presenter, 0, $b + 1) . substr($destination, 0, $a);
973: }
974: }
975: $presenterClass = $presenterLoader->getPresenterClass($presenter);
976: }
977:
978: // PROCESS SIGNAL ARGUMENTS
979: if (isset($signal)) { // $component must be IStatePersistent
980: $class = get_class($component);
981: if ($signal === 'this') { // means "no signal"
982: $signal = '';
983: if (array_key_exists(0, $args)) {
984: throw new InvalidLinkException("Extra parameter for signal '$class:$signal!'.");
985: }
986:
987: } elseif (strpos($signal, self::NAME_SEPARATOR) === FALSE) { // TODO: AppForm exception
988: // counterpart of signalReceived() & tryCall()
989: $method = $component->formatSignalMethod($signal);
990: if (!PresenterHelpers::isMethodCallable($class, $method)) {
991: throw new InvalidLinkException("Unknown signal '$class:$signal!'.");
992: }
993: if ($args) { // convert indexed parameters to named
994: PresenterHelpers::argsToParams($class, $method, $args);
995: }
996: }
997:
998: // counterpart of IStatePersistent
999: if ($args && array_intersect_key($args, PresenterHelpers::getPersistentParams($class))) {
1000: $component->saveState($args);
1001: }
1002:
1003: if ($args && $component !== $this) {
1004: $prefix = $component->getUniqueId() . self::NAME_SEPARATOR;
1005: foreach ($args as $key => $val) {
1006: unset($args[$key]);
1007: $args[$prefix . $key] = $val;
1008: }
1009: }
1010: }
1011:
1012: // PROCESS ARGUMENTS
1013: if (is_subclass_of($presenterClass, __CLASS__)) {
1014: if ($action === '') {
1015: /*$action = $presenterClass::$defaultAction;*/ // in PHP 5.3
1016: $action = self::$defaultAction;
1017: }
1018:
1019: $current = ($action === '*' || $action === $this->action) && $presenterClass === $this->getClass(); // TODO
1020:
1021: if ($args || $destination === 'this') {
1022: // counterpart of run() & tryCall()
1023: // in PHP 5.3
1024: $method = call_user_func(array($presenterClass, 'formatActionMethod'), $action);
1025: if (!PresenterHelpers::isMethodCallable($presenterClass, $method)) {
1026: $method = 'present' . $action;
1027: if (!PresenterHelpers::isMethodCallable($presenterClass, $method)) {// back compatibility
1028: // in PHP 5.3
1029: $method = call_user_func(array($presenterClass, 'formatRenderMethod'), $action);
1030: if (!PresenterHelpers::isMethodCallable($presenterClass, $method)) {
1031: $method = NULL;
1032: }
1033: }
1034: }
1035:
1036: // convert indexed parameters to named
1037: if ($method === NULL) {
1038: if (array_key_exists(0, $args)) {
1039: throw new InvalidLinkException("Extra parameter for '$presenter:$action'.");
1040: }
1041:
1042: } elseif ($destination === 'this') {
1043: PresenterHelpers::argsToParams($presenterClass, $method, $args, $this->params);
1044:
1045: } else {
1046: PresenterHelpers::argsToParams($presenterClass, $method, $args);
1047: }
1048: }
1049:
1050: // counterpart of IStatePersistent
1051: if ($args && array_intersect_key($args, PresenterHelpers::getPersistentParams($presenterClass))) {
1052: $this->saveState($args, $presenterClass);
1053: }
1054:
1055: $globalState = $this->getGlobalState($destination === 'this' ? NULL : $presenterClass);
1056: if ($current && $args) {
1057: $tmp = $globalState + $this->params;
1058: foreach ($args as $key => $val) {
1059: if ((string) $val !== (isset($tmp[$key]) ? (string) $tmp[$key] : '')) {
1060: $current = FALSE;
1061: break;
1062: }
1063: }
1064: }
1065: $args += $globalState;
1066: }
1067:
1068: // ADD ACTION & SIGNAL & FLASH
1069: $args[self::ACTION_KEY] = $action;
1070: if (!empty($signal)) {
1071: $args[self::SIGNAL_KEY] = $component->getParamId($signal);
1072: $current = $current && $args[self::SIGNAL_KEY] === $this->getParam(self::SIGNAL_KEY);
1073: }
1074: if ($mode === 'redirect' && $this->hasFlashSession()) {
1075: $args[self::FLASH_KEY] = $this->getParam(self::FLASH_KEY);
1076: }
1077:
1078: $this->lastCreatedRequest = new PresenterRequest(
1079: $presenter,
1080: PresenterRequest::FORWARD,
1081: $args,
1082: array(),
1083: array()
1084: );
1085: $this->lastCreatedRequestFlag = array('current' => $current);
1086:
1087: if ($mode === 'forward') return;
1088:
1089: // CONSTRUCT URL
1090: $uri = $router->constructUrl($this->lastCreatedRequest, $httpRequest);
1091: if ($uri === NULL) {
1092: unset($args[self::ACTION_KEY]);
1093: $params = urldecode(http_build_query($args, NULL, ', '));
1094: throw new InvalidLinkException("No route for $presenter:$action($params)");
1095: }
1096:
1097: // make URL relative if possible
1098: if ($mode === 'link' && $scheme === FALSE && !$this->absoluteUrls) {
1099: $hostUri = $httpRequest->getUri()->hostUri;
1100: if (strncmp($uri, $hostUri, strlen($hostUri)) === 0) {
1101: $uri = substr($uri, strlen($hostUri));
1102: }
1103: }
1104:
1105: return $uri . $fragment;
1106: }
1107:
1108:
1109:
1110: /**
1111: * Invalid link handler. Descendant can override this method to change default behaviour.
1112: * @param InvalidLinkException
1113: * @return string
1114: * @throws InvalidLinkException
1115: */
1116: protected function handleInvalidLink($e)
1117: {
1118: if (self::$invalidLinkMode === NULL) {
1119: self::$invalidLinkMode = Environment::isProduction()
1120: ? self::INVALID_LINK_SILENT : self::INVALID_LINK_WARNING;
1121: }
1122:
1123: if (self::$invalidLinkMode === self::INVALID_LINK_SILENT) {
1124: return '#';
1125:
1126: } elseif (self::$invalidLinkMode === self::INVALID_LINK_WARNING) {
1127: return 'error: ' . htmlSpecialChars($e->getMessage());
1128:
1129: } else { // self::INVALID_LINK_EXCEPTION
1130: throw $e;
1131: }
1132: }
1133:
1134:
1135:
1136: /********************* interface IStatePersistent ****************d*g**/
1137:
1138:
1139:
1140: /**
1141: * Returns array of persistent components.
1142: * This default implementation detects components by class-level annotation @persistent(cmp1, cmp2).
1143: * @return array
1144: */
1145: public static function getPersistentComponents()
1146: {
1147: return (array) Annotations::get(new ReflectionClass(func_get_arg(0)), 'persistent');
1148: }
1149:
1150:
1151:
1152: /**
1153: * Saves state information for all subcomponents to $this->globalState.
1154: * @return array
1155: */
1156: private function getGlobalState($forClass = NULL)
1157: {
1158: $sinces = & $this->globalStateSinces;
1159:
1160: if ($this->globalState === NULL) {
1161: if ($this->phase >= self::PHASE_SHUTDOWN) {
1162: throw new InvalidStateException("Presenter is shutting down, cannot save state.");
1163: }
1164:
1165: $state = array();
1166: foreach ($this->globalParams as $id => $params) {
1167: $prefix = $id . self::NAME_SEPARATOR;
1168: foreach ($params as $key => $val) {
1169: $state[$prefix . $key] = $val;
1170: }
1171: }
1172: $this->saveState($state, $forClass);
1173:
1174: if ($sinces === NULL) {
1175: $sinces = array();
1176: foreach (PresenterHelpers::getPersistentParams(get_class($this)) as $nm => $meta) {
1177: $sinces[$nm] = $meta['since'];
1178: }
1179: }
1180:
1181: $components = PresenterHelpers::getPersistentComponents(get_class($this));
1182: $iterator = $this->getComponents(TRUE, 'Nette\Application\IStatePersistent');
1183: foreach ($iterator as $name => $component)
1184: {
1185: if ($iterator->getDepth() === 0) {
1186: // counts with RecursiveIteratorIterator::SELF_FIRST
1187: $since = isset($components[$name]['since']) ? $components[$name]['since'] : FALSE; // FALSE = nonpersistent
1188: }
1189: $prefix = $component->getUniqueId() . self::NAME_SEPARATOR;
1190: $params = array();
1191: $component->saveState($params);
1192: foreach ($params as $key => $val) {
1193: $state[$prefix . $key] = $val;
1194: $sinces[$prefix . $key] = $since;
1195: }
1196: }
1197:
1198: } else {
1199: $state = $this->globalState;
1200: }
1201:
1202: if ($forClass !== NULL) {
1203: $since = NULL;
1204: foreach ($state as $key => $foo) {
1205: if (!isset($sinces[$key])) {
1206: $x = strpos($key, self::NAME_SEPARATOR);
1207: $x = $x === FALSE ? $key : substr($key, 0, $x);
1208: $sinces[$key] = isset($sinces[$x]) ? $sinces[$x] : FALSE;
1209: }
1210: if ($since !== $sinces[$key]) {
1211: $since = $sinces[$key];
1212: $ok = $since && (is_subclass_of($forClass, $since) || $forClass === $since);
1213: }
1214: if (!$ok) {
1215: unset($state[$key]);
1216: }
1217: }
1218: }
1219:
1220: return $state;
1221: }
1222:
1223:
1224:
1225: /**
1226: * Permanently saves state information for all subcomponents to $this->globalState.
1227: * @return void
1228: */
1229: protected function saveGlobalState()
1230: {
1231: $this->globalParams = array();
1232: $this->globalState = $this->getGlobalState();
1233: }
1234:
1235:
1236:
1237: /**
1238: * Initializes $this->globalParams, $this->signal & $this->signalReceiver, $this->action, $this->view. Called by run().
1239: * @return void
1240: * @throws BadRequestException if action name is not valid
1241: */
1242: private function initGlobalParams()
1243: {
1244: // init $this->globalParams
1245: $this->globalParams = array();
1246: $selfParams = array();
1247:
1248: $params = $this->request->getParams();
1249: if ($this->isAjax()) {
1250: $params = $this->request->getPost() + $params;
1251: }
1252:
1253: foreach ($params as $key => $value) {
1254: $a = strlen($key) > 2 ? strrpos($key, self::NAME_SEPARATOR, -2) : FALSE;
1255: if ($a === FALSE) {
1256: $selfParams[$key] = $value;
1257: } else {
1258: $this->globalParams[substr($key, 0, $a)][substr($key, $a + 1)] = $value;
1259: }
1260: }
1261:
1262: // init & validate $this->action & $this->view
1263: $this->changeAction(isset($selfParams[self::ACTION_KEY]) ? $selfParams[self::ACTION_KEY] : self::$defaultAction);
1264:
1265: // init $this->signalReceiver and key 'signal' in appropriate params array
1266: $this->signalReceiver = $this->getUniqueId();
1267: if (!empty($selfParams[self::SIGNAL_KEY])) {
1268: $param = $selfParams[self::SIGNAL_KEY];
1269: $pos = strrpos($param, '-');
1270: if ($pos) {
1271: $this->signalReceiver = substr($param, 0, $pos);
1272: $this->signal = substr($param, $pos + 1);
1273: } else {
1274: $this->signalReceiver = $this->getUniqueId();
1275: $this->signal = $param;
1276: }
1277: if ($this->signal == NULL) { // intentionally ==
1278: $this->signal = NULL;
1279: }
1280: }
1281:
1282: $this->loadState($selfParams);
1283: }
1284:
1285:
1286:
1287: /**
1288: * Pops parameters for specified component.
1289: * @param string component id
1290: * @return array
1291: */
1292: final public function popGlobalParams($id)
1293: {
1294: if (isset($this->globalParams[$id])) {
1295: $res = $this->globalParams[$id];
1296: unset($this->globalParams[$id]);
1297: return $res;
1298:
1299: } else {
1300: return array();
1301: }
1302: }
1303:
1304:
1305:
1306: /********************* flash session ****************d*g**/
1307:
1308:
1309:
1310: /**
1311: * Checks if a flash session namespace exists.
1312: * @return bool
1313: */
1314: public function hasFlashSession()
1315: {
1316: return !empty($this->params[self::FLASH_KEY])
1317: && $this->getSession()->hasNamespace('Nette.Application.Flash/' . $this->params[self::FLASH_KEY]);
1318: }
1319:
1320:
1321:
1322: /**
1323: * Returns session namespace provided to pass temporary data between redirects.
1324: * @return SesssionNamespace
1325: */
1326: public function getFlashSession()
1327: {
1328: if (empty($this->params[self::FLASH_KEY])) {
1329: $this->params[self::FLASH_KEY] = substr(md5(lcg_value()), 0, 4);
1330: }
1331: return $this->getSession()->getNamespace('Nette.Application.Flash/' . $this->params[self::FLASH_KEY]);
1332: }
1333:
1334:
1335:
1336: /********************* backend ****************d*g**/
1337:
1338:
1339:
1340: /**
1341: * @return IHttpRequest
1342: */
1343: protected function getHttpRequest()
1344: {
1345: return Environment::getHttpRequest();
1346: }
1347:
1348:
1349:
1350: /**
1351: * @return IHttpResponse
1352: */
1353: protected function getHttpResponse()
1354: {
1355: return Environment::getHttpResponse();
1356: }
1357:
1358:
1359:
1360: /**
1361: * @return Application
1362: */
1363: public function getApplication()
1364: {
1365: return Environment::getApplication();
1366: }
1367:
1368:
1369:
1370: /**
1371: * @return Sesssion
1372: */
1373: private function getSession()
1374: {
1375: return Environment::getSession();
1376: }
1377:
1378: }

Source for file Presenter.php

Namespaces