Products::validatePagination() - Code Metrics - Inspection of "Reducing lines of code in products functions :art:" - MuriloChianfa/Redstore-Microservice-Based - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — master ( eebb3c...073ade )

by Murilo
created 2021-12-19 18:22 UTC
Products::validatePagination() A

↳ Parent: Products
Complexity

Conditions	3
Paths	2
Size

Total Lines	8
Code Lines	4
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
eloc	4
c	0
b	0
f	0
dl	0
loc	8
rs	10
cc	3
nc	2
nop	1
<?php

namespace Source\Controllers;

use stdClass;
use Source\Core\Request;
use Source\Core\Response;
use Source\Models\Product;
use Source\Models\ProductImage;
use Source\Models\Category;

class Products
{
    /**
     * @var \stdClass $Message
     */
    private $Message;

    /**
     * @var Request $Request
     */
    private $Request;

    /**
     * @var array $validExtensions
     */
    private $validExtensions = [
        'image/jpeg',
        'image/jpg',
        'image/png'
    ];

    /**
     * Products model constructor...
     */
    public function __construct()
    {
        $this->Message = new stdClass();
        $this->Request = new Request();
    }

    /**
     * GET the list of all products
     *
     * @param array|null $data Receive the current page and limit of then
     * @return void
     */
    public function products($data): void
    {
        $Product = new Product();

        $data = filter_var_array($data, FILTER_SANITIZE_STRIPPED);
        $data = filter_var_array(/** @scrutinizer ignore-type */ $data, FILTER_SANITIZE_STRIPPED);

        $this->allProductsWithoutFilters($data);
        $this->validatePagination($data);

        $page = filter_var($data['page'], FILTER_VALIDATE_INT);
        $limit = filter_var($data['limit'], FILTER_VALIDATE_INT);

        $this->validateOrderAndDirection($data);

        if (is_null(($products = $Product->findAll($limit, ($page * $limit) - $limit)))) {
            (new Response())->setStatusCode(HTTP_NO_CONTENT)->send($this->Message);
        }

        $this->Message->message = $products;
        $this->Message->count = $Product->coluntAllAvailableProducts();

        (new Response())->setStatusCode(HTTP_OK)->send($this->Message);
    }

    /**
     * GET one single product
     *
     * @param array $data
     * @return void
     */
    public function product($data)
    {
        $data = filter_var_array($data, FILTER_SANITIZE_STRIPPED);

        $id = $this->validateSingleProductId($data);

        $Product = new Product();

        if (is_null(($product = $Product->findByProductId($id)))) {
            (new Response())->setStatusCode(HTTP_NO_CONTENT)->send($this->Message);
        }

        $this->Message->message = $product->data();

        (new Response())->setStatusCode(HTTP_OK)->send($this->Message);
    }

    /**
     * POST insert a new product
     *
     * @param array $data
     * @return void
     */
    public function addProduct($data)
    {
        (new Auth())->validateLogin();

        $Product = new Product();

        foreach ($Product->getRequired() as $required) {
            if (!isset($data[$required])) {
                $this->Message->message = "parâmetro '{$required}' é requerido";
                (new Response())->setStatusCode(HTTP_BAD_REQUEST)->send($this->Message);
                return;
            }
        }

        $data = filter_var_array($data, FILTER_SANITIZE_STRIPPED);

        $name = filter_var(trim($data["name"]), FILTER_SANITIZE_FULL_SPECIAL_CHARS);

        $value = filter_var($data["value"], FILTER_VALIDATE_FLOAT);
        $description = filter_var(trim($data["description"]), FILTER_SANITIZE_FULL_SPECIAL_CHARS);
        $available = filter_var($data["available"], FILTER_VALIDATE_INT);
        $product_type_id = filter_var($data["product_type_id"], FILTER_VALIDATE_INT);

        if (!$value || !$available || !$product_type_id || empty($name) || empty($description)) {
            $this->Message->message = 'parâmetro inválido';
            (new Response())->setStatusCode(HTTP_BAD_REQUEST)->send($this->Message);
        }

        $Category = new Category();

        if (is_null($Category->findById($product_type_id, 'id'))) {
            $this->Message->message = 'esta categoria não existe';
            (new Response())->setStatusCode(HTTP_BAD_REQUEST)->send($this->Message);
        }

        $Product = new Product();

        /** Criar produto */
        $Product->name = $name;
        $Product->value = $value;
        $Product->description = $description;
        $Product->available = $available;
        $Product->product_type_id = $product_type_id;

        if (!$Product->save()) {
            $this->Message->message = $Product->message();
            (new Response())->setStatusCode(HTTP_OK)->send($this->Message);
        }

        $this->Message->message = 'Produto adicionado com sucesso';
        (new Response())->setStatusCode(HTTP_OK)->send($this->Message);
    }

    /**
     * POST insert a new product image to one product
     *
     * @param array $data
     * @return void
     */
    public function addProductImage($data)
    {
        (new Auth())->validateLogin();

        $data = filter_var_array($data, FILTER_SANITIZE_STRIPPED);

        $Product = $this->validateProductId($data);

        $ProductImage = new ProductImage();
        $imageName = md5(date('Y-m-dH:i:s', time()));

        $base64Image = $this->validateImageUpload($data);

        error_log($Product->id);
        error_log($imageName);
        // error_log($base64Image);

        $ProductImage->product_id = $Product->id;
        $ProductImage->url_slug = $imageName;
        $ProductImage->image = $base64Image;

        if (!$ProductImage->save()) {
            $this->Message->message = $ProductImage->message();
            (new Response())->setStatusCode(HTTP_OK)->send($this->Message);
        }

        $this->Message->message = 'Imagem adicionada com sucesso';
        (new Response())->setStatusCode(HTTP_OK)->send($this->Message);
    }

    /**
     * DELETE delete one product image by id
     *
     * @param array $data
     * @return void
     */
    public function deleteProductImage($data)
    {
        (new Auth())->validateLogin();

        $data = filter_var_array($data, FILTER_SANITIZE_STRIPPED);

        $ProductImage = new ProductImage();

        if (!isset($data['id']) || !filter_var($data['id'], FILTER_VALIDATE_INT)) {
            $this->Message->message = 'ID da imagem invalida';
            (new Response())->setStatusCode(HTTP_BAD_REQUEST)->send($this->Message);
        }

        $id = (int) $data['id'];

        if (is_null($ProductImage->findById($id, 'id'))) {
            $this->Message->message = 'Imagem nao encontrada';
            (new Response())->setStatusCode(HTTP_BAD_REQUEST)->send($this->Message);
        }

        if (!$ProductImage->delete('id', $id)) {
            $this->Message->message = $ProductImage->message();
            (new Response())->setStatusCode(HTTP_OK)->send($this->Message);
        }

        (new Response())->setStatusCode(HTTP_OK)->send($this->Message);
    }

    public function alterProduct($data)
    {
        (new Auth())->validateLogin();

        $Product = new Product();

        $data = filter_var_array($data, FILTER_SANITIZE_STRIPPED);

        $id = $this->validateSingleProductId($data);

        if (is_null(($Product = $Product->findById($id, '*')))) {
            $this->Message->message = 'este produto não foi encontrado';
            (new Response())->setStatusCode(HTTP_BAD_REQUEST)->send($this->Message);
        }

        $productData = &$Product->data();

        $fields = [
            'name' => FILTER_SANITIZE_FULL_SPECIAL_CHARS,

            'value' => FILTER_VALIDATE_FLOAT,
            'description' => FILTER_SANITIZE_FULL_SPECIAL_CHARS,
            'available' => FILTER_VALIDATE_INT
        ];

        foreach ($fields as $key => $filter) {
            if (!isset($data[$key])) {
                continue;
            }

            $$key = filter_var(trim($data[$key]), $filter);

            if (!$$key) {
                $this->Message->message = "Parâmetro {$key} inválido!";
                (new Response())->setStatusCode(HTTP_BAD_REQUEST)->send($this->Message);
            }

            $productData->$key = $$key;
        }

        if (isset($data["product_type_id"])) {
            $product_type_id = filter_var($data["product_type_id"], FILTER_VALIDATE_INT);

            if (!$product_type_id) {
                $this->Message->message = 'parâmetro inválido';
                (new Response())->setStatusCode(HTTP_BAD_REQUEST)->send($this->Message);
            }

            $Category = new Category();

            if (is_null($Category->findById($product_type_id, 'id'))) {
                $this->Message->message = 'esta categoria não existe';
                (new Response())->setStatusCode(HTTP_BAD_REQUEST)->send($this->Message);
            }

            $productData->product_type_id = $product_type_id;
        }

        if (!$Product->save()) {
            $this->Message->message = $Product->message();
            (new Response())->setStatusCode(HTTP_OK)->send($this->Message);
        }

        $this->Message->message = 'Produto atualizado com sucesso';
        (new Response())->setStatusCode(HTTP_OK)->send($this->Message);
    }

    private function validateSingleProductId($data)
    {
        if (empty($data['id'])) {
            $this->Message->message = 'ID do produto inválido';
            (new Response())->setStatusCode(HTTP_BAD_REQUEST)->send($this->Message);
        }
    
        $id = filter_var($data['id'], FILTER_VALIDATE_INT);

        if (!$id) {
            $this->Message->message = 'parâmetro inválido';
            (new Response())->setStatusCode(HTTP_BAD_REQUEST)->send($this->Message);
        }

        return $id;
    }

    private function validateProductId($data)
    {
        if (!isset($data['id'])) {
            $this->Message->message = 'Id do produto inválido!';
            (new Response())->setStatusCode(HTTP_BAD_REQUEST)->send($this->Message);
        }

        $id = filter_var($data["id"], FILTER_VALIDATE_INT);

        if (!$id) {
            $this->Message->message = 'Id do produto inválido!';
            (new Response())->setStatusCode(HTTP_BAD_REQUEST)->send($this->Message);
        }

        $Product = new Product();
        $Product = $Product->findById($id, 'id');
        
        if (is_null($Product)) {
            $this->Message->message = 'Produto não encontrado!';
            (new Response())->setStatusCode(HTTP_BAD_REQUEST)->send($this->Message);
        }

        return $Product;
    }

    private function allProductsWithoutFilters($data)
    {
        if (!empty($data)) {
            return; 
        }

        if (is_null(($products = $Product->findAll()))) {

            (new Response())->setStatusCode(HTTP_NO_CONTENT)->send($this->Message);
        }

        $this->Message->message = $products;
        (new Response())->setStatusCode(HTTP_OK)->send($this->Message);
    }

    private function validatePagination($data)
    {
        if (!isset($data['page']) || !isset($data['limit'])) {
            $this->Message->message = [
                'message' => 'Missing page or limit argument'
            ];

            (new Response())->setStatusCode(HTTP_BAD_REQUEST)->send($this->Message);
        }
    }

    private function validateOrderAndDirection($data)
    {
        if (!isset($data['order']) || !isset($data['direction'])) {
            return;
        }

        $page = filter_var($data['page'], FILTER_VALIDATE_INT);
        $limit = filter_var($data['limit'], FILTER_VALIDATE_INT);

        $find = $this->validateSearchFilters($data);

        $find = $find->order($data['order'] . ' ' . $data['direction']);
        $find = $find->limit($limit);
        $find = $find->offset(($page * $limit) - $limit);
        $products = $find->fetch(true);

        if (empty($products)) {
            (new Response())->setStatusCode(HTTP_NO_CONTENT)->send($this->Message);
        }

        foreach ($products as $key => $value) {
            $products[$key] = $value->data();

            $products[$key]->category = (new Category())->findById((int) $products[$key]->product_type_id)->data();
            $products[$key]->ProductImage = (new ProductImage())->findAllByProductId((int) $products[$key]->id);
        }

        $this->Message->message = $products;
        (new Response())->setStatusCode(HTTP_OK)->send($this->Message);
    }

    private function validateSearchFilters($data)
    {
        $Product = new Product();

        if (empty($data['filterColumn'])) {
            return $Product->find();
        }
        
        if (empty($data['selfId'])) {
            return $Product->find("{$data['filterColumn']} = {$data['filterValue']}");
        }

        return $Product->find("{$data['filterColumn']} = {$data['filterValue']} AND id != {$data['selfId']}");
    }

    private function validateImageUpload($data)
    {
        if (empty($data['image'])) {
            $this->Message->message = 'imagem nao encontrada';
            (new Response())->setStatusCode(HTTP_BAD_REQUEST)->send($this->Message);
        }

        $base64Image = $data['image'];

        try {
            $base64 = getimagesizefromstring(base64_decode(explode(',', $base64Image)[1]));
        } catch (\Exception $e) {
            $this->Message->message = 'imagem invalida';
            (new Response())->setStatusCode(HTTP_BAD_REQUEST)->send($this->Message);
        }

        if (!$base64) {

            $this->Message->message = 'imagem invalida';
            (new Response())->setStatusCode(HTTP_BAD_REQUEST)->send($this->Message);
        }

        if (!empty($base64[0]) && !empty($base64[0]) && !empty($base64['mime'])) {
            if (!in_array($base64['mime'], $this->validExtensions)) {
                $this->Message->message = 'tipo de imagem invalida';
                (new Response())->setStatusCode(HTTP_BAD_REQUEST)->send($this->Message);
            }
        }

        return $base64Image;
    }
}

MuriloChianfa / Redstore-Microservice-Based

Push — master ( eebb3c...073ade )

Products::validatePagination() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
