Class AdmException

Exception implements Throwable

AdmException

Copyright: 2004-2016 The Admidio Team
License: GNU General Public License v2.0 only **********************************************************************************************
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

Class: AdmException
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

Par: Example
Located at admexception.php

Methods summary

`public`	# `__construct( string $message, string $param1 = '', string $param2 = '', string $param3 = '', string $param4 = '' )` Constructor that will @b rollback an open database translation Constructor that will @b rollback an open database translation Parameters `$message` Translation @b id that should be shown when exception is catched `$param1` Optional parameter for language string of translation id `$param2` Another optional parameter for language string of translation id `$param3` Another optional parameter for language string of translation id `$param4` Another optional parameter for language string of translation id Overrides `Exception::__construct`
`public string`	# `getText( )` Simply return the plain translated error text without any markup. Simply return the plain translated error text without any markup. Returns string Returns only a string with the exception text
`public`	# `setNewMessage( string $message, string $param1 = '', string $param2 = '', string $param3 = '', string $param4 = '' )` 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. 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. Parameters `$message` Translation @b id that should be shown when exception is catched `$param1` Optional parameter for language string of translation id `$param2` Another optional parameter for language string of translation id `$param3` Another optional parameter for language string of translation id `$param4` Another optional parameter for language string of translation id
`public`	# `showHtml( )` Show html message window with translated message Show html message window with translated message
`public`	# `showText( )` Simply return the plain translated error text without any markup and stop the script. Simply return the plain translated error text without any markup and stop the script.

Methods inherited from Exception

__toString(), __wakeup(), getCode(), getFile(), getLine(), getMessage(), getPrevious(), getTrace(), getTraceAsString()

Properties summary

`protected`	`$param1`	#
`protected`	`$param2`	#
`protected`	`$param3`	#
`protected`	`$param4`	#

Properties inherited from Exception

$code, $file, $line, $message

Packages

Classes

Exceptions

Functions

Class AdmException

Methods summary

Parameters

Overrides

Returns

Parameters

Methods inherited from Exception

Properties summary

Properties inherited from Exception