From f4d12bf72a943d6a8965f21a11eefbb05d2a5483 Mon Sep 17 00:00:00 2001 From: Eole Date: Wed, 27 Apr 2016 22:52:25 +0200 Subject: Add Documentation --- server/doc/classes/errorManagement.html | 560 ++++++++++++++++++++++++++++++++ 1 file changed, 560 insertions(+) create mode 100644 server/doc/classes/errorManagement.html (limited to 'server/doc/classes/errorManagement.html') diff --git a/server/doc/classes/errorManagement.html b/server/doc/classes/errorManagement.html new file mode 100644 index 0000000..ca73563 --- /dev/null +++ b/server/doc/classes/errorManagement.html @@ -0,0 +1,560 @@ + + + + + + API Documentation + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+ + + + API Documentation + +
+ +
+
+
+ + + +
+ +
+
+
+
+
+
+ + \ +
+
+
+ + + +
+
+
+
+ +
+
+
+
+
+
+ + + +

\errorManagement

+

errorManagement Class of the back-end application

+

Management of error

+ + +
+

Summary

+
+
+ Methods +
+
+ Properties +
+
+ Constants +
+
+
+
+ __construct()
+ BaseErrorHandler()
+ BadResponseHandler()
+ NotImplementedHandler()
+ UserInputHandler()
+ OtherException()
+
+
+ No public properties found +
+
+ No constants found +
+
+
+
+ No protected methods found +
+
+ $app
+
+
+ N/A +
+
+
+
+ No private methods found +
+
+ No private properties found +
+
+ N/A +
+
+
+
+ +
+ + + +
+
+

Properties

+
+ +
+ +
+
+ +
+

$app

+ 
$app : \App
+

+ + +

Type

+ \App + — protected, contains the main app object
+
+ +
+ + + +
+

Methods

+ +
+ +
+
+ +
+

__construct()

+ + 
__construct(\App  $args) : \ErrorManagement
+

ErrorManagemement constructor

+ + +

Parameters

+ + + + + + +
\App$args

the main app object

+ + +

Returns

+ \ErrorManagement + —

Object

+ +
+
+ +
+ +
+
+ +
+

BaseErrorHandler()

+ + 
BaseErrorHandler(\Exception  $error) : void
+

Put an error message corresponding to a base error in the output

+ + +

Parameters

+ + + + + + +
\Exception$error

the exception triggered

+ + + +
+
+ +
+ +
+
+ +
+

BadResponseHandler()

+ + 
BadResponseHandler(\Exception  $error) : void
+

Put an error message corresponding to a bad response in function of the status code in the output

+ + +

Parameters

+ + + + + + +
\Exception$error

the exception triggered

+ + + +
+
+ +
+ +
+
+ +
+

NotImplementedHandler()

+ + 
NotImplementedHandler(\Exception  $error) : void
+

Put an error message corresponding to a not implemented yet error in the output

+ + +

Parameters

+ + + + + + +
\Exception$error

the exception triggered

+ + + +
+
+ +
+ +
+
+ +
+

UserInputHandler()

+ + 
UserInputHandler(\Exception  $error) : void
+

Put an error message corresponding to a user input error in the output

+ + +

Parameters

+ + + + + + +
\Exception$error

the exception triggered

+ + + +
+
+ +
+ +
+
+ +
+

OtherException()

+ + 
OtherException(\Exception  $error) : void
+

Put an error message corresponding to an other error in the output

+ + +

Parameters

+ + + + + + +
\Exception$error

the exception triggered

+ + + +
+
+ +
+ +
+
+ + + + +
+ + + -- cgit v1.2.3