1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 <?php
/**
***********************************************************************************************
* @copyright 2004-2016 The Admidio Team
* @see http://www.admidio.org/
* @license https://www.gnu.org/licenses/gpl-2.0.html GNU General Public License v2.0 only
***********************************************************************************************
*/
/**
* @class AdmException
* @brief Admidio specific enhancements of the exception class
*
* This class extends the default PHP exception class with an Admidio specific
* output. The exception get's a language string as parameter and returns a
* html or plain text message with the translated error if an exception is thrown
*
* @par Example
* @code try
* {
* if($bla == 1)
* {
* throw new AdmException(LST_NOT_VALID_DATE_FORMAT);
* }
* ..
*
* }
* catch(AdmException $e)
* {
* // show html message
* $e->showHtml();
*
* // show simply text message
* $e->showText();
* } @endcode
*/
class AdmException extends Exception
{
protected $param1;
protected $param2;
protected $param3;
protected $param4;
/**
* Constructor that will @b rollback an open database translation
* @param string $message Translation @b id that should be shown when exception is catched
* @param string $param1 Optional parameter for language string of translation id
* @param string $param2 Another optional parameter for language string of translation id
* @param string $param3 Another optional parameter for language string of translation id
* @param string $param4 Another optional parameter for language string of translation id
*/
public function __construct($message, $param1 = '', $param2 = '', $param3 = '', $param4 = '')
{
global $gDb;
if(is_object($gDb))
{
$gDb->endTransaction();
}
// save param in class parameters
$this->param1 = $param1;
$this->param2 = $param2;
$this->param3 = $param3;
$this->param4 = $param4;
// sicherstellen, dass alles korrekt zugewiesen wird
parent::__construct($message, 0);
}
/**
* Simply return the plain translated error text without any markup.
* @return string Returns only a string with the exception text
*/
public function getText()
{
global $gL10n;
// if text is a translation-id then translate it
if(strpos($this->message, '_') === 3)
{
return $gL10n->get($this->message, $this->param1, $this->param2, $this->param3, $this->param4);
}
return $this->message;
}
/**
* Set a new Admidio message id with their parameters. This method should be used
* if during the exception processing a new better message should be set.
* @param string $message Translation @b id that should be shown when exception is catched
* @param string $param1 Optional parameter for language string of translation id
* @param string $param2 Another optional parameter for language string of translation id
* @param string $param3 Another optional parameter for language string of translation id
* @param string $param4 Another optional parameter for language string of translation id
*/
public function setNewMessage($message, $param1 = '', $param2 = '', $param3 = '', $param4 = '')
{
$this->message = $message;
// save param in class parameters
$this->param1 = $param1;
$this->param2 = $param2;
$this->param3 = $param3;
$this->param4 = $param4;
}
/**
* Show html message window with translated message
*/
public function showHtml()
{
global $gMessage;
// display database error to user
if(is_object($gMessage))
{
$gMessage->show($this->getText());
// => EXIT
}
else
{
echo $this->getText();
exit();
}
}
/**
* Simply return the plain translated error text without any markup and stop the script.
*/
public function showText()
{
echo $this->getText();
exit();
}
}