extern/egroupware
1
0
Fork 1
mirror of https://github.com/EGroupware/egroupware.git synced 2024-10-06 02:02:24 +02:00
Code Issues Packages Projects Releases Wiki Activity

"docu update: which exceptions should give translated messages ready to display to the user and which dont need to"

Browse Source
This commit is contained in:
Ralf Becker 2007-12-09 07:38:52 +00:00
parent 6994cc27c1
commit 6a91f65335
1 changed files with 7 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
phpgwapi/inc/class.egw_exception.inc.php
View File

@ -19,6 +19,10 @@
* eGroupWare API - Exceptions
*
* All eGroupWare exceptions should extended this class, so we are able to eg. add some logging later.
*
* The messages for most exceptions should be translated and ready to be displayed to the user.
* Only exception to this are exceptions like egw_exception_assertion_fails, egw_exception_wrong_parameter
* or egw_exception_db, which are suppost to happen only during program development.
*/
class egw_exception extends Exception
{
@ -115,17 +119,19 @@ class egw_exception_not_found extends egw_exception
/**
* An necessary assumption the developer made failed, regular execution can not continue
*
* As you get this only by an error in the code or during development, the message does not need to be translated
*/
class egw_exception_assertion_failed extends egw_exception { }
/**
* A method or function was called with a wrong or missing parameter
*
* As you get this only by an error in the code or during development, the message does not need to be translated
*/
class egw_exception_wrong_parameter extends egw_exception_assertion_failed { }
/**
* Wrong or missing required user input
* Wrong or missing required user input: message should be translated so it can be shown directly to the user
*
*/
class egw_exception_wrong_userinput extends egw_exception_assertion_failed { }