1<?php 2 3namespace dokuwiki\Action\Exception; 4 5/** 6 * Class ActionException 7 * 8 * This exception and its subclasses signal that the current action should be 9 * aborted and a different action should be used instead. The new action can 10 * be given as parameter in the constructor. Defaults to 'show' 11 * 12 * The message will NOT be shown to the enduser 13 * 14 * @package dokuwiki\Action\Exception 15 */ 16class ActionException extends \Exception 17{ 18 19 /** @var string the new action */ 20 protected $newaction; 21 22 /** @var bool should the exception's message be shown to the user? */ 23 protected $displayToUser = false; 24 25 /** 26 * ActionException constructor. 27 * 28 * When no new action is given 'show' is assumed. For requests that originated in a POST, 29 * a 'redirect' is used which will cause a redirect to the 'show' action. 30 * 31 * @param string|null $newaction the action that should be used next 32 * @param string $message optional message, will not be shown except for some dub classes 33 */ 34 public function __construct($newaction = null, $message = '') { 35 global $INPUT; 36 parent::__construct($message); 37 if(is_null($newaction)) { 38 if(strtolower($INPUT->server->str('REQUEST_METHOD')) == 'post') { 39 $newaction = 'redirect'; 40 } else { 41 $newaction = 'show'; 42 } 43 } 44 45 $this->newaction = $newaction; 46 } 47 48 /** 49 * Returns the action to use next 50 * 51 * @return string 52 */ 53 public function getNewAction() { 54 return $this->newaction; 55 } 56 57 /** 58 * Should this Exception's message be shown to the user? 59 * 60 * @param null|bool $set when null is given, the current setting is not changed 61 * @return bool 62 */ 63 public function displayToUser($set = null) { 64 if(!is_null($set)) $this->displayToUser = $set; 65 return $set; 66 } 67} 68