From 19d84e2ae4c6710aac2236df4f135409ef519fc8 Mon Sep 17 00:00:00 2001
From: Yoggzo <yogg@epsina.com>
Date: Sun, 27 Mar 2016 19:40:36 +0200
Subject: [PATCH] Update commentaries
---
server/core/Automating.php | 15 ++++++---
server/core/ErrorManagement.php | 55 +++++++++++++++++++++++++++++++--
server/core/Image.php | 4 +--
3 files changed, 64 insertions(+), 10 deletions(-)
diff --git a/server/core/Automating.php b/server/core/Automating.php
index 2665541..065cf5e 100644
--- a/server/core/Automating.php
+++ b/server/core/Automating.php
@@ -1,11 +1,11 @@
<?php
/**
-* File containing the Image Class.
+* File containing the Automating Class.
*
* @version 1.0 Initialisation of this file
* @since 1.0 Core application's file
*
-* @author Yogg 'yogg at epsina . com'
+* @author Evan Pisani 'yogg at epsina . com'
*
* @todo Complete the functions with errors detection and finish the descriptions
*/
@@ -48,7 +48,13 @@ class automating implements Core{
$this->{$action.""}();
}
-
+ /**
+ * Create a new image on a new server
+ *
+ * @param $error the error triggered
+ *
+ * @return Image the new image created
+ */
private function createImageOnNewServer(){
try{
$image = new Image($this->app);
@@ -87,9 +93,8 @@ class automating implements Core{
}catch(Exception $e){
$this->app->getErrorInstance()->OtherException($e);
}
+ $this->app->setOutput("Auto", $res);
}
-
-
}
?>
\ No newline at end of file
diff --git a/server/core/ErrorManagement.php b/server/core/ErrorManagement.php
index e7cb83e..be7080b 100755
--- a/server/core/ErrorManagement.php
+++ b/server/core/ErrorManagement.php
@@ -1,4 +1,13 @@
<?php
+/**
+* File containing the Errormanagement Class.
+*
+* @version 1.0 Initialisation of this file
+* @since 1.0 Core application's file
+*
+* @author Eole 'eoledev at outlook . fr', Evan Pisani 'yogg at epsina . com'
+*
+*/
use OpenCloud\Common\Error\BadResponseError;
use OpenCloud\Common\Error\BaseError;
@@ -7,20 +16,40 @@ use OpenCloud\Common\Error\UserInputError;
Class errorManagement{
-
+ /** @var App $app protected, contains the main app object */
protected $app;
-
+ /**
+ * ErrorManagemement constructor
+ *
+ * @param App $app the main app object
+ *
+ * @return ErrorManagement
+ */
public function __construct($args){
$this->app = $args;
}
+ /**
+ * Put an error message corresponding to a base error in the output
+ *
+ * @param $error the error triggered
+ *
+ * @return String BaseError message
+ */
public function BaseErrorHandler($error){
$this->app->setOutput("Error", "BaseError");
}
+ /**
+ * Put an error message corresponding to a bad response in function of the status code in the output
+ *
+ * @param $error the error triggered
+ *
+ * @return String Error message
+ */
public function BadResponseHandler($error){
$statusCode = $error->getResponse()->getStatusCode();
switch ($statusCode) {
@@ -54,19 +83,39 @@ Class errorManagement{
}
}
+ /**
+ * Put an error message corresponding to a not implemented yet error in the output
+ *
+ * @param $error the error triggered
+ *
+ * @return String internal error message
+ */
public function NotImplementedHandler($error){
$this->app->setOutput("Error", "Internal error (not implemented yet), please contact an administrator");
}
+ /**
+ * Put an error message corresponding to a user input error in the output
+ *
+ * @param $error the error triggered
+ *
+ * @return String User input error message
+ */
public function UserInputHandler($error){
$this->app->setOutput("Error", "UserInputError");
}
+ /**
+ * Put an error message corresponding to an other error in the output
+ *
+ * @param $error the error triggered
+ *
+ * @return String error message
+ */
public function OtherException($error){
$this->app->setOutput("Error", $error->getMessage());
}
-
}
?>
diff --git a/server/core/Image.php b/server/core/Image.php
index e9736a2..c595135 100755
--- a/server/core/Image.php
+++ b/server/core/Image.php
@@ -5,7 +5,7 @@
* @version 1.0 Initialisation of this file
* @since 1.0 Core application's file
*
-* @author Yogg 'yogg at epsina . com'
+* @author Evan Pisani 'yogg at epsina . com'
*
* @todo Complete the functions with errors detection and finish the descriptions
*/
@@ -19,7 +19,7 @@ include("CoreInterface.php");
/**
* Image Class of the back-end application
*
-* ADD CLASS DESCRIPTION
+* Management of images
*
*/
class image implements Core{