FEAT #25 refactoring status

src/app/status/controllers/StatusController.php

+<?php
+
+/**
+* Copyright Maarch since 2008 under licence GPLv3.
+* See LICENCE.txt file at the root folder for more details.
+* This file is part of Maarch software.
+*
+*/
+
+/**
+* @brief Status Controller
+* @author dev@maarch.org
+* @ingroup core
+*/
+
+namespace Status\controllers;
+
+use History\controllers\HistoryController;
+use Psr\Http\Message\RequestInterface;
+use Psr\Http\Message\ResponseInterface;
+use Respect\Validation\Validator;
+use Status\models\StatusModel;
+use Status\models\StatusImagesModel;
+use Core\Models\ServiceModel;
+
+class StatusController
+{
+    public function getList(RequestInterface $request, ResponseInterface $response)
+    {
+        if (!ServiceModel::hasService(['id' => 'admin_status', 'userId' => $_SESSION['user']['UserId'], 'location' => 'apps', 'type' => 'admin'])) {
+            return $response->withStatus(403)->withJson(['errors' => 'Service forbidden']);
+        }
+
+        return $response->withJson([
+            'statusList' => StatusModel::getList()
+        ]);
+    }
+
+    public function getNewInformations(RequestInterface $request, ResponseInterface $response)
+    {
+        if (!ServiceModel::hasService(['id' => 'admin_status', 'userId' => $_SESSION['user']['UserId'], 'location' => 'apps', 'type' => 'admin'])) {
+            return $response->withStatus(403)->withJson(['errors' => 'Service forbidden']);
+        }
+
+        return $response->withJson([
+            'statusImages' => StatusImagesModel::getStatusImages()
+        ]);
+    }
+
+    public function getByIdentifier(RequestInterface $request, ResponseInterface $response, $aArgs)
+    {
+        if (!ServiceModel::hasService(['id' => 'admin_status', 'userId' => $_SESSION['user']['UserId'], 'location' => 'apps', 'type' => 'admin'])) {
+            return $response->withStatus(403)->withJson(['errors' => 'Service forbidden']);
+        }
+
+        if (!empty($aArgs['identifier']) && Validator::numeric()->validate($aArgs['identifier'])) {
+            $obj = StatusModel::getByIdentifier(['identifier' => $aArgs['identifier']]);
+
+            if (empty($obj)) {
+                return $response->withStatus(404)->withJson(['errors' => 'identifier not found']);
+            }
+
+            return $response->withJson([
+                'status'       => $obj,
+                'statusImages' => StatusImagesModel::getStatusImages(),
+            ]);
+        } else {
+            return $response->withStatus(500)->withJson(['errors' => 'identifier not valid']);
+        }
+    }
+
+    public function create(RequestInterface $request, ResponseInterface $response)
+    {
+        if (!ServiceModel::hasService(['id' => 'admin_status', 'userId' => $_SESSION['user']['UserId'], 'location' => 'apps', 'type' => 'admin'])) {
+            return $response->withStatus(403)->withJson(['errors' => 'Service forbidden']);
+        }
+
+        $request = $request->getParams();
+        $aArgs   = self::manageValue($request);
+        $errors  = $this->control($aArgs, 'create');
+
+        if (!empty($errors)) {
+            return $response->withStatus(500)->withJson(['errors' => $errors]);
+        }
+
+        if (StatusModel::create($aArgs)) {
+            $return['status'] = StatusModel::getById(['id' => $aArgs['id']])[0];
+
+            HistoryController::add([
+                'tableName' => 'status',
+                'recordId'  => $return['status']['id'],
+                'eventType' => 'ADD',
+                'eventId'   => 'statusup',
+                'info'       => _STATUS_ADDED . ' : ' . $return['status']['id']
+            ]);
+
+            return $response->withJson($return);
+        } else {
+            return $response->withStatus(500)->withJson(['errors' => _NOT_CREATE]);
+        }
+    }
+
+    public function update(RequestInterface $request, ResponseInterface $response, $aArgs)
+    {
+        if (!ServiceModel::hasService(['id' => 'admin_status', 'userId' => $_SESSION['user']['UserId'], 'location' => 'apps', 'type' => 'admin'])) {
+            return $response->withStatus(403)->withJson(['errors' => 'Service forbidden']);
+        }
+
+        $request = $request->getParams();
+        $request = array_merge($request, $aArgs);
+
+        $aArgs   = self::manageValue($request);
+        $errors  = $this->control($aArgs, 'update');
+
+        if (!empty($errors)) {
+            return $response->withStatus(500)->withJson(['errors' => $errors]);
+        }
+
+        if (StatusModel::update($aArgs)) {
+            $return['status'] = StatusModel::getByIdentifier(['identifier' => $aArgs['identifier']])[0];
+
+            HistoryController::add([
+                'tableName' => 'status',
+                'recordId'  => $return['status']['id'],
+                'eventType' => 'UP',
+                'eventId'   => 'statusup',
+                'info'       => _MODIFY_STATUS . ' : ' . $return['status']['id']
+            ]);
+            
+            return $response->withJson($return);
+        } else {
+            return $response
+                ->withStatus(500)
+                ->withJson(['errors' => _NOT_UPDATE]);
+        }
+
+    }
+
+    public function delete(RequestInterface $request, ResponseInterface $response, $aArgs)
+    {
+        if (!ServiceModel::hasService(['id' => 'admin_status', 'userId' => $_SESSION['user']['UserId'], 'location' => 'apps', 'type' => 'admin'])) {
+            return $response->withStatus(403)->withJson(['errors' => 'Service forbidden']);
+        }
+
+        $statusDeleted = StatusModel::getByIdentifier(['identifier' => $aArgs['identifier']]);
+
+        if (Validator::notEmpty()->validate($aArgs['identifier']) && Validator::numeric()->validate($aArgs['identifier']) && !empty($statusDeleted)) {
+            
+            StatusModel::delete(['identifier' => $aArgs['identifier']]);
+
+            HistoryController::add([
+                'tableName' => 'status',
+                'recordId'  => $statusDeleted[0]['id'],
+                'eventType' => 'DEL',
+                'eventId'   => 'statusdel',
+                'info'       => _STATUS_DELETED . ' : ' . $statusDeleted[0]['id']
+            ]);
+        } else {
+            return $response
+                ->withStatus(500)
+                ->withJson(['errors' => 'identifier not valid']);
+        }
+
+        return $response->withJson(
+            [
+            'statuses' => StatusModel::getList()
+            ]
+        );
+    }
+
+    protected function manageValue($request)
+    {
+        foreach ($request  as $key => $value) {
+            if (in_array($key, ['is_system', 'is_folder_status', 'can_be_searched', 'can_be_modified'])) {
+                if (empty($value)) {
+                    $request[$key] = 'N';
+                } else {
+                    $request[$key] = 'Y';
+                }
+            }
+        }
+
+        $request['is_system'] = 'N';
+
+        return $request;
+    }
+
+    protected function control($request, $mode)
+    {
+        $errors = [];
+
+        if(!Validator::notEmpty()->validate($request['id'])){
+            array_push($errors, _ID . ' ' . _EMPTY);
+        } else if ($mode == 'create') {
+            $obj = StatusModel::getById(['id' => $request['id']]);
+
+            if (!empty($obj)) {
+                array_push(
+                    $errors,
+                    _ID . ' ' . $obj[0]['id'] . ' ' . _ALREADY_EXISTS
+                );
+            }
+        } elseif ($mode == 'update') {
+            $obj = StatusModel::getByIdentifier(['identifier' => $request['identifier']]);
+            
+            if (empty($obj)) {
+                array_push(
+                    $errors,
+                    $request['identifier'] . ' ' . _NOT_EXISTS
+                );
+            }
+        }
+
+        if (!Validator::regex('/^[\w.-]*$/')->validate($request['id']) ||
+            !Validator::length(1, 10)->validate($request['id']) ||
+            !Validator::notEmpty()->validate($request['id'])) {
+            array_push($errors, _ID . ' ' . _INVALID);
+        }
+
+        if (!Validator::notEmpty()->validate($request['label_status']) ||
+            !Validator::length(1, 50)->validate($request['label_status'])) {
+            array_push($errors, _DESCRIPTION . ' ' . _INVALID);
+        }
+
+        if (Validator::notEmpty()->validate($request['is_system']) &&
+            !Validator::contains('Y')->validate($request['is_system']) &&
+            !Validator::contains('N')->validate($request['is_system'])
+        ) {
+            array_push($errors, 'is_system ' . _INVALID);
+        }
+
+        if (Validator::notEmpty()->validate($request['is_folder_status']) &&
+            !Validator::contains('Y')->validate($request['is_folder_status']) &&
+            !Validator::contains('N')->validate($request['is_folder_status'])
+        ) {
+            array_push($errors, _IS_FOLDER_STATUS . ' ' . _INVALID);
+        }
+
+        if (!Validator::notEmpty()->validate($request['img_filename']) ||
+            !Validator::length(1, 255)->validate($request['img_filename'])
+        ) {
+            array_push($errors, _IMG_RELATED . ' ' . _INVALID);
+        }
+
+        if (Validator::notEmpty()->validate($request['maarch_module']) &&
+            !Validator::length(null, 255)->validate($request['maarch_module'])
+        ) {
+            array_push($errors, 'maarch_module ' . _INVALID);
+        }
+
+        if (Validator::notEmpty()->validate($request['can_be_searched']) &&
+            !Validator::contains('Y')->validate($request['can_be_searched']) &&
+            !Validator::contains('N')->validate($request['can_be_searched'])
+        ) {
+            array_push($errors, _CAN_BE_SEARCHED . ' ' . _INVALID);
+        }
+
+        if (Validator::notEmpty()->validate($request['can_be_modified']) &&
+            !Validator::contains('Y')->validate($request['can_be_modified']) &&
+            !Validator::contains('N')->validate($request['can_be_modified'])
+        ) {
+            array_push($errors, _CAN_BE_MODIFIED . ' ' . _INVALID);
+        }
+
+        return $errors;
+    }
+}

src/app/status/models/StatusImagesModel.php

+<?php
+
+/**
+* Copyright Maarch since 2008 under licence GPLv3.
+* See LICENCE.txt file at the root folder for more details.
+* This file is part of Maarch software.
+*
+*/
+
+/**
+* @brief Status Images Model
+* @author dev@maarch.org
+* @ingroup core
+*/
+
+namespace Status\models;
+
+class StatusImagesModel extends StatusImagesModelAbstract
+{
+    // Do your stuff in this class
+}

src/app/status/models/StatusImagesModelAbstract.php

+<?php
+
+/**
+* Copyright Maarch since 2008 under licence GPLv3.
+* See LICENCE.txt file at the root folder for more details.
+* This file is part of Maarch software.
+*
+*/
+
+/**
+* @brief Status Images Model
+* @author dev@maarch.org
+* @ingroup core
+*/
+
+namespace Status\models;
+
+use Core\Models\DatabaseModel;
+use Core\Models\ValidatorModel;
+
+class StatusImagesModelAbstract
+{
+    public static function getStatusImages(array $aArgs = [])
+    {
+        $aReturn = DatabaseModel::select([
+            'select'    => empty($aArgs['select']) ? ['*'] : $aArgs['select'],
+            'table'     => ['status_images'],
+            'order_by'  => ['id']
+        ]);
+
+        return $aReturn;
+    }
+}

src/app/status/models/StatusModel.php

+<?php
+
+/**
+* Copyright Maarch since 2008 under licence GPLv3.
+* See LICENCE.txt file at the root folder for more details.
+* This file is part of Maarch software.
+*
+*/
+
+/**
+* @brief Status Model
+* @author dev@maarch.org
+* @ingroup core
+*/
+
+namespace Status\models;
+
+class StatusModel extends StatusModelAbstract
+{
+    // Do your stuff in this class
+}

src/app/status/models/StatusModelAbstract.php

+<?php
+
+/**
+* Copyright Maarch since 2008 under licence GPLv3.
+* See LICENCE.txt file at the root folder for more details.
+* This file is part of Maarch software.
+*
+*/
+
+/**
+* @brief Status Model
+* @author dev@maarch.org
+* @ingroup core
+*/
+
+namespace Status\models;
+
+use Core\Models\DatabaseModel;
+use Core\Models\ValidatorModel;
+
+class StatusModelAbstract
+{
+    public static function getList()
+    {
+        $aReturn = DatabaseModel::select([
+            'select'    => empty($aArgs['select']) ? ['*'] : $aArgs['select'],
+            'table'     => ['status'],
+            'order_by'  => ['identifier']
+        ]);
+
+        return $aReturn;
+    }
+
+    public static function getById(array $aArgs = [])
+    {
+        ValidatorModel::notEmpty($aArgs, ['id']);
+        ValidatorModel::stringType($aArgs, ['id']);
+
+        $aReturn = DatabaseModel::select([
+            'select'    => empty($aArgs['select']) ? ['*'] : $aArgs['select'],
+            'table'     => ['status'],
+            'where'     => ['id = ?'],
+            'data'      => [$aArgs['id']]
+        ]);
+
+        return $aReturn;
+    }
+
+    public static function getByIdentifier(array $aArgs = [])
+    {
+        ValidatorModel::notEmpty($aArgs, ['identifier']);
+        ValidatorModel::intVal($aArgs, ['identifier']);
+
+        $aReturn = DatabaseModel::select([
+            'select'    => empty($aArgs['select']) ? ['*'] : $aArgs['select'],
+            'table'     => ['status'],
+            'where'     => ['identifier = ?'],
+            'data'      => [$aArgs['identifier']]
+        ]);
+
+        return $aReturn;
+    }
+
+    public static function create(array $aArgs = [])
+    {
+        ValidatorModel::notEmpty($aArgs, ['id', 'label_status']);
+        ValidatorModel::stringType($aArgs, ['id', 'label_status']);
+
+        $aReturn = DatabaseModel::insert([
+            'table'         => 'status',
+            'columnsValues' => $aArgs
+            ]);
+
+        return $aReturn;
+    }
+
+    public static function update(array $aArgs = [])
+    {
+        ValidatorModel::notEmpty($aArgs, ['label_status', 'identifier']);
+        ValidatorModel::intVal($aArgs, ['identifier']);
+
+        $where['identifier'] = $aArgs['identifier'];
+        unset($aArgs['id']);
+        unset($aArgs['identifier']);
+
+        $aReturn = DatabaseModel::update([
+            'table' => 'status',
+            'set'   => $aArgs,
+            'where' => ['identifier = ?'],
+            'data'  => [$where['identifier']]
+        ]);
+
+        return $aReturn;
+    }
+
+    public static function delete(array $aArgs = [])
+    {
+        ValidatorModel::notEmpty($aArgs, ['identifier']);
+        ValidatorModel::intVal($aArgs, ['identifier']);
+
+        $aReturn = DatabaseModel::delete([
+                'table' => 'status',
+                'where' => ['identifier = ?'],
+                'data'  => [$aArgs['identifier']]
+            ]);
+
+        return $aReturn;
+    }
+
+}