refatorando-condicionais.md

Refatorando Condicionais: função switch.

Nesse caso do uso indevido da função switch, pode ser refatorada sem mesmo usar condicionais.

Em meio aos códigos legados de um projeto que trabalho encontrei esse fragmento de código:

<?php

function status($statusId)
{
    switch ($statusId) {
        case "1":$statusName = "Aprovado";
            break;
        case "2":$statusName = "Aguardando Pagto";
            break;
        case "3":$statusName = "Em Analise";
            break;
        case "4":$statusName = "Rejeitado";
            break;
        case "5":$statusName = "Devolvido";
            break;
        case "6":$statusName = "Cancelado";
            break;
        case "3":$statusName = "Bloqueado";
            break;
    }
    return $statusName;
}

O switch pode ser substituído tranquilamente por um simples array. :)

<?php

function status($statusId)
{
    $statusName = [
        1 => "Aprovado",
        2 => "Aguardando Pagto",
        3 => "Em Analise",
        4 => "Rejeitado",
        5 => "Devolvido",
        6 => "Cancelado",
        3 => "Bloqueado",
    ];

    return $statusName[$statusId];
}

Além de diminuir a quantia de código fica de fácil leitura.

Atualização

• Uso de constantes nos valores de string, para não delegar para a função o valor em si, somente a funcionalidade de retornar o valor conforme o input

<?php declare(strict_types=1);

const STATUS_APPROVAL = 'Aprovado';
const STATUS_WAITING_PAYMENT = 'Aguardando Pagto';
const STATUS_ANALISYS = 'Em Analise';
const STATUS_REJECTED = 'Rejeitado';
const STATUS_RETURNED = 'Devolvido';
const STATUS_CANCELED = 'Cancelado';
const STATUS_BLOCKED = 'Bloqueado';
const STATUS_DEFAULT = 'Não Encontrado';

function status(int $statusId) : string
{
    $statusName = [
        1 => STATUS_APPROVAL,
        2 => STATUS_WAITING_PAYMENT,
        3 => STATUS_ANALISYS,
        4 => STATUS_REJECTED,
        5 => STATUS_RETURNED,
        6 => STATUS_CANCELED,
        7 => STATUS_BLOCKED,
    ];

    if (!array_key_exists($statusId, $statusName)) {
        return STATUS_DEFAULT;
    }

    return $statusName[$statusId];
}

Nova proposta para o mesmo resultado, podendo usar o ID em outras partes do projeto sem fazer comparações de valores números de forma explícita.

<?php declare(strict_types=1);

const STATUS_APPROVAL = 'Aprovado';
const STATUS_WAITING_PAYMENT = 'Aguardando Pagto';
const STATUS_ANALISYS = 'Em Analise';
const STATUS_REJECTED = 'Rejeitado';
const STATUS_RETURNED = 'Devolvido';
const STATUS_CANCELED = 'Cancelado';
const STATUS_BLOCKED = 'Bloqueado';
const STATUS_DEFAULT = 'Não Encontrado';

const STATUS_APPROVAL_ID = 1;
const STATUS_WAITING_PAYMENT_ID = 2;
const STATUS_ANALISYS_ID = 3;
const STATUS_REJECTED_ID = 4;
const STATUS_RETURNED_ID = 5;
const STATUS_CANCELED_ID = 6;
const STATUS_BLOCKED_ID = 7;

function status(int $statusId) : string
{
    $statusName = [
        STATUS_APPROVAL_ID => STATUS_APPROVAL,
        STATUS_WAITING_PAYMENT_ID => STATUS_WAITING_PAYMENT,
        STATUS_ANALISYS_ID => STATUS_ANALISYS,
        STATUS_REJECTED_ID => STATUS_REJECTED,
        STATUS_RETURNED_ID => STATUS_RETURNED,
        STATUS_CANCELED_ID => STATUS_CANCELED,
        STATUS_BLOCKED_ID => STATUS_BLOCKED,
    ];

    if (!array_key_exists($statusId, $statusName)) {
        return STATUS_DEFAULT;
    }

    return $statusName[$statusId];
}

Um exemplo para o mesmo resultado, muda um pouco a abordagem para usar enums do PHP 8.1.

<?php

declare(strict_types=1);

enum Status: int
{
    case STATUS_APPROVAL = 1;
    case STATUS_WAITING_PAYMENT = 2;
    case STATUS_ANALISYS = 3;
    case STATUS_REJECTED = 4;
    case STATUS_RETURNED = 5;
    case STATUS_CANCELED = 6;
    case STATUS_BLOCKED = 7;

    public function label(): string
    {
        return match($this) 
        {
            self::STATUS_APPROVAL => 'Aprovado',
            self::STATUS_WAITING_PAYMENT => 'Aguardando Pagto',
            self::STATUS_ANALISYS => 'Em Analise',
            self::STATUS_REJECTED => 'Rejeitado',
            self::STATUS_RETURNED => 'Devolvido',
            self::STATUS_CANCELED => 'Cancelado',
            self::STATUS_BLOCKED => 'Bloqueado'
        };
    }
}

$status = Status::STATUS_RETURNED;
echo $status->label() . ' - ' . $status->value . PHP_EOL; // Devolvido - 5

$status = Status::tryFrom(3);
echo $status->label() . ' - ' . $status->value . PHP_EOL; // Em Analise - 3