[#496,#513] Return more specific errors on project deletion.

Since we had to rewrite the delete DAO operation, we did it in PDO
terms, addressing #513 too.

Author: jaragunde

model/dao/ProjectDAO/PostgreSQLProjectDAO.php

@@ -669,27 +669,46 @@ public function create(ProjectVO $projectVO) {
      * This function deletes the data of a Project by its {@link ProjectVO}.
      *
      * @param ProjectVO $projectVO the {@link ProjectVO} with the data we want to delete from database.
-     * @return int the number of rows that have been affected (it should be 1).
-     * @throws {@link SQLQueryErrorException}
+     * @return OperationResult the result {@link OperationResult} with information about operation status
      */
     public function delete(ProjectVO $projectVO) {
-        $affectedRows = 0;
+        $result = new OperationResult(false);
 
-        // Check for a user ID.
-        if($projectVO->getId() >= 0) {
-            $currProjectVO = $this->getById($projectVO->getId());
-        }
+        $sql = "DELETE FROM project WHERE id=:id";
+        try {
+            $statement = $this->pdo->prepare($sql);
+            $statement->bindValue(":id", $projectVO->getId(), PDO::PARAM_INT);
+            $statement->execute();
 
-        // If it exists, then delete.
-        if(sizeof($currProjectVO) > 0) {
-            $sql = "DELETE FROM project WHERE id=".$projectVO->getId();
+            $result->setIsSuccessful(true);
+            $result->setMessage('Project deleted successfully.');
+            $result->setResponseCode(200);
+        }
+        catch (PDOException $ex) {
+            $errorMessage = $ex->getMessage();
+            error_log('Project deletion failed: ' . $errorMessage);
 
-            $res = pg_query($this->connect, $sql);
-            if ($res == NULL) throw new SQLQueryErrorException(pg_last_error());
-                $affectedRows = pg_affected_rows($res);
+            $resultMessage = "Project deletion failed: \n";
+            if(strpos($errorMessage, "Foreign key violation")) {
+                if(strpos($errorMessage, "task")) {
+                    $resultMessage .= "The project has assigned tasks.\n";
+                }
+                else {
+                    // catch-all for any foreign key violations that we may add in the future
+                    $resultMessage .= "There is data associated to the project.\n";
+                }
+            }
+            else {
+                // unpredictable error, just return the native error code and message
+                $resultMessage .= $errorMessage;
+            }
+            $result->setErrorNumber($ex->getCode());
+            $result->setMessage($resultMessage);
+            $result->setIsSuccessful(false);
+            $result->setResponseCode(500);
         }
 
-        return $affectedRows;
+        return $result;
     }
 }
 

model/facade/ProjectsFacade.php

@@ -162,15 +162,11 @@ static function CreateProjects($projects) {
      *  This function is used for deleting a Project.
      *
      * @param ProjectVO $project the Project value object we want to delete.
-     * @return int it just indicates if there was any error (<i>-1</i>) or not (<i>0</i>).
-     * @throws {@link SQLQueryErrorException}
+     * @return OperationResult the result {@link OperationResult} with information about operation status
      */
     static function DeleteProject(ProjectVO $project) {
-
-    $action = new DeleteProjectAction($project);
-
-    return $action->execute();
-
+        $action = new DeleteProjectAction($project);
+        return $action->execute();
     }
 
     /** Delete Projects Function
@@ -179,17 +175,13 @@ static function DeleteProject(ProjectVO $project) {
      *  If an error occurs, it stops deleting.
      *
      * @param array $projects the Project value objects we want to delete.
-     * @return int it just indicates if there was any error (<i>-1</i>) or not (<i>0</i>).
-     * @throws {@link SQLQueryErrorException}
+     * @return array OperationResult the array of results {@link OperationResult} with information about operation status.
      */
     static function DeleteProjects($projects) {
-
-    foreach((array)$projects as $project)
-        if ((ProjectsFacade::DeleteProject($project)) == -1)
-            return -1;
-
-    return 0;
-
+        $operationResults = [];
+        foreach ((array) $projects as $project)
+            $operationResults[] = ProjectsFacade::DeleteProject($project);
+        return $operationResults;
     }
 
     /** Project Users Assigning

model/facade/action/DeleteProjectAction.php

@@ -32,6 +32,7 @@
 include_once(PHPREPORT_ROOT . '/model/facade/action/Action.php');
 include_once(PHPREPORT_ROOT . '/model/dao/DAOFactory.php');
 include_once(PHPREPORT_ROOT . '/model/vo/ProjectVO.php');
+include_once(PHPREPORT_ROOT . '/model/OperationResult.php');
 
 /** Delete Project Action
  *
@@ -68,19 +69,12 @@ public function __construct(ProjectVO $project) {
      *
      * This is the function that contains the code that deletes the Project from persistent storing.
      *
-     * @return int it just indicates if there was any error (<i>-1</i>) or not (<i>0</i>).
+     * @return OperationResult the result {@link OperationResult} with information about operation status
      */
     protected function doExecute() {
-
         $dao = DAOFactory::getProjectDAO();
-
-        if ($dao->delete($this->project)!=1) {
-            return -1;
-        }
-
-        return 0;
+        return $dao->delete($this->project);
     }
-
 }
 
 /*

web/services/deleteProjectsService.php

@@ -99,12 +99,21 @@
 
     }
 
+    $operationResults = ProjectsFacade::DeleteProjects($deleteProjects);
+    $errors = array_filter($operationResults, function ($item) {
+        return (!$item->getIsSuccessful());
+    });
+    if ($errors) {
+        //if multiple failures, let's just return a 500
+        http_response_code(500);
+        $string = "<return service='deleteProjects'><errors>";
+        foreach ($errors as $result) {
+            $string .= "<error id='" . $result->getErrorNumber() . "'>" . $result->getMessage() . "</error>";
+        }
+        $string .= "</errors></return>";
+    }
 
-    if (count($deleteProjects) >= 1)
-        if (ProjectsFacade::DeleteProjects($deleteProjects) == -1)
-            $string = "<return service='deleteProjects'><error id='1'>There was some error while deleting the projects</error></return>";
-
-    if (!$string)
+    if (!isset($string))
         $string = "<return service='deleteProjects'><ok>Operation Success!</ok></return>";