Source for file SimpleRouter.php

Documentation is available at SimpleRouter.php

1. 1: <?php
2. 2:  
3. 3: /**
4. 4:  * Nette Framework
5. 5:  *
6. 6:  * Copyright (c) 2004, 2009 David Grudl (http://davidgrudl.com)
7. 7:  *
8. 8:  * This source file is subject to the "Nette license" that is bundled
9. 9:  * with this package in the file license.txt.
10. 10:  *
11. 11:  * For more information please see https://nette.org
12. 12:  *
13. 13:  * @copyright  Copyright (c) 2004, 2009 David Grudl
14. 14:  * @license    https://nette.org/license  Nette license
15. 15:  * @link       https://nette.org
16. 16:  * @category   Nette
17. 17:  * @package    Nette\Application
18. 18:  * @version    $Id$
19. 19:  */
20. 20:  
21. 21:  
22. 22:  
23. 23: require_once dirname(__FILE__) . '/../Object.php';
24. 24:  
25. 25: require_once dirname(__FILE__) . '/../Application/IRouter.php';
26. 26:  
27. 27:  
28. 28:  
29. 29: /**
30. 30:  * The bidirectional route for trivial routing via query string.
31. 31:  *
32. 32:  * @author     David Grudl
33. 33:  * @copyright  Copyright (c) 2004, 2009 David Grudl
34. 34:  * @package    Nette\Application
35. 35:  */
36. 36: class SimpleRouter extends Object implements IRouter
37. 37: {
38. 38:     const PRESENTER_KEY = 'presenter';
39. 39:     const MODULE_KEY = 'module';
40. 40:  
41. 41:     /** @var string */
42. 42:     protected $module = '';
43. 43:  
44. 44:     /** @var array */
45. 45:     protected $defaults;
46. 46:  
47. 47:     /** @var int */
48. 48:     protected $flags;
49. 49:  
50. 50:  
51. 51:  
52. 52:     /**
53. 53:      * @param  array   default values
54. 54:      * @param  int     flags
55. 55:      */
56. 56:     public function __construct($defaults = array(), $flags = 0)
57. 57:     {
58. 58:         if (is_string($defaults)) {
59. 59:             $a = strrpos($defaults, ':');
60. 60:             $defaults = array(
61. 61:                 self::PRESENTER_KEY => substr($defaults, 0, $a),
62. 62:                 'action' => substr($defaults, $a + 1),
63. 63:             );
64. 64:  
65. 65:         } elseif (isset($defaults['view'])) { // back compatiblity
66. 66:             $defaults['action'] = $defaults['view'];
67. 67:             unset($defaults['view']);
68. 68:         }
69. 69:  
70. 70:         if (isset($defaults[self::MODULE_KEY])) {
71. 71:             $this->module = $defaults[self::MODULE_KEY] . ':';
72. 72:             unset($defaults[self::MODULE_KEY]);
73. 73:         }
74. 74:  
75. 75:         $this->defaults = $defaults;
76. 76:         $this->flags = $flags;
77. 77:     }
78. 78:  
79. 79:  
80. 80:  
81. 81:     /**
82. 82:      * Maps HTTP request to a PresenterRequest object.
83. 83:      * @param  IHttpRequest 
84. 84:      * @return PresenterRequest|NULL
85. 85:      */
86. 86:     public function match(IHttpRequest $httpRequest)
87. 87:     {
88. 88:         // combine with precedence: get, (post,) defaults
89. 89:         $params = $httpRequest->getQuery();
90. 90:         $params += $this->defaults;
91. 91:  
92. 92:         if (!isset($params[self::PRESENTER_KEY])) {
93. 93:             throw new InvalidStateException('Missing presenter.');
94. 94:         }
95. 95:  
96. 96:         $presenter = $this->module . $params[self::PRESENTER_KEY];
97. 97:         unset($params[self::PRESENTER_KEY]);
98. 98:  
99. 99:         return new PresenterRequest(
100. 100:             $presenter,
101. 101:             $httpRequest->getMethod(),
102. 102:             $params,
103. 103:             $httpRequest->getPost(),
104. 104:             $httpRequest->getFiles(),
105. 105:             array('secured' => $httpRequest->isSecured())
106. 106:         );
107. 107:     }
108. 108:  
109. 109:  
110. 110:  
111. 111:     /**
112. 112:      * Constructs absolute URL from PresenterRequest object.
113. 113:      * @param  IHttpRequest 
114. 114:      * @param  PresenterRequest 
115. 115:      * @return string|NULL
116. 116:      */
117. 117:     public function constructUrl(PresenterRequest $appRequest, IHttpRequest $httpRequest)
118. 118:     {
119. 119:         $params = $appRequest->getParams();
120. 120:  
121. 121:         // presenter name
122. 122:         $presenter = $appRequest->getPresenterName();
123. 123:         if (strncasecmp($presenter, $this->module, strlen($this->module)) === 0) {
124. 124:             $params[self::PRESENTER_KEY] = substr($presenter, strlen($this->module));
125. 125:         } else {
126. 126:             return NULL;
127. 127:         }
128. 128:  
129. 129:         // remove default values; NULL values are retain
130. 130:         foreach ($this->defaults as $key => $value) {
131. 131:             if (isset($params[$key]) && $params[$key] == $value) { // intentionally ==
132. 132:                 unset($params[$key]);
133. 133:             }
134. 134:         }
135. 135:  
136. 136:         $uri = $httpRequest->getUri();
137. 137:         $uri = ($this->flags & self::SECURED ? 'https://' : 'http://') . $uri->authority . $uri->scriptPath;
138. 138:         $query = http_build_query($params, '', '&');
139. 139:         if ($query != '') { // intentionally ==
140. 140:             $uri .= '?' . $query;
141. 141:         }
142. 142:         return $uri;
143. 143:     }
144. 144:  
145. 145:  
146. 146:  
147. 147:     /**
148. 148:      * Returns default values.
149. 149:      * @return array 
150. 150:      */
151. 151:     public function getDefaults()
152. 152:     {
153. 153:         return $this->defaults;
154. 154:     }
155. 155:  
156. 156: }