1: <?php
  2: 
  3: /**
  4:  * This file is part of the Nette Framework (https://nette.org)
  5:  * Copyright (c) 2004 David Grudl (http://davidgrudl.com)
  6:  */
  7: 
  8: namespace Nette\Application\UI;
  9: 
 10: use Nette;
 11: 
 12: 
 13: /**
 14:  * PresenterComponent is the base class for all Presenter components.
 15:  *
 16:  * Components are persistent objects located on a presenter. They have ability to own
 17:  * other child components, and interact with user. Components have properties
 18:  * for storing their status, and responds to user command.
 19:  *
 20:  * @author     David Grudl
 21:  *
 22:  * @property-read Presenter $presenter
 23:  * @property-read string $uniqueId
 24:  */
 25: abstract class PresenterComponent extends Nette\ComponentModel\Container implements ISignalReceiver, IStatePersistent, \ArrayAccess
 26: {
 27:     /** @var array */
 28:     protected $params = array();
 29: 
 30: 
 31:     /**
 32:      * Returns the presenter where this component belongs to.
 33:      * @param  bool   throw exception if presenter doesn't exist?
 34:      * @return Presenter|NULL
 35:      */
 36:     public function getPresenter($need = TRUE)
 37:     {
 38:         return $this->lookup('Nette\Application\UI\Presenter', $need);
 39:     }
 40: 
 41: 
 42:     /**
 43:      * Returns a fully-qualified name that uniquely identifies the component
 44:      * within the presenter hierarchy.
 45:      * @return string
 46:      */
 47:     public function getUniqueId()
 48:     {
 49:         return $this->lookupPath('Nette\Application\UI\Presenter', TRUE);
 50:     }
 51: 
 52: 
 53:     /**
 54:      * This method will be called when the component (or component's parent)
 55:      * becomes attached to a monitored object. Do not call this method yourself.
 56:      * @param  Nette\ComponentModel\IComponent
 57:      * @return void
 58:      */
 59:     protected function attached($presenter)
 60:     {
 61:         if ($presenter instanceof Presenter) {
 62:             $this->loadState($presenter->popGlobalParameters($this->getUniqueId()));
 63:         }
 64:     }
 65: 
 66: 
 67:     /**
 68:      * @return void
 69:      */
 70:     protected function validateParent(Nette\ComponentModel\IContainer $parent)
 71:     {
 72:         parent::validateParent($parent);
 73:         $this->monitor('Nette\Application\UI\Presenter');
 74:     }
 75: 
 76: 
 77:     /**
 78:      * Calls public method if exists.
 79:      * @param  string
 80:      * @param  array
 81:      * @return bool  does method exist?
 82:      */
 83:     protected function tryCall($method, array $params)
 84:     {
 85:         $rc = $this->getReflection();
 86:         if ($rc->hasMethod($method)) {
 87:             $rm = $rc->getMethod($method);
 88:             if ($rm->isPublic() && !$rm->isAbstract() && !$rm->isStatic()) {
 89:                 $this->checkRequirements($rm);
 90:                 $rm->invokeArgs($this, $rc->combineArgs($rm, $params));
 91:                 return TRUE;
 92:             }
 93:         }
 94:         return FALSE;
 95:     }
 96: 
 97: 
 98:     /**
 99:      * Checks for requirements such as authorization.
100:      * @return void
101:      */
102:     public function checkRequirements($element)
103:     {
104:     }
105: 
106: 
107:     /**
108:      * Access to reflection.
109:      * @return PresenterComponentReflection
110:      */
111:     public static function getReflection()
112:     {
113:         return new PresenterComponentReflection(get_called_class());
114:     }
115: 
116: 
117:     /********************* interface IStatePersistent ****************d*g**/
118: 
119: 
120:     /**
121:      * Loads state informations.
122:      * @param  array
123:      * @return void
124:      */
125:     public function loadState(array $params)
126:     {
127:         $reflection = $this->getReflection();
128:         foreach ($reflection->getPersistentParams() as $name => $meta) {
129:             if (isset($params[$name])) { // NULLs are ignored
130:                 $type = gettype($meta['def'] === NULL ? $params[$name] : $meta['def']); // compatible with 2.0.x
131:                 if (!$reflection->convertType($params[$name], $type)) {
132:                     throw new Nette\Application\BadRequestException("Invalid value for persistent parameter '$name' in '{$this->getName()}', expected " . ($type === 'NULL' ? 'scalar' : $type) . ".");
133:                 }
134:                 $this->$name = & $params[$name];
135:             } else {
136:                 $params[$name] = & $this->$name;
137:             }
138:         }
139:         $this->params = $params;
140:     }
141: 
142: 
143:     /**
144:      * Saves state informations for next request.
145:      * @param  array
146:      * @param  PresenterComponentReflection (internal, used by Presenter)
147:      * @return void
148:      */
149:     public function saveState(array & $params, $reflection = NULL)
150:     {
151:         $reflection = $reflection === NULL ? $this->getReflection() : $reflection;
152:         foreach ($reflection->getPersistentParams() as $name => $meta) {
153: 
154:             if (isset($params[$name])) {
155:                 // injected value
156: 
157:             } elseif (array_key_exists($name, $params)) { // NULLs are skipped
158:                 continue;
159: 
160:             } elseif (!isset($meta['since']) || $this instanceof $meta['since']) {
161:                 $params[$name] = $this->$name; // object property value
162: 
163:             } else {
164:                 continue; // ignored parameter
165:             }
166: 
167:             $type = gettype($meta['def'] === NULL ? $params[$name] : $meta['def']); // compatible with 2.0.x
168:             if (!PresenterComponentReflection::convertType($params[$name], $type)) {
169:                 throw new InvalidLinkException(sprintf("Invalid value for persistent parameter '%s' in '%s', expected %s.", $name, $this->getName(), $type === 'NULL' ? 'scalar' : $type));
170:             }
171: 
172:             if ($params[$name] === $meta['def'] || ($meta['def'] === NULL && is_scalar($params[$name]) && (string) $params[$name] === '')) {
173:                 $params[$name] = NULL; // value transmit is unnecessary
174:             }
175:         }
176:     }
177: 
178: 
179:     /**
180:      * Returns component param.
181:      * If no key is passed, returns the entire array.
182:      * @param  string key
183:      * @param  mixed  default value
184:      * @return mixed
185:      */
186:     public function getParameter($name = NULL, $default = NULL)
187:     {
188:         if (func_num_args() === 0) {
189:             return $this->params;
190: 
191:         } elseif (isset($this->params[$name])) {
192:             return $this->params[$name];
193: 
194:         } else {
195:             return $default;
196:         }
197:     }
198: 
199: 
200:     /**
201:      * Returns a fully-qualified name that uniquely identifies the parameter.
202:      * @param  string
203:      * @return string
204:      */
205:     public function getParameterId($name)
206:     {
207:         $uid = $this->getUniqueId();
208:         return $uid === '' ? $name : $uid . self::NAME_SEPARATOR . $name;
209:     }
210: 
211: 
212:     /** @deprecated */
213:     function getParam($name = NULL, $default = NULL)
214:     {
215:         return func_num_args() ? $this->getParameter($name, $default) : $this->getParameter();
216:     }
217: 
218: 
219:     /** @deprecated */
220:     function getParamId($name)
221:     {
222:         trigger_error(__METHOD__ . '() is deprecated; use getParameterId() instead.', E_USER_WARNING);
223:         return $this->getParameterId($name);
224:     }
225: 
226: 
227:     /**
228:      * Returns array of classes persistent parameters. They have public visibility and are non-static.
229:      * This default implementation detects persistent parameters by annotation @persistent.
230:      * @return array
231:      */
232:     public static function getPersistentParams()
233:     {
234:         $rc = new Nette\Reflection\ClassType(get_called_class());
235:         $params = array();
236:         foreach ($rc->getProperties(\ReflectionProperty::IS_PUBLIC) as $rp) {
237:             if (!$rp->isStatic() && $rp->hasAnnotation('persistent')) {
238:                 $params[] = $rp->getName();
239:             }
240:         }
241:         return $params;
242:     }
243: 
244: 
245:     /********************* interface ISignalReceiver ****************d*g**/
246: 
247: 
248:     /**
249:      * Calls signal handler method.
250:      * @param  string
251:      * @return void
252:      * @throws BadSignalException if there is not handler method
253:      */
254:     public function signalReceived($signal)
255:     {
256:         if (!$this->tryCall($this->formatSignalMethod($signal), $this->params)) {
257:             $class = get_class($this);
258:             throw new BadSignalException("There is no handler for signal '$signal' in class $class.");
259:         }
260:     }
261: 
262: 
263:     /**
264:      * Formats signal handler method name -> case sensitivity doesn't matter.
265:      * @param  string
266:      * @return string
267:      */
268:     public function formatSignalMethod($signal)
269:     {
270:         return $signal == NULL ? NULL : 'handle' . $signal; // intentionally ==
271:     }
272: 
273: 
274:     /********************* navigation ****************d*g**/
275: 
276: 
277:     /**
278:      * Generates URL to presenter, action or signal.
279:      * @param  string   destination in format "[[module:]presenter:]action" or "signal!" or "this"
280:      * @param  array|mixed
281:      * @return string
282:      * @throws InvalidLinkException
283:      */
284:     public function link($destination, $args = array())
285:     {
286:         try {
287:             return $this->getPresenter()->createRequest($this, $destination, is_array($args) ? $args : array_slice(func_get_args(), 1), 'link');
288: 
289:         } catch (InvalidLinkException $e) {
290:             return $this->getPresenter()->handleInvalidLink($e);
291:         }
292:     }
293: 
294: 
295:     /**
296:      * Returns destination as Link object.
297:      * @param  string   destination in format "[[module:]presenter:]view" or "signal!"
298:      * @param  array|mixed
299:      * @return Link
300:      */
301:     public function lazyLink($destination, $args = array())
302:     {
303:         return new Link($this, $destination, is_array($args) ? $args : array_slice(func_get_args(), 1));
304:     }
305: 
306: 
307:     /**
308:      * Determines whether it links to the current page.
309:      * @param  string   destination in format "[[module:]presenter:]action" or "signal!" or "this"
310:      * @param  array|mixed
311:      * @return bool
312:      * @throws InvalidLinkException
313:      */
314:     public function isLinkCurrent($destination = NULL, $args = array())
315:     {
316:         if ($destination !== NULL) {
317:             $this->getPresenter()->createRequest($this, $destination, is_array($args) ? $args : array_slice(func_get_args(), 1), 'test');
318:         }
319:         return $this->getPresenter()->getLastCreatedRequestFlag('current');
320:     }
321: 
322: 
323:     /**
324:      * Redirect to another presenter, action or signal.
325:      * @param  int      [optional] HTTP error code
326:      * @param  string   destination in format "[[module:]presenter:]view" or "signal!"
327:      * @param  array|mixed
328:      * @return void
329:      * @throws Nette\Application\AbortException
330:      */
331:     public function redirect($code, $destination = NULL, $args = array())
332:     {
333:         if (!is_numeric($code)) { // first parameter is optional
334:             $args = $destination;
335:             $destination = $code;
336:             $code = NULL;
337:         }
338: 
339:         if (!is_array($args)) {
340:             $args = array_slice(func_get_args(), is_numeric($code) ? 2 : 1);
341:         }
342: 
343:         $presenter = $this->getPresenter();
344:         $presenter->redirectUrl($presenter->createRequest($this, $destination, $args, 'redirect'), $code);
345:     }
346: 
347: 
348:     /********************* interface \ArrayAccess ****************d*g**/
349: 
350: 
351:     /**
352:      * Adds the component to the container.
353:      * @param  string  component name
354:      * @param  Nette\ComponentModel\IComponent
355:      * @return void
356:      */
357:     public function offsetSet($name, $component)
358:     {
359:         $this->addComponent($component, $name);
360:     }
361: 
362: 
363:     /**
364:      * Returns component specified by name. Throws exception if component doesn't exist.
365:      * @param  string  component name
366:      * @return Nette\ComponentModel\IComponent
367:      * @throws Nette\InvalidArgumentException
368:      */
369:     public function offsetGet($name)
370:     {
371:         return $this->getComponent($name, TRUE);
372:     }
373: 
374: 
375:     /**
376:      * Does component specified by name exists?
377:      * @param  string  component name
378:      * @return bool
379:      */
380:     public function offsetExists($name)
381:     {
382:         return $this->getComponent($name, FALSE) !== NULL;
383:     }
384: 
385: 
386:     /**
387:      * Removes component from the container.
388:      * @param  string  component name
389:      * @return void
390:      */
391:     public function offsetUnset($name)
392:     {
393:         $component = $this->getComponent($name, FALSE);
394:         if ($component !== NULL) {
395:             $this->removeComponent($component);
396:         }
397:     }
398: 
399: }
400: