diff --git a/app/Api/V1/Controllers/Autocomplete/AccountController.php b/app/Api/V1/Controllers/Autocomplete/AccountController.php index a9dba92ca5b..5977a9d06f8 100644 --- a/app/Api/V1/Controllers/Autocomplete/AccountController.php +++ b/app/Api/V1/Controllers/Autocomplete/AccountController.php @@ -40,6 +40,10 @@ /** * Class AccountController + * + * Controlador da API responsavel pelo autocomplete de contas. + * Fornece sugestoes de contas para campos de busca com suporte + * a filtragem por tipo e exibicao de saldo. */ class AccountController extends Controller { diff --git a/app/Api/V1/Controllers/Autocomplete/BillController.php b/app/Api/V1/Controllers/Autocomplete/BillController.php index 5fea014b5c4..45d918d42d1 100644 --- a/app/Api/V1/Controllers/Autocomplete/BillController.php +++ b/app/Api/V1/Controllers/Autocomplete/BillController.php @@ -33,6 +33,10 @@ /** * Class BillController + * + * Controlador da API responsavel pelo autocomplete de faturas. + * Fornece sugestoes de faturas/assinaturas para campos de busca + * com informacoes de nome e status ativo. */ class BillController extends Controller { diff --git a/app/Api/V1/Controllers/Autocomplete/BudgetController.php b/app/Api/V1/Controllers/Autocomplete/BudgetController.php index 3fd273d329e..7ab517c6e37 100644 --- a/app/Api/V1/Controllers/Autocomplete/BudgetController.php +++ b/app/Api/V1/Controllers/Autocomplete/BudgetController.php @@ -33,6 +33,10 @@ /** * Class BudgetController + * + * Controlador da API responsavel pelo autocomplete de orcamentos. + * Fornece sugestoes de orcamentos para campos de busca + * com informacoes de ID e nome. */ class BudgetController extends Controller { diff --git a/app/Api/V1/Controllers/Autocomplete/CategoryController.php b/app/Api/V1/Controllers/Autocomplete/CategoryController.php index cf24f56776b..9b91c9c1909 100644 --- a/app/Api/V1/Controllers/Autocomplete/CategoryController.php +++ b/app/Api/V1/Controllers/Autocomplete/CategoryController.php @@ -33,6 +33,10 @@ /** * Class CategoryController + * + * Controlador da API responsavel pelo autocomplete de categorias. + * Fornece sugestoes de categorias para campos de busca + * com informacoes de ID e nome. */ class CategoryController extends Controller { diff --git a/app/Api/V1/Controllers/Autocomplete/CurrencyController.php b/app/Api/V1/Controllers/Autocomplete/CurrencyController.php index 427e03d5b97..c8a8342a037 100644 --- a/app/Api/V1/Controllers/Autocomplete/CurrencyController.php +++ b/app/Api/V1/Controllers/Autocomplete/CurrencyController.php @@ -34,6 +34,10 @@ /** * Class CurrencyController + * + * Controlador da API responsavel pelo autocomplete de moedas. + * Fornece sugestoes de moedas para campos de busca com + * informacoes de codigo, simbolo e casas decimais. */ class CurrencyController extends Controller { diff --git a/app/Api/V1/Controllers/Autocomplete/ObjectGroupController.php b/app/Api/V1/Controllers/Autocomplete/ObjectGroupController.php index 0f4126f9410..3e17dd3c912 100644 --- a/app/Api/V1/Controllers/Autocomplete/ObjectGroupController.php +++ b/app/Api/V1/Controllers/Autocomplete/ObjectGroupController.php @@ -33,6 +33,10 @@ /** * Class ObjectGroupController + * + * Controlador da API responsavel pelo autocomplete de grupos de objetos. + * Fornece sugestoes de grupos para campos de busca com + * informacoes de ID e titulo. */ class ObjectGroupController extends Controller { diff --git a/app/Api/V1/Controllers/Autocomplete/PiggyBankController.php b/app/Api/V1/Controllers/Autocomplete/PiggyBankController.php index de08a181b52..4a24a0591fd 100644 --- a/app/Api/V1/Controllers/Autocomplete/PiggyBankController.php +++ b/app/Api/V1/Controllers/Autocomplete/PiggyBankController.php @@ -34,6 +34,10 @@ /** * Class PiggyBankController + * + * Controlador da API responsavel pelo autocomplete de cofrinhos. + * Fornece sugestoes de cofrinhos para campos de busca com + * informacoes de saldo, moeda e grupo de objetos. */ class PiggyBankController extends Controller { diff --git a/app/Api/V1/Controllers/Autocomplete/RecurrenceController.php b/app/Api/V1/Controllers/Autocomplete/RecurrenceController.php index f061df14438..d037d4edb2c 100644 --- a/app/Api/V1/Controllers/Autocomplete/RecurrenceController.php +++ b/app/Api/V1/Controllers/Autocomplete/RecurrenceController.php @@ -33,6 +33,10 @@ /** * Class RecurrenceController + * + * Controlador da API responsavel pelo autocomplete de recorrencias. + * Fornece sugestoes de transacoes recorrentes para campos de busca + * com informacoes de titulo e descricao. */ class RecurrenceController extends Controller { diff --git a/app/Api/V1/Controllers/Autocomplete/RuleController.php b/app/Api/V1/Controllers/Autocomplete/RuleController.php index acc44effcd6..b8551daaa51 100644 --- a/app/Api/V1/Controllers/Autocomplete/RuleController.php +++ b/app/Api/V1/Controllers/Autocomplete/RuleController.php @@ -33,6 +33,10 @@ /** * Class RuleController + * + * Controlador da API responsavel pelo autocomplete de regras. + * Fornece sugestoes de regras de automacao para campos de busca + * com informacoes de titulo e descricao. */ class RuleController extends Controller { diff --git a/app/Api/V1/Controllers/Autocomplete/RuleGroupController.php b/app/Api/V1/Controllers/Autocomplete/RuleGroupController.php index d5e42b67338..8fee8176868 100644 --- a/app/Api/V1/Controllers/Autocomplete/RuleGroupController.php +++ b/app/Api/V1/Controllers/Autocomplete/RuleGroupController.php @@ -33,6 +33,10 @@ /** * Class RuleGroupController + * + * Controlador da API responsavel pelo autocomplete de grupos de regras. + * Fornece sugestoes de grupos de regras para campos de busca + * com informacoes de titulo e descricao. */ class RuleGroupController extends Controller { diff --git a/app/Api/V1/Controllers/Autocomplete/TagController.php b/app/Api/V1/Controllers/Autocomplete/TagController.php index 5ad94ea7f5a..6518ccdd07d 100644 --- a/app/Api/V1/Controllers/Autocomplete/TagController.php +++ b/app/Api/V1/Controllers/Autocomplete/TagController.php @@ -33,6 +33,10 @@ /** * Class TagController + * + * Controlador da API responsavel pelo autocomplete de tags. + * Fornece sugestoes de tags para campos de busca + * com informacoes de ID e nome da tag. */ class TagController extends Controller { diff --git a/app/Api/V1/Controllers/Autocomplete/TransactionController.php b/app/Api/V1/Controllers/Autocomplete/TransactionController.php index 4321479d265..63e4d409f9d 100644 --- a/app/Api/V1/Controllers/Autocomplete/TransactionController.php +++ b/app/Api/V1/Controllers/Autocomplete/TransactionController.php @@ -36,6 +36,10 @@ /** * Class TransactionController + * + * Controlador da API responsavel pelo autocomplete de transacoes. + * Fornece sugestoes de transacoes para campos de busca + * com informacoes de descricao e ID do grupo. */ class TransactionController extends Controller { diff --git a/app/Api/V1/Controllers/Autocomplete/TransactionTypeController.php b/app/Api/V1/Controllers/Autocomplete/TransactionTypeController.php index 357efc37a1f..13787407127 100644 --- a/app/Api/V1/Controllers/Autocomplete/TransactionTypeController.php +++ b/app/Api/V1/Controllers/Autocomplete/TransactionTypeController.php @@ -33,6 +33,10 @@ /** * Class TransactionTypeController + * + * Controlador da API responsavel pelo autocomplete de tipos de transacao. + * Fornece sugestoes de tipos (deposito, saque, transferencia) para + * campos de busca com informacoes de ID e tipo. */ class TransactionTypeController extends Controller { diff --git a/app/Api/V1/Controllers/Chart/AccountController.php b/app/Api/V1/Controllers/Chart/AccountController.php index f3219657770..309404abb98 100644 --- a/app/Api/V1/Controllers/Chart/AccountController.php +++ b/app/Api/V1/Controllers/Chart/AccountController.php @@ -40,6 +40,10 @@ /** * Class AccountController + * + * Controlador da API responsavel por graficos de contas. + * Gera dados para graficos de saldo de contas ao longo do tempo + * com suporte a conversao de moedas. */ class AccountController extends Controller { diff --git a/app/Api/V1/Controllers/Chart/BalanceController.php b/app/Api/V1/Controllers/Chart/BalanceController.php index d589be1661c..83807224a2d 100644 --- a/app/Api/V1/Controllers/Chart/BalanceController.php +++ b/app/Api/V1/Controllers/Chart/BalanceController.php @@ -20,6 +20,10 @@ /** * Class BalanceController + * + * Controlador da API responsavel por graficos de balanco. + * Gera dados para graficos de receitas e despesas agrupados + * por periodo com suporte a conversao de moedas. */ class BalanceController extends Controller { diff --git a/app/Api/V1/Controllers/Chart/BudgetController.php b/app/Api/V1/Controllers/Chart/BudgetController.php index 4102693d363..b691b1d52a9 100644 --- a/app/Api/V1/Controllers/Chart/BudgetController.php +++ b/app/Api/V1/Controllers/Chart/BudgetController.php @@ -44,6 +44,10 @@ /** * Class BudgetController + * + * Controlador da API responsavel por graficos de orcamentos. + * Gera dados para graficos de gastos vs orcado, incluindo + * valores restantes e excedidos por periodo. */ class BudgetController extends Controller { diff --git a/app/Api/V1/Controllers/Chart/CategoryController.php b/app/Api/V1/Controllers/Chart/CategoryController.php index 2ed6299222c..d9c78b9219a 100644 --- a/app/Api/V1/Controllers/Chart/CategoryController.php +++ b/app/Api/V1/Controllers/Chart/CategoryController.php @@ -42,7 +42,11 @@ use Illuminate\Support\Facades\Log; /** - * Class BudgetController + * Class CategoryController + * + * Controlador da API responsavel por graficos de categorias. + * Gera dados para graficos de gastos por categoria + * com suporte a conversao de moedas. */ class CategoryController extends Controller { diff --git a/app/Api/V1/Controllers/Controller.php b/app/Api/V1/Controllers/Controller.php index 196cca92902..f66971ef051 100644 --- a/app/Api/V1/Controllers/Controller.php +++ b/app/Api/V1/Controllers/Controller.php @@ -52,6 +52,11 @@ /** * Class Controller. * + * Classe base abstrata para todos os controladores da API V1. + * Fornece funcionalidades comuns como gerenciamento de parametros, + * validacao de headers HTTP, conversao de moedas e serializacao JSON API. + * Todos os controladores da API devem estender esta classe. + * * @SuppressWarnings("PHPMD.CouplingBetweenObjects") * @SuppressWarnings("PHPMD.NumberOfChildren") */ diff --git a/app/Api/V1/Controllers/Data/Bulk/TransactionController.php b/app/Api/V1/Controllers/Data/Bulk/TransactionController.php index 7f00225c70b..f4271d7ec76 100644 --- a/app/Api/V1/Controllers/Data/Bulk/TransactionController.php +++ b/app/Api/V1/Controllers/Data/Bulk/TransactionController.php @@ -34,12 +34,9 @@ /** * Class TransactionController * - * Endpoint to update transactions by submitting - * (optional) a "where" clause and an "update" - * clause. - * - * Because this is a security nightmare waiting to happen validation - * is pretty strict. + * Controlador da API responsavel por operacoes em massa de transacoes. + * Permite atualizar transacoes em lote usando clausulas "where" e "update" + * com validacao rigorosa por questoes de seguranca. */ class TransactionController extends Controller { diff --git a/app/Api/V1/Controllers/Data/DestroyController.php b/app/Api/V1/Controllers/Data/DestroyController.php index 87e791be7ce..844ceee2738 100644 --- a/app/Api/V1/Controllers/Data/DestroyController.php +++ b/app/Api/V1/Controllers/Data/DestroyController.php @@ -51,6 +51,10 @@ /** * Class DestroyController + * + * Controlador da API responsavel pela exclusao em massa de dados. + * Permite excluir orcamentos, faturas, cofrinhos, regras, categorias, + * tags, contas e transacoes de forma massiva. */ class DestroyController extends Controller { diff --git a/app/Api/V1/Controllers/Data/Export/ExportController.php b/app/Api/V1/Controllers/Data/Export/ExportController.php index f65e23dfc05..2807eefab92 100644 --- a/app/Api/V1/Controllers/Data/Export/ExportController.php +++ b/app/Api/V1/Controllers/Data/Export/ExportController.php @@ -36,6 +36,10 @@ /** * Class ExportController + * + * Controlador da API responsavel pela exportacao de dados. + * Permite exportar contas, faturas, orcamentos, categorias, + * cofrinhos, recorrencias, regras, tags e transacoes em CSV. */ class ExportController extends Controller { diff --git a/app/Api/V1/Controllers/Data/PurgeController.php b/app/Api/V1/Controllers/Data/PurgeController.php index cea88fa0e69..c3f3e380761 100644 --- a/app/Api/V1/Controllers/Data/PurgeController.php +++ b/app/Api/V1/Controllers/Data/PurgeController.php @@ -42,6 +42,10 @@ /** * Class PurgeController + * + * Controlador da API responsavel pela limpeza de dados excluidos. + * Remove permanentemente registros que foram soft-deleted + * como orcamentos, faturas, contas e transacoes. */ class PurgeController extends Controller { diff --git a/app/Api/V1/Controllers/Insight/Expense/AccountController.php b/app/Api/V1/Controllers/Insight/Expense/AccountController.php index 889fdce65de..6a4e29c7b8e 100644 --- a/app/Api/V1/Controllers/Insight/Expense/AccountController.php +++ b/app/Api/V1/Controllers/Insight/Expense/AccountController.php @@ -34,8 +34,9 @@ /** * Class AccountController * - * Shows expense information grouped or limited by date. - * I.e. all expenses grouped by account + currency. + * Controlador da API responsavel por insights de despesas por conta. + * Exibe informacoes de despesas agrupadas por conta de origem + * ou destino com suporte a filtragem por periodo. */ class AccountController extends Controller { diff --git a/app/Api/V1/Controllers/Insight/Expense/BillController.php b/app/Api/V1/Controllers/Insight/Expense/BillController.php index 55cd1dc77cd..2ae4a686f69 100644 --- a/app/Api/V1/Controllers/Insight/Expense/BillController.php +++ b/app/Api/V1/Controllers/Insight/Expense/BillController.php @@ -35,6 +35,10 @@ /** * Class BillController + * + * Controlador da API responsavel por insights de despesas por fatura. + * Exibe informacoes de despesas agrupadas por fatura/assinatura + * com suporte a conversao de moedas. */ class BillController extends Controller { diff --git a/app/Api/V1/Controllers/Insight/Expense/BudgetController.php b/app/Api/V1/Controllers/Insight/Expense/BudgetController.php index ed91b96a16b..046066ae98a 100644 --- a/app/Api/V1/Controllers/Insight/Expense/BudgetController.php +++ b/app/Api/V1/Controllers/Insight/Expense/BudgetController.php @@ -35,6 +35,10 @@ /** * Class BudgetController + * + * Controlador da API responsavel por insights de despesas por orcamento. + * Exibe informacoes de despesas agrupadas por orcamento + * incluindo despesas sem orcamento definido. */ class BudgetController extends Controller { diff --git a/app/Api/V1/Controllers/Insight/Expense/CategoryController.php b/app/Api/V1/Controllers/Insight/Expense/CategoryController.php index d5d092b461c..9884cf81e6d 100644 --- a/app/Api/V1/Controllers/Insight/Expense/CategoryController.php +++ b/app/Api/V1/Controllers/Insight/Expense/CategoryController.php @@ -35,6 +35,10 @@ /** * Class CategoryController + * + * Controlador da API responsavel por insights de despesas por categoria. + * Exibe informacoes de despesas agrupadas por categoria + * incluindo despesas sem categoria definida. */ class CategoryController extends Controller { diff --git a/app/Api/V1/Controllers/Insight/Expense/PeriodController.php b/app/Api/V1/Controllers/Insight/Expense/PeriodController.php index 3e03ec287b2..aea13068c2b 100644 --- a/app/Api/V1/Controllers/Insight/Expense/PeriodController.php +++ b/app/Api/V1/Controllers/Insight/Expense/PeriodController.php @@ -34,6 +34,10 @@ /** * Class PeriodController + * + * Controlador da API responsavel por insights de despesas por periodo. + * Exibe o total de despesas em um periodo especifico + * com suporte a conversao para moeda primaria. */ class PeriodController extends Controller { diff --git a/app/Api/V1/Controllers/Insight/Expense/TagController.php b/app/Api/V1/Controllers/Insight/Expense/TagController.php index ff98df82fef..ae86d6ec876 100644 --- a/app/Api/V1/Controllers/Insight/Expense/TagController.php +++ b/app/Api/V1/Controllers/Insight/Expense/TagController.php @@ -35,6 +35,10 @@ /** * Class TagController + * + * Controlador da API responsavel por insights de despesas por tag. + * Exibe informacoes de despesas agrupadas por tag + * incluindo despesas sem tag definida. */ class TagController extends Controller { diff --git a/app/Api/V1/Controllers/Insight/Income/AccountController.php b/app/Api/V1/Controllers/Insight/Income/AccountController.php index d1670922619..4f55fec6a79 100644 --- a/app/Api/V1/Controllers/Insight/Income/AccountController.php +++ b/app/Api/V1/Controllers/Insight/Income/AccountController.php @@ -34,8 +34,9 @@ /** * Class AccountController * - * Shows income information grouped or limited by date. - * I.e. all income grouped by account + currency. + * Controlador da API responsavel por insights de receitas por conta. + * Exibe informacoes de receitas agrupadas por conta de destino + * ou origem com suporte a filtragem por periodo. */ class AccountController extends Controller { diff --git a/app/Api/V1/Controllers/Insight/Income/CategoryController.php b/app/Api/V1/Controllers/Insight/Income/CategoryController.php index 15470903378..7c709c38af4 100644 --- a/app/Api/V1/Controllers/Insight/Income/CategoryController.php +++ b/app/Api/V1/Controllers/Insight/Income/CategoryController.php @@ -35,6 +35,10 @@ /** * Class CategoryController + * + * Controlador da API responsavel por insights de receitas por categoria. + * Exibe informacoes de receitas agrupadas por categoria + * incluindo receitas sem categoria definida. */ class CategoryController extends Controller { diff --git a/app/Api/V1/Controllers/Insight/Income/PeriodController.php b/app/Api/V1/Controllers/Insight/Income/PeriodController.php index c66a19eab89..02559b7a979 100644 --- a/app/Api/V1/Controllers/Insight/Income/PeriodController.php +++ b/app/Api/V1/Controllers/Insight/Income/PeriodController.php @@ -33,6 +33,10 @@ /** * Class PeriodController + * + * Controlador da API responsavel por insights de receitas por periodo. + * Exibe o total de receitas em um periodo especifico + * com suporte a conversao para moeda primaria. */ class PeriodController extends Controller { diff --git a/app/Api/V1/Controllers/Insight/Income/TagController.php b/app/Api/V1/Controllers/Insight/Income/TagController.php index fe452706542..ff13c369157 100644 --- a/app/Api/V1/Controllers/Insight/Income/TagController.php +++ b/app/Api/V1/Controllers/Insight/Income/TagController.php @@ -34,6 +34,10 @@ /** * Class TagController + * + * Controlador da API responsavel por insights de receitas por tag. + * Exibe informacoes de receitas agrupadas por tag + * incluindo receitas sem tag definida. */ class TagController extends Controller { diff --git a/app/Api/V1/Controllers/Insight/Transfer/AccountController.php b/app/Api/V1/Controllers/Insight/Transfer/AccountController.php index ce9e1635aa9..dc9986e4611 100644 --- a/app/Api/V1/Controllers/Insight/Transfer/AccountController.php +++ b/app/Api/V1/Controllers/Insight/Transfer/AccountController.php @@ -32,6 +32,10 @@ /** * Class AccountController + * + * Controlador da API responsavel por insights de transferencias por conta. + * Exibe informacoes de transferencias entre contas de ativos + * com suporte a filtragem por periodo. */ class AccountController extends Controller { diff --git a/app/Api/V1/Controllers/Insight/Transfer/CategoryController.php b/app/Api/V1/Controllers/Insight/Transfer/CategoryController.php index 63cabef200e..7059a5eee7e 100644 --- a/app/Api/V1/Controllers/Insight/Transfer/CategoryController.php +++ b/app/Api/V1/Controllers/Insight/Transfer/CategoryController.php @@ -35,6 +35,10 @@ /** * Class CategoryController + * + * Controlador da API responsavel por insights de transferencias por categoria. + * Exibe informacoes de transferencias agrupadas por categoria + * incluindo transferencias sem categoria definida. */ class CategoryController extends Controller { diff --git a/app/Api/V1/Controllers/Insight/Transfer/PeriodController.php b/app/Api/V1/Controllers/Insight/Transfer/PeriodController.php index e2dc396d191..aed03060606 100644 --- a/app/Api/V1/Controllers/Insight/Transfer/PeriodController.php +++ b/app/Api/V1/Controllers/Insight/Transfer/PeriodController.php @@ -33,6 +33,10 @@ /** * Class PeriodController + * + * Controlador da API responsavel por insights de transferencias por periodo. + * Exibe o total de transferencias em um periodo especifico + * com suporte a conversao para moeda primaria. */ class PeriodController extends Controller { diff --git a/app/Api/V1/Controllers/Insight/Transfer/TagController.php b/app/Api/V1/Controllers/Insight/Transfer/TagController.php index a03d623cfd1..04bb8e18acd 100644 --- a/app/Api/V1/Controllers/Insight/Transfer/TagController.php +++ b/app/Api/V1/Controllers/Insight/Transfer/TagController.php @@ -34,6 +34,10 @@ /** * Class TagController + * + * Controlador da API responsavel por insights de transferencias por tag. + * Exibe informacoes de transferencias agrupadas por tag + * incluindo transferencias sem tag definida. */ class TagController extends Controller { diff --git a/app/Api/V1/Controllers/Models/Account/DestroyController.php b/app/Api/V1/Controllers/Models/Account/DestroyController.php index fc23429f762..3d1b53d4056 100644 --- a/app/Api/V1/Controllers/Models/Account/DestroyController.php +++ b/app/Api/V1/Controllers/Models/Account/DestroyController.php @@ -31,6 +31,9 @@ /** * Class DestroyController + * + * Controlador da API responsavel pela exclusao de contas. + * Remove contas do sistema atraves da API REST. */ class DestroyController extends Controller { diff --git a/app/Api/V1/Controllers/Models/Account/ListController.php b/app/Api/V1/Controllers/Models/Account/ListController.php index 15f8ac7c045..d25f226381f 100644 --- a/app/Api/V1/Controllers/Models/Account/ListController.php +++ b/app/Api/V1/Controllers/Models/Account/ListController.php @@ -45,6 +45,9 @@ /** * Class ListController + * + * Controlador da API responsavel pela listagem de recursos relacionados a contas. + * Lista anexos, cofrinhos e transacoes associados a uma conta especifica. */ class ListController extends Controller { diff --git a/app/Api/V1/Controllers/Models/Account/ShowController.php b/app/Api/V1/Controllers/Models/Account/ShowController.php index 5cdb73d10dd..a41d5c890b9 100644 --- a/app/Api/V1/Controllers/Models/Account/ShowController.php +++ b/app/Api/V1/Controllers/Models/Account/ShowController.php @@ -41,6 +41,9 @@ /** * Class ShowController + * + * Controlador da API responsavel pela exibicao de contas. + * Lista todas as contas ou exibe detalhes de uma conta especifica. */ class ShowController extends Controller { diff --git a/app/Api/V1/Controllers/Models/Account/StoreController.php b/app/Api/V1/Controllers/Models/Account/StoreController.php index bbda9b50ef8..39025b3622b 100644 --- a/app/Api/V1/Controllers/Models/Account/StoreController.php +++ b/app/Api/V1/Controllers/Models/Account/StoreController.php @@ -35,6 +35,9 @@ /** * Class StoreController + * + * Controlador da API responsavel pela criacao de contas. + * Cria novas contas no sistema atraves da API REST. */ class StoreController extends Controller { diff --git a/app/Api/V1/Controllers/Models/Account/UpdateController.php b/app/Api/V1/Controllers/Models/Account/UpdateController.php index 5118b1116da..55ac1c8bc09 100644 --- a/app/Api/V1/Controllers/Models/Account/UpdateController.php +++ b/app/Api/V1/Controllers/Models/Account/UpdateController.php @@ -37,6 +37,9 @@ /** * Class UpdateController + * + * Controlador da API responsavel pela atualizacao de contas. + * Atualiza dados de contas existentes atraves da API REST. */ class UpdateController extends Controller { diff --git a/app/Api/V1/Controllers/Models/Attachment/DestroyController.php b/app/Api/V1/Controllers/Models/Attachment/DestroyController.php index c7ee0d20e50..586f9c5b955 100644 --- a/app/Api/V1/Controllers/Models/Attachment/DestroyController.php +++ b/app/Api/V1/Controllers/Models/Attachment/DestroyController.php @@ -35,6 +35,9 @@ /** * Class DestroyController + * + * Controlador da API responsavel pela exclusao de anexos. + * Remove anexos do sistema atraves da API REST. */ class DestroyController extends Controller { diff --git a/app/Api/V1/Controllers/Models/Attachment/ShowController.php b/app/Api/V1/Controllers/Models/Attachment/ShowController.php index bb8e267a113..81c9c1ed170 100644 --- a/app/Api/V1/Controllers/Models/Attachment/ShowController.php +++ b/app/Api/V1/Controllers/Models/Attachment/ShowController.php @@ -42,6 +42,9 @@ /** * Class ShowController + * + * Controlador da API responsavel pela exibicao de anexos. + * Lista todos os anexos, exibe detalhes ou faz download de um anexo especifico. */ class ShowController extends Controller { diff --git a/app/Api/V1/Controllers/Models/Attachment/StoreController.php b/app/Api/V1/Controllers/Models/Attachment/StoreController.php index a070ff8c5d7..8fff9a139c0 100644 --- a/app/Api/V1/Controllers/Models/Attachment/StoreController.php +++ b/app/Api/V1/Controllers/Models/Attachment/StoreController.php @@ -41,6 +41,9 @@ /** * Class StoreController + * + * Controlador da API responsavel pela criacao de anexos. + * Cria novos anexos e faz upload de arquivos atraves da API REST. */ class StoreController extends Controller { diff --git a/app/Api/V1/Controllers/Models/Attachment/UpdateController.php b/app/Api/V1/Controllers/Models/Attachment/UpdateController.php index c5e2fd2a9c0..f62ac19fc6e 100644 --- a/app/Api/V1/Controllers/Models/Attachment/UpdateController.php +++ b/app/Api/V1/Controllers/Models/Attachment/UpdateController.php @@ -38,6 +38,9 @@ /** * Class UpdateController + * + * Controlador da API responsavel pela atualizacao de anexos. + * Atualiza metadados de anexos existentes atraves da API REST. */ class UpdateController extends Controller { diff --git a/app/Api/V1/Controllers/Models/AvailableBudget/ShowController.php b/app/Api/V1/Controllers/Models/AvailableBudget/ShowController.php index 94f7dfdbc71..7787cf9d8ae 100644 --- a/app/Api/V1/Controllers/Models/AvailableBudget/ShowController.php +++ b/app/Api/V1/Controllers/Models/AvailableBudget/ShowController.php @@ -39,6 +39,9 @@ /** * Class ShowController + * + * Controlador da API responsavel pela exibicao de orcamentos disponiveis. + * Lista todos os orcamentos disponiveis ou exibe detalhes de um especifico. */ class ShowController extends Controller { diff --git a/app/Api/V1/Controllers/Models/Bill/DestroyController.php b/app/Api/V1/Controllers/Models/Bill/DestroyController.php index d62697d9509..b8509d643e0 100644 --- a/app/Api/V1/Controllers/Models/Bill/DestroyController.php +++ b/app/Api/V1/Controllers/Models/Bill/DestroyController.php @@ -31,6 +31,9 @@ /** * Class DestroyController + * + * Controlador da API responsavel pela exclusao de faturas. + * Remove faturas do sistema atraves da API REST. */ class DestroyController extends Controller { diff --git a/app/Api/V1/Controllers/Models/Bill/ListController.php b/app/Api/V1/Controllers/Models/Bill/ListController.php index e0e21e01cca..fcc6e367d30 100644 --- a/app/Api/V1/Controllers/Models/Bill/ListController.php +++ b/app/Api/V1/Controllers/Models/Bill/ListController.php @@ -43,6 +43,9 @@ /** * Class ListController + * + * Controlador da API responsavel pela listagem de recursos relacionados a faturas. + * Lista anexos, regras e transacoes associados a uma fatura especifica. */ class ListController extends Controller { diff --git a/app/Api/V1/Controllers/Models/Bill/ShowController.php b/app/Api/V1/Controllers/Models/Bill/ShowController.php index 6c767f16a6d..6c7625d6d61 100644 --- a/app/Api/V1/Controllers/Models/Bill/ShowController.php +++ b/app/Api/V1/Controllers/Models/Bill/ShowController.php @@ -39,6 +39,9 @@ /** * Class ShowController + * + * Controlador da API responsavel pela exibicao de faturas. + * Lista todas as faturas ou exibe detalhes de uma fatura especifica. */ class ShowController extends Controller { diff --git a/app/Api/V1/Controllers/Models/Bill/StoreController.php b/app/Api/V1/Controllers/Models/Bill/StoreController.php index e0ab4b23d5e..6f2b2016ab1 100644 --- a/app/Api/V1/Controllers/Models/Bill/StoreController.php +++ b/app/Api/V1/Controllers/Models/Bill/StoreController.php @@ -37,6 +37,9 @@ /** * Class StoreController + * + * Controlador da API responsavel pela criacao de faturas. + * Cria novas faturas no sistema atraves da API REST. */ class StoreController extends Controller { diff --git a/app/Api/V1/Controllers/Models/Bill/UpdateController.php b/app/Api/V1/Controllers/Models/Bill/UpdateController.php index bca0351efe3..dc4772e933c 100644 --- a/app/Api/V1/Controllers/Models/Bill/UpdateController.php +++ b/app/Api/V1/Controllers/Models/Bill/UpdateController.php @@ -36,6 +36,9 @@ /** * Class UpdateController + * + * Controlador da API responsavel pela atualizacao de faturas. + * Atualiza dados de faturas existentes atraves da API REST. */ class UpdateController extends Controller { diff --git a/app/Api/V1/Controllers/Models/Budget/DestroyController.php b/app/Api/V1/Controllers/Models/Budget/DestroyController.php index 93e2f738ece..e80d5a08682 100644 --- a/app/Api/V1/Controllers/Models/Budget/DestroyController.php +++ b/app/Api/V1/Controllers/Models/Budget/DestroyController.php @@ -31,6 +31,9 @@ /** * Class DestroyController + * + * Controlador da API responsavel pela exclusao de orcamentos. + * Remove orcamentos do sistema atraves da API REST. */ class DestroyController extends Controller { diff --git a/app/Api/V1/Controllers/Models/Budget/ListController.php b/app/Api/V1/Controllers/Models/Budget/ListController.php index 036fa6d4ec3..8920ded5e42 100644 --- a/app/Api/V1/Controllers/Models/Budget/ListController.php +++ b/app/Api/V1/Controllers/Models/Budget/ListController.php @@ -44,7 +44,12 @@ use League\Fractal\Pagination\IlluminatePaginatorAdapter; use League\Fractal\Resource\Collection as FractalCollection; -// Class ListController +/** + * Class ListController + * + * Controlador da API responsavel pela listagem de recursos relacionados a orcamentos. + * Lista anexos, limites de orcamento e transacoes associados a um orcamento especifico. + */ class ListController extends Controller { use TransactionFilter; diff --git a/app/Api/V1/Controllers/Models/Budget/ShowController.php b/app/Api/V1/Controllers/Models/Budget/ShowController.php index e5062863b1a..87ff423799e 100644 --- a/app/Api/V1/Controllers/Models/Budget/ShowController.php +++ b/app/Api/V1/Controllers/Models/Budget/ShowController.php @@ -40,6 +40,9 @@ /** * Class ShowController + * + * Controlador da API responsavel pela exibicao de orcamentos. + * Lista todos os orcamentos ou exibe detalhes de um orcamento especifico. */ class ShowController extends Controller { diff --git a/app/Api/V1/Controllers/Models/Budget/StoreController.php b/app/Api/V1/Controllers/Models/Budget/StoreController.php index b6d9e85e6c4..9fdf88c31a4 100644 --- a/app/Api/V1/Controllers/Models/Budget/StoreController.php +++ b/app/Api/V1/Controllers/Models/Budget/StoreController.php @@ -36,6 +36,9 @@ /** * Class StoreController + * + * Controlador da API responsavel pela criacao de orcamentos. + * Cria novos orcamentos no sistema atraves da API REST. */ class StoreController extends Controller { diff --git a/app/Api/V1/Controllers/Models/Budget/UpdateController.php b/app/Api/V1/Controllers/Models/Budget/UpdateController.php index b6524ba738f..837110d74f3 100644 --- a/app/Api/V1/Controllers/Models/Budget/UpdateController.php +++ b/app/Api/V1/Controllers/Models/Budget/UpdateController.php @@ -36,6 +36,9 @@ /** * Class UpdateController + * + * Controlador da API responsavel pela atualizacao de orcamentos. + * Atualiza dados de orcamentos existentes atraves da API REST. */ class UpdateController extends Controller { diff --git a/app/Api/V1/Controllers/Models/BudgetLimit/DestroyController.php b/app/Api/V1/Controllers/Models/BudgetLimit/DestroyController.php index 7c037dafd13..fbba8a410d9 100644 --- a/app/Api/V1/Controllers/Models/BudgetLimit/DestroyController.php +++ b/app/Api/V1/Controllers/Models/BudgetLimit/DestroyController.php @@ -34,6 +34,9 @@ /** * Class DestroyController + * + * Controlador da API responsavel pela exclusao de limites de orcamento. + * Remove limites de orcamento do sistema atraves da API REST. */ class DestroyController extends Controller { diff --git a/app/Api/V1/Controllers/Models/BudgetLimit/ListController.php b/app/Api/V1/Controllers/Models/BudgetLimit/ListController.php index ee987eae8ae..f62b3bcb1ba 100644 --- a/app/Api/V1/Controllers/Models/BudgetLimit/ListController.php +++ b/app/Api/V1/Controllers/Models/BudgetLimit/ListController.php @@ -40,6 +40,9 @@ /** * Class ListController + * + * Controlador da API responsavel pela listagem de transacoes de limites de orcamento. + * Lista transacoes associadas a um limite de orcamento especifico. */ class ListController extends Controller { diff --git a/app/Api/V1/Controllers/Models/BudgetLimit/ShowController.php b/app/Api/V1/Controllers/Models/BudgetLimit/ShowController.php index 0253b3aac9c..0d41c98cf09 100644 --- a/app/Api/V1/Controllers/Models/BudgetLimit/ShowController.php +++ b/app/Api/V1/Controllers/Models/BudgetLimit/ShowController.php @@ -43,6 +43,9 @@ /** * Class ShowController + * + * Controlador da API responsavel pela exibicao de limites de orcamento. + * Lista todos os limites de orcamento ou exibe detalhes de um especifico. */ class ShowController extends Controller { diff --git a/app/Api/V1/Controllers/Models/BudgetLimit/StoreController.php b/app/Api/V1/Controllers/Models/BudgetLimit/StoreController.php index c3b88d69f20..e96fbadc24d 100644 --- a/app/Api/V1/Controllers/Models/BudgetLimit/StoreController.php +++ b/app/Api/V1/Controllers/Models/BudgetLimit/StoreController.php @@ -36,6 +36,9 @@ /** * Class StoreController + * + * Controlador da API responsavel pela criacao de limites de orcamento. + * Cria novos limites de orcamento no sistema atraves da API REST. */ class StoreController extends Controller { diff --git a/app/Api/V1/Controllers/Models/BudgetLimit/UpdateController.php b/app/Api/V1/Controllers/Models/BudgetLimit/UpdateController.php index 159c3c8b490..8a9c2ede013 100644 --- a/app/Api/V1/Controllers/Models/BudgetLimit/UpdateController.php +++ b/app/Api/V1/Controllers/Models/BudgetLimit/UpdateController.php @@ -38,6 +38,9 @@ /** * Class UpdateController + * + * Controlador da API responsavel pela atualizacao de limites de orcamento. + * Atualiza dados de limites de orcamento existentes atraves da API REST. */ class UpdateController extends Controller { diff --git a/app/Api/V1/Controllers/Models/Category/DestroyController.php b/app/Api/V1/Controllers/Models/Category/DestroyController.php index 29c58b20155..1ab83ff8cf9 100644 --- a/app/Api/V1/Controllers/Models/Category/DestroyController.php +++ b/app/Api/V1/Controllers/Models/Category/DestroyController.php @@ -31,6 +31,9 @@ /** * Class DestroyController + * + * Controlador da API responsavel pela exclusao de categorias. + * Remove categorias do sistema atraves da API REST. */ class DestroyController extends Controller { diff --git a/app/Api/V1/Controllers/Models/Category/ListController.php b/app/Api/V1/Controllers/Models/Category/ListController.php index 04af2f2c6c6..3e07f40d4c1 100644 --- a/app/Api/V1/Controllers/Models/Category/ListController.php +++ b/app/Api/V1/Controllers/Models/Category/ListController.php @@ -42,6 +42,9 @@ /** * Class ListController + * + * Controlador da API responsavel pela listagem de recursos relacionados a categorias. + * Lista anexos e transacoes associados a uma categoria especifica. */ class ListController extends Controller { diff --git a/app/Api/V1/Controllers/Models/Category/ShowController.php b/app/Api/V1/Controllers/Models/Category/ShowController.php index 9022eed9f9f..8523076bfd1 100644 --- a/app/Api/V1/Controllers/Models/Category/ShowController.php +++ b/app/Api/V1/Controllers/Models/Category/ShowController.php @@ -39,6 +39,9 @@ /** * Class ShowController + * + * Controlador da API responsavel pela exibicao de categorias. + * Lista todas as categorias ou exibe detalhes de uma categoria especifica. */ class ShowController extends Controller { diff --git a/app/Api/V1/Controllers/Models/Category/StoreController.php b/app/Api/V1/Controllers/Models/Category/StoreController.php index 99d53fcb5de..0d4b09cc596 100644 --- a/app/Api/V1/Controllers/Models/Category/StoreController.php +++ b/app/Api/V1/Controllers/Models/Category/StoreController.php @@ -36,6 +36,9 @@ /** * Class StoreController + * + * Controlador da API responsavel pela criacao de categorias. + * Cria novas categorias no sistema atraves da API REST. */ class StoreController extends Controller { diff --git a/app/Api/V1/Controllers/Models/Category/UpdateController.php b/app/Api/V1/Controllers/Models/Category/UpdateController.php index bcb82e927a9..1fdacc9064f 100644 --- a/app/Api/V1/Controllers/Models/Category/UpdateController.php +++ b/app/Api/V1/Controllers/Models/Category/UpdateController.php @@ -36,6 +36,9 @@ /** * Class UpdateController + * + * Controlador da API responsavel pela atualizacao de categorias. + * Atualiza dados de categorias existentes atraves da API REST. */ class UpdateController extends Controller { diff --git a/app/Api/V1/Controllers/Models/CurrencyExchangeRate/DestroyController.php b/app/Api/V1/Controllers/Models/CurrencyExchangeRate/DestroyController.php index 265a72b616d..96cc86df049 100644 --- a/app/Api/V1/Controllers/Models/CurrencyExchangeRate/DestroyController.php +++ b/app/Api/V1/Controllers/Models/CurrencyExchangeRate/DestroyController.php @@ -34,6 +34,12 @@ use FireflyIII\Support\Http\Api\ValidatesUserGroupTrait; use Illuminate\Http\JsonResponse; +/** + * Class DestroyController + * + * Controlador da API responsavel pela exclusao de taxas de cambio. + * Remove taxas de cambio do sistema atraves da API REST. + */ class DestroyController extends Controller { use ValidatesUserGroupTrait; diff --git a/app/Api/V1/Controllers/Models/CurrencyExchangeRate/IndexController.php b/app/Api/V1/Controllers/Models/CurrencyExchangeRate/IndexController.php index cebd3a82778..b43652cf2d9 100644 --- a/app/Api/V1/Controllers/Models/CurrencyExchangeRate/IndexController.php +++ b/app/Api/V1/Controllers/Models/CurrencyExchangeRate/IndexController.php @@ -33,7 +33,10 @@ use Illuminate\Pagination\LengthAwarePaginator; /** - * Class ShowController + * Class IndexController + * + * Controlador da API responsavel pela listagem de taxas de cambio. + * Lista todas as taxas de cambio cadastradas no sistema. */ class IndexController extends Controller { diff --git a/app/Api/V1/Controllers/Models/CurrencyExchangeRate/ShowController.php b/app/Api/V1/Controllers/Models/CurrencyExchangeRate/ShowController.php index 3b2f8c6e4dc..e0b4fa820c9 100644 --- a/app/Api/V1/Controllers/Models/CurrencyExchangeRate/ShowController.php +++ b/app/Api/V1/Controllers/Models/CurrencyExchangeRate/ShowController.php @@ -38,6 +38,9 @@ /** * Class ShowController + * + * Controlador da API responsavel pela exibicao de taxas de cambio. + * Exibe detalhes de taxas de cambio entre moedas especificas. */ class ShowController extends Controller { diff --git a/app/Api/V1/Controllers/Models/CurrencyExchangeRate/StoreController.php b/app/Api/V1/Controllers/Models/CurrencyExchangeRate/StoreController.php index 0e0f0fa8a1a..d8d2c7fd863 100644 --- a/app/Api/V1/Controllers/Models/CurrencyExchangeRate/StoreController.php +++ b/app/Api/V1/Controllers/Models/CurrencyExchangeRate/StoreController.php @@ -39,6 +39,12 @@ use Illuminate\Pagination\LengthAwarePaginator; use Illuminate\Support\Collection; +/** + * Class StoreController + * + * Controlador da API responsavel pela criacao de taxas de cambio. + * Cria novas taxas de cambio no sistema atraves da API REST. + */ class StoreController extends Controller { use ValidatesUserGroupTrait; diff --git a/app/Api/V1/Controllers/Models/CurrencyExchangeRate/UpdateController.php b/app/Api/V1/Controllers/Models/CurrencyExchangeRate/UpdateController.php index 8844407f7d6..47050a81f4b 100644 --- a/app/Api/V1/Controllers/Models/CurrencyExchangeRate/UpdateController.php +++ b/app/Api/V1/Controllers/Models/CurrencyExchangeRate/UpdateController.php @@ -36,6 +36,12 @@ use Illuminate\Http\JsonResponse; use Symfony\Component\HttpKernel\Exception\NotFoundHttpException; +/** + * Class UpdateController + * + * Controlador da API responsavel pela atualizacao de taxas de cambio. + * Atualiza taxas de cambio existentes atraves da API REST. + */ class UpdateController extends Controller { use ValidatesUserGroupTrait; diff --git a/app/Api/V1/Controllers/Models/ObjectGroup/DestroyController.php b/app/Api/V1/Controllers/Models/ObjectGroup/DestroyController.php index 02c229057a8..c80eaae4524 100644 --- a/app/Api/V1/Controllers/Models/ObjectGroup/DestroyController.php +++ b/app/Api/V1/Controllers/Models/ObjectGroup/DestroyController.php @@ -32,6 +32,9 @@ /** * Class DestroyController + * + * Controlador da API responsavel pela exclusao de grupos de objetos. + * Remove grupos de objetos do sistema atraves da API REST. */ class DestroyController extends Controller { diff --git a/app/Api/V1/Controllers/Models/ObjectGroup/ListController.php b/app/Api/V1/Controllers/Models/ObjectGroup/ListController.php index 78dab176588..79c8c29984a 100644 --- a/app/Api/V1/Controllers/Models/ObjectGroup/ListController.php +++ b/app/Api/V1/Controllers/Models/ObjectGroup/ListController.php @@ -40,6 +40,9 @@ /** * Class ListController + * + * Controlador da API responsavel pela listagem de recursos relacionados a grupos de objetos. + * Lista faturas e cofrinhos associados a um grupo de objetos especifico. */ class ListController extends Controller { diff --git a/app/Api/V1/Controllers/Models/ObjectGroup/ShowController.php b/app/Api/V1/Controllers/Models/ObjectGroup/ShowController.php index 4b06061ee2e..0c3ae5b813a 100644 --- a/app/Api/V1/Controllers/Models/ObjectGroup/ShowController.php +++ b/app/Api/V1/Controllers/Models/ObjectGroup/ShowController.php @@ -37,6 +37,9 @@ /** * Class ShowController + * + * Controlador da API responsavel pela exibicao de grupos de objetos. + * Lista todos os grupos de objetos ou exibe detalhes de um grupo especifico. */ class ShowController extends Controller { diff --git a/app/Api/V1/Controllers/Models/ObjectGroup/UpdateController.php b/app/Api/V1/Controllers/Models/ObjectGroup/UpdateController.php index 8fe4f209520..5e3c25b36c6 100644 --- a/app/Api/V1/Controllers/Models/ObjectGroup/UpdateController.php +++ b/app/Api/V1/Controllers/Models/ObjectGroup/UpdateController.php @@ -35,6 +35,9 @@ /** * Class UpdateController + * + * Controlador da API responsavel pela atualizacao de grupos de objetos. + * Atualiza dados de grupos de objetos existentes atraves da API REST. */ class UpdateController extends Controller { diff --git a/app/Api/V1/Controllers/Models/PiggyBank/DestroyController.php b/app/Api/V1/Controllers/Models/PiggyBank/DestroyController.php index 5b5736e7679..3d57eb36b70 100644 --- a/app/Api/V1/Controllers/Models/PiggyBank/DestroyController.php +++ b/app/Api/V1/Controllers/Models/PiggyBank/DestroyController.php @@ -31,6 +31,9 @@ /** * Class DestroyController + * + * Controlador da API responsavel pela exclusao de cofrinhos. + * Remove cofrinhos do sistema atraves da API REST. */ class DestroyController extends Controller { diff --git a/app/Api/V1/Controllers/Models/PiggyBank/ListController.php b/app/Api/V1/Controllers/Models/PiggyBank/ListController.php index 558255ceb4d..b2b681446a9 100644 --- a/app/Api/V1/Controllers/Models/PiggyBank/ListController.php +++ b/app/Api/V1/Controllers/Models/PiggyBank/ListController.php @@ -41,6 +41,9 @@ /** * Class ListController + * + * Controlador da API responsavel pela listagem de recursos relacionados a cofrinhos. + * Lista contas, anexos e eventos associados a um cofrinho especifico. */ class ListController extends Controller { diff --git a/app/Api/V1/Controllers/Models/PiggyBank/ShowController.php b/app/Api/V1/Controllers/Models/PiggyBank/ShowController.php index c81d49bea53..7a4404ff7a5 100644 --- a/app/Api/V1/Controllers/Models/PiggyBank/ShowController.php +++ b/app/Api/V1/Controllers/Models/PiggyBank/ShowController.php @@ -39,6 +39,9 @@ /** * Class ShowController + * + * Controlador da API responsavel pela exibicao de cofrinhos. + * Lista todos os cofrinhos ou exibe detalhes de um cofrinho especifico. */ class ShowController extends Controller { diff --git a/app/Api/V1/Controllers/Models/PiggyBank/StoreController.php b/app/Api/V1/Controllers/Models/PiggyBank/StoreController.php index 175962c5070..f0f32380ad0 100644 --- a/app/Api/V1/Controllers/Models/PiggyBank/StoreController.php +++ b/app/Api/V1/Controllers/Models/PiggyBank/StoreController.php @@ -36,6 +36,9 @@ /** * Class StoreController + * + * Controlador da API responsavel pela criacao de cofrinhos. + * Cria novos cofrinhos no sistema atraves da API REST. */ class StoreController extends Controller { diff --git a/app/Api/V1/Controllers/Models/PiggyBank/UpdateController.php b/app/Api/V1/Controllers/Models/PiggyBank/UpdateController.php index 94a6d2e0229..543a3428d9a 100644 --- a/app/Api/V1/Controllers/Models/PiggyBank/UpdateController.php +++ b/app/Api/V1/Controllers/Models/PiggyBank/UpdateController.php @@ -36,6 +36,9 @@ /** * Class UpdateController + * + * Controlador da API responsavel pela atualizacao de cofrinhos. + * Atualiza dados de cofrinhos existentes atraves da API REST. */ class UpdateController extends Controller { diff --git a/app/Api/V1/Controllers/Models/Recurrence/DestroyController.php b/app/Api/V1/Controllers/Models/Recurrence/DestroyController.php index fa67c501476..8bf478b70ba 100644 --- a/app/Api/V1/Controllers/Models/Recurrence/DestroyController.php +++ b/app/Api/V1/Controllers/Models/Recurrence/DestroyController.php @@ -31,6 +31,9 @@ /** * Class DestroyController + * + * Controlador da API responsavel pela exclusao de transacoes recorrentes. + * Remove transacoes recorrentes do sistema atraves da API REST. */ class DestroyController extends Controller { diff --git a/app/Api/V1/Controllers/Models/Recurrence/ListController.php b/app/Api/V1/Controllers/Models/Recurrence/ListController.php index 867dc46e33c..e98e0830215 100644 --- a/app/Api/V1/Controllers/Models/Recurrence/ListController.php +++ b/app/Api/V1/Controllers/Models/Recurrence/ListController.php @@ -40,6 +40,9 @@ /** * Class ListController + * + * Controlador da API responsavel pela listagem de recursos relacionados a transacoes recorrentes. + * Lista transacoes associadas a uma recorrencia especifica. */ class ListController extends Controller { diff --git a/app/Api/V1/Controllers/Models/Recurrence/ShowController.php b/app/Api/V1/Controllers/Models/Recurrence/ShowController.php index 74f29cfacea..d07743401b0 100644 --- a/app/Api/V1/Controllers/Models/Recurrence/ShowController.php +++ b/app/Api/V1/Controllers/Models/Recurrence/ShowController.php @@ -39,6 +39,9 @@ /** * Class ShowController + * + * Controlador da API responsavel pela exibicao de transacoes recorrentes. + * Lista todas as recorrencias ou exibe detalhes de uma recorrencia especifica. */ class ShowController extends Controller { diff --git a/app/Api/V1/Controllers/Models/Recurrence/StoreController.php b/app/Api/V1/Controllers/Models/Recurrence/StoreController.php index 48148bbc3b4..a194108177b 100644 --- a/app/Api/V1/Controllers/Models/Recurrence/StoreController.php +++ b/app/Api/V1/Controllers/Models/Recurrence/StoreController.php @@ -36,6 +36,9 @@ /** * Class StoreController + * + * Controlador da API responsavel pela criacao de transacoes recorrentes. + * Cria novas recorrencias no sistema atraves da API REST. */ class StoreController extends Controller { diff --git a/app/Api/V1/Controllers/Models/Recurrence/UpdateController.php b/app/Api/V1/Controllers/Models/Recurrence/UpdateController.php index e34a4450323..11d881682fa 100644 --- a/app/Api/V1/Controllers/Models/Recurrence/UpdateController.php +++ b/app/Api/V1/Controllers/Models/Recurrence/UpdateController.php @@ -36,6 +36,9 @@ /** * Class UpdateController + * + * Controlador da API responsavel pela atualizacao de transacoes recorrentes. + * Atualiza dados de recorrencias existentes atraves da API REST. */ class UpdateController extends Controller { diff --git a/app/Api/V1/Controllers/Models/Rule/DestroyController.php b/app/Api/V1/Controllers/Models/Rule/DestroyController.php index 2144a5e34f5..85db7fd9efc 100644 --- a/app/Api/V1/Controllers/Models/Rule/DestroyController.php +++ b/app/Api/V1/Controllers/Models/Rule/DestroyController.php @@ -32,6 +32,9 @@ /** * Class DestroyController + * + * Controlador da API responsavel pela exclusao de regras. + * Remove regras de automacao do sistema atraves da API REST. */ class DestroyController extends Controller { diff --git a/app/Api/V1/Controllers/Models/Rule/ShowController.php b/app/Api/V1/Controllers/Models/Rule/ShowController.php index d6ad0db7a5e..ba017ca9fda 100644 --- a/app/Api/V1/Controllers/Models/Rule/ShowController.php +++ b/app/Api/V1/Controllers/Models/Rule/ShowController.php @@ -38,6 +38,9 @@ /** * Class ShowController + * + * Controlador da API responsavel pela exibicao de regras. + * Lista todas as regras ou exibe detalhes de uma regra especifica. */ class ShowController extends Controller { diff --git a/app/Api/V1/Controllers/Models/Rule/StoreController.php b/app/Api/V1/Controllers/Models/Rule/StoreController.php index 640ebb738b8..228d48e49a0 100644 --- a/app/Api/V1/Controllers/Models/Rule/StoreController.php +++ b/app/Api/V1/Controllers/Models/Rule/StoreController.php @@ -34,6 +34,9 @@ /** * Class StoreController + * + * Controlador da API responsavel pela criacao de regras. + * Cria novas regras de automacao no sistema atraves da API REST. */ class StoreController extends Controller { diff --git a/app/Api/V1/Controllers/Models/Rule/UpdateController.php b/app/Api/V1/Controllers/Models/Rule/UpdateController.php index d58c9bd5c01..ec2a9ac079a 100644 --- a/app/Api/V1/Controllers/Models/Rule/UpdateController.php +++ b/app/Api/V1/Controllers/Models/Rule/UpdateController.php @@ -35,6 +35,9 @@ /** * Class UpdateController + * + * Controlador da API responsavel pela atualizacao de regras. + * Atualiza dados de regras existentes atraves da API REST. */ class UpdateController extends Controller { diff --git a/app/Api/V1/Controllers/Models/RuleGroup/DestroyController.php b/app/Api/V1/Controllers/Models/RuleGroup/DestroyController.php index e5ac3ccf71c..4732de67da8 100644 --- a/app/Api/V1/Controllers/Models/RuleGroup/DestroyController.php +++ b/app/Api/V1/Controllers/Models/RuleGroup/DestroyController.php @@ -32,6 +32,9 @@ /** * Class DestroyController + * + * Controlador da API responsavel pela exclusao de grupos de regras. + * Remove grupos de regras do sistema atraves da API REST. */ class DestroyController extends Controller { diff --git a/app/Api/V1/Controllers/Models/RuleGroup/ListController.php b/app/Api/V1/Controllers/Models/RuleGroup/ListController.php index af419528a1c..ddb976a2ba5 100644 --- a/app/Api/V1/Controllers/Models/RuleGroup/ListController.php +++ b/app/Api/V1/Controllers/Models/RuleGroup/ListController.php @@ -37,6 +37,9 @@ /** * Class ListController + * + * Controlador da API responsavel pela listagem de recursos relacionados a grupos de regras. + * Lista regras associadas a um grupo de regras especifico. */ class ListController extends Controller { diff --git a/app/Api/V1/Controllers/Models/RuleGroup/ShowController.php b/app/Api/V1/Controllers/Models/RuleGroup/ShowController.php index a906227340b..59d624071b2 100644 --- a/app/Api/V1/Controllers/Models/RuleGroup/ShowController.php +++ b/app/Api/V1/Controllers/Models/RuleGroup/ShowController.php @@ -38,6 +38,9 @@ /** * Class ShowController + * + * Controlador da API responsavel pela exibicao de grupos de regras. + * Lista todos os grupos de regras ou exibe detalhes de um grupo especifico. */ class ShowController extends Controller { diff --git a/app/Api/V1/Controllers/Models/RuleGroup/StoreController.php b/app/Api/V1/Controllers/Models/RuleGroup/StoreController.php index e73cf05d651..4886ac8de95 100644 --- a/app/Api/V1/Controllers/Models/RuleGroup/StoreController.php +++ b/app/Api/V1/Controllers/Models/RuleGroup/StoreController.php @@ -35,6 +35,9 @@ /** * Class StoreController + * + * Controlador da API responsavel pela criacao de grupos de regras. + * Cria novos grupos de regras no sistema atraves da API REST. */ class StoreController extends Controller { diff --git a/app/Api/V1/Controllers/Models/RuleGroup/UpdateController.php b/app/Api/V1/Controllers/Models/RuleGroup/UpdateController.php index 3d3c514768d..c03a9517dac 100644 --- a/app/Api/V1/Controllers/Models/RuleGroup/UpdateController.php +++ b/app/Api/V1/Controllers/Models/RuleGroup/UpdateController.php @@ -35,6 +35,9 @@ /** * Class UpdateController + * + * Controlador da API responsavel pela atualizacao de grupos de regras. + * Atualiza dados de grupos de regras existentes atraves da API REST. */ class UpdateController extends Controller { diff --git a/app/Api/V1/Controllers/Models/Tag/DestroyController.php b/app/Api/V1/Controllers/Models/Tag/DestroyController.php index 2f46224b32c..d2cd47ce6da 100644 --- a/app/Api/V1/Controllers/Models/Tag/DestroyController.php +++ b/app/Api/V1/Controllers/Models/Tag/DestroyController.php @@ -32,6 +32,9 @@ /** * Class DestroyController + * + * Controlador da API responsavel pela exclusao de tags. + * Remove tags do sistema atraves da API REST. */ class DestroyController extends Controller { diff --git a/app/Api/V1/Controllers/Models/Tag/ListController.php b/app/Api/V1/Controllers/Models/Tag/ListController.php index 1fc4629b05d..846b07244ea 100644 --- a/app/Api/V1/Controllers/Models/Tag/ListController.php +++ b/app/Api/V1/Controllers/Models/Tag/ListController.php @@ -42,6 +42,9 @@ /** * Class ListController + * + * Controlador da API responsavel pela listagem de recursos relacionados a tags. + * Lista anexos e transacoes associados a uma tag especifica. */ class ListController extends Controller { diff --git a/app/Api/V1/Controllers/Models/Tag/ShowController.php b/app/Api/V1/Controllers/Models/Tag/ShowController.php index 5e59c4bf11f..c9da667a036 100644 --- a/app/Api/V1/Controllers/Models/Tag/ShowController.php +++ b/app/Api/V1/Controllers/Models/Tag/ShowController.php @@ -38,6 +38,9 @@ /** * Class ShowController + * + * Controlador da API responsavel pela exibicao de tags. + * Lista todas as tags ou exibe detalhes de uma tag especifica. */ class ShowController extends Controller { diff --git a/app/Api/V1/Controllers/Models/Tag/StoreController.php b/app/Api/V1/Controllers/Models/Tag/StoreController.php index 8308532e799..172d3f4b40c 100644 --- a/app/Api/V1/Controllers/Models/Tag/StoreController.php +++ b/app/Api/V1/Controllers/Models/Tag/StoreController.php @@ -34,6 +34,9 @@ /** * Class StoreController + * + * Controlador da API responsavel pela criacao de tags. + * Cria novas tags no sistema atraves da API REST. */ class StoreController extends Controller { diff --git a/app/Api/V1/Controllers/Models/Tag/UpdateController.php b/app/Api/V1/Controllers/Models/Tag/UpdateController.php index 515322370c9..acabb3a4fd3 100644 --- a/app/Api/V1/Controllers/Models/Tag/UpdateController.php +++ b/app/Api/V1/Controllers/Models/Tag/UpdateController.php @@ -35,6 +35,9 @@ /** * Class UpdateController + * + * Controlador da API responsavel pela atualizacao de tags. + * Atualiza dados de tags existentes atraves da API REST. */ class UpdateController extends Controller { diff --git a/app/Api/V1/Controllers/Models/Transaction/DestroyController.php b/app/Api/V1/Controllers/Models/Transaction/DestroyController.php index f77339b188a..cbe5a6916d3 100644 --- a/app/Api/V1/Controllers/Models/Transaction/DestroyController.php +++ b/app/Api/V1/Controllers/Models/Transaction/DestroyController.php @@ -38,6 +38,9 @@ /** * Class DestroyController + * + * Controlador da API responsavel pela exclusao de transacoes. + * Remove transacoes e grupos de transacoes do sistema atraves da API REST. */ class DestroyController extends Controller { diff --git a/app/Api/V1/Controllers/Models/Transaction/ListController.php b/app/Api/V1/Controllers/Models/Transaction/ListController.php index 560324e7ffb..5e09487e50e 100644 --- a/app/Api/V1/Controllers/Models/Transaction/ListController.php +++ b/app/Api/V1/Controllers/Models/Transaction/ListController.php @@ -42,6 +42,9 @@ /** * Class ListController + * + * Controlador da API responsavel pela listagem de recursos relacionados a transacoes. + * Lista anexos, eventos de cofrinhos e links associados a uma transacao especifica. */ class ListController extends Controller { diff --git a/app/Api/V1/Controllers/Models/Transaction/ShowController.php b/app/Api/V1/Controllers/Models/Transaction/ShowController.php index b20fab792d6..5299841801a 100644 --- a/app/Api/V1/Controllers/Models/Transaction/ShowController.php +++ b/app/Api/V1/Controllers/Models/Transaction/ShowController.php @@ -42,6 +42,9 @@ /** * Class ShowController + * + * Controlador da API responsavel pela exibicao de transacoes. + * Lista todas as transacoes ou exibe detalhes de uma transacao especifica. */ class ShowController extends Controller { diff --git a/app/Api/V1/Controllers/Models/Transaction/StoreController.php b/app/Api/V1/Controllers/Models/Transaction/StoreController.php index 37acce2eb65..d2a0090378f 100644 --- a/app/Api/V1/Controllers/Models/Transaction/StoreController.php +++ b/app/Api/V1/Controllers/Models/Transaction/StoreController.php @@ -45,6 +45,9 @@ /** * Class StoreController + * + * Controlador da API responsavel pela criacao de transacoes. + * Cria novas transacoes no sistema atraves da API REST. */ class StoreController extends Controller { diff --git a/app/Api/V1/Controllers/Models/Transaction/UpdateController.php b/app/Api/V1/Controllers/Models/Transaction/UpdateController.php index 6db7503671a..93bae0f7043 100644 --- a/app/Api/V1/Controllers/Models/Transaction/UpdateController.php +++ b/app/Api/V1/Controllers/Models/Transaction/UpdateController.php @@ -40,6 +40,9 @@ /** * Class UpdateController + * + * Controlador da API responsavel pela atualizacao de transacoes. + * Atualiza dados de transacoes existentes atraves da API REST. */ class UpdateController extends Controller { diff --git a/app/Api/V1/Controllers/Models/TransactionCurrency/DestroyController.php b/app/Api/V1/Controllers/Models/TransactionCurrency/DestroyController.php index b7c7e69a34f..c726197987c 100644 --- a/app/Api/V1/Controllers/Models/TransactionCurrency/DestroyController.php +++ b/app/Api/V1/Controllers/Models/TransactionCurrency/DestroyController.php @@ -36,6 +36,9 @@ /** * Class DestroyController + * + * Controlador da API responsavel pela exclusao de moedas. + * Remove moedas do sistema atraves da API REST. */ class DestroyController extends Controller { diff --git a/app/Api/V1/Controllers/Models/TransactionCurrency/ListController.php b/app/Api/V1/Controllers/Models/TransactionCurrency/ListController.php index 17fb1c075a8..b459f0fed22 100644 --- a/app/Api/V1/Controllers/Models/TransactionCurrency/ListController.php +++ b/app/Api/V1/Controllers/Models/TransactionCurrency/ListController.php @@ -63,6 +63,9 @@ /** * Class ListController + * + * Controlador da API responsavel pela listagem de recursos relacionados a moedas. + * Lista contas, orcamentos disponiveis, faturas, limites de orcamento, recorrencias, regras e transacoes por moeda. */ class ListController extends Controller { diff --git a/app/Api/V1/Controllers/Models/TransactionCurrency/ShowController.php b/app/Api/V1/Controllers/Models/TransactionCurrency/ShowController.php index 481896505c8..22e4494e883 100644 --- a/app/Api/V1/Controllers/Models/TransactionCurrency/ShowController.php +++ b/app/Api/V1/Controllers/Models/TransactionCurrency/ShowController.php @@ -40,6 +40,9 @@ /** * Class ShowController + * + * Controlador da API responsavel pela exibicao de moedas. + * Lista todas as moedas ou exibe detalhes de uma moeda especifica. */ class ShowController extends Controller { diff --git a/app/Api/V1/Controllers/Models/TransactionCurrency/StoreController.php b/app/Api/V1/Controllers/Models/TransactionCurrency/StoreController.php index 5e4364043f6..31c8e410c92 100644 --- a/app/Api/V1/Controllers/Models/TransactionCurrency/StoreController.php +++ b/app/Api/V1/Controllers/Models/TransactionCurrency/StoreController.php @@ -37,6 +37,9 @@ /** * Class StoreController + * + * Controlador da API responsavel pela criacao de moedas. + * Cria novas moedas no sistema atraves da API REST. */ class StoreController extends Controller { diff --git a/app/Api/V1/Controllers/Models/TransactionCurrency/UpdateController.php b/app/Api/V1/Controllers/Models/TransactionCurrency/UpdateController.php index f9a45ffdee3..a3eb6aa04de 100644 --- a/app/Api/V1/Controllers/Models/TransactionCurrency/UpdateController.php +++ b/app/Api/V1/Controllers/Models/TransactionCurrency/UpdateController.php @@ -39,6 +39,9 @@ /** * Class UpdateController + * + * Controlador da API responsavel pela atualizacao de moedas. + * Atualiza, habilita, desabilita e define moedas como primarias atraves da API REST. */ class UpdateController extends Controller { diff --git a/app/Api/V1/Controllers/Models/TransactionLink/DestroyController.php b/app/Api/V1/Controllers/Models/TransactionLink/DestroyController.php index e5c0b5ff46a..06f2fbf80cd 100644 --- a/app/Api/V1/Controllers/Models/TransactionLink/DestroyController.php +++ b/app/Api/V1/Controllers/Models/TransactionLink/DestroyController.php @@ -32,6 +32,9 @@ /** * Class DestroyController + * + * Controlador da API responsavel pela exclusao de links de transacoes. + * Remove links entre transacoes do sistema atraves da API REST. */ class DestroyController extends Controller { diff --git a/app/Api/V1/Controllers/Models/TransactionLink/ShowController.php b/app/Api/V1/Controllers/Models/TransactionLink/ShowController.php index f5874f90ae6..076d749755a 100644 --- a/app/Api/V1/Controllers/Models/TransactionLink/ShowController.php +++ b/app/Api/V1/Controllers/Models/TransactionLink/ShowController.php @@ -39,6 +39,9 @@ /** * Class ShowController + * + * Controlador da API responsavel pela exibicao de links de transacoes. + * Lista todos os links ou exibe detalhes de um link especifico. */ class ShowController extends Controller { diff --git a/app/Api/V1/Controllers/Models/TransactionLink/StoreController.php b/app/Api/V1/Controllers/Models/TransactionLink/StoreController.php index 89219ff30aa..b117b3ec3f8 100644 --- a/app/Api/V1/Controllers/Models/TransactionLink/StoreController.php +++ b/app/Api/V1/Controllers/Models/TransactionLink/StoreController.php @@ -38,6 +38,9 @@ /** * Class StoreController + * + * Controlador da API responsavel pela criacao de links de transacoes. + * Cria novos links entre transacoes no sistema atraves da API REST. */ class StoreController extends Controller { diff --git a/app/Api/V1/Controllers/Models/TransactionLink/UpdateController.php b/app/Api/V1/Controllers/Models/TransactionLink/UpdateController.php index 289774ad391..f964c97f691 100644 --- a/app/Api/V1/Controllers/Models/TransactionLink/UpdateController.php +++ b/app/Api/V1/Controllers/Models/TransactionLink/UpdateController.php @@ -36,6 +36,9 @@ /** * Class UpdateController + * + * Controlador da API responsavel pela atualizacao de links de transacoes. + * Atualiza dados de links entre transacoes existentes atraves da API REST. */ class UpdateController extends Controller { diff --git a/app/Api/V1/Controllers/Models/TransactionLinkType/DestroyController.php b/app/Api/V1/Controllers/Models/TransactionLinkType/DestroyController.php index 7abbff55d71..40ae53709ff 100644 --- a/app/Api/V1/Controllers/Models/TransactionLinkType/DestroyController.php +++ b/app/Api/V1/Controllers/Models/TransactionLinkType/DestroyController.php @@ -34,6 +34,9 @@ /** * Class DestroyController + * + * Controlador da API responsavel pela exclusao de tipos de links de transacoes. + * Remove tipos de links do sistema atraves da API REST. */ class DestroyController extends Controller { diff --git a/app/Api/V1/Controllers/Models/TransactionLinkType/ShowController.php b/app/Api/V1/Controllers/Models/TransactionLinkType/ShowController.php index 9fa5e2e4970..2feb139c0ec 100644 --- a/app/Api/V1/Controllers/Models/TransactionLinkType/ShowController.php +++ b/app/Api/V1/Controllers/Models/TransactionLinkType/ShowController.php @@ -39,6 +39,9 @@ /** * Class ShowController + * + * Controlador da API responsavel pela exibicao de tipos de links de transacoes. + * Lista todos os tipos de links ou exibe detalhes de um tipo especifico. */ class ShowController extends Controller { diff --git a/app/Api/V1/Controllers/Models/TransactionLinkType/StoreController.php b/app/Api/V1/Controllers/Models/TransactionLinkType/StoreController.php index 7e534e39939..f7235a19e3d 100644 --- a/app/Api/V1/Controllers/Models/TransactionLinkType/StoreController.php +++ b/app/Api/V1/Controllers/Models/TransactionLinkType/StoreController.php @@ -38,6 +38,9 @@ /** * Class StoreController + * + * Controlador da API responsavel pela criacao de tipos de links de transacoes. + * Cria novos tipos de links no sistema atraves da API REST. */ class StoreController extends Controller { diff --git a/app/Api/V1/Controllers/Models/TransactionLinkType/UpdateController.php b/app/Api/V1/Controllers/Models/TransactionLinkType/UpdateController.php index 2b43fa81df4..bd035b2e006 100644 --- a/app/Api/V1/Controllers/Models/TransactionLinkType/UpdateController.php +++ b/app/Api/V1/Controllers/Models/TransactionLinkType/UpdateController.php @@ -40,6 +40,9 @@ /** * Class UpdateController + * + * Controlador da API responsavel pela atualizacao de tipos de links de transacoes. + * Atualiza dados de tipos de links existentes atraves da API REST. */ class UpdateController extends Controller { diff --git a/app/Api/V1/Controllers/Models/UserGroup/ShowController.php b/app/Api/V1/Controllers/Models/UserGroup/ShowController.php index f8ae23d4d95..30e7ec98638 100644 --- a/app/Api/V1/Controllers/Models/UserGroup/ShowController.php +++ b/app/Api/V1/Controllers/Models/UserGroup/ShowController.php @@ -32,6 +32,9 @@ /** * Class ShowController + * + * Controlador da API responsavel pela exibicao de grupos de usuarios. + * Exibe detalhes de um grupo de usuarios especifico. */ class ShowController extends Controller { diff --git a/app/Api/V1/Controllers/Models/UserGroup/UpdateController.php b/app/Api/V1/Controllers/Models/UserGroup/UpdateController.php index e1a9e517e57..22be3886323 100644 --- a/app/Api/V1/Controllers/Models/UserGroup/UpdateController.php +++ b/app/Api/V1/Controllers/Models/UserGroup/UpdateController.php @@ -32,6 +32,12 @@ use Illuminate\Http\JsonResponse; use Illuminate\Support\Facades\Log; +/** + * Class UpdateController + * + * Controlador da API responsavel pela atualizacao de grupos de usuarios. + * Atualiza dados de grupos de usuarios existentes atraves da API REST. + */ class UpdateController extends Controller { public const string RESOURCE_KEY = 'user_groups'; diff --git a/app/Api/V1/Controllers/Search/AccountController.php b/app/Api/V1/Controllers/Search/AccountController.php index cfcad8642a9..b52d5c1694e 100644 --- a/app/Api/V1/Controllers/Search/AccountController.php +++ b/app/Api/V1/Controllers/Search/AccountController.php @@ -40,6 +40,10 @@ /** * Class AccountController + * + * Controlador da API responsavel pela busca de contas. + * Permite pesquisar contas por ID, nome, IBAN ou numero, + * com suporte a filtragem por tipo de conta. */ class AccountController extends Controller { diff --git a/app/Api/V1/Controllers/Search/TransactionController.php b/app/Api/V1/Controllers/Search/TransactionController.php index a68f44d8a61..6726282a2e0 100644 --- a/app/Api/V1/Controllers/Search/TransactionController.php +++ b/app/Api/V1/Controllers/Search/TransactionController.php @@ -36,6 +36,10 @@ /** * Class TransactionController + * + * Controlador da API responsavel pela busca de transacoes. + * Permite pesquisar transacoes usando queries complexas + * com suporte a paginacao e enriquecimento de dados. */ class TransactionController extends Controller { diff --git a/app/Api/V1/Controllers/Summary/BasicController.php b/app/Api/V1/Controllers/Summary/BasicController.php index 096ed01db77..4b3c6a41ed6 100644 --- a/app/Api/V1/Controllers/Summary/BasicController.php +++ b/app/Api/V1/Controllers/Summary/BasicController.php @@ -49,6 +49,10 @@ /** * Class BasicController + * + * Controlador da API responsavel pelo resumo financeiro basico. + * Fornece informacoes agregadas sobre saldo, receitas, despesas, + * assinaturas, orcamentos e patrimonio liquido do usuario. */ class BasicController extends Controller { diff --git a/app/Api/V1/Controllers/System/AboutController.php b/app/Api/V1/Controllers/System/AboutController.php index c9f74933e69..a4cbe87468b 100644 --- a/app/Api/V1/Controllers/System/AboutController.php +++ b/app/Api/V1/Controllers/System/AboutController.php @@ -31,9 +31,11 @@ use League\Fractal\Resource\Item; /** - * Returns basic information about this installation. + * Class AboutController * - * Class AboutController. + * Controlador da API responsavel por informacoes do sistema. + * Retorna informacoes basicas sobre a instalacao como versao, + * versao do PHP, sistema operacional e driver de banco de dados. */ class AboutController extends Controller { diff --git a/app/Api/V1/Controllers/System/ConfigurationController.php b/app/Api/V1/Controllers/System/ConfigurationController.php index 6331ef03916..74462ad1fe3 100644 --- a/app/Api/V1/Controllers/System/ConfigurationController.php +++ b/app/Api/V1/Controllers/System/ConfigurationController.php @@ -40,6 +40,10 @@ /** * Class ConfigurationController + * + * Controlador da API responsavel pela configuracao do sistema. + * Permite visualizar e atualizar configuracoes dinamicas + * como modo demo, verificacao de atualizacoes e modo usuario unico. */ class ConfigurationController extends Controller { diff --git a/app/Api/V1/Controllers/System/CronController.php b/app/Api/V1/Controllers/System/CronController.php index 941211efbd2..5a7e152614d 100644 --- a/app/Api/V1/Controllers/System/CronController.php +++ b/app/Api/V1/Controllers/System/CronController.php @@ -32,6 +32,10 @@ /** * Class CronController + * + * Controlador da API responsavel pela execucao de tarefas cron. + * Executa tarefas agendadas como transacoes recorrentes, orcamentos + * automaticos, taxas de cambio e notificacoes de faturas. */ class CronController extends Controller { diff --git a/app/Api/V1/Controllers/System/UserController.php b/app/Api/V1/Controllers/System/UserController.php index 0928c041a94..a19d8e2d316 100644 --- a/app/Api/V1/Controllers/System/UserController.php +++ b/app/Api/V1/Controllers/System/UserController.php @@ -39,7 +39,11 @@ use League\Fractal\Resource\Item; /** - * Class UserController. + * Class UserController + * + * Controlador da API responsavel pelo gerenciamento de usuarios. + * Permite listar, criar, atualizar e excluir usuarios do sistema + * com controle de permissoes baseado em roles. */ class UserController extends Controller { diff --git a/app/Api/V1/Controllers/User/PreferencesController.php b/app/Api/V1/Controllers/User/PreferencesController.php index d2040588e38..e79c80d134d 100644 --- a/app/Api/V1/Controllers/User/PreferencesController.php +++ b/app/Api/V1/Controllers/User/PreferencesController.php @@ -38,6 +38,10 @@ /** * Class PreferencesController + * + * Controlador da API responsavel pelas preferencias do usuario. + * Permite listar, visualizar, criar e atualizar preferencias + * de configuracao do usuario no sistema. */ class PreferencesController extends Controller { diff --git a/app/Api/V1/Controllers/Webhook/AttemptController.php b/app/Api/V1/Controllers/Webhook/AttemptController.php index 2a8f9491766..8d145d3a1eb 100644 --- a/app/Api/V1/Controllers/Webhook/AttemptController.php +++ b/app/Api/V1/Controllers/Webhook/AttemptController.php @@ -41,6 +41,10 @@ /** * Class AttemptController + * + * Controlador da API responsavel pelas tentativas de webhook. + * Permite listar e visualizar tentativas de envio de mensagens + * de webhook, incluindo status e logs de resposta. */ class AttemptController extends Controller { diff --git a/app/Api/V1/Controllers/Webhook/DestroyController.php b/app/Api/V1/Controllers/Webhook/DestroyController.php index 4899c7be206..611f52517ca 100644 --- a/app/Api/V1/Controllers/Webhook/DestroyController.php +++ b/app/Api/V1/Controllers/Webhook/DestroyController.php @@ -36,6 +36,10 @@ /** * Class DestroyController + * + * Controlador da API responsavel pela exclusao de webhooks. + * Permite excluir webhooks, mensagens de webhook e tentativas + * de envio de mensagens de webhook. */ class DestroyController extends Controller { diff --git a/app/Api/V1/Controllers/Webhook/MessageController.php b/app/Api/V1/Controllers/Webhook/MessageController.php index 6e14814f6fb..a7047cebbb5 100644 --- a/app/Api/V1/Controllers/Webhook/MessageController.php +++ b/app/Api/V1/Controllers/Webhook/MessageController.php @@ -40,6 +40,10 @@ /** * Class MessageController + * + * Controlador da API responsavel pelas mensagens de webhook. + * Permite listar e visualizar mensagens geradas por webhooks, + * incluindo o payload e status de envio. */ class MessageController extends Controller { diff --git a/app/Api/V1/Controllers/Webhook/ShowController.php b/app/Api/V1/Controllers/Webhook/ShowController.php index 31906c85eda..07604aa6d66 100644 --- a/app/Api/V1/Controllers/Webhook/ShowController.php +++ b/app/Api/V1/Controllers/Webhook/ShowController.php @@ -44,6 +44,10 @@ /** * Class ShowController + * + * Controlador da API responsavel pela exibicao de webhooks. + * Permite listar todos os webhooks, visualizar um webhook especifico + * e disparar webhooks manualmente para transacoes. */ class ShowController extends Controller { diff --git a/app/Api/V1/Controllers/Webhook/StoreController.php b/app/Api/V1/Controllers/Webhook/StoreController.php index 77ea1de82a3..773ed0d3860 100644 --- a/app/Api/V1/Controllers/Webhook/StoreController.php +++ b/app/Api/V1/Controllers/Webhook/StoreController.php @@ -35,6 +35,10 @@ /** * Class StoreController + * + * Controlador da API responsavel pela criacao de webhooks. + * Permite criar novos webhooks com configuracoes de URL, + * gatilho, resposta e status ativo. */ class StoreController extends Controller { diff --git a/app/Api/V1/Controllers/Webhook/SubmitController.php b/app/Api/V1/Controllers/Webhook/SubmitController.php index 034bea04b6a..4f80c366af3 100644 --- a/app/Api/V1/Controllers/Webhook/SubmitController.php +++ b/app/Api/V1/Controllers/Webhook/SubmitController.php @@ -34,6 +34,10 @@ /** * Class SubmitController + * + * Controlador da API responsavel pelo envio de webhooks. + * Permite disparar manualmente o envio de mensagens pendentes + * de um webhook especifico. */ class SubmitController extends Controller { diff --git a/app/Api/V1/Controllers/Webhook/UpdateController.php b/app/Api/V1/Controllers/Webhook/UpdateController.php index 7e2e0e2353e..d979921a5a1 100644 --- a/app/Api/V1/Controllers/Webhook/UpdateController.php +++ b/app/Api/V1/Controllers/Webhook/UpdateController.php @@ -36,6 +36,10 @@ /** * Class UpdateController + * + * Controlador da API responsavel pela atualizacao de webhooks. + * Permite modificar configuracoes de webhooks existentes + * como URL, gatilho, resposta e status ativo. */ class UpdateController extends Controller { diff --git a/app/Api/V1/Middleware/ApiDemoUser.php b/app/Api/V1/Middleware/ApiDemoUser.php index cd85e948792..99e5dde5b6f 100644 --- a/app/Api/V1/Middleware/ApiDemoUser.php +++ b/app/Api/V1/Middleware/ApiDemoUser.php @@ -28,7 +28,10 @@ use Illuminate\Http\Request; /** - * Class ApiDemoUser. + * Class ApiDemoUser + * + * Middleware para protecao de usuarios demo na API. + * Bloqueia requisicoes de usuarios com role 'demo' para proteger dados de demonstracao. */ class ApiDemoUser { diff --git a/app/Api/V1/Requests/Autocomplete/AutocompleteRequest.php b/app/Api/V1/Requests/Autocomplete/AutocompleteRequest.php index 566624b0600..2e88ec7eb9c 100644 --- a/app/Api/V1/Requests/Autocomplete/AutocompleteRequest.php +++ b/app/Api/V1/Requests/Autocomplete/AutocompleteRequest.php @@ -31,6 +31,9 @@ /** * Class AutocompleteRequest + * + * Classe de requisicao para funcionalidade de autocompletar. + * Valida e processa dados de busca para sugestoes de autocompletar. */ class AutocompleteRequest extends FormRequest { diff --git a/app/Api/V1/Requests/Chart/ChartRequest.php b/app/Api/V1/Requests/Chart/ChartRequest.php index 2ef933a1c21..5bb131c021e 100644 --- a/app/Api/V1/Requests/Chart/ChartRequest.php +++ b/app/Api/V1/Requests/Chart/ChartRequest.php @@ -34,6 +34,9 @@ /** * Class ChartRequest + * + * Classe de requisicao para geracao de graficos. + * Valida e processa parametros de periodo, contas e configuracoes de graficos. */ class ChartRequest extends FormRequest { diff --git a/app/Api/V1/Requests/Data/Bulk/MoveTransactionsRequest.php b/app/Api/V1/Requests/Data/Bulk/MoveTransactionsRequest.php index 8731e354aac..cbc68910c4c 100644 --- a/app/Api/V1/Requests/Data/Bulk/MoveTransactionsRequest.php +++ b/app/Api/V1/Requests/Data/Bulk/MoveTransactionsRequest.php @@ -33,6 +33,9 @@ /** * Class MoveTransactionsRequest + * + * Classe de requisicao para movimentacao em massa de transacoes. + * Valida e processa dados de movimentacao de transacoes entre contas. */ class MoveTransactionsRequest extends FormRequest { diff --git a/app/Api/V1/Requests/Data/Bulk/TransactionRequest.php b/app/Api/V1/Requests/Data/Bulk/TransactionRequest.php index b02ee211498..5a94f39dee5 100644 --- a/app/Api/V1/Requests/Data/Bulk/TransactionRequest.php +++ b/app/Api/V1/Requests/Data/Bulk/TransactionRequest.php @@ -38,6 +38,9 @@ /** * Class TransactionRequest + * + * Classe de requisicao para operacoes em massa de transacoes. + * Valida e processa consultas JSON para operacoes em lote. */ class TransactionRequest extends FormRequest { diff --git a/app/Api/V1/Requests/Data/DestroyRequest.php b/app/Api/V1/Requests/Data/DestroyRequest.php index 082fb00adb5..b2c4f2f8bd3 100644 --- a/app/Api/V1/Requests/Data/DestroyRequest.php +++ b/app/Api/V1/Requests/Data/DestroyRequest.php @@ -30,6 +30,9 @@ /** * Class DestroyRequest + * + * Classe de requisicao para exclusao em massa de dados. + * Valida e processa parametros de exclusao de objetos do sistema. */ class DestroyRequest extends FormRequest { diff --git a/app/Api/V1/Requests/Data/Export/ExportRequest.php b/app/Api/V1/Requests/Data/Export/ExportRequest.php index 541529e2edf..f9dba751711 100644 --- a/app/Api/V1/Requests/Data/Export/ExportRequest.php +++ b/app/Api/V1/Requests/Data/Export/ExportRequest.php @@ -33,6 +33,9 @@ /** * Class ExportRequest + * + * Classe de requisicao para exportacao de dados. + * Valida e processa parametros de exportacao de transacoes em formato CSV. */ class ExportRequest extends FormRequest { diff --git a/app/Api/V1/Requests/Insight/GenericRequest.php b/app/Api/V1/Requests/Insight/GenericRequest.php index 4e98c50b5e4..62e2a96a206 100644 --- a/app/Api/V1/Requests/Insight/GenericRequest.php +++ b/app/Api/V1/Requests/Insight/GenericRequest.php @@ -39,6 +39,9 @@ /** * Class GenericRequest + * + * Classe de requisicao generica para endpoints de insights. + * Valida e processa parametros de periodo, contas, orcamentos, categorias, faturas e tags. */ class GenericRequest extends FormRequest { diff --git a/app/Api/V1/Requests/Models/Account/StoreRequest.php b/app/Api/V1/Requests/Models/Account/StoreRequest.php index 3d04bb7cee6..4d3f1255d4b 100644 --- a/app/Api/V1/Requests/Models/Account/StoreRequest.php +++ b/app/Api/V1/Requests/Models/Account/StoreRequest.php @@ -36,6 +36,9 @@ /** * Class StoreRequest + * + * Classe de requisicao para criacao de contas. + * Valida e processa dados de criacao de contas incluindo saldo inicial e localizacao. */ class StoreRequest extends FormRequest { diff --git a/app/Api/V1/Requests/Models/Account/UpdateRequest.php b/app/Api/V1/Requests/Models/Account/UpdateRequest.php index 5fb31b6fc86..eb84fba876c 100644 --- a/app/Api/V1/Requests/Models/Account/UpdateRequest.php +++ b/app/Api/V1/Requests/Models/Account/UpdateRequest.php @@ -39,6 +39,9 @@ /** * Class UpdateRequest + * + * Classe de requisicao para atualizacao de contas. + * Valida e processa dados de atualizacao de contas incluindo saldo inicial e localizacao. */ class UpdateRequest extends FormRequest { diff --git a/app/Api/V1/Requests/Models/Attachment/StoreRequest.php b/app/Api/V1/Requests/Models/Attachment/StoreRequest.php index 2c8f572843b..f3bdaaaaadb 100644 --- a/app/Api/V1/Requests/Models/Attachment/StoreRequest.php +++ b/app/Api/V1/Requests/Models/Attachment/StoreRequest.php @@ -31,6 +31,9 @@ /** * Class StoreRequest + * + * Classe de requisicao para criacao de anexos. + * Valida e processa dados de criacao de anexos para modelos do sistema. */ class StoreRequest extends FormRequest { diff --git a/app/Api/V1/Requests/Models/Attachment/UpdateRequest.php b/app/Api/V1/Requests/Models/Attachment/UpdateRequest.php index c84cd6a9d90..2776ae1db8e 100644 --- a/app/Api/V1/Requests/Models/Attachment/UpdateRequest.php +++ b/app/Api/V1/Requests/Models/Attachment/UpdateRequest.php @@ -31,6 +31,9 @@ /** * Class UpdateRequest + * + * Classe de requisicao para atualizacao de anexos. + * Valida e processa dados de atualizacao de anexos para modelos do sistema. */ class UpdateRequest extends FormRequest { diff --git a/app/Api/V1/Requests/Models/AvailableBudget/Request.php b/app/Api/V1/Requests/Models/AvailableBudget/Request.php index 93b3f732b01..6af44367459 100644 --- a/app/Api/V1/Requests/Models/AvailableBudget/Request.php +++ b/app/Api/V1/Requests/Models/AvailableBudget/Request.php @@ -34,6 +34,9 @@ /** * Class Request + * + * Classe de requisicao para orcamento disponivel. + * Valida e processa dados de orcamento disponivel incluindo moeda e periodo. */ class Request extends FormRequest { diff --git a/app/Api/V1/Requests/Models/Bill/StoreRequest.php b/app/Api/V1/Requests/Models/Bill/StoreRequest.php index 46b0027e7e8..4f6a5c8ce9e 100644 --- a/app/Api/V1/Requests/Models/Bill/StoreRequest.php +++ b/app/Api/V1/Requests/Models/Bill/StoreRequest.php @@ -36,6 +36,9 @@ /** * Class StoreRequest + * + * Classe de requisicao para criacao de faturas. + * Valida e processa dados de criacao de faturas recorrentes. */ class StoreRequest extends FormRequest { diff --git a/app/Api/V1/Requests/Models/Bill/UpdateRequest.php b/app/Api/V1/Requests/Models/Bill/UpdateRequest.php index 149f5ad4b79..3b2a2243f87 100644 --- a/app/Api/V1/Requests/Models/Bill/UpdateRequest.php +++ b/app/Api/V1/Requests/Models/Bill/UpdateRequest.php @@ -35,6 +35,9 @@ /** * Class UpdateRequest + * + * Classe de requisicao para atualizacao de faturas. + * Valida e processa dados de atualizacao de faturas recorrentes. */ class UpdateRequest extends FormRequest { diff --git a/app/Api/V1/Requests/Models/Budget/StoreRequest.php b/app/Api/V1/Requests/Models/Budget/StoreRequest.php index 43f44c7720b..677b625260a 100644 --- a/app/Api/V1/Requests/Models/Budget/StoreRequest.php +++ b/app/Api/V1/Requests/Models/Budget/StoreRequest.php @@ -35,6 +35,9 @@ /** * Class StoreRequest + * + * Classe de requisicao para criacao de orcamentos. + * Valida e processa dados de criacao de orcamentos incluindo configuracoes de auto-orcamento. */ class StoreRequest extends FormRequest { diff --git a/app/Api/V1/Requests/Models/Budget/UpdateRequest.php b/app/Api/V1/Requests/Models/Budget/UpdateRequest.php index ed1d119e934..4c4282f5a20 100644 --- a/app/Api/V1/Requests/Models/Budget/UpdateRequest.php +++ b/app/Api/V1/Requests/Models/Budget/UpdateRequest.php @@ -36,6 +36,9 @@ /** * Class UpdateRequest + * + * Classe de requisicao para atualizacao de orcamentos. + * Valida e processa dados de atualizacao de orcamentos incluindo configuracoes de auto-orcamento. */ class UpdateRequest extends FormRequest { diff --git a/app/Api/V1/Requests/Models/BudgetLimit/StoreRequest.php b/app/Api/V1/Requests/Models/BudgetLimit/StoreRequest.php index 48c77cf2a2a..5ed0047e67a 100644 --- a/app/Api/V1/Requests/Models/BudgetLimit/StoreRequest.php +++ b/app/Api/V1/Requests/Models/BudgetLimit/StoreRequest.php @@ -31,6 +31,9 @@ /** * Class StoreRequest + * + * Classe de requisicao para criacao de limites de orcamento. + * Valida e processa dados de criacao de limites de orcamento incluindo periodo e valor. */ class StoreRequest extends FormRequest { diff --git a/app/Api/V1/Requests/Models/BudgetLimit/UpdateRequest.php b/app/Api/V1/Requests/Models/BudgetLimit/UpdateRequest.php index 3c0fc08c372..acc0d77f186 100644 --- a/app/Api/V1/Requests/Models/BudgetLimit/UpdateRequest.php +++ b/app/Api/V1/Requests/Models/BudgetLimit/UpdateRequest.php @@ -34,6 +34,9 @@ /** * Class UpdateRequest + * + * Classe de requisicao para atualizacao de limites de orcamento. + * Valida e processa dados de atualizacao de limites de orcamento incluindo periodo e valor. */ class UpdateRequest extends FormRequest { diff --git a/app/Api/V1/Requests/Models/Category/StoreRequest.php b/app/Api/V1/Requests/Models/Category/StoreRequest.php index ae0670a2855..90a15716aea 100644 --- a/app/Api/V1/Requests/Models/Category/StoreRequest.php +++ b/app/Api/V1/Requests/Models/Category/StoreRequest.php @@ -30,6 +30,9 @@ /** * Class StoreRequest + * + * Classe de requisicao para criacao de categorias. + * Valida e processa dados de criacao de categorias de transacoes. */ class StoreRequest extends FormRequest { diff --git a/app/Api/V1/Requests/Models/Category/UpdateRequest.php b/app/Api/V1/Requests/Models/Category/UpdateRequest.php index 3d63e642664..e60c0f25115 100644 --- a/app/Api/V1/Requests/Models/Category/UpdateRequest.php +++ b/app/Api/V1/Requests/Models/Category/UpdateRequest.php @@ -31,6 +31,9 @@ /** * Class UpdateRequest + * + * Classe de requisicao para atualizacao de categorias. + * Valida e processa dados de atualizacao de categorias de transacoes. */ class UpdateRequest extends FormRequest { diff --git a/app/Api/V1/Requests/Models/CurrencyExchangeRate/DestroyRequest.php b/app/Api/V1/Requests/Models/CurrencyExchangeRate/DestroyRequest.php index 82ff8ca3de7..64f6d63c74f 100644 --- a/app/Api/V1/Requests/Models/CurrencyExchangeRate/DestroyRequest.php +++ b/app/Api/V1/Requests/Models/CurrencyExchangeRate/DestroyRequest.php @@ -29,6 +29,12 @@ use FireflyIII\Support\Request\ConvertsDataTypes; use Illuminate\Foundation\Http\FormRequest; +/** + * Class DestroyRequest + * + * Classe de requisicao para exclusao de taxas de cambio. + * Valida e processa parametros de exclusao de taxas de cambio de moedas. + */ class DestroyRequest extends FormRequest { use ChecksLogin; diff --git a/app/Api/V1/Requests/Models/CurrencyExchangeRate/StoreByCurrenciesRequest.php b/app/Api/V1/Requests/Models/CurrencyExchangeRate/StoreByCurrenciesRequest.php index 67706bdc69b..8eee33289a1 100644 --- a/app/Api/V1/Requests/Models/CurrencyExchangeRate/StoreByCurrenciesRequest.php +++ b/app/Api/V1/Requests/Models/CurrencyExchangeRate/StoreByCurrenciesRequest.php @@ -31,6 +31,12 @@ use Illuminate\Contracts\Validation\Validator; use Illuminate\Foundation\Http\FormRequest; +/** + * Class StoreByCurrenciesRequest + * + * Classe de requisicao para criacao de taxas de cambio por moedas. + * Valida e processa dados de criacao de taxas de cambio agrupadas por moedas. + */ class StoreByCurrenciesRequest extends FormRequest { use ChecksLogin; diff --git a/app/Api/V1/Requests/Models/CurrencyExchangeRate/StoreByDateRequest.php b/app/Api/V1/Requests/Models/CurrencyExchangeRate/StoreByDateRequest.php index 433e6ac90b4..d7a726908cd 100644 --- a/app/Api/V1/Requests/Models/CurrencyExchangeRate/StoreByDateRequest.php +++ b/app/Api/V1/Requests/Models/CurrencyExchangeRate/StoreByDateRequest.php @@ -30,6 +30,12 @@ use Illuminate\Contracts\Validation\Validator; use Illuminate\Foundation\Http\FormRequest; +/** + * Class StoreByDateRequest + * + * Classe de requisicao para criacao de taxas de cambio por data. + * Valida e processa dados de criacao de taxas de cambio agrupadas por data. + */ class StoreByDateRequest extends FormRequest { use ChecksLogin; diff --git a/app/Api/V1/Requests/Models/CurrencyExchangeRate/StoreRequest.php b/app/Api/V1/Requests/Models/CurrencyExchangeRate/StoreRequest.php index b4ef5d13b8d..da7665fb6fb 100644 --- a/app/Api/V1/Requests/Models/CurrencyExchangeRate/StoreRequest.php +++ b/app/Api/V1/Requests/Models/CurrencyExchangeRate/StoreRequest.php @@ -30,6 +30,12 @@ use FireflyIII\Support\Request\ConvertsDataTypes; use Illuminate\Foundation\Http\FormRequest; +/** + * Class StoreRequest + * + * Classe de requisicao para criacao de taxas de cambio. + * Valida e processa dados de criacao de taxas de cambio entre moedas. + */ class StoreRequest extends FormRequest { use ChecksLogin; diff --git a/app/Api/V1/Requests/Models/CurrencyExchangeRate/UpdateRequest.php b/app/Api/V1/Requests/Models/CurrencyExchangeRate/UpdateRequest.php index 8114b7abed0..6d9ba129e73 100644 --- a/app/Api/V1/Requests/Models/CurrencyExchangeRate/UpdateRequest.php +++ b/app/Api/V1/Requests/Models/CurrencyExchangeRate/UpdateRequest.php @@ -29,6 +29,12 @@ use FireflyIII\Support\Request\ConvertsDataTypes; use Illuminate\Foundation\Http\FormRequest; +/** + * Class UpdateRequest + * + * Classe de requisicao para atualizacao de taxas de cambio. + * Valida e processa dados de atualizacao de taxas de cambio entre moedas. + */ class UpdateRequest extends FormRequest { use ChecksLogin; diff --git a/app/Api/V1/Requests/Models/ObjectGroup/UpdateRequest.php b/app/Api/V1/Requests/Models/ObjectGroup/UpdateRequest.php index 17b5a41e160..3a89c2fff70 100644 --- a/app/Api/V1/Requests/Models/ObjectGroup/UpdateRequest.php +++ b/app/Api/V1/Requests/Models/ObjectGroup/UpdateRequest.php @@ -31,6 +31,9 @@ /** * Class UpdateRequest + * + * Classe de requisicao para atualizacao de grupos de objetos. + * Valida e processa dados de atualizacao de grupos de objetos do sistema. */ class UpdateRequest extends FormRequest { diff --git a/app/Api/V1/Requests/Models/PiggyBank/StoreRequest.php b/app/Api/V1/Requests/Models/PiggyBank/StoreRequest.php index a45297b832a..b8016108539 100644 --- a/app/Api/V1/Requests/Models/PiggyBank/StoreRequest.php +++ b/app/Api/V1/Requests/Models/PiggyBank/StoreRequest.php @@ -35,6 +35,9 @@ /** * Class StoreRequest + * + * Classe de requisicao para criacao de cofrinhos. + * Valida e processa dados de criacao de cofrinhos incluindo contas e valores. */ class StoreRequest extends FormRequest { diff --git a/app/Api/V1/Requests/Models/PiggyBank/UpdateRequest.php b/app/Api/V1/Requests/Models/PiggyBank/UpdateRequest.php index c6c23c72cae..7ee32af2ccb 100644 --- a/app/Api/V1/Requests/Models/PiggyBank/UpdateRequest.php +++ b/app/Api/V1/Requests/Models/PiggyBank/UpdateRequest.php @@ -34,6 +34,9 @@ /** * Class UpdateRequest + * + * Classe de requisicao para atualizacao de cofrinhos. + * Valida e processa dados de atualizacao de cofrinhos incluindo contas e valores. */ class UpdateRequest extends FormRequest { diff --git a/app/Api/V1/Requests/Models/Recurrence/StoreRequest.php b/app/Api/V1/Requests/Models/Recurrence/StoreRequest.php index b9f736f74fd..ab88d0b42bf 100644 --- a/app/Api/V1/Requests/Models/Recurrence/StoreRequest.php +++ b/app/Api/V1/Requests/Models/Recurrence/StoreRequest.php @@ -39,6 +39,9 @@ /** * Class StoreRequest + * + * Classe de requisicao para criacao de transacoes recorrentes. + * Valida e processa dados de criacao de recorrencias incluindo repeticoes e transacoes. */ class StoreRequest extends FormRequest { diff --git a/app/Api/V1/Requests/Models/Recurrence/UpdateRequest.php b/app/Api/V1/Requests/Models/Recurrence/UpdateRequest.php index f16c5215902..ddba59a3e52 100644 --- a/app/Api/V1/Requests/Models/Recurrence/UpdateRequest.php +++ b/app/Api/V1/Requests/Models/Recurrence/UpdateRequest.php @@ -40,6 +40,9 @@ /** * Class UpdateRequest + * + * Classe de requisicao para atualizacao de transacoes recorrentes. + * Valida e processa dados de atualizacao de recorrencias incluindo repeticoes e transacoes. */ class UpdateRequest extends FormRequest { diff --git a/app/Api/V1/Requests/Models/Rule/StoreRequest.php b/app/Api/V1/Requests/Models/Rule/StoreRequest.php index 496dbc550a5..9828ebd74f7 100644 --- a/app/Api/V1/Requests/Models/Rule/StoreRequest.php +++ b/app/Api/V1/Requests/Models/Rule/StoreRequest.php @@ -35,6 +35,9 @@ /** * Class StoreRequest + * + * Classe de requisicao para criacao de regras de automacao. + * Valida e processa dados de criacao de regras incluindo gatilhos e acoes. */ class StoreRequest extends FormRequest { diff --git a/app/Api/V1/Requests/Models/Rule/TestRequest.php b/app/Api/V1/Requests/Models/Rule/TestRequest.php index ef855b9c858..81457d6f336 100644 --- a/app/Api/V1/Requests/Models/Rule/TestRequest.php +++ b/app/Api/V1/Requests/Models/Rule/TestRequest.php @@ -31,6 +31,9 @@ /** * Class TestRequest + * + * Classe de requisicao para teste de regras de automacao. + * Valida e processa parametros de teste de regras em transacoes. */ class TestRequest extends FormRequest { diff --git a/app/Api/V1/Requests/Models/Rule/TriggerRequest.php b/app/Api/V1/Requests/Models/Rule/TriggerRequest.php index 42f4417aca1..3d3fe7e044b 100644 --- a/app/Api/V1/Requests/Models/Rule/TriggerRequest.php +++ b/app/Api/V1/Requests/Models/Rule/TriggerRequest.php @@ -31,6 +31,9 @@ /** * Class TriggerRequest + * + * Classe de requisicao para execucao de regras de automacao. + * Valida e processa parametros de execucao de regras em transacoes. */ class TriggerRequest extends FormRequest { diff --git a/app/Api/V1/Requests/Models/Rule/UpdateRequest.php b/app/Api/V1/Requests/Models/Rule/UpdateRequest.php index 8b58fbd3d8e..c13ea2772d5 100644 --- a/app/Api/V1/Requests/Models/Rule/UpdateRequest.php +++ b/app/Api/V1/Requests/Models/Rule/UpdateRequest.php @@ -36,6 +36,9 @@ /** * Class UpdateRequest + * + * Classe de requisicao para atualizacao de regras de automacao. + * Valida e processa dados de atualizacao de regras incluindo gatilhos e acoes. */ class UpdateRequest extends FormRequest { diff --git a/app/Api/V1/Requests/Models/Rule/ValidateExpressionRequest.php b/app/Api/V1/Requests/Models/Rule/ValidateExpressionRequest.php index 766826d3a2f..915be4b5c9f 100644 --- a/app/Api/V1/Requests/Models/Rule/ValidateExpressionRequest.php +++ b/app/Api/V1/Requests/Models/Rule/ValidateExpressionRequest.php @@ -30,6 +30,9 @@ /** * Class ValidateExpressionRequest + * + * Classe de requisicao para validacao de expressoes de regras. + * Valida expressoes usadas em acoes de regras de automacao. */ class ValidateExpressionRequest extends FormRequest { diff --git a/app/Api/V1/Requests/Models/RuleGroup/StoreRequest.php b/app/Api/V1/Requests/Models/RuleGroup/StoreRequest.php index f38be5a7e2d..086fe602d42 100644 --- a/app/Api/V1/Requests/Models/RuleGroup/StoreRequest.php +++ b/app/Api/V1/Requests/Models/RuleGroup/StoreRequest.php @@ -31,6 +31,9 @@ /** * Class StoreRequest + * + * Classe de requisicao para criacao de grupos de regras. + * Valida e processa dados de criacao de grupos de regras de automacao. */ class StoreRequest extends FormRequest { diff --git a/app/Api/V1/Requests/Models/RuleGroup/TestRequest.php b/app/Api/V1/Requests/Models/RuleGroup/TestRequest.php index 68c7bfb219e..14626d64212 100644 --- a/app/Api/V1/Requests/Models/RuleGroup/TestRequest.php +++ b/app/Api/V1/Requests/Models/RuleGroup/TestRequest.php @@ -31,6 +31,9 @@ /** * Class TestRequest + * + * Classe de requisicao para teste de grupos de regras. + * Valida e processa parametros de teste de grupos de regras em transacoes. */ class TestRequest extends FormRequest { diff --git a/app/Api/V1/Requests/Models/RuleGroup/TriggerRequest.php b/app/Api/V1/Requests/Models/RuleGroup/TriggerRequest.php index 67e7fd4e099..29343217b27 100644 --- a/app/Api/V1/Requests/Models/RuleGroup/TriggerRequest.php +++ b/app/Api/V1/Requests/Models/RuleGroup/TriggerRequest.php @@ -31,6 +31,9 @@ /** * Class TriggerRequest + * + * Classe de requisicao para execucao de grupos de regras. + * Valida e processa parametros de execucao de grupos de regras em transacoes. */ class TriggerRequest extends FormRequest { diff --git a/app/Api/V1/Requests/Models/RuleGroup/UpdateRequest.php b/app/Api/V1/Requests/Models/RuleGroup/UpdateRequest.php index d2cbae0cab0..899ea777574 100644 --- a/app/Api/V1/Requests/Models/RuleGroup/UpdateRequest.php +++ b/app/Api/V1/Requests/Models/RuleGroup/UpdateRequest.php @@ -32,6 +32,9 @@ /** * Class UpdateRequest + * + * Classe de requisicao para atualizacao de grupos de regras. + * Valida e processa dados de atualizacao de grupos de regras de automacao. */ class UpdateRequest extends FormRequest { diff --git a/app/Api/V1/Requests/Models/Tag/StoreRequest.php b/app/Api/V1/Requests/Models/Tag/StoreRequest.php index aeb51632bd7..9bdba225a4c 100644 --- a/app/Api/V1/Requests/Models/Tag/StoreRequest.php +++ b/app/Api/V1/Requests/Models/Tag/StoreRequest.php @@ -32,6 +32,9 @@ /** * Class StoreRequest + * + * Classe de requisicao para criacao de tags. + * Valida e processa dados de criacao de tags incluindo localizacao. */ class StoreRequest extends FormRequest { diff --git a/app/Api/V1/Requests/Models/Tag/UpdateRequest.php b/app/Api/V1/Requests/Models/Tag/UpdateRequest.php index 37417dfdb23..1731075d30e 100644 --- a/app/Api/V1/Requests/Models/Tag/UpdateRequest.php +++ b/app/Api/V1/Requests/Models/Tag/UpdateRequest.php @@ -33,6 +33,9 @@ /** * Class UpdateRequest + * + * Classe de requisicao para atualizacao de tags. + * Valida e processa dados de atualizacao de tags incluindo localizacao. */ class UpdateRequest extends FormRequest { diff --git a/app/Api/V1/Requests/Models/Transaction/StoreRequest.php b/app/Api/V1/Requests/Models/Transaction/StoreRequest.php index 4c7cb3d43da..641f952f804 100644 --- a/app/Api/V1/Requests/Models/Transaction/StoreRequest.php +++ b/app/Api/V1/Requests/Models/Transaction/StoreRequest.php @@ -43,6 +43,9 @@ /** * Class StoreRequest + * + * Classe de requisicao para criacao de transacoes. + * Valida e processa dados de criacao de transacoes incluindo splits e metadados. */ class StoreRequest extends FormRequest { diff --git a/app/Api/V1/Requests/Models/Transaction/UpdateRequest.php b/app/Api/V1/Requests/Models/Transaction/UpdateRequest.php index 1aa8af303dd..14b067d970a 100644 --- a/app/Api/V1/Requests/Models/Transaction/UpdateRequest.php +++ b/app/Api/V1/Requests/Models/Transaction/UpdateRequest.php @@ -41,6 +41,9 @@ /** * Class UpdateRequest + * + * Classe de requisicao para atualizacao de transacoes. + * Valida e processa dados de atualizacao de transacoes incluindo splits e metadados. */ class UpdateRequest extends FormRequest { diff --git a/app/Api/V1/Requests/Models/TransactionCurrency/StoreRequest.php b/app/Api/V1/Requests/Models/TransactionCurrency/StoreRequest.php index d3aa5df6dc1..c04c2b3c8e5 100644 --- a/app/Api/V1/Requests/Models/TransactionCurrency/StoreRequest.php +++ b/app/Api/V1/Requests/Models/TransactionCurrency/StoreRequest.php @@ -31,6 +31,9 @@ /** * Class StoreRequest + * + * Classe de requisicao para criacao de moedas. + * Valida e processa dados de criacao de moedas de transacao. */ class StoreRequest extends FormRequest { diff --git a/app/Api/V1/Requests/Models/TransactionCurrency/UpdateRequest.php b/app/Api/V1/Requests/Models/TransactionCurrency/UpdateRequest.php index e4687c0edbb..0c59b69e0a4 100644 --- a/app/Api/V1/Requests/Models/TransactionCurrency/UpdateRequest.php +++ b/app/Api/V1/Requests/Models/TransactionCurrency/UpdateRequest.php @@ -32,6 +32,9 @@ /** * Class UpdateRequest + * + * Classe de requisicao para atualizacao de moedas. + * Valida e processa dados de atualizacao de moedas de transacao. */ class UpdateRequest extends FormRequest { diff --git a/app/Api/V1/Requests/Models/TransactionLink/StoreRequest.php b/app/Api/V1/Requests/Models/TransactionLink/StoreRequest.php index b93334289d9..d59362747c5 100644 --- a/app/Api/V1/Requests/Models/TransactionLink/StoreRequest.php +++ b/app/Api/V1/Requests/Models/TransactionLink/StoreRequest.php @@ -35,6 +35,9 @@ /** * Class StoreRequest + * + * Classe de requisicao para criacao de links entre transacoes. + * Valida e processa dados de criacao de vinculos entre transacoes. */ class StoreRequest extends FormRequest { diff --git a/app/Api/V1/Requests/Models/TransactionLink/UpdateRequest.php b/app/Api/V1/Requests/Models/TransactionLink/UpdateRequest.php index ce62f5a87cf..34e925d0c2a 100644 --- a/app/Api/V1/Requests/Models/TransactionLink/UpdateRequest.php +++ b/app/Api/V1/Requests/Models/TransactionLink/UpdateRequest.php @@ -35,6 +35,9 @@ /** * Class UpdateRequest + * + * Classe de requisicao para atualizacao de links entre transacoes. + * Valida e processa dados de atualizacao de vinculos entre transacoes. */ class UpdateRequest extends FormRequest { diff --git a/app/Api/V1/Requests/Models/TransactionLinkType/StoreRequest.php b/app/Api/V1/Requests/Models/TransactionLinkType/StoreRequest.php index d62bae15502..4068e2a4057 100644 --- a/app/Api/V1/Requests/Models/TransactionLinkType/StoreRequest.php +++ b/app/Api/V1/Requests/Models/TransactionLinkType/StoreRequest.php @@ -30,6 +30,9 @@ /** * Class StoreRequest + * + * Classe de requisicao para criacao de tipos de link de transacao. + * Valida e processa dados de criacao de tipos de vinculo entre transacoes. */ class StoreRequest extends FormRequest { diff --git a/app/Api/V1/Requests/Models/TransactionLinkType/UpdateRequest.php b/app/Api/V1/Requests/Models/TransactionLinkType/UpdateRequest.php index d924645515b..1ebe96316be 100644 --- a/app/Api/V1/Requests/Models/TransactionLinkType/UpdateRequest.php +++ b/app/Api/V1/Requests/Models/TransactionLinkType/UpdateRequest.php @@ -32,6 +32,9 @@ /** * Class UpdateRequest + * + * Classe de requisicao para atualizacao de tipos de link de transacao. + * Valida e processa dados de atualizacao de tipos de vinculo entre transacoes. */ class UpdateRequest extends FormRequest { diff --git a/app/Api/V1/Requests/Models/UserGroup/UpdateRequest.php b/app/Api/V1/Requests/Models/UserGroup/UpdateRequest.php index 20c75a9342d..a5e9dc5c2aa 100644 --- a/app/Api/V1/Requests/Models/UserGroup/UpdateRequest.php +++ b/app/Api/V1/Requests/Models/UserGroup/UpdateRequest.php @@ -30,6 +30,9 @@ /** * Class UpdateRequest + * + * Classe de requisicao para atualizacao de grupos de usuarios. + * Valida e processa dados de atualizacao de grupos de usuarios e administracoes. */ class UpdateRequest extends FormRequest { diff --git a/app/Api/V1/Requests/Models/Webhook/CreateRequest.php b/app/Api/V1/Requests/Models/Webhook/CreateRequest.php index 66064a0e198..378299da09e 100644 --- a/app/Api/V1/Requests/Models/Webhook/CreateRequest.php +++ b/app/Api/V1/Requests/Models/Webhook/CreateRequest.php @@ -36,6 +36,9 @@ /** * Class CreateRequest + * + * Classe de requisicao para criacao de webhooks. + * Valida e processa dados de criacao de webhooks incluindo gatilhos e respostas. */ class CreateRequest extends FormRequest { diff --git a/app/Api/V1/Requests/Models/Webhook/UpdateRequest.php b/app/Api/V1/Requests/Models/Webhook/UpdateRequest.php index d235ca048c7..823ae442bcb 100644 --- a/app/Api/V1/Requests/Models/Webhook/UpdateRequest.php +++ b/app/Api/V1/Requests/Models/Webhook/UpdateRequest.php @@ -36,6 +36,9 @@ /** * Class UpdateRequest + * + * Classe de requisicao para atualizacao de webhooks. + * Valida e processa dados de atualizacao de webhooks incluindo gatilhos e respostas. */ class UpdateRequest extends FormRequest { diff --git a/app/Api/V1/Requests/System/CronRequest.php b/app/Api/V1/Requests/System/CronRequest.php index 1ffebd0494a..35cf296839f 100644 --- a/app/Api/V1/Requests/System/CronRequest.php +++ b/app/Api/V1/Requests/System/CronRequest.php @@ -30,6 +30,9 @@ /** * Class CronRequest + * + * Classe de requisicao para execucao de tarefas cron. + * Valida e processa parametros de execucao de tarefas agendadas do sistema. */ class CronRequest extends FormRequest { diff --git a/app/Api/V1/Requests/System/UpdateRequest.php b/app/Api/V1/Requests/System/UpdateRequest.php index 2f9c39af0e3..4bdad5b717c 100644 --- a/app/Api/V1/Requests/System/UpdateRequest.php +++ b/app/Api/V1/Requests/System/UpdateRequest.php @@ -31,6 +31,9 @@ /** * Class UpdateRequest + * + * Classe de requisicao para atualizacao de configuracoes do sistema. + * Valida e processa dados de atualizacao de configuracoes dinamicas. */ class UpdateRequest extends FormRequest { diff --git a/app/Api/V1/Requests/System/UserStoreRequest.php b/app/Api/V1/Requests/System/UserStoreRequest.php index 9ca9409ec8d..08c4b77c167 100644 --- a/app/Api/V1/Requests/System/UserStoreRequest.php +++ b/app/Api/V1/Requests/System/UserStoreRequest.php @@ -31,6 +31,9 @@ /** * Class UserStoreRequest + * + * Classe de requisicao para criacao de usuarios. + * Valida e processa dados de criacao de usuarios do sistema. */ class UserStoreRequest extends FormRequest { diff --git a/app/Api/V1/Requests/System/UserUpdateRequest.php b/app/Api/V1/Requests/System/UserUpdateRequest.php index d22090ba0be..a47e593747f 100644 --- a/app/Api/V1/Requests/System/UserUpdateRequest.php +++ b/app/Api/V1/Requests/System/UserUpdateRequest.php @@ -34,6 +34,9 @@ /** * Class UserUpdateRequest + * + * Classe de requisicao para atualizacao de usuarios. + * Valida e processa dados de atualizacao de usuarios do sistema. */ class UserUpdateRequest extends FormRequest { diff --git a/app/Api/V1/Requests/User/PreferenceStoreRequest.php b/app/Api/V1/Requests/User/PreferenceStoreRequest.php index 22ee8ad706f..1e6733ef824 100644 --- a/app/Api/V1/Requests/User/PreferenceStoreRequest.php +++ b/app/Api/V1/Requests/User/PreferenceStoreRequest.php @@ -30,6 +30,9 @@ /** * Class PreferenceStoreRequest + * + * Classe de requisicao para criacao de preferencias do usuario. + * Valida e processa dados de criacao de preferencias atraves da API. */ class PreferenceStoreRequest extends FormRequest { diff --git a/app/Api/V1/Requests/User/PreferenceUpdateRequest.php b/app/Api/V1/Requests/User/PreferenceUpdateRequest.php index 7489f7e2de6..df7f7e42495 100644 --- a/app/Api/V1/Requests/User/PreferenceUpdateRequest.php +++ b/app/Api/V1/Requests/User/PreferenceUpdateRequest.php @@ -30,6 +30,9 @@ /** * Class PreferenceUpdateRequest + * + * Classe de requisicao para atualizacao de preferencias do usuario. + * Valida e processa dados de atualizacao de preferencias atraves da API. */ class PreferenceUpdateRequest extends FormRequest { diff --git a/app/Casts/SeparateTimezoneCaster.php b/app/Casts/SeparateTimezoneCaster.php index aa1091885fb..91b2f995872 100644 --- a/app/Casts/SeparateTimezoneCaster.php +++ b/app/Casts/SeparateTimezoneCaster.php @@ -30,13 +30,10 @@ use Illuminate\Database\Eloquent\Model; /** - * Class SeparateTimezoneCaster + * Class SeparateTimezoneCaster. * - * Checks if the object has a separate _tz value. If it does, it will use that timezone to parse the date. - * If it is NULL, it will use the system's timezone. - * - * At some point a user's database consists entirely of UTC dates, and we won't need this anymore. However, - * the completeness of this migration is not yet guaranteed. + * Caster para conversao de datas com fuso horario separado. + * Verifica se o objeto tem um valor _tz separado e usa esse fuso horario para analisar a data. */ class SeparateTimezoneCaster implements CastsAttributes { diff --git a/app/Console/Commands/Correction/ConvertsDatesToUTC.php b/app/Console/Commands/Correction/ConvertsDatesToUTC.php index 63457c65f38..8893e81dfb4 100644 --- a/app/Console/Commands/Correction/ConvertsDatesToUTC.php +++ b/app/Console/Commands/Correction/ConvertsDatesToUTC.php @@ -32,6 +32,12 @@ use Illuminate\Support\Collection; use Illuminate\Support\Facades\Log; +/** + * Class ConvertsDatesToUTC + * + * Comando para converter datas para UTC. + * Converte datas armazenadas para o fuso horario UTC. + */ class ConvertsDatesToUTC extends Command { use ShowsFriendlyMessages; diff --git a/app/Console/Commands/Correction/CorrectsAccountOrder.php b/app/Console/Commands/Correction/CorrectsAccountOrder.php index af3d8d089ff..1a71cc7ba17 100644 --- a/app/Console/Commands/Correction/CorrectsAccountOrder.php +++ b/app/Console/Commands/Correction/CorrectsAccountOrder.php @@ -29,6 +29,12 @@ use FireflyIII\User; use Illuminate\Console\Command; +/** + * Class CorrectsAccountOrder + * + * Comando para corrigir ordem de contas. + * Garante que a ordem das contas esteja correta. + */ class CorrectsAccountOrder extends Command { use ShowsFriendlyMessages; diff --git a/app/Console/Commands/Correction/CorrectsAccountTypes.php b/app/Console/Commands/Correction/CorrectsAccountTypes.php index c56fc6f79a5..3e736148b52 100644 --- a/app/Console/Commands/Correction/CorrectsAccountTypes.php +++ b/app/Console/Commands/Correction/CorrectsAccountTypes.php @@ -36,6 +36,12 @@ use Illuminate\Database\Eloquent\Builder; use Illuminate\Database\Query\JoinClause; +/** + * Class CorrectsAccountTypes + * + * Comando para corrigir tipos de conta. + * Garante que todos os diarios tenham os tipos de conta de origem/destino corretos. + */ class CorrectsAccountTypes extends Command { use ShowsFriendlyMessages; diff --git a/app/Console/Commands/Correction/CorrectsAmounts.php b/app/Console/Commands/Correction/CorrectsAmounts.php index 328196817fd..772a1442a05 100644 --- a/app/Console/Commands/Correction/CorrectsAmounts.php +++ b/app/Console/Commands/Correction/CorrectsAmounts.php @@ -44,6 +44,12 @@ use Illuminate\Support\Facades\Log; use ValueError; +/** + * Class CorrectsAmounts + * + * Comando para corrigir valores. + * Garante que valores positivos e negativos sejam registrados corretamente. + */ class CorrectsAmounts extends Command { use ShowsFriendlyMessages; diff --git a/app/Console/Commands/Correction/CorrectsCurrencies.php b/app/Console/Commands/Correction/CorrectsCurrencies.php index 1ded27400b1..17c12b8f7e0 100644 --- a/app/Console/Commands/Correction/CorrectsCurrencies.php +++ b/app/Console/Commands/Correction/CorrectsCurrencies.php @@ -37,6 +37,12 @@ use Illuminate\Support\Facades\Log; use Symfony\Component\Console\Command\Command as CommandAlias; +/** + * Class CorrectsCurrencies + * + * Comando para corrigir moedas. + * Habilita todas as moedas em uso no sistema. + */ class CorrectsCurrencies extends Command { use ShowsFriendlyMessages; diff --git a/app/Console/Commands/Correction/CorrectsDatabase.php b/app/Console/Commands/Correction/CorrectsDatabase.php index 5850619f614..98adab6a658 100644 --- a/app/Console/Commands/Correction/CorrectsDatabase.php +++ b/app/Console/Commands/Correction/CorrectsDatabase.php @@ -28,6 +28,12 @@ use Illuminate\Console\Command; use Illuminate\Support\Facades\Schema; +/** + * Class CorrectsDatabase + * + * Comando para corrigir banco de dados. + * Valida e corrige a integridade do banco de dados executando varios comandos de correcao. + */ class CorrectsDatabase extends Command { use ShowsFriendlyMessages; diff --git a/app/Console/Commands/Correction/CorrectsFrontpageAccounts.php b/app/Console/Commands/Correction/CorrectsFrontpageAccounts.php index 11a2926f6e9..accab6c52eb 100644 --- a/app/Console/Commands/Correction/CorrectsFrontpageAccounts.php +++ b/app/Console/Commands/Correction/CorrectsFrontpageAccounts.php @@ -31,6 +31,12 @@ use FireflyIII\User; use Illuminate\Console\Command; +/** + * Class CorrectsFrontpageAccounts + * + * Comando para corrigir contas da pagina inicial. + * Remove contas excluidas ou de tipo incorreto das preferencias da pagina inicial. + */ class CorrectsFrontpageAccounts extends Command { use ShowsFriendlyMessages; diff --git a/app/Console/Commands/Correction/CorrectsGroupInformation.php b/app/Console/Commands/Correction/CorrectsGroupInformation.php index c55a3f00299..902d7aa5cc4 100644 --- a/app/Console/Commands/Correction/CorrectsGroupInformation.php +++ b/app/Console/Commands/Correction/CorrectsGroupInformation.php @@ -46,6 +46,12 @@ use Illuminate\Console\Command; use Illuminate\Database\QueryException; +/** + * Class CorrectsGroupInformation + * + * Comando para corrigir informacoes de grupo. + * Garante que cada objeto esteja vinculado a um grupo. + */ class CorrectsGroupInformation extends Command { use ShowsFriendlyMessages; diff --git a/app/Console/Commands/Correction/CorrectsIbans.php b/app/Console/Commands/Correction/CorrectsIbans.php index 93062e1c8cb..346b5091f81 100644 --- a/app/Console/Commands/Correction/CorrectsIbans.php +++ b/app/Console/Commands/Correction/CorrectsIbans.php @@ -30,6 +30,12 @@ use Illuminate\Console\Command; use Illuminate\Support\Collection; +/** + * Class CorrectsIbans + * + * Comando para corrigir IBANs. + * Remove espacos de IBANs e corrige duplicatas. + */ class CorrectsIbans extends Command { use ShowsFriendlyMessages; diff --git a/app/Console/Commands/Correction/CorrectsLongDescriptions.php b/app/Console/Commands/Correction/CorrectsLongDescriptions.php index a5b98a3cf48..f126919aa50 100644 --- a/app/Console/Commands/Correction/CorrectsLongDescriptions.php +++ b/app/Console/Commands/Correction/CorrectsLongDescriptions.php @@ -30,6 +30,12 @@ use Illuminate\Console\Command; use Illuminate\Support\Facades\DB; +/** + * Class CorrectsLongDescriptions + * + * Comando para corrigir descricoes longas. + * Trunca descricoes de diarios e grupos que excedem o limite maximo. + */ class CorrectsLongDescriptions extends Command { use ShowsFriendlyMessages; diff --git a/app/Console/Commands/Correction/CorrectsMetaDataFields.php b/app/Console/Commands/Correction/CorrectsMetaDataFields.php index 731c5f49f79..416f8aed7b7 100644 --- a/app/Console/Commands/Correction/CorrectsMetaDataFields.php +++ b/app/Console/Commands/Correction/CorrectsMetaDataFields.php @@ -28,6 +28,12 @@ use Illuminate\Console\Command; use Illuminate\Support\Facades\DB; +/** + * Class CorrectsMetaDataFields + * + * Comando para corrigir campos de metadados. + * Renomeia campos de metadados alterados. + */ class CorrectsMetaDataFields extends Command { use ShowsFriendlyMessages; diff --git a/app/Console/Commands/Correction/CorrectsOpeningBalanceCurrencies.php b/app/Console/Commands/Correction/CorrectsOpeningBalanceCurrencies.php index 0383e727858..de1ca57fc58 100644 --- a/app/Console/Commands/Correction/CorrectsOpeningBalanceCurrencies.php +++ b/app/Console/Commands/Correction/CorrectsOpeningBalanceCurrencies.php @@ -35,6 +35,12 @@ use Illuminate\Console\Command; use Illuminate\Support\Collection; +/** + * Class CorrectsOpeningBalanceCurrencies + * + * Comando para corrigir moedas de saldo inicial. + * Garante que as moedas das transacoes de saldo inicial correspondam as contas. + */ class CorrectsOpeningBalanceCurrencies extends Command { use ShowsFriendlyMessages; diff --git a/app/Console/Commands/Correction/CorrectsPiggyBanks.php b/app/Console/Commands/Correction/CorrectsPiggyBanks.php index 89226299609..c11d99144d4 100644 --- a/app/Console/Commands/Correction/CorrectsPiggyBanks.php +++ b/app/Console/Commands/Correction/CorrectsPiggyBanks.php @@ -29,6 +29,12 @@ use FireflyIII\Models\TransactionJournal; use Illuminate\Console\Command; +/** + * Class CorrectsPiggyBanks + * + * Comando para corrigir cofrinhos. + * Corrige problemas comuns com cofrinhos. + */ class CorrectsPiggyBanks extends Command { use ShowsFriendlyMessages; diff --git a/app/Console/Commands/Correction/CorrectsPreferences.php b/app/Console/Commands/Correction/CorrectsPreferences.php index 2de5a6dffc4..8f62ce84114 100644 --- a/app/Console/Commands/Correction/CorrectsPreferences.php +++ b/app/Console/Commands/Correction/CorrectsPreferences.php @@ -30,6 +30,12 @@ use Illuminate\Console\Command; use Symfony\Component\Console\Command\Command as CommandAlias; +/** + * Class CorrectsPreferences + * + * Comando para corrigir preferencias. + * Adiciona ID de grupo de usuario as preferencias para administracao especifica. + */ class CorrectsPreferences extends Command { protected $description = 'Give Firefly III preferences a user group ID so they can be made administration specific.'; diff --git a/app/Console/Commands/Correction/CorrectsPrimaryCurrencyAmounts.php b/app/Console/Commands/Correction/CorrectsPrimaryCurrencyAmounts.php index 563cd6c08fb..54325eb3ee0 100644 --- a/app/Console/Commands/Correction/CorrectsPrimaryCurrencyAmounts.php +++ b/app/Console/Commands/Correction/CorrectsPrimaryCurrencyAmounts.php @@ -49,6 +49,12 @@ use Illuminate\Support\Facades\DB; use Illuminate\Support\Facades\Log; +/** + * Class CorrectsPrimaryCurrencyAmounts + * + * Comando para recalcular valores em moeda primaria. + * Recalcula valores em moeda primaria para todos os objetos. + */ class CorrectsPrimaryCurrencyAmounts extends Command { use ShowsFriendlyMessages; diff --git a/app/Console/Commands/Correction/CorrectsRecurringTransactions.php b/app/Console/Commands/Correction/CorrectsRecurringTransactions.php index e47dad72363..57ad01798e1 100644 --- a/app/Console/Commands/Correction/CorrectsRecurringTransactions.php +++ b/app/Console/Commands/Correction/CorrectsRecurringTransactions.php @@ -33,6 +33,12 @@ use FireflyIII\User; use Illuminate\Console\Command; +/** + * Class CorrectsRecurringTransactions + * + * Comando para corrigir transacoes recorrentes. + * Corrige transacoes recorrentes com tipo de transacao incorreto. + */ class CorrectsRecurringTransactions extends Command { use ShowsFriendlyMessages; diff --git a/app/Console/Commands/Correction/CorrectsTimezoneInformation.php b/app/Console/Commands/Correction/CorrectsTimezoneInformation.php index 38dca1a0dc2..c903c1bc6b5 100644 --- a/app/Console/Commands/Correction/CorrectsTimezoneInformation.php +++ b/app/Console/Commands/Correction/CorrectsTimezoneInformation.php @@ -42,6 +42,12 @@ use Illuminate\Database\QueryException; use Illuminate\Support\Facades\Log; +/** + * Class CorrectsTimezoneInformation + * + * Comando para corrigir informacoes de fuso horario. + * Garante que todas as datas tenham um fuso horario definido. + */ class CorrectsTimezoneInformation extends Command { use ShowsFriendlyMessages; diff --git a/app/Console/Commands/Correction/CorrectsTransactionTypes.php b/app/Console/Commands/Correction/CorrectsTransactionTypes.php index 3663917ef57..d7f9f6f86c6 100644 --- a/app/Console/Commands/Correction/CorrectsTransactionTypes.php +++ b/app/Console/Commands/Correction/CorrectsTransactionTypes.php @@ -34,6 +34,12 @@ use Illuminate\Support\Collection; use Illuminate\Support\Facades\Log; +/** + * Class CorrectsTransactionTypes + * + * Comando para corrigir tipos de transacao. + * Garante que todas as transacoes sejam do tipo correto baseado em origem e destino. + */ class CorrectsTransactionTypes extends Command { use ShowsFriendlyMessages; diff --git a/app/Console/Commands/Correction/CorrectsTransferBudgets.php b/app/Console/Commands/Correction/CorrectsTransferBudgets.php index 5098087f76d..c34347e0cbe 100644 --- a/app/Console/Commands/Correction/CorrectsTransferBudgets.php +++ b/app/Console/Commands/Correction/CorrectsTransferBudgets.php @@ -29,6 +29,12 @@ use FireflyIII\Models\TransactionJournal; use Illuminate\Console\Command; +/** + * Class CorrectsTransferBudgets + * + * Comando para corrigir orcamentos de transferencias. + * Remove orcamentos de transacoes que nao sao saques. + */ class CorrectsTransferBudgets extends Command { use ShowsFriendlyMessages; diff --git a/app/Console/Commands/Correction/CorrectsUnevenAmount.php b/app/Console/Commands/Correction/CorrectsUnevenAmount.php index 30a6107fe19..83ec177984d 100644 --- a/app/Console/Commands/Correction/CorrectsUnevenAmount.php +++ b/app/Console/Commands/Correction/CorrectsUnevenAmount.php @@ -38,6 +38,12 @@ use ValueError; use stdClass; +/** + * Class CorrectsUnevenAmount + * + * Comando para corrigir valores desiguais. + * Corrige diarios com valores desiguais entre transacoes de origem e destino. + */ class CorrectsUnevenAmount extends Command { use ShowsFriendlyMessages; diff --git a/app/Console/Commands/Correction/CreatesAccessTokens.php b/app/Console/Commands/Correction/CreatesAccessTokens.php index f73e8d2258c..2396a1aceeb 100644 --- a/app/Console/Commands/Correction/CreatesAccessTokens.php +++ b/app/Console/Commands/Correction/CreatesAccessTokens.php @@ -30,6 +30,12 @@ use Illuminate\Console\Command; use Exception; +/** + * Class CreatesAccessTokens + * + * Comando para criar tokens de acesso. + * Cria tokens de acesso de usuario para acesso via linha de comando. + */ class CreatesAccessTokens extends Command { use ShowsFriendlyMessages; diff --git a/app/Console/Commands/Correction/CreatesGroupMemberships.php b/app/Console/Commands/Correction/CreatesGroupMemberships.php index 92709fdad04..db063371d7b 100644 --- a/app/Console/Commands/Correction/CreatesGroupMemberships.php +++ b/app/Console/Commands/Correction/CreatesGroupMemberships.php @@ -33,6 +33,12 @@ use FireflyIII\User; use Illuminate\Console\Command; +/** + * Class CreatesGroupMemberships + * + * Comando para criar membros de grupo. + * Atualiza e cria membros de grupo de usuarios. + */ class CreatesGroupMemberships extends Command { use ShowsFriendlyMessages; diff --git a/app/Console/Commands/Correction/CreatesLinkTypes.php b/app/Console/Commands/Correction/CreatesLinkTypes.php index 19592b03cf7..8c4b2606f2a 100644 --- a/app/Console/Commands/Correction/CreatesLinkTypes.php +++ b/app/Console/Commands/Correction/CreatesLinkTypes.php @@ -28,6 +28,12 @@ use FireflyIII\Models\LinkType; use Illuminate\Console\Command; +/** + * Class CreatesLinkTypes + * + * Comando para criar tipos de link. + * Cria todos os tipos de link padrao para vincular transacoes. + */ class CreatesLinkTypes extends Command { use ShowsFriendlyMessages; diff --git a/app/Console/Commands/Correction/RemovesBills.php b/app/Console/Commands/Correction/RemovesBills.php index 663c315d73b..848fd09ace3 100644 --- a/app/Console/Commands/Correction/RemovesBills.php +++ b/app/Console/Commands/Correction/RemovesBills.php @@ -30,6 +30,12 @@ use FireflyIII\Models\TransactionType; use Illuminate\Console\Command; +/** + * Class RemovesBills + * + * Comando para remover faturas. + * Remove faturas de transacoes que nao deveriam ter uma. + */ class RemovesBills extends Command { use ShowsFriendlyMessages; diff --git a/app/Console/Commands/Correction/RemovesEmptyGroups.php b/app/Console/Commands/Correction/RemovesEmptyGroups.php index 2fac48e95b6..5d943cda4f5 100644 --- a/app/Console/Commands/Correction/RemovesEmptyGroups.php +++ b/app/Console/Commands/Correction/RemovesEmptyGroups.php @@ -29,6 +29,12 @@ use Illuminate\Console\Command; use Exception; +/** + * Class RemovesEmptyGroups + * + * Comando para remover grupos vazios. + * Exclui grupos de transacoes vazios. + */ class RemovesEmptyGroups extends Command { use ShowsFriendlyMessages; diff --git a/app/Console/Commands/Correction/RemovesEmptyJournals.php b/app/Console/Commands/Correction/RemovesEmptyJournals.php index 38b1a1c437d..fee5558c330 100644 --- a/app/Console/Commands/Correction/RemovesEmptyJournals.php +++ b/app/Console/Commands/Correction/RemovesEmptyJournals.php @@ -31,6 +31,12 @@ use Illuminate\Database\QueryException; use Illuminate\Support\Facades\DB; +/** + * Class RemovesEmptyJournals + * + * Comando para remover diarios vazios. + * Exclui diarios de transacoes vazios e desiguais. + */ class RemovesEmptyJournals extends Command { use ShowsFriendlyMessages; diff --git a/app/Console/Commands/Correction/RemovesZeroAmount.php b/app/Console/Commands/Correction/RemovesZeroAmount.php index fd9d1c344e3..527a0cea1b3 100644 --- a/app/Console/Commands/Correction/RemovesZeroAmount.php +++ b/app/Console/Commands/Correction/RemovesZeroAmount.php @@ -29,6 +29,12 @@ use FireflyIII\Models\TransactionJournal; use Illuminate\Console\Command; +/** + * Class RemovesZeroAmount + * + * Comando para remover valores zero. + * Exclui transacoes com valor zero. + */ class RemovesZeroAmount extends Command { use ShowsFriendlyMessages; diff --git a/app/Console/Commands/Correction/RestoresOAuthKeys.php b/app/Console/Commands/Correction/RestoresOAuthKeys.php index 8eaf3c79a7d..da338648172 100644 --- a/app/Console/Commands/Correction/RestoresOAuthKeys.php +++ b/app/Console/Commands/Correction/RestoresOAuthKeys.php @@ -28,6 +28,12 @@ use FireflyIII\Support\System\OAuthKeys; use Illuminate\Console\Command; +/** + * Class RestoresOAuthKeys + * + * Comando para restaurar chaves OAuth. + * Restaura as chaves OAuth geradas para o sistema. + */ class RestoresOAuthKeys extends Command { use ShowsFriendlyMessages; diff --git a/app/Console/Commands/Correction/TriggersCreditCalculation.php b/app/Console/Commands/Correction/TriggersCreditCalculation.php index 57918d99761..3425a28b1a0 100644 --- a/app/Console/Commands/Correction/TriggersCreditCalculation.php +++ b/app/Console/Commands/Correction/TriggersCreditCalculation.php @@ -28,6 +28,12 @@ use FireflyIII\Services\Internal\Support\CreditRecalculateService; use Illuminate\Console\Command; +/** + * Class TriggersCreditCalculation + * + * Comando para recalcular creditos. + * Aciona o servico de recalculo de credito para passivos. + */ class TriggersCreditCalculation extends Command { protected $description = 'Triggers the credit recalculation service for liabilities.'; diff --git a/app/Console/Commands/Export/ExportsData.php b/app/Console/Commands/Export/ExportsData.php index d1189a2b40d..43c540f1780 100644 --- a/app/Console/Commands/Export/ExportsData.php +++ b/app/Console/Commands/Export/ExportsData.php @@ -41,6 +41,12 @@ use function Safe\file_put_contents; +/** + * Class ExportsData + * + * Comando para exportar dados. + * Exporta transacoes, contas, orcamentos, categorias e outros dados para arquivos CSV. + */ class ExportsData extends Command { use ShowsFriendlyMessages; diff --git a/app/Console/Commands/ShowsFriendlyMessages.php b/app/Console/Commands/ShowsFriendlyMessages.php index 1046218d0f9..4965fb01f01 100644 --- a/app/Console/Commands/ShowsFriendlyMessages.php +++ b/app/Console/Commands/ShowsFriendlyMessages.php @@ -26,6 +26,9 @@ /** * Trait ShowsFriendlyMessages + * + * Mensagens amigaveis para comandos. + * Fornece metodos para exibir mensagens formatadas no console. */ trait ShowsFriendlyMessages { diff --git a/app/Console/Commands/System/CallsLaravelPassportKeys.php b/app/Console/Commands/System/CallsLaravelPassportKeys.php index 22e1ebddd34..130cff21271 100644 --- a/app/Console/Commands/System/CallsLaravelPassportKeys.php +++ b/app/Console/Commands/System/CallsLaravelPassportKeys.php @@ -30,6 +30,12 @@ use Illuminate\Support\Facades\Artisan; use Symfony\Component\Console\Command\Command as CommandAlias; +/** + * Class CallsLaravelPassportKeys + * + * Comando para gerar chaves do Passport. + * Executa o comando passport:keys do Laravel para gerar chaves de criptografia. + */ class CallsLaravelPassportKeys extends Command { use ShowsFriendlyMessages; diff --git a/app/Console/Commands/System/CreatesDatabase.php b/app/Console/Commands/System/CreatesDatabase.php index 1e88f7209fb..cb3a696ad6f 100644 --- a/app/Console/Commands/System/CreatesDatabase.php +++ b/app/Console/Commands/System/CreatesDatabase.php @@ -29,6 +29,12 @@ use PDO; use PDOException; +/** + * Class CreatesDatabase + * + * Comando para criar banco de dados. + * Tenta criar o banco de dados MySQL se ele ainda nao existir. + */ class CreatesDatabase extends Command { use ShowsFriendlyMessages; diff --git a/app/Console/Commands/System/CreatesFirstUser.php b/app/Console/Commands/System/CreatesFirstUser.php index 18fa530bb85..79142e27787 100644 --- a/app/Console/Commands/System/CreatesFirstUser.php +++ b/app/Console/Commands/System/CreatesFirstUser.php @@ -30,6 +30,12 @@ use Illuminate\Support\Facades\Hash; use Illuminate\Support\Str; +/** + * Class CreatesFirstUser + * + * Comando para criar primeiro usuario. + * Cria um novo usuario administrador com senha gerada automaticamente. + */ class CreatesFirstUser extends Command { use ShowsFriendlyMessages; diff --git a/app/Console/Commands/System/ForcesDecimalSize.php b/app/Console/Commands/System/ForcesDecimalSize.php index 4b54218f10c..9161be9af0b 100644 --- a/app/Console/Commands/System/ForcesDecimalSize.php +++ b/app/Console/Commands/System/ForcesDecimalSize.php @@ -47,9 +47,11 @@ use function Safe\json_encode; /** - * This command was inspired by https://github.com/elliot-gh. It will check all amount fields - * and their values and correct them to the correct number of decimal places. This fixes issues where - * Firefly III would store 0.01 as 0.01000000000000000020816681711721685132943093776702880859375. + * Class ForcesDecimalSize + * + * Comando para corrigir tamanho decimal. + * Verifica e corrige campos de valor para o numero correto de casas decimais. + * Inspirado por https://github.com/elliot-gh. */ class ForcesDecimalSize extends Command { diff --git a/app/Console/Commands/System/ForcesMigrations.php b/app/Console/Commands/System/ForcesMigrations.php index 479031c62ec..d63c01a79d3 100644 --- a/app/Console/Commands/System/ForcesMigrations.php +++ b/app/Console/Commands/System/ForcesMigrations.php @@ -33,6 +33,12 @@ use Illuminate\Support\Facades\Log; use Illuminate\Support\Facades\Schema; +/** + * Class ForcesMigrations + * + * Comando para forcar migracoes. + * Executa todas as migracoes do banco de dados de forma forcada. + */ class ForcesMigrations extends Command { use ShowsFriendlyMessages; diff --git a/app/Console/Commands/System/OutputsInstructions.php b/app/Console/Commands/System/OutputsInstructions.php index b144fcdf339..db9db9f093d 100644 --- a/app/Console/Commands/System/OutputsInstructions.php +++ b/app/Console/Commands/System/OutputsInstructions.php @@ -28,6 +28,12 @@ use FireflyIII\Support\System\GeneratesInstallationId; use Illuminate\Console\Command; +/** + * Class OutputsInstructions + * + * Comando de instrucoes. + * Exibe instrucoes de instalacao e atualizacao do Firefly III. + */ class OutputsInstructions extends Command { use GeneratesInstallationId; diff --git a/app/Console/Commands/System/OutputsVersion.php b/app/Console/Commands/System/OutputsVersion.php index 56050f3cd46..cdfc78b4716 100644 --- a/app/Console/Commands/System/OutputsVersion.php +++ b/app/Console/Commands/System/OutputsVersion.php @@ -26,6 +26,12 @@ use Illuminate\Console\Command; +/** + * Class OutputsVersion + * + * Comando para exibir versao. + * Exibe a versao atual do Firefly III no console. + */ class OutputsVersion extends Command { protected $description = 'Outputs the Firefly III version'; diff --git a/app/Console/Commands/System/RecalculatesRunningBalance.php b/app/Console/Commands/System/RecalculatesRunningBalance.php index 5e51a4fcc67..b7d2fb88b3a 100644 --- a/app/Console/Commands/System/RecalculatesRunningBalance.php +++ b/app/Console/Commands/System/RecalculatesRunningBalance.php @@ -27,6 +27,12 @@ use FireflyIII\Support\Models\AccountBalanceCalculator; use Illuminate\Console\Command; +/** + * Class RecalculatesRunningBalance + * + * Comando para recalcular saldos. + * Recalcula os saldos correntes de todas as contas. + */ class RecalculatesRunningBalance extends Command { use ShowsFriendlyMessages; diff --git a/app/Console/Commands/System/ResetsErrorMailLimit.php b/app/Console/Commands/System/ResetsErrorMailLimit.php index 9aba24fa791..3af089b340c 100644 --- a/app/Console/Commands/System/ResetsErrorMailLimit.php +++ b/app/Console/Commands/System/ResetsErrorMailLimit.php @@ -8,6 +8,12 @@ use Illuminate\Console\Command; use Symfony\Component\Console\Command\Command as CommandAlias; +/** + * Class ResetsErrorMailLimit + * + * Comando para resetar limite de emails de erro. + * Reseta o contador de emails de erro enviados para permitir novos envios. + */ class ResetsErrorMailLimit extends Command { use ShowsFriendlyMessages; diff --git a/app/Console/Commands/System/ScansAttachments.php b/app/Console/Commands/System/ScansAttachments.php index 24c6f6199b6..c4f7bddc025 100644 --- a/app/Console/Commands/System/ScansAttachments.php +++ b/app/Console/Commands/System/ScansAttachments.php @@ -40,6 +40,12 @@ use function Safe\mime_content_type; use function Safe\tempnam; +/** + * Class ScansAttachments + * + * Comando para escanear anexos. + * Reescaneia todos os anexos e recalcula o hash MD5 e tipo MIME. + */ class ScansAttachments extends Command { use ShowsFriendlyMessages; diff --git a/app/Console/Commands/System/SetsLatestVersion.php b/app/Console/Commands/System/SetsLatestVersion.php index f6207ee15a1..c16244ccb6b 100644 --- a/app/Console/Commands/System/SetsLatestVersion.php +++ b/app/Console/Commands/System/SetsLatestVersion.php @@ -27,6 +27,12 @@ use FireflyIII\Console\Commands\ShowsFriendlyMessages; use Illuminate\Console\Command; +/** + * Class SetsLatestVersion + * + * Comando para definir versao mais recente. + * Atualiza a versao do banco de dados e do Firefly III na configuracao. + */ class SetsLatestVersion extends Command { use ShowsFriendlyMessages; diff --git a/app/Console/Commands/System/VerifySecurityAlerts.php b/app/Console/Commands/System/VerifySecurityAlerts.php index 920142d7940..0b4c32248fe 100644 --- a/app/Console/Commands/System/VerifySecurityAlerts.php +++ b/app/Console/Commands/System/VerifySecurityAlerts.php @@ -32,6 +32,12 @@ use function Safe\json_decode; +/** + * Class VerifySecurityAlerts + * + * Comando para verificar alertas de seguranca. + * Verifica e exibe alertas de seguranca para a versao atual do Firefly III. + */ class VerifySecurityAlerts extends Command { use ShowsFriendlyMessages; diff --git a/app/Console/Commands/Tools/ApplyRules.php b/app/Console/Commands/Tools/ApplyRules.php index b2a891b5d69..26470ff88df 100644 --- a/app/Console/Commands/Tools/ApplyRules.php +++ b/app/Console/Commands/Tools/ApplyRules.php @@ -40,6 +40,12 @@ use Illuminate\Support\Collection; use Illuminate\Support\Facades\Log; +/** + * Class ApplyRules + * + * Comando para aplicar regras. + * Aplica regras e grupos de regras a uma selecao de transacoes. + */ class ApplyRules extends Command { use ShowsFriendlyMessages; diff --git a/app/Console/Commands/Tools/Cron.php b/app/Console/Commands/Tools/Cron.php index 27a4e66a644..7bf445d24b0 100644 --- a/app/Console/Commands/Tools/Cron.php +++ b/app/Console/Commands/Tools/Cron.php @@ -37,6 +37,12 @@ use Illuminate\Support\Facades\Log; use InvalidArgumentException; +/** + * Class Cron + * + * Comando de cron. + * Executa todas as tarefas agendadas do Firefly III (taxas de cambio, transacoes recorrentes, etc). + */ class Cron extends Command { use ShowsFriendlyMessages; diff --git a/app/Console/Commands/Upgrade/AddsTransactionIdentifiers.php b/app/Console/Commands/Upgrade/AddsTransactionIdentifiers.php index af59ca61cec..c967cfcf4cb 100644 --- a/app/Console/Commands/Upgrade/AddsTransactionIdentifiers.php +++ b/app/Console/Commands/Upgrade/AddsTransactionIdentifiers.php @@ -33,6 +33,12 @@ use Illuminate\Database\QueryException; use Illuminate\Support\Facades\Schema; +/** + * Class AddsTransactionIdentifiers + * + * Comando para adicionar identificadores de transacao. + * Corrige identificadores de transacoes divididas para facilitar correspondencia. + */ class AddsTransactionIdentifiers extends Command { use ShowsFriendlyMessages; diff --git a/app/Console/Commands/Upgrade/RemovesDatabaseDecryption.php b/app/Console/Commands/Upgrade/RemovesDatabaseDecryption.php index 87e99cd7060..f70b3f087dd 100644 --- a/app/Console/Commands/Upgrade/RemovesDatabaseDecryption.php +++ b/app/Console/Commands/Upgrade/RemovesDatabaseDecryption.php @@ -36,6 +36,12 @@ use function Safe\json_decode; +/** + * Class RemovesDatabaseDecryption + * + * Comando para descriptografar banco de dados. + * Remove a criptografia de campos do banco de dados. + */ class RemovesDatabaseDecryption extends Command { use ShowsFriendlyMessages; diff --git a/app/Console/Commands/Upgrade/RepairsAccountBalances.php b/app/Console/Commands/Upgrade/RepairsAccountBalances.php index 1e35520f099..93202b32ed9 100644 --- a/app/Console/Commands/Upgrade/RepairsAccountBalances.php +++ b/app/Console/Commands/Upgrade/RepairsAccountBalances.php @@ -28,6 +28,12 @@ use FireflyIII\Support\Models\AccountBalanceCalculator; use Illuminate\Console\Command; +/** + * Class RepairsAccountBalances + * + * Comando para reparar saldos de contas. + * Recalcula todos os saldos de contas. + */ class RepairsAccountBalances extends Command { use ShowsFriendlyMessages; diff --git a/app/Console/Commands/Upgrade/RepairsPostgresSequences.php b/app/Console/Commands/Upgrade/RepairsPostgresSequences.php index b37f33afe89..a89a75e54c2 100644 --- a/app/Console/Commands/Upgrade/RepairsPostgresSequences.php +++ b/app/Console/Commands/Upgrade/RepairsPostgresSequences.php @@ -28,6 +28,12 @@ use Illuminate\Console\Command; use Illuminate\Support\Facades\DB; +/** + * Class RepairsPostgresSequences + * + * Comando para reparar sequencias PostgreSQL. + * Corrige problemas com sequencias de autoincremento no PostgreSQL. + */ class RepairsPostgresSequences extends Command { use ShowsFriendlyMessages; diff --git a/app/Console/Commands/Upgrade/UpgradesAccountCurrencies.php b/app/Console/Commands/Upgrade/UpgradesAccountCurrencies.php index eef26f86086..bffc49e39be 100644 --- a/app/Console/Commands/Upgrade/UpgradesAccountCurrencies.php +++ b/app/Console/Commands/Upgrade/UpgradesAccountCurrencies.php @@ -37,6 +37,12 @@ use FireflyIII\User; use Illuminate\Console\Command; +/** + * Class UpgradesAccountCurrencies + * + * Comando para atualizar moedas de contas. + * Garante que todas as contas tenham uma referencia de moeda preferida. + */ class UpgradesAccountCurrencies extends Command { use ShowsFriendlyMessages; diff --git a/app/Console/Commands/Upgrade/UpgradesAccountMetaData.php b/app/Console/Commands/Upgrade/UpgradesAccountMetaData.php index d181e41e22d..ddf24080ebd 100644 --- a/app/Console/Commands/Upgrade/UpgradesAccountMetaData.php +++ b/app/Console/Commands/Upgrade/UpgradesAccountMetaData.php @@ -29,6 +29,12 @@ use FireflyIII\Models\AccountMeta; use Illuminate\Console\Command; +/** + * Class UpgradesAccountMetaData + * + * Comando para renomear metadados de contas. + * Renomeia metadados de contas para o novo formato. + */ class UpgradesAccountMetaData extends Command { use ShowsFriendlyMessages; diff --git a/app/Console/Commands/Upgrade/UpgradesAttachments.php b/app/Console/Commands/Upgrade/UpgradesAttachments.php index c3e0d32eb9a..55e6e6db0d8 100644 --- a/app/Console/Commands/Upgrade/UpgradesAttachments.php +++ b/app/Console/Commands/Upgrade/UpgradesAttachments.php @@ -30,6 +30,12 @@ use FireflyIII\Models\Note; use Illuminate\Console\Command; +/** + * Class UpgradesAttachments + * + * Comando para migrar anexos. + * Migra descricoes de anexos para notas. + */ class UpgradesAttachments extends Command { use ShowsFriendlyMessages; diff --git a/app/Console/Commands/Upgrade/UpgradesBillsToRules.php b/app/Console/Commands/Upgrade/UpgradesBillsToRules.php index b146f11e8bd..8e269be79d1 100644 --- a/app/Console/Commands/Upgrade/UpgradesBillsToRules.php +++ b/app/Console/Commands/Upgrade/UpgradesBillsToRules.php @@ -36,6 +36,12 @@ use FireflyIII\User; use Illuminate\Console\Command; +/** + * Class UpgradesBillsToRules + * + * Comando para migrar faturas para regras. + * Converte faturas antigas para a nova estrutura baseada em regras. + */ class UpgradesBillsToRules extends Command { use ShowsFriendlyMessages; diff --git a/app/Console/Commands/Upgrade/UpgradesBudgetLimitPeriods.php b/app/Console/Commands/Upgrade/UpgradesBudgetLimitPeriods.php index a43f05682d8..b558a468b91 100644 --- a/app/Console/Commands/Upgrade/UpgradesBudgetLimitPeriods.php +++ b/app/Console/Commands/Upgrade/UpgradesBudgetLimitPeriods.php @@ -28,6 +28,12 @@ use FireflyIII\Models\BudgetLimit; use Illuminate\Console\Command; +/** + * Class UpgradesBudgetLimitPeriods + * + * Comando para adicionar periodos a limites de orcamento. + * Adiciona o periodo estimado aos limites de orcamento existentes. + */ class UpgradesBudgetLimitPeriods extends Command { use ShowsFriendlyMessages; diff --git a/app/Console/Commands/Upgrade/UpgradesBudgetLimits.php b/app/Console/Commands/Upgrade/UpgradesBudgetLimits.php index 473247de6fc..b16322bd8e6 100644 --- a/app/Console/Commands/Upgrade/UpgradesBudgetLimits.php +++ b/app/Console/Commands/Upgrade/UpgradesBudgetLimits.php @@ -31,6 +31,12 @@ use FireflyIII\User; use Illuminate\Console\Command; +/** + * Class UpgradesBudgetLimits + * + * Comando para atualizar limites de orcamento. + * Adiciona moeda aos limites de orcamento existentes. + */ class UpgradesBudgetLimits extends Command { use ShowsFriendlyMessages; diff --git a/app/Console/Commands/Upgrade/UpgradesCreditCardLiabilities.php b/app/Console/Commands/Upgrade/UpgradesCreditCardLiabilities.php index 7b3b8e65b11..daea3382e06 100644 --- a/app/Console/Commands/Upgrade/UpgradesCreditCardLiabilities.php +++ b/app/Console/Commands/Upgrade/UpgradesCreditCardLiabilities.php @@ -32,6 +32,12 @@ use Illuminate\Console\Command; use Illuminate\Support\Collection; +/** + * Class UpgradesCreditCardLiabilities + * + * Comando para converter passivos de cartao de credito. + * Converte contas de cartao de credito antigas para passivos genericos. + */ class UpgradesCreditCardLiabilities extends Command { use ShowsFriendlyMessages; diff --git a/app/Console/Commands/Upgrade/UpgradesCurrencyPreferences.php b/app/Console/Commands/Upgrade/UpgradesCurrencyPreferences.php index 56b1a5ee0cb..c108d157592 100644 --- a/app/Console/Commands/Upgrade/UpgradesCurrencyPreferences.php +++ b/app/Console/Commands/Upgrade/UpgradesCurrencyPreferences.php @@ -32,6 +32,12 @@ use Illuminate\Console\Command; use Illuminate\Support\Collection; +/** + * Class UpgradesCurrencyPreferences + * + * Comando para atualizar preferencias de moeda. + * Migra preferencias de moeda de usuarios para a nova estrutura. + */ class UpgradesCurrencyPreferences extends Command { use ShowsFriendlyMessages; diff --git a/app/Console/Commands/Upgrade/UpgradesDatabase.php b/app/Console/Commands/Upgrade/UpgradesDatabase.php index a98ff922d8f..d21cb07164a 100644 --- a/app/Console/Commands/Upgrade/UpgradesDatabase.php +++ b/app/Console/Commands/Upgrade/UpgradesDatabase.php @@ -38,6 +38,12 @@ use FireflyIII\Console\Commands\ShowsFriendlyMessages; use Illuminate\Console\Command; +/** + * Class UpgradesDatabase + * + * Comando para atualizar banco de dados. + * Executa todas as migracoes e comandos de atualizacao do banco de dados. + */ class UpgradesDatabase extends Command { use ShowsFriendlyMessages; diff --git a/app/Console/Commands/Upgrade/UpgradesJournalMetaData.php b/app/Console/Commands/Upgrade/UpgradesJournalMetaData.php index 3f199e57a18..5937f3b0ee8 100644 --- a/app/Console/Commands/Upgrade/UpgradesJournalMetaData.php +++ b/app/Console/Commands/Upgrade/UpgradesJournalMetaData.php @@ -33,6 +33,12 @@ use Illuminate\Support\Collection; use Illuminate\Support\Facades\DB; +/** + * Class UpgradesJournalMetaData + * + * Comando para migrar metadados de diarios. + * Move metadados de volta para diarios em vez de transacoes individuais. + */ class UpgradesJournalMetaData extends Command { use ShowsFriendlyMessages; diff --git a/app/Console/Commands/Upgrade/UpgradesJournalNotes.php b/app/Console/Commands/Upgrade/UpgradesJournalNotes.php index 788cf1f6c1d..81814e36865 100644 --- a/app/Console/Commands/Upgrade/UpgradesJournalNotes.php +++ b/app/Console/Commands/Upgrade/UpgradesJournalNotes.php @@ -29,6 +29,12 @@ use FireflyIII\Models\TransactionJournalMeta; use Illuminate\Console\Command; +/** + * Class UpgradesJournalNotes + * + * Comando para migrar notas de diarios. + * Migra notas de metadados de transacoes para a tabela de notas. + */ class UpgradesJournalNotes extends Command { use ShowsFriendlyMessages; diff --git a/app/Console/Commands/Upgrade/UpgradesLiabilities.php b/app/Console/Commands/Upgrade/UpgradesLiabilities.php index 4a4074b1fbb..ba867115dd7 100644 --- a/app/Console/Commands/Upgrade/UpgradesLiabilities.php +++ b/app/Console/Commands/Upgrade/UpgradesLiabilities.php @@ -34,6 +34,12 @@ use FireflyIII\User; use Illuminate\Console\Command; +/** + * Class UpgradesLiabilities + * + * Comando para atualizar passivos. + * Atualiza passivos para a nova estrutura 5.6.0. + */ class UpgradesLiabilities extends Command { use ShowsFriendlyMessages; diff --git a/app/Console/Commands/Upgrade/UpgradesLiabilitiesEight.php b/app/Console/Commands/Upgrade/UpgradesLiabilitiesEight.php index 511d8c4cf44..49836ecc986 100644 --- a/app/Console/Commands/Upgrade/UpgradesLiabilitiesEight.php +++ b/app/Console/Commands/Upgrade/UpgradesLiabilitiesEight.php @@ -36,6 +36,12 @@ use FireflyIII\User; use Illuminate\Console\Command; +/** + * Class UpgradesLiabilitiesEight + * + * Comando para atualizar passivos v6. + * Atualiza passivos para a nova estrutura 6.0.0. + */ class UpgradesLiabilitiesEight extends Command { use ShowsFriendlyMessages; diff --git a/app/Console/Commands/Upgrade/UpgradesMultiPiggyBanks.php b/app/Console/Commands/Upgrade/UpgradesMultiPiggyBanks.php index d155510181a..fb14fdc3cfa 100644 --- a/app/Console/Commands/Upgrade/UpgradesMultiPiggyBanks.php +++ b/app/Console/Commands/Upgrade/UpgradesMultiPiggyBanks.php @@ -32,6 +32,12 @@ use Illuminate\Console\Command; use Illuminate\Support\Facades\Log; +/** + * Class UpgradesMultiPiggyBanks + * + * Comando para atualizar cofrinhos. + * Atualiza cofrinhos para suportar multiplas contas. + */ class UpgradesMultiPiggyBanks extends Command { use ShowsFriendlyMessages; diff --git a/app/Console/Commands/Upgrade/UpgradesPrimaryCurrencyAmounts.php b/app/Console/Commands/Upgrade/UpgradesPrimaryCurrencyAmounts.php index 9cb26669ee5..8ce1f7fccaa 100644 --- a/app/Console/Commands/Upgrade/UpgradesPrimaryCurrencyAmounts.php +++ b/app/Console/Commands/Upgrade/UpgradesPrimaryCurrencyAmounts.php @@ -29,6 +29,12 @@ use Illuminate\Console\Command; use Illuminate\Support\Facades\Artisan; +/** + * Class UpgradesPrimaryCurrencyAmounts + * + * Comando para calcular valores em moeda primaria. + * Executa os calculos de valores em moeda primaria. + */ class UpgradesPrimaryCurrencyAmounts extends Command { use ShowsFriendlyMessages; diff --git a/app/Console/Commands/Upgrade/UpgradesRecurrenceMetaData.php b/app/Console/Commands/Upgrade/UpgradesRecurrenceMetaData.php index d40f566a4ce..9c71aec0db1 100644 --- a/app/Console/Commands/Upgrade/UpgradesRecurrenceMetaData.php +++ b/app/Console/Commands/Upgrade/UpgradesRecurrenceMetaData.php @@ -32,6 +32,12 @@ use function Safe\json_encode; +/** + * Class UpgradesRecurrenceMetaData + * + * Comando para migrar metadados de recorrencias. + * Migra metadados de recorrencias para a nova estrutura. + */ class UpgradesRecurrenceMetaData extends Command { use ShowsFriendlyMessages; diff --git a/app/Console/Commands/Upgrade/UpgradesRuleActions.php b/app/Console/Commands/Upgrade/UpgradesRuleActions.php index c3619be8f97..648efb2457d 100644 --- a/app/Console/Commands/Upgrade/UpgradesRuleActions.php +++ b/app/Console/Commands/Upgrade/UpgradesRuleActions.php @@ -29,6 +29,12 @@ use FireflyIII\Models\RuleAction; use Illuminate\Console\Command; +/** + * Class UpgradesRuleActions + * + * Comando para migrar acoes de regras. + * Migra acoes de regras obsoletas para o novo motor de expressoes. + */ class UpgradesRuleActions extends Command { use ShowsFriendlyMessages; diff --git a/app/Console/Commands/Upgrade/UpgradesTagLocations.php b/app/Console/Commands/Upgrade/UpgradesTagLocations.php index a6fe336a49b..ac3663b2a15 100644 --- a/app/Console/Commands/Upgrade/UpgradesTagLocations.php +++ b/app/Console/Commands/Upgrade/UpgradesTagLocations.php @@ -29,6 +29,12 @@ use FireflyIII\Models\Tag; use Illuminate\Console\Command; +/** + * Class UpgradesTagLocations + * + * Comando para migrar localizacoes de tags. + * Migra dados de localizacao de tags para a tabela de localizacoes. + */ class UpgradesTagLocations extends Command { use ShowsFriendlyMessages; diff --git a/app/Console/Commands/Upgrade/UpgradesToGroups.php b/app/Console/Commands/Upgrade/UpgradesToGroups.php index 453c31e0d3d..88073e8de07 100644 --- a/app/Console/Commands/Upgrade/UpgradesToGroups.php +++ b/app/Console/Commands/Upgrade/UpgradesToGroups.php @@ -39,6 +39,12 @@ use Illuminate\Support\Facades\DB; use Exception; +/** + * Class UpgradesToGroups + * + * Comando para migrar para grupos. + * Migra a estrutura de transacoes pre-4.7.8 para a estrutura 4.7.8+ com grupos. + */ class UpgradesToGroups extends Command { use ShowsFriendlyMessages; diff --git a/app/Console/Commands/Upgrade/UpgradesTransferCurrencies.php b/app/Console/Commands/Upgrade/UpgradesTransferCurrencies.php index d92813d6cd6..1e558fc2fd6 100644 --- a/app/Console/Commands/Upgrade/UpgradesTransferCurrencies.php +++ b/app/Console/Commands/Upgrade/UpgradesTransferCurrencies.php @@ -34,6 +34,12 @@ use FireflyIII\Repositories\Journal\JournalCLIRepositoryInterface; use Illuminate\Console\Command; +/** + * Class UpgradesTransferCurrencies + * + * Comando para atualizar moedas de transferencias. + * Verifica e corrige informacoes de moeda em transacoes de transferencia. + */ class UpgradesTransferCurrencies extends Command { use ShowsFriendlyMessages; diff --git a/app/Console/Commands/Upgrade/UpgradesVariousCurrencyInformation.php b/app/Console/Commands/Upgrade/UpgradesVariousCurrencyInformation.php index 648b34ed5e0..bf48e149d68 100644 --- a/app/Console/Commands/Upgrade/UpgradesVariousCurrencyInformation.php +++ b/app/Console/Commands/Upgrade/UpgradesVariousCurrencyInformation.php @@ -36,6 +36,12 @@ use FireflyIII\Repositories\Journal\JournalRepositoryInterface; use Illuminate\Console\Command; +/** + * Class UpgradesVariousCurrencyInformation + * + * Comando para atualizar informacoes de moeda. + * Atualiza informacoes de moeda em saques, depositos e saldos iniciais. + */ class UpgradesVariousCurrencyInformation extends Command { use ShowsFriendlyMessages; diff --git a/app/Console/Kernel.php b/app/Console/Kernel.php index bccbb2c3e5b..53786843c46 100644 --- a/app/Console/Kernel.php +++ b/app/Console/Kernel.php @@ -29,7 +29,10 @@ use Override; /** - * File to make sure commands work. + * Class Kernel + * + * Kernel do console. + * Registra comandos e define o agendamento de tarefas da aplicacao. */ class Kernel extends ConsoleKernel { diff --git a/app/Entities/AccountBalance.php b/app/Entities/AccountBalance.php index b7e62471261..85d7ef7fb77 100644 --- a/app/Entities/AccountBalance.php +++ b/app/Entities/AccountBalance.php @@ -26,6 +26,11 @@ use FireflyIII\Models\Account; +/** + * Class AccountBalance. + * + * Entidade para representacao de saldo de conta. + */ class AccountBalance { public string $amount; diff --git a/app/Enums/AccountTypeEnum.php b/app/Enums/AccountTypeEnum.php index 1a178d2101a..31760dbae05 100644 --- a/app/Enums/AccountTypeEnum.php +++ b/app/Enums/AccountTypeEnum.php @@ -25,7 +25,9 @@ namespace FireflyIII\Enums; /** - * enum AccountTypeEnum + * Enum AccountTypeEnum. + * + * Enumeracao de tipos de conta. */ enum AccountTypeEnum: string { diff --git a/app/Enums/AutoBudgetType.php b/app/Enums/AutoBudgetType.php index 6d2a327a65c..192d89d9731 100644 --- a/app/Enums/AutoBudgetType.php +++ b/app/Enums/AutoBudgetType.php @@ -25,7 +25,9 @@ namespace FireflyIII\Enums; /** - * Enum AutoBudgetType + * Enum AutoBudgetType. + * + * Enumeracao de tipos de orcamento automatico. */ enum AutoBudgetType: int { diff --git a/app/Enums/ClauseType.php b/app/Enums/ClauseType.php index 47f50192f82..a7987445655 100644 --- a/app/Enums/ClauseType.php +++ b/app/Enums/ClauseType.php @@ -25,7 +25,9 @@ namespace FireflyIII\Enums; /** - * Class ClauseType + * Class ClauseType. + * + * Classe de tipos de clausula para operacoes em massa. */ class ClauseType { diff --git a/app/Enums/RecurrenceRepetitionWeekend.php b/app/Enums/RecurrenceRepetitionWeekend.php index 78ad764e16d..7800248bae5 100644 --- a/app/Enums/RecurrenceRepetitionWeekend.php +++ b/app/Enums/RecurrenceRepetitionWeekend.php @@ -25,7 +25,9 @@ namespace FireflyIII\Enums; /** - * Class RecurrenceRepetitionWeekend + * Enum RecurrenceRepetitionWeekend. + * + * Enumeracao de comportamento de recorrencia em fim de semana. */ enum RecurrenceRepetitionWeekend: int { diff --git a/app/Enums/SearchDirection.php b/app/Enums/SearchDirection.php index 1bd8ee8c0ff..00de8cab929 100644 --- a/app/Enums/SearchDirection.php +++ b/app/Enums/SearchDirection.php @@ -24,6 +24,11 @@ namespace FireflyIII\Enums; +/** + * Enum SearchDirection. + * + * Enumeracao de direcao de busca. + */ enum SearchDirection { case SOURCE; diff --git a/app/Enums/StringPosition.php b/app/Enums/StringPosition.php index 3a65e02e539..17d43dd879d 100644 --- a/app/Enums/StringPosition.php +++ b/app/Enums/StringPosition.php @@ -25,8 +25,9 @@ namespace FireflyIII\Enums; /** - * Class StringPosition + * Enum StringPosition. * + * Enumeracao de posicao de string para busca. * stringPosition: 1 = start (default), 2 = end, 3 = contains, 4 = is */ enum StringPosition diff --git a/app/Enums/TransactionTypeEnum.php b/app/Enums/TransactionTypeEnum.php index 0df01e348a8..402bf1a96c4 100644 --- a/app/Enums/TransactionTypeEnum.php +++ b/app/Enums/TransactionTypeEnum.php @@ -25,7 +25,9 @@ namespace FireflyIII\Enums; /** - * Class TransactionTypeEnum + * Enum TransactionTypeEnum. + * + * Enumeracao de tipos de transacao. */ enum TransactionTypeEnum: string { diff --git a/app/Enums/UserRoleEnum.php b/app/Enums/UserRoleEnum.php index 8df1fcf9af1..ecfd9652afc 100644 --- a/app/Enums/UserRoleEnum.php +++ b/app/Enums/UserRoleEnum.php @@ -25,7 +25,9 @@ namespace FireflyIII\Enums; /** - * Class UserRoleEnum + * Enum UserRoleEnum. + * + * Enumeracao de papeis de usuario. */ enum UserRoleEnum: string { diff --git a/app/Enums/WebhookDelivery.php b/app/Enums/WebhookDelivery.php index 3322d761e88..aa30d922a4d 100644 --- a/app/Enums/WebhookDelivery.php +++ b/app/Enums/WebhookDelivery.php @@ -25,7 +25,9 @@ namespace FireflyIII\Enums; /** - * Class WebhookDelivery + * Enum WebhookDelivery. + * + * Enumeracao de formatos de entrega de webhook. */ enum WebhookDelivery: int { diff --git a/app/Enums/WebhookResponse.php b/app/Enums/WebhookResponse.php index ead11117a0e..06bbad33d13 100644 --- a/app/Enums/WebhookResponse.php +++ b/app/Enums/WebhookResponse.php @@ -25,7 +25,9 @@ namespace FireflyIII\Enums; /** - * Class WebhookResponse + * Enum WebhookResponse. + * + * Enumeracao de respostas de webhook. */ enum WebhookResponse: int { diff --git a/app/Enums/WebhookTrigger.php b/app/Enums/WebhookTrigger.php index 9f2951ff1d4..d107b663560 100644 --- a/app/Enums/WebhookTrigger.php +++ b/app/Enums/WebhookTrigger.php @@ -25,7 +25,9 @@ namespace FireflyIII\Enums; /** - * Class WebhookTrigger + * Enum WebhookTrigger. + * + * Enumeracao de gatilhos de webhook. */ enum WebhookTrigger: int { diff --git a/app/Events/Model/Account/Updated.php b/app/Events/Model/Account/Updated.php index fe765e1d086..e7993a74416 100644 --- a/app/Events/Model/Account/Updated.php +++ b/app/Events/Model/Account/Updated.php @@ -27,6 +27,11 @@ use FireflyIII\Models\Account; use Illuminate\Queue\SerializesModels; +/** + * Class Updated + * + * Evento disparado quando uma conta e atualizada. + */ class Updated { use SerializesModels; diff --git a/app/Events/Model/Bill/WarnUserAboutOverdueSubscriptions.php b/app/Events/Model/Bill/WarnUserAboutOverdueSubscriptions.php index 0e84a849dd4..f7fe8a7d626 100644 --- a/app/Events/Model/Bill/WarnUserAboutOverdueSubscriptions.php +++ b/app/Events/Model/Bill/WarnUserAboutOverdueSubscriptions.php @@ -8,6 +8,11 @@ use FireflyIII\User; use Illuminate\Queue\SerializesModels; +/** + * Class WarnUserAboutOverdueSubscriptions + * + * Evento para avisar usuario sobre assinaturas vencidas. + */ class WarnUserAboutOverdueSubscriptions extends Event { use SerializesModels; diff --git a/app/Events/Model/PiggyBank/ChangedName.php b/app/Events/Model/PiggyBank/ChangedName.php index bed6b78f201..58478623626 100644 --- a/app/Events/Model/PiggyBank/ChangedName.php +++ b/app/Events/Model/PiggyBank/ChangedName.php @@ -8,6 +8,11 @@ use FireflyIII\Models\PiggyBank; use Illuminate\Queue\SerializesModels; +/** + * Class ChangedName + * + * Evento disparado quando o nome de um cofrinho e alterado. + */ class ChangedName extends Event { use SerializesModels; diff --git a/app/Events/Preferences/UserGroupChangedPrimaryCurrency.php b/app/Events/Preferences/UserGroupChangedPrimaryCurrency.php index 4f6fc7fbb2c..b3f5cf3ef37 100644 --- a/app/Events/Preferences/UserGroupChangedPrimaryCurrency.php +++ b/app/Events/Preferences/UserGroupChangedPrimaryCurrency.php @@ -29,6 +29,11 @@ use Illuminate\Queue\SerializesModels; use Illuminate\Support\Facades\Log; +/** + * Class UserGroupChangedPrimaryCurrency + * + * Evento disparado quando um grupo de usuario altera sua moeda primaria. + */ class UserGroupChangedPrimaryCurrency extends Event { use SerializesModels; diff --git a/app/Events/Security/DisabledMFA.php b/app/Events/Security/DisabledMFA.php index 58c6260ed35..3363e930ada 100644 --- a/app/Events/Security/DisabledMFA.php +++ b/app/Events/Security/DisabledMFA.php @@ -29,6 +29,11 @@ use Illuminate\Contracts\Auth\Authenticatable; use Illuminate\Queue\SerializesModels; +/** + * Class DisabledMFA + * + * Evento disparado quando MFA e desabilitado para um usuario. + */ class DisabledMFA extends Event { use SerializesModels; diff --git a/app/Events/Security/EnabledMFA.php b/app/Events/Security/EnabledMFA.php index d0a647fc865..f1dfc75a9a5 100644 --- a/app/Events/Security/EnabledMFA.php +++ b/app/Events/Security/EnabledMFA.php @@ -29,6 +29,11 @@ use Illuminate\Contracts\Auth\Authenticatable; use Illuminate\Queue\SerializesModels; +/** + * Class EnabledMFA + * + * Evento disparado quando MFA e habilitado para um usuario. + */ class EnabledMFA extends Event { use SerializesModels; diff --git a/app/Events/Security/MFABackupFewLeft.php b/app/Events/Security/MFABackupFewLeft.php index 0379afeb3e1..57f32177725 100644 --- a/app/Events/Security/MFABackupFewLeft.php +++ b/app/Events/Security/MFABackupFewLeft.php @@ -29,6 +29,11 @@ use Illuminate\Contracts\Auth\Authenticatable; use Illuminate\Queue\SerializesModels; +/** + * Class MFABackupFewLeft + * + * Evento disparado quando restam poucos codigos de backup MFA. + */ class MFABackupFewLeft extends Event { use SerializesModels; diff --git a/app/Events/Security/MFABackupNoLeft.php b/app/Events/Security/MFABackupNoLeft.php index 43df68b3a1c..0395d64868a 100644 --- a/app/Events/Security/MFABackupNoLeft.php +++ b/app/Events/Security/MFABackupNoLeft.php @@ -29,6 +29,11 @@ use Illuminate\Contracts\Auth\Authenticatable; use Illuminate\Queue\SerializesModels; +/** + * Class MFABackupNoLeft + * + * Evento disparado quando nao ha mais codigos de backup MFA disponiveis. + */ class MFABackupNoLeft extends Event { use SerializesModels; diff --git a/app/Events/Security/MFAManyFailedAttempts.php b/app/Events/Security/MFAManyFailedAttempts.php index e1b9067c5b2..e7879ed0f93 100644 --- a/app/Events/Security/MFAManyFailedAttempts.php +++ b/app/Events/Security/MFAManyFailedAttempts.php @@ -29,6 +29,11 @@ use Illuminate\Contracts\Auth\Authenticatable; use Illuminate\Queue\SerializesModels; +/** + * Class MFAManyFailedAttempts + * + * Evento disparado quando ha muitas tentativas falhas de MFA. + */ class MFAManyFailedAttempts extends Event { use SerializesModels; diff --git a/app/Events/Security/MFANewBackupCodes.php b/app/Events/Security/MFANewBackupCodes.php index 4cf80e8f07b..41372c0d377 100644 --- a/app/Events/Security/MFANewBackupCodes.php +++ b/app/Events/Security/MFANewBackupCodes.php @@ -29,6 +29,11 @@ use Illuminate\Contracts\Auth\Authenticatable; use Illuminate\Queue\SerializesModels; +/** + * Class MFANewBackupCodes + * + * Evento disparado quando novos codigos de backup MFA sao gerados. + */ class MFANewBackupCodes extends Event { use SerializesModels; diff --git a/app/Events/Security/MFAUsedBackupCode.php b/app/Events/Security/MFAUsedBackupCode.php index 8321faf3f39..78c064fd050 100644 --- a/app/Events/Security/MFAUsedBackupCode.php +++ b/app/Events/Security/MFAUsedBackupCode.php @@ -29,6 +29,11 @@ use Illuminate\Contracts\Auth\Authenticatable; use Illuminate\Queue\SerializesModels; +/** + * Class MFAUsedBackupCode + * + * Evento disparado quando um codigo de backup MFA e usado. + */ class MFAUsedBackupCode extends Event { use SerializesModels; diff --git a/app/Events/Security/UnknownUserAttemptedLogin.php b/app/Events/Security/UnknownUserAttemptedLogin.php index 6482316711a..bf073494679 100644 --- a/app/Events/Security/UnknownUserAttemptedLogin.php +++ b/app/Events/Security/UnknownUserAttemptedLogin.php @@ -26,6 +26,11 @@ use Illuminate\Queue\SerializesModels; +/** + * Class UnknownUserAttemptedLogin + * + * Evento disparado quando um usuario desconhecido tenta fazer login. + */ class UnknownUserAttemptedLogin { use SerializesModels; diff --git a/app/Events/Security/UserAttemptedLogin.php b/app/Events/Security/UserAttemptedLogin.php index 6313bcbc355..b82f511a7f8 100644 --- a/app/Events/Security/UserAttemptedLogin.php +++ b/app/Events/Security/UserAttemptedLogin.php @@ -29,6 +29,11 @@ use Illuminate\Contracts\Auth\Authenticatable; use Illuminate\Queue\SerializesModels; +/** + * Class UserAttemptedLogin + * + * Evento disparado quando um usuario tenta fazer login. + */ class UserAttemptedLogin extends Event { use SerializesModels; diff --git a/app/Events/Test/OwnerTestNotificationChannel.php b/app/Events/Test/OwnerTestNotificationChannel.php index efce1b2a80a..93298ed2d95 100644 --- a/app/Events/Test/OwnerTestNotificationChannel.php +++ b/app/Events/Test/OwnerTestNotificationChannel.php @@ -27,6 +27,11 @@ use FireflyIII\Notifications\Notifiables\OwnerNotifiable; use Illuminate\Queue\SerializesModels; +/** + * Class OwnerTestNotificationChannel + * + * Evento para testar canal de notificacao do proprietario. + */ class OwnerTestNotificationChannel { use SerializesModels; diff --git a/app/Events/Test/UserTestNotificationChannel.php b/app/Events/Test/UserTestNotificationChannel.php index 4d028459d14..19ea11e6ff6 100644 --- a/app/Events/Test/UserTestNotificationChannel.php +++ b/app/Events/Test/UserTestNotificationChannel.php @@ -27,6 +27,11 @@ use FireflyIII\User; use Illuminate\Queue\SerializesModels; +/** + * Class UserTestNotificationChannel + * + * Evento para testar canal de notificacao de usuario. + */ class UserTestNotificationChannel { use SerializesModels; diff --git a/app/Exceptions/BadHttpHeaderException.php b/app/Exceptions/BadHttpHeaderException.php index 375466c2189..9e2c2a896dd 100644 --- a/app/Exceptions/BadHttpHeaderException.php +++ b/app/Exceptions/BadHttpHeaderException.php @@ -26,6 +26,11 @@ use Exception; +/** + * Class BadHttpHeaderException. + * + * Excecao lancada quando um cabecalho HTTP invalido e recebido. + */ class BadHttpHeaderException extends Exception { public int $statusCode = 406; diff --git a/app/Exceptions/DuplicateTransactionException.php b/app/Exceptions/DuplicateTransactionException.php index f468652981b..b2da46c2088 100644 --- a/app/Exceptions/DuplicateTransactionException.php +++ b/app/Exceptions/DuplicateTransactionException.php @@ -27,6 +27,8 @@ use Exception; /** - * Class DuplicateTransactionException + * Class DuplicateTransactionException. + * + * Excecao lancada quando uma transacao duplicada e detectada. */ class DuplicateTransactionException extends Exception {} diff --git a/app/Exceptions/FireflyException.php b/app/Exceptions/FireflyException.php index bca7de92bd7..337d6fa89d4 100644 --- a/app/Exceptions/FireflyException.php +++ b/app/Exceptions/FireflyException.php @@ -28,5 +28,7 @@ /** * Class FireflyException. + * + * Excecao base do Firefly III. */ class FireflyException extends Exception {} diff --git a/app/Exceptions/GracefulNotFoundHandler.php b/app/Exceptions/GracefulNotFoundHandler.php index 7866d200475..c377380a710 100644 --- a/app/Exceptions/GracefulNotFoundHandler.php +++ b/app/Exceptions/GracefulNotFoundHandler.php @@ -38,7 +38,9 @@ use Throwable; /** - * Class GracefulNotFoundHandler + * Class GracefulNotFoundHandler. + * + * Manipulador de excecoes 404 com redirecionamento gracioso. */ class GracefulNotFoundHandler extends ExceptionHandler { diff --git a/app/Exceptions/Handler.php b/app/Exceptions/Handler.php index fbdde03e1cc..74e2d1b9473 100644 --- a/app/Exceptions/Handler.php +++ b/app/Exceptions/Handler.php @@ -52,9 +52,10 @@ use function Safe\json_encode; use function Safe\parse_url; -// temp /** - * Class Handler + * Class Handler. + * + * Manipulador de excecoes da aplicacao. */ class Handler extends ExceptionHandler { diff --git a/app/Exceptions/IntervalException.php b/app/Exceptions/IntervalException.php index 45fe7cddfb7..4ee547aa5a5 100644 --- a/app/Exceptions/IntervalException.php +++ b/app/Exceptions/IntervalException.php @@ -29,7 +29,9 @@ use Throwable; /** - * Class IntervalException + * Class IntervalException. + * + * Excecao lancada quando um intervalo de periodicidade invalido e usado. */ final class IntervalException extends Exception { diff --git a/app/Exceptions/NotImplementedException.php b/app/Exceptions/NotImplementedException.php index 40d6a6e362c..f90ecc978ab 100644 --- a/app/Exceptions/NotImplementedException.php +++ b/app/Exceptions/NotImplementedException.php @@ -28,5 +28,7 @@ /** * Class NotImplementedException. + * + * Excecao lancada quando uma funcionalidade nao foi implementada. */ class NotImplementedException extends Exception {} diff --git a/app/Exceptions/ValidationException.php b/app/Exceptions/ValidationException.php index 5a89abb0c29..f20097e440b 100644 --- a/app/Exceptions/ValidationException.php +++ b/app/Exceptions/ValidationException.php @@ -27,6 +27,8 @@ use Exception; /** - * Class ValidationExceptions. + * Class ValidationException. + * + * Excecao lancada quando uma validacao falha. */ class ValidationException extends Exception {} diff --git a/app/Factory/AccountFactory.php b/app/Factory/AccountFactory.php index 94e9f5a5d91..9107f0827a1 100644 --- a/app/Factory/AccountFactory.php +++ b/app/Factory/AccountFactory.php @@ -37,9 +37,9 @@ use Illuminate\Support\Facades\Log; /** - * Factory to create or return accounts. + * Class AccountFactory. * - * Class AccountFactory + * Fabrica para criacao de contas. */ class AccountFactory { diff --git a/app/Factory/AccountMetaFactory.php b/app/Factory/AccountMetaFactory.php index 95bbd459553..91750333953 100644 --- a/app/Factory/AccountMetaFactory.php +++ b/app/Factory/AccountMetaFactory.php @@ -29,7 +29,9 @@ use FireflyIII\Support\Facades\Steam; /** - * Class AccountMetaFactory + * Class AccountMetaFactory. + * + * Fabrica para criacao de metadados de conta. */ class AccountMetaFactory { diff --git a/app/Factory/AttachmentFactory.php b/app/Factory/AttachmentFactory.php index 421af6dca2f..8f0c102d3af 100644 --- a/app/Factory/AttachmentFactory.php +++ b/app/Factory/AttachmentFactory.php @@ -32,7 +32,9 @@ use FireflyIII\User; /** - * Class AttachmentFactory + * Class AttachmentFactory. + * + * Fabrica para criacao de anexos. */ class AttachmentFactory { diff --git a/app/Factory/BillFactory.php b/app/Factory/BillFactory.php index 1fe45671344..0a87c43f9f6 100644 --- a/app/Factory/BillFactory.php +++ b/app/Factory/BillFactory.php @@ -33,7 +33,9 @@ use Illuminate\Database\QueryException; /** - * Class BillFactory + * Class BillFactory. + * + * Fabrica para criacao de faturas. */ class BillFactory { diff --git a/app/Factory/BudgetFactory.php b/app/Factory/BudgetFactory.php index bbb274fa5d7..810b1b348a8 100644 --- a/app/Factory/BudgetFactory.php +++ b/app/Factory/BudgetFactory.php @@ -28,6 +28,8 @@ /** * Class BudgetFactory. + * + * Fabrica para criacao de orcamentos. */ class BudgetFactory { diff --git a/app/Factory/CategoryFactory.php b/app/Factory/CategoryFactory.php index 754dba76445..8b407f3c7fb 100644 --- a/app/Factory/CategoryFactory.php +++ b/app/Factory/CategoryFactory.php @@ -29,7 +29,9 @@ use Illuminate\Database\QueryException; /** - * Class CategoryFactory + * Class CategoryFactory. + * + * Fabrica para criacao de categorias. */ class CategoryFactory { diff --git a/app/Factory/PiggyBankEventFactory.php b/app/Factory/PiggyBankEventFactory.php index 52643c55f72..fe3f0c7d665 100644 --- a/app/Factory/PiggyBankEventFactory.php +++ b/app/Factory/PiggyBankEventFactory.php @@ -28,9 +28,9 @@ use FireflyIII\Repositories\PiggyBank\PiggyBankRepositoryInterface; /** - * Create piggy bank events. + * Class PiggyBankEventFactory. * - * Class PiggyBankEventFactory + * Fabrica para criacao de eventos de cofrinho. */ class PiggyBankEventFactory { diff --git a/app/Factory/PiggyBankFactory.php b/app/Factory/PiggyBankFactory.php index 539e1999b8b..ca91e028da2 100644 --- a/app/Factory/PiggyBankFactory.php +++ b/app/Factory/PiggyBankFactory.php @@ -40,7 +40,9 @@ use function Safe\json_encode; /** - * Class PiggyBankFactory + * Class PiggyBankFactory. + * + * Fabrica para criacao de cofrinhos. */ class PiggyBankFactory { diff --git a/app/Factory/RecurrenceFactory.php b/app/Factory/RecurrenceFactory.php index 8254a8a4ec5..f084a7da66b 100644 --- a/app/Factory/RecurrenceFactory.php +++ b/app/Factory/RecurrenceFactory.php @@ -33,7 +33,9 @@ use Illuminate\Support\MessageBag; /** - * Class RecurrenceFactory + * Class RecurrenceFactory. + * + * Fabrica para criacao de transacoes recorrentes. */ class RecurrenceFactory { diff --git a/app/Factory/TagFactory.php b/app/Factory/TagFactory.php index e0bb78254cd..e2deeea62ae 100644 --- a/app/Factory/TagFactory.php +++ b/app/Factory/TagFactory.php @@ -30,7 +30,9 @@ use FireflyIII\User; /** - * Class TagFactory + * Class TagFactory. + * + * Fabrica para criacao de tags. */ class TagFactory { diff --git a/app/Factory/TransactionCurrencyFactory.php b/app/Factory/TransactionCurrencyFactory.php index b4088e200d4..c151f835cf7 100644 --- a/app/Factory/TransactionCurrencyFactory.php +++ b/app/Factory/TransactionCurrencyFactory.php @@ -29,7 +29,9 @@ use Illuminate\Database\QueryException; /** - * Class TransactionCurrencyFactory + * Class TransactionCurrencyFactory. + * + * Fabrica para criacao de moedas de transacao. */ class TransactionCurrencyFactory { diff --git a/app/Factory/TransactionFactory.php b/app/Factory/TransactionFactory.php index 9a1b590bf7b..10ba3c1b9a6 100644 --- a/app/Factory/TransactionFactory.php +++ b/app/Factory/TransactionFactory.php @@ -35,7 +35,9 @@ use Illuminate\Support\Facades\Validator; /** - * Class TransactionFactory + * Class TransactionFactory. + * + * Fabrica para criacao de transacoes. */ class TransactionFactory { diff --git a/app/Factory/TransactionGroupFactory.php b/app/Factory/TransactionGroupFactory.php index 10ecf31b52a..f09d9ad1340 100644 --- a/app/Factory/TransactionGroupFactory.php +++ b/app/Factory/TransactionGroupFactory.php @@ -31,7 +31,9 @@ use FireflyIII\User; /** - * Class TransactionGroupFactory + * Class TransactionGroupFactory. + * + * Fabrica para criacao de grupos de transacao. */ class TransactionGroupFactory { diff --git a/app/Factory/TransactionJournalFactory.php b/app/Factory/TransactionJournalFactory.php index 070f71fa265..15478d7fad6 100644 --- a/app/Factory/TransactionJournalFactory.php +++ b/app/Factory/TransactionJournalFactory.php @@ -59,7 +59,9 @@ use function Safe\json_encode; /** - * Class TransactionJournalFactory + * Class TransactionJournalFactory. + * + * Fabrica para criacao de lancamentos. * * @SuppressWarnings("PHPMD.CouplingBetweenObjects") */ diff --git a/app/Factory/TransactionJournalMetaFactory.php b/app/Factory/TransactionJournalMetaFactory.php index 56dd79d1e05..8c9c249c8a7 100644 --- a/app/Factory/TransactionJournalMetaFactory.php +++ b/app/Factory/TransactionJournalMetaFactory.php @@ -28,7 +28,9 @@ use FireflyIII\Models\TransactionJournalMeta; /** - * Class TransactionJournalMetaFactory + * Class TransactionJournalMetaFactory. + * + * Fabrica para criacao de metadados de lancamento. */ class TransactionJournalMetaFactory { diff --git a/app/Factory/TransactionTypeFactory.php b/app/Factory/TransactionTypeFactory.php index b7bde85c90d..0a2bdc26be5 100644 --- a/app/Factory/TransactionTypeFactory.php +++ b/app/Factory/TransactionTypeFactory.php @@ -27,7 +27,9 @@ use FireflyIII\Models\TransactionType; /** - * Class TransactionTypeFactory + * Class TransactionTypeFactory. + * + * Fabrica para criacao de tipos de transacao. */ class TransactionTypeFactory { diff --git a/app/Factory/UserGroupFactory.php b/app/Factory/UserGroupFactory.php index d392b698323..d84ad94a1d3 100644 --- a/app/Factory/UserGroupFactory.php +++ b/app/Factory/UserGroupFactory.php @@ -31,7 +31,9 @@ use FireflyIII\Models\UserRole; /** - * Class UserGroupFactory + * Class UserGroupFactory. + * + * Fabrica para criacao de grupos de usuario. */ class UserGroupFactory { diff --git a/app/Generator/Chart/Basic/ChartJsGenerator.php b/app/Generator/Chart/Basic/ChartJsGenerator.php index 4fd3a258e7e..0f075935d2c 100644 --- a/app/Generator/Chart/Basic/ChartJsGenerator.php +++ b/app/Generator/Chart/Basic/ChartJsGenerator.php @@ -27,6 +27,8 @@ /** * Class ChartJsGenerator. + * + * Gerador de graficos compativel com Chart.js. */ class ChartJsGenerator implements GeneratorInterface { diff --git a/app/Generator/Chart/Basic/GeneratorInterface.php b/app/Generator/Chart/Basic/GeneratorInterface.php index f55193b96cc..461489db669 100644 --- a/app/Generator/Chart/Basic/GeneratorInterface.php +++ b/app/Generator/Chart/Basic/GeneratorInterface.php @@ -25,6 +25,8 @@ /** * Interface GeneratorInterface. + * + * Interface para geradores de graficos. */ interface GeneratorInterface { diff --git a/app/Generator/Report/Account/MonthReportGenerator.php b/app/Generator/Report/Account/MonthReportGenerator.php index f711be2185c..c26ceaa51df 100644 --- a/app/Generator/Report/Account/MonthReportGenerator.php +++ b/app/Generator/Report/Account/MonthReportGenerator.php @@ -31,12 +31,21 @@ /** * Class MonthReportGenerator. + * + * Gerador de relatorios mensais por conta. */ class MonthReportGenerator implements ReportGeneratorInterface { + /** @var Collection Contas envolvidas */ private Collection $accounts; + + /** @var Carbon Data final */ private Carbon $end; + + /** @var Collection Contas de despesa */ private Collection $expense; + + /** @var Carbon Data inicial */ private Carbon $start; /** diff --git a/app/Generator/Report/Account/MultiYearReportGenerator.php b/app/Generator/Report/Account/MultiYearReportGenerator.php index 467b4611138..a6c4ffdaf8d 100644 --- a/app/Generator/Report/Account/MultiYearReportGenerator.php +++ b/app/Generator/Report/Account/MultiYearReportGenerator.php @@ -27,6 +27,8 @@ /** * Class MultiYearReportGenerator. + * + * Gerador de relatorios multi-anuais por conta. */ class MultiYearReportGenerator extends MonthReportGenerator { diff --git a/app/Generator/Report/Account/YearReportGenerator.php b/app/Generator/Report/Account/YearReportGenerator.php index 90a1b03cb6a..5dd273aa683 100644 --- a/app/Generator/Report/Account/YearReportGenerator.php +++ b/app/Generator/Report/Account/YearReportGenerator.php @@ -27,6 +27,8 @@ /** * Class YearReportGenerator. + * + * Gerador de relatorios anuais por conta. */ class YearReportGenerator extends MonthReportGenerator { diff --git a/app/Generator/Report/Audit/MonthReportGenerator.php b/app/Generator/Report/Audit/MonthReportGenerator.php index bc02d217a83..9112f4a6f7f 100644 --- a/app/Generator/Report/Audit/MonthReportGenerator.php +++ b/app/Generator/Report/Audit/MonthReportGenerator.php @@ -38,11 +38,18 @@ /** * Class MonthReportGenerator. + * + * Gerador de relatorios de auditoria mensais. */ class MonthReportGenerator implements ReportGeneratorInterface { + /** @var Collection Contas envolvidas */ private Collection $accounts; + + /** @var Carbon Data final */ private Carbon $end; + + /** @var Carbon Data inicial */ private Carbon $start; /** diff --git a/app/Generator/Report/Audit/MultiYearReportGenerator.php b/app/Generator/Report/Audit/MultiYearReportGenerator.php index 2dde9586a0c..350ce3772f7 100644 --- a/app/Generator/Report/Audit/MultiYearReportGenerator.php +++ b/app/Generator/Report/Audit/MultiYearReportGenerator.php @@ -25,5 +25,7 @@ /** * Class MultiYearReportGenerator. + * + * Gerador de relatorios de auditoria multi-anuais. */ class MultiYearReportGenerator extends MonthReportGenerator {} diff --git a/app/Generator/Report/Audit/YearReportGenerator.php b/app/Generator/Report/Audit/YearReportGenerator.php index 6357823820c..97d17b128c9 100644 --- a/app/Generator/Report/Audit/YearReportGenerator.php +++ b/app/Generator/Report/Audit/YearReportGenerator.php @@ -25,5 +25,7 @@ /** * Class YearReportGenerator. + * + * Gerador de relatorios de auditoria anuais. */ class YearReportGenerator extends MonthReportGenerator {} diff --git a/app/Generator/Report/Budget/MonthReportGenerator.php b/app/Generator/Report/Budget/MonthReportGenerator.php index 7c19c19e54d..1ed565f4141 100644 --- a/app/Generator/Report/Budget/MonthReportGenerator.php +++ b/app/Generator/Report/Budget/MonthReportGenerator.php @@ -33,14 +33,25 @@ /** * Class MonthReportGenerator. + * + * Gerador de relatorios mensais por orcamento. * TODO include info about tags. */ class MonthReportGenerator implements ReportGeneratorInterface { + /** @var Collection Contas envolvidas */ private Collection $accounts; + + /** @var Collection Orcamentos envolvidos */ private Collection $budgets; + + /** @var Carbon Data final */ private Carbon $end; + + /** @var array Despesas */ private array $expenses; + + /** @var Carbon Data inicial */ private Carbon $start; /** diff --git a/app/Generator/Report/Budget/MultiYearReportGenerator.php b/app/Generator/Report/Budget/MultiYearReportGenerator.php index 77a85793741..508f91c490b 100644 --- a/app/Generator/Report/Budget/MultiYearReportGenerator.php +++ b/app/Generator/Report/Budget/MultiYearReportGenerator.php @@ -25,5 +25,7 @@ /** * Class MultiYearReportGenerator. + * + * Gerador de relatorios multi-anuais por orcamento. */ class MultiYearReportGenerator extends MonthReportGenerator {} diff --git a/app/Generator/Report/Budget/YearReportGenerator.php b/app/Generator/Report/Budget/YearReportGenerator.php index 4251a99e49a..44856f57f22 100644 --- a/app/Generator/Report/Budget/YearReportGenerator.php +++ b/app/Generator/Report/Budget/YearReportGenerator.php @@ -25,5 +25,7 @@ /** * Class YearReportGenerator. + * + * Gerador de relatorios anuais por orcamento. */ class YearReportGenerator extends MonthReportGenerator {} diff --git a/app/Generator/Report/Category/MonthReportGenerator.php b/app/Generator/Report/Category/MonthReportGenerator.php index 61dd7f5cac9..55d0c9d9efc 100644 --- a/app/Generator/Report/Category/MonthReportGenerator.php +++ b/app/Generator/Report/Category/MonthReportGenerator.php @@ -33,15 +33,28 @@ /** * Class MonthReportGenerator. + * + * Gerador de relatorios mensais por categoria. * TODO include info about tags */ class MonthReportGenerator implements ReportGeneratorInterface { + /** @var Collection Contas envolvidas */ private Collection $accounts; + + /** @var Collection Categorias envolvidas */ private Collection $categories; + + /** @var Carbon Data final */ private Carbon $end; + + /** @var array Despesas */ private array $expenses; + + /** @var array Receitas */ private array $income; + + /** @var Carbon Data inicial */ private Carbon $start; /** diff --git a/app/Generator/Report/Category/MultiYearReportGenerator.php b/app/Generator/Report/Category/MultiYearReportGenerator.php index c7fb20662a3..36d8930f7f8 100644 --- a/app/Generator/Report/Category/MultiYearReportGenerator.php +++ b/app/Generator/Report/Category/MultiYearReportGenerator.php @@ -25,5 +25,7 @@ /** * Class MultiYearReportGenerator. + * + * Gerador de relatorios multi-anuais por categoria. */ class MultiYearReportGenerator extends MonthReportGenerator {} diff --git a/app/Generator/Report/Category/YearReportGenerator.php b/app/Generator/Report/Category/YearReportGenerator.php index 49f3d2f84f2..044559651be 100644 --- a/app/Generator/Report/Category/YearReportGenerator.php +++ b/app/Generator/Report/Category/YearReportGenerator.php @@ -25,5 +25,7 @@ /** * Class YearReportGenerator. + * + * Gerador de relatorios anuais por categoria. */ class YearReportGenerator extends MonthReportGenerator {} diff --git a/app/Generator/Report/ReportGeneratorFactory.php b/app/Generator/Report/ReportGeneratorFactory.php index 9d74f758ba7..9da02021625 100644 --- a/app/Generator/Report/ReportGeneratorFactory.php +++ b/app/Generator/Report/ReportGeneratorFactory.php @@ -28,6 +28,8 @@ /** * Class ReportGeneratorFactory. + * + * Fabrica para criar geradores de relatorios. */ class ReportGeneratorFactory { diff --git a/app/Generator/Report/ReportGeneratorInterface.php b/app/Generator/Report/ReportGeneratorInterface.php index 67a0991e4e6..ae50f7fbd93 100644 --- a/app/Generator/Report/ReportGeneratorInterface.php +++ b/app/Generator/Report/ReportGeneratorInterface.php @@ -28,6 +28,8 @@ /** * Interface ReportGeneratorInterface. + * + * Interface para geradores de relatorios. */ interface ReportGeneratorInterface { diff --git a/app/Generator/Report/Standard/MonthReportGenerator.php b/app/Generator/Report/Standard/MonthReportGenerator.php index edbe7910b66..4dc71f93465 100644 --- a/app/Generator/Report/Standard/MonthReportGenerator.php +++ b/app/Generator/Report/Standard/MonthReportGenerator.php @@ -31,6 +31,8 @@ /** * Class MonthReportGenerator. + * + * Gerador de relatorios mensais padrao. */ class MonthReportGenerator implements ReportGeneratorInterface { diff --git a/app/Generator/Report/Standard/MultiYearReportGenerator.php b/app/Generator/Report/Standard/MultiYearReportGenerator.php index d5e42a4dcbd..1ed2c04941f 100644 --- a/app/Generator/Report/Standard/MultiYearReportGenerator.php +++ b/app/Generator/Report/Standard/MultiYearReportGenerator.php @@ -30,7 +30,9 @@ use Throwable; /** - * Class MonthReportGenerator. + * Class MultiYearReportGenerator. + * + * Gerador de relatorios multi-anuais padrao. */ class MultiYearReportGenerator implements ReportGeneratorInterface { diff --git a/app/Generator/Report/Standard/YearReportGenerator.php b/app/Generator/Report/Standard/YearReportGenerator.php index 6ac88700c29..974ac122920 100644 --- a/app/Generator/Report/Standard/YearReportGenerator.php +++ b/app/Generator/Report/Standard/YearReportGenerator.php @@ -30,7 +30,9 @@ use Throwable; /** - * Class MonthReportGenerator. + * Class YearReportGenerator. + * + * Gerador de relatorios anuais padrao. */ class YearReportGenerator implements ReportGeneratorInterface { diff --git a/app/Generator/Report/Tag/MonthReportGenerator.php b/app/Generator/Report/Tag/MonthReportGenerator.php index 82d1c0c2474..af57e462cc5 100644 --- a/app/Generator/Report/Tag/MonthReportGenerator.php +++ b/app/Generator/Report/Tag/MonthReportGenerator.php @@ -32,12 +32,21 @@ /** * Class MonthReportGenerator. + * + * Gerador de relatorios mensais por tag. */ class MonthReportGenerator implements ReportGeneratorInterface { + /** @var Collection Contas envolvidas */ private Collection $accounts; + + /** @var Carbon Data final */ private Carbon $end; + + /** @var Carbon Data inicial */ private Carbon $start; + + /** @var Collection Tags envolvidas */ private Collection $tags; /** diff --git a/app/Generator/Report/Tag/MultiYearReportGenerator.php b/app/Generator/Report/Tag/MultiYearReportGenerator.php index f4f4b3eca39..9d6fe45a423 100644 --- a/app/Generator/Report/Tag/MultiYearReportGenerator.php +++ b/app/Generator/Report/Tag/MultiYearReportGenerator.php @@ -25,5 +25,7 @@ /** * Class MultiYearReportGenerator. + * + * Gerador de relatorios multi-anuais por tag. */ class MultiYearReportGenerator extends MonthReportGenerator {} diff --git a/app/Generator/Report/Tag/YearReportGenerator.php b/app/Generator/Report/Tag/YearReportGenerator.php index 91b94cdd7dd..d75bc3b28c2 100644 --- a/app/Generator/Report/Tag/YearReportGenerator.php +++ b/app/Generator/Report/Tag/YearReportGenerator.php @@ -25,5 +25,7 @@ /** * Class YearReportGenerator. + * + * Gerador de relatorios anuais por tag. */ class YearReportGenerator extends MonthReportGenerator {} diff --git a/app/Generator/Webhook/MessageGeneratorInterface.php b/app/Generator/Webhook/MessageGeneratorInterface.php index a16556e6c7a..5828808684c 100644 --- a/app/Generator/Webhook/MessageGeneratorInterface.php +++ b/app/Generator/Webhook/MessageGeneratorInterface.php @@ -30,6 +30,8 @@ /** * Interface MessageGeneratorInterface + * + * Interface para geradores de mensagens de webhook. */ interface MessageGeneratorInterface { diff --git a/app/Generator/Webhook/StandardMessageGenerator.php b/app/Generator/Webhook/StandardMessageGenerator.php index 6143aee75f7..2fe53bf4fdb 100644 --- a/app/Generator/Webhook/StandardMessageGenerator.php +++ b/app/Generator/Webhook/StandardMessageGenerator.php @@ -50,13 +50,24 @@ /** * Class StandardMessageGenerator + * + * Gerador padrao de mensagens de webhook. */ class StandardMessageGenerator implements MessageGeneratorInterface { + /** @var Collection Objetos para gerar mensagens */ private Collection $objects; + + /** @var WebhookTrigger Gatilho do webhook */ private WebhookTrigger $trigger; + + /** @var User Usuario */ private User $user; + + /** @var int Versao do gerador */ private int $version = 0; + + /** @var Collection Webhooks ativos */ private Collection $webhooks; public function __construct() diff --git a/app/Handlers/Events/APIEventHandler.php b/app/Handlers/Events/APIEventHandler.php index 7d59a4b6364..4c4c313e4cf 100644 --- a/app/Handlers/Events/APIEventHandler.php +++ b/app/Handlers/Events/APIEventHandler.php @@ -32,11 +32,17 @@ /** * Class APIEventHandler + * + * Manipulador de eventos da API. + * Processa eventos relacionados a tokens de acesso. */ class APIEventHandler { /** - * Respond to the creation of an access token. + * Responde a criacao de um token de acesso. + * Envia notificacao ao usuario sobre o novo token. + * + * @param AccessTokenCreated $event Evento de token criado */ public function accessTokenCreated(AccessTokenCreated $event): void { diff --git a/app/Handlers/Events/AdminEventHandler.php b/app/Handlers/Events/AdminEventHandler.php index 5fe258067c9..7c967700f76 100644 --- a/app/Handlers/Events/AdminEventHandler.php +++ b/app/Handlers/Events/AdminEventHandler.php @@ -41,9 +41,17 @@ /** * Class AdminEventHandler. + * + * Manipulador de eventos administrativos. + * Envia notificacoes para administradores sobre convites, logins e versoes. */ class AdminEventHandler { + /** + * Envia notificacao de convite criado. + * + * @param InvitationCreated $event Evento de convite criado + */ public function sendInvitationNotification(InvitationCreated $event): void { $sendMail = app('fireflyconfig')->get('notification_invite_created', true)->data; diff --git a/app/Handlers/Events/AuditEventHandler.php b/app/Handlers/Events/AuditEventHandler.php index d881b19ed45..d92fcc1d28a 100644 --- a/app/Handlers/Events/AuditEventHandler.php +++ b/app/Handlers/Events/AuditEventHandler.php @@ -30,9 +30,17 @@ /** * Class AuditEventHandler + * + * Manipulador de eventos de auditoria. + * Armazena logs de auditoria para alteracoes no sistema. */ class AuditEventHandler { + /** + * Armazena evento de auditoria. + * + * @param TriggeredAuditLog $event Evento de log de auditoria + */ public function storeAuditEvent(TriggeredAuditLog $event): void { $array = [ diff --git a/app/Handlers/Events/AutomationHandler.php b/app/Handlers/Events/AutomationHandler.php index 11b11a7b65a..c02c931b648 100644 --- a/app/Handlers/Events/AutomationHandler.php +++ b/app/Handlers/Events/AutomationHandler.php @@ -35,11 +35,17 @@ /** * Class AutomationHandler + * + * Manipulador de eventos de automacao. + * Envia relatorios sobre transacoes criadas automaticamente. */ class AutomationHandler { /** - * Respond to the creation of X journals. + * Responde a criacao de transacoes. + * Envia notificacao ao usuario sobre as transacoes criadas. + * + * @param RequestedReportOnJournals $event Evento de relatorio solicitado * * @throws FireflyException */ diff --git a/app/Handlers/Events/BillEventHandler.php b/app/Handlers/Events/BillEventHandler.php index 6a96bf29a75..dedba538426 100644 --- a/app/Handlers/Events/BillEventHandler.php +++ b/app/Handlers/Events/BillEventHandler.php @@ -36,9 +36,17 @@ /** * Class BillEventHandler + * + * Manipulador de eventos para faturas e assinaturas. + * Envia notificacoes sobre faturas vencidas e lembretes. */ class BillEventHandler { + /** + * Avisa sobre assinaturas vencidas. + * + * @param WarnUserAboutOverdueSubscriptions $event Evento de assinaturas vencidas + */ public function warnAboutOverdueSubscriptions(WarnUserAboutOverdueSubscriptions $event): void { Log::debug(sprintf('Now in %s', __METHOD__)); diff --git a/app/Handlers/Events/DestroyedGroupEventHandler.php b/app/Handlers/Events/DestroyedGroupEventHandler.php index fb5baf4c229..3ec8e4eb2e4 100644 --- a/app/Handlers/Events/DestroyedGroupEventHandler.php +++ b/app/Handlers/Events/DestroyedGroupEventHandler.php @@ -34,9 +34,17 @@ /** * Class DestroyedGroupEventHandler + * + * Manipulador de eventos para grupos de transacao destruidos. + * Dispara webhooks e atualiza saldos quando um grupo e excluido. */ class DestroyedGroupEventHandler { + /** + * Executa todos os manipuladores para o evento. + * + * @param DestroyedTransactionGroup $event Evento de grupo destruido + */ public function runAllHandlers(DestroyedTransactionGroup $event): void { $this->triggerWebhooks($event); diff --git a/app/Handlers/Events/Model/PiggyBankEventHandler.php b/app/Handlers/Events/Model/PiggyBankEventHandler.php index cea67d76b08..88f122dda6d 100644 --- a/app/Handlers/Events/Model/PiggyBankEventHandler.php +++ b/app/Handlers/Events/Model/PiggyBankEventHandler.php @@ -34,9 +34,18 @@ /** * Class PiggyBankEventHandler + * + * Manipulador de eventos para cofrinhos. + * Processa alteracoes de nome e valores de cofrinhos. */ class PiggyBankEventHandler { + /** + * Processa alteracao de nome do cofrinho. + * Atualiza regras que referenciam o nome antigo. + * + * @param ChangedName $event Evento de alteracao de nome + */ public function changedPiggyBankName(ChangedName $event): void { // loop all accounts, collect all user's rules. diff --git a/app/Handlers/Events/Model/RuleHandler.php b/app/Handlers/Events/Model/RuleHandler.php index ea3bb107c8f..f92fb1c52a0 100644 --- a/app/Handlers/Events/Model/RuleHandler.php +++ b/app/Handlers/Events/Model/RuleHandler.php @@ -33,9 +33,17 @@ /** * Class RuleHandler + * + * Manipulador de eventos para regras. + * Envia notificacoes quando acoes de regras falham. */ class RuleHandler { + /** + * Processa falha de acao de regra em array. + * + * @param RuleActionFailedOnArray $event Evento de falha de acao + */ public function ruleActionFailedOnArray(RuleActionFailedOnArray $event): void { $ruleAction = $event->ruleAction; diff --git a/app/Handlers/Events/PreferencesEventHandler.php b/app/Handlers/Events/PreferencesEventHandler.php index f816f890f97..7b9bb47033d 100644 --- a/app/Handlers/Events/PreferencesEventHandler.php +++ b/app/Handlers/Events/PreferencesEventHandler.php @@ -36,8 +36,19 @@ use Illuminate\Support\Facades\DB; use Illuminate\Support\Facades\Log; +/** + * Class PreferencesEventHandler + * + * Manipulador de eventos para preferencias. + * Reseta valores de moeda primaria quando alterada. + */ class PreferencesEventHandler { + /** + * Reseta valores de moeda primaria para todos os objetos. + * + * @param UserGroupChangedPrimaryCurrency $event Evento de alteracao de moeda + */ public function resetPrimaryCurrencyAmounts(UserGroupChangedPrimaryCurrency $event): void { // Reset the primary currency amounts for all objects that have it. diff --git a/app/Handlers/Events/Security/MFAHandler.php b/app/Handlers/Events/Security/MFAHandler.php index a259a742e25..2a5d20c5a24 100644 --- a/app/Handlers/Events/Security/MFAHandler.php +++ b/app/Handlers/Events/Security/MFAHandler.php @@ -41,8 +41,19 @@ use Illuminate\Support\Facades\Notification; use Exception; +/** + * Class MFAHandler + * + * Manipulador de eventos de autenticacao multi-fator (MFA). + * Envia notificacoes relacionadas a eventos de MFA. + */ class MFAHandler { + /** + * Envia email quando restam poucos codigos de backup. + * + * @param MFABackupFewLeft $event Evento de poucos codigos restantes + */ public function sendBackupFewLeftMail(MFABackupFewLeft $event): void { app('log')->debug(sprintf('Now in %s', __METHOD__)); diff --git a/app/Handlers/Events/StoredAccountEventHandler.php b/app/Handlers/Events/StoredAccountEventHandler.php index 574148def21..77cd2a11eac 100644 --- a/app/Handlers/Events/StoredAccountEventHandler.php +++ b/app/Handlers/Events/StoredAccountEventHandler.php @@ -29,9 +29,17 @@ /** * Class StoredAccountEventHandler + * + * Manipulador de eventos para contas armazenadas. + * Recalcula credito quando uma conta e criada. */ class StoredAccountEventHandler { + /** + * Recalcula o credito para a conta armazenada. + * + * @param StoredAccount $event Evento de conta armazenada + */ public function recalculateCredit(StoredAccount $event): void { $account = $event->account; diff --git a/app/Handlers/Events/StoredGroupEventHandler.php b/app/Handlers/Events/StoredGroupEventHandler.php index a5f806ae0c8..6b050991e1a 100644 --- a/app/Handlers/Events/StoredGroupEventHandler.php +++ b/app/Handlers/Events/StoredGroupEventHandler.php @@ -36,9 +36,17 @@ /** * Class StoredGroupEventHandler + * + * Manipulador de eventos para grupos de transacao armazenados. + * Processa regras, recalcula credito e dispara webhooks. */ class StoredGroupEventHandler { + /** + * Executa todos os manipuladores para o evento. + * + * @param StoredTransactionGroup $event Evento de grupo armazenado + */ public function runAllHandlers(StoredTransactionGroup $event): void { $this->processRules($event); diff --git a/app/Handlers/Events/UpdatedAccountEventHandler.php b/app/Handlers/Events/UpdatedAccountEventHandler.php index 59c137e8171..801f9a29cbf 100644 --- a/app/Handlers/Events/UpdatedAccountEventHandler.php +++ b/app/Handlers/Events/UpdatedAccountEventHandler.php @@ -29,9 +29,17 @@ /** * Class UpdatedAccountEventHandler + * + * Manipulador de eventos para contas atualizadas. + * Recalcula credito quando uma conta e atualizada. */ class UpdatedAccountEventHandler { + /** + * Recalcula o credito para a conta atualizada. + * + * @param UpdatedAccount $event Evento de conta atualizada + */ public function recalculateCredit(UpdatedAccount $event): void { $account = $event->account; diff --git a/app/Handlers/Events/UpdatedGroupEventHandler.php b/app/Handlers/Events/UpdatedGroupEventHandler.php index b25c913d0b0..738b755d822 100644 --- a/app/Handlers/Events/UpdatedGroupEventHandler.php +++ b/app/Handlers/Events/UpdatedGroupEventHandler.php @@ -40,9 +40,17 @@ /** * Class UpdatedGroupEventHandler + * + * Manipulador de eventos para grupos de transacao atualizados. + * Processa regras, recalcula credito e dispara webhooks. */ class UpdatedGroupEventHandler { + /** + * Executa todos os manipuladores para o evento. + * + * @param UpdatedTransactionGroup $event Evento de grupo atualizado + */ public function runAllHandlers(UpdatedTransactionGroup $event): void { $this->unifyAccounts($event); diff --git a/app/Handlers/Events/UserEventHandler.php b/app/Handlers/Events/UserEventHandler.php index ebe0cca9f69..d13215ec64f 100644 --- a/app/Handlers/Events/UserEventHandler.php +++ b/app/Handlers/Events/UserEventHandler.php @@ -61,7 +61,8 @@ /** * Class UserEventHandler. * - * This class responds to any events that have anything to do with the User object. + * Manipulador de eventos relacionados ao usuario. + * Processa registro, login, alteracao de email e notificacoes. * * The method name reflects what is being done. This is in the present tense. */ diff --git a/app/Handlers/Events/VersionCheckEventHandler.php b/app/Handlers/Events/VersionCheckEventHandler.php index a7ac2c62c3f..157f3dcd95f 100644 --- a/app/Handlers/Events/VersionCheckEventHandler.php +++ b/app/Handlers/Events/VersionCheckEventHandler.php @@ -34,6 +34,9 @@ /** * Class VersionCheckEventHandler + * + * Manipulador de eventos para verificacao de versao. + * Verifica se ha atualizacoes disponiveis no GitHub. */ class VersionCheckEventHandler { diff --git a/app/Handlers/Events/WebhookEventHandler.php b/app/Handlers/Events/WebhookEventHandler.php index f48adef9dfa..cb2054f9c79 100644 --- a/app/Handlers/Events/WebhookEventHandler.php +++ b/app/Handlers/Events/WebhookEventHandler.php @@ -30,11 +30,15 @@ /** * Class WebhookEventHandler + * + * Manipulador de eventos para webhooks. + * Envia mensagens de webhook pendentes. */ class WebhookEventHandler { /** - * Will try to send at most 3 messages so the flow doesn't get broken too much. + * Envia mensagens de webhook pendentes. + * Tenta enviar no maximo 5 mensagens para nao interromper o fluxo. */ public function sendWebhookMessages(): void { diff --git a/app/Handlers/Observer/AccountObserver.php b/app/Handlers/Observer/AccountObserver.php index b29983ada59..57856abd5ce 100644 --- a/app/Handlers/Observer/AccountObserver.php +++ b/app/Handlers/Observer/AccountObserver.php @@ -38,9 +38,17 @@ /** * Class AccountObserver + * + * Observador para contas. + * Atualiza valores de moeda primaria e limpa dados relacionados. */ class AccountObserver { + /** + * Processa criacao de conta. + * + * @param Account $account Conta criada + */ public function created(Account $account): void { // Log::debug('Observe "created" of an account.'); diff --git a/app/Handlers/Observer/AttachmentObserver.php b/app/Handlers/Observer/AttachmentObserver.php index 0ec70407016..70584a32be5 100644 --- a/app/Handlers/Observer/AttachmentObserver.php +++ b/app/Handlers/Observer/AttachmentObserver.php @@ -27,9 +27,17 @@ /** * Class AttachmentObserver + * + * Observador para anexos. + * Limpa notas ao excluir anexo. */ class AttachmentObserver { + /** + * Processa exclusao de anexo. + * + * @param Attachment $attachment Anexo sendo excluido + */ public function deleting(Attachment $attachment): void { app('log')->debug('Observe "deleting" of an attachment.'); diff --git a/app/Handlers/Observer/AutoBudgetObserver.php b/app/Handlers/Observer/AutoBudgetObserver.php index ca030ba70e0..c9b189dcd42 100644 --- a/app/Handlers/Observer/AutoBudgetObserver.php +++ b/app/Handlers/Observer/AutoBudgetObserver.php @@ -29,8 +29,19 @@ use FireflyIII\Support\Http\Api\ExchangeRateConverter; use Illuminate\Support\Facades\Log; +/** + * Class AutoBudgetObserver + * + * Observador para orcamentos automaticos. + * Atualiza valores de moeda primaria. + */ class AutoBudgetObserver { + /** + * Processa criacao de orcamento automatico. + * + * @param AutoBudget $autoBudget Orcamento automatico criado + */ public function created(AutoBudget $autoBudget): void { Log::debug('Observe "created" of an auto budget.'); diff --git a/app/Handlers/Observer/AvailableBudgetObserver.php b/app/Handlers/Observer/AvailableBudgetObserver.php index 02fc32d0b18..33a551f605e 100644 --- a/app/Handlers/Observer/AvailableBudgetObserver.php +++ b/app/Handlers/Observer/AvailableBudgetObserver.php @@ -29,8 +29,19 @@ use FireflyIII\Support\Http\Api\ExchangeRateConverter; use Illuminate\Support\Facades\Log; +/** + * Class AvailableBudgetObserver + * + * Observador para orcamentos disponiveis. + * Atualiza valores de moeda primaria. + */ class AvailableBudgetObserver { + /** + * Processa criacao de orcamento disponivel. + * + * @param AvailableBudget $availableBudget Orcamento criado + */ public function created(AvailableBudget $availableBudget): void { // Log::debug('Observe "created" of an available budget.'); diff --git a/app/Handlers/Observer/BillObserver.php b/app/Handlers/Observer/BillObserver.php index 9d7d5f96723..9d04221e783 100644 --- a/app/Handlers/Observer/BillObserver.php +++ b/app/Handlers/Observer/BillObserver.php @@ -32,9 +32,17 @@ /** * Class BillObserver + * + * Observador para faturas. + * Atualiza valores de moeda primaria e limpa anexos. */ class BillObserver { + /** + * Processa criacao de fatura. + * + * @param Bill $bill Fatura criada + */ public function created(Bill $bill): void { // Log::debug('Observe "created" of a bill.'); diff --git a/app/Handlers/Observer/BudgetLimitObserver.php b/app/Handlers/Observer/BudgetLimitObserver.php index f6fcc85f03e..02ede78c9ef 100644 --- a/app/Handlers/Observer/BudgetLimitObserver.php +++ b/app/Handlers/Observer/BudgetLimitObserver.php @@ -34,10 +34,21 @@ use Illuminate\Support\Collection; use Illuminate\Support\Facades\Log; +/** + * Class BudgetLimitObserver + * + * Observador para limites de orcamento. + * Atualiza valores de moeda primaria e dispara webhooks. + */ class BudgetLimitObserver { use RecalculatesAvailableBudgetsTrait; + /** + * Processa criacao de limite de orcamento. + * + * @param BudgetLimit $budgetLimit Limite criado + */ public function created(BudgetLimit $budgetLimit): void { Log::debug('Observe "created" of a budget limit.'); diff --git a/app/Handlers/Observer/BudgetObserver.php b/app/Handlers/Observer/BudgetObserver.php index 51a87b864f8..945ee6c4f34 100644 --- a/app/Handlers/Observer/BudgetObserver.php +++ b/app/Handlers/Observer/BudgetObserver.php @@ -36,11 +36,19 @@ /** * Class BudgetObserver + * + * Observador para orcamentos. + * Dispara webhooks e limpa dados relacionados. */ class BudgetObserver { use RecalculatesAvailableBudgetsTrait; + /** + * Processa criacao de orcamento. + * + * @param Budget $budget Orcamento criado + */ public function created(Budget $budget): void { Log::debug(sprintf('Observe "created" of budget #%d ("%s").', $budget->id, $budget->name)); diff --git a/app/Handlers/Observer/CategoryObserver.php b/app/Handlers/Observer/CategoryObserver.php index 24f7edf7921..9d5f01ef4c2 100644 --- a/app/Handlers/Observer/CategoryObserver.php +++ b/app/Handlers/Observer/CategoryObserver.php @@ -29,9 +29,17 @@ /** * Class CategoryObserver + * + * Observador para categorias. + * Limpa anexos e notas ao excluir categoria. */ class CategoryObserver { + /** + * Processa exclusao de categoria. + * + * @param Category $category Categoria sendo excluida + */ public function deleting(Category $category): void { app('log')->debug('Observe "deleting" of a category.'); diff --git a/app/Handlers/Observer/PiggyBankEventObserver.php b/app/Handlers/Observer/PiggyBankEventObserver.php index acd86567278..6bb651de495 100644 --- a/app/Handlers/Observer/PiggyBankEventObserver.php +++ b/app/Handlers/Observer/PiggyBankEventObserver.php @@ -29,8 +29,19 @@ use FireflyIII\Support\Http\Api\ExchangeRateConverter; use Illuminate\Support\Facades\Log; +/** + * Class PiggyBankEventObserver + * + * Observador para eventos de cofrinho. + * Atualiza valores de moeda primaria. + */ class PiggyBankEventObserver { + /** + * Processa criacao de evento de cofrinho. + * + * @param PiggyBankEvent $event Evento criado + */ public function created(PiggyBankEvent $event): void { Log::debug('Observe "created" of a piggy bank event.'); diff --git a/app/Handlers/Observer/PiggyBankObserver.php b/app/Handlers/Observer/PiggyBankObserver.php index 8c8364f01fc..6ce2c7234f0 100644 --- a/app/Handlers/Observer/PiggyBankObserver.php +++ b/app/Handlers/Observer/PiggyBankObserver.php @@ -32,9 +32,17 @@ /** * Class PiggyBankObserver + * + * Observador para cofrinhos. + * Atualiza valores de moeda primaria e limpa dados relacionados. */ class PiggyBankObserver { + /** + * Processa criacao de cofrinho. + * + * @param PiggyBank $piggyBank Cofrinho criado + */ public function created(PiggyBank $piggyBank): void { Log::debug('Observe "created" of a piggy bank.'); diff --git a/app/Handlers/Observer/RecurrenceObserver.php b/app/Handlers/Observer/RecurrenceObserver.php index ff2e4218f86..0c694eb5cfb 100644 --- a/app/Handlers/Observer/RecurrenceObserver.php +++ b/app/Handlers/Observer/RecurrenceObserver.php @@ -29,9 +29,17 @@ /** * Class RecurrenceObserver + * + * Observador para recorrencias. + * Limpa anexos, repeticoes e transacoes ao excluir. */ class RecurrenceObserver { + /** + * Processa exclusao de recorrencia. + * + * @param Recurrence $recurrence Recorrencia sendo excluida + */ public function deleting(Recurrence $recurrence): void { app('log')->debug('Observe "deleting" of a recurrence.'); diff --git a/app/Handlers/Observer/RecurrenceTransactionObserver.php b/app/Handlers/Observer/RecurrenceTransactionObserver.php index f88cb38b5db..17c3f44a3a2 100644 --- a/app/Handlers/Observer/RecurrenceTransactionObserver.php +++ b/app/Handlers/Observer/RecurrenceTransactionObserver.php @@ -27,9 +27,17 @@ /** * Class RecurrenceTransactionObserver + * + * Observador para transacoes recorrentes. + * Limpa metadados ao excluir transacao recorrente. */ class RecurrenceTransactionObserver { + /** + * Processa exclusao de transacao recorrente. + * + * @param RecurrenceTransaction $transaction Transacao sendo excluida + */ public function deleting(RecurrenceTransaction $transaction): void { app('log')->debug('Observe "deleting" of a recurrence transaction.'); diff --git a/app/Handlers/Observer/RuleGroupObserver.php b/app/Handlers/Observer/RuleGroupObserver.php index c7e1c223bf5..58888cc3f1c 100644 --- a/app/Handlers/Observer/RuleGroupObserver.php +++ b/app/Handlers/Observer/RuleGroupObserver.php @@ -27,9 +27,17 @@ /** * Class RuleGroupObserver + * + * Observador para grupos de regras. + * Exclui regras associadas ao excluir grupo. */ class RuleGroupObserver { + /** + * Processa exclusao de grupo de regras. + * + * @param RuleGroup $ruleGroup Grupo sendo excluido + */ public function deleting(RuleGroup $ruleGroup): void { app('log')->debug('Observe "deleting" of a rule group.'); diff --git a/app/Handlers/Observer/RuleObserver.php b/app/Handlers/Observer/RuleObserver.php index 3121a6b62e5..41323d00959 100644 --- a/app/Handlers/Observer/RuleObserver.php +++ b/app/Handlers/Observer/RuleObserver.php @@ -27,9 +27,17 @@ /** * Class RuleObserver + * + * Observador para regras. + * Limpa acoes e gatilhos ao excluir regra. */ class RuleObserver { + /** + * Processa exclusao de regra. + * + * @param Rule $rule Regra sendo excluida + */ public function deleting(Rule $rule): void { app('log')->debug('Observe "deleting" of a rule.'); diff --git a/app/Handlers/Observer/TagObserver.php b/app/Handlers/Observer/TagObserver.php index 71090e6ef32..3e8384c6a33 100644 --- a/app/Handlers/Observer/TagObserver.php +++ b/app/Handlers/Observer/TagObserver.php @@ -29,9 +29,17 @@ /** * Class TagObserver + * + * Observador para tags. + * Limpa anexos e localizacoes ao excluir tag. */ class TagObserver { + /** + * Processa exclusao de tag. + * + * @param Tag $tag Tag sendo excluida + */ public function deleting(Tag $tag): void { app('log')->debug('Observe "deleting" of a tag.'); diff --git a/app/Handlers/Observer/TransactionGroupObserver.php b/app/Handlers/Observer/TransactionGroupObserver.php index c3dacd4de5a..69c8d62a5c6 100644 --- a/app/Handlers/Observer/TransactionGroupObserver.php +++ b/app/Handlers/Observer/TransactionGroupObserver.php @@ -27,10 +27,18 @@ use Illuminate\Support\Facades\Log; /** - * Class TransactionGroup + * Class TransactionGroupObserver + * + * Observador para grupos de transacao. + * Exclui diarios associados ao excluir grupo. */ class TransactionGroupObserver { + /** + * Processa exclusao de grupo de transacao. + * + * @param TransactionGroup $transactionGroup Grupo sendo excluido + */ public function deleting(TransactionGroup $transactionGroup): void { Log::debug('Observe "deleting" of a transaction group.'); diff --git a/app/Handlers/Observer/TransactionJournalObserver.php b/app/Handlers/Observer/TransactionJournalObserver.php index ee6be25944a..18143222c61 100644 --- a/app/Handlers/Observer/TransactionJournalObserver.php +++ b/app/Handlers/Observer/TransactionJournalObserver.php @@ -30,9 +30,17 @@ /** * Class TransactionJournalObserver + * + * Observador para diarios de transacao. + * Limpa transacoes, anexos e links ao excluir. */ class TransactionJournalObserver { + /** + * Processa exclusao de diario de transacao. + * + * @param TransactionJournal $transactionJournal Diario sendo excluido + */ public function deleting(TransactionJournal $transactionJournal): void { Log::debug('Observe "deleting" of a transaction journal.'); diff --git a/app/Handlers/Observer/TransactionObserver.php b/app/Handlers/Observer/TransactionObserver.php index a5c5fefd732..39af57d7c03 100644 --- a/app/Handlers/Observer/TransactionObserver.php +++ b/app/Handlers/Observer/TransactionObserver.php @@ -31,11 +31,20 @@ /** * Class TransactionObserver + * + * Observador para transacoes. + * Atualiza saldos e valores de moeda primaria. */ class TransactionObserver { + /** @var bool Flag para controlar recalculo de saldo */ public static bool $recalculate = true; + /** + * Processa criacao de transacao. + * + * @param Transaction $transaction Transacao criada + */ public function created(Transaction $transaction): void { Log::debug('Observe "created" of a transaction.'); diff --git a/app/Handlers/Observer/WebhookMessageObserver.php b/app/Handlers/Observer/WebhookMessageObserver.php index 6248dc4d3c0..d93c3649336 100644 --- a/app/Handlers/Observer/WebhookMessageObserver.php +++ b/app/Handlers/Observer/WebhookMessageObserver.php @@ -27,9 +27,17 @@ /** * Class WebhookMessageObserver + * + * Observador para mensagens de webhook. + * Limpa tentativas de webhook ao excluir mensagem. */ class WebhookMessageObserver { + /** + * Processa exclusao de mensagem de webhook. + * + * @param WebhookMessage $webhookMessage Mensagem sendo excluida + */ public function deleting(WebhookMessage $webhookMessage): void { app('log')->debug('Observe "deleting" of a webhook message.'); diff --git a/app/Handlers/Observer/WebhookObserver.php b/app/Handlers/Observer/WebhookObserver.php index 6a0799db996..6877c73c3c1 100644 --- a/app/Handlers/Observer/WebhookObserver.php +++ b/app/Handlers/Observer/WebhookObserver.php @@ -27,9 +27,17 @@ /** * Class WebhookObserver + * + * Observador para webhooks. + * Limpa mensagens ao excluir webhook. */ class WebhookObserver { + /** + * Processa exclusao de webhook. + * + * @param Webhook $webhook Webhook sendo excluido + */ public function deleting(Webhook $webhook): void { app('log')->debug('Observe "deleting" of a webhook.'); diff --git a/app/Helpers/Attachments/AttachmentHelper.php b/app/Helpers/Attachments/AttachmentHelper.php index 28194b7e03f..17f0e0cc2d3 100644 --- a/app/Helpers/Attachments/AttachmentHelper.php +++ b/app/Helpers/Attachments/AttachmentHelper.php @@ -47,15 +47,27 @@ /** * Class AttachmentHelper. + * + * Helper para gerenciamento de anexos. */ class AttachmentHelper implements AttachmentHelperInterface { + /** @var Collection Anexos processados */ public Collection $attachments; + + /** @var MessageBag Erros de upload */ public MessageBag $errors; + + /** @var MessageBag Mensagens de sucesso */ public MessageBag $messages; + + /** @var array Tipos MIME permitidos */ protected array $allowedMimes = []; + + /** @var int Tamanho maximo de upload */ protected int $maxUploadSize = 0; + /** @var Filesystem Disco de upload */ protected Filesystem $uploadDisk; /** diff --git a/app/Helpers/Attachments/AttachmentHelperInterface.php b/app/Helpers/Attachments/AttachmentHelperInterface.php index 4640d5deb85..3efcbb293e5 100644 --- a/app/Helpers/Attachments/AttachmentHelperInterface.php +++ b/app/Helpers/Attachments/AttachmentHelperInterface.php @@ -29,6 +29,8 @@ /** * Interface AttachmentHelperInterface. + * + * Interface para helpers de anexos. */ interface AttachmentHelperInterface { diff --git a/app/Helpers/Collector/Extensions/AccountCollection.php b/app/Helpers/Collector/Extensions/AccountCollection.php index 2328b5dabcf..e32350c79f1 100644 --- a/app/Helpers/Collector/Extensions/AccountCollection.php +++ b/app/Helpers/Collector/Extensions/AccountCollection.php @@ -33,7 +33,9 @@ use Override; /** - * Trait AccountCollection + * Trait AccountCollection. + * + * Trait para coleta de transacoes por conta. */ trait AccountCollection { diff --git a/app/Helpers/Collector/Extensions/AmountCollection.php b/app/Helpers/Collector/Extensions/AmountCollection.php index 6daf0192a7e..ee2632fd163 100644 --- a/app/Helpers/Collector/Extensions/AmountCollection.php +++ b/app/Helpers/Collector/Extensions/AmountCollection.php @@ -28,7 +28,9 @@ use Illuminate\Database\Eloquent\Builder as EloquentBuilder; /** - * Trait AmountCollection + * Trait AmountCollection. + * + * Trait para coleta de transacoes por valor. */ trait AmountCollection { diff --git a/app/Helpers/Collector/Extensions/AttachmentCollection.php b/app/Helpers/Collector/Extensions/AttachmentCollection.php index 7738fd305fe..d21b36cffdd 100644 --- a/app/Helpers/Collector/Extensions/AttachmentCollection.php +++ b/app/Helpers/Collector/Extensions/AttachmentCollection.php @@ -31,7 +31,9 @@ use Illuminate\Database\Eloquent\Builder as EloquentBuilder; /** - * Trait AttachmentCollection + * Trait AttachmentCollection. + * + * Trait para coleta de transacoes por anexos. */ trait AttachmentCollection { diff --git a/app/Helpers/Collector/Extensions/CollectorProperties.php b/app/Helpers/Collector/Extensions/CollectorProperties.php index ae21d08041a..0b8cd8f8515 100644 --- a/app/Helpers/Collector/Extensions/CollectorProperties.php +++ b/app/Helpers/Collector/Extensions/CollectorProperties.php @@ -29,7 +29,9 @@ use Illuminate\Database\Eloquent\Relations\HasMany; /** - * Trait CollectorProperties + * Trait CollectorProperties. + * + * Trait com propriedades do coletor de transacoes. */ trait CollectorProperties { diff --git a/app/Helpers/Collector/Extensions/MetaCollection.php b/app/Helpers/Collector/Extensions/MetaCollection.php index 5e6dd7e85cc..aa028011d64 100644 --- a/app/Helpers/Collector/Extensions/MetaCollection.php +++ b/app/Helpers/Collector/Extensions/MetaCollection.php @@ -39,7 +39,9 @@ use function Safe\json_encode; /** - * Trait MetaCollection + * Trait MetaCollection. + * + * Trait para coleta de transacoes por metadados. */ trait MetaCollection { diff --git a/app/Helpers/Collector/Extensions/TimeCollection.php b/app/Helpers/Collector/Extensions/TimeCollection.php index b20a860e880..97f6c750e43 100644 --- a/app/Helpers/Collector/Extensions/TimeCollection.php +++ b/app/Helpers/Collector/Extensions/TimeCollection.php @@ -28,7 +28,9 @@ use FireflyIII\Helpers\Collector\GroupCollectorInterface; /** - * Trait TimeCollection + * Trait TimeCollection. + * + * Trait para coleta de transacoes por tempo. */ trait TimeCollection { diff --git a/app/Helpers/Collector/GroupCollector.php b/app/Helpers/Collector/GroupCollector.php index 59b27487309..ebf58ba2c35 100644 --- a/app/Helpers/Collector/GroupCollector.php +++ b/app/Helpers/Collector/GroupCollector.php @@ -51,7 +51,9 @@ use function Safe\json_decode; /** - * Class GroupCollector + * Class GroupCollector. + * + * Coletor de grupos de transacoes. */ class GroupCollector implements GroupCollectorInterface { diff --git a/app/Helpers/Collector/GroupCollectorInterface.php b/app/Helpers/Collector/GroupCollectorInterface.php index 8dab806e8c7..ffe4cbd0fb4 100644 --- a/app/Helpers/Collector/GroupCollectorInterface.php +++ b/app/Helpers/Collector/GroupCollectorInterface.php @@ -37,7 +37,9 @@ use Illuminate\Support\Collection; /** - * Interface GroupCollectorInterface + * Interface GroupCollectorInterface. + * + * Interface para coletor de grupos de transacoes. */ interface GroupCollectorInterface { diff --git a/app/Helpers/Fiscal/FiscalHelper.php b/app/Helpers/Fiscal/FiscalHelper.php index 13c9d14bdc0..1b5c57a777a 100644 --- a/app/Helpers/Fiscal/FiscalHelper.php +++ b/app/Helpers/Fiscal/FiscalHelper.php @@ -27,10 +27,12 @@ /** * Class FiscalHelper. + * + * Helper para calculos de ano fiscal. */ class FiscalHelper implements FiscalHelperInterface { - /** @var bool */ + /** @var bool Se usa ano fiscal personalizado */ protected $useCustomFiscalYear; /** diff --git a/app/Helpers/Fiscal/FiscalHelperInterface.php b/app/Helpers/Fiscal/FiscalHelperInterface.php index 52850486230..9549a0aa412 100644 --- a/app/Helpers/Fiscal/FiscalHelperInterface.php +++ b/app/Helpers/Fiscal/FiscalHelperInterface.php @@ -27,6 +27,8 @@ /** * Interface FiscalHelperInterface. + * + * Interface para helpers de ano fiscal. */ interface FiscalHelperInterface { diff --git a/app/Helpers/Report/NetWorth.php b/app/Helpers/Report/NetWorth.php index c3a2f0592cc..64fbce19c73 100644 --- a/app/Helpers/Report/NetWorth.php +++ b/app/Helpers/Report/NetWorth.php @@ -41,16 +41,24 @@ use Illuminate\Support\Facades\Log; /** - * This class can handle both request with and without a user group and will return the appropriate repository when - * necessary. + * Class NetWorth. * - * Class NetWorth + * Helper para calcular patrimonio liquido. + * Esta classe pode lidar com requisicoes com e sem grupo de usuario + * e retornara o repositorio apropriado quando necessario. */ class NetWorth implements NetWorthInterface { + /** @var AccountRepositoryInterface Repositorio de contas */ private AccountRepositoryInterface $accountRepository; + + /** @var CurrencyRepositoryInterface Repositorio de moedas */ private CurrencyRepositoryInterface $currencyRepos; + + /** @var User Usuario */ private User $user; // @phpstan-ignore-line + + /** @var UserGroup|null Grupo de usuario */ private ?UserGroup $userGroup = null; // @phpstan-ignore-line /** diff --git a/app/Helpers/Report/NetWorthInterface.php b/app/Helpers/Report/NetWorthInterface.php index a73cd53b4d1..936ef0daaa8 100644 --- a/app/Helpers/Report/NetWorthInterface.php +++ b/app/Helpers/Report/NetWorthInterface.php @@ -32,7 +32,9 @@ use Illuminate\Support\Collection; /** - * Interface NetWorthInterface + * Interface NetWorthInterface. + * + * Interface para helpers de patrimonio liquido. */ interface NetWorthInterface { diff --git a/app/Helpers/Report/PopupReport.php b/app/Helpers/Report/PopupReport.php index aa213197800..bffb4180293 100644 --- a/app/Helpers/Report/PopupReport.php +++ b/app/Helpers/Report/PopupReport.php @@ -35,6 +35,8 @@ /** * Class PopupReport. + * + * Helper para relatorios popup. */ class PopupReport implements PopupReportInterface { diff --git a/app/Helpers/Report/PopupReportInterface.php b/app/Helpers/Report/PopupReportInterface.php index 3a03cdb0492..1ce25e6bc44 100644 --- a/app/Helpers/Report/PopupReportInterface.php +++ b/app/Helpers/Report/PopupReportInterface.php @@ -29,6 +29,8 @@ /** * Interface PopupReportInterface. + * + * Interface para relatorios popup. */ interface PopupReportInterface { diff --git a/app/Helpers/Report/ReportHelper.php b/app/Helpers/Report/ReportHelper.php index 3fce549ae05..d1fd529e386 100644 --- a/app/Helpers/Report/ReportHelper.php +++ b/app/Helpers/Report/ReportHelper.php @@ -33,10 +33,12 @@ /** * Class ReportHelper. + * + * Helper para geracao de relatorios. */ class ReportHelper implements ReportHelperInterface { - /** @var BudgetRepositoryInterface The budget repository */ + /** @var BudgetRepositoryInterface Repositorio de orcamentos */ protected $budgetRepository; /** diff --git a/app/Helpers/Report/ReportHelperInterface.php b/app/Helpers/Report/ReportHelperInterface.php index 1320127896b..c0d366e612c 100644 --- a/app/Helpers/Report/ReportHelperInterface.php +++ b/app/Helpers/Report/ReportHelperInterface.php @@ -28,6 +28,8 @@ /** * Interface ReportHelperInterface. + * + * Interface para helpers de relatorios. */ interface ReportHelperInterface { diff --git a/app/Helpers/Update/UpdateTrait.php b/app/Helpers/Update/UpdateTrait.php index 8a779cdfc26..8f74b3a1176 100644 --- a/app/Helpers/Update/UpdateTrait.php +++ b/app/Helpers/Update/UpdateTrait.php @@ -27,7 +27,9 @@ use FireflyIII\Services\FireflyIIIOrg\Update\UpdateRequestInterface; /** - * Trait UpdateTrait + * Trait UpdateTrait. + * + * Trait para verificacao de atualizacoes. */ trait UpdateTrait { diff --git a/app/Helpers/Webhook/Sha3SignatureGenerator.php b/app/Helpers/Webhook/Sha3SignatureGenerator.php index 6d42a4ac56b..4de460e5117 100644 --- a/app/Helpers/Webhook/Sha3SignatureGenerator.php +++ b/app/Helpers/Webhook/Sha3SignatureGenerator.php @@ -32,10 +32,13 @@ use function Safe\json_encode; /** - * Class Sha3SignatureGenerator + * Class Sha3SignatureGenerator. + * + * Gerador de assinaturas SHA3 para webhooks. */ class Sha3SignatureGenerator implements SignatureGeneratorInterface { + /** @var int Versao do gerador */ private int $version = 1; /** diff --git a/app/Helpers/Webhook/SignatureGeneratorInterface.php b/app/Helpers/Webhook/SignatureGeneratorInterface.php index b8234091652..9d9983abc32 100644 --- a/app/Helpers/Webhook/SignatureGeneratorInterface.php +++ b/app/Helpers/Webhook/SignatureGeneratorInterface.php @@ -27,7 +27,9 @@ use FireflyIII\Models\WebhookMessage; /** - * Interface SignatureGeneratorInterface + * Interface SignatureGeneratorInterface. + * + * Interface para geradores de assinaturas de webhook. */ interface SignatureGeneratorInterface { diff --git a/app/Http/Controllers/Account/CreateController.php b/app/Http/Controllers/Account/CreateController.php index 9098c4e2fa2..ea4709fe04d 100644 --- a/app/Http/Controllers/Account/CreateController.php +++ b/app/Http/Controllers/Account/CreateController.php @@ -40,6 +40,10 @@ /** * Class CreateController + * + * Controlador responsavel pela criacao de novas contas no sistema. + * Permite criar contas de ativos, passivos, despesas e receitas + * com suporte a anexos e localizacao geografica. */ class CreateController extends Controller { diff --git a/app/Http/Controllers/Account/DeleteController.php b/app/Http/Controllers/Account/DeleteController.php index 0763718cd12..65e66c5ce23 100644 --- a/app/Http/Controllers/Account/DeleteController.php +++ b/app/Http/Controllers/Account/DeleteController.php @@ -35,6 +35,10 @@ /** * Class DeleteController + * + * Controlador responsavel pela exclusao de contas no sistema. + * Permite excluir contas e opcionalmente mover transacoes + * para outra conta antes da exclusao. */ class DeleteController extends Controller { diff --git a/app/Http/Controllers/Account/EditController.php b/app/Http/Controllers/Account/EditController.php index 7d172bead13..e74719224f7 100644 --- a/app/Http/Controllers/Account/EditController.php +++ b/app/Http/Controllers/Account/EditController.php @@ -40,6 +40,10 @@ /** * Class EditController + * + * Controlador responsavel pela edicao de contas existentes. + * Permite modificar propriedades da conta como nome, moeda, + * saldo inicial, localizacao e configuracoes especificas. */ class EditController extends Controller { diff --git a/app/Http/Controllers/Account/IndexController.php b/app/Http/Controllers/Account/IndexController.php index 1ee5f5cccf9..c4d89dfa8f2 100644 --- a/app/Http/Controllers/Account/IndexController.php +++ b/app/Http/Controllers/Account/IndexController.php @@ -38,6 +38,10 @@ /** * Class IndexController + * + * Controlador responsavel pela listagem de contas no sistema. + * Exibe contas ativas e inativas com informacoes de saldo, + * atividade recente e estatisticas do periodo. */ class IndexController extends Controller { @@ -123,6 +127,14 @@ function (Account $account) use ($activities, $startBalances, $endBalances): voi return view('accounts.index', compact('objectType', 'inactivePage', 'subTitleIcon', 'subTitle', 'page', 'accounts')); } + /** + * Calcula a diferenca entre saldos iniciais e finais. + * + * @param array $startBalances Saldos iniciais por moeda + * @param array $endBalances Saldos finais por moeda + * + * @return array Diferencas calculadas por moeda + */ private function subtract(array $startBalances, array $endBalances): array { $result = []; diff --git a/app/Http/Controllers/Account/ReconcileController.php b/app/Http/Controllers/Account/ReconcileController.php index cee8c1c158e..1ad19d9cb10 100644 --- a/app/Http/Controllers/Account/ReconcileController.php +++ b/app/Http/Controllers/Account/ReconcileController.php @@ -43,7 +43,11 @@ use Illuminate\View\View; /** - * Class ReconcileController. + * Class ReconcileController + * + * Controlador responsavel pela reconciliacao de contas. + * Permite ao usuario verificar e ajustar saldos de contas + * comparando com extratos bancarios e criando transacoes de ajuste. */ class ReconcileController extends Controller { @@ -193,7 +197,14 @@ public function submit(ReconciliationStoreRequest $request, Account $account, Ca } /** - * Creates a reconciliation group. + * Cria uma transacao de reconciliacao para ajustar o saldo da conta. + * + * @param Account $account Conta a ser reconciliada + * @param Carbon $start Data inicial do periodo + * @param Carbon $end Data final do periodo + * @param string $difference Diferenca a ser ajustada + * + * @return string Mensagem de erro ou string vazia em caso de sucesso * * @throws DuplicateTransactionException */ diff --git a/app/Http/Controllers/Account/ShowController.php b/app/Http/Controllers/Account/ShowController.php index 71712913902..33f3a86f0b5 100644 --- a/app/Http/Controllers/Account/ShowController.php +++ b/app/Http/Controllers/Account/ShowController.php @@ -44,6 +44,10 @@ /** * Class ShowController + * + * Controlador responsavel pela exibicao detalhada de contas. + * Mostra transacoes, saldos, graficos e informacoes completas + * de uma conta especifica com suporte a filtros de periodo. */ class ShowController extends Controller { diff --git a/app/Http/Controllers/Admin/ConfigurationController.php b/app/Http/Controllers/Admin/ConfigurationController.php index 33afca23c07..c2394c3b139 100644 --- a/app/Http/Controllers/Admin/ConfigurationController.php +++ b/app/Http/Controllers/Admin/ConfigurationController.php @@ -33,7 +33,11 @@ use Illuminate\View\View; /** - * Class ConfigurationController. + * Class ConfigurationController + * + * Controlador responsavel pelas configuracoes globais da instancia. + * Permite configurar modo de usuario unico, modo demo e outras + * configuracoes do sistema. */ class ConfigurationController extends Controller { diff --git a/app/Http/Controllers/Admin/HomeController.php b/app/Http/Controllers/Admin/HomeController.php index 6f4fc059f2e..b0339c9e2e4 100644 --- a/app/Http/Controllers/Admin/HomeController.php +++ b/app/Http/Controllers/Admin/HomeController.php @@ -30,7 +30,10 @@ use Illuminate\View\View; /** - * Class HomeController. + * Class HomeController + * + * Controlador responsavel pela pagina inicial da area administrativa. + * Exibe o indice de configuracoes do sistema e informacoes do administrador. */ class HomeController extends Controller { diff --git a/app/Http/Controllers/Admin/LinkController.php b/app/Http/Controllers/Admin/LinkController.php index 88d87ac3a1f..f142af036b9 100644 --- a/app/Http/Controllers/Admin/LinkController.php +++ b/app/Http/Controllers/Admin/LinkController.php @@ -36,7 +36,11 @@ use Illuminate\View\View; /** - * Class LinkController. + * Class LinkController + * + * Controlador responsavel pela administracao de tipos de links entre transacoes. + * Permite criar, editar e excluir tipos de links personalizados que conectam + * transacoes relacionadas no sistema. */ class LinkController extends Controller { diff --git a/app/Http/Controllers/Admin/NotificationController.php b/app/Http/Controllers/Admin/NotificationController.php index 39823066d13..24143269d07 100644 --- a/app/Http/Controllers/Admin/NotificationController.php +++ b/app/Http/Controllers/Admin/NotificationController.php @@ -34,8 +34,20 @@ use Illuminate\Support\Facades\Log; use Illuminate\View\View; +/** + * Class NotificationController + * + * Controlador responsavel pelas configuracoes de notificacoes do administrador. + * Permite configurar canais de notificacao como Slack, Pushover, ntfy e email + * para alertas do sistema. + */ class NotificationController extends Controller { + /** + * Exibe a pagina de configuracao de notificacoes. + * + * @return View View com as configuracoes de notificacao + */ public function index(): View { Log::channel('audit')->info('User visits notifications index.'); @@ -93,6 +105,13 @@ public function index(): View ); } + /** + * Salva as configuracoes de notificacao. + * + * @param NotificationRequest $request Requisicao com dados de notificacao + * + * @return RedirectResponse Redirecionamento para a pagina de configuracoes + */ public function postIndex(NotificationRequest $request): RedirectResponse { $all = $request->getAll(); @@ -119,6 +138,13 @@ public function postIndex(NotificationRequest $request): RedirectResponse return redirect(route('settings.notification.index')); } + /** + * Envia uma notificacao de teste para o canal especificado. + * + * @param Request $request Requisicao com o canal de teste + * + * @return RedirectResponse Redirecionamento com resultado do teste + */ public function testNotification(Request $request): RedirectResponse { diff --git a/app/Http/Controllers/Admin/UpdateController.php b/app/Http/Controllers/Admin/UpdateController.php index 8502d43ce8b..6e814c37bac 100644 --- a/app/Http/Controllers/Admin/UpdateController.php +++ b/app/Http/Controllers/Admin/UpdateController.php @@ -34,7 +34,11 @@ use Illuminate\View\View; /** - * Class HomeController. + * Class UpdateController + * + * Controlador responsavel pela verificacao de atualizacoes do sistema. + * Permite configurar preferencias de atualizacao e verificar manualmente + * se ha novas versoes disponiveis do Firefly III. */ class UpdateController extends Controller { diff --git a/app/Http/Controllers/Admin/UserController.php b/app/Http/Controllers/Admin/UserController.php index 07abf76b4db..6d2b138b172 100644 --- a/app/Http/Controllers/Admin/UserController.php +++ b/app/Http/Controllers/Admin/UserController.php @@ -39,7 +39,11 @@ use Illuminate\View\View; /** - * Class UserController. + * Class UserController + * + * Controlador responsavel pela administracao de usuarios do sistema. + * Permite listar, criar, editar, excluir usuarios e gerenciar convites + * para novos usuarios no modo de usuario unico. */ class UserController extends Controller { diff --git a/app/Http/Controllers/Auth/ConfirmPasswordController.php b/app/Http/Controllers/Auth/ConfirmPasswordController.php index 7ff1da6abdd..787c75faa6f 100644 --- a/app/Http/Controllers/Auth/ConfirmPasswordController.php +++ b/app/Http/Controllers/Auth/ConfirmPasswordController.php @@ -31,6 +31,10 @@ /** * Class ConfirmPasswordController + * + * Controlador responsavel pela confirmacao de senha. + * Solicita que usuarios confirmem sua senha antes de + * acessar areas sensiveis do sistema. */ class ConfirmPasswordController extends Controller { diff --git a/app/Http/Controllers/Auth/ForgotPasswordController.php b/app/Http/Controllers/Auth/ForgotPasswordController.php index dc292cc5709..276b5dbd7cd 100644 --- a/app/Http/Controllers/Auth/ForgotPasswordController.php +++ b/app/Http/Controllers/Auth/ForgotPasswordController.php @@ -38,6 +38,10 @@ /** * Class ForgotPasswordController + * + * Controlador responsavel pela recuperacao de senha. + * Envia emails com links de redefinicao de senha + * para usuarios que esqueceram suas credenciais. */ class ForgotPasswordController extends Controller { diff --git a/app/Http/Controllers/Auth/LoginController.php b/app/Http/Controllers/Auth/LoginController.php index 19a1b37764c..0e9d954b0f6 100644 --- a/app/Http/Controllers/Auth/LoginController.php +++ b/app/Http/Controllers/Auth/LoginController.php @@ -51,9 +51,9 @@ /** * Class LoginController * - * This controller handles authenticating users for the application and - * redirecting them to your home screen. The controller uses a trait - * to conveniently provide its functionality to your applications. + * Controlador responsavel pela autenticacao de usuarios. + * Gerencia login, logout e protecao contra tentativas + * excessivas de acesso (throttling). */ class LoginController extends Controller { diff --git a/app/Http/Controllers/Auth/RegisterController.php b/app/Http/Controllers/Auth/RegisterController.php index 79701fe3f7a..ac5be517eb8 100644 --- a/app/Http/Controllers/Auth/RegisterController.php +++ b/app/Http/Controllers/Auth/RegisterController.php @@ -45,9 +45,9 @@ /** * Class RegisterController * - * This controller handles the registration of new users as well as their - * validation and creation. By default this controller uses a trait to - * provide this functionality without requiring any additional code. + * Controlador responsavel pelo registro de novos usuarios. + * Gerencia a validacao e criacao de contas de usuario, + * incluindo suporte a codigos de convite e modo de usuario unico. */ class RegisterController extends Controller { diff --git a/app/Http/Controllers/Auth/ResetPasswordController.php b/app/Http/Controllers/Auth/ResetPasswordController.php index 442d4956b4b..ae75128067b 100644 --- a/app/Http/Controllers/Auth/ResetPasswordController.php +++ b/app/Http/Controllers/Auth/ResetPasswordController.php @@ -38,9 +38,9 @@ /** * Class ResetPasswordController * - * This controller is responsible for handling password reset requests - * and uses a simple trait to include this behavior. You're free to - * explore this trait and override any methods you wish to tweak. + * Controlador responsavel pela redefinicao de senha. + * Processa tokens de redefinicao e permite que usuarios + * criem novas senhas apos validacao. */ class ResetPasswordController extends Controller { diff --git a/app/Http/Controllers/Auth/TwoFactorController.php b/app/Http/Controllers/Auth/TwoFactorController.php index 1ebce315527..da312802cad 100644 --- a/app/Http/Controllers/Auth/TwoFactorController.php +++ b/app/Http/Controllers/Auth/TwoFactorController.php @@ -39,7 +39,11 @@ use PragmaRX\Google2FALaravel\Support\Authenticator; /** - * Class TwoFactorController. + * Class TwoFactorController + * + * Controlador responsavel pela autenticacao de dois fatores (2FA). + * Gerencia validacao de codigos MFA, codigos de backup e + * historico de tentativas de autenticacao. */ class TwoFactorController extends Controller { diff --git a/app/Http/Controllers/Bill/CreateController.php b/app/Http/Controllers/Bill/CreateController.php index 401ead7c6d1..86e3bc3b865 100644 --- a/app/Http/Controllers/Bill/CreateController.php +++ b/app/Http/Controllers/Bill/CreateController.php @@ -37,6 +37,10 @@ /** * Class CreateController + * + * Controlador responsavel pela criacao de novas faturas recorrentes. + * Permite criar faturas com periodos de repeticao, valores minimos e maximos, + * e suporte a anexos. */ class CreateController extends Controller { diff --git a/app/Http/Controllers/Bill/DeleteController.php b/app/Http/Controllers/Bill/DeleteController.php index 6dccb056a6f..9e1514ade65 100644 --- a/app/Http/Controllers/Bill/DeleteController.php +++ b/app/Http/Controllers/Bill/DeleteController.php @@ -35,6 +35,9 @@ /** * Class DeleteController + * + * Controlador responsavel pela exclusao de faturas recorrentes. + * Permite excluir faturas e suas associacoes com transacoes. */ class DeleteController extends Controller { diff --git a/app/Http/Controllers/Bill/EditController.php b/app/Http/Controllers/Bill/EditController.php index de520dfc7f6..02394e0efb6 100644 --- a/app/Http/Controllers/Bill/EditController.php +++ b/app/Http/Controllers/Bill/EditController.php @@ -37,6 +37,9 @@ /** * Class EditController + * + * Controlador responsavel pela edicao de faturas recorrentes existentes. + * Permite modificar valores, periodos, datas e outras propriedades da fatura. */ class EditController extends Controller { diff --git a/app/Http/Controllers/Bill/IndexController.php b/app/Http/Controllers/Bill/IndexController.php index 46f8514f140..be46899489c 100644 --- a/app/Http/Controllers/Bill/IndexController.php +++ b/app/Http/Controllers/Bill/IndexController.php @@ -41,6 +41,10 @@ /** * Class IndexController + * + * Controlador responsavel pela listagem de faturas recorrentes. + * Exibe todas as faturas com informacoes de pagamento, valores esperados + * e organizacao por grupos de objetos. */ class IndexController extends Controller { @@ -149,6 +153,12 @@ public function index(): Application|Factory|\Illuminate\Contracts\Foundation\Ap } /** + * Calcula os totais por moeda e grupo de faturas. + * + * @param array $bills Array de faturas agrupadas + * + * @return array Totais calculados por grupo e moeda + * * @throws FireflyException */ private function getSums(array $bills): array @@ -202,6 +212,14 @@ private function getSums(array $bills): array return $sums; } + /** + * Calcula o valor medio da fatura por periodo. + * + * @param array $bill Dados da fatura + * @param string $range Periodo de visualizacao (1M, 1Y, etc.) + * + * @return string Valor medio por periodo + */ private function amountPerPeriod(array $bill, string $range): string { $avg = bcdiv(bcadd((string)$bill['amount_min'], (string)$bill['amount_max']), '2'); @@ -243,6 +261,13 @@ private function amountPerPeriod(array $bill, string $range): string return $perPeriod; } + /** + * Calcula os totais gerais de todas as faturas. + * + * @param array $sums Totais por grupo + * + * @return array Totais consolidados por moeda + */ private function getTotals(array $sums): array { $totals = []; diff --git a/app/Http/Controllers/Bill/ShowController.php b/app/Http/Controllers/Bill/ShowController.php index acfb3ab3aa0..bc82fcfdd25 100644 --- a/app/Http/Controllers/Bill/ShowController.php +++ b/app/Http/Controllers/Bill/ShowController.php @@ -48,6 +48,10 @@ /** * Class ShowController + * + * Controlador responsavel pela exibicao detalhada de faturas recorrentes. + * Mostra transacoes associadas, medias de pagamento e permite reescanear + * transacoes para vincular a fatura. */ class ShowController extends Controller { diff --git a/app/Http/Controllers/Budget/BudgetLimitController.php b/app/Http/Controllers/Budget/BudgetLimitController.php index 367bbba1ad8..3934f85a541 100644 --- a/app/Http/Controllers/Budget/BudgetLimitController.php +++ b/app/Http/Controllers/Budget/BudgetLimitController.php @@ -45,6 +45,10 @@ /** * Class BudgetLimitController + * + * Controlador responsavel pelo gerenciamento de limites de orcamento. + * Permite criar, editar e excluir limites de orcamento por periodo + * e moeda, com calculo de gastos e saldo restante. */ class BudgetLimitController extends Controller { diff --git a/app/Http/Controllers/Budget/CreateController.php b/app/Http/Controllers/Budget/CreateController.php index 45f05ad8970..eda84b5b7e0 100644 --- a/app/Http/Controllers/Budget/CreateController.php +++ b/app/Http/Controllers/Budget/CreateController.php @@ -38,6 +38,10 @@ /** * Class CreateController + * + * Controlador responsavel pela criacao de novos orcamentos. + * Permite criar orcamentos com configuracoes de auto-orcamento, + * periodos de repeticao e suporte a anexos. */ class CreateController extends Controller { diff --git a/app/Http/Controllers/Budget/DeleteController.php b/app/Http/Controllers/Budget/DeleteController.php index a938a06df4a..0f4129a1b21 100644 --- a/app/Http/Controllers/Budget/DeleteController.php +++ b/app/Http/Controllers/Budget/DeleteController.php @@ -35,6 +35,9 @@ /** * Class DeleteController + * + * Controlador responsavel pela exclusao de orcamentos. + * Permite excluir orcamentos e suas associacoes com transacoes. */ class DeleteController extends Controller { diff --git a/app/Http/Controllers/Budget/EditController.php b/app/Http/Controllers/Budget/EditController.php index a3969e6d7d7..1546cf581c4 100644 --- a/app/Http/Controllers/Budget/EditController.php +++ b/app/Http/Controllers/Budget/EditController.php @@ -39,6 +39,10 @@ /** * Class EditController + * + * Controlador responsavel pela edicao de orcamentos existentes. + * Permite modificar valores, configuracoes de auto-orcamento + * e outras propriedades do orcamento. */ class EditController extends Controller { diff --git a/app/Http/Controllers/Budget/IndexController.php b/app/Http/Controllers/Budget/IndexController.php index a370bbd00f2..1099173ab72 100644 --- a/app/Http/Controllers/Budget/IndexController.php +++ b/app/Http/Controllers/Budget/IndexController.php @@ -47,6 +47,10 @@ /** * Class IndexController + * + * Controlador responsavel pela listagem de orcamentos. + * Exibe todos os orcamentos com informacoes de gastos, limites + * e disponibilidade por periodo. */ class IndexController extends Controller { @@ -161,6 +165,14 @@ public function index(?Carbon $start = null, ?Carbon $end = null) ); } + /** + * Obtem todos os orcamentos disponiveis para o periodo. + * + * @param Carbon $start Data inicial do periodo + * @param Carbon $end Data final do periodo + * + * @return array Lista de orcamentos disponiveis com gastos e valores orcados + */ private function getAllAvailableBudgets(Carbon $start, Carbon $end): array { Log::debug(sprintf('Start of getAllAvailableBudgets("%s", "%s")', $start->format('Y-m-d H:i:s'), $end->format('Y-m-d H:i:s'))); @@ -194,6 +206,16 @@ private function getAllAvailableBudgets(Carbon $start, Carbon $end): array return $availableBudgets; } + /** + * Obtem todos os orcamentos ativos com limites e gastos. + * + * @param Carbon $start Data inicial do periodo + * @param Carbon $end Data final do periodo + * @param Collection $currencies Colecao de moedas disponiveis + * @param TransactionCurrency $primaryCurrency Moeda primaria do usuario + * + * @return array Lista de orcamentos com informacoes completas + */ private function getAllBudgets(Carbon $start, Carbon $end, Collection $currencies, TransactionCurrency $primaryCurrency): array { // get all budgets, and paginate them into $budgets. @@ -252,6 +274,13 @@ private function getAllBudgets(Carbon $start, Carbon $end, Collection $currencie return $budgets; } + /** + * Calcula os totais de orcamentos, gastos e saldo restante. + * + * @param array $budgets Lista de orcamentos + * + * @return array Totais por moeda (orcado, gasto, restante) + */ private function getSums(array $budgets): array { $sums = [ diff --git a/app/Http/Controllers/Budget/ShowController.php b/app/Http/Controllers/Budget/ShowController.php index 36815436a44..9273ca41f7a 100644 --- a/app/Http/Controllers/Budget/ShowController.php +++ b/app/Http/Controllers/Budget/ShowController.php @@ -42,6 +42,10 @@ /** * Class ShowController + * + * Controlador responsavel pela exibicao detalhada de orcamentos. + * Mostra transacoes associadas, limites de orcamento e permite + * visualizar transacoes sem orcamento definido. */ class ShowController extends Controller { diff --git a/app/Http/Controllers/Category/CreateController.php b/app/Http/Controllers/Category/CreateController.php index c9a0e58d1d1..8b64cd131d5 100644 --- a/app/Http/Controllers/Category/CreateController.php +++ b/app/Http/Controllers/Category/CreateController.php @@ -38,6 +38,9 @@ /** * Class CreateController + * + * Controlador responsavel pela criacao de novas categorias. + * Permite criar categorias para organizar transacoes com suporte a anexos. */ class CreateController extends Controller { diff --git a/app/Http/Controllers/Category/DeleteController.php b/app/Http/Controllers/Category/DeleteController.php index b4968f45eeb..33d7cd82cce 100644 --- a/app/Http/Controllers/Category/DeleteController.php +++ b/app/Http/Controllers/Category/DeleteController.php @@ -35,6 +35,9 @@ /** * Class DeleteController + * + * Controlador responsavel pela exclusao de categorias. + * Permite excluir categorias e suas associacoes com transacoes. */ class DeleteController extends Controller { diff --git a/app/Http/Controllers/Category/EditController.php b/app/Http/Controllers/Category/EditController.php index cdfa19a3fc4..2c54b1d5a17 100644 --- a/app/Http/Controllers/Category/EditController.php +++ b/app/Http/Controllers/Category/EditController.php @@ -38,6 +38,9 @@ /** * Class EditController + * + * Controlador responsavel pela edicao de categorias existentes. + * Permite modificar nome, notas e anexos da categoria. */ class EditController extends Controller { diff --git a/app/Http/Controllers/Category/IndexController.php b/app/Http/Controllers/Category/IndexController.php index 41b85c87a7a..302183e0e79 100644 --- a/app/Http/Controllers/Category/IndexController.php +++ b/app/Http/Controllers/Category/IndexController.php @@ -35,6 +35,9 @@ /** * Class IndexController + * + * Controlador responsavel pela listagem de categorias. + * Exibe todas as categorias com informacoes de ultima atividade. */ class IndexController extends Controller { diff --git a/app/Http/Controllers/Category/NoCategoryController.php b/app/Http/Controllers/Category/NoCategoryController.php index be784e6aa67..1bdc59e3461 100644 --- a/app/Http/Controllers/Category/NoCategoryController.php +++ b/app/Http/Controllers/Category/NoCategoryController.php @@ -39,6 +39,9 @@ /** * Class NoCategoryController + * + * Controlador responsavel pela exibicao de transacoes sem categoria. + * Permite visualizar e filtrar transacoes que nao possuem categoria definida. */ class NoCategoryController extends Controller { diff --git a/app/Http/Controllers/Category/ShowController.php b/app/Http/Controllers/Category/ShowController.php index d9a03f2f4af..44b290f6da4 100644 --- a/app/Http/Controllers/Category/ShowController.php +++ b/app/Http/Controllers/Category/ShowController.php @@ -38,6 +38,9 @@ /** * Class ShowController + * + * Controlador responsavel pela exibicao detalhada de categorias. + * Mostra transacoes associadas a categoria com filtros de periodo. */ class ShowController extends Controller { diff --git a/app/Http/Controllers/Chart/AccountController.php b/app/Http/Controllers/Chart/AccountController.php index 00f387d7c46..fe3cdc450bf 100644 --- a/app/Http/Controllers/Chart/AccountController.php +++ b/app/Http/Controllers/Chart/AccountController.php @@ -47,7 +47,11 @@ use function Safe\json_encode; /** - * Class AccountController. + * Class AccountController + * + * Controlador responsavel pela geracao de graficos relacionados a contas. + * Gera graficos de saldo, despesas por orcamento, despesas por categoria + * e receitas por categoria para contas de ativos e despesas. */ class AccountController extends Controller { diff --git a/app/Http/Controllers/Chart/BillController.php b/app/Http/Controllers/Chart/BillController.php index ceb02a444b3..18b17bd39a1 100644 --- a/app/Http/Controllers/Chart/BillController.php +++ b/app/Http/Controllers/Chart/BillController.php @@ -33,7 +33,11 @@ use Illuminate\Http\JsonResponse; /** - * Class BillController. + * Class BillController + * + * Controlador responsavel pela geracao de graficos relacionados a faturas. + * Gera graficos de faturas pagas vs nao pagas e historico de pagamentos + * de faturas individuais. */ class BillController extends Controller { diff --git a/app/Http/Controllers/Chart/BudgetController.php b/app/Http/Controllers/Chart/BudgetController.php index 49433fb8ebc..2aa7955a0a1 100644 --- a/app/Http/Controllers/Chart/BudgetController.php +++ b/app/Http/Controllers/Chart/BudgetController.php @@ -45,7 +45,11 @@ use Illuminate\Support\Facades\Log; /** - * Class BudgetController. + * Class BudgetController + * + * Controlador responsavel pela geracao de graficos relacionados a orcamentos. + * Gera graficos de gastos por orcamento, limites de orcamento, despesas + * por conta de ativos, categoria e conta de despesas. */ class BudgetController extends Controller { diff --git a/app/Http/Controllers/Chart/BudgetReportController.php b/app/Http/Controllers/Chart/BudgetReportController.php index aee1d2a9580..e19a415cb90 100644 --- a/app/Http/Controllers/Chart/BudgetReportController.php +++ b/app/Http/Controllers/Chart/BudgetReportController.php @@ -35,9 +35,11 @@ use Illuminate\Support\Collection; /** - * Separate controller because many helper functions are shared. - * * Class BudgetReportController + * + * Controlador responsavel pela geracao de graficos de relatorios de orcamento. + * Gera graficos de despesas por orcamento, categoria, conta de origem + * e conta de destino para relatorios de orcamento. */ class BudgetReportController extends Controller { diff --git a/app/Http/Controllers/Chart/CategoryController.php b/app/Http/Controllers/Chart/CategoryController.php index 8c862353252..3b59d5d3a9c 100644 --- a/app/Http/Controllers/Chart/CategoryController.php +++ b/app/Http/Controllers/Chart/CategoryController.php @@ -41,7 +41,11 @@ use Illuminate\Support\Collection; /** - * Class CategoryController. + * Class CategoryController + * + * Controlador responsavel pela geracao de graficos relacionados a categorias. + * Gera graficos de gastos e receitas por categoria, incluindo graficos + * de periodo e graficos para relatorios. */ class CategoryController extends Controller { diff --git a/app/Http/Controllers/Chart/CategoryReportController.php b/app/Http/Controllers/Chart/CategoryReportController.php index 14fc29bb7a5..0d0bdfe2b0a 100644 --- a/app/Http/Controllers/Chart/CategoryReportController.php +++ b/app/Http/Controllers/Chart/CategoryReportController.php @@ -34,9 +34,11 @@ use Illuminate\Support\Collection; /** - * Separate controller because many helper functions are shared. - * * Class CategoryReportController + * + * Controlador responsavel pela geracao de graficos de relatorios de categoria. + * Gera graficos de despesas e receitas por categoria, orcamento, conta de origem + * e conta de destino para relatorios de categoria. */ class CategoryReportController extends Controller { diff --git a/app/Http/Controllers/Chart/DoubleReportController.php b/app/Http/Controllers/Chart/DoubleReportController.php index 1e88ceaa5d4..71fe66d5b58 100644 --- a/app/Http/Controllers/Chart/DoubleReportController.php +++ b/app/Http/Controllers/Chart/DoubleReportController.php @@ -35,6 +35,10 @@ /** * Class DoubleReportController + * + * Controlador responsavel pela geracao de graficos de relatorios de contas duplas. + * Gera graficos comparativos de despesas e receitas entre contas de ativos + * e suas contrapartes (contas de despesas/receitas). */ class DoubleReportController extends Controller { diff --git a/app/Http/Controllers/Chart/ExpenseReportController.php b/app/Http/Controllers/Chart/ExpenseReportController.php index d3806d846e1..ff199ed5145 100644 --- a/app/Http/Controllers/Chart/ExpenseReportController.php +++ b/app/Http/Controllers/Chart/ExpenseReportController.php @@ -36,9 +36,11 @@ use Illuminate\Support\Collection; /** - * Separate controller because many helper functions are shared. - * * Class ExpenseReportController + * + * Controlador responsavel pela geracao de graficos de relatorios de despesas. + * Gera graficos de receitas e despesas agrupados por conta de despesa/receita + * com totais acumulados ao longo do tempo. */ class ExpenseReportController extends Controller { diff --git a/app/Http/Controllers/Chart/PiggyBankController.php b/app/Http/Controllers/Chart/PiggyBankController.php index 920c3a9301f..fb7335c5c3d 100644 --- a/app/Http/Controllers/Chart/PiggyBankController.php +++ b/app/Http/Controllers/Chart/PiggyBankController.php @@ -35,7 +35,10 @@ use Illuminate\Http\JsonResponse; /** - * Class PiggyBankController. + * Class PiggyBankController + * + * Controlador responsavel pela geracao de graficos relacionados a cofrinhos. + * Gera graficos de historico de depositos e saques do cofrinho ao longo do tempo. */ class PiggyBankController extends Controller { diff --git a/app/Http/Controllers/Chart/ReportController.php b/app/Http/Controllers/Chart/ReportController.php index 6dbb91ac9a7..ed8faa44be3 100644 --- a/app/Http/Controllers/Chart/ReportController.php +++ b/app/Http/Controllers/Chart/ReportController.php @@ -39,7 +39,11 @@ use Illuminate\Support\Facades\Log; /** - * Class ReportController. + * Class ReportController + * + * Controlador responsavel pela geracao de graficos para relatorios. + * Gera graficos de patrimonio liquido e operacoes (receitas/despesas) + * para relatorios de periodo. */ class ReportController extends Controller { diff --git a/app/Http/Controllers/Chart/TagReportController.php b/app/Http/Controllers/Chart/TagReportController.php index dbc94518346..78e8ff8f23b 100644 --- a/app/Http/Controllers/Chart/TagReportController.php +++ b/app/Http/Controllers/Chart/TagReportController.php @@ -35,6 +35,10 @@ /** * Class TagReportController + * + * Controlador responsavel pela geracao de graficos de relatorios de tags. + * Gera graficos de despesas e receitas por tag, orcamento, categoria, + * conta de origem e conta de destino. */ class TagReportController extends Controller { diff --git a/app/Http/Controllers/Chart/TransactionController.php b/app/Http/Controllers/Chart/TransactionController.php index 973af0ee549..3cf6036a246 100644 --- a/app/Http/Controllers/Chart/TransactionController.php +++ b/app/Http/Controllers/Chart/TransactionController.php @@ -34,6 +34,10 @@ /** * Class TransactionController + * + * Controlador responsavel pela geracao de graficos de transacoes. + * Gera graficos de transacoes agrupadas por orcamento, categoria, + * conta de origem e conta de destino. */ class TransactionController extends Controller { diff --git a/app/Http/Controllers/Controller.php b/app/Http/Controllers/Controller.php index dc282fbc074..c0588de7bad 100644 --- a/app/Http/Controllers/Controller.php +++ b/app/Http/Controllers/Controller.php @@ -42,7 +42,19 @@ use function Safe\ini_get; /** - * Class Controller. + * Class Controller + * + * Classe base abstrata para todos os controladores do Firefly III. + * Fornece funcionalidades comuns como autenticacao, validacao, + * configuracao de moeda primaria e compartilhamento de variaveis de view. + * + * @property string $name Nome do controlador + * @property bool $convertToPrimary Se deve converter valores para moeda primaria + * @property string $dateTimeFormat Formato de data e hora + * @property TransactionCurrency|null $primaryCurrency Moeda primaria do usuario + * @property string $monthAndDayFormat Formato de mes e dia + * @property string $monthFormat Formato de mes + * @property string $redirectUrl URL de redirecionamento padrao * * @SuppressWarnings("PHPMD.CouplingBetweenObjects") * @SuppressWarnings("PHPMD.NumberOfChildren") diff --git a/app/Http/Controllers/DebugController.php b/app/Http/Controllers/DebugController.php index 3970980c15e..308ae222bd2 100644 --- a/app/Http/Controllers/DebugController.php +++ b/app/Http/Controllers/DebugController.php @@ -58,6 +58,10 @@ /** * Class DebugController + * + * Controlador responsavel por funcionalidades de depuracao e diagnostico. + * Fornece informacoes sobre o sistema, limpa caches, exibe logs e + * permite testar erros para verificar o tratamento de excecoes. */ class DebugController extends Controller { @@ -162,9 +166,13 @@ public function apiTest() return view('test.api-test'); } + /** + * Gera a tabela HTML com informacoes de depuracao. + * + * @return string HTML da tabela de depuracao + */ private function generateTable(): string { - // system information: $system = $this->getSystemInformation(); $docker = $this->getBuildInfo(); $app = $this->getAppInfo(); @@ -173,6 +181,11 @@ private function generateTable(): string return (string) view('partials.debug-table', compact('system', 'docker', 'app', 'user')); } + /** + * Obtem informacoes do sistema como versao do PHP, banco de dados, etc. + * + * @return array Array com informacoes do sistema + */ private function getSystemInformation(): array { $maxFileSize = Steam::phpBytes((string) ini_get('upload_max_filesize')); @@ -196,6 +209,11 @@ private function getSystemInformation(): array ]; } + /** + * Obtem informacoes de build do Docker, se disponivel. + * + * @return array Array com informacoes de build + */ private function getBuildInfo(): array { $return = [ @@ -234,6 +252,11 @@ private function getBuildInfo(): array return $return; } + /** + * Obtem informacoes da aplicacao como modo debug, idioma padrao, etc. + * + * @return array Array com informacoes da aplicacao + */ private function getAppInfo(): array { $userGuard = config('auth.defaults.guard'); @@ -266,6 +289,11 @@ private function getAppInfo(): array ]; } + /** + * Obtem informacoes do usuario atual como idioma, locale, moeda primaria, etc. + * + * @return array Array com informacoes do usuario + */ private function getUserInfo(): array { $userFlags = $this->getUserFlags(); @@ -299,6 +327,11 @@ private function getUserInfo(): array ]; } + /** + * Gera flags visuais indicando recursos utilizados pelo usuario. + * + * @return string String com emojis representando recursos utilizados + */ private function getUserFlags(): string { $flags = []; @@ -350,6 +383,15 @@ private function getUserFlags(): string return implode(' ', $flags); } + /** + * Exibe todas as rotas disponiveis na aplicacao (apenas para proprietarios). + * + * @param Request $request Requisicao HTTP + * + * @return never Este metodo sempre termina com exit + * + * @throws NotFoundHttpException Se o usuario nao for proprietario + */ public function routes(Request $request): never { if (!auth()->user()->hasRole('owner')) { diff --git a/app/Http/Controllers/ExchangeRates/IndexController.php b/app/Http/Controllers/ExchangeRates/IndexController.php index 258052606bb..e54b2244e3f 100644 --- a/app/Http/Controllers/ExchangeRates/IndexController.php +++ b/app/Http/Controllers/ExchangeRates/IndexController.php @@ -29,6 +29,13 @@ use Illuminate\View\View; use Symfony\Component\HttpKernel\Exception\NotFoundHttpException; +/** + * Class IndexController + * + * Controlador responsavel pela exibicao de taxas de cambio. + * Mostra taxas de conversao entre moedas configuradas + * no sistema de taxas de cambio. + */ class IndexController extends Controller { /** diff --git a/app/Http/Controllers/Export/IndexController.php b/app/Http/Controllers/Export/IndexController.php index 3167f655257..0c7306fbf4d 100644 --- a/app/Http/Controllers/Export/IndexController.php +++ b/app/Http/Controllers/Export/IndexController.php @@ -39,6 +39,10 @@ /** * Class IndexController + * + * Controlador responsavel pela exportacao de dados. + * Permite exportar transacoes do usuario em formato CSV + * para backup ou analise externa. */ class IndexController extends Controller { diff --git a/app/Http/Controllers/HomeController.php b/app/Http/Controllers/HomeController.php index b8297243083..d2b0067622e 100644 --- a/app/Http/Controllers/HomeController.php +++ b/app/Http/Controllers/HomeController.php @@ -40,7 +40,11 @@ use Illuminate\Support\Facades\Log; /** - * Class HomeController. + * Class HomeController + * + * Controlador responsavel pela pagina inicial (dashboard) do Firefly III. + * Exibe o resumo financeiro do usuario, incluindo contas, transacoes + * recentes e informacoes sobre faturas. */ class HomeController extends Controller { @@ -139,6 +143,13 @@ public function index(AccountRepositoryInterface $repository): mixed throw new FireflyException('Invalid layout configuration'); } + /** + * Renderiza a pagina inicial usando o layout V1. + * + * @param AccountRepositoryInterface $repository Repositorio de contas + * + * @return mixed View da pagina inicial V1 + */ private function indexV1(AccountRepositoryInterface $repository): mixed { $types = config('firefly.accountTypesByIdentifier.asset'); @@ -182,6 +193,11 @@ private function indexV1(AccountRepositoryInterface $repository): mixed return view('index', compact('count', 'subTitle', 'transactions', 'billCount', 'start', 'end', 'today', 'pageTitle')); } + /** + * Renderiza a pagina inicial usando o layout V2. + * + * @return mixed View da pagina inicial V2 + */ private function indexV2(): mixed { $subTitle = (string) trans('firefly.welcome_back'); diff --git a/app/Http/Controllers/JavascriptController.php b/app/Http/Controllers/JavascriptController.php index bccff306d98..c2619fd3283 100644 --- a/app/Http/Controllers/JavascriptController.php +++ b/app/Http/Controllers/JavascriptController.php @@ -35,7 +35,11 @@ use Illuminate\Http\Response; /** - * Class JavascriptController. + * Class JavascriptController + * + * Controlador responsavel por gerar arquivos JavaScript dinamicos. + * Fornece dados de contas, moedas e variaveis de configuracao + * para uso no frontend da aplicacao. */ class JavascriptController extends Controller { @@ -125,7 +129,10 @@ public function variables(Request $request, AccountRepositoryInterface $reposito } /** - * Bit of a hack but OK. + * Gera variaveis JavaScript para o layout V2. + * Inclui datas de inicio e fim do periodo atual. + * + * @return Response Resposta com JavaScript contendo as variaveis */ public function variablesV2(): Response { diff --git a/app/Http/Controllers/Json/AutoCompleteController.php b/app/Http/Controllers/Json/AutoCompleteController.php index b749d626ad5..49c80090d56 100644 --- a/app/Http/Controllers/Json/AutoCompleteController.php +++ b/app/Http/Controllers/Json/AutoCompleteController.php @@ -26,6 +26,10 @@ use FireflyIII\Http\Controllers\Controller; /** - * Class AutoCompleteController. + * Class AutoCompleteController + * + * Controlador responsavel pelo autocomplete de campos. + * Fornece sugestoes de preenchimento automatico para + * contas, categorias, tags e outros campos do sistema. */ class AutoCompleteController extends Controller {} diff --git a/app/Http/Controllers/Json/BoxController.php b/app/Http/Controllers/Json/BoxController.php index ff3f5e8c83d..da510af2718 100644 --- a/app/Http/Controllers/Json/BoxController.php +++ b/app/Http/Controllers/Json/BoxController.php @@ -39,7 +39,11 @@ use Illuminate\Http\JsonResponse; /** - * Class BoxController. + * Class BoxController + * + * Controlador responsavel pelos widgets da pagina inicial. + * Fornece dados JSON para os boxes de saldo, receitas, + * despesas e patrimonio liquido. */ class BoxController extends Controller { diff --git a/app/Http/Controllers/Json/BudgetController.php b/app/Http/Controllers/Json/BudgetController.php index 23a687ed469..dd0fd3fdc05 100644 --- a/app/Http/Controllers/Json/BudgetController.php +++ b/app/Http/Controllers/Json/BudgetController.php @@ -36,6 +36,10 @@ /** * Class BudgetController + * + * Controlador responsavel por dados JSON de orcamentos. + * Fornece informacoes sobre valores orcados, disponiveis + * e percentuais de uso por moeda e periodo. */ class BudgetController extends Controller { diff --git a/app/Http/Controllers/Json/FrontpageController.php b/app/Http/Controllers/Json/FrontpageController.php index f66864866b4..c7d41cada46 100644 --- a/app/Http/Controllers/Json/FrontpageController.php +++ b/app/Http/Controllers/Json/FrontpageController.php @@ -31,7 +31,11 @@ use Illuminate\Http\JsonResponse; /** - * Class FrontpageController. + * Class FrontpageController + * + * Controlador responsavel por dados da pagina inicial. + * Fornece HTML renderizado para widgets como cofrinhos + * e outros elementos dinamicos do dashboard. */ class FrontpageController extends Controller { diff --git a/app/Http/Controllers/Json/IntroController.php b/app/Http/Controllers/Json/IntroController.php index f3bd44b6608..8de6bc44941 100644 --- a/app/Http/Controllers/Json/IntroController.php +++ b/app/Http/Controllers/Json/IntroController.php @@ -29,7 +29,11 @@ use Illuminate\Http\JsonResponse; /** - * Class IntroController. + * Class IntroController + * + * Controlador responsavel pelo assistente de introducao. + * Gerencia os passos do tutorial interativo que guia + * novos usuarios pelas funcionalidades do sistema. */ class IntroController extends Controller { diff --git a/app/Http/Controllers/Json/ReconcileController.php b/app/Http/Controllers/Json/ReconcileController.php index 44a4d0cdf97..8ea3ebab07c 100644 --- a/app/Http/Controllers/Json/ReconcileController.php +++ b/app/Http/Controllers/Json/ReconcileController.php @@ -41,6 +41,10 @@ /** * Class ReconcileController + * + * Controlador responsavel pela reconciliacao de contas. + * Fornece dados JSON para o processo de reconciliacao, + * incluindo saldos, transacoes e calculos de diferenca. */ class ReconcileController extends Controller { diff --git a/app/Http/Controllers/Json/RecurrenceController.php b/app/Http/Controllers/Json/RecurrenceController.php index 6c07685f340..9704da489ea 100644 --- a/app/Http/Controllers/Json/RecurrenceController.php +++ b/app/Http/Controllers/Json/RecurrenceController.php @@ -35,6 +35,10 @@ /** * Class RecurrenceController + * + * Controlador responsavel por dados JSON de recorrencias. + * Fornece eventos de calendario e sugestoes de repeticao + * para transacoes recorrentes. */ class RecurrenceController extends Controller { diff --git a/app/Http/Controllers/Json/RuleController.php b/app/Http/Controllers/Json/RuleController.php index a555015150e..4d4f2ed8409 100644 --- a/app/Http/Controllers/Json/RuleController.php +++ b/app/Http/Controllers/Json/RuleController.php @@ -32,6 +32,10 @@ /** * Class RuleController + * + * Controlador responsavel por dados JSON de regras. + * Fornece HTML renderizado para formularios de gatilhos + * e acoes de regras de automacao. */ class RuleController extends Controller { diff --git a/app/Http/Controllers/NewUserController.php b/app/Http/Controllers/NewUserController.php index 271c70e692e..03d1e7fe499 100644 --- a/app/Http/Controllers/NewUserController.php +++ b/app/Http/Controllers/NewUserController.php @@ -36,7 +36,11 @@ use Illuminate\View\View; /** - * Class NewUserController. + * Class NewUserController + * + * Controlador responsavel pela configuracao inicial de novos usuarios. + * Exibe o formulario de boas-vindas e cria as contas iniciais + * (conta corrente, poupanca e carteira) para o usuario. */ class NewUserController extends Controller { diff --git a/app/Http/Controllers/ObjectGroup/DeleteController.php b/app/Http/Controllers/ObjectGroup/DeleteController.php index 4a6c97181c6..82815580df8 100644 --- a/app/Http/Controllers/ObjectGroup/DeleteController.php +++ b/app/Http/Controllers/ObjectGroup/DeleteController.php @@ -33,6 +33,10 @@ /** * Class DeleteController + * + * Controlador responsavel pela exclusao de grupos de objetos. + * Permite excluir grupos sem afetar os elementos + * que estavam associados a eles. */ class DeleteController extends Controller { diff --git a/app/Http/Controllers/ObjectGroup/EditController.php b/app/Http/Controllers/ObjectGroup/EditController.php index 62be1e1edb1..c8c4da00149 100644 --- a/app/Http/Controllers/ObjectGroup/EditController.php +++ b/app/Http/Controllers/ObjectGroup/EditController.php @@ -36,6 +36,10 @@ /** * Class EditController + * + * Controlador responsavel pela edicao de grupos de objetos. + * Permite modificar titulo e configuracoes de grupos + * que organizam elementos do sistema. */ class EditController extends Controller { diff --git a/app/Http/Controllers/ObjectGroup/IndexController.php b/app/Http/Controllers/ObjectGroup/IndexController.php index 6cddb20792f..22097da5fa2 100644 --- a/app/Http/Controllers/ObjectGroup/IndexController.php +++ b/app/Http/Controllers/ObjectGroup/IndexController.php @@ -34,6 +34,10 @@ /** * Class IndexController + * + * Controlador responsavel pela listagem de grupos de objetos. + * Exibe e gerencia grupos que organizam cofrinhos e + * outros elementos do sistema. */ class IndexController extends Controller { diff --git a/app/Http/Controllers/PiggyBank/AmountController.php b/app/Http/Controllers/PiggyBank/AmountController.php index 4cdec6201f6..480da18729f 100644 --- a/app/Http/Controllers/PiggyBank/AmountController.php +++ b/app/Http/Controllers/PiggyBank/AmountController.php @@ -37,6 +37,10 @@ /** * Class AmountController + * + * Controlador responsavel pelo gerenciamento de valores em cofrinhos. + * Permite adicionar e remover dinheiro de cofrinhos, com suporte + * a multiplas contas e validacao de limites. */ class AmountController extends Controller { diff --git a/app/Http/Controllers/PiggyBank/CreateController.php b/app/Http/Controllers/PiggyBank/CreateController.php index 0edd81cbccf..dbe32a007b9 100644 --- a/app/Http/Controllers/PiggyBank/CreateController.php +++ b/app/Http/Controllers/PiggyBank/CreateController.php @@ -38,6 +38,10 @@ /** * Class CreateController + * + * Controlador responsavel pela criacao de novos cofrinhos. + * Permite criar cofrinhos com metas de economia, datas alvo + * e suporte a anexos. */ class CreateController extends Controller { diff --git a/app/Http/Controllers/PiggyBank/DeleteController.php b/app/Http/Controllers/PiggyBank/DeleteController.php index 2ac0855b852..3c6d9c6a79b 100644 --- a/app/Http/Controllers/PiggyBank/DeleteController.php +++ b/app/Http/Controllers/PiggyBank/DeleteController.php @@ -33,6 +33,9 @@ /** * Class DeleteController + * + * Controlador responsavel pela exclusao de cofrinhos. + * Permite excluir cofrinhos e seus eventos associados. */ class DeleteController extends Controller { diff --git a/app/Http/Controllers/PiggyBank/EditController.php b/app/Http/Controllers/PiggyBank/EditController.php index 200d5acc6d3..ed62e4413eb 100644 --- a/app/Http/Controllers/PiggyBank/EditController.php +++ b/app/Http/Controllers/PiggyBank/EditController.php @@ -37,6 +37,10 @@ /** * Class EditController + * + * Controlador responsavel pela edicao de cofrinhos existentes. + * Permite modificar metas, datas, contas associadas e resetar + * o historico de eventos. */ class EditController extends Controller { diff --git a/app/Http/Controllers/PiggyBank/IndexController.php b/app/Http/Controllers/PiggyBank/IndexController.php index 64cab7c4ed0..e1cd6098a31 100644 --- a/app/Http/Controllers/PiggyBank/IndexController.php +++ b/app/Http/Controllers/PiggyBank/IndexController.php @@ -45,6 +45,10 @@ /** * Class IndexController + * + * Controlador responsavel pela listagem de cofrinhos. + * Exibe todos os cofrinhos agrupados por grupo de objetos, + * com informacoes de progresso e saldos por conta. */ class IndexController extends Controller { diff --git a/app/Http/Controllers/PiggyBank/ShowController.php b/app/Http/Controllers/PiggyBank/ShowController.php index 3783708c2e2..67823aee5c2 100644 --- a/app/Http/Controllers/PiggyBank/ShowController.php +++ b/app/Http/Controllers/PiggyBank/ShowController.php @@ -38,6 +38,9 @@ /** * Class ShowController + * + * Controlador responsavel pela exibicao detalhada de cofrinhos. + * Mostra eventos de deposito/saque, progresso da meta e anexos. */ class ShowController extends Controller { diff --git a/app/Http/Controllers/Popup/ReportController.php b/app/Http/Controllers/Popup/ReportController.php index 1d4ae33507d..eb5e2b281f2 100644 --- a/app/Http/Controllers/Popup/ReportController.php +++ b/app/Http/Controllers/Popup/ReportController.php @@ -30,7 +30,11 @@ use Illuminate\Http\Request; /** - * Class ReportController. + * Class ReportController + * + * Controlador responsavel por popups de relatorios. + * Gera conteudo HTML para janelas popup que exibem + * detalhes de orcamentos, despesas, receitas e categorias. */ class ReportController extends Controller { diff --git a/app/Http/Controllers/Preferences/NotificationsController.php b/app/Http/Controllers/Preferences/NotificationsController.php index 3d416ec1364..d0b3f25b989 100644 --- a/app/Http/Controllers/Preferences/NotificationsController.php +++ b/app/Http/Controllers/Preferences/NotificationsController.php @@ -26,4 +26,11 @@ use FireflyIII\Http\Controllers\Controller; +/** + * Class NotificationsController + * + * Controlador responsavel pelas preferencias de notificacoes. + * Gerencia configuracoes de alertas e avisos do sistema + * para o usuario. + */ class NotificationsController extends Controller {} diff --git a/app/Http/Controllers/Profile/MfaController.php b/app/Http/Controllers/Profile/MfaController.php index 333801c3808..d6cfe6e9a97 100644 --- a/app/Http/Controllers/Profile/MfaController.php +++ b/app/Http/Controllers/Profile/MfaController.php @@ -48,13 +48,9 @@ /** * Class MfaController * - * Enable MFA Flow: - * - * Page 1 (GET): Show QR code and the manual code. Secret keeps rotating. - * POST: store secret, store response, validate password. - * --- - * Page 3 (GET): Confirm 2FA status and show recovery codes. - * Same page as page 1, but when secret is present. + * Controlador responsavel pela configuracao de MFA no perfil. + * Permite habilitar, desabilitar e gerenciar autenticacao + * de dois fatores, incluindo codigos de backup. */ class MfaController extends Controller { diff --git a/app/Http/Controllers/Recurring/CreateController.php b/app/Http/Controllers/Recurring/CreateController.php index f2b5bd599c9..fdad5f3b4cb 100644 --- a/app/Http/Controllers/Recurring/CreateController.php +++ b/app/Http/Controllers/Recurring/CreateController.php @@ -43,6 +43,10 @@ /** * Class CreateController + * + * Controlador responsavel pela criacao de transacoes recorrentes. + * Permite criar transacoes que se repetem automaticamente em intervalos + * definidos, com suporte a diferentes tipos de repeticao e anexos. */ class CreateController extends Controller { diff --git a/app/Http/Controllers/Recurring/DeleteController.php b/app/Http/Controllers/Recurring/DeleteController.php index 4cdc4c971fd..aff6ef158e6 100644 --- a/app/Http/Controllers/Recurring/DeleteController.php +++ b/app/Http/Controllers/Recurring/DeleteController.php @@ -35,6 +35,9 @@ /** * Class DeleteController + * + * Controlador responsavel pela exclusao de transacoes recorrentes. + * Permite excluir transacoes recorrentes e suas transacoes geradas. */ class DeleteController extends Controller { diff --git a/app/Http/Controllers/Recurring/EditController.php b/app/Http/Controllers/Recurring/EditController.php index 59772aa1b42..2c0b572b51b 100644 --- a/app/Http/Controllers/Recurring/EditController.php +++ b/app/Http/Controllers/Recurring/EditController.php @@ -48,6 +48,10 @@ /** * Class EditController + * + * Controlador responsavel pela edicao de transacoes recorrentes. + * Permite modificar configuracoes de repeticao, valores, contas + * e outras propriedades da transacao recorrente. */ class EditController extends Controller { diff --git a/app/Http/Controllers/Recurring/IndexController.php b/app/Http/Controllers/Recurring/IndexController.php index 773c36f9168..97e1112a99e 100644 --- a/app/Http/Controllers/Recurring/IndexController.php +++ b/app/Http/Controllers/Recurring/IndexController.php @@ -40,6 +40,10 @@ /** * Class IndexController + * + * Controlador responsavel pela listagem de transacoes recorrentes. + * Exibe todas as transacoes recorrentes com informacoes de proximas + * ocorrencias e status de execucao. */ class IndexController extends Controller { diff --git a/app/Http/Controllers/Recurring/ShowController.php b/app/Http/Controllers/Recurring/ShowController.php index d44456fd116..655ef792dc5 100644 --- a/app/Http/Controllers/Recurring/ShowController.php +++ b/app/Http/Controllers/Recurring/ShowController.php @@ -42,6 +42,9 @@ /** * Class ShowController + * + * Controlador responsavel pela exibicao detalhada de transacoes recorrentes. + * Mostra ocorrencias passadas e futuras, transacoes geradas e anexos. */ class ShowController extends Controller { diff --git a/app/Http/Controllers/Recurring/TriggerController.php b/app/Http/Controllers/Recurring/TriggerController.php index 818f3530373..04cd0dfebf1 100644 --- a/app/Http/Controllers/Recurring/TriggerController.php +++ b/app/Http/Controllers/Recurring/TriggerController.php @@ -35,6 +35,9 @@ /** * Class TriggerController + * + * Controlador responsavel pelo disparo manual de transacoes recorrentes. + * Permite executar uma transacao recorrente manualmente em uma data especifica. */ class TriggerController extends Controller { diff --git a/app/Http/Controllers/Report/AccountController.php b/app/Http/Controllers/Report/AccountController.php index dcd9464ce39..f87d9701064 100644 --- a/app/Http/Controllers/Report/AccountController.php +++ b/app/Http/Controllers/Report/AccountController.php @@ -32,7 +32,11 @@ use Illuminate\Support\Collection; /** - * Class AccountController. + * Class AccountController + * + * Controlador responsavel pela geracao de relatorios de contas. + * Gera visoes parciais com saldos e movimentacoes de contas + * para o sistema de relatorios. */ class AccountController extends Controller { diff --git a/app/Http/Controllers/Report/BalanceController.php b/app/Http/Controllers/Report/BalanceController.php index 41b3010a4a7..bc2d406b74f 100644 --- a/app/Http/Controllers/Report/BalanceController.php +++ b/app/Http/Controllers/Report/BalanceController.php @@ -35,7 +35,11 @@ use Illuminate\Support\Collection; /** - * Class BalanceController. + * Class BalanceController + * + * Controlador responsavel pela geracao de relatorios de balanco. + * Gera visoes parciais com gastos por orcamento e conta, + * mostrando a distribuicao de despesas. */ class BalanceController extends Controller { diff --git a/app/Http/Controllers/Report/BillController.php b/app/Http/Controllers/Report/BillController.php index 1fd70e3c488..a8d7356dea9 100644 --- a/app/Http/Controllers/Report/BillController.php +++ b/app/Http/Controllers/Report/BillController.php @@ -34,6 +34,10 @@ /** * Class BillController + * + * Controlador responsavel pela geracao de relatorios de faturas. + * Gera visoes parciais com status de pagamento de faturas + * recorrentes no periodo selecionado. */ class BillController extends Controller { diff --git a/app/Http/Controllers/Report/BudgetController.php b/app/Http/Controllers/Report/BudgetController.php index 2b26e165011..e629b1212b8 100644 --- a/app/Http/Controllers/Report/BudgetController.php +++ b/app/Http/Controllers/Report/BudgetController.php @@ -39,7 +39,11 @@ use Illuminate\View\View; /** - * Class BudgetController. + * Class BudgetController + * + * Controlador responsavel pela geracao de relatorios de orcamentos. + * Gera visoes parciais com gastos por orcamento, conta e periodo, + * incluindo medias e maiores despesas. */ class BudgetController extends Controller { diff --git a/app/Http/Controllers/Report/CategoryController.php b/app/Http/Controllers/Report/CategoryController.php index fc8d17421a5..576a06737df 100644 --- a/app/Http/Controllers/Report/CategoryController.php +++ b/app/Http/Controllers/Report/CategoryController.php @@ -39,7 +39,11 @@ use Illuminate\View\View; /** - * Class CategoryController. + * Class CategoryController + * + * Controlador responsavel pela geracao de relatorios de categorias. + * Gera visoes parciais com receitas e despesas por categoria, + * incluindo medias, maiores transacoes e distribuicao por periodo. */ class CategoryController extends Controller { diff --git a/app/Http/Controllers/Report/DoubleController.php b/app/Http/Controllers/Report/DoubleController.php index 32a1736844e..913df12683b 100644 --- a/app/Http/Controllers/Report/DoubleController.php +++ b/app/Http/Controllers/Report/DoubleController.php @@ -37,6 +37,10 @@ /** * Class DoubleController + * + * Controlador responsavel pela geracao de relatorios de contas duplas. + * Gera visoes parciais com transacoes entre contas de ativos e + * passivos, mostrando fluxos de dinheiro entre contas relacionadas. */ class DoubleController extends Controller { diff --git a/app/Http/Controllers/Report/OperationsController.php b/app/Http/Controllers/Report/OperationsController.php index d2aaeaa3dd7..7b179340b0f 100644 --- a/app/Http/Controllers/Report/OperationsController.php +++ b/app/Http/Controllers/Report/OperationsController.php @@ -32,7 +32,11 @@ use Illuminate\Support\Collection; /** - * Class OperationsController. + * Class OperationsController + * + * Controlador responsavel pela geracao de relatorios de operacoes. + * Gera visoes parciais com resumos de receitas e despesas, + * mostrando totais por moeda e periodo. */ class OperationsController extends Controller { diff --git a/app/Http/Controllers/Report/TagController.php b/app/Http/Controllers/Report/TagController.php index 22bca3fd991..4826d16fd63 100644 --- a/app/Http/Controllers/Report/TagController.php +++ b/app/Http/Controllers/Report/TagController.php @@ -37,6 +37,10 @@ /** * Class TagController + * + * Controlador responsavel pela geracao de relatorios de tags. + * Gera visoes parciais com receitas e despesas por tag, + * incluindo medias, maiores transacoes e distribuicao por conta. */ class TagController extends Controller { diff --git a/app/Http/Controllers/Rule/CreateController.php b/app/Http/Controllers/Rule/CreateController.php index 107042d458a..bdc501204d1 100644 --- a/app/Http/Controllers/Rule/CreateController.php +++ b/app/Http/Controllers/Rule/CreateController.php @@ -44,6 +44,10 @@ /** * Class CreateController + * + * Controlador responsavel pela criacao de regras de automacao. + * Permite criar regras com gatilhos e acoes para automatizar + * a categorizacao e modificacao de transacoes. */ class CreateController extends Controller { diff --git a/app/Http/Controllers/Rule/DeleteController.php b/app/Http/Controllers/Rule/DeleteController.php index d4c6ceb05de..86c28cd7c65 100644 --- a/app/Http/Controllers/Rule/DeleteController.php +++ b/app/Http/Controllers/Rule/DeleteController.php @@ -33,6 +33,9 @@ /** * Class DeleteController + * + * Controlador responsavel pela exclusao de regras de automacao. + * Permite excluir regras e seus gatilhos e acoes associados. */ class DeleteController extends Controller { diff --git a/app/Http/Controllers/Rule/EditController.php b/app/Http/Controllers/Rule/EditController.php index 848fa259a3d..b0673a889a3 100644 --- a/app/Http/Controllers/Rule/EditController.php +++ b/app/Http/Controllers/Rule/EditController.php @@ -42,6 +42,9 @@ /** * Class EditController + * + * Controlador responsavel pela edicao de regras de automacao. + * Permite modificar gatilhos, acoes e configuracoes da regra. */ class EditController extends Controller { diff --git a/app/Http/Controllers/Rule/IndexController.php b/app/Http/Controllers/Rule/IndexController.php index 5d53c38e9c9..0005729294d 100644 --- a/app/Http/Controllers/Rule/IndexController.php +++ b/app/Http/Controllers/Rule/IndexController.php @@ -37,6 +37,9 @@ /** * Class IndexController + * + * Controlador responsavel pela listagem de regras de automacao. + * Exibe todas as regras organizadas por grupos de regras. */ class IndexController extends Controller { diff --git a/app/Http/Controllers/Rule/SelectController.php b/app/Http/Controllers/Rule/SelectController.php index 24c7dc08600..335b38a4bc6 100644 --- a/app/Http/Controllers/Rule/SelectController.php +++ b/app/Http/Controllers/Rule/SelectController.php @@ -42,7 +42,11 @@ use Illuminate\View\View; /** - * Class SelectController. + * Class SelectController + * + * Controlador responsavel pela selecao e teste de regras. + * Permite testar gatilhos de regras e executar regras em + * transacoes existentes selecionadas. */ class SelectController extends Controller { diff --git a/app/Http/Controllers/RuleGroup/CreateController.php b/app/Http/Controllers/RuleGroup/CreateController.php index c2698493087..d4a58b32bc4 100644 --- a/app/Http/Controllers/RuleGroup/CreateController.php +++ b/app/Http/Controllers/RuleGroup/CreateController.php @@ -34,6 +34,9 @@ /** * Class CreateController + * + * Controlador responsavel pela criacao de grupos de regras. + * Permite criar grupos para organizar regras de automacao. */ class CreateController extends Controller { diff --git a/app/Http/Controllers/RuleGroup/DeleteController.php b/app/Http/Controllers/RuleGroup/DeleteController.php index 8d7bf2fea71..123d1892332 100644 --- a/app/Http/Controllers/RuleGroup/DeleteController.php +++ b/app/Http/Controllers/RuleGroup/DeleteController.php @@ -35,6 +35,9 @@ /** * Class DeleteController + * + * Controlador responsavel pela exclusao de grupos de regras. + * Permite excluir grupos e mover regras para outros grupos. */ class DeleteController extends Controller { diff --git a/app/Http/Controllers/RuleGroup/EditController.php b/app/Http/Controllers/RuleGroup/EditController.php index ecf18bfa479..5d50c38ae8b 100644 --- a/app/Http/Controllers/RuleGroup/EditController.php +++ b/app/Http/Controllers/RuleGroup/EditController.php @@ -37,6 +37,9 @@ /** * Class EditController + * + * Controlador responsavel pela edicao de grupos de regras. + * Permite modificar titulo, descricao e ordem dos grupos. */ class EditController extends Controller { diff --git a/app/Http/Controllers/RuleGroup/ExecutionController.php b/app/Http/Controllers/RuleGroup/ExecutionController.php index 4f1b3137b2b..f90ba7f921d 100644 --- a/app/Http/Controllers/RuleGroup/ExecutionController.php +++ b/app/Http/Controllers/RuleGroup/ExecutionController.php @@ -39,6 +39,10 @@ /** * Class ExecutionController + * + * Controlador responsavel pela execucao de grupos de regras. + * Permite executar todas as regras de um grupo em transacoes + * existentes selecionadas por periodo e contas. */ class ExecutionController extends Controller { diff --git a/app/Http/Controllers/System/CronController.php b/app/Http/Controllers/System/CronController.php index 432d0d189bd..b3b710bf6b6 100644 --- a/app/Http/Controllers/System/CronController.php +++ b/app/Http/Controllers/System/CronController.php @@ -30,6 +30,10 @@ /** * Class CronController + * + * Controlador responsavel pelo endpoint de cron legado. + * Redireciona para o novo endpoint da API para execucao + * de tarefas agendadas. */ class CronController { diff --git a/app/Http/Controllers/System/HealthcheckController.php b/app/Http/Controllers/System/HealthcheckController.php index 8bec13fcd95..3201a003239 100644 --- a/app/Http/Controllers/System/HealthcheckController.php +++ b/app/Http/Controllers/System/HealthcheckController.php @@ -28,7 +28,11 @@ use Illuminate\Http\Response; /** - * Class HealthcheckController. + * Class HealthcheckController + * + * Controlador responsavel pela verificacao de saude do sistema. + * Fornece endpoint para monitoramento que verifica se a + * aplicacao e o banco de dados estao funcionando. */ class HealthcheckController extends Controller { diff --git a/app/Http/Controllers/System/InstallController.php b/app/Http/Controllers/System/InstallController.php index e2acfb680f6..df7f5990247 100644 --- a/app/Http/Controllers/System/InstallController.php +++ b/app/Http/Controllers/System/InstallController.php @@ -41,6 +41,10 @@ /** * Class InstallController + * + * Controlador responsavel pela instalacao e atualizacao. + * Executa migracoes de banco de dados, gera chaves RSA + * e configura o sistema durante a instalacao. */ class InstallController extends Controller { diff --git a/app/Http/Controllers/Transaction/BulkController.php b/app/Http/Controllers/Transaction/BulkController.php index bca008b1472..3feb1b1fd15 100644 --- a/app/Http/Controllers/Transaction/BulkController.php +++ b/app/Http/Controllers/Transaction/BulkController.php @@ -39,6 +39,10 @@ /** * Class BulkController + * + * Controlador responsavel pela edicao em massa de transacoes. + * Permite modificar orcamento, categoria e tags de multiplas + * transacoes simultaneamente. */ class BulkController extends Controller { diff --git a/app/Http/Controllers/Transaction/ConvertController.php b/app/Http/Controllers/Transaction/ConvertController.php index 8f24176f596..1c06d436d17 100644 --- a/app/Http/Controllers/Transaction/ConvertController.php +++ b/app/Http/Controllers/Transaction/ConvertController.php @@ -48,7 +48,11 @@ use Illuminate\View\View; /** - * Class ConvertController. + * Class ConvertController + * + * Controlador responsavel pela conversao de tipos de transacoes. + * Permite converter entre despesas, receitas e transferencias, + * validando contas de origem e destino para cada tipo. * * TODO when converting a split transfer, all sources and destinations must be the same. */ diff --git a/app/Http/Controllers/Transaction/CreateController.php b/app/Http/Controllers/Transaction/CreateController.php index d8e6092837b..837a6f09308 100644 --- a/app/Http/Controllers/Transaction/CreateController.php +++ b/app/Http/Controllers/Transaction/CreateController.php @@ -40,6 +40,10 @@ /** * Class CreateController + * + * Controlador responsavel pela criacao de transacoes. + * Permite criar novas transacoes (despesas, receitas, transferencias) + * e clonar transacoes existentes. */ class CreateController extends Controller { diff --git a/app/Http/Controllers/Transaction/DeleteController.php b/app/Http/Controllers/Transaction/DeleteController.php index 89785805a95..b3aee92b861 100644 --- a/app/Http/Controllers/Transaction/DeleteController.php +++ b/app/Http/Controllers/Transaction/DeleteController.php @@ -39,6 +39,9 @@ /** * Class DeleteController + * + * Controlador responsavel pela exclusao de transacoes. + * Permite excluir grupos de transacoes e atualiza contas associadas. */ class DeleteController extends Controller { diff --git a/app/Http/Controllers/Transaction/EditController.php b/app/Http/Controllers/Transaction/EditController.php index 507cc0cc342..fe3571e1c18 100644 --- a/app/Http/Controllers/Transaction/EditController.php +++ b/app/Http/Controllers/Transaction/EditController.php @@ -39,6 +39,10 @@ /** * Class EditController + * + * Controlador responsavel pela edicao de transacoes. + * Permite modificar valores, contas, categorias e outras propriedades + * de transacoes existentes. */ class EditController extends Controller { diff --git a/app/Http/Controllers/Transaction/IndexController.php b/app/Http/Controllers/Transaction/IndexController.php index 54e6a6e9675..74b913993a9 100644 --- a/app/Http/Controllers/Transaction/IndexController.php +++ b/app/Http/Controllers/Transaction/IndexController.php @@ -37,6 +37,10 @@ /** * Class IndexController + * + * Controlador responsavel pela listagem de transacoes. + * Exibe transacoes filtradas por tipo e periodo, com suporte + * a paginacao e visao geral de periodos. */ class IndexController extends Controller { diff --git a/app/Http/Controllers/Transaction/LinkController.php b/app/Http/Controllers/Transaction/LinkController.php index d06bc0c0897..ffc5bb6600a 100644 --- a/app/Http/Controllers/Transaction/LinkController.php +++ b/app/Http/Controllers/Transaction/LinkController.php @@ -36,7 +36,11 @@ use Illuminate\View\View; /** - * Class LinkController. + * Class LinkController + * + * Controlador responsavel pelo gerenciamento de links entre transacoes. + * Permite criar, excluir e inverter links que conectam transacoes + * relacionadas (ex: reembolsos, pagamentos parcelados). */ class LinkController extends Controller { diff --git a/app/Http/Controllers/Transaction/MassController.php b/app/Http/Controllers/Transaction/MassController.php index bb7f4609ae7..e820aff36b6 100644 --- a/app/Http/Controllers/Transaction/MassController.php +++ b/app/Http/Controllers/Transaction/MassController.php @@ -44,7 +44,11 @@ use Illuminate\View\View as IlluminateView; /** - * Class MassController. + * Class MassController + * + * Controlador responsavel pela edicao e exclusao em massa de transacoes. + * Permite modificar ou excluir multiplas transacoes simultaneamente, + * incluindo alteracao de datas, descricoes, contas e categorias. */ class MassController extends Controller { diff --git a/app/Http/Controllers/Transaction/ShowController.php b/app/Http/Controllers/Transaction/ShowController.php index 3df555292c8..0c28d700f94 100644 --- a/app/Http/Controllers/Transaction/ShowController.php +++ b/app/Http/Controllers/Transaction/ShowController.php @@ -42,6 +42,10 @@ /** * Class ShowController + * + * Controlador responsavel pela exibicao detalhada de transacoes. + * Mostra informacoes completas da transacao incluindo valores, + * contas, anexos, links e historico de auditoria. */ class ShowController extends Controller { diff --git a/app/Http/Controllers/TransactionCurrency/CreateController.php b/app/Http/Controllers/TransactionCurrency/CreateController.php index 2e7372b213e..c7465691c79 100644 --- a/app/Http/Controllers/TransactionCurrency/CreateController.php +++ b/app/Http/Controllers/TransactionCurrency/CreateController.php @@ -40,6 +40,10 @@ /** * Class CreateController + * + * Controlador responsavel pela criacao de moedas. + * Permite que administradores criem novas moedas + * com codigo, simbolo e casas decimais personalizados. */ class CreateController extends Controller { diff --git a/app/Http/Controllers/TransactionCurrency/DeleteController.php b/app/Http/Controllers/TransactionCurrency/DeleteController.php index c7cc7fb83aa..19163326411 100644 --- a/app/Http/Controllers/TransactionCurrency/DeleteController.php +++ b/app/Http/Controllers/TransactionCurrency/DeleteController.php @@ -38,6 +38,10 @@ /** * Class DeleteController + * + * Controlador responsavel pela exclusao de moedas. + * Permite que administradores excluam moedas que + * nao estao em uso no sistema. */ class DeleteController extends Controller { diff --git a/app/Http/Controllers/TransactionCurrency/EditController.php b/app/Http/Controllers/TransactionCurrency/EditController.php index 926e973f447..99a13e8ea0c 100644 --- a/app/Http/Controllers/TransactionCurrency/EditController.php +++ b/app/Http/Controllers/TransactionCurrency/EditController.php @@ -37,6 +37,13 @@ use Illuminate\Support\Facades\Log; use Illuminate\View\View; +/** + * Class EditController + * + * Controlador responsavel pela edicao de moedas. + * Permite que administradores modifiquem propriedades + * de moedas existentes no sistema. + */ class EditController extends Controller { protected CurrencyRepositoryInterface $repository; diff --git a/app/Http/Controllers/TransactionCurrency/IndexController.php b/app/Http/Controllers/TransactionCurrency/IndexController.php index d63ffe5897e..656aedcfa51 100644 --- a/app/Http/Controllers/TransactionCurrency/IndexController.php +++ b/app/Http/Controllers/TransactionCurrency/IndexController.php @@ -34,6 +34,13 @@ use Illuminate\Pagination\LengthAwarePaginator; use Illuminate\View\View; +/** + * Class IndexController + * + * Controlador responsavel pela listagem de moedas. + * Exibe todas as moedas disponiveis no sistema, + * ordenadas por status de habilitacao e padrao. + */ class IndexController extends Controller { protected CurrencyRepositoryInterface $repository; diff --git a/app/Http/Controllers/UserGroup/CreateController.php b/app/Http/Controllers/UserGroup/CreateController.php index 88ab1ec074f..81ec63bd2ba 100644 --- a/app/Http/Controllers/UserGroup/CreateController.php +++ b/app/Http/Controllers/UserGroup/CreateController.php @@ -29,6 +29,13 @@ use Illuminate\Contracts\View\View; use Illuminate\Foundation\Application; +/** + * Class CreateController + * + * Controlador responsavel pela criacao de grupos de usuarios. + * Permite criar novas administracoes para organizar + * usuarios e seus dados financeiros. + */ class CreateController extends Controller { /** diff --git a/app/Http/Controllers/UserGroup/EditController.php b/app/Http/Controllers/UserGroup/EditController.php index c8d68e991d6..536fedad216 100644 --- a/app/Http/Controllers/UserGroup/EditController.php +++ b/app/Http/Controllers/UserGroup/EditController.php @@ -30,6 +30,13 @@ use Illuminate\Contracts\View\View; use Illuminate\Foundation\Application; +/** + * Class EditController + * + * Controlador responsavel pela edicao de grupos de usuarios. + * Permite modificar configuracoes de administracoes + * existentes no sistema. + */ class EditController extends Controller { /** diff --git a/app/Http/Controllers/UserGroup/IndexController.php b/app/Http/Controllers/UserGroup/IndexController.php index 41c05ad8b1b..1da119df2de 100644 --- a/app/Http/Controllers/UserGroup/IndexController.php +++ b/app/Http/Controllers/UserGroup/IndexController.php @@ -29,6 +29,13 @@ use Illuminate\Http\Request; use Illuminate\View\View; +/** + * Class IndexController + * + * Controlador responsavel pela listagem de grupos de usuarios. + * Exibe todas as administracoes disponiveis para + * o usuario atual. + */ class IndexController extends Controller { /** diff --git a/app/Http/Controllers/Webhooks/CreateController.php b/app/Http/Controllers/Webhooks/CreateController.php index 70ac3cbd350..af564e654d8 100644 --- a/app/Http/Controllers/Webhooks/CreateController.php +++ b/app/Http/Controllers/Webhooks/CreateController.php @@ -32,6 +32,10 @@ /** * Class CreateController + * + * Controlador responsavel pela criacao de webhooks. + * Permite criar novos webhooks para notificacoes automaticas + * quando eventos ocorrem no sistema. */ class CreateController extends Controller { diff --git a/app/Http/Controllers/Webhooks/DeleteController.php b/app/Http/Controllers/Webhooks/DeleteController.php index 4fd33895d17..b5ad066c0af 100644 --- a/app/Http/Controllers/Webhooks/DeleteController.php +++ b/app/Http/Controllers/Webhooks/DeleteController.php @@ -34,6 +34,9 @@ /** * Class DeleteController + * + * Controlador responsavel pela exclusao de webhooks. + * Permite excluir webhooks e suas mensagens associadas. */ class DeleteController extends Controller { diff --git a/app/Http/Controllers/Webhooks/EditController.php b/app/Http/Controllers/Webhooks/EditController.php index 7ea2b6c63b7..4febe6d78cd 100644 --- a/app/Http/Controllers/Webhooks/EditController.php +++ b/app/Http/Controllers/Webhooks/EditController.php @@ -34,6 +34,9 @@ /** * Class EditController + * + * Controlador responsavel pela edicao de webhooks. + * Permite modificar URL, gatilhos e configuracoes de webhooks. */ class EditController extends Controller { diff --git a/app/Http/Controllers/Webhooks/IndexController.php b/app/Http/Controllers/Webhooks/IndexController.php index a3ca4790c2a..9993936d94a 100644 --- a/app/Http/Controllers/Webhooks/IndexController.php +++ b/app/Http/Controllers/Webhooks/IndexController.php @@ -32,6 +32,9 @@ /** * Class IndexController + * + * Controlador responsavel pela listagem de webhooks. + * Exibe todos os webhooks configurados pelo usuario. */ class IndexController extends Controller { diff --git a/app/Http/Controllers/Webhooks/ShowController.php b/app/Http/Controllers/Webhooks/ShowController.php index 37e0e030037..b54854b3dea 100644 --- a/app/Http/Controllers/Webhooks/ShowController.php +++ b/app/Http/Controllers/Webhooks/ShowController.php @@ -34,6 +34,9 @@ /** * Class ShowController + * + * Controlador responsavel pela exibicao detalhada de webhooks. + * Mostra configuracoes, historico de mensagens e status do webhook. */ class ShowController extends Controller { diff --git a/app/Jobs/CreateAutoBudgetLimits.php b/app/Jobs/CreateAutoBudgetLimits.php index 396c21222ce..59056ff94ce 100644 --- a/app/Jobs/CreateAutoBudgetLimits.php +++ b/app/Jobs/CreateAutoBudgetLimits.php @@ -39,7 +39,9 @@ use Illuminate\Support\Collection; /** - * Class CreateAutoBudgetLimits + * Class CreateAutoBudgetLimits. + * + * Job para criacao de limites de orcamento automatico. */ class CreateAutoBudgetLimits implements ShouldQueue { diff --git a/app/Jobs/CreateRecurringTransactions.php b/app/Jobs/CreateRecurringTransactions.php index a70e768868f..e8c6d9e2c16 100644 --- a/app/Jobs/CreateRecurringTransactions.php +++ b/app/Jobs/CreateRecurringTransactions.php @@ -46,6 +46,8 @@ /** * Class CreateRecurringTransactions. + * + * Job para criacao de transacoes recorrentes. */ class CreateRecurringTransactions implements ShouldQueue { diff --git a/app/Jobs/DownloadExchangeRates.php b/app/Jobs/DownloadExchangeRates.php index 0a873f925ca..e78a0314a6e 100644 --- a/app/Jobs/DownloadExchangeRates.php +++ b/app/Jobs/DownloadExchangeRates.php @@ -43,7 +43,9 @@ use function Safe\json_decode; /** - * Class DownloadExchangeRates + * Class DownloadExchangeRates. + * + * Job para download de taxas de cambio. */ class DownloadExchangeRates implements ShouldQueue { diff --git a/app/Jobs/Job.php b/app/Jobs/Job.php index 05b49522264..036ce2971bf 100644 --- a/app/Jobs/Job.php +++ b/app/Jobs/Job.php @@ -27,6 +27,8 @@ /** * Class Job. + * + * Classe base abstrata para jobs. */ abstract class Job { diff --git a/app/Jobs/MailError.php b/app/Jobs/MailError.php index d1e34a41647..e30d2247c90 100644 --- a/app/Jobs/MailError.php +++ b/app/Jobs/MailError.php @@ -40,6 +40,8 @@ /** * Class MailError. + * + * Job para envio de emails de erro. */ class MailError extends Job implements ShouldQueue { diff --git a/app/Jobs/SendWebhookMessage.php b/app/Jobs/SendWebhookMessage.php index dbaab99fe34..6b3c1ba9a05 100644 --- a/app/Jobs/SendWebhookMessage.php +++ b/app/Jobs/SendWebhookMessage.php @@ -33,7 +33,9 @@ use Illuminate\Queue\SerializesModels; /** - * Class SendWebhookMessage + * Class SendWebhookMessage. + * + * Job para envio de mensagens de webhook. */ class SendWebhookMessage implements ShouldQueue { diff --git a/app/Jobs/WarnAboutBills.php b/app/Jobs/WarnAboutBills.php index 155454790ea..33290600d02 100644 --- a/app/Jobs/WarnAboutBills.php +++ b/app/Jobs/WarnAboutBills.php @@ -39,7 +39,9 @@ use Illuminate\Support\Facades\Log; /** - * Class WarnAboutBills + * Class WarnAboutBills. + * + * Job para envio de avisos sobre faturas. */ class WarnAboutBills implements ShouldQueue { diff --git a/app/Mail/AccessTokenCreatedMail.php b/app/Mail/AccessTokenCreatedMail.php index 12deb375c4c..e705e117064 100644 --- a/app/Mail/AccessTokenCreatedMail.php +++ b/app/Mail/AccessTokenCreatedMail.php @@ -29,7 +29,9 @@ use Illuminate\Queue\SerializesModels; /** - * Class AccessTokenCreatedMail + * Class AccessTokenCreatedMail. + * + * Email enviado quando um token de acesso e criado. */ class AccessTokenCreatedMail extends Mailable { diff --git a/app/Mail/AdminTestMail.php b/app/Mail/AdminTestMail.php index a24f87d214d..030f8bbbc73 100644 --- a/app/Mail/AdminTestMail.php +++ b/app/Mail/AdminTestMail.php @@ -30,7 +30,7 @@ /** * Class AdminTestMail. * - * Sends a test mail to administrators. + * Email de teste enviado para administradores. */ class AdminTestMail extends Mailable { diff --git a/app/Mail/BillWarningMail.php b/app/Mail/BillWarningMail.php index 8b438091d59..fc66fd88072 100644 --- a/app/Mail/BillWarningMail.php +++ b/app/Mail/BillWarningMail.php @@ -30,7 +30,9 @@ use Illuminate\Queue\SerializesModels; /** - * Class BillWarningMail + * Class BillWarningMail. + * + * Email de aviso de fatura proxima do vencimento. */ class BillWarningMail extends Mailable { diff --git a/app/Mail/ConfirmEmailChangeMail.php b/app/Mail/ConfirmEmailChangeMail.php index de4153e21c0..2d61347a9d9 100644 --- a/app/Mail/ConfirmEmailChangeMail.php +++ b/app/Mail/ConfirmEmailChangeMail.php @@ -28,9 +28,9 @@ use Illuminate\Queue\SerializesModels; /** - * Class ConfirmEmailChangeMail + * Class ConfirmEmailChangeMail. * - * Sends message to new address to confirm change. + * Email de confirmacao de alteracao de email. */ class ConfirmEmailChangeMail extends Mailable { diff --git a/app/Mail/InvitationMail.php b/app/Mail/InvitationMail.php index d1dd789cbe1..f7b0241eb35 100644 --- a/app/Mail/InvitationMail.php +++ b/app/Mail/InvitationMail.php @@ -31,7 +31,9 @@ use function Safe\parse_url; /** - * Class InvitationMail + * Class InvitationMail. + * + * Email de convite para novos usuarios. */ class InvitationMail extends Mailable { diff --git a/app/Mail/NewIPAddressWarningMail.php b/app/Mail/NewIPAddressWarningMail.php index 8afba582a93..78afb63dc21 100644 --- a/app/Mail/NewIPAddressWarningMail.php +++ b/app/Mail/NewIPAddressWarningMail.php @@ -30,7 +30,9 @@ use Illuminate\Queue\SerializesModels; /** - * Class NewIPAddressWarningMail + * Class NewIPAddressWarningMail. + * + * Email de aviso de login de novo endereco IP. */ class NewIPAddressWarningMail extends Mailable { diff --git a/app/Mail/OAuthTokenCreatedMail.php b/app/Mail/OAuthTokenCreatedMail.php index 4f682595460..21196aaf06f 100644 --- a/app/Mail/OAuthTokenCreatedMail.php +++ b/app/Mail/OAuthTokenCreatedMail.php @@ -30,7 +30,9 @@ use Laravel\Passport\Client; /** - * Class OAuthTokenCreatedMail + * Class OAuthTokenCreatedMail. + * + * Email enviado quando um cliente OAuth e criado. */ class OAuthTokenCreatedMail extends Mailable { diff --git a/app/Mail/RegisteredUser.php b/app/Mail/RegisteredUser.php index 991d64d26f1..bed8bafef28 100644 --- a/app/Mail/RegisteredUser.php +++ b/app/Mail/RegisteredUser.php @@ -28,9 +28,9 @@ use Illuminate\Queue\SerializesModels; /** - * Sends newly registered user an email message. + * Class RegisteredUser. * - * Class RegisteredUser + * Email de boas-vindas para usuarios recem-registrados. */ class RegisteredUser extends Mailable { diff --git a/app/Mail/ReportNewJournalsMail.php b/app/Mail/ReportNewJournalsMail.php index e0a492fa478..81d81e882c3 100644 --- a/app/Mail/ReportNewJournalsMail.php +++ b/app/Mail/ReportNewJournalsMail.php @@ -34,7 +34,7 @@ /** * Class ReportNewJournalsMail. * - * Sends a list of newly created journals to the user. + * Email de relatorio de novos lancamentos criados. */ class ReportNewJournalsMail extends Mailable { diff --git a/app/Mail/RequestedNewPassword.php b/app/Mail/RequestedNewPassword.php index fb5202d6f2c..0c23e97c46e 100644 --- a/app/Mail/RequestedNewPassword.php +++ b/app/Mail/RequestedNewPassword.php @@ -28,8 +28,9 @@ use Illuminate\Queue\SerializesModels; /** - * Sends user link for new password. - * Class RequestedNewPassword + * Class RequestedNewPassword. + * + * Email enviado quando o usuario solicita uma nova senha. */ class RequestedNewPassword extends Mailable { diff --git a/app/Mail/UndoEmailChangeMail.php b/app/Mail/UndoEmailChangeMail.php index 98c55721e7a..c0bd98a6538 100644 --- a/app/Mail/UndoEmailChangeMail.php +++ b/app/Mail/UndoEmailChangeMail.php @@ -28,7 +28,9 @@ use Illuminate\Queue\SerializesModels; /** - * Class UndoEmailChangeMail + * Class UndoEmailChangeMail. + * + * Email para desfazer alteracao de email. */ class UndoEmailChangeMail extends Mailable { diff --git a/app/Models/Account.php b/app/Models/Account.php index 683b4a29737..8ec4ace3ad6 100644 --- a/app/Models/Account.php +++ b/app/Models/Account.php @@ -40,6 +40,33 @@ use Illuminate\Database\Eloquent\SoftDeletes; use Symfony\Component\HttpKernel\Exception\NotFoundHttpException; +/** + * Class Account + * + * Representa uma conta financeira no sistema Firefly III. As contas podem ser de diversos tipos, + * como contas correntes, poupanca, cartoes de credito, ativos, passivos, entre outros. + * Esta classe e o modelo central para gerenciar todas as contas do usuario. + * + * @property int $id Identificador unico da conta + * @property int $user_id ID do usuario proprietario + * @property int $user_group_id ID do grupo de usuarios + * @property int $account_type_id ID do tipo de conta + * @property string $name Nome da conta + * @property bool $active Indica se a conta esta ativa + * @property string|null $virtual_balance Saldo virtual da conta + * @property string|null $iban Numero IBAN da conta + * @property string|null $native_virtual_balance Saldo virtual na moeda nativa + * @property \Carbon\Carbon $created_at Data de criacao + * @property \Carbon\Carbon $updated_at Data de atualizacao + * @property \Carbon\Carbon|null $deleted_at Data de exclusao (soft delete) + * @property-read AccountType $accountType Tipo da conta + * @property-read User $user Usuario proprietario + * @property-read \Illuminate\Support\Collection $accountMeta Metadados da conta + * @property-read \Illuminate\Support\Collection $transactions Transacoes da conta + * @property-read \Illuminate\Support\Collection $piggyBanks Cofrinhos associados + * @property-read \Illuminate\Support\Collection $attachments Anexos da conta + * @property-read \Illuminate\Support\Collection $notes Notas da conta + */ class Account extends Model { use HasFactory; @@ -75,21 +102,43 @@ public static function routeBinder(string $value): self throw new NotFoundHttpException(); } + /** + * Retorna o relacionamento com o usuario proprietario da conta. + * + * @return BelongsTo Relacionamento BelongsTo com o modelo User + */ public function user(): BelongsTo { return $this->belongsTo(User::class); } + /** + * Retorna todos os saldos historicos da conta. + * Os saldos sao armazenados para diferentes moedas e periodos. + * + * @return HasMany Colecao de AccountBalance relacionados a esta conta + */ public function accountBalances(): HasMany { return $this->hasMany(AccountBalance::class); } + /** + * Retorna o tipo da conta (corrente, poupanca, cartao de credito, etc.). + * + * @return BelongsTo Relacionamento BelongsTo com o modelo AccountType + */ public function accountType(): BelongsTo { return $this->belongsTo(AccountType::class); } + /** + * Retorna todos os anexos associados a esta conta. + * Anexos podem incluir documentos, comprovantes, etc. + * + * @return MorphMany Colecao polimorfica de Attachment + */ public function attachments(): MorphMany { return $this->morphMany(Attachment::class, 'attachable'); @@ -111,15 +160,28 @@ protected function accountNumber(): Attribute }); } + /** + * Retorna todos os metadados associados a esta conta. + * Metadados incluem informacoes adicionais como numero da conta, BIC, etc. + * + * @return HasMany Colecao de AccountMeta relacionados a esta conta + */ public function accountMeta(): HasMany { return $this->hasMany(AccountMeta::class); } + /** + * Retorna o nome editavel da conta. + * Para contas do tipo CASH, retorna string vazia pois nao sao editaveis. + * + * @return Attribute Atributo computado para o nome editavel + */ protected function editName(): Attribute { return Attribute::make(get: function () { $name = $this->name; + // Contas do tipo CASH nao possuem nome editavel if (AccountTypeEnum::CASH->value === $this->accountType->type) { return ''; } @@ -128,13 +190,21 @@ protected function editName(): Attribute }); } + /** + * Retorna todas as localizacoes geograficas associadas a esta conta. + * + * @return MorphMany Colecao polimorfica de Location + */ public function locations(): MorphMany { return $this->morphMany(Location::class, 'locatable'); } /** - * Get all the notes. + * Retorna todas as notas associadas a esta conta. + * Notas podem conter informacoes adicionais ou lembretes sobre a conta. + * + * @return MorphMany Colecao polimorfica de Note */ public function notes(): MorphMany { @@ -142,21 +212,40 @@ public function notes(): MorphMany } /** - * Get all the tags for the post. + * Retorna todos os grupos de objetos aos quais esta conta pertence. + * Grupos de objetos permitem organizar contas em categorias personalizadas. + * + * @return MorphToMany Colecao polimorfica de ObjectGroup */ public function objectGroups(): MorphToMany { return $this->morphToMany(ObjectGroup::class, 'object_groupable'); } + /** + * Retorna todos os cofrinhos (piggy banks) associados a esta conta. + * Cofrinhos sao metas de poupanca vinculadas a contas. + * + * @return BelongsToMany Colecao de PiggyBank relacionados + */ public function piggyBanks(): BelongsToMany { return $this->belongsToMany(PiggyBank::class); } + /** + * Escopo de consulta para filtrar contas por tipos especificos. + * Realiza join com a tabela account_types se necessario. + * + * @param EloquentBuilder $query Query builder do Eloquent + * @param array $types Array de tipos de conta para filtrar + * + * @return void + */ #[Scope] protected function accountTypeIn(EloquentBuilder $query, array $types): void { + // Realiza o join apenas uma vez para evitar duplicacao if (false === $this->joinedAccountTypes) { $query->leftJoin('account_types', 'account_types.id', '=', 'accounts.account_type_id'); $this->joinedAccountTypes = true; @@ -164,6 +253,14 @@ protected function accountTypeIn(EloquentBuilder $query, array $types): void $query->whereIn('account_types.type', $types); } + /** + * Define o valor do saldo virtual da conta. + * Converte valores vazios para null para consistencia no banco de dados. + * + * @param mixed $value Valor do saldo virtual a ser definido + * + * @return void + */ public function setVirtualBalanceAttribute(mixed $value): void { $value = (string) $value; @@ -173,16 +270,31 @@ public function setVirtualBalanceAttribute(mixed $value): void $this->attributes['virtual_balance'] = $value; } + /** + * Retorna todas as transacoes associadas a esta conta. + * + * @return HasMany Colecao de Transaction relacionadas a esta conta + */ public function transactions(): HasMany { return $this->hasMany(Transaction::class); } + /** + * Retorna o grupo de usuarios ao qual esta conta pertence. + * + * @return BelongsTo Relacionamento BelongsTo com o modelo UserGroup + */ public function userGroup(): BelongsTo { return $this->belongsTo(UserGroup::class); } + /** + * Accessor para garantir que o ID da conta seja retornado como inteiro. + * + * @return Attribute Atributo computado para o ID da conta + */ protected function accountId(): Attribute { return Attribute::make( @@ -191,7 +303,9 @@ protected function accountId(): Attribute } /** - * Get the user ID + * Accessor para garantir que o ID do tipo de conta seja retornado como inteiro. + * + * @return Attribute Atributo computado para o ID do tipo de conta */ protected function accountTypeId(): Attribute { @@ -200,6 +314,12 @@ protected function accountTypeId(): Attribute ); } + /** + * Accessor para formatar o IBAN removendo espacos. + * Retorna null se o valor original for null. + * + * @return Attribute Atributo computado para o IBAN formatado + */ protected function iban(): Attribute { return Attribute::make( @@ -207,6 +327,11 @@ protected function iban(): Attribute ); } + /** + * Accessor para garantir que a ordem seja retornada como inteiro. + * + * @return Attribute Atributo computado para a ordem de exibicao + */ protected function order(): Attribute { return Attribute::make( @@ -215,7 +340,9 @@ protected function order(): Attribute } /** - * Get the virtual balance + * Accessor para garantir que o saldo virtual seja retornado como string. + * + * @return Attribute Atributo computado para o saldo virtual */ protected function virtualBalance(): Attribute { @@ -224,6 +351,12 @@ protected function virtualBalance(): Attribute ); } + /** + * Define os casts de atributos do modelo. + * Especifica como cada atributo deve ser convertido ao ser acessado. + * + * @return array Array de casts de atributos + */ protected function casts(): array { return [ diff --git a/app/Models/AccountBalance.php b/app/Models/AccountBalance.php index e7eaf361ce7..bfa8d5043ab 100644 --- a/app/Models/AccountBalance.php +++ b/app/Models/AccountBalance.php @@ -30,22 +30,54 @@ use Illuminate\Database\Eloquent\Model; use Illuminate\Database\Eloquent\Relations\BelongsTo; +/** + * Class AccountBalance + * + * Representa o saldo de uma conta em um determinado momento no tempo. + * Armazena snapshots do saldo da conta para diferentes moedas e datas, + * permitindo rastrear o historico de saldos ao longo do tempo. + * + * @property int $id Identificador unico do registro de saldo + * @property int $account_id ID da conta associada + * @property string $title Titulo ou descricao do saldo + * @property int $transaction_currency_id ID da moeda do saldo + * @property string $balance Valor do saldo + * @property \Carbon\Carbon $date Data do saldo + * @property string $date_tz Fuso horario da data + * @property-read Account $account Conta associada + * @property-read TransactionCurrency $transactionCurrency Moeda do saldo + */ class AccountBalance extends Model { use HasFactory; protected $fillable = ['account_id', 'title', 'transaction_currency_id', 'balance', 'date', 'date_tz']; + /** + * Retorna a conta associada a este registro de saldo. + * + * @return BelongsTo Relacionamento BelongsTo com o modelo Account + */ public function account(): BelongsTo { return $this->belongsTo(Account::class); } + /** + * Retorna a moeda associada a este saldo. + * + * @return BelongsTo Relacionamento BelongsTo com o modelo TransactionCurrency + */ public function transactionCurrency(): BelongsTo { return $this->belongsTo(TransactionCurrency::class); } + /** + * Define os casts de atributos do modelo. + * + * @return array Array de casts de atributos + */ protected function casts(): array { return [ diff --git a/app/Models/AccountMeta.php b/app/Models/AccountMeta.php index 61d8644ff33..a9f44747eb4 100644 --- a/app/Models/AccountMeta.php +++ b/app/Models/AccountMeta.php @@ -31,6 +31,21 @@ use function Safe\json_decode; use function Safe\json_encode; +/** + * Class AccountMeta + * + * Armazena metadados adicionais para contas financeiras. + * Permite armazenar informacoes extras como numero da conta, BIC, codigo do banco, + * e outros dados especificos que nao fazem parte do modelo principal de conta. + * + * @property int $id Identificador unico do metadado + * @property int $account_id ID da conta associada + * @property string $name Nome/chave do metadado + * @property string $data Valor do metadado (armazenado como JSON) + * @property \Carbon\Carbon $created_at Data de criacao + * @property \Carbon\Carbon $updated_at Data de atualizacao + * @property-read Account $account Conta associada + */ class AccountMeta extends Model { use ReturnsIntegerIdTrait; @@ -38,16 +53,32 @@ class AccountMeta extends Model protected $fillable = ['account_id', 'name', 'data']; protected $table = 'account_meta'; + /** + * Retorna a conta associada a este metadado. + * + * @return BelongsTo Relacionamento BelongsTo com o modelo Account + */ public function account(): BelongsTo { return $this->belongsTo(Account::class); } + /** + * Accessor e mutator para o campo data. + * Decodifica JSON ao ler e codifica ao salvar. + * + * @return Attribute Atributo computado para manipulacao de dados JSON + */ protected function data(): Attribute { return Attribute::make(get: fn (mixed $value) => (string) json_decode((string) $value, true), set: fn (mixed $value) => ['data' => json_encode($value)]); } + /** + * Define os casts de atributos do modelo. + * + * @return array Array de casts de atributos + */ protected function casts(): array { return [ diff --git a/app/Models/AccountType.php b/app/Models/AccountType.php index d4571fde779..00d031909fa 100644 --- a/app/Models/AccountType.php +++ b/app/Models/AccountType.php @@ -28,6 +28,19 @@ use Illuminate\Database\Eloquent\Model; use Illuminate\Database\Eloquent\Relations\HasMany; +/** + * Class AccountType + * + * Define os diferentes tipos de contas suportados pelo Firefly III. + * Tipos incluem: conta corrente (Asset), despesa (Expense), receita (Revenue), + * cartao de credito (Credit Card), emprestimo (Loan), hipoteca (Mortgage), etc. + * + * @property int $id Identificador unico do tipo de conta + * @property string $type Nome do tipo de conta + * @property \Carbon\Carbon $created_at Data de criacao + * @property \Carbon\Carbon $updated_at Data de atualizacao + * @property-read \Illuminate\Support\Collection $accounts Contas deste tipo + */ class AccountType extends Model { use ReturnsIntegerIdTrait; @@ -82,11 +95,21 @@ class AccountType extends Model protected $fillable = ['type']; + /** + * Retorna todas as contas associadas a este tipo de conta. + * + * @return HasMany Colecao de Account relacionadas a este tipo + */ public function accounts(): HasMany { return $this->hasMany(Account::class); } + /** + * Define os casts de atributos do modelo. + * + * @return array Array de casts de atributos + */ protected function casts(): array { return [ diff --git a/app/Models/Attachment.php b/app/Models/Attachment.php index 2287666db1a..a44dc73957a 100644 --- a/app/Models/Attachment.php +++ b/app/Models/Attachment.php @@ -34,6 +34,32 @@ use Illuminate\Database\Eloquent\SoftDeletes; use Symfony\Component\HttpKernel\Exception\NotFoundHttpException; +/** + * Class Attachment + * + * Representa um arquivo anexado a entidades do sistema como transacoes, contas, etc. + * Anexos podem ser comprovantes, recibos, documentos ou qualquer arquivo relevante + * para o registro financeiro. + * + * @property int $id Identificador unico do anexo + * @property int $user_id ID do usuario proprietario + * @property int $user_group_id ID do grupo de usuarios + * @property int $attachable_id ID da entidade anexada + * @property string $attachable_type Tipo da entidade anexada + * @property string $md5 Hash MD5 do arquivo + * @property string $filename Nome original do arquivo + * @property string $mime Tipo MIME do arquivo + * @property string|null $title Titulo do anexo + * @property string|null $description Descricao do anexo + * @property int $size Tamanho do arquivo em bytes + * @property bool $uploaded Indica se o upload foi concluido + * @property \Carbon\Carbon $created_at Data de criacao + * @property \Carbon\Carbon $updated_at Data de atualizacao + * @property \Carbon\Carbon|null $deleted_at Data de exclusao (soft delete) + * @property-read User $user Usuario proprietario + * @property-read Model $attachable Entidade anexada + * @property-read \Illuminate\Support\Collection $notes Notas do anexo + */ class Attachment extends Model { use ReturnsIntegerIdTrait; @@ -65,13 +91,21 @@ public static function routeBinder(string $value): self throw new NotFoundHttpException(); } + /** + * Retorna o usuario proprietario do anexo. + * + * @return BelongsTo Relacionamento BelongsTo com o modelo User + */ public function user(): BelongsTo { return $this->belongsTo(User::class); } /** - * Get all of the owning attachable models. + * Retorna a entidade a qual este anexo esta vinculado. + * Pode ser uma transacao, conta, fatura ou qualquer outra entidade anexavel. + * + * @return MorphTo Relacionamento polimorfico com a entidade anexada */ public function attachable(): MorphTo { @@ -79,7 +113,10 @@ public function attachable(): MorphTo } /** - * Returns the expected filename for this attachment. + * Retorna o nome do arquivo esperado para este anexo no sistema de arquivos. + * O nome segue o padrao 'at-{id}.data' para armazenamento interno. + * + * @return string Nome do arquivo no formato 'at-{id}.data' */ public function fileName(): string { @@ -87,13 +124,20 @@ public function fileName(): string } /** - * Get all the notes. + * Retorna todas as notas associadas a este anexo. + * + * @return MorphMany Colecao polimorfica de Note */ public function notes(): MorphMany { return $this->morphMany(Note::class, 'noteable'); } + /** + * Accessor para garantir que o ID da entidade anexada seja retornado como inteiro. + * + * @return Attribute Atributo computado para o ID da entidade anexada + */ protected function attachableId(): Attribute { return Attribute::make( @@ -101,6 +145,11 @@ protected function attachableId(): Attribute ); } + /** + * Define os casts de atributos do modelo. + * + * @return array Array de casts de atributos + */ protected function casts(): array { return [ diff --git a/app/Models/AuditLogEntry.php b/app/Models/AuditLogEntry.php index 53773692a19..ad92b8a75de 100644 --- a/app/Models/AuditLogEntry.php +++ b/app/Models/AuditLogEntry.php @@ -30,21 +30,57 @@ use Illuminate\Database\Eloquent\Relations\MorphTo; use Illuminate\Database\Eloquent\SoftDeletes; +/** + * Class AuditLogEntry + * + * Registra alteracoes feitas em entidades do sistema para fins de auditoria. + * Armazena o estado anterior e posterior de cada modificacao, permitindo + * rastrear quem fez a alteracao e quando. + * + * @property int $id Identificador unico do registro de auditoria + * @property int $auditable_id ID da entidade auditada + * @property string $auditable_type Tipo da entidade auditada + * @property int $changer_id ID de quem fez a alteracao + * @property string $changer_type Tipo de quem fez a alteracao + * @property string $action Acao realizada (create, update, delete) + * @property array $before Estado anterior da entidade + * @property array $after Estado posterior da entidade + * @property \Carbon\Carbon $created_at Data de criacao + * @property \Carbon\Carbon $updated_at Data de atualizacao + * @property \Carbon\Carbon|null $deleted_at Data de exclusao (soft delete) + * @property-read Model $auditable Entidade auditada + * @property-read Model $changer Quem fez a alteracao + */ class AuditLogEntry extends Model { use ReturnsIntegerIdTrait; use SoftDeletes; + /** + * Retorna a entidade que foi auditada. + * + * @return MorphTo Relacionamento polimorfico com a entidade auditada + */ public function auditable(): MorphTo { return $this->morphTo(); } + /** + * Retorna quem realizou a alteracao (usuario ou sistema). + * + * @return MorphTo Relacionamento polimorfico com o autor da alteracao + */ public function changer(): MorphTo { return $this->morphTo(); } + /** + * Accessor para garantir que o ID da entidade auditada seja retornado como inteiro. + * + * @return Attribute Atributo computado para o ID da entidade auditada + */ protected function auditableId(): Attribute { return Attribute::make( @@ -52,6 +88,11 @@ protected function auditableId(): Attribute ); } + /** + * Accessor para garantir que o ID do autor da alteracao seja retornado como inteiro. + * + * @return Attribute Atributo computado para o ID do autor + */ protected function changerId(): Attribute { return Attribute::make( @@ -59,6 +100,11 @@ protected function changerId(): Attribute ); } + /** + * Define os casts de atributos do modelo. + * + * @return array Array de casts de atributos + */ protected function casts(): array { return [ diff --git a/app/Models/AutoBudget.php b/app/Models/AutoBudget.php index 7f53584616d..b14777bcffa 100644 --- a/app/Models/AutoBudget.php +++ b/app/Models/AutoBudget.php @@ -31,6 +31,24 @@ use Illuminate\Database\Eloquent\Relations\BelongsTo; use Illuminate\Database\Eloquent\SoftDeletes; +/** + * Class AutoBudget + * + * Configura orcamentos automaticos que sao renovados periodicamente. + * Permite definir valores que sao automaticamente alocados para orcamentos + * em intervalos regulares (diario, semanal, mensal, etc.). + * + * @property int $id Identificador unico do auto-orcamento + * @property int $budget_id ID do orcamento associado + * @property int $transaction_currency_id ID da moeda + * @property int $auto_budget_type Tipo de auto-orcamento (reset, rollover, adjusted) + * @property string $amount Valor do orcamento automatico + * @property string $native_amount Valor na moeda nativa + * @property string $period Periodo de renovacao + * @property \Carbon\Carbon|null $deleted_at Data de exclusao (soft delete) + * @property-read Budget $budget Orcamento associado + * @property-read TransactionCurrency $transactionCurrency Moeda do orcamento + */ class AutoBudget extends Model { use ReturnsIntegerIdTrait; @@ -51,16 +69,31 @@ class AutoBudget extends Model ]; protected $fillable = ['budget_id', 'amount', 'period', 'native_amount']; + /** + * Retorna o orcamento associado a este auto-orcamento. + * + * @return BelongsTo Relacionamento BelongsTo com o modelo Budget + */ public function budget(): BelongsTo { return $this->belongsTo(Budget::class); } + /** + * Retorna a moeda associada a este auto-orcamento. + * + * @return BelongsTo Relacionamento BelongsTo com o modelo TransactionCurrency + */ public function transactionCurrency(): BelongsTo { return $this->belongsTo(TransactionCurrency::class); } + /** + * Accessor para garantir que o valor seja retornado como string. + * + * @return Attribute Atributo computado para o valor do orcamento + */ protected function amount(): Attribute { return Attribute::make( @@ -68,6 +101,11 @@ protected function amount(): Attribute ); } + /** + * Accessor para garantir que o ID do orcamento seja retornado como inteiro. + * + * @return Attribute Atributo computado para o ID do orcamento + */ protected function budgetId(): Attribute { return Attribute::make( @@ -75,6 +113,11 @@ protected function budgetId(): Attribute ); } + /** + * Define os casts de atributos do modelo. + * + * @return array Array de casts de atributos + */ protected function casts(): array { return [ @@ -82,6 +125,11 @@ protected function casts(): array ]; } + /** + * Accessor para garantir que o ID da moeda seja retornado como inteiro. + * + * @return Attribute Atributo computado para o ID da moeda + */ protected function transactionCurrencyId(): Attribute { return Attribute::make( diff --git a/app/Models/AvailableBudget.php b/app/Models/AvailableBudget.php index 576864a2eaa..355e71d0aaf 100644 --- a/app/Models/AvailableBudget.php +++ b/app/Models/AvailableBudget.php @@ -33,6 +33,27 @@ use Illuminate\Database\Eloquent\SoftDeletes; use Symfony\Component\HttpKernel\Exception\NotFoundHttpException; +/** + * Class AvailableBudget + * + * Representa o valor total disponivel para orcamentos em um determinado periodo. + * Define quanto dinheiro o usuario tem disponivel para alocar em orcamentos + * durante um intervalo de datas especifico. + * + * @property int $id Identificador unico + * @property int $user_id ID do usuario proprietario + * @property int $user_group_id ID do grupo de usuarios + * @property int $transaction_currency_id ID da moeda + * @property string $amount Valor disponivel + * @property string $native_amount Valor na moeda nativa + * @property \Carbon\Carbon $start_date Data de inicio do periodo + * @property \Carbon\Carbon $end_date Data de fim do periodo + * @property \Carbon\Carbon $created_at Data de criacao + * @property \Carbon\Carbon $updated_at Data de atualizacao + * @property \Carbon\Carbon|null $deleted_at Data de exclusao (soft delete) + * @property-read User $user Usuario proprietario + * @property-read TransactionCurrency $transactionCurrency Moeda do orcamento disponivel + */ class AvailableBudget extends Model { use ReturnsIntegerIdTrait; @@ -64,16 +85,31 @@ public static function routeBinder(string $value): self throw new NotFoundHttpException(); } + /** + * Retorna o usuario proprietario deste orcamento disponivel. + * + * @return BelongsTo Relacionamento BelongsTo com o modelo User + */ public function user(): BelongsTo { return $this->belongsTo(User::class); } + /** + * Retorna a moeda associada a este orcamento disponivel. + * + * @return BelongsTo Relacionamento BelongsTo com o modelo TransactionCurrency + */ public function transactionCurrency(): BelongsTo { return $this->belongsTo(TransactionCurrency::class); } + /** + * Accessor para garantir que o valor seja retornado como string. + * + * @return Attribute Atributo computado para o valor disponivel + */ protected function amount(): Attribute { return Attribute::make( @@ -81,6 +117,12 @@ protected function amount(): Attribute ); } + /** + * Accessor e mutator para a data de fim do periodo. + * Converte entre Carbon e formato de string para o banco de dados. + * + * @return Attribute Atributo computado para a data de fim + */ protected function endDate(): Attribute { return Attribute::make( @@ -89,6 +131,12 @@ protected function endDate(): Attribute ); } + /** + * Accessor e mutator para a data de inicio do periodo. + * Converte entre Carbon e formato de string para o banco de dados. + * + * @return Attribute Atributo computado para a data de inicio + */ protected function startDate(): Attribute { return Attribute::make( @@ -97,6 +145,11 @@ protected function startDate(): Attribute ); } + /** + * Accessor para garantir que o ID da moeda seja retornado como inteiro. + * + * @return Attribute Atributo computado para o ID da moeda + */ protected function transactionCurrencyId(): Attribute { return Attribute::make( @@ -104,6 +157,11 @@ protected function transactionCurrencyId(): Attribute ); } + /** + * Define os casts de atributos do modelo. + * + * @return array Array de casts de atributos + */ protected function casts(): array { return [ diff --git a/app/Models/Bill.php b/app/Models/Bill.php index a0f59bc9d47..4b21537d043 100644 --- a/app/Models/Bill.php +++ b/app/Models/Bill.php @@ -36,6 +36,38 @@ use Illuminate\Database\Eloquent\SoftDeletes; use Symfony\Component\HttpKernel\Exception\NotFoundHttpException; +/** + * Class Bill + * + * Representa uma conta recorrente ou fatura no sistema Firefly III. + * Faturas sao despesas regulares como aluguel, contas de servicos publicos, + * assinaturas, etc. que ocorrem em intervalos previsíveis. + * + * @property int $id Identificador unico da fatura + * @property int $user_id ID do usuario proprietario + * @property int $user_group_id ID do grupo de usuarios + * @property int $transaction_currency_id ID da moeda + * @property string $name Nome da fatura + * @property string|null $match Padrao de correspondencia para transacoes + * @property string $amount_min Valor minimo esperado + * @property string $amount_max Valor maximo esperado + * @property \Carbon\Carbon $date Data de vencimento + * @property string $repeat_freq Frequencia de repeticao + * @property int $skip Numero de periodos a pular + * @property bool $automatch Se deve corresponder automaticamente + * @property bool $active Se a fatura esta ativa + * @property \Carbon\Carbon|null $end_date Data de fim da fatura + * @property \Carbon\Carbon|null $extension_date Data de extensao + * @property \Carbon\Carbon $created_at Data de criacao + * @property \Carbon\Carbon $updated_at Data de atualizacao + * @property \Carbon\Carbon|null $deleted_at Data de exclusao (soft delete) + * @property-read User $user Usuario proprietario + * @property-read TransactionCurrency $transactionCurrency Moeda da fatura + * @property-read \Illuminate\Support\Collection $transactionJournals Transacoes associadas + * @property-read \Illuminate\Support\Collection $attachments Anexos da fatura + * @property-read \Illuminate\Support\Collection $notes Notas da fatura + * @property-read \Illuminate\Support\Collection $objectGroups Grupos de objetos + */ class Bill extends Model { use ReturnsIntegerIdTrait; @@ -90,18 +122,30 @@ public static function routeBinder(string $value): self throw new NotFoundHttpException(); } + /** + * Retorna o usuario proprietario desta fatura. + * + * @return BelongsTo Relacionamento BelongsTo com o modelo User + */ public function user(): BelongsTo { return $this->belongsTo(User::class); } + /** + * Retorna todos os anexos associados a esta fatura. + * + * @return MorphMany Colecao polimorfica de Attachment + */ public function attachments(): MorphMany { return $this->morphMany(Attachment::class, 'attachable'); } /** - * Get all of the notes. + * Retorna todas as notas associadas a esta fatura. + * + * @return MorphMany Colecao polimorfica de Note */ public function notes(): MorphMany { @@ -109,7 +153,9 @@ public function notes(): MorphMany } /** - * Get all the tags for the post. + * Retorna todos os grupos de objetos aos quais esta fatura pertence. + * + * @return MorphToMany Colecao polimorfica de ObjectGroup */ public function objectGroups(): MorphToMany { @@ -117,7 +163,11 @@ public function objectGroups(): MorphToMany } /** - * @param mixed $value + * Define o valor maximo da fatura como string. + * + * @param mixed $value Valor maximo a ser definido + * + * @return void */ public function setAmountMaxAttribute($value): void { @@ -125,25 +175,41 @@ public function setAmountMaxAttribute($value): void } /** - * @param mixed $value + * Define o valor minimo da fatura como string. + * + * @param mixed $value Valor minimo a ser definido + * + * @return void */ public function setAmountMinAttribute($value): void { $this->attributes['amount_min'] = (string) $value; } + /** + * Retorna a moeda associada a esta fatura. + * + * @return BelongsTo Relacionamento BelongsTo com o modelo TransactionCurrency + */ public function transactionCurrency(): BelongsTo { return $this->belongsTo(TransactionCurrency::class); } + /** + * Retorna todas as transacoes associadas a esta fatura. + * + * @return HasMany Colecao de TransactionJournal relacionadas + */ public function transactionJournals(): HasMany { return $this->hasMany(TransactionJournal::class); } /** - * Get the max amount + * Accessor para garantir que o valor maximo seja retornado como string. + * + * @return Attribute Atributo computado para o valor maximo */ protected function amountMax(): Attribute { @@ -153,7 +219,9 @@ protected function amountMax(): Attribute } /** - * Get the min amount + * Accessor para garantir que o valor minimo seja retornado como string. + * + * @return Attribute Atributo computado para o valor minimo */ protected function amountMin(): Attribute { @@ -162,6 +230,11 @@ protected function amountMin(): Attribute ); } + /** + * Accessor para garantir que a ordem seja retornada como inteiro. + * + * @return Attribute Atributo computado para a ordem de exibicao + */ protected function order(): Attribute { return Attribute::make( @@ -170,7 +243,9 @@ protected function order(): Attribute } /** - * Get the skip + * Accessor para garantir que o numero de periodos a pular seja retornado como inteiro. + * + * @return Attribute Atributo computado para o numero de periodos a pular */ protected function skip(): Attribute { @@ -179,6 +254,11 @@ protected function skip(): Attribute ); } + /** + * Accessor para garantir que o ID da moeda seja retornado como inteiro. + * + * @return Attribute Atributo computado para o ID da moeda + */ protected function transactionCurrencyId(): Attribute { return Attribute::make( @@ -186,6 +266,11 @@ protected function transactionCurrencyId(): Attribute ); } + /** + * Define os casts de atributos do modelo. + * + * @return array Array de casts de atributos + */ protected function casts(): array { return [ diff --git a/app/Models/Budget.php b/app/Models/Budget.php index c5c1c29d465..c1c7f7bda76 100644 --- a/app/Models/Budget.php +++ b/app/Models/Budget.php @@ -35,6 +35,30 @@ use Illuminate\Database\Eloquent\SoftDeletes; use Symfony\Component\HttpKernel\Exception\NotFoundHttpException; +/** + * Class Budget + * + * Representa um orcamento no sistema Firefly III. Orcamentos permitem ao usuario + * definir limites de gastos para categorias especificas de despesas, ajudando + * no controle financeiro e planejamento de gastos. + * + * @property int $id Identificador unico do orcamento + * @property int $user_id ID do usuario proprietario + * @property int $user_group_id ID do grupo de usuarios + * @property string $name Nome do orcamento + * @property bool $active Se o orcamento esta ativo + * @property int $order Ordem de exibicao + * @property \Carbon\Carbon $created_at Data de criacao + * @property \Carbon\Carbon $updated_at Data de atualizacao + * @property \Carbon\Carbon|null $deleted_at Data de exclusao (soft delete) + * @property-read User $user Usuario proprietario + * @property-read \Illuminate\Support\Collection $autoBudgets Auto-orcamentos associados + * @property-read \Illuminate\Support\Collection $budgetlimits Limites de orcamento + * @property-read \Illuminate\Support\Collection $transactionJournals Transacoes associadas + * @property-read \Illuminate\Support\Collection $transactions Transacoes + * @property-read \Illuminate\Support\Collection $attachments Anexos + * @property-read \Illuminate\Support\Collection $notes Notas + */ class Budget extends Model { use ReturnsIntegerIdTrait; @@ -68,44 +92,81 @@ public static function routeBinder(string $value): self throw new NotFoundHttpException(); } + /** + * Retorna o usuario proprietario deste orcamento. + * + * @return BelongsTo Relacionamento BelongsTo com o modelo User + */ public function user(): BelongsTo { return $this->belongsTo(User::class); } + /** + * Retorna todos os anexos associados a este orcamento. + * + * @return MorphMany Colecao polimorfica de Attachment + */ public function attachments(): MorphMany { return $this->morphMany(Attachment::class, 'attachable'); } + /** + * Retorna todos os auto-orcamentos associados a este orcamento. + * + * @return HasMany Colecao de AutoBudget relacionados + */ public function autoBudgets(): HasMany { return $this->hasMany(AutoBudget::class); } + /** + * Retorna todos os limites de orcamento associados. + * + * @return HasMany Colecao de BudgetLimit relacionados + */ public function budgetlimits(): HasMany { return $this->hasMany(BudgetLimit::class); } /** - * Get all of the notes. + * Retorna todas as notas associadas a este orcamento. + * + * @return MorphMany Colecao polimorfica de Note */ public function notes(): MorphMany { return $this->morphMany(Note::class, 'noteable'); } + /** + * Retorna todos os diarios de transacao associados a este orcamento. + * + * @return BelongsToMany Colecao de TransactionJournal relacionados + */ public function transactionJournals(): BelongsToMany { return $this->belongsToMany(TransactionJournal::class, 'budget_transaction_journal', 'budget_id'); } + /** + * Retorna todas as transacoes associadas a este orcamento. + * + * @return BelongsToMany Colecao de Transaction relacionadas + */ public function transactions(): BelongsToMany { return $this->belongsToMany(Transaction::class, 'budget_transaction', 'budget_id'); } + /** + * Accessor para garantir que a ordem seja retornada como inteiro. + * + * @return Attribute Atributo computado para a ordem de exibicao + */ protected function order(): Attribute { return Attribute::make( @@ -113,6 +174,11 @@ protected function order(): Attribute ); } + /** + * Define os casts de atributos do modelo. + * + * @return array Array de casts de atributos + */ protected function casts(): array { return [ diff --git a/app/Models/BudgetLimit.php b/app/Models/BudgetLimit.php index e7270fc7b01..48917c61f3c 100644 --- a/app/Models/BudgetLimit.php +++ b/app/Models/BudgetLimit.php @@ -31,6 +31,26 @@ use Illuminate\Database\Eloquent\Relations\MorphMany; use Symfony\Component\HttpKernel\Exception\NotFoundHttpException; +/** + * Class BudgetLimit + * + * Define um limite de gastos para um orcamento em um periodo especifico. + * Permite ao usuario definir quanto pode gastar em um orcamento durante + * um intervalo de datas, com suporte a diferentes moedas. + * + * @property int $id Identificador unico do limite + * @property int $budget_id ID do orcamento associado + * @property int $transaction_currency_id ID da moeda + * @property string $amount Valor limite + * @property string $native_amount Valor na moeda nativa + * @property \Carbon\Carbon $start_date Data de inicio do periodo + * @property \Carbon\Carbon $end_date Data de fim do periodo + * @property \Carbon\Carbon $created_at Data de criacao + * @property \Carbon\Carbon $updated_at Data de atualizacao + * @property-read Budget $budget Orcamento associado + * @property-read TransactionCurrency $transactionCurrency Moeda do limite + * @property-read \Illuminate\Support\Collection $notes Notas associadas + */ class BudgetLimit extends Model { use ReturnsIntegerIdTrait; @@ -59,26 +79,40 @@ public static function routeBinder(string $value): self throw new NotFoundHttpException(); } + /** + * Retorna o orcamento associado a este limite. + * + * @return BelongsTo Relacionamento BelongsTo com o modelo Budget + */ public function budget(): BelongsTo { return $this->belongsTo(Budget::class); } /** - * Get all the notes. + * Retorna todas as notas associadas a este limite de orcamento. + * + * @return MorphMany Colecao polimorfica de Note */ public function notes(): MorphMany { return $this->morphMany(Note::class, 'noteable'); } + /** + * Retorna a moeda associada a este limite de orcamento. + * + * @return BelongsTo Relacionamento BelongsTo com o modelo TransactionCurrency + */ public function transactionCurrency(): BelongsTo { return $this->belongsTo(TransactionCurrency::class); } /** - * Get the amount + * Accessor para garantir que o valor limite seja retornado como string. + * + * @return Attribute Atributo computado para o valor limite */ protected function amount(): Attribute { @@ -87,6 +121,11 @@ protected function amount(): Attribute ); } + /** + * Accessor para garantir que o ID do orcamento seja retornado como inteiro. + * + * @return Attribute Atributo computado para o ID do orcamento + */ protected function budgetId(): Attribute { return Attribute::make( @@ -94,6 +133,11 @@ protected function budgetId(): Attribute ); } + /** + * Accessor para garantir que o ID da moeda seja retornado como inteiro. + * + * @return Attribute Atributo computado para o ID da moeda + */ protected function transactionCurrencyId(): Attribute { return Attribute::make( @@ -101,6 +145,11 @@ protected function transactionCurrencyId(): Attribute ); } + /** + * Define os casts de atributos do modelo. + * + * @return array Array de casts de atributos + */ protected function casts(): array { return [ diff --git a/app/Models/Category.php b/app/Models/Category.php index 3e50f448c6c..47fed057c73 100644 --- a/app/Models/Category.php +++ b/app/Models/Category.php @@ -34,6 +34,26 @@ use Illuminate\Database\Eloquent\SoftDeletes; use Symfony\Component\HttpKernel\Exception\NotFoundHttpException; +/** + * Class Category + * + * Representa uma categoria de transacao no sistema Firefly III. + * Categorias permitem classificar transacoes para melhor organizacao + * e analise dos gastos e receitas do usuario. + * + * @property int $id Identificador unico da categoria + * @property int $user_id ID do usuario proprietario + * @property int $user_group_id ID do grupo de usuarios + * @property string $name Nome da categoria + * @property \Carbon\Carbon $created_at Data de criacao + * @property \Carbon\Carbon $updated_at Data de atualizacao + * @property \Carbon\Carbon|null $deleted_at Data de exclusao (soft delete) + * @property-read User $user Usuario proprietario + * @property-read \Illuminate\Support\Collection $transactionJournals Transacoes associadas + * @property-read \Illuminate\Support\Collection $transactions Transacoes + * @property-read \Illuminate\Support\Collection $attachments Anexos + * @property-read \Illuminate\Support\Collection $notes Notas + */ class Category extends Model { use ReturnsIntegerIdTrait; @@ -67,34 +87,61 @@ public static function routeBinder(string $value): self throw new NotFoundHttpException(); } + /** + * Retorna o usuario proprietario desta categoria. + * + * @return BelongsTo Relacionamento BelongsTo com o modelo User + */ public function user(): BelongsTo { return $this->belongsTo(User::class); } + /** + * Retorna todos os anexos associados a esta categoria. + * + * @return MorphMany Colecao polimorfica de Attachment + */ public function attachments(): MorphMany { return $this->morphMany(Attachment::class, 'attachable'); } /** - * Get all of the category's notes. + * Retorna todas as notas associadas a esta categoria. + * + * @return MorphMany Colecao polimorfica de Note */ public function notes(): MorphMany { return $this->morphMany(Note::class, 'noteable'); } + /** + * Retorna todos os diarios de transacao associados a esta categoria. + * + * @return BelongsToMany Colecao de TransactionJournal relacionados + */ public function transactionJournals(): BelongsToMany { return $this->belongsToMany(TransactionJournal::class, 'category_transaction_journal', 'category_id'); } + /** + * Retorna todas as transacoes associadas a esta categoria. + * + * @return BelongsToMany Colecao de Transaction relacionadas + */ public function transactions(): BelongsToMany { return $this->belongsToMany(Transaction::class, 'category_transaction', 'category_id'); } + /** + * Define os casts de atributos do modelo. + * + * @return array Array de casts de atributos + */ protected function casts(): array { return [ diff --git a/app/Models/Configuration.php b/app/Models/Configuration.php index 1eeb2007dca..3ee07804a8c 100644 --- a/app/Models/Configuration.php +++ b/app/Models/Configuration.php @@ -31,6 +31,20 @@ use function Safe\json_decode; use function Safe\json_encode; +/** + * Class Configuration + * + * Armazena configuracoes globais do sistema Firefly III. + * Permite armazenar pares chave-valor para configuracoes que + * afetam o comportamento geral da aplicacao. + * + * @property int $id Identificador unico da configuracao + * @property string $name Nome/chave da configuracao + * @property mixed $data Dados da configuracao (armazenados como JSON) + * @property \Carbon\Carbon $created_at Data de criacao + * @property \Carbon\Carbon $updated_at Data de atualizacao + * @property \Carbon\Carbon|null $deleted_at Data de exclusao (soft delete) + */ class Configuration extends Model { use ReturnsIntegerIdTrait; @@ -39,15 +53,21 @@ class Configuration extends Model protected $table = 'configuration'; /** - * TODO can be replaced with native laravel code. + * Accessor e mutator para o campo data. + * Converte automaticamente entre JSON e objetos PHP. * - * @return mixed + * @return Attribute Atributo computado para os dados da configuracao */ protected function data(): Attribute { return Attribute::make(get: fn ($value) => json_decode((string) $value), set: fn ($value) => ['data' => json_encode($value)]); } + /** + * Define os casts de atributos do modelo. + * + * @return array Array de casts de atributos + */ protected function casts(): array { return [ diff --git a/app/Models/CurrencyExchangeRate.php b/app/Models/CurrencyExchangeRate.php index f5117715fe0..1c1f288c07b 100644 --- a/app/Models/CurrencyExchangeRate.php +++ b/app/Models/CurrencyExchangeRate.php @@ -32,6 +32,26 @@ use Illuminate\Database\Eloquent\Relations\BelongsTo; use Illuminate\Database\Eloquent\SoftDeletes; +/** + * Class CurrencyExchangeRate + * + * Armazena taxas de cambio entre moedas para uma data especifica. + * Permite ao sistema converter valores entre diferentes moedas + * usando taxas historicas ou definidas pelo usuario. + * + * @property int $id Identificador unico da taxa de cambio + * @property int $user_id ID do usuario proprietario + * @property int $from_currency_id ID da moeda de origem + * @property int $to_currency_id ID da moeda de destino + * @property \Carbon\Carbon $date Data da taxa de cambio + * @property string $rate Taxa de cambio + * @property string|null $user_rate Taxa definida pelo usuario + * @property \Carbon\Carbon $created_at Data de criacao + * @property \Carbon\Carbon $updated_at Data de atualizacao + * @property-read User $user Usuario proprietario + * @property-read TransactionCurrency $fromCurrency Moeda de origem + * @property-read TransactionCurrency $toCurrency Moeda de destino + */ class CurrencyExchangeRate extends Model { use ReturnsIntegerIdTrait; @@ -39,21 +59,41 @@ class CurrencyExchangeRate extends Model use SoftDeletes; protected $fillable = ['user_id', 'from_currency_id', 'to_currency_id', 'date', 'date_tz', 'rate']; + /** + * Retorna a moeda de origem desta taxa de cambio. + * + * @return BelongsTo Relacionamento BelongsTo com o modelo TransactionCurrency + */ public function fromCurrency(): BelongsTo { return $this->belongsTo(TransactionCurrency::class, 'from_currency_id'); } + /** + * Retorna a moeda de destino desta taxa de cambio. + * + * @return BelongsTo Relacionamento BelongsTo com o modelo TransactionCurrency + */ public function toCurrency(): BelongsTo { return $this->belongsTo(TransactionCurrency::class, 'to_currency_id'); } + /** + * Retorna o usuario proprietario desta taxa de cambio. + * + * @return BelongsTo Relacionamento BelongsTo com o modelo User + */ public function user(): BelongsTo { return $this->belongsTo(User::class); } + /** + * Accessor para garantir que o ID da moeda de origem seja retornado como inteiro. + * + * @return Attribute Atributo computado para o ID da moeda de origem + */ protected function fromCurrencyId(): Attribute { return Attribute::make( @@ -61,6 +101,11 @@ protected function fromCurrencyId(): Attribute ); } + /** + * Accessor para garantir que a taxa de cambio seja retornada como string. + * + * @return Attribute Atributo computado para a taxa de cambio + */ protected function rate(): Attribute { return Attribute::make( @@ -68,6 +113,11 @@ protected function rate(): Attribute ); } + /** + * Accessor para garantir que o ID da moeda de destino seja retornado como inteiro. + * + * @return Attribute Atributo computado para o ID da moeda de destino + */ protected function toCurrencyId(): Attribute { return Attribute::make( @@ -75,6 +125,11 @@ protected function toCurrencyId(): Attribute ); } + /** + * Accessor para garantir que a taxa definida pelo usuario seja retornada como string. + * + * @return Attribute Atributo computado para a taxa do usuario + */ protected function userRate(): Attribute { return Attribute::make( @@ -82,6 +137,11 @@ protected function userRate(): Attribute ); } + /** + * Define os casts de atributos do modelo. + * + * @return array Array de casts de atributos + */ protected function casts(): array { return [ diff --git a/app/Models/GroupMembership.php b/app/Models/GroupMembership.php index 830826967e7..5a1f2d89bc5 100644 --- a/app/Models/GroupMembership.php +++ b/app/Models/GroupMembership.php @@ -31,6 +31,23 @@ use Illuminate\Database\Eloquent\Model; use Illuminate\Database\Eloquent\Relations\BelongsTo; +/** + * Class GroupMembership + * + * Representa a associacao entre um usuario e um grupo de usuarios. + * Define qual papel (role) o usuario tem dentro de um grupo especifico, + * permitindo controle de acesso granular. + * + * @property int $id Identificador unico da associacao + * @property int $user_id ID do usuario + * @property int $user_group_id ID do grupo de usuarios + * @property int $user_role_id ID do papel do usuario no grupo + * @property \Carbon\Carbon $created_at Data de criacao + * @property \Carbon\Carbon $updated_at Data de atualizacao + * @property-read User $user Usuario associado + * @property-read UserGroup $userGroup Grupo de usuarios + * @property-read UserRole $userRole Papel do usuario no grupo + */ class GroupMembership extends Model { use ReturnsIntegerIdTrait; @@ -38,21 +55,41 @@ class GroupMembership extends Model protected $fillable = ['user_id', 'user_group_id', 'user_role_id']; + /** + * Retorna o usuario associado a esta membresia. + * + * @return BelongsTo Relacionamento BelongsTo com o modelo User + */ public function user(): BelongsTo { return $this->belongsTo(User::class); } + /** + * Retorna o grupo de usuarios ao qual esta membresia pertence. + * + * @return BelongsTo Relacionamento BelongsTo com o modelo UserGroup + */ public function userGroup(): BelongsTo { return $this->belongsTo(UserGroup::class); } + /** + * Retorna o papel do usuario neste grupo. + * + * @return BelongsTo Relacionamento BelongsTo com o modelo UserRole + */ public function userRole(): BelongsTo { return $this->belongsTo(UserRole::class); } + /** + * Accessor para garantir que o ID do papel seja retornado como inteiro. + * + * @return Attribute Atributo computado para o ID do papel + */ protected function userRoleId(): Attribute { return Attribute::make( @@ -60,6 +97,11 @@ protected function userRoleId(): Attribute ); } + /** + * Define os casts de atributos do modelo. + * + * @return array Array de casts de atributos + */ protected function casts(): array { return [ diff --git a/app/Models/InvitedUser.php b/app/Models/InvitedUser.php index d543d82c47e..6bc449b2e5f 100644 --- a/app/Models/InvitedUser.php +++ b/app/Models/InvitedUser.php @@ -32,6 +32,24 @@ use Illuminate\Database\Eloquent\Relations\BelongsTo; use Symfony\Component\HttpKernel\Exception\NotFoundHttpException; +/** + * Class InvitedUser + * + * Representa um convite enviado para um novo usuario se juntar ao sistema. + * Armazena informacoes sobre o convite, incluindo codigo de convite, + * data de expiracao e status de resgate. + * + * @property int $id Identificador unico do convite + * @property int $user_id ID do usuario que enviou o convite + * @property int $user_group_id ID do grupo de usuarios + * @property string $email Email do usuario convidado + * @property string $invite_code Codigo unico do convite + * @property \Carbon\Carbon $expires Data de expiracao do convite + * @property bool $redeemed Se o convite foi resgatado + * @property \Carbon\Carbon $created_at Data de criacao + * @property \Carbon\Carbon $updated_at Data de atualizacao + * @property-read User $user Usuario que enviou o convite + */ class InvitedUser extends Model { use ReturnsIntegerIdTrait; @@ -56,11 +74,21 @@ public static function routeBinder(string $value): self throw new NotFoundHttpException(); } + /** + * Retorna o usuario que enviou este convite. + * + * @return BelongsTo Relacionamento BelongsTo com o modelo User + */ public function user(): BelongsTo { return $this->belongsTo(User::class); } + /** + * Define os casts de atributos do modelo. + * + * @return array Array de casts de atributos + */ protected function casts(): array { return [ diff --git a/app/Models/LinkType.php b/app/Models/LinkType.php index f7b662961c5..4c501dda6c1 100644 --- a/app/Models/LinkType.php +++ b/app/Models/LinkType.php @@ -29,6 +29,23 @@ use Illuminate\Database\Eloquent\SoftDeletes; use Symfony\Component\HttpKernel\Exception\NotFoundHttpException; +/** + * Class LinkType + * + * Define tipos de links que podem conectar transacoes entre si. + * Permite criar relacionamentos semanticos entre transacoes, + * como "pago por", "reembolsado por", "relacionado a", etc. + * + * @property int $id Identificador unico do tipo de link + * @property string $name Nome do tipo de link + * @property string $inward Descricao do link na direcao de entrada + * @property string $outward Descricao do link na direcao de saida + * @property bool $editable Se o tipo de link pode ser editado + * @property \Carbon\Carbon $created_at Data de criacao + * @property \Carbon\Carbon $updated_at Data de atualizacao + * @property \Carbon\Carbon|null $deleted_at Data de exclusao (soft delete) + * @property-read \Illuminate\Support\Collection $transactionJournalLinks Links de transacao deste tipo + */ class LinkType extends Model { use ReturnsIntegerIdTrait; @@ -54,11 +71,21 @@ public static function routeBinder(string $value): self throw new NotFoundHttpException(); } + /** + * Retorna todos os links de transacao deste tipo. + * + * @return HasMany Colecao de TransactionJournalLink relacionados + */ public function transactionJournalLinks(): HasMany { return $this->hasMany(TransactionJournalLink::class); } + /** + * Define os casts de atributos do modelo. + * + * @return array Array de casts de atributos + */ protected function casts(): array { return [ diff --git a/app/Models/Location.php b/app/Models/Location.php index ce5744dba9c..ac80a2bf9cb 100644 --- a/app/Models/Location.php +++ b/app/Models/Location.php @@ -30,6 +30,25 @@ use Illuminate\Database\Eloquent\Relations\MorphMany; use Illuminate\Database\Eloquent\Relations\MorphTo; +/** + * Class Location + * + * Representa uma localizacao geografica associada a entidades do sistema. + * Permite armazenar coordenadas de latitude e longitude para contas, + * transacoes e outras entidades que podem ter uma localizacao fisica. + * + * @property int $id Identificador unico da localizacao + * @property int $locatable_id ID da entidade associada + * @property string $locatable_type Tipo da entidade associada + * @property float|null $latitude Latitude da localizacao + * @property float|null $longitude Longitude da localizacao + * @property int|null $zoom_level Nivel de zoom do mapa + * @property \Carbon\Carbon $created_at Data de criacao + * @property \Carbon\Carbon $updated_at Data de atualizacao + * @property-read Model $locatable Entidade associada + * @property-read \Illuminate\Support\Collection $accounts Contas nesta localizacao + * @property-read \Illuminate\Support\Collection $transactionJournals Transacoes nesta localizacao + */ class Location extends Model { use ReturnsIntegerIdTrait; @@ -37,7 +56,12 @@ class Location extends Model protected $fillable = ['locatable_id', 'locatable_type', 'latitude', 'longitude', 'zoom_level']; /** - * Add rules for locations. + * Adiciona regras de validacao para localizacoes. + * Define regras para latitude, longitude e nivel de zoom. + * + * @param array $rules Array de regras existentes + * + * @return array Array de regras com as regras de localizacao adicionadas */ public static function requestRules(array $rules): array { @@ -48,24 +72,41 @@ public static function requestRules(array $rules): array return $rules; } + /** + * Retorna todas as contas associadas a esta localizacao. + * + * @return MorphMany Colecao polimorfica de Account + */ public function accounts(): MorphMany { return $this->morphMany(Account::class, 'locatable'); } /** - * Get all the owning attachable models. + * Retorna a entidade proprietaria desta localizacao. + * + * @return MorphTo Relacionamento polimorfico com a entidade proprietaria */ public function locatable(): MorphTo { return $this->morphTo(); } + /** + * Retorna todos os diarios de transacao associados a esta localizacao. + * + * @return MorphMany Colecao polimorfica de TransactionJournal + */ public function transactionJournals(): MorphMany { return $this->morphMany(TransactionJournal::class, 'locatable'); } + /** + * Accessor para garantir que o ID da entidade localizavel seja retornado como inteiro. + * + * @return Attribute Atributo computado para o ID da entidade + */ protected function locatableId(): Attribute { return Attribute::make( @@ -73,6 +114,11 @@ protected function locatableId(): Attribute ); } + /** + * Define os casts de atributos do modelo. + * + * @return array Array de casts de atributos + */ protected function casts(): array { return [ diff --git a/app/Models/Note.php b/app/Models/Note.php index 6c8c56653e1..5f3445e0e35 100644 --- a/app/Models/Note.php +++ b/app/Models/Note.php @@ -29,6 +29,23 @@ use Illuminate\Database\Eloquent\Relations\MorphTo; use Illuminate\Database\Eloquent\SoftDeletes; +/** + * Class Note + * + * Representa uma nota de texto associada a entidades do sistema. + * Notas podem ser anexadas a transacoes, contas, orcamentos e outras + * entidades para adicionar informacoes contextuais. + * + * @property int $id Identificador unico da nota + * @property int $noteable_id ID da entidade associada + * @property string $noteable_type Tipo da entidade associada + * @property string|null $title Titulo da nota + * @property string|null $text Conteudo da nota + * @property \Carbon\Carbon $created_at Data de criacao + * @property \Carbon\Carbon $updated_at Data de atualizacao + * @property \Carbon\Carbon|null $deleted_at Data de exclusao (soft delete) + * @property-read Model $noteable Entidade associada + */ class Note extends Model { use ReturnsIntegerIdTrait; @@ -37,13 +54,20 @@ class Note extends Model protected $fillable = ['title', 'text', 'noteable_id', 'noteable_type']; /** - * Get all the owning noteable models. + * Retorna a entidade proprietaria desta nota. + * + * @return MorphTo Relacionamento polimorfico com a entidade proprietaria */ public function noteable(): MorphTo { return $this->morphTo(); } + /** + * Accessor para garantir que o ID da entidade seja retornado como inteiro. + * + * @return Attribute Atributo computado para o ID da entidade + */ protected function noteableId(): Attribute { return Attribute::make( @@ -51,6 +75,11 @@ protected function noteableId(): Attribute ); } + /** + * Define os casts de atributos do modelo. + * + * @return array Array de casts de atributos + */ protected function casts(): array { return [ diff --git a/app/Models/ObjectGroup.php b/app/Models/ObjectGroup.php index d7833412fb9..03db6b41a9c 100644 --- a/app/Models/ObjectGroup.php +++ b/app/Models/ObjectGroup.php @@ -33,6 +33,26 @@ use Illuminate\Database\Eloquent\Relations\MorphToMany; use Symfony\Component\HttpKernel\Exception\NotFoundHttpException; +/** + * Class ObjectGroup + * + * Representa um grupo de objetos para organizar entidades relacionadas. + * Permite agrupar contas, faturas e cofrinhos em categorias logicas + * para melhor organizacao e visualizacao. + * + * @property int $id Identificador unico do grupo + * @property int $user_id ID do usuario proprietario + * @property int $user_group_id ID do grupo de usuarios + * @property string $title Titulo do grupo + * @property int $order Ordem de exibicao + * @property \Carbon\Carbon $created_at Data de criacao + * @property \Carbon\Carbon $updated_at Data de atualizacao + * @property \Carbon\Carbon|null $deleted_at Data de exclusao (soft delete) + * @property-read User $user Usuario proprietario + * @property-read \Illuminate\Support\Collection $accounts Contas neste grupo + * @property-read \Illuminate\Support\Collection $bills Faturas neste grupo + * @property-read \Illuminate\Support\Collection $piggyBanks Cofrinhos neste grupo + */ class ObjectGroup extends Model { use ReturnsIntegerIdTrait; @@ -61,35 +81,51 @@ public static function routeBinder(string $value): self throw new NotFoundHttpException(); } + /** + * Retorna o usuario proprietario deste grupo de objetos. + * + * @return BelongsTo Relacionamento BelongsTo com o modelo User + */ public function user(): BelongsTo { return $this->belongsTo(User::class); } /** - * @return MorphToMany + * Retorna todas as contas associadas a este grupo. + * + * @return MorphToMany Colecao polimorfica de Account */ - public function accounts() + public function accounts(): MorphToMany { return $this->morphedByMany(Account::class, 'object_groupable'); } /** - * @return MorphToMany + * Retorna todas as faturas associadas a este grupo. + * + * @return MorphToMany Colecao polimorfica de Bill */ - public function bills() + public function bills(): MorphToMany { return $this->morphedByMany(Bill::class, 'object_groupable'); } /** - * @return MorphToMany + * Retorna todos os cofrinhos associados a este grupo. + * + * @return MorphToMany Colecao polimorfica de PiggyBank */ - public function piggyBanks() + public function piggyBanks(): MorphToMany { return $this->morphedByMany(PiggyBank::class, 'object_groupable'); } + /** + * Accessor para garantir que a ordem seja retornada como inteiro. + * + * @return Attribute Atributo computado para a ordem de exibicao + */ protected function order(): Attribute { return Attribute::make( @@ -97,6 +133,11 @@ protected function order(): Attribute ); } + /** + * Define os casts de atributos do modelo. + * + * @return array Array de casts de atributos + */ protected function casts(): array { return [ diff --git a/app/Models/PiggyBank.php b/app/Models/PiggyBank.php index 08d5a2563d0..2a92e42c22c 100644 --- a/app/Models/PiggyBank.php +++ b/app/Models/PiggyBank.php @@ -34,6 +34,35 @@ use Illuminate\Database\Eloquent\SoftDeletes; use Symfony\Component\HttpKernel\Exception\NotFoundHttpException; +/** + * Class PiggyBank + * + * Representa um cofrinho (meta de poupanca) no sistema Firefly III. + * Cofrinhos permitem ao usuario definir metas de economia com valores + * alvo e datas limite, acompanhando o progresso ao longo do tempo. + * + * @property int $id Identificador unico do cofrinho + * @property int $account_id ID da conta associada + * @property int $transaction_currency_id ID da moeda + * @property string $name Nome do cofrinho + * @property string $target_amount Valor alvo a ser economizado + * @property string|null $native_target_amount Valor alvo na moeda nativa + * @property \Carbon\Carbon|null $start_date Data de inicio + * @property \Carbon\Carbon|null $target_date Data alvo para atingir a meta + * @property int $order Ordem de exibicao + * @property bool $active Se o cofrinho esta ativo + * @property \Carbon\Carbon $created_at Data de criacao + * @property \Carbon\Carbon $updated_at Data de atualizacao + * @property \Carbon\Carbon|null $deleted_at Data de exclusao (soft delete) + * @property-read Account $account Conta associada + * @property-read \Illuminate\Support\Collection $accounts Contas associadas + * @property-read TransactionCurrency $transactionCurrency Moeda do cofrinho + * @property-read \Illuminate\Support\Collection $piggyBankEvents Eventos do cofrinho + * @property-read \Illuminate\Support\Collection $piggyBankRepetitions Repeticoes do cofrinho + * @property-read \Illuminate\Support\Collection $attachments Anexos + * @property-read \Illuminate\Support\Collection $notes Notas + * @property-read \Illuminate\Support\Collection $objectGroups Grupos de objetos + */ class PiggyBank extends Model { use ReturnsIntegerIdTrait; @@ -63,23 +92,40 @@ public static function routeBinder(string $value): self throw new NotFoundHttpException(); } + /** + * Retorna a conta principal associada a este cofrinho. + * + * @return BelongsTo Relacionamento BelongsTo com o modelo Account + */ public function account(): BelongsTo { return $this->belongsTo(Account::class); } + /** + * Retorna todas as contas associadas a este cofrinho com valores atuais. + * + * @return BelongsToMany Colecao de Account com dados de pivot + */ public function accounts(): BelongsToMany { return $this->belongsToMany(Account::class)->withPivot(['current_amount', 'native_current_amount']); } + /** + * Retorna todos os anexos associados a este cofrinho. + * + * @return MorphMany Colecao polimorfica de Attachment + */ public function attachments(): MorphMany { return $this->morphMany(Attachment::class, 'attachable'); } /** - * Get all the piggy bank's notes. + * Retorna todas as notas associadas a este cofrinho. + * + * @return MorphMany Colecao polimorfica de Note */ public function notes(): MorphMany { @@ -87,36 +133,62 @@ public function notes(): MorphMany } /** - * Get all the tags for the post. + * Retorna todos os grupos de objetos aos quais este cofrinho pertence. + * + * @return MorphToMany Colecao polimorfica de ObjectGroup */ public function objectGroups(): MorphToMany { return $this->morphToMany(ObjectGroup::class, 'object_groupable'); } + /** + * Retorna todos os eventos deste cofrinho. + * + * @return HasMany Colecao de PiggyBankEvent relacionados + */ public function piggyBankEvents(): HasMany { return $this->hasMany(PiggyBankEvent::class); } + /** + * Retorna todas as repeticoes deste cofrinho. + * + * @return HasMany Colecao de PiggyBankRepetition relacionadas + */ public function piggyBankRepetitions(): HasMany { return $this->hasMany(PiggyBankRepetition::class); } /** - * @param mixed $value + * Define o valor alvo do cofrinho como string. + * + * @param mixed $value Valor alvo a ser definido + * + * @return void */ public function setTargetAmountAttribute($value): void { $this->attributes['target_amount'] = (string) $value; } + /** + * Retorna a moeda associada a este cofrinho. + * + * @return BelongsTo Relacionamento BelongsTo com o modelo TransactionCurrency + */ public function transactionCurrency(): BelongsTo { return $this->belongsTo(TransactionCurrency::class); } + /** + * Accessor para garantir que o ID da conta seja retornado como inteiro. + * + * @return Attribute Atributo computado para o ID da conta + */ protected function accountId(): Attribute { return Attribute::make( @@ -124,6 +196,11 @@ protected function accountId(): Attribute ); } + /** + * Accessor para garantir que a ordem seja retornada como inteiro. + * + * @return Attribute Atributo computado para a ordem de exibicao + */ protected function order(): Attribute { return Attribute::make( @@ -132,7 +209,9 @@ protected function order(): Attribute } /** - * Get the max amount + * Accessor para garantir que o valor alvo seja retornado como string. + * + * @return Attribute Atributo computado para o valor alvo */ protected function targetAmount(): Attribute { @@ -141,6 +220,11 @@ protected function targetAmount(): Attribute ); } + /** + * Define os casts de atributos do modelo. + * + * @return array Array de casts de atributos + */ protected function casts(): array { return [ diff --git a/app/Models/PiggyBankEvent.php b/app/Models/PiggyBankEvent.php index 733792ffeb4..3be28b4af24 100644 --- a/app/Models/PiggyBankEvent.php +++ b/app/Models/PiggyBankEvent.php @@ -29,6 +29,24 @@ use Illuminate\Database\Eloquent\Model; use Illuminate\Database\Eloquent\Relations\BelongsTo; +/** + * Class PiggyBankEvent + * + * Registra eventos de deposito ou retirada em um cofrinho. + * Cada evento representa uma alteracao no saldo do cofrinho, + * permitindo rastrear o historico de contribuicoes. + * + * @property int $id Identificador unico do evento + * @property int $piggy_bank_id ID do cofrinho associado + * @property int|null $transaction_journal_id ID da transacao associada + * @property \Carbon\Carbon $date Data do evento + * @property string $amount Valor do evento (positivo ou negativo) + * @property string|null $native_amount Valor na moeda nativa + * @property \Carbon\Carbon $created_at Data de criacao + * @property \Carbon\Carbon $updated_at Data de atualizacao + * @property-read PiggyBank $piggyBank Cofrinho associado + * @property-read TransactionJournal|null $transactionJournal Transacao associada + */ class PiggyBankEvent extends Model { use ReturnsIntegerIdTrait; @@ -37,26 +55,42 @@ class PiggyBankEvent extends Model protected $hidden = ['amount_encrypted']; + /** + * Retorna o cofrinho associado a este evento. + * + * @return BelongsTo Relacionamento BelongsTo com o modelo PiggyBank + */ public function piggyBank(): BelongsTo { return $this->belongsTo(PiggyBank::class); } /** - * @param mixed $value + * Define o valor do evento como string. + * + * @param mixed $value Valor a ser definido + * + * @return void */ public function setAmountAttribute($value): void { $this->attributes['amount'] = (string) $value; } + /** + * Retorna a transacao associada a este evento. + * + * @return BelongsTo Relacionamento BelongsTo com o modelo TransactionJournal + */ public function transactionJournal(): BelongsTo { return $this->belongsTo(TransactionJournal::class); } /** - * Get the amount + * Accessor para garantir que o valor seja retornado como string. + * + * @return Attribute Atributo computado para o valor do evento */ protected function amount(): Attribute { @@ -65,6 +99,11 @@ protected function amount(): Attribute ); } + /** + * Accessor para garantir que o ID do cofrinho seja retornado como inteiro. + * + * @return Attribute Atributo computado para o ID do cofrinho + */ protected function piggyBankId(): Attribute { return Attribute::make( @@ -72,6 +111,11 @@ protected function piggyBankId(): Attribute ); } + /** + * Define os casts de atributos do modelo. + * + * @return array Array de casts de atributos + */ protected function casts(): array { return [ diff --git a/app/Models/PiggyBankRepetition.php b/app/Models/PiggyBankRepetition.php index f0f6125b537..634f609ad74 100644 --- a/app/Models/PiggyBankRepetition.php +++ b/app/Models/PiggyBankRepetition.php @@ -32,17 +32,47 @@ use Illuminate\Database\Eloquent\Model; use Illuminate\Database\Eloquent\Relations\BelongsTo; +/** + * Class PiggyBankRepetition + * + * Representa uma repeticao ou ciclo de um cofrinho. + * Permite rastrear o progresso de economia em diferentes periodos, + * armazenando o valor atual economizado para cada ciclo. + * + * @property int $id Identificador unico da repeticao + * @property int $piggy_bank_id ID do cofrinho associado + * @property \Carbon\Carbon|null $start_date Data de inicio do ciclo + * @property \Carbon\Carbon|null $target_date Data alvo do ciclo + * @property string $current_amount Valor atual economizado + * @property \Carbon\Carbon $created_at Data de criacao + * @property \Carbon\Carbon $updated_at Data de atualizacao + * @property-read PiggyBank $piggyBank Cofrinho associado + */ class PiggyBankRepetition extends Model { use ReturnsIntegerIdTrait; protected $fillable = ['piggy_bank_id', 'start_date', 'start_date_tz', 'target_date', 'target_date_tz', 'current_amount']; + /** + * Retorna o cofrinho associado a esta repeticao. + * + * @return BelongsTo Relacionamento BelongsTo com o modelo PiggyBank + */ public function piggyBank(): BelongsTo { return $this->belongsTo(PiggyBank::class); } + /** + * Scope para filtrar repeticoes por datas especificas de inicio e fim. + * + * @param EloquentBuilder $query Query builder + * @param Carbon $start Data de inicio + * @param Carbon $target Data alvo + * + * @return EloquentBuilder Query builder filtrada + */ #[Scope] protected function onDates(EloquentBuilder $query, Carbon $start, Carbon $target): EloquentBuilder { @@ -50,10 +80,16 @@ protected function onDates(EloquentBuilder $query, Carbon $start, Carbon $target } /** - * @return EloquentBuilder + * Scope para filtrar repeticoes relevantes em uma data especifica. + * Retorna repeticoes onde a data esta entre start_date e target_date. + * + * @param EloquentBuilder $query Query builder + * @param Carbon $date Data de referencia + * + * @return EloquentBuilder Query builder filtrada */ #[Scope] - protected function relevantOnDate(EloquentBuilder $query, Carbon $date) + protected function relevantOnDate(EloquentBuilder $query, Carbon $date): EloquentBuilder { return $query->where( static function (EloquentBuilder $q) use ($date): void { @@ -71,7 +107,11 @@ static function (EloquentBuilder $q) use ($date): void { } /** - * @param mixed $value + * Define o valor atual economizado como string. + * + * @param mixed $value Valor a ser definido + * + * @return void */ public function setCurrentAmountAttribute($value): void { @@ -79,7 +119,9 @@ public function setCurrentAmountAttribute($value): void } /** - * Get the amount + * Accessor para garantir que o valor atual seja retornado como string. + * + * @return Attribute Atributo computado para o valor atual */ protected function currentAmount(): Attribute { @@ -88,6 +130,11 @@ protected function currentAmount(): Attribute ); } + /** + * Accessor para garantir que o ID do cofrinho seja retornado como inteiro. + * + * @return Attribute Atributo computado para o ID do cofrinho + */ protected function piggyBankId(): Attribute { return Attribute::make( @@ -95,6 +142,11 @@ protected function piggyBankId(): Attribute ); } + /** + * Define os casts de atributos do modelo. + * + * @return array Array de casts de atributos + */ protected function casts(): array { return [ diff --git a/app/Models/Preference.php b/app/Models/Preference.php index 0e282cf1a53..4d555e82eff 100644 --- a/app/Models/Preference.php +++ b/app/Models/Preference.php @@ -30,6 +30,22 @@ use Illuminate\Database\Eloquent\Relations\BelongsTo; use Symfony\Component\HttpKernel\Exception\NotFoundHttpException; +/** + * Class Preference + * + * Armazena preferencias do usuario no sistema Firefly III. + * Preferencias incluem configuracoes como idioma, moeda padrao, + * formato de data, e outras opcoes personalizaveis. + * + * @property int $id Identificador unico da preferencia + * @property int $user_id ID do usuario proprietario + * @property int|null $user_group_id ID do grupo de usuarios + * @property string $name Nome/chave da preferencia + * @property array $data Dados da preferencia + * @property \Carbon\Carbon $created_at Data de criacao + * @property \Carbon\Carbon $updated_at Data de atualizacao + * @property-read User $user Usuario proprietario + */ class Preference extends Model { use ReturnsIntegerIdTrait; @@ -89,11 +105,21 @@ public static function routeBinder(string $value): self throw new NotFoundHttpException(); } + /** + * Retorna o usuario proprietario desta preferencia. + * + * @return BelongsTo Relacionamento BelongsTo com o modelo User + */ public function user(): BelongsTo { return $this->belongsTo(User::class); } + /** + * Define os casts de atributos do modelo. + * + * @return array Array de casts de atributos + */ protected function casts(): array { return [ diff --git a/app/Models/Recurrence.php b/app/Models/Recurrence.php index 4e369fca275..45aa8254f95 100644 --- a/app/Models/Recurrence.php +++ b/app/Models/Recurrence.php @@ -36,6 +36,36 @@ use Illuminate\Database\Eloquent\SoftDeletes; use Symfony\Component\HttpKernel\Exception\NotFoundHttpException; +/** + * Class Recurrence + * + * Representa uma transacao recorrente no sistema Firefly III. + * Transacoes recorrentes sao criadas automaticamente em intervalos + * definidos, como pagamentos mensais, salarios, etc. + * + * @property int $id Identificador unico da recorrencia + * @property int $user_id ID do usuario proprietario + * @property int $user_group_id ID do grupo de usuarios + * @property int $transaction_type_id ID do tipo de transacao + * @property string $title Titulo da recorrencia + * @property string|null $description Descricao da recorrencia + * @property \Carbon\Carbon $first_date Data da primeira ocorrencia + * @property \Carbon\Carbon|null $repeat_until Data limite para repeticoes + * @property \Carbon\Carbon|null $latest_date Data da ultima ocorrencia + * @property int $repetitions Numero de repeticoes + * @property bool $apply_rules Se deve aplicar regras + * @property bool $active Se a recorrencia esta ativa + * @property \Carbon\Carbon $created_at Data de criacao + * @property \Carbon\Carbon $updated_at Data de atualizacao + * @property \Carbon\Carbon|null $deleted_at Data de exclusao (soft delete) + * @property-read User $user Usuario proprietario + * @property-read TransactionType $transactionType Tipo de transacao + * @property-read \Illuminate\Support\Collection $recurrenceMeta Metadados da recorrencia + * @property-read \Illuminate\Support\Collection $recurrenceRepetitions Repeticoes + * @property-read \Illuminate\Support\Collection $recurrenceTransactions Transacoes + * @property-read \Illuminate\Support\Collection $attachments Anexos + * @property-read \Illuminate\Support\Collection $notes Notas + */ class Recurrence extends Model { use ReturnsIntegerIdTrait; @@ -70,49 +100,91 @@ public static function routeBinder(string $value): self throw new NotFoundHttpException(); } + /** + * Retorna o usuario proprietario desta recorrencia. + * + * @return BelongsTo Relacionamento BelongsTo com o modelo User + */ public function user(): BelongsTo { return $this->belongsTo(User::class); } + /** + * Retorna todos os anexos associados a esta recorrencia. + * + * @return MorphMany Colecao polimorfica de Attachment + */ public function attachments(): MorphMany { return $this->morphMany(Attachment::class, 'attachable'); } /** - * Get all the notes. + * Retorna todas as notas associadas a esta recorrencia. + * + * @return MorphMany Colecao polimorfica de Note */ public function notes(): MorphMany { return $this->morphMany(Note::class, 'noteable'); } + /** + * Retorna todos os metadados desta recorrencia. + * + * @return HasMany Colecao de RecurrenceMeta relacionados + */ public function recurrenceMeta(): HasMany { return $this->hasMany(RecurrenceMeta::class); } + /** + * Retorna todas as repeticoes desta recorrencia. + * + * @return HasMany Colecao de RecurrenceRepetition relacionadas + */ public function recurrenceRepetitions(): HasMany { return $this->hasMany(RecurrenceRepetition::class); } + /** + * Retorna todas as transacoes desta recorrencia. + * + * @return HasMany Colecao de RecurrenceTransaction relacionadas + */ public function recurrenceTransactions(): HasMany { return $this->hasMany(RecurrenceTransaction::class); } + /** + * Retorna a moeda associada a esta recorrencia. + * + * @return BelongsTo Relacionamento BelongsTo com o modelo TransactionCurrency + */ public function transactionCurrency(): BelongsTo { return $this->belongsTo(TransactionCurrency::class); } + /** + * Retorna o tipo de transacao desta recorrencia. + * + * @return BelongsTo Relacionamento BelongsTo com o modelo TransactionType + */ public function transactionType(): BelongsTo { return $this->belongsTo(TransactionType::class); } + /** + * Accessor para garantir que o ID do tipo de transacao seja retornado como inteiro. + * + * @return Attribute Atributo computado para o ID do tipo de transacao + */ protected function transactionTypeId(): Attribute { return Attribute::make( @@ -120,6 +192,11 @@ protected function transactionTypeId(): Attribute ); } + /** + * Define os casts de atributos do modelo. + * + * @return array Array de casts de atributos + */ protected function casts(): array { return [ diff --git a/app/Models/RecurrenceMeta.php b/app/Models/RecurrenceMeta.php index 7430c942f69..8efd2c557b7 100644 --- a/app/Models/RecurrenceMeta.php +++ b/app/Models/RecurrenceMeta.php @@ -30,6 +30,22 @@ use Illuminate\Database\Eloquent\Relations\BelongsTo; use Illuminate\Database\Eloquent\SoftDeletes; +/** + * Class RecurrenceMeta + * + * Armazena metadados adicionais para transacoes recorrentes. + * Permite armazenar informacoes extras como tags, notas e + * outras configuracoes especificas da recorrencia. + * + * @property int $id Identificador unico do metadado + * @property int $recurrence_id ID da recorrencia associada + * @property string $name Nome/chave do metadado + * @property string $value Valor do metadado + * @property \Carbon\Carbon $created_at Data de criacao + * @property \Carbon\Carbon $updated_at Data de atualizacao + * @property \Carbon\Carbon|null $deleted_at Data de exclusao (soft delete) + * @property-read Recurrence $recurrence Recorrencia associada + */ class RecurrenceMeta extends Model { use ReturnsIntegerIdTrait; @@ -39,11 +55,21 @@ class RecurrenceMeta extends Model protected $table = 'recurrences_meta'; + /** + * Retorna a recorrencia associada a este metadado. + * + * @return BelongsTo Relacionamento BelongsTo com o modelo Recurrence + */ public function recurrence(): BelongsTo { return $this->belongsTo(Recurrence::class); } + /** + * Accessor para garantir que o ID da recorrencia seja retornado como inteiro. + * + * @return Attribute Atributo computado para o ID da recorrencia + */ protected function recurrenceId(): Attribute { return Attribute::make( @@ -51,6 +77,11 @@ protected function recurrenceId(): Attribute ); } + /** + * Define os casts de atributos do modelo. + * + * @return array Array de casts de atributos + */ protected function casts(): array { return [ diff --git a/app/Models/RecurrenceRepetition.php b/app/Models/RecurrenceRepetition.php index 93ad02a1968..c8cba1fc147 100644 --- a/app/Models/RecurrenceRepetition.php +++ b/app/Models/RecurrenceRepetition.php @@ -31,6 +31,24 @@ use Illuminate\Database\Eloquent\Relations\BelongsTo; use Illuminate\Database\Eloquent\SoftDeletes; +/** + * Class RecurrenceRepetition + * + * Define como uma transacao recorrente se repete. + * Especifica o tipo de repeticao (diaria, semanal, mensal, etc.), + * o momento da repeticao e como lidar com fins de semana. + * + * @property int $id Identificador unico da repeticao + * @property int $recurrence_id ID da recorrencia associada + * @property string $repetition_type Tipo de repeticao (daily, weekly, monthly, etc.) + * @property string $repetition_moment Momento da repeticao (dia da semana, dia do mes, etc.) + * @property int $repetition_skip Numero de periodos a pular + * @property int $weekend Como lidar com fins de semana + * @property \Carbon\Carbon $created_at Data de criacao + * @property \Carbon\Carbon $updated_at Data de atualizacao + * @property \Carbon\Carbon|null $deleted_at Data de exclusao (soft delete) + * @property-read Recurrence $recurrence Recorrencia associada + */ class RecurrenceRepetition extends Model { use ReturnsIntegerIdTrait; @@ -63,11 +81,21 @@ class RecurrenceRepetition extends Model protected $table = 'recurrences_repetitions'; + /** + * Retorna a recorrencia associada a esta repeticao. + * + * @return BelongsTo Relacionamento BelongsTo com o modelo Recurrence + */ public function recurrence(): BelongsTo { return $this->belongsTo(Recurrence::class); } + /** + * Define os casts de atributos do modelo. + * + * @return array Array de casts de atributos + */ protected function casts(): array { return [ @@ -75,6 +103,11 @@ protected function casts(): array ]; } + /** + * Accessor para garantir que o ID da recorrencia seja retornado como inteiro. + * + * @return Attribute Atributo computado para o ID da recorrencia + */ protected function recurrenceId(): Attribute { return Attribute::make( @@ -82,6 +115,11 @@ protected function recurrenceId(): Attribute ); } + /** + * Accessor para garantir que o numero de periodos a pular seja retornado como inteiro. + * + * @return Attribute Atributo computado para o numero de periodos a pular + */ protected function repetitionSkip(): Attribute { return Attribute::make( @@ -89,6 +127,11 @@ protected function repetitionSkip(): Attribute ); } + /** + * Accessor para garantir que o tratamento de fim de semana seja retornado como inteiro. + * + * @return Attribute Atributo computado para o tratamento de fim de semana + */ protected function weekend(): Attribute { return Attribute::make( diff --git a/app/Models/RecurrenceTransaction.php b/app/Models/RecurrenceTransaction.php index 2c17d52ebbb..780fed73736 100644 --- a/app/Models/RecurrenceTransaction.php +++ b/app/Models/RecurrenceTransaction.php @@ -31,6 +31,32 @@ use Illuminate\Database\Eloquent\Relations\HasMany; use Illuminate\Database\Eloquent\SoftDeletes; +/** + * Class RecurrenceTransaction + * + * Define os detalhes de uma transacao dentro de uma recorrencia. + * Especifica contas de origem e destino, valores, moedas e + * outras informacoes necessarias para criar a transacao. + * + * @property int $id Identificador unico + * @property int $recurrence_id ID da recorrencia + * @property int $transaction_currency_id ID da moeda principal + * @property int|null $foreign_currency_id ID da moeda estrangeira + * @property int $source_id ID da conta de origem + * @property int $destination_id ID da conta de destino + * @property string $amount Valor da transacao + * @property string|null $foreign_amount Valor em moeda estrangeira + * @property string $description Descricao da transacao + * @property \Carbon\Carbon $created_at Data de criacao + * @property \Carbon\Carbon $updated_at Data de atualizacao + * @property \Carbon\Carbon|null $deleted_at Data de exclusao (soft delete) + * @property-read Recurrence $recurrence Recorrencia associada + * @property-read Account $sourceAccount Conta de origem + * @property-read Account $destinationAccount Conta de destino + * @property-read TransactionCurrency $transactionCurrency Moeda principal + * @property-read TransactionCurrency|null $foreignCurrency Moeda estrangeira + * @property-read \Illuminate\Support\Collection $recurrenceTransactionMeta Metadados + */ class RecurrenceTransaction extends Model { use ReturnsIntegerIdTrait; @@ -50,41 +76,81 @@ class RecurrenceTransaction extends Model protected $table = 'recurrences_transactions'; + /** + * Retorna a conta de destino desta transacao recorrente. + * + * @return BelongsTo Relacionamento BelongsTo com o modelo Account + */ public function destinationAccount(): BelongsTo { return $this->belongsTo(Account::class, 'destination_id'); } + /** + * Retorna a moeda estrangeira desta transacao recorrente. + * + * @return BelongsTo Relacionamento BelongsTo com o modelo TransactionCurrency + */ public function foreignCurrency(): BelongsTo { return $this->belongsTo(TransactionCurrency::class); } + /** + * Retorna a recorrencia a qual esta transacao pertence. + * + * @return BelongsTo Relacionamento BelongsTo com o modelo Recurrence + */ public function recurrence(): BelongsTo { return $this->belongsTo(Recurrence::class); } + /** + * Retorna todos os metadados desta transacao recorrente. + * + * @return HasMany Colecao de RecurrenceTransactionMeta relacionados + */ public function recurrenceTransactionMeta(): HasMany { return $this->hasMany(RecurrenceTransactionMeta::class, 'rt_id'); } + /** + * Retorna a conta de origem desta transacao recorrente. + * + * @return BelongsTo Relacionamento BelongsTo com o modelo Account + */ public function sourceAccount(): BelongsTo { return $this->belongsTo(Account::class, 'source_id'); } + /** + * Retorna a moeda principal desta transacao recorrente. + * + * @return BelongsTo Relacionamento BelongsTo com o modelo TransactionCurrency + */ public function transactionCurrency(): BelongsTo { return $this->belongsTo(TransactionCurrency::class); } + /** + * Retorna o tipo de transacao desta transacao recorrente. + * + * @return BelongsTo Relacionamento BelongsTo com o modelo TransactionType + */ public function transactionType(): BelongsTo { return $this->belongsTo(TransactionType::class); } + /** + * Accessor para garantir que o valor seja retornado como string. + * + * @return Attribute Atributo computado para o valor da transacao + */ protected function amount(): Attribute { return Attribute::make( @@ -92,6 +158,11 @@ protected function amount(): Attribute ); } + /** + * Accessor para garantir que o ID da conta de destino seja retornado como inteiro. + * + * @return Attribute Atributo computado para o ID da conta de destino + */ protected function destinationId(): Attribute { return Attribute::make( @@ -99,6 +170,11 @@ protected function destinationId(): Attribute ); } + /** + * Accessor para garantir que o valor em moeda estrangeira seja retornado como string. + * + * @return Attribute Atributo computado para o valor em moeda estrangeira + */ protected function foreignAmount(): Attribute { return Attribute::make( @@ -106,6 +182,11 @@ protected function foreignAmount(): Attribute ); } + /** + * Accessor para garantir que o ID da recorrencia seja retornado como inteiro. + * + * @return Attribute Atributo computado para o ID da recorrencia + */ protected function recurrenceId(): Attribute { return Attribute::make( @@ -113,6 +194,11 @@ protected function recurrenceId(): Attribute ); } + /** + * Accessor para garantir que o ID da conta de origem seja retornado como inteiro. + * + * @return Attribute Atributo computado para o ID da conta de origem + */ protected function sourceId(): Attribute { return Attribute::make( @@ -120,6 +206,11 @@ protected function sourceId(): Attribute ); } + /** + * Accessor para garantir que o ID da moeda seja retornado como inteiro. + * + * @return Attribute Atributo computado para o ID da moeda + */ protected function transactionCurrencyId(): Attribute { return Attribute::make( @@ -127,6 +218,11 @@ protected function transactionCurrencyId(): Attribute ); } + /** + * Accessor para garantir que o ID do usuario seja retornado como inteiro. + * + * @return Attribute Atributo computado para o ID do usuario + */ protected function userId(): Attribute { return Attribute::make( @@ -134,6 +230,11 @@ protected function userId(): Attribute ); } + /** + * Define os casts de atributos do modelo. + * + * @return array Array de casts de atributos + */ protected function casts(): array { return [ diff --git a/app/Models/RecurrenceTransactionMeta.php b/app/Models/RecurrenceTransactionMeta.php index a334b9c433d..e8f77b89223 100644 --- a/app/Models/RecurrenceTransactionMeta.php +++ b/app/Models/RecurrenceTransactionMeta.php @@ -30,6 +30,22 @@ use Illuminate\Database\Eloquent\Relations\BelongsTo; use Illuminate\Database\Eloquent\SoftDeletes; +/** + * Class RecurrenceTransactionMeta + * + * Armazena metadados adicionais para transacoes de recorrencias. + * Permite armazenar informacoes extras como categorias, orcamentos, + * tags e outras configuracoes especificas da transacao recorrente. + * + * @property int $id Identificador unico do metadado + * @property int $rt_id ID da transacao recorrente associada + * @property string $name Nome/chave do metadado + * @property string $value Valor do metadado + * @property \Carbon\Carbon $created_at Data de criacao + * @property \Carbon\Carbon $updated_at Data de atualizacao + * @property \Carbon\Carbon|null $deleted_at Data de exclusao (soft delete) + * @property-read RecurrenceTransaction $recurrenceTransaction Transacao recorrente associada + */ class RecurrenceTransactionMeta extends Model { use ReturnsIntegerIdTrait; @@ -39,11 +55,21 @@ class RecurrenceTransactionMeta extends Model protected $table = 'rt_meta'; + /** + * Retorna a transacao recorrente associada a este metadado. + * + * @return BelongsTo Relacionamento BelongsTo com o modelo RecurrenceTransaction + */ public function recurrenceTransaction(): BelongsTo { return $this->belongsTo(RecurrenceTransaction::class, 'rt_id'); } + /** + * Accessor para garantir que o ID da transacao recorrente seja retornado como inteiro. + * + * @return Attribute Atributo computado para o ID da transacao recorrente + */ protected function rtId(): Attribute { return Attribute::make( @@ -51,6 +77,11 @@ protected function rtId(): Attribute ); } + /** + * Define os casts de atributos do modelo. + * + * @return array Array de casts de atributos + */ protected function casts(): array { return [ diff --git a/app/Models/Role.php b/app/Models/Role.php index b1b3476ca48..4e50822b888 100644 --- a/app/Models/Role.php +++ b/app/Models/Role.php @@ -28,17 +28,42 @@ use Illuminate\Database\Eloquent\Model; use Illuminate\Database\Eloquent\Relations\BelongsToMany; +/** + * Class Role + * + * Representa um papel (role) de usuario no sistema Firefly III. + * Papeis definem permissoes e niveis de acesso, como administrador, + * usuario padrao, etc. + * + * @property int $id Identificador unico do papel + * @property string $name Nome do papel + * @property string|null $display_name Nome de exibicao do papel + * @property string|null $description Descricao do papel + * @property \Carbon\Carbon $created_at Data de criacao + * @property \Carbon\Carbon $updated_at Data de atualizacao + * @property-read \Illuminate\Support\Collection $users Usuarios com este papel + */ class Role extends Model { use ReturnsIntegerIdTrait; protected $fillable = ['name', 'display_name', 'description']; + /** + * Retorna todos os usuarios que possuem este papel. + * + * @return BelongsToMany Colecao de User relacionados + */ public function users(): BelongsToMany { return $this->belongsToMany(User::class); } + /** + * Define os casts de atributos do modelo. + * + * @return array Array de casts de atributos + */ protected function casts(): array { return [ diff --git a/app/Models/Rule.php b/app/Models/Rule.php index 5308eae4d51..b956c2eebf9 100644 --- a/app/Models/Rule.php +++ b/app/Models/Rule.php @@ -33,6 +33,32 @@ use Illuminate\Database\Eloquent\SoftDeletes; use Symfony\Component\HttpKernel\Exception\NotFoundHttpException; +/** + * Class Rule + * + * Representa uma regra de automacao no sistema Firefly III. + * Regras permitem automatizar acoes em transacoes com base em + * gatilhos (triggers) e acoes definidas pelo usuario. + * + * @property int $id Identificador unico da regra + * @property int $user_id ID do usuario proprietario + * @property int $user_group_id ID do grupo de usuarios + * @property int $rule_group_id ID do grupo de regras + * @property string $title Titulo da regra + * @property string|null $description Descricao da regra + * @property int $order Ordem de execucao + * @property bool $active Se a regra esta ativa + * @property bool $strict Se todos os gatilhos devem corresponder + * @property bool $stop_processing Se deve parar o processamento apos esta regra + * @property \Carbon\Carbon $created_at Data de criacao + * @property \Carbon\Carbon $updated_at Data de atualizacao + * @property \Carbon\Carbon|null $deleted_at Data de exclusao (soft delete) + * @property-read User $user Usuario proprietario + * @property-read RuleGroup $ruleGroup Grupo de regras + * @property-read UserGroup $userGroup Grupo de usuarios + * @property-read \Illuminate\Support\Collection $ruleActions Acoes da regra + * @property-read \Illuminate\Support\Collection $ruleTriggers Gatilhos da regra + */ class Rule extends Model { use ReturnsIntegerIdTrait; @@ -64,36 +90,71 @@ public static function routeBinder(string $value): self throw new NotFoundHttpException(); } + /** + * Retorna o usuario proprietario desta regra. + * + * @return BelongsTo Relacionamento BelongsTo com o modelo User + */ public function user(): BelongsTo { return $this->belongsTo(User::class); } + /** + * Retorna todas as acoes desta regra. + * + * @return HasMany Colecao de RuleAction relacionadas + */ public function ruleActions(): HasMany { return $this->hasMany(RuleAction::class); } + /** + * Retorna o grupo de regras ao qual esta regra pertence. + * + * @return BelongsTo Relacionamento BelongsTo com o modelo RuleGroup + */ public function ruleGroup(): BelongsTo { return $this->belongsTo(RuleGroup::class); } + /** + * Retorna todos os gatilhos desta regra. + * + * @return HasMany Colecao de RuleTrigger relacionados + */ public function ruleTriggers(): HasMany { return $this->hasMany(RuleTrigger::class); } + /** + * Mutator para escapar HTML na descricao da regra. + * + * @return Attribute Atributo computado para a descricao + */ protected function description(): Attribute { return Attribute::make(set: fn ($value) => ['description' => e($value)]); } + /** + * Retorna o grupo de usuarios ao qual esta regra pertence. + * + * @return BelongsTo Relacionamento BelongsTo com o modelo UserGroup + */ public function userGroup(): BelongsTo { return $this->belongsTo(UserGroup::class); } + /** + * Accessor para garantir que a ordem seja retornada como inteiro. + * + * @return Attribute Atributo computado para a ordem de execucao + */ protected function order(): Attribute { return Attribute::make( @@ -101,6 +162,11 @@ protected function order(): Attribute ); } + /** + * Accessor para garantir que o ID do grupo de regras seja retornado como inteiro. + * + * @return Attribute Atributo computado para o ID do grupo de regras + */ protected function ruleGroupId(): Attribute { return Attribute::make( @@ -108,6 +174,11 @@ protected function ruleGroupId(): Attribute ); } + /** + * Define os casts de atributos do modelo. + * + * @return array Array de casts de atributos + */ protected function casts(): array { return [ diff --git a/app/Models/RuleAction.php b/app/Models/RuleAction.php index 60ebc7254f5..d0efd374059 100644 --- a/app/Models/RuleAction.php +++ b/app/Models/RuleAction.php @@ -31,12 +31,37 @@ use Illuminate\Support\Facades\Log; use Symfony\Component\ExpressionLanguage\SyntaxError; +/** + * Class RuleAction + * + * Representa uma acao a ser executada quando uma regra e acionada. + * Acoes podem modificar transacoes, como alterar descricao, categoria, + * tags, contas, e outros atributos. + * + * @property int $id Identificador unico da acao + * @property int $rule_id ID da regra associada + * @property string $action_type Tipo da acao (ex: set_category, add_tag) + * @property string $action_value Valor da acao + * @property int $order Ordem de execucao + * @property bool $active Se a acao esta ativa + * @property bool $stop_processing Se deve parar o processamento apos esta acao + * @property \Carbon\Carbon $created_at Data de criacao + * @property \Carbon\Carbon $updated_at Data de atualizacao + * @property-read Rule $rule Regra associada + */ class RuleAction extends Model { use ReturnsIntegerIdTrait; protected $fillable = ['rule_id', 'action_type', 'action_value', 'order', 'active', 'stop_processing']; + /** + * Obtem o valor da acao, processando expressoes se o motor de expressoes estiver habilitado. + * + * @param array $journal Dados do diario de transacao para avaliacao de expressoes + * + * @return string Valor da acao processado + */ public function getValue(array $journal): string { if (false === config('firefly.feature_flags.expression_engine')) { @@ -45,7 +70,6 @@ public function getValue(array $journal): string return (string) $this->action_value; } if (true === config('firefly.feature_flags.expression_engine') && str_starts_with($this->action_value, '\=')) { - // return literal string. return substr($this->action_value, 1); } $expr = new ActionExpression($this->action_value); @@ -61,11 +85,21 @@ public function getValue(array $journal): string return $result; } + /** + * Retorna a regra associada a esta acao. + * + * @return BelongsTo Relacionamento BelongsTo com o modelo Rule + */ public function rule(): BelongsTo { return $this->belongsTo(Rule::class); } + /** + * Accessor para garantir que a ordem seja retornada como inteiro. + * + * @return Attribute Atributo computado para a ordem de execucao + */ protected function order(): Attribute { return Attribute::make( @@ -73,6 +107,11 @@ protected function order(): Attribute ); } + /** + * Accessor para garantir que o ID da regra seja retornado como inteiro. + * + * @return Attribute Atributo computado para o ID da regra + */ protected function ruleId(): Attribute { return Attribute::make( @@ -80,6 +119,11 @@ protected function ruleId(): Attribute ); } + /** + * Define os casts de atributos do modelo. + * + * @return array Array de casts de atributos + */ protected function casts(): array { return [ diff --git a/app/Models/RuleGroup.php b/app/Models/RuleGroup.php index 1a25031a7ee..5720ba42cf5 100644 --- a/app/Models/RuleGroup.php +++ b/app/Models/RuleGroup.php @@ -33,6 +33,27 @@ use Illuminate\Database\Eloquent\SoftDeletes; use Symfony\Component\HttpKernel\Exception\NotFoundHttpException; +/** + * Class RuleGroup + * + * Representa um grupo de regras no sistema Firefly III. + * Grupos de regras permitem organizar regras relacionadas e + * controlar a ordem de execucao das regras. + * + * @property int $id Identificador unico do grupo + * @property int $user_id ID do usuario proprietario + * @property int $user_group_id ID do grupo de usuarios + * @property string $title Titulo do grupo de regras + * @property string|null $description Descricao do grupo + * @property int $order Ordem de execucao + * @property bool $active Se o grupo esta ativo + * @property bool $stop_processing Se deve parar o processamento apos este grupo + * @property \Carbon\Carbon $created_at Data de criacao + * @property \Carbon\Carbon $updated_at Data de atualizacao + * @property \Carbon\Carbon|null $deleted_at Data de exclusao (soft delete) + * @property-read User $user Usuario proprietario + * @property-read \Illuminate\Support\Collection $rules Regras neste grupo + */ class RuleGroup extends Model { use ReturnsIntegerIdTrait; @@ -64,16 +85,31 @@ public static function routeBinder(string $value): self throw new NotFoundHttpException(); } + /** + * Retorna o usuario proprietario deste grupo de regras. + * + * @return BelongsTo Relacionamento BelongsTo com o modelo User + */ public function user(): BelongsTo { return $this->belongsTo(User::class); } + /** + * Retorna todas as regras neste grupo. + * + * @return HasMany Colecao de Rule relacionadas + */ public function rules(): HasMany { return $this->hasMany(Rule::class); } + /** + * Accessor para garantir que a ordem seja retornada como inteiro. + * + * @return Attribute Atributo computado para a ordem de execucao + */ protected function order(): Attribute { return Attribute::make( @@ -81,6 +117,11 @@ protected function order(): Attribute ); } + /** + * Define os casts de atributos do modelo. + * + * @return array Array de casts de atributos + */ protected function casts(): array { return [ diff --git a/app/Models/RuleTrigger.php b/app/Models/RuleTrigger.php index 5c9f4fca2e1..d2a625841c4 100644 --- a/app/Models/RuleTrigger.php +++ b/app/Models/RuleTrigger.php @@ -28,17 +28,45 @@ use Illuminate\Database\Eloquent\Model; use Illuminate\Database\Eloquent\Relations\BelongsTo; +/** + * Class RuleTrigger + * + * Representa um gatilho (trigger) que ativa uma regra. + * Gatilhos definem condicoes que devem ser atendidas para + * que as acoes da regra sejam executadas. + * + * @property int $id Identificador unico do gatilho + * @property int $rule_id ID da regra associada + * @property string $trigger_type Tipo do gatilho (ex: description_contains) + * @property string $trigger_value Valor do gatilho + * @property int $order Ordem de avaliacao + * @property bool $active Se o gatilho esta ativo + * @property bool $stop_processing Se deve parar o processamento apos este gatilho + * @property \Carbon\Carbon $created_at Data de criacao + * @property \Carbon\Carbon $updated_at Data de atualizacao + * @property-read Rule $rule Regra associada + */ class RuleTrigger extends Model { use ReturnsIntegerIdTrait; protected $fillable = ['rule_id', 'trigger_type', 'trigger_value', 'order', 'active', 'stop_processing']; + /** + * Retorna a regra associada a este gatilho. + * + * @return BelongsTo Relacionamento BelongsTo com o modelo Rule + */ public function rule(): BelongsTo { return $this->belongsTo(Rule::class); } + /** + * Accessor para garantir que a ordem seja retornada como inteiro. + * + * @return Attribute Atributo computado para a ordem de avaliacao + */ protected function order(): Attribute { return Attribute::make( @@ -46,6 +74,11 @@ protected function order(): Attribute ); } + /** + * Accessor para garantir que o ID da regra seja retornado como inteiro. + * + * @return Attribute Atributo computado para o ID da regra + */ protected function ruleId(): Attribute { return Attribute::make( @@ -53,6 +86,11 @@ protected function ruleId(): Attribute ); } + /** + * Define os casts de atributos do modelo. + * + * @return array Array de casts de atributos + */ protected function casts(): array { return [ diff --git a/app/Models/Tag.php b/app/Models/Tag.php index 3af4799730f..51c7351ae71 100644 --- a/app/Models/Tag.php +++ b/app/Models/Tag.php @@ -34,6 +34,28 @@ use Illuminate\Database\Eloquent\SoftDeletes; use Symfony\Component\HttpKernel\Exception\NotFoundHttpException; +/** + * Class Tag + * + * Representa uma tag para classificar transacoes no sistema Firefly III. + * Tags permitem ao usuario adicionar marcadores personalizados as transacoes + * para facilitar a organizacao e busca. + * + * @property int $id Identificador unico da tag + * @property int $user_id ID do usuario proprietario + * @property int $user_group_id ID do grupo de usuarios + * @property string $tag Nome da tag + * @property string|null $description Descricao da tag + * @property string|null $tag_mode Modo da tag + * @property \Carbon\Carbon|null $date Data associada a tag + * @property \Carbon\Carbon $created_at Data de criacao + * @property \Carbon\Carbon $updated_at Data de atualizacao + * @property \Carbon\Carbon|null $deleted_at Data de exclusao (soft delete) + * @property-read User $user Usuario proprietario + * @property-read \Illuminate\Support\Collection $transactionJournals Transacoes com esta tag + * @property-read \Illuminate\Support\Collection $attachments Anexos + * @property-read \Illuminate\Support\Collection $locations Localizacoes + */ class Tag extends Model { use ReturnsIntegerIdTrait; @@ -67,26 +89,51 @@ public static function routeBinder(string $value): self throw new NotFoundHttpException(); } + /** + * Retorna o usuario proprietario desta tag. + * + * @return BelongsTo Relacionamento BelongsTo com o modelo User + */ public function user(): BelongsTo { return $this->belongsTo(User::class); } + /** + * Retorna todos os anexos associados a esta tag. + * + * @return MorphMany Colecao polimorfica de Attachment + */ public function attachments(): MorphMany { return $this->morphMany(Attachment::class, 'attachable'); } + /** + * Retorna todas as localizacoes associadas a esta tag. + * + * @return MorphMany Colecao polimorfica de Location + */ public function locations(): MorphMany { return $this->morphMany(Location::class, 'locatable'); } + /** + * Retorna todos os diarios de transacao com esta tag. + * + * @return BelongsToMany Colecao de TransactionJournal relacionados + */ public function transactionJournals(): BelongsToMany { return $this->belongsToMany(TransactionJournal::class); } + /** + * Define os casts de atributos do modelo. + * + * @return array Array de casts de atributos + */ protected function casts(): array { return [ diff --git a/app/Models/Transaction.php b/app/Models/Transaction.php index a563e3656ff..87245fb64fa 100644 --- a/app/Models/Transaction.php +++ b/app/Models/Transaction.php @@ -34,6 +34,34 @@ use Illuminate\Database\Eloquent\Relations\BelongsToMany; use Illuminate\Database\Eloquent\SoftDeletes; +/** + * Class Transaction + * + * Representa uma transacao financeira individual no sistema Firefly III. + * Cada transacao pertence a um diario de transacao (TransactionJournal) e + * esta associada a uma conta. Transacoes podem ter valores em moeda estrangeira. + * + * @property int $id Identificador unico da transacao + * @property int $account_id ID da conta associada + * @property int $transaction_journal_id ID do diario de transacao + * @property int $transaction_currency_id ID da moeda principal + * @property int|null $foreign_currency_id ID da moeda estrangeira + * @property string $description Descricao da transacao + * @property string $amount Valor da transacao + * @property string|null $foreign_amount Valor em moeda estrangeira + * @property string $native_amount Valor na moeda nativa + * @property int $identifier Identificador sequencial + * @property bool $reconciled Se a transacao foi reconciliada + * @property \Carbon\Carbon $created_at Data de criacao + * @property \Carbon\Carbon $updated_at Data de atualizacao + * @property \Carbon\Carbon|null $deleted_at Data de exclusao (soft delete) + * @property-read Account $account Conta associada + * @property-read TransactionJournal $transactionJournal Diario de transacao + * @property-read TransactionCurrency $transactionCurrency Moeda principal + * @property-read TransactionCurrency|null $foreignCurrency Moeda estrangeira + * @property-read \Illuminate\Support\Collection $budgets Orcamentos associados + * @property-read \Illuminate\Support\Collection $categories Categorias associadas + */ class Transaction extends Model { use HasFactory; @@ -143,23 +171,42 @@ protected function transactionTypes(Builder $query, array $types): void } /** - * @param mixed $value + * Define o valor da transacao como string. + * + * @param mixed $value Valor a ser definido + * + * @return void */ public function setAmountAttribute($value): void { $this->attributes['amount'] = (string) $value; } + /** + * Retorna a moeda principal desta transacao. + * + * @return BelongsTo Relacionamento BelongsTo com o modelo TransactionCurrency + */ public function transactionCurrency(): BelongsTo { return $this->belongsTo(TransactionCurrency::class); } + /** + * Retorna o diario de transacao ao qual esta transacao pertence. + * + * @return BelongsTo Relacionamento BelongsTo com o modelo TransactionJournal + */ public function transactionJournal(): BelongsTo { return $this->belongsTo(TransactionJournal::class); } + /** + * Accessor para garantir que o ID da conta seja retornado como inteiro. + * + * @return Attribute Atributo computado para o ID da conta + */ protected function accountId(): Attribute { return Attribute::make( @@ -168,7 +215,9 @@ protected function accountId(): Attribute } /** - * Get the amount + * Accessor para garantir que o valor seja retornado como string. + * + * @return Attribute Atributo computado para o valor da transacao */ protected function amount(): Attribute { @@ -177,6 +226,11 @@ protected function amount(): Attribute ); } + /** + * Accessor para verificar se o saldo precisa ser recalculado. + * + * @return Attribute Atributo computado para o estado de saldo sujo + */ protected function balanceDirty(): Attribute { return Attribute::make( @@ -185,7 +239,9 @@ protected function balanceDirty(): Attribute } /** - * Get the foreign amount + * Accessor para garantir que o valor em moeda estrangeira seja retornado como string. + * + * @return Attribute Atributo computado para o valor em moeda estrangeira */ protected function foreignAmount(): Attribute { @@ -194,6 +250,11 @@ protected function foreignAmount(): Attribute ); } + /** + * Accessor para garantir que o ID do diario de transacao seja retornado como inteiro. + * + * @return Attribute Atributo computado para o ID do diario + */ protected function transactionJournalId(): Attribute { return Attribute::make( @@ -201,6 +262,11 @@ protected function transactionJournalId(): Attribute ); } + /** + * Define os casts de atributos do modelo. + * + * @return array Array de casts de atributos + */ protected function casts(): array { return [ @@ -208,7 +274,7 @@ protected function casts(): array 'updated_at' => 'datetime', 'deleted_at' => 'datetime', 'identifier' => 'int', - 'encrypted' => 'boolean', // model does not have these fields though + 'encrypted' => 'boolean', 'bill_name_encrypted' => 'boolean', 'reconciled' => 'boolean', 'balance_dirty' => 'boolean', diff --git a/app/Models/TransactionCurrency.php b/app/Models/TransactionCurrency.php index 83dfd6bfe03..7c2fe826479 100644 --- a/app/Models/TransactionCurrency.php +++ b/app/Models/TransactionCurrency.php @@ -32,6 +32,30 @@ use Illuminate\Database\Eloquent\SoftDeletes; use Symfony\Component\HttpKernel\Exception\NotFoundHttpException; +/** + * Class TransactionCurrency + * + * Representa uma moeda no sistema Firefly III. + * Moedas sao usadas para definir valores monetarios em transacoes, + * contas, orcamentos e outros elementos financeiros. + * + * @property int $id Identificador unico da moeda + * @property string $code Codigo ISO da moeda (ex: USD, EUR, BRL) + * @property string $name Nome da moeda + * @property string $symbol Simbolo da moeda (ex: $, R$) + * @property int $decimal_places Numero de casas decimais + * @property bool $enabled Se a moeda esta habilitada + * @property \Carbon\Carbon $created_at Data de criacao + * @property \Carbon\Carbon $updated_at Data de atualizacao + * @property \Carbon\Carbon|null $deleted_at Data de exclusao (soft delete) + * @property bool|null $userGroupEnabled Se esta habilitada para o grupo do usuario + * @property bool|null $userGroupNative Se e a moeda nativa do grupo + * @property-read \Illuminate\Support\Collection $budgetLimits Limites de orcamento nesta moeda + * @property-read \Illuminate\Support\Collection $transactionJournals Transacoes nesta moeda + * @property-read \Illuminate\Support\Collection $transactions Transacoes + * @property-read \Illuminate\Support\Collection $userGroups Grupos de usuarios + * @property-read \Illuminate\Support\Collection $users Usuarios + */ class TransactionCurrency extends Model { use ReturnsIntegerIdTrait; @@ -62,6 +86,13 @@ public static function routeBinder(string $value): self throw new NotFoundHttpException(); } + /** + * Atualiza as propriedades de habilitacao da moeda para um usuario especifico. + * + * @param User $user Usuario para verificar + * + * @return void + */ public function refreshForUser(User $user): void { $current = $user->userGroup->currencies()->where('transaction_currencies.id', $this->id)->first(); @@ -70,23 +101,40 @@ public function refreshForUser(User $user): void $this->userGroupEnabled = null !== $current; } + /** + * Retorna todos os limites de orcamento nesta moeda. + * + * @return HasMany Colecao de BudgetLimit relacionados + */ public function budgetLimits(): HasMany { return $this->hasMany(BudgetLimit::class); } + /** + * Retorna todos os diarios de transacao nesta moeda. + * + * @return HasMany Colecao de TransactionJournal relacionados + */ public function transactionJournals(): HasMany { return $this->hasMany(TransactionJournal::class); } + /** + * Retorna todas as transacoes nesta moeda. + * + * @return HasMany Colecao de Transaction relacionadas + */ public function transactions(): HasMany { return $this->hasMany(Transaction::class); } /** - * Link to user groups + * Retorna todos os grupos de usuarios que usam esta moeda. + * + * @return BelongsToMany Colecao de UserGroup relacionados */ public function userGroups(): BelongsToMany { @@ -94,13 +142,20 @@ public function userGroups(): BelongsToMany } /** - * Link to users + * Retorna todos os usuarios que usam esta moeda. + * + * @return BelongsToMany Colecao de User relacionados */ public function users(): BelongsToMany { return $this->belongsToMany(User::class)->withTimestamps()->withPivot('user_default'); } + /** + * Accessor para garantir que o numero de casas decimais seja retornado como inteiro. + * + * @return Attribute Atributo computado para o numero de casas decimais + */ protected function decimalPlaces(): Attribute { return Attribute::make( @@ -108,6 +163,11 @@ protected function decimalPlaces(): Attribute ); } + /** + * Define os casts de atributos do modelo. + * + * @return array Array de casts de atributos + */ protected function casts(): array { return [ diff --git a/app/Models/TransactionGroup.php b/app/Models/TransactionGroup.php index a09af2b231a..bd0b264f3cd 100644 --- a/app/Models/TransactionGroup.php +++ b/app/Models/TransactionGroup.php @@ -32,6 +32,24 @@ use Illuminate\Database\Eloquent\SoftDeletes; use Symfony\Component\HttpKernel\Exception\NotFoundHttpException; +/** + * Class TransactionGroup + * + * Representa um grupo de transacoes no sistema Firefly III. + * Grupos de transacoes permitem agrupar multiplas transacoes relacionadas, + * como transacoes divididas (split transactions). + * + * @property int $id Identificador unico do grupo + * @property int $user_id ID do usuario proprietario + * @property int $user_group_id ID do grupo de usuarios + * @property string|null $title Titulo do grupo de transacoes + * @property \Carbon\Carbon $created_at Data de criacao + * @property \Carbon\Carbon $updated_at Data de atualizacao + * @property \Carbon\Carbon|null $deleted_at Data de exclusao (soft delete) + * @property-read User $user Usuario proprietario + * @property-read UserGroup $userGroup Grupo de usuarios + * @property-read \Illuminate\Support\Collection $transactionJournals Diarios de transacao neste grupo + */ class TransactionGroup extends Model { use ReturnsIntegerIdTrait; @@ -71,21 +89,41 @@ public static function routeBinder(string $value): self throw new NotFoundHttpException(); } + /** + * Retorna o usuario proprietario deste grupo de transacoes. + * + * @return BelongsTo Relacionamento BelongsTo com o modelo User + */ public function user(): BelongsTo { return $this->belongsTo(User::class); } + /** + * Retorna todos os diarios de transacao neste grupo. + * + * @return HasMany Colecao de TransactionJournal relacionados + */ public function transactionJournals(): HasMany { return $this->hasMany(TransactionJournal::class); } + /** + * Retorna o grupo de usuarios ao qual este grupo de transacoes pertence. + * + * @return BelongsTo Relacionamento BelongsTo com o modelo UserGroup + */ public function userGroup(): BelongsTo { return $this->belongsTo(UserGroup::class); } + /** + * Define os casts de atributos do modelo. + * + * @return array Array de casts de atributos + */ protected function casts(): array { return [ diff --git a/app/Models/TransactionJournal.php b/app/Models/TransactionJournal.php index 609d7dc3534..3731072a094 100644 --- a/app/Models/TransactionJournal.php +++ b/app/Models/TransactionJournal.php @@ -42,6 +42,46 @@ use Symfony\Component\HttpKernel\Exception\NotFoundHttpException; /** + * Class TransactionJournal + * + * Representa um diario de transacao no sistema Firefly III. + * O diario de transacao e o registro principal de uma transacao financeira, + * contendo informacoes como data, descricao, tipo e relacionamentos. + * + * @property int $id Identificador unico do diario + * @property int $user_id ID do usuario proprietario + * @property int $user_group_id ID do grupo de usuarios + * @property int $transaction_type_id ID do tipo de transacao + * @property int $transaction_currency_id ID da moeda + * @property int|null $transaction_group_id ID do grupo de transacoes + * @property int|null $bill_id ID da fatura associada + * @property string $description Descricao da transacao + * @property \Carbon\Carbon $date Data da transacao + * @property int $order Ordem de exibicao + * @property int $tag_count Numero de tags + * @property bool $completed Se a transacao esta completa + * @property \Carbon\Carbon $created_at Data de criacao + * @property \Carbon\Carbon $updated_at Data de atualizacao + * @property \Carbon\Carbon|null $deleted_at Data de exclusao (soft delete) + * @property-read User $user Usuario proprietario + * @property-read UserGroup $userGroup Grupo de usuarios + * @property-read TransactionType $transactionType Tipo de transacao + * @property-read TransactionCurrency $transactionCurrency Moeda + * @property-read TransactionGroup|null $transactionGroup Grupo de transacoes + * @property-read Bill|null $bill Fatura associada + * @property-read \Illuminate\Support\Collection $transactions Transacoes + * @property-read \Illuminate\Support\Collection $categories Categorias + * @property-read \Illuminate\Support\Collection $budgets Orcamentos + * @property-read \Illuminate\Support\Collection $tags Tags + * @property-read \Illuminate\Support\Collection $attachments Anexos + * @property-read \Illuminate\Support\Collection $notes Notas + * @property-read \Illuminate\Support\Collection $locations Localizacoes + * @property-read \Illuminate\Support\Collection $piggyBankEvents Eventos de cofrinho + * @property-read \Illuminate\Support\Collection $transactionJournalMeta Metadados + * @property-read \Illuminate\Support\Collection $sourceJournalLinks Links de origem + * @property-read \Illuminate\Support\Collection $destJournalLinks Links de destino + * @property-read \Illuminate\Support\Collection $auditLogEntries Entradas de log de auditoria + * * @method EloquentBuilder|static before() * @method EloquentBuilder|static after() * @method static EloquentBuilder|static query() @@ -93,41 +133,81 @@ public static function routeBinder(string $value): self throw new NotFoundHttpException(); } + /** + * Retorna o usuario proprietario deste diario de transacao. + * + * @return BelongsTo Relacionamento BelongsTo com o modelo User + */ public function user(): BelongsTo { return $this->belongsTo(User::class); } + /** + * Retorna todos os anexos associados a este diario de transacao. + * + * @return MorphMany Colecao polimorfica de Attachment + */ public function attachments(): MorphMany { return $this->morphMany(Attachment::class, 'attachable'); } + /** + * Retorna todas as entradas de log de auditoria deste diario. + * + * @return MorphMany Colecao polimorfica de AuditLogEntry + */ public function auditLogEntries(): MorphMany { return $this->morphMany(AuditLogEntry::class, 'auditable'); } + /** + * Retorna a fatura associada a este diario de transacao. + * + * @return BelongsTo Relacionamento BelongsTo com o modelo Bill + */ public function bill(): BelongsTo { return $this->belongsTo(Bill::class); } + /** + * Retorna todos os orcamentos associados a este diario de transacao. + * + * @return BelongsToMany Colecao de Budget relacionados + */ public function budgets(): BelongsToMany { return $this->belongsToMany(Budget::class); } + /** + * Retorna todas as categorias associadas a este diario de transacao. + * + * @return BelongsToMany Colecao de Category relacionadas + */ public function categories(): BelongsToMany { return $this->belongsToMany(Category::class); } + /** + * Retorna todos os links onde este diario e o destino. + * + * @return HasMany Colecao de TransactionJournalLink relacionados + */ public function destJournalLinks(): HasMany { return $this->hasMany(TransactionJournalLink::class, 'destination_id'); } + /** + * Verifica se esta transacao e uma transferencia. + * + * @return bool True se for uma transferencia, false caso contrario + */ public function isTransfer(): bool { if (null !== $this->transaction_type_type) { @@ -137,34 +217,70 @@ public function isTransfer(): bool return $this->transactionType->isTransfer(); } + /** + * Retorna todas as localizacoes associadas a este diario de transacao. + * + * @return MorphMany Colecao polimorfica de Location + */ public function locations(): MorphMany { return $this->morphMany(Location::class, 'locatable'); } /** - * Get all the notes. + * Retorna todas as notas associadas a este diario de transacao. + * + * @return MorphMany Colecao polimorfica de Note */ public function notes(): MorphMany { return $this->morphMany(Note::class, 'noteable'); } + /** + * Retorna todos os eventos de cofrinho associados a este diario. + * + * @return HasMany Colecao de PiggyBankEvent relacionados + */ public function piggyBankEvents(): HasMany { return $this->hasMany(PiggyBankEvent::class); } + /** + * Scope para filtrar transacoes apos uma data especifica. + * + * @param EloquentBuilder $query Query builder + * @param Carbon $date Data de referencia + * + * @return EloquentBuilder Query builder modificado + */ public function scopeAfter(EloquentBuilder $query, Carbon $date): EloquentBuilder { return $query->where('transaction_journals.date', '>=', $date->format('Y-m-d H:i:s')); } + /** + * Scope para filtrar transacoes antes de uma data especifica. + * + * @param EloquentBuilder $query Query builder + * @param Carbon $date Data de referencia + * + * @return EloquentBuilder Query builder modificado + */ public function scopeBefore(EloquentBuilder $query, Carbon $date): EloquentBuilder { return $query->where('transaction_journals.date', '<=', $date->format('Y-m-d H:i:s')); } + /** + * Scope para filtrar por tipos de transacao. + * + * @param EloquentBuilder $query Query builder + * @param array $types Tipos de transacao para filtrar + * + * @return void + */ #[Scope] protected function transactionTypes(EloquentBuilder $query, array $types): void { @@ -177,7 +293,12 @@ protected function transactionTypes(EloquentBuilder $query, array $types): void } /** - * Checks if tables are joined. + * Verifica se uma tabela ja esta unida na query. + * + * @param EloquentBuilder $query Query builder + * @param string $table Nome da tabela + * + * @return bool True se a tabela ja esta unida, false caso contrario */ public static function isJoined(EloquentBuilder $query, string $table): bool { @@ -191,46 +312,91 @@ public static function isJoined(EloquentBuilder $query, string $table): bool return false; } + /** + * Retorna todos os links onde este diario e a origem. + * + * @return HasMany Colecao de TransactionJournalLink relacionados + */ public function sourceJournalLinks(): HasMany { return $this->hasMany(TransactionJournalLink::class, 'source_id'); } + /** + * Retorna todas as tags associadas a este diario de transacao. + * + * @return BelongsToMany Colecao de Tag relacionadas + */ public function tags(): BelongsToMany { return $this->belongsToMany(Tag::class); } + /** + * Retorna a moeda deste diario de transacao. + * + * @return BelongsTo Relacionamento BelongsTo com o modelo TransactionCurrency + */ public function transactionCurrency(): BelongsTo { return $this->belongsTo(TransactionCurrency::class); } + /** + * Retorna o grupo de transacoes ao qual este diario pertence. + * + * @return BelongsTo Relacionamento BelongsTo com o modelo TransactionGroup + */ public function transactionGroup(): BelongsTo { return $this->belongsTo(TransactionGroup::class); } + /** + * Retorna todos os metadados deste diario de transacao. + * + * @return HasMany Colecao de TransactionJournalMeta relacionados + */ public function transactionJournalMeta(): HasMany { return $this->hasMany(TransactionJournalMeta::class); } + /** + * Retorna o tipo de transacao deste diario. + * + * @return BelongsTo Relacionamento BelongsTo com o modelo TransactionType + */ public function transactionType(): BelongsTo { return $this->belongsTo(TransactionType::class); } + /** + * Retorna todas as transacoes deste diario. + * + * @return HasMany Colecao de Transaction relacionadas + */ public function transactions(): HasMany { return $this->hasMany(Transaction::class); } + /** + * Retorna o grupo de usuarios ao qual este diario pertence. + * + * @return BelongsTo Relacionamento BelongsTo com o modelo UserGroup + */ public function userGroup(): BelongsTo { return $this->belongsTo(UserGroup::class); } + /** + * Accessor para garantir que a ordem seja retornada como inteiro. + * + * @return Attribute Atributo computado para a ordem de exibicao + */ protected function order(): Attribute { return Attribute::make( @@ -238,6 +404,11 @@ protected function order(): Attribute ); } + /** + * Accessor para garantir que o ID do tipo de transacao seja retornado como inteiro. + * + * @return Attribute Atributo computado para o ID do tipo de transacao + */ protected function transactionTypeId(): Attribute { return Attribute::make( @@ -245,6 +416,11 @@ protected function transactionTypeId(): Attribute ); } + /** + * Define os casts de atributos do modelo. + * + * @return array Array de casts de atributos + */ protected function casts(): array { return [ diff --git a/app/Models/TransactionJournalLink.php b/app/Models/TransactionJournalLink.php index 92adb6a7e24..e9543f34258 100644 --- a/app/Models/TransactionJournalLink.php +++ b/app/Models/TransactionJournalLink.php @@ -30,6 +30,24 @@ use Illuminate\Database\Eloquent\Relations\MorphMany; use Symfony\Component\HttpKernel\Exception\NotFoundHttpException; +/** + * Class TransactionJournalLink + * + * Representa um link entre dois diarios de transacao no sistema Firefly III. + * Links permitem conectar transacoes relacionadas, como pagamentos e reembolsos, + * ou transacoes que se referem uma a outra. + * + * @property int $id Identificador unico do link + * @property int $link_type_id ID do tipo de link + * @property int $source_id ID do diario de origem + * @property int $destination_id ID do diario de destino + * @property \Carbon\Carbon $created_at Data de criacao + * @property \Carbon\Carbon $updated_at Data de atualizacao + * @property-read LinkType $linkType Tipo de link + * @property-read TransactionJournal $source Diario de origem + * @property-read TransactionJournal $destination Diario de destino + * @property-read \Illuminate\Support\Collection $notes Notas + */ class TransactionJournalLink extends Model { use ReturnsIntegerIdTrait; @@ -60,29 +78,51 @@ public static function routeBinder(string $value): self throw new NotFoundHttpException(); } + /** + * Retorna o diario de transacao de destino deste link. + * + * @return BelongsTo Relacionamento BelongsTo com o modelo TransactionJournal + */ public function destination(): BelongsTo { return $this->belongsTo(TransactionJournal::class, 'destination_id'); } + /** + * Retorna o tipo de link deste relacionamento. + * + * @return BelongsTo Relacionamento BelongsTo com o modelo LinkType + */ public function linkType(): BelongsTo { return $this->belongsTo(LinkType::class); } /** - * Get all of the notes. + * Retorna todas as notas associadas a este link. + * + * @return MorphMany Colecao polimorfica de Note */ public function notes(): MorphMany { return $this->morphMany(Note::class, 'noteable'); } + /** + * Retorna o diario de transacao de origem deste link. + * + * @return BelongsTo Relacionamento BelongsTo com o modelo TransactionJournal + */ public function source(): BelongsTo { return $this->belongsTo(TransactionJournal::class, 'source_id'); } + /** + * Accessor para garantir que o ID do destino seja retornado como inteiro. + * + * @return Attribute Atributo computado para o ID do destino + */ protected function destinationId(): Attribute { return Attribute::make( @@ -90,6 +130,11 @@ protected function destinationId(): Attribute ); } + /** + * Accessor para garantir que o ID do tipo de link seja retornado como inteiro. + * + * @return Attribute Atributo computado para o ID do tipo de link + */ protected function linkTypeId(): Attribute { return Attribute::make( @@ -97,6 +142,11 @@ protected function linkTypeId(): Attribute ); } + /** + * Accessor para garantir que o ID da origem seja retornado como inteiro. + * + * @return Attribute Atributo computado para o ID da origem + */ protected function sourceId(): Attribute { return Attribute::make( @@ -104,6 +154,11 @@ protected function sourceId(): Attribute ); } + /** + * Define os casts de atributos do modelo. + * + * @return array Array de casts de atributos + */ protected function casts(): array { return [ diff --git a/app/Models/TransactionJournalMeta.php b/app/Models/TransactionJournalMeta.php index 144bc79e827..4e425629aee 100644 --- a/app/Models/TransactionJournalMeta.php +++ b/app/Models/TransactionJournalMeta.php @@ -32,6 +32,23 @@ use function Safe\json_decode; use function Safe\json_encode; +/** + * Class TransactionJournalMeta + * + * Armazena metadados adicionais para diarios de transacao. + * Permite armazenar informacoes extras como datas de juros, + * datas de processamento, referencias externas, etc. + * + * @property int $id Identificador unico do metadado + * @property int $transaction_journal_id ID do diario de transacao + * @property string $name Nome/chave do metadado + * @property mixed $data Dados do metadado (armazenados como JSON) + * @property string $hash Hash dos dados para verificacao + * @property \Carbon\Carbon $created_at Data de criacao + * @property \Carbon\Carbon $updated_at Data de atualizacao + * @property \Carbon\Carbon|null $deleted_at Data de exclusao (soft delete) + * @property-read TransactionJournal $transactionJournal Diario de transacao associado + */ class TransactionJournalMeta extends Model { use ReturnsIntegerIdTrait; @@ -42,7 +59,10 @@ class TransactionJournalMeta extends Model protected $table = 'journal_meta'; /** - * @return mixed + * Accessor e mutator para os dados do metadado. + * Decodifica JSON ao ler e codifica ao salvar, gerando um hash. + * + * @return Attribute Atributo computado para os dados */ protected function data(): Attribute { @@ -53,11 +73,21 @@ protected function data(): Attribute }); } + /** + * Retorna o diario de transacao associado a este metadado. + * + * @return BelongsTo Relacionamento BelongsTo com o modelo TransactionJournal + */ public function transactionJournal(): BelongsTo { return $this->belongsTo(TransactionJournal::class); } + /** + * Accessor para garantir que o ID do diario seja retornado como inteiro. + * + * @return Attribute Atributo computado para o ID do diario de transacao + */ protected function transactionJournalId(): Attribute { return Attribute::make( @@ -65,6 +95,11 @@ protected function transactionJournalId(): Attribute ); } + /** + * Define os casts de atributos do modelo. + * + * @return array Array de casts de atributos + */ protected function casts(): array { return [ diff --git a/app/Models/TransactionType.php b/app/Models/TransactionType.php index 0b04ead8b57..1ab7b80d84a 100644 --- a/app/Models/TransactionType.php +++ b/app/Models/TransactionType.php @@ -31,6 +31,20 @@ use Illuminate\Database\Eloquent\SoftDeletes; use Symfony\Component\HttpKernel\Exception\NotFoundHttpException; +/** + * Class TransactionType + * + * Representa um tipo de transacao no sistema Firefly III. + * Tipos incluem: Withdrawal (retirada), Deposit (deposito), Transfer (transferencia), + * Opening balance (saldo inicial), Reconciliation (reconciliacao), etc. + * + * @property int $id Identificador unico do tipo + * @property string $type Nome do tipo de transacao + * @property \Carbon\Carbon $created_at Data de criacao + * @property \Carbon\Carbon $updated_at Data de atualizacao + * @property \Carbon\Carbon|null $deleted_at Data de exclusao (soft delete) + * @property-read \Illuminate\Support\Collection $transactionJournals Diarios de transacao deste tipo + */ class TransactionType extends Model { use ReturnsIntegerIdTrait; @@ -83,31 +97,61 @@ public static function routeBinder(string $type): self throw new NotFoundHttpException(); } + /** + * Verifica se este tipo e um deposito. + * + * @return bool True se for deposito, false caso contrario + */ public function isDeposit(): bool { return TransactionTypeEnum::DEPOSIT->value === $this->type; } + /** + * Verifica se este tipo e um saldo inicial. + * + * @return bool True se for saldo inicial, false caso contrario + */ public function isOpeningBalance(): bool { return TransactionTypeEnum::OPENING_BALANCE->value === $this->type; } + /** + * Verifica se este tipo e uma transferencia. + * + * @return bool True se for transferencia, false caso contrario + */ public function isTransfer(): bool { return TransactionTypeEnum::TRANSFER->value === $this->type; } + /** + * Verifica se este tipo e uma retirada. + * + * @return bool True se for retirada, false caso contrario + */ public function isWithdrawal(): bool { return TransactionTypeEnum::WITHDRAWAL->value === $this->type; } + /** + * Retorna todos os diarios de transacao deste tipo. + * + * @return HasMany Colecao de TransactionJournal relacionados + */ public function transactionJournals(): HasMany { return $this->hasMany(TransactionJournal::class); } + /** + * Define os casts de atributos do modelo. + * + * @return array Array de casts de atributos + */ protected function casts(): array { return [ diff --git a/app/Models/UserGroup.php b/app/Models/UserGroup.php index fbae2d70f62..f26beb987b9 100644 --- a/app/Models/UserGroup.php +++ b/app/Models/UserGroup.php @@ -33,6 +33,36 @@ use Illuminate\Database\Eloquent\Relations\HasManyThrough; use Symfony\Component\HttpKernel\Exception\NotFoundHttpException; +/** + * Class UserGroup + * + * Representa um grupo de usuarios no sistema Firefly III. + * Grupos de usuarios permitem compartilhar dados financeiros entre + * multiplos usuarios, como familias ou organizacoes. + * + * @property int $id Identificador unico do grupo + * @property string $title Titulo do grupo + * @property \Carbon\Carbon $created_at Data de criacao + * @property \Carbon\Carbon $updated_at Data de atualizacao + * @property-read \Illuminate\Support\Collection $accounts Contas do grupo + * @property-read \Illuminate\Support\Collection $attachments Anexos do grupo + * @property-read \Illuminate\Support\Collection $availableBudgets Orcamentos disponiveis + * @property-read \Illuminate\Support\Collection $bills Faturas do grupo + * @property-read \Illuminate\Support\Collection $budgets Orcamentos do grupo + * @property-read \Illuminate\Support\Collection $categories Categorias do grupo + * @property-read \Illuminate\Support\Collection $currencies Moedas do grupo + * @property-read \Illuminate\Support\Collection $currencyExchangeRates Taxas de cambio + * @property-read \Illuminate\Support\Collection $groupMemberships Membros do grupo + * @property-read \Illuminate\Support\Collection $objectGroups Grupos de objetos + * @property-read \Illuminate\Support\Collection $piggyBanks Cofrinhos + * @property-read \Illuminate\Support\Collection $recurrences Recorrencias + * @property-read \Illuminate\Support\Collection $ruleGroups Grupos de regras + * @property-read \Illuminate\Support\Collection $rules Regras + * @property-read \Illuminate\Support\Collection $tags Tags + * @property-read \Illuminate\Support\Collection $transactionGroups Grupos de transacoes + * @property-read \Illuminate\Support\Collection $transactionJournals Diarios de transacao + * @property-read \Illuminate\Support\Collection $webhooks Webhooks + */ class UserGroup extends Model { use ReturnsIntegerIdTrait; @@ -69,7 +99,9 @@ public static function routeBinder(string $value): self } /** - * Link to accounts. + * Retorna todas as contas deste grupo de usuarios. + * + * @return HasMany Colecao de Account relacionadas */ public function accounts(): HasMany { @@ -77,7 +109,9 @@ public function accounts(): HasMany } /** - * Link to attachments. + * Retorna todos os anexos deste grupo de usuarios. + * + * @return HasMany Colecao de Attachment relacionados */ public function attachments(): HasMany { @@ -85,7 +119,9 @@ public function attachments(): HasMany } /** - * Link to bills. + * Retorna todos os orcamentos disponiveis deste grupo de usuarios. + * + * @return HasMany Colecao de AvailableBudget relacionados */ public function availableBudgets(): HasMany { @@ -93,7 +129,9 @@ public function availableBudgets(): HasMany } /** - * Link to bills. + * Retorna todas as faturas deste grupo de usuarios. + * + * @return HasMany Colecao de Bill relacionadas */ public function bills(): HasMany { @@ -101,7 +139,9 @@ public function bills(): HasMany } /** - * Link to budgets. + * Retorna todos os orcamentos deste grupo de usuarios. + * + * @return HasMany Colecao de Budget relacionados */ public function budgets(): HasMany { @@ -109,7 +149,9 @@ public function budgets(): HasMany } /** - * Link to categories. + * Retorna todas as categorias deste grupo de usuarios. + * + * @return HasMany Colecao de Category relacionadas */ public function categories(): HasMany { @@ -117,7 +159,9 @@ public function categories(): HasMany } /** - * Link to currencies + * Retorna todas as moedas habilitadas para este grupo de usuarios. + * + * @return BelongsToMany Colecao de TransactionCurrency relacionadas */ public function currencies(): BelongsToMany { @@ -125,64 +169,110 @@ public function currencies(): BelongsToMany } /** - * Link to exchange rates. + * Retorna todas as taxas de cambio deste grupo de usuarios. + * + * @return HasMany Colecao de CurrencyExchangeRate relacionadas */ public function currencyExchangeRates(): HasMany { return $this->hasMany(CurrencyExchangeRate::class); } + /** + * Retorna todas as associacoes de membros deste grupo. + * + * @return HasMany Colecao de GroupMembership relacionadas + */ public function groupMemberships(): HasMany { return $this->hasMany(GroupMembership::class); } + /** + * Retorna todos os grupos de objetos deste grupo de usuarios. + * + * @return HasMany Colecao de ObjectGroup relacionados + */ public function objectGroups(): HasMany { return $this->hasMany(ObjectGroup::class); } /** - * Link to piggy banks. + * Retorna todos os cofrinhos deste grupo de usuarios atraves das contas. + * + * @return HasManyThrough Colecao de PiggyBank relacionados */ public function piggyBanks(): HasManyThrough { return $this->hasManyThrough(PiggyBank::class, Account::class); } + /** + * Retorna todas as recorrencias deste grupo de usuarios. + * + * @return HasMany Colecao de Recurrence relacionadas + */ public function recurrences(): HasMany { return $this->hasMany(Recurrence::class); } + /** + * Retorna todos os grupos de regras deste grupo de usuarios. + * + * @return HasMany Colecao de RuleGroup relacionados + */ public function ruleGroups(): HasMany { return $this->hasMany(RuleGroup::class); } + /** + * Retorna todas as regras deste grupo de usuarios. + * + * @return HasMany Colecao de Rule relacionadas + */ public function rules(): HasMany { return $this->hasMany(Rule::class); } + /** + * Retorna todas as tags deste grupo de usuarios. + * + * @return HasMany Colecao de Tag relacionadas + */ public function tags(): HasMany { return $this->hasMany(Tag::class); } + /** + * Retorna todos os grupos de transacoes deste grupo de usuarios. + * + * @return HasMany Colecao de TransactionGroup relacionados + */ public function transactionGroups(): HasMany { return $this->hasMany(TransactionGroup::class); } /** - * Link to transaction journals. + * Retorna todos os diarios de transacao deste grupo de usuarios. + * + * @return HasMany Colecao de TransactionJournal relacionados */ public function transactionJournals(): HasMany { return $this->hasMany(TransactionJournal::class); } + /** + * Retorna todos os webhooks deste grupo de usuarios. + * + * @return HasMany Colecao de Webhook relacionados + */ public function webhooks(): HasMany { return $this->hasMany(Webhook::class); diff --git a/app/Models/UserRole.php b/app/Models/UserRole.php index dc422684cc0..8084d9198b7 100644 --- a/app/Models/UserRole.php +++ b/app/Models/UserRole.php @@ -28,12 +28,30 @@ use Illuminate\Database\Eloquent\Model; use Illuminate\Database\Eloquent\Relations\HasMany; +/** + * Class UserRole + * + * Representa um papel de usuario dentro de um grupo no sistema Firefly III. + * Papeis definem permissoes e niveis de acesso dentro de grupos de usuarios, + * como proprietario, membro completo, somente leitura, etc. + * + * @property int $id Identificador unico do papel + * @property string $title Titulo do papel + * @property \Carbon\Carbon $created_at Data de criacao + * @property \Carbon\Carbon $updated_at Data de atualizacao + * @property-read \Illuminate\Support\Collection $groupMemberships Membros com este papel + */ class UserRole extends Model { use ReturnsIntegerIdTrait; protected $fillable = ['title']; + /** + * Retorna todas as associacoes de membros com este papel. + * + * @return HasMany Colecao de GroupMembership relacionadas + */ public function groupMemberships(): HasMany { return $this->hasMany(GroupMembership::class); diff --git a/app/Models/Webhook.php b/app/Models/Webhook.php index 7932894770f..9f4eea41f15 100644 --- a/app/Models/Webhook.php +++ b/app/Models/Webhook.php @@ -36,6 +36,29 @@ use Illuminate\Database\Eloquent\SoftDeletes; use Symfony\Component\HttpKernel\Exception\NotFoundHttpException; +/** + * Class Webhook + * + * Representa um webhook no sistema Firefly III. + * Webhooks permitem notificar sistemas externos quando eventos + * ocorrem, como criacao ou atualizacao de transacoes. + * + * @property int $id Identificador unico do webhook + * @property int $user_id ID do usuario proprietario + * @property int $user_group_id ID do grupo de usuarios + * @property string $title Titulo do webhook + * @property string $url URL de destino do webhook + * @property string $secret Segredo para assinatura + * @property bool $active Se o webhook esta ativo + * @property int $trigger Tipo de gatilho + * @property int $response Tipo de resposta + * @property int $delivery Metodo de entrega + * @property \Carbon\Carbon $created_at Data de criacao + * @property \Carbon\Carbon $updated_at Data de atualizacao + * @property \Carbon\Carbon|null $deleted_at Data de exclusao (soft delete) + * @property-read User $user Usuario proprietario + * @property-read \Illuminate\Support\Collection $webhookMessages Mensagens do webhook + */ class Webhook extends Model { use ReturnsIntegerIdTrait; @@ -53,6 +76,11 @@ class Webhook extends Model ]; protected $fillable = ['active', 'trigger', 'response', 'delivery', 'user_id', 'user_group_id', 'url', 'title', 'secret']; + /** + * Retorna todos os metodos de entrega disponiveis. + * + * @return array Array de metodos de entrega indexados por valor + */ public static function getDeliveries(): array { $array = []; @@ -64,6 +92,11 @@ public static function getDeliveries(): array return $array; } + /** + * Retorna os metodos de entrega formatados para validacao. + * + * @return array Array de metodos de entrega para validacao + */ public static function getDeliveriesForValidation(): array { $array = []; @@ -76,6 +109,11 @@ public static function getDeliveriesForValidation(): array return $array; } + /** + * Retorna todos os tipos de resposta disponiveis. + * + * @return array Array de tipos de resposta indexados por valor + */ public static function getResponses(): array { $array = []; @@ -87,6 +125,11 @@ public static function getResponses(): array return $array; } + /** + * Retorna os tipos de resposta formatados para validacao. + * + * @return array Array de tipos de resposta para validacao + */ public static function getResponsesForValidation(): array { $array = []; @@ -99,6 +142,11 @@ public static function getResponsesForValidation(): array return $array; } + /** + * Retorna todos os tipos de gatilho disponiveis. + * + * @return array Array de tipos de gatilho indexados por valor + */ public static function getTriggers(): array { $array = []; @@ -110,6 +158,11 @@ public static function getTriggers(): array return $array; } + /** + * Retorna os tipos de gatilho formatados para validacao. + * + * @return array Array de tipos de gatilho para validacao + */ public static function getTriggersForValidation(): array { $array = []; @@ -145,16 +198,31 @@ public static function routeBinder(string $value): self throw new NotFoundHttpException(); } + /** + * Retorna o usuario proprietario deste webhook. + * + * @return BelongsTo Relacionamento BelongsTo com o modelo User + */ public function user(): BelongsTo { return $this->belongsTo(User::class); } + /** + * Retorna todas as mensagens deste webhook. + * + * @return HasMany Colecao de WebhookMessage relacionadas + */ public function webhookMessages(): HasMany { return $this->hasMany(WebhookMessage::class); } + /** + * Define os casts de atributos do modelo. + * + * @return array Array de casts de atributos + */ protected function casts(): array { return [ diff --git a/app/Models/WebhookAttempt.php b/app/Models/WebhookAttempt.php index fa283f9ca22..dea6a942737 100644 --- a/app/Models/WebhookAttempt.php +++ b/app/Models/WebhookAttempt.php @@ -32,6 +32,22 @@ use Illuminate\Database\Eloquent\SoftDeletes; use Symfony\Component\HttpKernel\Exception\NotFoundHttpException; +/** + * Class WebhookAttempt + * + * Representa uma tentativa de envio de webhook no sistema Firefly III. + * Cada tentativa registra o resultado do envio de uma mensagem de webhook, + * incluindo codigo de resposta, logs e status de sucesso. + * + * @property int $id Identificador unico da tentativa + * @property int $webhook_message_id ID da mensagem de webhook + * @property int|null $status_code Codigo de status HTTP da resposta + * @property string|null $logs Logs da tentativa + * @property \Carbon\Carbon $created_at Data de criacao + * @property \Carbon\Carbon $updated_at Data de atualizacao + * @property \Carbon\Carbon|null $deleted_at Data de exclusao (soft delete) + * @property-read WebhookMessage $webhookMessage Mensagem de webhook associada + */ class WebhookAttempt extends Model { use ReturnsIntegerIdTrait; @@ -60,11 +76,21 @@ public static function routeBinder(string $value): self throw new NotFoundHttpException(); } + /** + * Retorna a mensagem de webhook associada a esta tentativa. + * + * @return BelongsTo Relacionamento BelongsTo com o modelo WebhookMessage + */ public function webhookMessage(): BelongsTo { return $this->belongsTo(WebhookMessage::class); } + /** + * Accessor para garantir que o ID da mensagem seja retornado como inteiro. + * + * @return Attribute Atributo computado para o ID da mensagem de webhook + */ protected function webhookMessageId(): Attribute { return Attribute::make( diff --git a/app/Models/WebhookMessage.php b/app/Models/WebhookMessage.php index 77d6a0642c4..34e0d8e90ef 100644 --- a/app/Models/WebhookMessage.php +++ b/app/Models/WebhookMessage.php @@ -32,6 +32,25 @@ use Illuminate\Database\Eloquent\Relations\HasMany; use Symfony\Component\HttpKernel\Exception\NotFoundHttpException; +/** + * Class WebhookMessage + * + * Representa uma mensagem de webhook no sistema Firefly III. + * Mensagens contem os dados a serem enviados para o endpoint do webhook + * e rastreiam o status de envio. + * + * @property int $id Identificador unico da mensagem + * @property int $webhook_id ID do webhook associado + * @property string $uuid UUID unico da mensagem + * @property array $message Conteudo da mensagem (JSON) + * @property bool $sent Se a mensagem foi enviada + * @property bool $errored Se houve erro no envio + * @property array|null $logs Logs de envio (JSON) + * @property \Carbon\Carbon $created_at Data de criacao + * @property \Carbon\Carbon $updated_at Data de atualizacao + * @property-read Webhook $webhook Webhook associado + * @property-read \Illuminate\Support\Collection $webhookAttempts Tentativas de envio + */ class WebhookMessage extends Model { use ReturnsIntegerIdTrait; @@ -59,18 +78,30 @@ public static function routeBinder(string $value): self throw new NotFoundHttpException(); } + /** + * Retorna o webhook associado a esta mensagem. + * + * @return BelongsTo Relacionamento BelongsTo com o modelo Webhook + */ public function webhook(): BelongsTo { return $this->belongsTo(Webhook::class); } + /** + * Retorna todas as tentativas de envio desta mensagem. + * + * @return HasMany Colecao de WebhookAttempt relacionadas + */ public function webhookAttempts(): HasMany { return $this->hasMany(WebhookAttempt::class); } /** - * Get the amount + * Accessor para garantir que o status de envio seja retornado como booleano. + * + * @return Attribute Atributo computado para o status de envio */ protected function sent(): Attribute { @@ -79,6 +110,11 @@ protected function sent(): Attribute ); } + /** + * Accessor para garantir que o ID do webhook seja retornado como inteiro. + * + * @return Attribute Atributo computado para o ID do webhook + */ protected function webhookId(): Attribute { return Attribute::make( @@ -86,6 +122,11 @@ protected function webhookId(): Attribute ); } + /** + * Define os casts de atributos do modelo. + * + * @return array Array de casts de atributos + */ protected function casts(): array { return [ diff --git a/app/Notifications/Admin/UnknownUserLoginAttempt.php b/app/Notifications/Admin/UnknownUserLoginAttempt.php index b72b0b93245..5758790221d 100644 --- a/app/Notifications/Admin/UnknownUserLoginAttempt.php +++ b/app/Notifications/Admin/UnknownUserLoginAttempt.php @@ -37,10 +37,20 @@ use NotificationChannels\Pushover\PushoverMessage; use Ntfy\Message; +/** + * Class UnknownUserLoginAttempt + * + * Notificacao de tentativa de login de usuario desconhecido. + */ class UnknownUserLoginAttempt extends Notification { use Queueable; + /** + * Construtor da notificacao. + * + * @param string $address Endereco de email da tentativa + */ public function __construct(private string $address) {} /** diff --git a/app/Notifications/Admin/UserInvitation.php b/app/Notifications/Admin/UserInvitation.php index 613bfa1f939..becd8b755e4 100644 --- a/app/Notifications/Admin/UserInvitation.php +++ b/app/Notifications/Admin/UserInvitation.php @@ -40,11 +40,18 @@ /** * Class UserInvitation + * + * Notificacao de convite de usuario criado. */ class UserInvitation extends Notification { use Queueable; + /** + * Construtor da notificacao. + * + * @param InvitedUser $invitee Usuario convidado + */ public function __construct(private InvitedUser $invitee) {} /** diff --git a/app/Notifications/Admin/UserRegistration.php b/app/Notifications/Admin/UserRegistration.php index 4d6fcf9b292..61f82d3dc45 100644 --- a/app/Notifications/Admin/UserRegistration.php +++ b/app/Notifications/Admin/UserRegistration.php @@ -40,11 +40,18 @@ /** * Class UserRegistration + * + * Notificacao de registro de novo usuario para admin. */ class UserRegistration extends Notification { use Queueable; + /** + * Construtor da notificacao. + * + * @param User $user Usuario registrado + */ public function __construct(private User $user) {} /** diff --git a/app/Notifications/Admin/VersionCheckResult.php b/app/Notifications/Admin/VersionCheckResult.php index deb2f5b4cba..46453a942e5 100644 --- a/app/Notifications/Admin/VersionCheckResult.php +++ b/app/Notifications/Admin/VersionCheckResult.php @@ -37,11 +37,18 @@ /** * Class VersionCheckResult + * + * Notificacao de resultado de verificacao de versao. */ class VersionCheckResult extends Notification { use Queueable; + /** + * Construtor da notificacao. + * + * @param string $message Mensagem de resultado + */ public function __construct(private string $message) {} /** diff --git a/app/Notifications/Notifiables/OwnerNotifiable.php b/app/Notifications/Notifiables/OwnerNotifiable.php index 96198c5d397..e02baca2f24 100644 --- a/app/Notifications/Notifiables/OwnerNotifiable.php +++ b/app/Notifications/Notifiables/OwnerNotifiable.php @@ -29,10 +29,15 @@ use Illuminate\Support\Str; use NotificationChannels\Pushover\PushoverReceiver; +/** + * Class OwnerNotifiable + * + * Classe notificavel para o proprietario do sistema. + */ class OwnerNotifiable { /** - * Get the notification routing information for the given driver. + * Obtem informacoes de roteamento de notificacao para o driver. * * @param string $driver * @param null|Notification $notification diff --git a/app/Notifications/ReturnsAvailableChannels.php b/app/Notifications/ReturnsAvailableChannels.php index e3b2737b307..48ae6045182 100644 --- a/app/Notifications/ReturnsAvailableChannels.php +++ b/app/Notifications/ReturnsAvailableChannels.php @@ -30,8 +30,21 @@ use NotificationChannels\Pushover\PushoverChannel; use Wijourdil\NtfyNotificationChannel\Channels\NtfyChannel; +/** + * Class ReturnsAvailableChannels + * + * Retorna canais de notificacao disponiveis para usuarios. + */ class ReturnsAvailableChannels { + /** + * Retorna canais disponiveis para um tipo de notificacao. + * + * @param string $type Tipo de notificacao (user, owner) + * @param null|User $user Usuario para canais de usuario + * + * @return array Lista de canais disponiveis + */ public static function returnChannels(string $type, ?User $user = null): array { $channels = ['mail']; diff --git a/app/Notifications/ReturnsSettings.php b/app/Notifications/ReturnsSettings.php index 1d3d763fb31..77785543f69 100644 --- a/app/Notifications/ReturnsSettings.php +++ b/app/Notifications/ReturnsSettings.php @@ -30,8 +30,22 @@ use FireflyIII\User; use Illuminate\Support\Facades\Log; +/** + * Class ReturnsSettings + * + * Retorna configuracoes de notificacao para diferentes canais. + */ class ReturnsSettings { + /** + * Obtem configuracoes para um canal de notificacao. + * + * @param string $channel Canal de notificacao (ntfy, etc.) + * @param string $type Tipo de notificacao (user, owner) + * @param null|User $user Usuario para configuracoes de usuario + * + * @return array Configuracoes do canal + */ public static function getSettings(string $channel, string $type, ?User $user): array { if ('ntfy' === $channel) { diff --git a/app/Notifications/Security/DisabledMFANotification.php b/app/Notifications/Security/DisabledMFANotification.php index 511b5cecabb..73a93341f1d 100644 --- a/app/Notifications/Security/DisabledMFANotification.php +++ b/app/Notifications/Security/DisabledMFANotification.php @@ -36,10 +36,20 @@ use NotificationChannels\Pushover\PushoverMessage; use Ntfy\Message; +/** + * Class DisabledMFANotification + * + * Notificacao de desativacao de MFA. + */ class DisabledMFANotification extends Notification { use Queueable; + /** + * Construtor da notificacao. + * + * @param User $user Usuario que desativou MFA + */ public function __construct(private User $user) {} /** diff --git a/app/Notifications/Security/EnabledMFANotification.php b/app/Notifications/Security/EnabledMFANotification.php index e3863aee9ef..cc8ef0eeab1 100644 --- a/app/Notifications/Security/EnabledMFANotification.php +++ b/app/Notifications/Security/EnabledMFANotification.php @@ -36,10 +36,20 @@ use NotificationChannels\Pushover\PushoverMessage; use Ntfy\Message; +/** + * Class EnabledMFANotification + * + * Notificacao de ativacao de MFA. + */ class EnabledMFANotification extends Notification { use Queueable; + /** + * Construtor da notificacao. + * + * @param User $user Usuario que ativou MFA + */ public function __construct(private User $user) {} /** diff --git a/app/Notifications/Security/MFABackupFewLeftNotification.php b/app/Notifications/Security/MFABackupFewLeftNotification.php index 4302d10c462..1aa1f504442 100644 --- a/app/Notifications/Security/MFABackupFewLeftNotification.php +++ b/app/Notifications/Security/MFABackupFewLeftNotification.php @@ -36,10 +36,21 @@ use NotificationChannels\Pushover\PushoverMessage; use Ntfy\Message; +/** + * Class MFABackupFewLeftNotification + * + * Notificacao de poucos codigos de backup restantes. + */ class MFABackupFewLeftNotification extends Notification { use Queueable; + /** + * Construtor da notificacao. + * + * @param User $user Usuario com poucos codigos + * @param int $count Numero de codigos restantes + */ public function __construct(private User $user, private int $count) {} /** diff --git a/app/Notifications/Security/MFABackupNoLeftNotification.php b/app/Notifications/Security/MFABackupNoLeftNotification.php index 246119e9014..620ba7a7911 100644 --- a/app/Notifications/Security/MFABackupNoLeftNotification.php +++ b/app/Notifications/Security/MFABackupNoLeftNotification.php @@ -36,10 +36,20 @@ use NotificationChannels\Pushover\PushoverMessage; use Ntfy\Message; +/** + * Class MFABackupNoLeftNotification + * + * Notificacao de nenhum codigo de backup restante. + */ class MFABackupNoLeftNotification extends Notification { use Queueable; + /** + * Construtor da notificacao. + * + * @param User $user Usuario sem codigos de backup + */ public function __construct(private User $user) {} /** diff --git a/app/Notifications/Security/MFAManyFailedAttemptsNotification.php b/app/Notifications/Security/MFAManyFailedAttemptsNotification.php index 400cee87e7a..68a61f11381 100644 --- a/app/Notifications/Security/MFAManyFailedAttemptsNotification.php +++ b/app/Notifications/Security/MFAManyFailedAttemptsNotification.php @@ -36,10 +36,21 @@ use NotificationChannels\Pushover\PushoverMessage; use Ntfy\Message; +/** + * Class MFAManyFailedAttemptsNotification + * + * Notificacao de muitas tentativas de MFA falhas. + */ class MFAManyFailedAttemptsNotification extends Notification { use Queueable; + /** + * Construtor da notificacao. + * + * @param User $user Usuario com tentativas falhas + * @param int $count Numero de tentativas falhas + */ public function __construct(private User $user, private int $count) {} public function toArray(User $notifiable): array diff --git a/app/Notifications/Security/MFAUsedBackupCodeNotification.php b/app/Notifications/Security/MFAUsedBackupCodeNotification.php index 01a3aac01cf..0da4edc2b3e 100644 --- a/app/Notifications/Security/MFAUsedBackupCodeNotification.php +++ b/app/Notifications/Security/MFAUsedBackupCodeNotification.php @@ -36,10 +36,20 @@ use NotificationChannels\Pushover\PushoverMessage; use Ntfy\Message; +/** + * Class MFAUsedBackupCodeNotification + * + * Notificacao de uso de codigo de backup MFA. + */ class MFAUsedBackupCodeNotification extends Notification { use Queueable; + /** + * Construtor da notificacao. + * + * @param User $user Usuario que usou codigo de backup + */ public function __construct(private User $user) {} /** diff --git a/app/Notifications/Security/NewBackupCodesNotification.php b/app/Notifications/Security/NewBackupCodesNotification.php index ede672e96b0..96aa87e9dee 100644 --- a/app/Notifications/Security/NewBackupCodesNotification.php +++ b/app/Notifications/Security/NewBackupCodesNotification.php @@ -36,10 +36,20 @@ use NotificationChannels\Pushover\PushoverMessage; use Ntfy\Message; +/** + * Class NewBackupCodesNotification + * + * Notificacao de novos codigos de backup gerados. + */ class NewBackupCodesNotification extends Notification { use Queueable; + /** + * Construtor da notificacao. + * + * @param User $user Usuario que gerou novos codigos + */ public function __construct(private User $user) {} /** diff --git a/app/Notifications/Security/UserFailedLoginAttempt.php b/app/Notifications/Security/UserFailedLoginAttempt.php index 08159020bee..bf084ca53a3 100644 --- a/app/Notifications/Security/UserFailedLoginAttempt.php +++ b/app/Notifications/Security/UserFailedLoginAttempt.php @@ -37,10 +37,20 @@ use NotificationChannels\Pushover\PushoverMessage; use Ntfy\Message; +/** + * Class UserFailedLoginAttempt + * + * Notificacao de tentativa de login falha. + */ class UserFailedLoginAttempt extends Notification { use Queueable; + /** + * Construtor da notificacao. + * + * @param User $user Usuario da tentativa + */ public function __construct(private User $user) {} public function toArray(User $notifiable): array diff --git a/app/Notifications/Test/OwnerTestNotificationEmail.php b/app/Notifications/Test/OwnerTestNotificationEmail.php index 498e7e3baad..e6b5827f388 100644 --- a/app/Notifications/Test/OwnerTestNotificationEmail.php +++ b/app/Notifications/Test/OwnerTestNotificationEmail.php @@ -31,7 +31,9 @@ use Illuminate\Notifications\Notification; /** - * Class TestNotification + * Class OwnerTestNotificationEmail + * + * Notificacao de teste via email para proprietario. */ class OwnerTestNotificationEmail extends Notification { diff --git a/app/Notifications/Test/OwnerTestNotificationNtfy.php b/app/Notifications/Test/OwnerTestNotificationNtfy.php index 9f72e8544bd..aae2c29e0e3 100644 --- a/app/Notifications/Test/OwnerTestNotificationNtfy.php +++ b/app/Notifications/Test/OwnerTestNotificationNtfy.php @@ -34,7 +34,9 @@ // use Illuminate\Notifications\Slack\SlackMessage; /** - * Class TestNotification + * Class OwnerTestNotificationNtfy + * + * Notificacao de teste via Ntfy para proprietario. */ class OwnerTestNotificationNtfy extends Notification { diff --git a/app/Notifications/Test/OwnerTestNotificationPushover.php b/app/Notifications/Test/OwnerTestNotificationPushover.php index 0e2c444f013..1f83087e48d 100644 --- a/app/Notifications/Test/OwnerTestNotificationPushover.php +++ b/app/Notifications/Test/OwnerTestNotificationPushover.php @@ -34,7 +34,9 @@ // use Illuminate\Notifications\Slack\SlackMessage; /** - * Class TestNotification + * Class OwnerTestNotificationPushover + * + * Notificacao de teste via Pushover para proprietario. */ class OwnerTestNotificationPushover extends Notification { diff --git a/app/Notifications/Test/OwnerTestNotificationSlack.php b/app/Notifications/Test/OwnerTestNotificationSlack.php index 7a0a6e40dea..346d12d8b67 100644 --- a/app/Notifications/Test/OwnerTestNotificationSlack.php +++ b/app/Notifications/Test/OwnerTestNotificationSlack.php @@ -32,7 +32,9 @@ // use Illuminate\Notifications\Slack\SlackMessage; /** - * Class TestNotification + * Class OwnerTestNotificationSlack + * + * Notificacao de teste via Slack para proprietario. */ class OwnerTestNotificationSlack extends Notification { diff --git a/app/Notifications/Test/UserTestNotificationEmail.php b/app/Notifications/Test/UserTestNotificationEmail.php index 2fbc0dd2938..3884e8fb40c 100644 --- a/app/Notifications/Test/UserTestNotificationEmail.php +++ b/app/Notifications/Test/UserTestNotificationEmail.php @@ -31,7 +31,9 @@ use Illuminate\Notifications\Notification; /** - * Class TestNotification + * Class UserTestNotificationEmail + * + * Notificacao de teste via email para usuario. */ class UserTestNotificationEmail extends Notification { diff --git a/app/Notifications/Test/UserTestNotificationNtfy.php b/app/Notifications/Test/UserTestNotificationNtfy.php index babcb459f81..5197deaed72 100644 --- a/app/Notifications/Test/UserTestNotificationNtfy.php +++ b/app/Notifications/Test/UserTestNotificationNtfy.php @@ -34,7 +34,9 @@ // use Illuminate\Notifications\Slack\SlackMessage; /** - * Class TestNotification + * Class UserTestNotificationNtfy + * + * Notificacao de teste via Ntfy para usuario. */ class UserTestNotificationNtfy extends Notification { diff --git a/app/Notifications/Test/UserTestNotificationPushover.php b/app/Notifications/Test/UserTestNotificationPushover.php index e963b4bca97..924fead9814 100644 --- a/app/Notifications/Test/UserTestNotificationPushover.php +++ b/app/Notifications/Test/UserTestNotificationPushover.php @@ -34,7 +34,9 @@ // use Illuminate\Notifications\Slack\SlackMessage; /** - * Class TestNotification + * Class UserTestNotificationPushover + * + * Notificacao de teste via Pushover para usuario. */ class UserTestNotificationPushover extends Notification { diff --git a/app/Notifications/Test/UserTestNotificationSlack.php b/app/Notifications/Test/UserTestNotificationSlack.php index 59cedc0b4cf..7b3f922a4ae 100644 --- a/app/Notifications/Test/UserTestNotificationSlack.php +++ b/app/Notifications/Test/UserTestNotificationSlack.php @@ -32,7 +32,9 @@ // use Illuminate\Notifications\Slack\SlackMessage; /** - * Class TestNotification + * Class UserTestNotificationSlack + * + * Notificacao de teste via Slack para usuario. */ class UserTestNotificationSlack extends Notification { diff --git a/app/Notifications/User/BillReminder.php b/app/Notifications/User/BillReminder.php index aebdf1333b0..78744809f7f 100644 --- a/app/Notifications/User/BillReminder.php +++ b/app/Notifications/User/BillReminder.php @@ -37,11 +37,20 @@ /** * Class BillReminder + * + * Notificacao de lembrete de fatura. */ class BillReminder extends Notification { use Queueable; + /** + * Construtor da notificacao. + * + * @param Bill $bill Fatura a lembrar + * @param string $field Campo de data (end_date, extension_date) + * @param int $diff Dias ate a data + */ public function __construct(private Bill $bill, private string $field, private int $diff) {} /** diff --git a/app/Notifications/User/NewAccessToken.php b/app/Notifications/User/NewAccessToken.php index 29d2c51b36e..f5629928eff 100644 --- a/app/Notifications/User/NewAccessToken.php +++ b/app/Notifications/User/NewAccessToken.php @@ -39,11 +39,16 @@ /** * Class NewAccessToken + * + * Notificacao de criacao de novo token de acesso. */ class NewAccessToken extends Notification { use Queueable; + /** + * Construtor da notificacao. + */ public function __construct() {} public function toArray(User $notifiable): array diff --git a/app/Notifications/User/RuleActionFailed.php b/app/Notifications/User/RuleActionFailed.php index 9a518edb2e7..b35a633b78a 100644 --- a/app/Notifications/User/RuleActionFailed.php +++ b/app/Notifications/User/RuleActionFailed.php @@ -35,17 +35,33 @@ /** * Class RuleActionFailed + * + * Notificacao de falha em acao de regra. */ class RuleActionFailed extends Notification { use Queueable; + /** @var string Link do grupo de transacao */ private string $groupLink; + + /** @var string Titulo do grupo de transacao */ private string $groupTitle; + + /** @var string Mensagem de erro */ private string $message; + + /** @var string Link da regra */ private string $ruleLink; + + /** @var string Titulo da regra */ private string $ruleTitle; + /** + * Construtor da notificacao. + * + * @param array $params Parametros da notificacao + */ public function __construct(array $params) { [$mainMessage, $groupTitle, $groupLink, $ruleTitle, $ruleLink] = $params; diff --git a/app/Notifications/User/SubscriptionsOverdueReminder.php b/app/Notifications/User/SubscriptionsOverdueReminder.php index 2db7fa53d5e..1b77f3384f7 100644 --- a/app/Notifications/User/SubscriptionsOverdueReminder.php +++ b/app/Notifications/User/SubscriptionsOverdueReminder.php @@ -14,10 +14,20 @@ use Illuminate\Notifications\Notification; use NotificationChannels\Pushover\PushoverMessage; +/** + * Class SubscriptionsOverdueReminder + * + * Notificacao de lembrete de assinaturas atrasadas. + */ class SubscriptionsOverdueReminder extends Notification { use Queueable; + /** + * Construtor da notificacao. + * + * @param array $overdue Lista de assinaturas atrasadas + */ public function __construct(private array $overdue) {} /** diff --git a/app/Notifications/User/TransactionCreation.php b/app/Notifications/User/TransactionCreation.php index 9a09d82a6cb..0a2a073f41a 100644 --- a/app/Notifications/User/TransactionCreation.php +++ b/app/Notifications/User/TransactionCreation.php @@ -31,11 +31,18 @@ /** * Class TransactionCreation + * + * Notificacao de criacao de transacoes. */ class TransactionCreation extends Notification { use Queueable; + /** + * Construtor da notificacao. + * + * @param array $collection Colecao de transacoes criadas + */ public function __construct(private array $collection) {} /** diff --git a/app/Notifications/User/UserLogin.php b/app/Notifications/User/UserLogin.php index 5fc368d7e0c..f94ed4b5cc4 100644 --- a/app/Notifications/User/UserLogin.php +++ b/app/Notifications/User/UserLogin.php @@ -38,11 +38,20 @@ /** * Class UserLogin + * + * Notificacao de login de usuario de novo IP. */ class UserLogin extends Notification { use Queueable; + /** + * Converte notificacao para array. + * + * @param User $notifiable Usuario notificavel + * + * @return array Dados da notificacao + */ public function toArray(User $notifiable): array { return [ diff --git a/app/Notifications/User/UserNewPassword.php b/app/Notifications/User/UserNewPassword.php index 16ffb0b31ad..95291b692fd 100644 --- a/app/Notifications/User/UserNewPassword.php +++ b/app/Notifications/User/UserNewPassword.php @@ -38,11 +38,18 @@ /** * Class UserNewPassword + * + * Notificacao de redefinicao de senha. */ class UserNewPassword extends Notification { use Queueable; + /** + * Construtor da notificacao. + * + * @param string $url URL para redefinicao de senha + */ public function __construct(private string $url) {} /** diff --git a/app/Notifications/User/UserRegistration.php b/app/Notifications/User/UserRegistration.php index fe0bbde10f4..b1c02615db7 100644 --- a/app/Notifications/User/UserRegistration.php +++ b/app/Notifications/User/UserRegistration.php @@ -31,11 +31,16 @@ /** * Class UserRegistration + * + * Notificacao de registro de usuario para o proprio usuario. */ class UserRegistration extends Notification { use Queueable; + /** + * Construtor da notificacao. + */ public function __construct() {} /** diff --git a/app/Providers/AccountServiceProvider.php b/app/Providers/AccountServiceProvider.php index caa4ffe49fe..feeb5e7b282 100644 --- a/app/Providers/AccountServiceProvider.php +++ b/app/Providers/AccountServiceProvider.php @@ -35,6 +35,8 @@ /** * Class AccountServiceProvider. + * + * Provedor de servicos de contas. */ class AccountServiceProvider extends ServiceProvider { diff --git a/app/Providers/AdminServiceProvider.php b/app/Providers/AdminServiceProvider.php index a7755151300..592b0deb242 100644 --- a/app/Providers/AdminServiceProvider.php +++ b/app/Providers/AdminServiceProvider.php @@ -30,7 +30,9 @@ use Override; /** - * Class AdminServiceProvider + * Class AdminServiceProvider. + * + * Provedor de servicos de administracao. */ class AdminServiceProvider extends ServiceProvider { diff --git a/app/Providers/AppServiceProvider.php b/app/Providers/AppServiceProvider.php index 263342b7533..ac98315ce1e 100644 --- a/app/Providers/AppServiceProvider.php +++ b/app/Providers/AppServiceProvider.php @@ -34,7 +34,9 @@ use function Safe\preg_match; /** - * Class AppServiceProvider + * Class AppServiceProvider. + * + * Provedor de servicos da aplicacao. */ class AppServiceProvider extends ServiceProvider { diff --git a/app/Providers/AttachmentServiceProvider.php b/app/Providers/AttachmentServiceProvider.php index 4b653f5b697..c1fbb484654 100644 --- a/app/Providers/AttachmentServiceProvider.php +++ b/app/Providers/AttachmentServiceProvider.php @@ -31,6 +31,8 @@ /** * Class AttachmentServiceProvider. + * + * Provedor de servicos de anexos. */ class AttachmentServiceProvider extends ServiceProvider { diff --git a/app/Providers/AuthServiceProvider.php b/app/Providers/AuthServiceProvider.php index 9f39f3d8a8b..3ccfdb6fb6b 100644 --- a/app/Providers/AuthServiceProvider.php +++ b/app/Providers/AuthServiceProvider.php @@ -30,7 +30,9 @@ use Laravel\Passport\Passport; /** - * Class AuthServiceProvider + * Class AuthServiceProvider. + * + * Provedor de servicos de autenticacao. */ class AuthServiceProvider extends ServiceProvider { diff --git a/app/Providers/BillServiceProvider.php b/app/Providers/BillServiceProvider.php index 0a5472304d0..2223b3bbdf1 100644 --- a/app/Providers/BillServiceProvider.php +++ b/app/Providers/BillServiceProvider.php @@ -31,6 +31,8 @@ /** * Class BillServiceProvider. + * + * Provedor de servicos de faturas. */ class BillServiceProvider extends ServiceProvider { diff --git a/app/Providers/BroadcastServiceProvider.php b/app/Providers/BroadcastServiceProvider.php index 6e80ef74515..302e4710bf9 100644 --- a/app/Providers/BroadcastServiceProvider.php +++ b/app/Providers/BroadcastServiceProvider.php @@ -27,7 +27,9 @@ use Illuminate\Support\ServiceProvider; /** - * Class BroadcastServiceProvider + * Class BroadcastServiceProvider. + * + * Provedor de servicos de broadcast. */ class BroadcastServiceProvider extends ServiceProvider { diff --git a/app/Providers/BudgetServiceProvider.php b/app/Providers/BudgetServiceProvider.php index a6bc575d312..618b92397f4 100644 --- a/app/Providers/BudgetServiceProvider.php +++ b/app/Providers/BudgetServiceProvider.php @@ -39,6 +39,8 @@ /** * Class BudgetServiceProvider. + * + * Provedor de servicos de orcamentos. */ class BudgetServiceProvider extends ServiceProvider { diff --git a/app/Providers/CategoryServiceProvider.php b/app/Providers/CategoryServiceProvider.php index 6346fea0464..090b15fa0a5 100644 --- a/app/Providers/CategoryServiceProvider.php +++ b/app/Providers/CategoryServiceProvider.php @@ -35,6 +35,8 @@ /** * Class CategoryServiceProvider. + * + * Provedor de servicos de categorias. */ class CategoryServiceProvider extends ServiceProvider { diff --git a/app/Providers/CurrencyServiceProvider.php b/app/Providers/CurrencyServiceProvider.php index 3b6a751b644..0366aed6fc4 100644 --- a/app/Providers/CurrencyServiceProvider.php +++ b/app/Providers/CurrencyServiceProvider.php @@ -34,6 +34,8 @@ /** * Class CurrencyServiceProvider. + * + * Provedor de servicos de moedas. */ class CurrencyServiceProvider extends ServiceProvider { diff --git a/app/Providers/EventServiceProvider.php b/app/Providers/EventServiceProvider.php index 5cff75ae42c..9c011a67343 100644 --- a/app/Providers/EventServiceProvider.php +++ b/app/Providers/EventServiceProvider.php @@ -105,6 +105,8 @@ /** * Class EventServiceProvider. * + * Provedor de servicos de eventos. + * * @SuppressWarnings("PHPMD.CouplingBetweenObjects") */ class EventServiceProvider extends ServiceProvider diff --git a/app/Providers/FireflyServiceProvider.php b/app/Providers/FireflyServiceProvider.php index 02ff3d729bc..7860d223c8d 100644 --- a/app/Providers/FireflyServiceProvider.php +++ b/app/Providers/FireflyServiceProvider.php @@ -81,6 +81,8 @@ /** * Class FireflyServiceProvider. * + * Provedor de servicos principal do Firefly III. + * * @SuppressWarnings("PHPMD.CouplingBetweenObjects") */ class FireflyServiceProvider extends ServiceProvider diff --git a/app/Providers/FireflySessionProvider.php b/app/Providers/FireflySessionProvider.php index fee1b30ed60..ba418b50914 100644 --- a/app/Providers/FireflySessionProvider.php +++ b/app/Providers/FireflySessionProvider.php @@ -29,7 +29,9 @@ use Override; /** - * Class FireflySessionProvider + * Class FireflySessionProvider. + * + * Provedor de sessao personalizado do Firefly III. */ class FireflySessionProvider extends ServiceProvider { diff --git a/app/Providers/JournalServiceProvider.php b/app/Providers/JournalServiceProvider.php index ac27b169ba6..77049f91976 100644 --- a/app/Providers/JournalServiceProvider.php +++ b/app/Providers/JournalServiceProvider.php @@ -39,6 +39,8 @@ /** * Class JournalServiceProvider. + * + * Provedor de servicos de lancamentos. */ class JournalServiceProvider extends ServiceProvider { diff --git a/app/Providers/PiggyBankServiceProvider.php b/app/Providers/PiggyBankServiceProvider.php index 99020bc2e3a..4e55d20a98d 100644 --- a/app/Providers/PiggyBankServiceProvider.php +++ b/app/Providers/PiggyBankServiceProvider.php @@ -31,6 +31,8 @@ /** * Class PiggyBankServiceProvider. + * + * Provedor de servicos de cofrinhos. */ class PiggyBankServiceProvider extends ServiceProvider { diff --git a/app/Providers/RecurringServiceProvider.php b/app/Providers/RecurringServiceProvider.php index a8184d735fe..a70fb57f10a 100644 --- a/app/Providers/RecurringServiceProvider.php +++ b/app/Providers/RecurringServiceProvider.php @@ -31,6 +31,8 @@ /** * Class RecurringServiceProvider. + * + * Provedor de servicos de transacoes recorrentes. */ class RecurringServiceProvider extends ServiceProvider { diff --git a/app/Providers/RouteServiceProvider.php b/app/Providers/RouteServiceProvider.php index caec293d3d2..781a2a5e8c4 100644 --- a/app/Providers/RouteServiceProvider.php +++ b/app/Providers/RouteServiceProvider.php @@ -28,7 +28,9 @@ use Override; /** - * Class RouteServiceProvider + * Class RouteServiceProvider. + * + * Provedor de servicos de rotas. */ class RouteServiceProvider extends ServiceProvider { diff --git a/app/Providers/RuleGroupServiceProvider.php b/app/Providers/RuleGroupServiceProvider.php index 32fa85b17eb..2c454497871 100644 --- a/app/Providers/RuleGroupServiceProvider.php +++ b/app/Providers/RuleGroupServiceProvider.php @@ -31,6 +31,8 @@ /** * Class RuleGroupServiceProvider. + * + * Provedor de servicos de grupos de regras. */ class RuleGroupServiceProvider extends ServiceProvider { diff --git a/app/Providers/RuleServiceProvider.php b/app/Providers/RuleServiceProvider.php index e7b235588f1..98b42275383 100644 --- a/app/Providers/RuleServiceProvider.php +++ b/app/Providers/RuleServiceProvider.php @@ -31,6 +31,8 @@ /** * Class RuleServiceProvider. + * + * Provedor de servicos de regras. */ class RuleServiceProvider extends ServiceProvider { diff --git a/app/Providers/SearchServiceProvider.php b/app/Providers/SearchServiceProvider.php index baf32f811b7..62f8a5d12ce 100644 --- a/app/Providers/SearchServiceProvider.php +++ b/app/Providers/SearchServiceProvider.php @@ -34,6 +34,8 @@ /** * Class SearchServiceProvider. + * + * Provedor de servicos de busca. */ class SearchServiceProvider extends ServiceProvider { diff --git a/app/Providers/SessionServiceProvider.php b/app/Providers/SessionServiceProvider.php index 2fdf356bd3c..718816a868b 100644 --- a/app/Providers/SessionServiceProvider.php +++ b/app/Providers/SessionServiceProvider.php @@ -29,6 +29,8 @@ /** * Class SessionServiceProvider. + * + * Provedor de servicos de sessao. */ class SessionServiceProvider extends BaseSessionServiceProvider { diff --git a/app/Providers/TagServiceProvider.php b/app/Providers/TagServiceProvider.php index 85b9b85cfe9..8ac2aeaef21 100644 --- a/app/Providers/TagServiceProvider.php +++ b/app/Providers/TagServiceProvider.php @@ -33,6 +33,8 @@ /** * Class TagServiceProvider. + * + * Provedor de servicos de tags. */ class TagServiceProvider extends ServiceProvider { diff --git a/app/Repositories/Account/AccountRepository.php b/app/Repositories/Account/AccountRepository.php index afd301bf228..d334a820c84 100644 --- a/app/Repositories/Account/AccountRepository.php +++ b/app/Repositories/Account/AccountRepository.php @@ -51,6 +51,9 @@ /** * Class AccountRepository. + * + * Repositorio principal para gerenciamento de contas. + * Fornece metodos para criar, atualizar, excluir e consultar contas financeiras. */ class AccountRepository implements AccountRepositoryInterface, UserGroupInterface { diff --git a/app/Repositories/Account/AccountRepositoryInterface.php b/app/Repositories/Account/AccountRepositoryInterface.php index 3a16896695a..87c743cd3fa 100644 --- a/app/Repositories/Account/AccountRepositoryInterface.php +++ b/app/Repositories/Account/AccountRepositoryInterface.php @@ -39,6 +39,9 @@ /** * Interface AccountRepositoryInterface. * + * Interface para repositorio de contas financeiras. + * Define metodos para criar, atualizar, excluir e consultar contas. + * * @method setUserGroup(UserGroup $group) * @method getUserGroup() * @method getUser() diff --git a/app/Repositories/Account/OperationsRepository.php b/app/Repositories/Account/OperationsRepository.php index e402922365b..d521b13c9da 100644 --- a/app/Repositories/Account/OperationsRepository.php +++ b/app/Repositories/Account/OperationsRepository.php @@ -35,6 +35,9 @@ /** * Class OperationsRepository + * + * Repositorio de operacoes de contas. + * Fornece metodos para calcular despesas, receitas e transferencias por conta. */ class OperationsRepository implements OperationsRepositoryInterface, UserGroupInterface { diff --git a/app/Repositories/Account/OperationsRepositoryInterface.php b/app/Repositories/Account/OperationsRepositoryInterface.php index 3d8b973a6a6..20f30267326 100644 --- a/app/Repositories/Account/OperationsRepositoryInterface.php +++ b/app/Repositories/Account/OperationsRepositoryInterface.php @@ -35,6 +35,9 @@ /** * Interface OperationsRepositoryInterface * + * Interface para operacoes de contas. + * Define metodos para calcular despesas, receitas e transferencias por conta. + * * @method setUserGroup(UserGroup $group) * @method getUserGroup() * @method getUser() diff --git a/app/Repositories/Attachment/AttachmentRepository.php b/app/Repositories/Attachment/AttachmentRepository.php index 0e41c59cf46..0c4548dc445 100644 --- a/app/Repositories/Attachment/AttachmentRepository.php +++ b/app/Repositories/Attachment/AttachmentRepository.php @@ -40,6 +40,9 @@ /** * Class AttachmentRepository. + * + * Repositorio principal para gerenciamento de anexos. + * Fornece metodos para criar, atualizar, excluir e consultar anexos de transacoes. */ class AttachmentRepository implements AttachmentRepositoryInterface, UserGroupInterface { diff --git a/app/Repositories/Attachment/AttachmentRepositoryInterface.php b/app/Repositories/Attachment/AttachmentRepositoryInterface.php index 01f43cdb3ba..7ec6c7acaf9 100644 --- a/app/Repositories/Attachment/AttachmentRepositoryInterface.php +++ b/app/Repositories/Attachment/AttachmentRepositoryInterface.php @@ -34,6 +34,9 @@ /** * Interface AttachmentRepositoryInterface. * + * Interface para repositorio de anexos. + * Define metodos para criar, atualizar, excluir e consultar anexos de transacoes. + * * @method setUserGroup(UserGroup $group) * @method getUserGroup() * @method getUser() diff --git a/app/Repositories/AuditLogEntry/ALERepository.php b/app/Repositories/AuditLogEntry/ALERepository.php index 50e4adaf08b..a8e3acb1632 100644 --- a/app/Repositories/AuditLogEntry/ALERepository.php +++ b/app/Repositories/AuditLogEntry/ALERepository.php @@ -30,6 +30,9 @@ /** * Class ALERepository + * + * Repositorio para gerenciamento de entradas de log de auditoria. + * Fornece metodos para criar e consultar registros de auditoria do sistema. */ class ALERepository implements ALERepositoryInterface { diff --git a/app/Repositories/AuditLogEntry/ALERepositoryInterface.php b/app/Repositories/AuditLogEntry/ALERepositoryInterface.php index 3860b52b3bb..cc24019d9e9 100644 --- a/app/Repositories/AuditLogEntry/ALERepositoryInterface.php +++ b/app/Repositories/AuditLogEntry/ALERepositoryInterface.php @@ -35,6 +35,9 @@ /** * Interface ALERepositoryInterface * + * Interface para repositorio de entradas de log de auditoria. + * Define metodos para criar e consultar registros de auditoria do sistema. + * * @method setUserGroup(UserGroup $group) * @method getUserGroup() * @method getUser() diff --git a/app/Repositories/Bill/BillRepository.php b/app/Repositories/Bill/BillRepository.php index 99c484f4a8e..359801f1ffc 100644 --- a/app/Repositories/Bill/BillRepository.php +++ b/app/Repositories/Bill/BillRepository.php @@ -50,6 +50,9 @@ /** * Class BillRepository. + * + * Repositorio principal para gerenciamento de contas a pagar. + * Fornece metodos para criar, atualizar, excluir e consultar contas recorrentes. */ class BillRepository implements BillRepositoryInterface, UserGroupInterface { diff --git a/app/Repositories/Bill/BillRepositoryInterface.php b/app/Repositories/Bill/BillRepositoryInterface.php index f39c1bf84ad..f85d8d390f9 100644 --- a/app/Repositories/Bill/BillRepositoryInterface.php +++ b/app/Repositories/Bill/BillRepositoryInterface.php @@ -36,6 +36,9 @@ /** * Interface BillRepositoryInterface. * + * Interface para repositorio de contas a pagar. + * Define metodos para criar, atualizar, excluir e consultar contas recorrentes. + * * @method setUserGroup(UserGroup $group) * @method getUserGroup() * @method getUser() diff --git a/app/Repositories/Budget/AvailableBudgetRepository.php b/app/Repositories/Budget/AvailableBudgetRepository.php index fb789f3ebb7..5f810f8b4e9 100644 --- a/app/Repositories/Budget/AvailableBudgetRepository.php +++ b/app/Repositories/Budget/AvailableBudgetRepository.php @@ -37,6 +37,9 @@ /** * Class AvailableBudgetRepository + * + * Repositorio para orcamento disponivel. + * Fornece metodos para gerenciar valores disponiveis para orcamento por periodo. */ class AvailableBudgetRepository implements AvailableBudgetRepositoryInterface, UserGroupInterface { diff --git a/app/Repositories/Budget/AvailableBudgetRepositoryInterface.php b/app/Repositories/Budget/AvailableBudgetRepositoryInterface.php index 3d54e3f20b8..4460e96f74a 100644 --- a/app/Repositories/Budget/AvailableBudgetRepositoryInterface.php +++ b/app/Repositories/Budget/AvailableBudgetRepositoryInterface.php @@ -37,6 +37,9 @@ /** * Interface AvailableBudgetRepositoryInterface * + * Interface para repositorio de orcamento disponivel. + * Define metodos para gerenciar valores disponiveis para orcamento por periodo. + * * @method setUserGroup(UserGroup $group) * @method getUserGroup() * @method getUser() diff --git a/app/Repositories/Budget/BudgetLimitRepository.php b/app/Repositories/Budget/BudgetLimitRepository.php index 8974613364b..4f9f18ea624 100644 --- a/app/Repositories/Budget/BudgetLimitRepository.php +++ b/app/Repositories/Budget/BudgetLimitRepository.php @@ -40,6 +40,9 @@ /** * Class BudgetLimitRepository + * + * Repositorio para limites de orcamento. + * Fornece metodos para criar, atualizar e consultar limites de orcamento. */ class BudgetLimitRepository implements BudgetLimitRepositoryInterface, UserGroupInterface { diff --git a/app/Repositories/Budget/BudgetLimitRepositoryInterface.php b/app/Repositories/Budget/BudgetLimitRepositoryInterface.php index c56093ef615..1611aea1ddb 100644 --- a/app/Repositories/Budget/BudgetLimitRepositoryInterface.php +++ b/app/Repositories/Budget/BudgetLimitRepositoryInterface.php @@ -37,6 +37,9 @@ /** * Interface BudgetLimitRepositoryInterface * + * Interface para repositorio de limites de orcamento. + * Define metodos para criar, atualizar e consultar limites de orcamento. + * * @method setUserGroup(UserGroup $group) * @method getUserGroup() * @method getUser() diff --git a/app/Repositories/Budget/BudgetRepository.php b/app/Repositories/Budget/BudgetRepository.php index 56de39dcc6e..c5692abb42a 100644 --- a/app/Repositories/Budget/BudgetRepository.php +++ b/app/Repositories/Budget/BudgetRepository.php @@ -50,7 +50,10 @@ use Illuminate\Support\Facades\Storage; /** - * Class BudgetRepository. + * Class BudgetRepository + * + * Repositorio para gerenciamento de orcamentos. + * Fornece metodos para criar, atualizar, excluir e consultar orcamentos e limites. */ class BudgetRepository implements BudgetRepositoryInterface, UserGroupInterface { diff --git a/app/Repositories/Budget/BudgetRepositoryInterface.php b/app/Repositories/Budget/BudgetRepositoryInterface.php index b12aed27962..602dec14545 100644 --- a/app/Repositories/Budget/BudgetRepositoryInterface.php +++ b/app/Repositories/Budget/BudgetRepositoryInterface.php @@ -34,7 +34,10 @@ use Illuminate\Support\Collection; /** - * Interface BudgetRepositoryInterface. + * Interface BudgetRepositoryInterface + * + * Interface para repositorio de orcamentos. + * Define metodos para gerenciamento de orcamentos, limites e auto-orcamentos. * * @method setUserGroup(UserGroup $group) * @method getUserGroup() diff --git a/app/Repositories/Budget/NoBudgetRepository.php b/app/Repositories/Budget/NoBudgetRepository.php index f48176ab9ae..e1a44d69c14 100644 --- a/app/Repositories/Budget/NoBudgetRepository.php +++ b/app/Repositories/Budget/NoBudgetRepository.php @@ -36,6 +36,9 @@ /** * Class NoBudgetRepository + * + * Repositorio para transacoes sem orcamento. + * Fornece metodos para consultar gastos sem orcamento definido. */ class NoBudgetRepository implements NoBudgetRepositoryInterface, UserGroupInterface { diff --git a/app/Repositories/Budget/NoBudgetRepositoryInterface.php b/app/Repositories/Budget/NoBudgetRepositoryInterface.php index 01b42c33965..213d1a75191 100644 --- a/app/Repositories/Budget/NoBudgetRepositoryInterface.php +++ b/app/Repositories/Budget/NoBudgetRepositoryInterface.php @@ -36,6 +36,9 @@ /** * Interface NoBudgetRepositoryInterface * + * Interface para repositorio de transacoes sem orcamento. + * Define metodos para consultar gastos sem orcamento definido. + * * @method setUserGroup(UserGroup $group) * @method getUserGroup() * @method getUser() diff --git a/app/Repositories/Budget/OperationsRepository.php b/app/Repositories/Budget/OperationsRepository.php index 052a6622b85..6b07eea4c3c 100644 --- a/app/Repositories/Budget/OperationsRepository.php +++ b/app/Repositories/Budget/OperationsRepository.php @@ -43,6 +43,9 @@ /** * Class OperationsRepository + * + * Repositorio para operacoes de orcamento. + * Fornece metodos para calcular gastos e gerar relatorios de orcamento. */ class OperationsRepository implements OperationsRepositoryInterface, UserGroupInterface { diff --git a/app/Repositories/Budget/OperationsRepositoryInterface.php b/app/Repositories/Budget/OperationsRepositoryInterface.php index 01cce862d3a..f60eef74595 100644 --- a/app/Repositories/Budget/OperationsRepositoryInterface.php +++ b/app/Repositories/Budget/OperationsRepositoryInterface.php @@ -37,6 +37,9 @@ /** * Interface OperationsRepositoryInterface * + * Interface para operacoes de orcamento. + * Define metodos para calcular gastos e gerar relatorios de orcamento. + * * @method setUserGroup(UserGroup $group) * @method getUserGroup() * @method getUser() diff --git a/app/Repositories/Category/CategoryRepository.php b/app/Repositories/Category/CategoryRepository.php index 487a467c20b..c7f7c46a146 100644 --- a/app/Repositories/Category/CategoryRepository.php +++ b/app/Repositories/Category/CategoryRepository.php @@ -43,6 +43,9 @@ /** * Class CategoryRepository. + * + * Repositorio principal para gerenciamento de categorias. + * Fornece metodos para criar, atualizar, excluir e consultar categorias de transacoes. */ class CategoryRepository implements CategoryRepositoryInterface, UserGroupInterface { diff --git a/app/Repositories/Category/CategoryRepositoryInterface.php b/app/Repositories/Category/CategoryRepositoryInterface.php index 263c11c7165..fbaa397953c 100644 --- a/app/Repositories/Category/CategoryRepositoryInterface.php +++ b/app/Repositories/Category/CategoryRepositoryInterface.php @@ -35,6 +35,9 @@ /** * Interface CategoryRepositoryInterface. * + * Interface para repositorio de categorias. + * Define metodos para criar, atualizar, excluir e consultar categorias de transacoes. + * * @method setUserGroup(UserGroup $group) * @method getUserGroup() * @method getUser() diff --git a/app/Repositories/Category/NoCategoryRepository.php b/app/Repositories/Category/NoCategoryRepository.php index dbaf464eb85..05d3d9367a8 100644 --- a/app/Repositories/Category/NoCategoryRepository.php +++ b/app/Repositories/Category/NoCategoryRepository.php @@ -34,6 +34,9 @@ /** * Class NoCategoryRepository + * + * Repositorio para transacoes sem categoria. + * Fornece metodos para consultar despesas e receitas sem categoria definida. */ class NoCategoryRepository implements NoCategoryRepositoryInterface, UserGroupInterface { diff --git a/app/Repositories/Category/NoCategoryRepositoryInterface.php b/app/Repositories/Category/NoCategoryRepositoryInterface.php index 58b25504f87..83b6eed112b 100644 --- a/app/Repositories/Category/NoCategoryRepositoryInterface.php +++ b/app/Repositories/Category/NoCategoryRepositoryInterface.php @@ -34,6 +34,9 @@ /** * Interface NoCategoryRepositoryInterface * + * Interface para repositorio de transacoes sem categoria. + * Define metodos para consultar despesas e receitas sem categoria definida. + * * @method setUserGroup(UserGroup $group) * @method getUserGroup() * @method getUser() diff --git a/app/Repositories/Category/OperationsRepository.php b/app/Repositories/Category/OperationsRepository.php index 26599d2c61c..38c23c16295 100644 --- a/app/Repositories/Category/OperationsRepository.php +++ b/app/Repositories/Category/OperationsRepository.php @@ -37,6 +37,9 @@ /** * Class OperationsRepository + * + * Repositorio de operacoes de categorias. + * Fornece metodos para calcular despesas, receitas e transferencias por categoria. */ class OperationsRepository implements OperationsRepositoryInterface, UserGroupInterface { diff --git a/app/Repositories/Category/OperationsRepositoryInterface.php b/app/Repositories/Category/OperationsRepositoryInterface.php index e8fcdab41b3..16fda5b4c6c 100644 --- a/app/Repositories/Category/OperationsRepositoryInterface.php +++ b/app/Repositories/Category/OperationsRepositoryInterface.php @@ -35,6 +35,9 @@ /** * Interface OperationsRepositoryInterface * + * Interface para operacoes de categorias. + * Define metodos para calcular despesas, receitas e transferencias por categoria. + * * @method setUserGroup(UserGroup $group) * @method getUserGroup() * @method getUser() diff --git a/app/Repositories/Currency/CurrencyRepository.php b/app/Repositories/Currency/CurrencyRepository.php index ce52a5f503f..fd93102d410 100644 --- a/app/Repositories/Currency/CurrencyRepository.php +++ b/app/Repositories/Currency/CurrencyRepository.php @@ -48,6 +48,9 @@ /** * Class CurrencyRepository. + * + * Repositorio principal para gerenciamento de moedas. + * Fornece metodos para criar, atualizar, excluir e consultar moedas de transacao. */ class CurrencyRepository implements CurrencyRepositoryInterface, UserGroupInterface { diff --git a/app/Repositories/Currency/CurrencyRepositoryInterface.php b/app/Repositories/Currency/CurrencyRepositoryInterface.php index 820b57c73c2..fe3a9cb5982 100644 --- a/app/Repositories/Currency/CurrencyRepositoryInterface.php +++ b/app/Repositories/Currency/CurrencyRepositoryInterface.php @@ -36,6 +36,9 @@ /** * Interface CurrencyRepositoryInterface. * + * Interface para repositorio de moedas. + * Define metodos para criar, atualizar, excluir e consultar moedas de transacao. + * * @method setUserGroup(UserGroup $group) * @method getUserGroup() * @method getUser() diff --git a/app/Repositories/ExchangeRate/ExchangeRateRepository.php b/app/Repositories/ExchangeRate/ExchangeRateRepository.php index 1fecb036fd4..2d4b781d214 100644 --- a/app/Repositories/ExchangeRate/ExchangeRateRepository.php +++ b/app/Repositories/ExchangeRate/ExchangeRateRepository.php @@ -33,6 +33,12 @@ use Illuminate\Support\Collection; use Override; +/** + * Class ExchangeRateRepository + * + * Repositorio para gerenciamento de taxas de cambio. + * Fornece metodos para criar, atualizar, excluir e consultar taxas de conversao entre moedas. + */ class ExchangeRateRepository implements ExchangeRateRepositoryInterface, UserGroupInterface { use UserGroupTrait; diff --git a/app/Repositories/ExchangeRate/ExchangeRateRepositoryInterface.php b/app/Repositories/ExchangeRate/ExchangeRateRepositoryInterface.php index 04f8ac1072f..8417f9daf4f 100644 --- a/app/Repositories/ExchangeRate/ExchangeRateRepositoryInterface.php +++ b/app/Repositories/ExchangeRate/ExchangeRateRepositoryInterface.php @@ -36,6 +36,9 @@ /** * Interface ExchangeRateRepositoryInterface * + * Interface para repositorio de taxas de cambio. + * Define metodos para criar, atualizar, excluir e consultar taxas de conversao entre moedas. + * * @method setUserGroup(UserGroup $group) * @method getUserGroup() * @method getUser() diff --git a/app/Repositories/Journal/JournalAPIRepository.php b/app/Repositories/Journal/JournalAPIRepository.php index 97efb75814f..f765b880fab 100644 --- a/app/Repositories/Journal/JournalAPIRepository.php +++ b/app/Repositories/Journal/JournalAPIRepository.php @@ -36,6 +36,9 @@ /** * Class JournalAPIRepository + * + * Repositorio de API para gerenciamento de diarios de transacoes. + * Fornece metodos para consultar transacoes, anexos e eventos de cofrinhos via API. */ class JournalAPIRepository implements JournalAPIRepositoryInterface, UserGroupInterface { diff --git a/app/Repositories/Journal/JournalAPIRepositoryInterface.php b/app/Repositories/Journal/JournalAPIRepositoryInterface.php index 454250c8e45..d90d9dece92 100644 --- a/app/Repositories/Journal/JournalAPIRepositoryInterface.php +++ b/app/Repositories/Journal/JournalAPIRepositoryInterface.php @@ -35,6 +35,9 @@ /** * Interface JournalAPIRepositoryInterface * + * Interface de API para repositorio de diarios de transacoes. + * Define metodos para consultar transacoes, anexos e eventos de cofrinhos via API. + * * @method setUserGroup(UserGroup $group) * @method getUserGroup() * @method getUser() diff --git a/app/Repositories/Journal/JournalCLIRepository.php b/app/Repositories/Journal/JournalCLIRepository.php index b908dcc82f0..9845059ef40 100644 --- a/app/Repositories/Journal/JournalCLIRepository.php +++ b/app/Repositories/Journal/JournalCLIRepository.php @@ -36,6 +36,9 @@ /** * Class JournalCLIRepository + * + * Repositorio CLI para gerenciamento de diarios de transacoes. + * Fornece metodos para consultar transacoes, metadados e tags via linha de comando. */ class JournalCLIRepository implements JournalCLIRepositoryInterface, UserGroupInterface { diff --git a/app/Repositories/Journal/JournalCLIRepositoryInterface.php b/app/Repositories/Journal/JournalCLIRepositoryInterface.php index 4a43340142a..01d86ff4b17 100644 --- a/app/Repositories/Journal/JournalCLIRepositoryInterface.php +++ b/app/Repositories/Journal/JournalCLIRepositoryInterface.php @@ -35,6 +35,9 @@ /** * Interface JournalCLIRepositoryInterface * + * Interface CLI para repositorio de diarios de transacoes. + * Define metodos para consultar transacoes, metadados e tags via linha de comando. + * * @method setUserGroup(UserGroup $group) * @method getUserGroup() * @method getUser() diff --git a/app/Repositories/Journal/JournalRepository.php b/app/Repositories/Journal/JournalRepository.php index aee44f902b3..8a0ee20f94c 100644 --- a/app/Repositories/Journal/JournalRepository.php +++ b/app/Repositories/Journal/JournalRepository.php @@ -42,6 +42,9 @@ /** * Class JournalRepository. + * + * Repositorio principal para gerenciamento de diarios de transacoes. + * Fornece metodos para criar, atualizar, excluir e consultar transacoes. */ class JournalRepository implements JournalRepositoryInterface, UserGroupInterface { diff --git a/app/Repositories/Journal/JournalRepositoryInterface.php b/app/Repositories/Journal/JournalRepositoryInterface.php index 8971bf92343..4c3a504733b 100644 --- a/app/Repositories/Journal/JournalRepositoryInterface.php +++ b/app/Repositories/Journal/JournalRepositoryInterface.php @@ -38,6 +38,9 @@ /** * Interface JournalRepositoryInterface * + * Interface para repositorio de diarios de transacoes. + * Define metodos para criar, atualizar, excluir e consultar transacoes. + * * @method setUserGroup(UserGroup $group) * @method getUserGroup() * @method getUser() diff --git a/app/Repositories/LinkType/LinkTypeRepository.php b/app/Repositories/LinkType/LinkTypeRepository.php index 9b2924b191e..1440b1c7657 100644 --- a/app/Repositories/LinkType/LinkTypeRepository.php +++ b/app/Repositories/LinkType/LinkTypeRepository.php @@ -35,6 +35,9 @@ /** * Class LinkTypeRepository. + * + * Repositorio para gerenciamento de tipos de links entre transacoes. + * Fornece metodos para criar, atualizar, excluir e consultar tipos de links. */ class LinkTypeRepository implements LinkTypeRepositoryInterface, UserGroupInterface { diff --git a/app/Repositories/LinkType/LinkTypeRepositoryInterface.php b/app/Repositories/LinkType/LinkTypeRepositoryInterface.php index 23cdeca825f..34227626985 100644 --- a/app/Repositories/LinkType/LinkTypeRepositoryInterface.php +++ b/app/Repositories/LinkType/LinkTypeRepositoryInterface.php @@ -35,6 +35,9 @@ /** * Interface LinkTypeRepositoryInterface. * + * Interface para repositorio de tipos de links entre transacoes. + * Define metodos para criar, atualizar, excluir e consultar tipos de links. + * * @method setUserGroup(UserGroup $group) * @method getUserGroup() * @method getUser() diff --git a/app/Repositories/ObjectGroup/CreatesObjectGroups.php b/app/Repositories/ObjectGroup/CreatesObjectGroups.php index 5835a32f11f..8c449e45cac 100644 --- a/app/Repositories/ObjectGroup/CreatesObjectGroups.php +++ b/app/Repositories/ObjectGroup/CreatesObjectGroups.php @@ -28,6 +28,9 @@ /** * Trait CreatesObjectGroups + * + * Trait para criacao e gerenciamento de grupos de objetos. + * Fornece metodos para encontrar ou criar grupos de objetos por titulo ou ID. */ trait CreatesObjectGroups { diff --git a/app/Repositories/ObjectGroup/ObjectGroupRepository.php b/app/Repositories/ObjectGroup/ObjectGroupRepository.php index 42991556709..6cb846f3a06 100644 --- a/app/Repositories/ObjectGroup/ObjectGroupRepository.php +++ b/app/Repositories/ObjectGroup/ObjectGroupRepository.php @@ -33,6 +33,9 @@ /** * Class ObjectGroupRepository + * + * Repositorio para gerenciamento de grupos de objetos. + * Fornece metodos para criar, atualizar, excluir e consultar grupos de objetos. */ class ObjectGroupRepository implements ObjectGroupRepositoryInterface, UserGroupInterface { diff --git a/app/Repositories/ObjectGroup/ObjectGroupRepositoryInterface.php b/app/Repositories/ObjectGroup/ObjectGroupRepositoryInterface.php index 5798b7ce2f5..7258c7da7a3 100644 --- a/app/Repositories/ObjectGroup/ObjectGroupRepositoryInterface.php +++ b/app/Repositories/ObjectGroup/ObjectGroupRepositoryInterface.php @@ -34,6 +34,9 @@ /** * Interface ObjectGroupRepositoryInterface * + * Interface para repositorio de grupos de objetos. + * Define metodos para criar, atualizar, excluir e consultar grupos de objetos. + * * @method setUserGroup(UserGroup $group) * @method getUserGroup() * @method getUser() diff --git a/app/Repositories/ObjectGroup/OrganisesObjectGroups.php b/app/Repositories/ObjectGroup/OrganisesObjectGroups.php index 4f23af15a57..115ec63b3f6 100644 --- a/app/Repositories/ObjectGroup/OrganisesObjectGroups.php +++ b/app/Repositories/ObjectGroup/OrganisesObjectGroups.php @@ -25,7 +25,10 @@ namespace FireflyIII\Repositories\ObjectGroup; /** - * Trait OrganisesRoleGroups + * Trait OrganisesObjectGroups + * + * Trait para organizacao de grupos de objetos. + * Fornece metodos para limpar grupos vazios e reordenar grupos. */ trait OrganisesObjectGroups { diff --git a/app/Repositories/PiggyBank/ModifiesPiggyBanks.php b/app/Repositories/PiggyBank/ModifiesPiggyBanks.php index 658ca6e1c83..5c97d19b86c 100644 --- a/app/Repositories/PiggyBank/ModifiesPiggyBanks.php +++ b/app/Repositories/PiggyBank/ModifiesPiggyBanks.php @@ -41,6 +41,9 @@ /** * Trait ModifiesPiggyBanks + * + * Trait para modificacao de cofrinhos. + * Fornece metodos para adicionar, remover e atualizar valores em cofrinhos. */ trait ModifiesPiggyBanks { diff --git a/app/Repositories/PiggyBank/PiggyBankRepository.php b/app/Repositories/PiggyBank/PiggyBankRepository.php index 711767e0516..3227cebc669 100644 --- a/app/Repositories/PiggyBank/PiggyBankRepository.php +++ b/app/Repositories/PiggyBank/PiggyBankRepository.php @@ -47,6 +47,9 @@ /** * Class PiggyBankRepository. + * + * Repositorio principal para gerenciamento de cofrinhos. + * Fornece metodos para criar, atualizar, excluir e consultar cofrinhos de poupanca. */ class PiggyBankRepository implements PiggyBankRepositoryInterface, UserGroupInterface { diff --git a/app/Repositories/PiggyBank/PiggyBankRepositoryInterface.php b/app/Repositories/PiggyBank/PiggyBankRepositoryInterface.php index 7be09f5fb3d..0cd9e9feaff 100644 --- a/app/Repositories/PiggyBank/PiggyBankRepositoryInterface.php +++ b/app/Repositories/PiggyBank/PiggyBankRepositoryInterface.php @@ -38,6 +38,9 @@ /** * Interface PiggyBankRepositoryInterface. * + * Interface para repositorio de cofrinhos. + * Define metodos para criar, atualizar, excluir e consultar cofrinhos de poupanca. + * * @method setUserGroup(UserGroup $group) * @method getUserGroup() * @method getUser() diff --git a/app/Repositories/Recurring/RecurringRepository.php b/app/Repositories/Recurring/RecurringRepository.php index e12a543e388..98d4fe5cb01 100644 --- a/app/Repositories/Recurring/RecurringRepository.php +++ b/app/Repositories/Recurring/RecurringRepository.php @@ -55,6 +55,9 @@ /** * Class RecurringRepository + * + * Repositorio para gerenciamento de transacoes recorrentes. + * Fornece metodos para criar, atualizar, excluir e consultar recorrencias. */ class RecurringRepository implements RecurringRepositoryInterface, UserGroupInterface { diff --git a/app/Repositories/Recurring/RecurringRepositoryInterface.php b/app/Repositories/Recurring/RecurringRepositoryInterface.php index b59548b9dec..060e49fceda 100644 --- a/app/Repositories/Recurring/RecurringRepositoryInterface.php +++ b/app/Repositories/Recurring/RecurringRepositoryInterface.php @@ -39,6 +39,9 @@ /** * Interface RecurringRepositoryInterface * + * Interface para repositorio de transacoes recorrentes. + * Define metodos para gerenciamento de recorrencias e calculo de ocorrencias. + * * @method setUserGroup(UserGroup $group) * @method getUserGroup() * @method getUser() diff --git a/app/Repositories/Rule/RuleRepository.php b/app/Repositories/Rule/RuleRepository.php index 5774e84e9e8..1ddef73e6e8 100644 --- a/app/Repositories/Rule/RuleRepository.php +++ b/app/Repositories/Rule/RuleRepository.php @@ -37,6 +37,9 @@ /** * Class RuleRepository. + * + * Repositorio principal para gerenciamento de regras de automacao. + * Fornece metodos para criar, atualizar, excluir e consultar regras de transacoes. */ class RuleRepository implements RuleRepositoryInterface, UserGroupInterface { diff --git a/app/Repositories/Rule/RuleRepositoryInterface.php b/app/Repositories/Rule/RuleRepositoryInterface.php index e4d8e53394b..8988054ed50 100644 --- a/app/Repositories/Rule/RuleRepositoryInterface.php +++ b/app/Repositories/Rule/RuleRepositoryInterface.php @@ -36,6 +36,9 @@ /** * Interface RuleRepositoryInterface. * + * Interface para repositorio de regras de automacao. + * Define metodos para criar, atualizar, excluir e consultar regras de transacoes. + * * @method setUserGroup(UserGroup $group) * @method getUserGroup() * @method getUser() diff --git a/app/Repositories/RuleGroup/RuleGroupRepository.php b/app/Repositories/RuleGroup/RuleGroupRepository.php index 3e1694baeed..8b031ed8aca 100644 --- a/app/Repositories/RuleGroup/RuleGroupRepository.php +++ b/app/Repositories/RuleGroup/RuleGroupRepository.php @@ -36,6 +36,9 @@ /** * Class RuleGroupRepository. + * + * Repositorio principal para gerenciamento de grupos de regras. + * Fornece metodos para criar, atualizar, excluir e consultar grupos de regras. */ class RuleGroupRepository implements RuleGroupRepositoryInterface, UserGroupInterface { diff --git a/app/Repositories/RuleGroup/RuleGroupRepositoryInterface.php b/app/Repositories/RuleGroup/RuleGroupRepositoryInterface.php index 54b24c1adb4..d177c31fcb1 100644 --- a/app/Repositories/RuleGroup/RuleGroupRepositoryInterface.php +++ b/app/Repositories/RuleGroup/RuleGroupRepositoryInterface.php @@ -33,6 +33,9 @@ /** * Interface RuleGroupRepositoryInterface. * + * Interface para repositorio de grupos de regras. + * Define metodos para criar, atualizar, excluir e consultar grupos de regras. + * * @method setUserGroup(UserGroup $group) * @method getUserGroup() * @method getUser() diff --git a/app/Repositories/Tag/OperationsRepository.php b/app/Repositories/Tag/OperationsRepository.php index 94ba8a0db50..397446875e0 100644 --- a/app/Repositories/Tag/OperationsRepository.php +++ b/app/Repositories/Tag/OperationsRepository.php @@ -34,6 +34,9 @@ /** * Class OperationsRepository + * + * Repositorio de operacoes de tags. + * Fornece metodos para calcular despesas e receitas por tag. */ class OperationsRepository implements OperationsRepositoryInterface, UserGroupInterface { diff --git a/app/Repositories/Tag/OperationsRepositoryInterface.php b/app/Repositories/Tag/OperationsRepositoryInterface.php index b7cd50c57c6..c5cc2da7bda 100644 --- a/app/Repositories/Tag/OperationsRepositoryInterface.php +++ b/app/Repositories/Tag/OperationsRepositoryInterface.php @@ -34,6 +34,9 @@ /** * Interface OperationsRepositoryInterface * + * Interface para operacoes de tags. + * Define metodos para calcular despesas e receitas por tag. + * * @method setUserGroup(UserGroup $group) * @method getUserGroup() * @method getUser() diff --git a/app/Repositories/Tag/TagRepository.php b/app/Repositories/Tag/TagRepository.php index 11edb3a29d7..4455563063c 100644 --- a/app/Repositories/Tag/TagRepository.php +++ b/app/Repositories/Tag/TagRepository.php @@ -41,6 +41,9 @@ /** * Class TagRepository. + * + * Repositorio principal para gerenciamento de tags. + * Fornece metodos para criar, atualizar, excluir e consultar tags de transacoes. */ class TagRepository implements TagRepositoryInterface, UserGroupInterface { diff --git a/app/Repositories/Tag/TagRepositoryInterface.php b/app/Repositories/Tag/TagRepositoryInterface.php index 2052dff88ca..d1e5b99bc85 100644 --- a/app/Repositories/Tag/TagRepositoryInterface.php +++ b/app/Repositories/Tag/TagRepositoryInterface.php @@ -35,6 +35,9 @@ /** * Interface TagRepositoryInterface. * + * Interface para repositorio de tags. + * Define metodos para criar, atualizar, excluir e consultar tags de transacoes. + * * @method setUserGroup(UserGroup $group) * @method getUserGroup() * @method getUser() diff --git a/app/Repositories/TransactionGroup/TransactionGroupRepository.php b/app/Repositories/TransactionGroup/TransactionGroupRepository.php index 6fce8e43db6..72d976efddf 100644 --- a/app/Repositories/TransactionGroup/TransactionGroupRepository.php +++ b/app/Repositories/TransactionGroup/TransactionGroupRepository.php @@ -54,6 +54,9 @@ /** * Class TransactionGroupRepository + * + * Repositorio principal para gerenciamento de grupos de transacoes. + * Fornece metodos para criar, atualizar, excluir e consultar grupos de transacoes. */ class TransactionGroupRepository implements TransactionGroupRepositoryInterface, UserGroupInterface { diff --git a/app/Repositories/TransactionGroup/TransactionGroupRepositoryInterface.php b/app/Repositories/TransactionGroup/TransactionGroupRepositoryInterface.php index e95cd68f752..099c1a9eafd 100644 --- a/app/Repositories/TransactionGroup/TransactionGroupRepositoryInterface.php +++ b/app/Repositories/TransactionGroup/TransactionGroupRepositoryInterface.php @@ -38,6 +38,9 @@ /** * Interface TransactionGroupRepositoryInterface * + * Interface para repositorio de grupos de transacoes. + * Define metodos para criar, atualizar, excluir e consultar grupos de transacoes. + * * @method setUserGroup(UserGroup $group) * @method getUserGroup() * @method getUser() diff --git a/app/Repositories/TransactionType/TransactionTypeRepository.php b/app/Repositories/TransactionType/TransactionTypeRepository.php index 55c0e2abe50..cef96a4ef1f 100644 --- a/app/Repositories/TransactionType/TransactionTypeRepository.php +++ b/app/Repositories/TransactionType/TransactionTypeRepository.php @@ -30,6 +30,9 @@ /** * Class TransactionTypeRepository + * + * Repositorio para gerenciamento de tipos de transacoes. + * Fornece metodos para consultar tipos de transacoes (deposito, saque, transferencia). */ class TransactionTypeRepository implements TransactionTypeRepositoryInterface { diff --git a/app/Repositories/TransactionType/TransactionTypeRepositoryInterface.php b/app/Repositories/TransactionType/TransactionTypeRepositoryInterface.php index dfc8681fba5..34fb88dcf87 100644 --- a/app/Repositories/TransactionType/TransactionTypeRepositoryInterface.php +++ b/app/Repositories/TransactionType/TransactionTypeRepositoryInterface.php @@ -34,6 +34,9 @@ /** * Interface TransactionTypeRepositoryInterface * + * Interface para repositorio de tipos de transacoes. + * Define metodos para consultar tipos de transacoes (deposito, saque, transferencia). + * * @method setUserGroup(UserGroup $group) * @method getUserGroup() * @method getUser() diff --git a/app/Repositories/User/UserRepository.php b/app/Repositories/User/UserRepository.php index e7d89c4a26e..714f12ca668 100644 --- a/app/Repositories/User/UserRepository.php +++ b/app/Repositories/User/UserRepository.php @@ -40,6 +40,9 @@ /** * Class UserRepository. + * + * Repositorio principal para gerenciamento de usuarios. + * Fornece metodos para criar, atualizar, excluir e consultar usuarios do sistema. */ class UserRepository implements UserRepositoryInterface { diff --git a/app/Repositories/User/UserRepositoryInterface.php b/app/Repositories/User/UserRepositoryInterface.php index 9c9da4e7e34..56ff1ae65c4 100644 --- a/app/Repositories/User/UserRepositoryInterface.php +++ b/app/Repositories/User/UserRepositoryInterface.php @@ -34,6 +34,9 @@ /** * Interface UserRepositoryInterface. * + * Interface para repositorio de usuarios. + * Define metodos para criar, atualizar, excluir e consultar usuarios do sistema. + * * @method setUserGroup(UserGroup $group) * @method getUserGroup() * @method getUser() diff --git a/app/Repositories/UserGroup/UserGroupRepository.php b/app/Repositories/UserGroup/UserGroupRepository.php index f8c9e3a4883..ed8c406871a 100644 --- a/app/Repositories/UserGroup/UserGroupRepository.php +++ b/app/Repositories/UserGroup/UserGroupRepository.php @@ -40,6 +40,9 @@ /** * Class UserGroupRepository + * + * Repositorio principal para gerenciamento de grupos de usuarios. + * Fornece metodos para criar, atualizar, excluir e consultar grupos de usuarios e membros. */ class UserGroupRepository implements UserGroupRepositoryInterface, UserGroupInterface { diff --git a/app/Repositories/UserGroup/UserGroupRepositoryInterface.php b/app/Repositories/UserGroup/UserGroupRepositoryInterface.php index c1a6152ab0a..9699250de54 100644 --- a/app/Repositories/UserGroup/UserGroupRepositoryInterface.php +++ b/app/Repositories/UserGroup/UserGroupRepositoryInterface.php @@ -33,6 +33,9 @@ /** * Interface UserGroupRepositoryInterface * + * Interface para repositorio de grupos de usuarios. + * Define metodos para criar, atualizar, excluir e consultar grupos de usuarios e membros. + * * @method setUserGroup(UserGroup $group) * @method getUserGroup() * @method getUser() diff --git a/app/Repositories/UserGroups/Account/AccountRepository.php b/app/Repositories/UserGroups/Account/AccountRepository.php index 418f16ef8b6..826f0bf1ea4 100644 --- a/app/Repositories/UserGroups/Account/AccountRepository.php +++ b/app/Repositories/UserGroups/Account/AccountRepository.php @@ -45,6 +45,9 @@ /** * Class AccountRepository * + * Repositorio de contas para grupos de usuarios. + * Fornece metodos para consultar, buscar e atualizar contas do grupo. + * * @deprecated */ class AccountRepository implements AccountRepositoryInterface diff --git a/app/Repositories/UserGroups/Account/AccountRepositoryInterface.php b/app/Repositories/UserGroups/Account/AccountRepositoryInterface.php index 6ea484133c1..7c4084595c3 100644 --- a/app/Repositories/UserGroups/Account/AccountRepositoryInterface.php +++ b/app/Repositories/UserGroups/Account/AccountRepositoryInterface.php @@ -31,6 +31,9 @@ /** * Interface AccountRepositoryInterface * + * Interface para repositorio de contas de grupos de usuarios. + * Define metodos para consultar, buscar e atualizar contas do grupo. + * * @deprecated */ interface AccountRepositoryInterface diff --git a/app/Repositories/UserGroups/Bill/BillRepository.php b/app/Repositories/UserGroups/Bill/BillRepository.php index defdaaba0d8..89b5544150b 100644 --- a/app/Repositories/UserGroups/Bill/BillRepository.php +++ b/app/Repositories/UserGroups/Bill/BillRepository.php @@ -37,6 +37,9 @@ /** * Class BillRepository * + * Repositorio de contas a pagar para grupos de usuarios. + * Fornece metodos para gerenciar contas recorrentes e calcular pagamentos. + * * @deprecated */ class BillRepository implements BillRepositoryInterface diff --git a/app/Repositories/UserGroups/Bill/BillRepositoryInterface.php b/app/Repositories/UserGroups/Bill/BillRepositoryInterface.php index 7c2819022e5..c01423681af 100644 --- a/app/Repositories/UserGroups/Bill/BillRepositoryInterface.php +++ b/app/Repositories/UserGroups/Bill/BillRepositoryInterface.php @@ -31,6 +31,9 @@ /** * Interface BillRepositoryInterface * + * Interface para repositorio de contas a pagar de grupos de usuarios. + * Define metodos para gerenciar contas recorrentes e calcular pagamentos. + * * @deprecated */ interface BillRepositoryInterface diff --git a/app/Repositories/UserGroups/Budget/AvailableBudgetRepository.php b/app/Repositories/UserGroups/Budget/AvailableBudgetRepository.php index c07ec329a90..0e7ac58795d 100644 --- a/app/Repositories/UserGroups/Budget/AvailableBudgetRepository.php +++ b/app/Repositories/UserGroups/Budget/AvailableBudgetRepository.php @@ -33,6 +33,9 @@ /** * Class AvailableBudgetRepository * + * Repositorio de orcamento disponivel para grupos de usuarios. + * Fornece metodos para consultar valores disponiveis para orcamento por periodo. + * * @deprecated */ class AvailableBudgetRepository implements AvailableBudgetRepositoryInterface diff --git a/app/Repositories/UserGroups/Budget/AvailableBudgetRepositoryInterface.php b/app/Repositories/UserGroups/Budget/AvailableBudgetRepositoryInterface.php index 33a2c7b203b..41776ddbeb1 100644 --- a/app/Repositories/UserGroups/Budget/AvailableBudgetRepositoryInterface.php +++ b/app/Repositories/UserGroups/Budget/AvailableBudgetRepositoryInterface.php @@ -29,6 +29,9 @@ /** * Interface AvailableBudgetRepositoryInterface * + * Interface para orcamento disponivel de grupos de usuarios. + * Define metodos para consultar valores disponiveis para orcamento por periodo. + * * @deprecated */ interface AvailableBudgetRepositoryInterface diff --git a/app/Repositories/UserGroups/Budget/BudgetRepository.php b/app/Repositories/UserGroups/Budget/BudgetRepository.php index cb43479b712..ad614881004 100644 --- a/app/Repositories/UserGroups/Budget/BudgetRepository.php +++ b/app/Repositories/UserGroups/Budget/BudgetRepository.php @@ -30,6 +30,9 @@ /** * Class BudgetRepository * + * Repositorio de orcamentos para grupos de usuarios. + * Fornece metodos para consultar orcamentos ativos e inativos. + * * @deprecated */ class BudgetRepository implements BudgetRepositoryInterface diff --git a/app/Repositories/UserGroups/Budget/BudgetRepositoryInterface.php b/app/Repositories/UserGroups/Budget/BudgetRepositoryInterface.php index 021736f595d..486e7132e38 100644 --- a/app/Repositories/UserGroups/Budget/BudgetRepositoryInterface.php +++ b/app/Repositories/UserGroups/Budget/BudgetRepositoryInterface.php @@ -29,6 +29,9 @@ /** * Interface BudgetRepositoryInterface * + * Interface para repositorio de orcamentos de grupos de usuarios. + * Define metodos para consultar orcamentos ativos e inativos. + * * @deprecated */ interface BudgetRepositoryInterface diff --git a/app/Repositories/UserGroups/Budget/OperationsRepository.php b/app/Repositories/UserGroups/Budget/OperationsRepository.php index 78944b9d511..1f3cbdf7f17 100644 --- a/app/Repositories/UserGroups/Budget/OperationsRepository.php +++ b/app/Repositories/UserGroups/Budget/OperationsRepository.php @@ -35,6 +35,9 @@ /** * Class OperationsRepository * + * Repositorio de operacoes de orcamento para grupos de usuarios. + * Fornece metodos para listar despesas por orcamento e periodo. + * * @deprecated */ class OperationsRepository implements OperationsRepositoryInterface diff --git a/app/Repositories/UserGroups/Budget/OperationsRepositoryInterface.php b/app/Repositories/UserGroups/Budget/OperationsRepositoryInterface.php index a96b94f658b..08f664c135c 100644 --- a/app/Repositories/UserGroups/Budget/OperationsRepositoryInterface.php +++ b/app/Repositories/UserGroups/Budget/OperationsRepositoryInterface.php @@ -30,6 +30,9 @@ /** * Interface OperationsRepositoryInterface * + * Interface para operacoes de orcamento de grupos de usuarios. + * Define metodos para listar despesas por orcamento e periodo. + * * @deprecated */ interface OperationsRepositoryInterface diff --git a/app/Repositories/UserGroups/Currency/CurrencyRepository.php b/app/Repositories/UserGroups/Currency/CurrencyRepository.php index 7928ec74e66..13658018e3e 100644 --- a/app/Repositories/UserGroups/Currency/CurrencyRepository.php +++ b/app/Repositories/UserGroups/Currency/CurrencyRepository.php @@ -46,6 +46,9 @@ /** * Class CurrencyRepository * + * Repositorio de moedas para grupos de usuarios. + * Fornece metodos para gerenciar moedas, incluindo ativacao, desativacao e definicao de moeda padrao. + * * @deprecated */ class CurrencyRepository implements CurrencyRepositoryInterface diff --git a/app/Repositories/UserGroups/Currency/CurrencyRepositoryInterface.php b/app/Repositories/UserGroups/Currency/CurrencyRepositoryInterface.php index 8c34e227088..b2fd87094bb 100644 --- a/app/Repositories/UserGroups/Currency/CurrencyRepositoryInterface.php +++ b/app/Repositories/UserGroups/Currency/CurrencyRepositoryInterface.php @@ -31,6 +31,9 @@ /** * Interface CurrencyRepositoryInterface * + * Interface para repositorio de moedas de grupos de usuarios. + * Define metodos para gerenciar moedas, incluindo ativacao, desativacao e definicao de moeda padrao. + * * @deprecated */ interface CurrencyRepositoryInterface diff --git a/app/Repositories/UserGroups/ExchangeRate/ExchangeRateRepository.php b/app/Repositories/UserGroups/ExchangeRate/ExchangeRateRepository.php index 3dc1d6a7972..94d358d28f6 100644 --- a/app/Repositories/UserGroups/ExchangeRate/ExchangeRateRepository.php +++ b/app/Repositories/UserGroups/ExchangeRate/ExchangeRateRepository.php @@ -35,6 +35,9 @@ /** * Class ExchangeRateRepository * + * Repositorio de taxas de cambio para grupos de usuarios. + * Fornece metodos para gerenciar taxas de conversao entre moedas. + * * @deprecated */ class ExchangeRateRepository implements ExchangeRateRepositoryInterface diff --git a/app/Repositories/UserGroups/ExchangeRate/ExchangeRateRepositoryInterface.php b/app/Repositories/UserGroups/ExchangeRate/ExchangeRateRepositoryInterface.php index 00e164d15e5..9ce1f175348 100644 --- a/app/Repositories/UserGroups/ExchangeRate/ExchangeRateRepositoryInterface.php +++ b/app/Repositories/UserGroups/ExchangeRate/ExchangeRateRepositoryInterface.php @@ -32,6 +32,9 @@ /** * Interface ExchangeRateRepositoryInterface * + * Interface para repositorio de taxas de cambio de grupos de usuarios. + * Define metodos para gerenciar taxas de conversao entre moedas. + * * @deprecated */ interface ExchangeRateRepositoryInterface diff --git a/app/Repositories/UserGroups/Journal/JournalRepository.php b/app/Repositories/UserGroups/Journal/JournalRepository.php index 8926573acdc..bf5d4a2f780 100644 --- a/app/Repositories/UserGroups/Journal/JournalRepository.php +++ b/app/Repositories/UserGroups/Journal/JournalRepository.php @@ -31,6 +31,9 @@ /** * Class JournalRepository * + * Repositorio de diarios de transacoes para grupos de usuarios. + * Fornece metodos para buscar descricoes de transacoes. + * * @deprecated */ class JournalRepository implements JournalRepositoryInterface diff --git a/app/Repositories/UserGroups/Journal/JournalRepositoryInterface.php b/app/Repositories/UserGroups/Journal/JournalRepositoryInterface.php index c8321fcd7c8..7f5d793b257 100644 --- a/app/Repositories/UserGroups/Journal/JournalRepositoryInterface.php +++ b/app/Repositories/UserGroups/Journal/JournalRepositoryInterface.php @@ -29,6 +29,9 @@ /** * Interface JournalRepositoryInterface * + * Interface para repositorio de diarios de transacoes de grupos de usuarios. + * Define metodos para buscar descricoes de transacoes. + * * @deprecated */ interface JournalRepositoryInterface diff --git a/app/Repositories/UserGroups/PiggyBank/PiggyBankRepository.php b/app/Repositories/UserGroups/PiggyBank/PiggyBankRepository.php index c1312306f7f..301a4d09675 100644 --- a/app/Repositories/UserGroups/PiggyBank/PiggyBankRepository.php +++ b/app/Repositories/UserGroups/PiggyBank/PiggyBankRepository.php @@ -31,6 +31,9 @@ /** * Class PiggyBankRepository * + * Repositorio de cofrinhos para grupos de usuarios. + * Fornece metodos para consultar cofrinhos do grupo. + * * @deprecated */ class PiggyBankRepository implements PiggyBankRepositoryInterface diff --git a/app/Repositories/UserGroups/PiggyBank/PiggyBankRepositoryInterface.php b/app/Repositories/UserGroups/PiggyBank/PiggyBankRepositoryInterface.php index cf39595a4b0..61a69938a1d 100644 --- a/app/Repositories/UserGroups/PiggyBank/PiggyBankRepositoryInterface.php +++ b/app/Repositories/UserGroups/PiggyBank/PiggyBankRepositoryInterface.php @@ -29,6 +29,9 @@ /** * Interface PiggyBankRepositoryInterface * + * Interface para repositorio de cofrinhos de grupos de usuarios. + * Define metodos para consultar cofrinhos do grupo. + * * @deprecated */ interface PiggyBankRepositoryInterface diff --git a/app/Repositories/UserGroups/Tag/TagRepository.php b/app/Repositories/UserGroups/Tag/TagRepository.php index 49f9c2e044a..c382667ed53 100644 --- a/app/Repositories/UserGroups/Tag/TagRepository.php +++ b/app/Repositories/UserGroups/Tag/TagRepository.php @@ -31,6 +31,9 @@ /** * Class TagRepository * + * Repositorio de tags para grupos de usuarios. + * Fornece metodos para buscar tags do grupo. + * * @deprecated */ class TagRepository implements TagRepositoryInterface diff --git a/app/Repositories/UserGroups/Tag/TagRepositoryInterface.php b/app/Repositories/UserGroups/Tag/TagRepositoryInterface.php index f5aa6775600..0f2540baf55 100644 --- a/app/Repositories/UserGroups/Tag/TagRepositoryInterface.php +++ b/app/Repositories/UserGroups/Tag/TagRepositoryInterface.php @@ -29,6 +29,9 @@ /** * Interface TagRepositoryInterface * + * Interface para repositorio de tags de grupos de usuarios. + * Define metodos para buscar tags do grupo. + * * @deprecated */ interface TagRepositoryInterface diff --git a/app/Repositories/Webhook/WebhookRepository.php b/app/Repositories/Webhook/WebhookRepository.php index 6d684b8984e..1e58920da3b 100644 --- a/app/Repositories/Webhook/WebhookRepository.php +++ b/app/Repositories/Webhook/WebhookRepository.php @@ -34,6 +34,9 @@ /** * Class WebhookRepository + * + * Repositorio principal para gerenciamento de webhooks. + * Fornece metodos para criar, atualizar, excluir e consultar webhooks de notificacao. */ class WebhookRepository implements WebhookRepositoryInterface, UserGroupInterface { diff --git a/app/Repositories/Webhook/WebhookRepositoryInterface.php b/app/Repositories/Webhook/WebhookRepositoryInterface.php index ae7e91d5ca9..3e906d27d1c 100644 --- a/app/Repositories/Webhook/WebhookRepositoryInterface.php +++ b/app/Repositories/Webhook/WebhookRepositoryInterface.php @@ -36,6 +36,9 @@ /** * Interface WebhookRepositoryInterface * + * Interface para repositorio de webhooks. + * Define metodos para criar, atualizar, excluir e consultar webhooks de notificacao. + * * @method setUserGroup(UserGroup $group) * @method getUserGroup() * @method getUser() diff --git a/app/Rules/Account/IsValidAccountType.php b/app/Rules/Account/IsValidAccountType.php index 52042572f11..eebe0989a15 100644 --- a/app/Rules/Account/IsValidAccountType.php +++ b/app/Rules/Account/IsValidAccountType.php @@ -29,6 +29,11 @@ use Closure; use Override; +/** + * Class IsValidAccountType. + * + * Regra de validacao para tipo de conta valido. + */ class IsValidAccountType implements ValidationRule { use AccountFilter; diff --git a/app/Rules/Admin/IsValidDiscordUrl.php b/app/Rules/Admin/IsValidDiscordUrl.php index ccb48009352..840ba3a9174 100644 --- a/app/Rules/Admin/IsValidDiscordUrl.php +++ b/app/Rules/Admin/IsValidDiscordUrl.php @@ -30,6 +30,11 @@ use Illuminate\Support\Facades\Log; use Closure; +/** + * Class IsValidDiscordUrl. + * + * Regra de validacao para URL do Discord. + */ class IsValidDiscordUrl implements ValidationRule { use ValidatesAmountsTrait; diff --git a/app/Rules/Admin/IsValidSlackOrDiscordUrl.php b/app/Rules/Admin/IsValidSlackOrDiscordUrl.php index 5b9f6063dab..a41212af36e 100644 --- a/app/Rules/Admin/IsValidSlackOrDiscordUrl.php +++ b/app/Rules/Admin/IsValidSlackOrDiscordUrl.php @@ -30,6 +30,11 @@ use Illuminate\Support\Facades\Log; use Closure; +/** + * Class IsValidSlackOrDiscordUrl. + * + * Regra de validacao para URL do Slack ou Discord. + */ class IsValidSlackOrDiscordUrl implements ValidationRule { use ValidatesAmountsTrait; diff --git a/app/Rules/Admin/IsValidSlackUrl.php b/app/Rules/Admin/IsValidSlackUrl.php index 90fc1dafcd2..b1021b89d23 100644 --- a/app/Rules/Admin/IsValidSlackUrl.php +++ b/app/Rules/Admin/IsValidSlackUrl.php @@ -30,6 +30,11 @@ use Illuminate\Support\Facades\Log; use Closure; +/** + * Class IsValidSlackUrl. + * + * Regra de validacao para URL do Slack. + */ class IsValidSlackUrl implements ValidationRule { use ValidatesAmountsTrait; diff --git a/app/Rules/BelongsUser.php b/app/Rules/BelongsUser.php index 2e1fa3a9c2a..b10ce36aa6e 100644 --- a/app/Rules/BelongsUser.php +++ b/app/Rules/BelongsUser.php @@ -35,7 +35,9 @@ use Closure; /** - * Class BelongsUser + * Class BelongsUser. + * + * Regra de validacao para pertencimento ao usuario. */ class BelongsUser implements ValidationRule { diff --git a/app/Rules/BelongsUserGroup.php b/app/Rules/BelongsUserGroup.php index fe29b1fbef6..2cea1476f99 100644 --- a/app/Rules/BelongsUserGroup.php +++ b/app/Rules/BelongsUserGroup.php @@ -36,7 +36,10 @@ use Closure; /** - * Class BelongsUserGroup + * Class BelongsUserGroup. + * + * Regra de validacao para pertencimento a grupo de usuario. + * * TODO this method has a lot in common with BelongsUser but will check if the UserGroup * TODO that is submitted is valid. This method will not validate if the user has a valid ROLE in this * TODO group. diff --git a/app/Rules/IsAllowedGroupAction.php b/app/Rules/IsAllowedGroupAction.php index f3a197f113e..872197d7173 100644 --- a/app/Rules/IsAllowedGroupAction.php +++ b/app/Rules/IsAllowedGroupAction.php @@ -34,6 +34,11 @@ use Closure; use Override; +/** + * Class IsAllowedGroupAction. + * + * Regra de validacao para acao permitida em grupo. + */ class IsAllowedGroupAction implements ValidationRule { private array $acceptedRoles; diff --git a/app/Rules/IsAssetAccountId.php b/app/Rules/IsAssetAccountId.php index e8d26937fd5..e7bcf792f8d 100644 --- a/app/Rules/IsAssetAccountId.php +++ b/app/Rules/IsAssetAccountId.php @@ -29,7 +29,9 @@ use Closure; /** - * Class IsAssetAccountId + * Class IsAssetAccountId. + * + * Regra de validacao para ID de conta de ativo. */ class IsAssetAccountId implements ValidationRule { diff --git a/app/Rules/IsBoolean.php b/app/Rules/IsBoolean.php index 28c1ca37812..ec1e6d1e71f 100644 --- a/app/Rules/IsBoolean.php +++ b/app/Rules/IsBoolean.php @@ -28,7 +28,9 @@ use Closure; /** - * Class IsBoolean + * Class IsBoolean. + * + * Regra de validacao para valor booleano. */ class IsBoolean implements ValidationRule { diff --git a/app/Rules/IsDateOrTime.php b/app/Rules/IsDateOrTime.php index 64d711ec99f..3f46d06c8d9 100644 --- a/app/Rules/IsDateOrTime.php +++ b/app/Rules/IsDateOrTime.php @@ -31,7 +31,9 @@ use Closure; /** - * Class IsDateOrTime + * Class IsDateOrTime. + * + * Regra de validacao para data ou hora. */ class IsDateOrTime implements ValidationRule { diff --git a/app/Rules/IsDefaultUserGroupName.php b/app/Rules/IsDefaultUserGroupName.php index 81b366a2e61..0bb4ed32c0f 100644 --- a/app/Rules/IsDefaultUserGroupName.php +++ b/app/Rules/IsDefaultUserGroupName.php @@ -31,7 +31,9 @@ use Closure; /** - * Class IsDefaultUserGroupName + * Class IsDefaultUserGroupName. + * + * Regra de validacao para nome de grupo de usuario padrao. */ class IsDefaultUserGroupName implements ValidationRule { diff --git a/app/Rules/IsDuplicateTransaction.php b/app/Rules/IsDuplicateTransaction.php index e0f6d4ac23e..f8dda30b5e2 100644 --- a/app/Rules/IsDuplicateTransaction.php +++ b/app/Rules/IsDuplicateTransaction.php @@ -28,9 +28,11 @@ use Closure; /** - * TODO not sure where this is used. + * Class IsDuplicateTransaction. + * + * Regra de validacao para transacao duplicada. * - * Class IsDuplicateTransaction + * TODO not sure where this is used. */ class IsDuplicateTransaction implements ValidationRule { diff --git a/app/Rules/IsFilterValueIn.php b/app/Rules/IsFilterValueIn.php index e167bdb79c0..c19db569062 100644 --- a/app/Rules/IsFilterValueIn.php +++ b/app/Rules/IsFilterValueIn.php @@ -27,6 +27,11 @@ use Illuminate\Contracts\Validation\ValidationRule; use Closure; +/** + * Class IsFilterValueIn. + * + * Regra de validacao para valor de filtro em lista. + */ class IsFilterValueIn implements ValidationRule { public function __construct(private readonly string $key, private readonly array $values) {} diff --git a/app/Rules/IsTransferAccount.php b/app/Rules/IsTransferAccount.php index 22f1fc5d8c9..1910cc08c29 100644 --- a/app/Rules/IsTransferAccount.php +++ b/app/Rules/IsTransferAccount.php @@ -30,7 +30,9 @@ use Closure; /** - * Class IsTransferAccount + * Class IsTransferAccount. + * + * Regra de validacao para conta de transferencia. */ class IsTransferAccount implements ValidationRule { diff --git a/app/Rules/IsValidActionExpression.php b/app/Rules/IsValidActionExpression.php index d12b507bd38..11ac58b3c90 100644 --- a/app/Rules/IsValidActionExpression.php +++ b/app/Rules/IsValidActionExpression.php @@ -30,6 +30,11 @@ use Illuminate\Translation\PotentiallyTranslatedString; use Closure; +/** + * Class IsValidActionExpression. + * + * Regra de validacao para expressao de acao valida. + */ class IsValidActionExpression implements ValidationRule { /** diff --git a/app/Rules/IsValidAmount.php b/app/Rules/IsValidAmount.php index 208d60c6964..14ea4a0ecf2 100644 --- a/app/Rules/IsValidAmount.php +++ b/app/Rules/IsValidAmount.php @@ -30,6 +30,11 @@ use Illuminate\Support\Facades\Log; use Closure; +/** + * Class IsValidAmount. + * + * Regra de validacao para valor valido. + */ class IsValidAmount implements ValidationRule { use ValidatesAmountsTrait; diff --git a/app/Rules/IsValidAttachmentModel.php b/app/Rules/IsValidAttachmentModel.php index 093e650cf2b..f52bee992ec 100644 --- a/app/Rules/IsValidAttachmentModel.php +++ b/app/Rules/IsValidAttachmentModel.php @@ -44,7 +44,9 @@ use Closure; /** - * Class IsValidAttachmentModel + * Class IsValidAttachmentModel. + * + * Regra de validacao para modelo de anexo valido. */ class IsValidAttachmentModel implements ValidationRule { diff --git a/app/Rules/IsValidBulkClause.php b/app/Rules/IsValidBulkClause.php index 8be8759eed6..63ab939f38e 100644 --- a/app/Rules/IsValidBulkClause.php +++ b/app/Rules/IsValidBulkClause.php @@ -32,7 +32,9 @@ use function Safe\json_decode; /** - * Class IsValidBulkClause + * Class IsValidBulkClause. + * + * Regra de validacao para clausula de operacao em massa. */ class IsValidBulkClause implements ValidationRule { diff --git a/app/Rules/IsValidDateRange.php b/app/Rules/IsValidDateRange.php index faf4b4343e9..e91aee5eb67 100644 --- a/app/Rules/IsValidDateRange.php +++ b/app/Rules/IsValidDateRange.php @@ -30,6 +30,11 @@ use Illuminate\Contracts\Validation\ValidationRule; use Closure; +/** + * Class IsValidDateRange. + * + * Regra de validacao para intervalo de datas valido. + */ class IsValidDateRange implements ValidationRule { /** diff --git a/app/Rules/IsValidPositiveAmount.php b/app/Rules/IsValidPositiveAmount.php index 2c6eeb63cd1..64271d0696a 100644 --- a/app/Rules/IsValidPositiveAmount.php +++ b/app/Rules/IsValidPositiveAmount.php @@ -32,6 +32,11 @@ use function Safe\json_encode; +/** + * Class IsValidPositiveAmount. + * + * Regra de validacao para valor positivo valido. + */ class IsValidPositiveAmount implements ValidationRule { use ValidatesAmountsTrait; diff --git a/app/Rules/IsValidZeroOrMoreAmount.php b/app/Rules/IsValidZeroOrMoreAmount.php index 3c937623334..dcae173ac93 100644 --- a/app/Rules/IsValidZeroOrMoreAmount.php +++ b/app/Rules/IsValidZeroOrMoreAmount.php @@ -30,6 +30,11 @@ use Illuminate\Support\Facades\Log; use Closure; +/** + * Class IsValidZeroOrMoreAmount. + * + * Regra de validacao para valor zero ou maior. + */ class IsValidZeroOrMoreAmount implements ValidationRule { use ValidatesAmountsTrait; diff --git a/app/Rules/LessThanPiggyTarget.php b/app/Rules/LessThanPiggyTarget.php index 78df1868756..9535a10e67c 100644 --- a/app/Rules/LessThanPiggyTarget.php +++ b/app/Rules/LessThanPiggyTarget.php @@ -28,7 +28,9 @@ use Closure; /** - * Class LessThanPiggyTarget + * Class LessThanPiggyTarget. + * + * Regra de validacao para valor menor que meta do cofrinho. */ class LessThanPiggyTarget implements ValidationRule { diff --git a/app/Rules/UniqueAccountNumber.php b/app/Rules/UniqueAccountNumber.php index 9cfae9d359f..4169cf3ae58 100644 --- a/app/Rules/UniqueAccountNumber.php +++ b/app/Rules/UniqueAccountNumber.php @@ -33,7 +33,9 @@ use function Safe\json_encode; /** - * Class UniqueAccountNumber + * Class UniqueAccountNumber. + * + * Regra de validacao para numero de conta unico. */ class UniqueAccountNumber implements ValidationRule { diff --git a/app/Rules/UniqueIban.php b/app/Rules/UniqueIban.php index 9246326c157..36d31865544 100644 --- a/app/Rules/UniqueIban.php +++ b/app/Rules/UniqueIban.php @@ -31,7 +31,9 @@ use Closure; /** - * Class UniqueIban + * Class UniqueIban. + * + * Regra de validacao para IBAN unico. */ class UniqueIban implements ValidationRule { diff --git a/app/Rules/ValidJournals.php b/app/Rules/ValidJournals.php index 2e2b6c62302..d11187a51b6 100644 --- a/app/Rules/ValidJournals.php +++ b/app/Rules/ValidJournals.php @@ -29,7 +29,9 @@ use Closure; /** - * Class ValidJournals + * Class ValidJournals. + * + * Regra de validacao para lancamentos validos. */ class ValidJournals implements ValidationRule { diff --git a/app/Rules/ValidRecurrenceRepetitionType.php b/app/Rules/ValidRecurrenceRepetitionType.php index f8e0fe36066..f5ade3ae50b 100644 --- a/app/Rules/ValidRecurrenceRepetitionType.php +++ b/app/Rules/ValidRecurrenceRepetitionType.php @@ -28,7 +28,9 @@ use Closure; /** - * Class ValidRecurrenceRepetitionType + * Class ValidRecurrenceRepetitionType. + * + * Regra de validacao para tipo de repeticao de recorrencia. */ class ValidRecurrenceRepetitionType implements ValidationRule { diff --git a/app/Rules/ValidRecurrenceRepetitionValue.php b/app/Rules/ValidRecurrenceRepetitionValue.php index 5a1a4b9031f..19e6bdbb085 100644 --- a/app/Rules/ValidRecurrenceRepetitionValue.php +++ b/app/Rules/ValidRecurrenceRepetitionValue.php @@ -30,7 +30,9 @@ use InvalidArgumentException; /** - * Class ValidRecurrenceRepetitionValue + * Class ValidRecurrenceRepetitionValue. + * + * Regra de validacao para valor de repeticao de recorrencia. */ class ValidRecurrenceRepetitionValue implements ValidationRule { diff --git a/app/Services/FireflyIIIOrg/Update/UpdateRequest.php b/app/Services/FireflyIIIOrg/Update/UpdateRequest.php index 9516071ddba..c81d4a2f2d4 100644 --- a/app/Services/FireflyIIIOrg/Update/UpdateRequest.php +++ b/app/Services/FireflyIIIOrg/Update/UpdateRequest.php @@ -35,6 +35,9 @@ /** * Class UpdateRequest + * + * Servico para verificacao de atualizacoes do Firefly III. + * Contata o servidor de atualizacoes e compara versoes para notificar o usuario. */ class UpdateRequest implements UpdateRequestInterface { diff --git a/app/Services/FireflyIIIOrg/Update/UpdateRequestInterface.php b/app/Services/FireflyIIIOrg/Update/UpdateRequestInterface.php index f0e51d43be3..007c3ec0532 100644 --- a/app/Services/FireflyIIIOrg/Update/UpdateRequestInterface.php +++ b/app/Services/FireflyIIIOrg/Update/UpdateRequestInterface.php @@ -26,6 +26,9 @@ /** * Interface UpdateRequestInterface + * + * Interface para servico de verificacao de atualizacoes. + * Define metodo para obter informacoes sobre novas versoes disponiveis. */ interface UpdateRequestInterface { diff --git a/app/Services/Internal/Destroy/AccountDestroyService.php b/app/Services/Internal/Destroy/AccountDestroyService.php index e2e4cb994b2..4f80e92c05c 100644 --- a/app/Services/Internal/Destroy/AccountDestroyService.php +++ b/app/Services/Internal/Destroy/AccountDestroyService.php @@ -36,6 +36,9 @@ /** * Class AccountDestroyService + * + * Servico para exclusao de contas. + * Gerencia a exclusao segura de contas, incluindo saldos iniciais e transacoes relacionadas. */ class AccountDestroyService { diff --git a/app/Services/Internal/Destroy/BillDestroyService.php b/app/Services/Internal/Destroy/BillDestroyService.php index b5a6a2c233e..38f5d0d4bc5 100644 --- a/app/Services/Internal/Destroy/BillDestroyService.php +++ b/app/Services/Internal/Destroy/BillDestroyService.php @@ -28,6 +28,9 @@ /** * Class BillDestroyService + * + * Servico para exclusao de contas a pagar. + * Gerencia a exclusao segura de faturas recorrentes. */ class BillDestroyService { diff --git a/app/Services/Internal/Destroy/BudgetDestroyService.php b/app/Services/Internal/Destroy/BudgetDestroyService.php index 0391ce924ad..17705347063 100644 --- a/app/Services/Internal/Destroy/BudgetDestroyService.php +++ b/app/Services/Internal/Destroy/BudgetDestroyService.php @@ -29,6 +29,9 @@ /** * Class BudgetDestroyService + * + * Servico para exclusao de orcamentos. + * Gerencia a exclusao segura de orcamentos e suas relacoes com transacoes. */ class BudgetDestroyService { diff --git a/app/Services/Internal/Destroy/CategoryDestroyService.php b/app/Services/Internal/Destroy/CategoryDestroyService.php index 04b6fb38739..f0af8148ae2 100644 --- a/app/Services/Internal/Destroy/CategoryDestroyService.php +++ b/app/Services/Internal/Destroy/CategoryDestroyService.php @@ -29,6 +29,9 @@ /** * Class CategoryDestroyService + * + * Servico para exclusao de categorias. + * Gerencia a exclusao segura de categorias e suas relacoes com transacoes. */ class CategoryDestroyService { diff --git a/app/Services/Internal/Destroy/CurrencyDestroyService.php b/app/Services/Internal/Destroy/CurrencyDestroyService.php index 4ab8b0c1b86..6287e3107ed 100644 --- a/app/Services/Internal/Destroy/CurrencyDestroyService.php +++ b/app/Services/Internal/Destroy/CurrencyDestroyService.php @@ -28,6 +28,9 @@ /** * Class CurrencyDestroyService + * + * Servico para exclusao de moedas. + * Gerencia a exclusao segura de moedas de transacao. */ class CurrencyDestroyService { diff --git a/app/Services/Internal/Destroy/JournalDestroyService.php b/app/Services/Internal/Destroy/JournalDestroyService.php index 77f63fa3ff6..ec3f4a8898d 100644 --- a/app/Services/Internal/Destroy/JournalDestroyService.php +++ b/app/Services/Internal/Destroy/JournalDestroyService.php @@ -33,6 +33,9 @@ /** * Class JournalDestroyService + * + * Servico para exclusao de diarios de transacoes. + * Gerencia a exclusao segura de transacoes e seus metadados relacionados. */ class JournalDestroyService { diff --git a/app/Services/Internal/Destroy/RecurrenceDestroyService.php b/app/Services/Internal/Destroy/RecurrenceDestroyService.php index 4c9385bc771..a00ca92fdd7 100644 --- a/app/Services/Internal/Destroy/RecurrenceDestroyService.php +++ b/app/Services/Internal/Destroy/RecurrenceDestroyService.php @@ -29,6 +29,9 @@ /** * Class RecurrenceDestroyService + * + * Servico para exclusao de transacoes recorrentes. + * Gerencia a exclusao segura de recorrencias e seus metadados relacionados. */ class RecurrenceDestroyService { diff --git a/app/Services/Internal/Destroy/TransactionGroupDestroyService.php b/app/Services/Internal/Destroy/TransactionGroupDestroyService.php index 281a49e0c8e..06d8ff7eab3 100644 --- a/app/Services/Internal/Destroy/TransactionGroupDestroyService.php +++ b/app/Services/Internal/Destroy/TransactionGroupDestroyService.php @@ -29,6 +29,9 @@ /** * Class TransactionGroupDestroyService + * + * Servico para exclusao de grupos de transacoes. + * Gerencia a exclusao segura de grupos e seus diarios de transacoes. */ class TransactionGroupDestroyService { diff --git a/app/Services/Internal/Support/AccountServiceTrait.php b/app/Services/Internal/Support/AccountServiceTrait.php index f3225155c70..2f9abae9ff6 100644 --- a/app/Services/Internal/Support/AccountServiceTrait.php +++ b/app/Services/Internal/Support/AccountServiceTrait.php @@ -44,6 +44,9 @@ /** * Trait AccountServiceTrait + * + * Trait com funcionalidades de servico de contas. + * Fornece metodos para gerenciar metadados, saldos iniciais e notas de contas. */ trait AccountServiceTrait { diff --git a/app/Services/Internal/Support/BillServiceTrait.php b/app/Services/Internal/Support/BillServiceTrait.php index c3a73b1e83c..255fe35379c 100644 --- a/app/Services/Internal/Support/BillServiceTrait.php +++ b/app/Services/Internal/Support/BillServiceTrait.php @@ -30,6 +30,9 @@ /** * Trait BillServiceTrait + * + * Trait com funcionalidades de servico de contas a pagar. + * Fornece metodos para atualizar acoes de regras e notas de faturas. */ trait BillServiceTrait { diff --git a/app/Services/Internal/Support/CreditRecalculateService.php b/app/Services/Internal/Support/CreditRecalculateService.php index da77efb15aa..47951be3d60 100644 --- a/app/Services/Internal/Support/CreditRecalculateService.php +++ b/app/Services/Internal/Support/CreditRecalculateService.php @@ -37,6 +37,9 @@ /** * Class CreditRecalculateService + * + * Servico para recalculo de creditos de passivos. + * Gerencia o calculo de dividas e creditos em contas de passivo. */ class CreditRecalculateService { diff --git a/app/Services/Internal/Support/JournalServiceTrait.php b/app/Services/Internal/Support/JournalServiceTrait.php index d0de5db9df7..2a3a8c73101 100644 --- a/app/Services/Internal/Support/JournalServiceTrait.php +++ b/app/Services/Internal/Support/JournalServiceTrait.php @@ -43,6 +43,9 @@ /** * Trait JournalServiceTrait + * + * Trait com funcionalidades de servico de diarios de transacoes. + * Fornece metodos para encontrar contas, armazenar orcamentos, categorias e tags. */ trait JournalServiceTrait { diff --git a/app/Services/Internal/Support/LocationServiceTrait.php b/app/Services/Internal/Support/LocationServiceTrait.php index 38b63f963d6..6fb5789a703 100644 --- a/app/Services/Internal/Support/LocationServiceTrait.php +++ b/app/Services/Internal/Support/LocationServiceTrait.php @@ -28,7 +28,10 @@ use Illuminate\Database\Eloquent\Model; /** - * Class LocationServiceTrait + * Trait LocationServiceTrait + * + * Trait com funcionalidades de servico de localizacao. + * Fornece metodos para armazenar coordenadas geograficas em modelos. */ trait LocationServiceTrait { diff --git a/app/Services/Internal/Support/RecurringTransactionTrait.php b/app/Services/Internal/Support/RecurringTransactionTrait.php index 6ac399f6e5d..0535f3f1eed 100644 --- a/app/Services/Internal/Support/RecurringTransactionTrait.php +++ b/app/Services/Internal/Support/RecurringTransactionTrait.php @@ -47,6 +47,9 @@ /** * Trait RecurringTransactionTrait + * + * Trait com funcionalidades de transacoes recorrentes. + * Fornece metodos para criar, atualizar e excluir repeticoes e transacoes recorrentes. */ trait RecurringTransactionTrait { diff --git a/app/Services/Internal/Support/TransactionTypeTrait.php b/app/Services/Internal/Support/TransactionTypeTrait.php index a9fe1308c8b..3e551dc3cd4 100644 --- a/app/Services/Internal/Support/TransactionTypeTrait.php +++ b/app/Services/Internal/Support/TransactionTypeTrait.php @@ -30,6 +30,9 @@ /** * Trait TransactionTypeTrait + * + * Trait com funcionalidades de tipos de transacao. + * Fornece metodo para encontrar tipos de transacao por nome. */ trait TransactionTypeTrait { diff --git a/app/Services/Internal/Update/AccountUpdateService.php b/app/Services/Internal/Update/AccountUpdateService.php index 5e1f230b4d8..e9c24e32872 100644 --- a/app/Services/Internal/Update/AccountUpdateService.php +++ b/app/Services/Internal/Update/AccountUpdateService.php @@ -36,6 +36,9 @@ /** * Class AccountUpdateService + * + * Servico para atualizacao de contas. + * Gerencia a atualizacao de dados de contas, metadados, saldos iniciais e localizacoes. * TODO this service is messy and convoluted. */ class AccountUpdateService diff --git a/app/Services/Internal/Update/BillUpdateService.php b/app/Services/Internal/Update/BillUpdateService.php index a4aca38ce4b..ea0f8623dfb 100644 --- a/app/Services/Internal/Update/BillUpdateService.php +++ b/app/Services/Internal/Update/BillUpdateService.php @@ -38,6 +38,9 @@ /** * Class BillUpdateService + * + * Servico para atualizacao de contas a pagar. + * Gerencia a atualizacao de dados de faturas, grupos de objetos e regras associadas. */ class BillUpdateService { diff --git a/app/Services/Internal/Update/CategoryUpdateService.php b/app/Services/Internal/Update/CategoryUpdateService.php index 28b5f36f008..96a3f6b1c84 100644 --- a/app/Services/Internal/Update/CategoryUpdateService.php +++ b/app/Services/Internal/Update/CategoryUpdateService.php @@ -34,6 +34,9 @@ /** * Class CategoryUpdateService + * + * Servico para atualizacao de categorias. + * Gerencia a atualizacao de dados de categorias, gatilhos de regras e recorrencias. */ class CategoryUpdateService { diff --git a/app/Services/Internal/Update/CurrencyUpdateService.php b/app/Services/Internal/Update/CurrencyUpdateService.php index 445b82ac630..1650b7ba81c 100644 --- a/app/Services/Internal/Update/CurrencyUpdateService.php +++ b/app/Services/Internal/Update/CurrencyUpdateService.php @@ -28,6 +28,9 @@ /** * Class CurrencyUpdateService + * + * Servico para atualizacao de moedas. + * Gerencia a atualizacao de dados de moedas de transacao. */ class CurrencyUpdateService { diff --git a/app/Services/Internal/Update/GroupCloneService.php b/app/Services/Internal/Update/GroupCloneService.php index db78b5092ba..f1e0a272281 100644 --- a/app/Services/Internal/Update/GroupCloneService.php +++ b/app/Services/Internal/Update/GroupCloneService.php @@ -37,6 +37,9 @@ /** * Class GroupCloneService + * + * Servico para clonagem de grupos de transacoes. + * Gerencia a duplicacao de grupos, diarios, transacoes e metadados associados. */ class GroupCloneService { diff --git a/app/Services/Internal/Update/GroupUpdateService.php b/app/Services/Internal/Update/GroupUpdateService.php index 384f3049384..ea0a7f05b81 100644 --- a/app/Services/Internal/Update/GroupUpdateService.php +++ b/app/Services/Internal/Update/GroupUpdateService.php @@ -35,6 +35,9 @@ /** * Class GroupUpdateService + * + * Servico para atualizacao de grupos de transacoes. + * Gerencia a atualizacao de grupos, criacao e exclusao de diarios de transacoes. */ class GroupUpdateService { diff --git a/app/Services/Internal/Update/JournalUpdateService.php b/app/Services/Internal/Update/JournalUpdateService.php index 9f53540109c..c23d6fb1fc4 100644 --- a/app/Services/Internal/Update/JournalUpdateService.php +++ b/app/Services/Internal/Update/JournalUpdateService.php @@ -51,9 +51,10 @@ use Illuminate\Support\Facades\Log; /** - * Class to centralise code that updates a journal given the input by system. - * * Class JournalUpdateService + * + * Servico para atualizacao de diarios de transacoes. + * Centraliza o codigo que atualiza um diario com base nos dados de entrada do sistema. */ class JournalUpdateService { diff --git a/app/Services/Internal/Update/RecurrenceUpdateService.php b/app/Services/Internal/Update/RecurrenceUpdateService.php index 7cad86a146f..cae5575b648 100644 --- a/app/Services/Internal/Update/RecurrenceUpdateService.php +++ b/app/Services/Internal/Update/RecurrenceUpdateService.php @@ -36,6 +36,9 @@ /** * Class RecurrenceUpdateService + * + * Servico para atualizacao de transacoes recorrentes. + * Gerencia a atualizacao de recorrencias, repeticoes e transacoes associadas. */ class RecurrenceUpdateService { diff --git a/app/Services/Password/PwndVerifierV2.php b/app/Services/Password/PwndVerifierV2.php index 79067b27f39..5a84377e1cd 100644 --- a/app/Services/Password/PwndVerifierV2.php +++ b/app/Services/Password/PwndVerifierV2.php @@ -28,7 +28,10 @@ use GuzzleHttp\Exception\RequestException; /** - * Class PwndVerifierV2. + * Class PwndVerifierV2 + * + * Verificador de senhas usando a API Have I Been Pwned. + * Verifica se uma senha foi comprometida em vazamentos de dados conhecidos. */ class PwndVerifierV2 implements Verifier { diff --git a/app/Services/Password/Verifier.php b/app/Services/Password/Verifier.php index 705053bbfbd..fcbfe00c437 100644 --- a/app/Services/Password/Verifier.php +++ b/app/Services/Password/Verifier.php @@ -24,7 +24,10 @@ namespace FireflyIII\Services\Password; /** - * Interface Verifier. + * Interface Verifier + * + * Interface para verificadores de senha. + * Define metodo para validar senhas contra servicos de seguranca. */ interface Verifier { diff --git a/app/Services/Webhook/StandardWebhookSender.php b/app/Services/Webhook/StandardWebhookSender.php index ab9a82108ae..a3118d5614b 100644 --- a/app/Services/Webhook/StandardWebhookSender.php +++ b/app/Services/Webhook/StandardWebhookSender.php @@ -39,6 +39,9 @@ /** * Class StandardWebhookSender + * + * Servico padrao para envio de webhooks. + * Gerencia o envio de mensagens de webhook para URLs configuradas. */ class StandardWebhookSender implements WebhookSenderInterface { diff --git a/app/Services/Webhook/WebhookSenderInterface.php b/app/Services/Webhook/WebhookSenderInterface.php index c13715518fc..19268b87e4b 100644 --- a/app/Services/Webhook/WebhookSenderInterface.php +++ b/app/Services/Webhook/WebhookSenderInterface.php @@ -28,6 +28,9 @@ /** * Interface WebhookSenderInterface + * + * Interface para servicos de envio de webhooks. + * Define metodos para configurar e enviar mensagens de webhook. */ interface WebhookSenderInterface { diff --git a/app/Support/Amount.php b/app/Support/Amount.php index c0c40ac390d..07a1081131e 100644 --- a/app/Support/Amount.php +++ b/app/Support/Amount.php @@ -35,7 +35,10 @@ use NumberFormatter; /** - * Class Amount. + * Class Amount + * + * Classe de suporte para formatacao de valores monetarios. + * Fornece metodos para formatar valores em diferentes moedas e locales. */ class Amount { diff --git a/app/Support/Authentication/RemoteUserGuard.php b/app/Support/Authentication/RemoteUserGuard.php index 7870187a347..8ab85cff176 100644 --- a/app/Support/Authentication/RemoteUserGuard.php +++ b/app/Support/Authentication/RemoteUserGuard.php @@ -36,6 +36,9 @@ /** * Class RemoteUserGuard + * + * Guarda de autenticacao para usuarios remotos. + * Implementa autenticacao baseada em cabecalhos HTTP para SSO. */ class RemoteUserGuard implements Guard { diff --git a/app/Support/Authentication/RemoteUserProvider.php b/app/Support/Authentication/RemoteUserProvider.php index 629ea7d5be3..f0331692773 100644 --- a/app/Support/Authentication/RemoteUserProvider.php +++ b/app/Support/Authentication/RemoteUserProvider.php @@ -35,6 +35,9 @@ /** * Class RemoteUserProvider + * + * Provedor de usuarios para autenticacao remota. + * Cria ou recupera usuarios baseado em identificadores de cabecalhos HTTP. */ class RemoteUserProvider implements UserProvider { diff --git a/app/Support/Balance.php b/app/Support/Balance.php index 188a967ba61..691790da782 100644 --- a/app/Support/Balance.php +++ b/app/Support/Balance.php @@ -30,6 +30,12 @@ use Illuminate\Support\Collection; use Illuminate\Support\Facades\Log; +/** + * Class Balance + * + * Classe de suporte para calculo de saldos de contas. + * Fornece metodos para obter saldos de contas em uma data especifica. + */ class Balance { /** diff --git a/app/Support/Binder/AccountList.php b/app/Support/Binder/AccountList.php index 314a0c025f9..43583c0cf8d 100644 --- a/app/Support/Binder/AccountList.php +++ b/app/Support/Binder/AccountList.php @@ -29,7 +29,10 @@ use Symfony\Component\HttpKernel\Exception\NotFoundHttpException; /** - * Class AccountList. + * Class AccountList + * + * Binder de rota para listas de contas. + * Converte IDs de contas em colecao de modelos Account. */ class AccountList implements BinderInterface { diff --git a/app/Support/Binder/BinderInterface.php b/app/Support/Binder/BinderInterface.php index 345c357f7c1..65896b1660f 100644 --- a/app/Support/Binder/BinderInterface.php +++ b/app/Support/Binder/BinderInterface.php @@ -26,7 +26,10 @@ use Illuminate\Routing\Route; /** - * Interface BinderInterface. + * Interface BinderInterface + * + * Interface para binders de rotas. + * Define metodo para vincular valores de rotas a modelos. */ interface BinderInterface { diff --git a/app/Support/Binder/BudgetList.php b/app/Support/Binder/BudgetList.php index 6526ebd38a1..37a96ef5b38 100644 --- a/app/Support/Binder/BudgetList.php +++ b/app/Support/Binder/BudgetList.php @@ -29,7 +29,10 @@ use Symfony\Component\HttpKernel\Exception\NotFoundHttpException; /** - * Class BudgetList. + * Class BudgetList + * + * Binder de rota para listas de orcamentos. + * Converte IDs de orcamentos em colecao de modelos Budget. */ class BudgetList implements BinderInterface { diff --git a/app/Support/Binder/CLIToken.php b/app/Support/Binder/CLIToken.php index d55e5dceca2..a35aef12028 100644 --- a/app/Support/Binder/CLIToken.php +++ b/app/Support/Binder/CLIToken.php @@ -31,6 +31,9 @@ /** * Class CLIToken + * + * Binder de rota para tokens de CLI. + * Valida tokens de acesso para comandos de linha de comando. */ class CLIToken implements BinderInterface { diff --git a/app/Support/Binder/CategoryList.php b/app/Support/Binder/CategoryList.php index 1275481fa38..504d4dfeb9a 100644 --- a/app/Support/Binder/CategoryList.php +++ b/app/Support/Binder/CategoryList.php @@ -29,7 +29,10 @@ use Symfony\Component\HttpKernel\Exception\NotFoundHttpException; /** - * Class CategoryList. + * Class CategoryList + * + * Binder de rota para listas de categorias. + * Converte IDs de categorias em colecao de modelos Category. */ class CategoryList implements BinderInterface { diff --git a/app/Support/Binder/CurrencyCode.php b/app/Support/Binder/CurrencyCode.php index cc5000ede6e..15b3baad627 100644 --- a/app/Support/Binder/CurrencyCode.php +++ b/app/Support/Binder/CurrencyCode.php @@ -28,7 +28,10 @@ use Symfony\Component\HttpKernel\Exception\NotFoundHttpException; /** - * Class CurrencyCode. + * Class CurrencyCode + * + * Binder de rota para codigos de moeda. + * Converte codigos de moeda em modelos TransactionCurrency. */ class CurrencyCode implements BinderInterface { diff --git a/app/Support/Binder/Date.php b/app/Support/Binder/Date.php index 99c0ce4c175..d4524f16251 100644 --- a/app/Support/Binder/Date.php +++ b/app/Support/Binder/Date.php @@ -31,7 +31,10 @@ use Symfony\Component\HttpKernel\Exception\NotFoundHttpException; /** - * Class Date. + * Class Date + * + * Binder de rota para datas. + * Converte strings de data em objetos Carbon, incluindo palavras magicas. */ class Date implements BinderInterface { diff --git a/app/Support/Binder/DynamicConfigKey.php b/app/Support/Binder/DynamicConfigKey.php index e2524c81ec5..483a335c18e 100644 --- a/app/Support/Binder/DynamicConfigKey.php +++ b/app/Support/Binder/DynamicConfigKey.php @@ -29,6 +29,9 @@ /** * Class DynamicConfigKey + * + * Binder de rota para chaves de configuracao dinamicas. + * Valida chaves de configuracao aceitas para API. */ class DynamicConfigKey { diff --git a/app/Support/Binder/EitherConfigKey.php b/app/Support/Binder/EitherConfigKey.php index e342c6d158a..2c7cc8897e2 100644 --- a/app/Support/Binder/EitherConfigKey.php +++ b/app/Support/Binder/EitherConfigKey.php @@ -29,6 +29,9 @@ /** * Class EitherConfigKey + * + * Binder de rota para chaves de configuracao estaticas ou dinamicas. + * Valida chaves de configuracao aceitas incluindo webhooks e regras. */ class EitherConfigKey { diff --git a/app/Support/Binder/JournalList.php b/app/Support/Binder/JournalList.php index 5eadcc587a1..9196c39b81d 100644 --- a/app/Support/Binder/JournalList.php +++ b/app/Support/Binder/JournalList.php @@ -29,7 +29,10 @@ use Symfony\Component\HttpKernel\Exception\NotFoundHttpException; /** - * Class JournalList. + * Class JournalList + * + * Binder de rota para listas de diarios de transacoes. + * Converte IDs de diarios em array de transacoes extraidas. */ class JournalList implements BinderInterface { diff --git a/app/Support/Binder/TagList.php b/app/Support/Binder/TagList.php index 3dd4835f54d..a9221c879da 100644 --- a/app/Support/Binder/TagList.php +++ b/app/Support/Binder/TagList.php @@ -31,7 +31,10 @@ use Symfony\Component\HttpKernel\Exception\NotFoundHttpException; /** - * Class TagList. + * Class TagList + * + * Binder de rota para listas de tags. + * Converte nomes ou IDs de tags em colecao de modelos Tag. */ class TagList implements BinderInterface { diff --git a/app/Support/Binder/TagOrId.php b/app/Support/Binder/TagOrId.php index bc511e50180..80e7fd382d8 100644 --- a/app/Support/Binder/TagOrId.php +++ b/app/Support/Binder/TagOrId.php @@ -29,7 +29,10 @@ use Symfony\Component\HttpKernel\Exception\NotFoundHttpException; /** - * Class TagOrId. + * Class TagOrId + * + * Binder de rota para tag por nome ou ID. + * Converte nome ou ID de tag em modelo Tag. */ class TagOrId implements BinderInterface { diff --git a/app/Support/Binder/UserGroupAccount.php b/app/Support/Binder/UserGroupAccount.php index 12d7eff4a2a..850521d3728 100644 --- a/app/Support/Binder/UserGroupAccount.php +++ b/app/Support/Binder/UserGroupAccount.php @@ -29,7 +29,10 @@ use Symfony\Component\HttpKernel\Exception\NotFoundHttpException; /** - * Class UserGroupAccount. + * Class UserGroupAccount + * + * Binder de rota para contas de grupo de usuarios. + * Converte ID de conta em modelo Account do grupo do usuario. */ class UserGroupAccount implements BinderInterface { diff --git a/app/Support/Binder/UserGroupBill.php b/app/Support/Binder/UserGroupBill.php index 551846d693e..80d1de9c505 100644 --- a/app/Support/Binder/UserGroupBill.php +++ b/app/Support/Binder/UserGroupBill.php @@ -29,7 +29,10 @@ use Symfony\Component\HttpKernel\Exception\NotFoundHttpException; /** - * Class UserGroupBill. + * Class UserGroupBill + * + * Binder de rota para faturas de grupo de usuarios. + * Converte ID de fatura em modelo Bill do grupo do usuario. */ class UserGroupBill implements BinderInterface { diff --git a/app/Support/Binder/UserGroupExchangeRate.php b/app/Support/Binder/UserGroupExchangeRate.php index 74a65c93487..321f4c14118 100644 --- a/app/Support/Binder/UserGroupExchangeRate.php +++ b/app/Support/Binder/UserGroupExchangeRate.php @@ -29,7 +29,10 @@ use Symfony\Component\HttpKernel\Exception\NotFoundHttpException; /** - * Class UserGroupTransaction. + * Class UserGroupExchangeRate + * + * Binder de rota para taxas de cambio de grupo de usuarios. + * Converte ID de taxa em modelo CurrencyExchangeRate do grupo do usuario. */ class UserGroupExchangeRate implements BinderInterface { diff --git a/app/Support/Binder/UserGroupTransaction.php b/app/Support/Binder/UserGroupTransaction.php index d9131400f3d..53981a4010b 100644 --- a/app/Support/Binder/UserGroupTransaction.php +++ b/app/Support/Binder/UserGroupTransaction.php @@ -29,7 +29,10 @@ use Symfony\Component\HttpKernel\Exception\NotFoundHttpException; /** - * Class UserGroupTransaction. + * Class UserGroupTransaction + * + * Binder de rota para transacoes de grupo de usuarios. + * Converte ID de transacao em modelo TransactionGroup do grupo do usuario. */ class UserGroupTransaction implements BinderInterface { diff --git a/app/Support/CacheProperties.php b/app/Support/CacheProperties.php index b81f0404679..74613a5393c 100644 --- a/app/Support/CacheProperties.php +++ b/app/Support/CacheProperties.php @@ -31,7 +31,10 @@ use function Safe\json_encode; /** - * Class CacheProperties. + * Class CacheProperties + * + * Classe de suporte para gerenciamento de cache. + * Fornece metodos para criar chaves de cache baseadas em propriedades. */ class CacheProperties { diff --git a/app/Support/Calendar/Calculator.php b/app/Support/Calendar/Calculator.php index 8d200fba171..df99d24b979 100644 --- a/app/Support/Calendar/Calculator.php +++ b/app/Support/Calendar/Calculator.php @@ -30,6 +30,9 @@ /** * Class Calculator + * + * Calculadora de datas baseada em periodicidade. + * Fornece metodos para calcular proximas datas com base em intervalos. */ class Calculator { diff --git a/app/Support/Calendar/Periodicity.php b/app/Support/Calendar/Periodicity.php index e7e37b0ca53..a4479d74d36 100644 --- a/app/Support/Calendar/Periodicity.php +++ b/app/Support/Calendar/Periodicity.php @@ -25,7 +25,10 @@ namespace FireflyIII\Support\Calendar; /** - * Class Periodicity + * Enum Periodicity + * + * Enumeracao de tipos de periodicidade. + * Define intervalos de tempo para calculos de recorrencia. */ enum Periodicity { diff --git a/app/Support/Calendar/Periodicity/Bimonthly.php b/app/Support/Calendar/Periodicity/Bimonthly.php index ce89863100b..48259b1f7ac 100644 --- a/app/Support/Calendar/Periodicity/Bimonthly.php +++ b/app/Support/Calendar/Periodicity/Bimonthly.php @@ -26,6 +26,9 @@ /** * Class Bimonthly + * + * Periodicidade bimestral. + * Calcula proxima data adicionando 2 meses. */ final class Bimonthly extends Monthly { diff --git a/app/Support/Calendar/Periodicity/Daily.php b/app/Support/Calendar/Periodicity/Daily.php index 1b5811644bc..5d299defc6d 100644 --- a/app/Support/Calendar/Periodicity/Daily.php +++ b/app/Support/Calendar/Periodicity/Daily.php @@ -28,6 +28,9 @@ /** * Class Daily + * + * Periodicidade diaria. + * Calcula proxima data adicionando dias. */ final class Daily extends Interval { diff --git a/app/Support/Calendar/Periodicity/Fortnightly.php b/app/Support/Calendar/Periodicity/Fortnightly.php index 99327e02765..79ef95a9aa7 100644 --- a/app/Support/Calendar/Periodicity/Fortnightly.php +++ b/app/Support/Calendar/Periodicity/Fortnightly.php @@ -26,6 +26,9 @@ /** * Class Fortnightly + * + * Periodicidade quinzenal. + * Calcula proxima data adicionando 2 semanas. */ final class Fortnightly extends Weekly { diff --git a/app/Support/Calendar/Periodicity/HalfYearly.php b/app/Support/Calendar/Periodicity/HalfYearly.php index 4471a4f0301..14e1e20dae7 100644 --- a/app/Support/Calendar/Periodicity/HalfYearly.php +++ b/app/Support/Calendar/Periodicity/HalfYearly.php @@ -26,6 +26,9 @@ /** * Class HalfYearly + * + * Periodicidade semestral. + * Calcula proxima data adicionando 6 meses. */ final class HalfYearly extends Monthly { diff --git a/app/Support/Calendar/Periodicity/Interspacable.php b/app/Support/Calendar/Periodicity/Interspacable.php index b1d2ab5b42e..c72c4b468fb 100644 --- a/app/Support/Calendar/Periodicity/Interspacable.php +++ b/app/Support/Calendar/Periodicity/Interspacable.php @@ -28,6 +28,9 @@ /** * Interface Interspacable + * + * Interface para classes de periodicidade. + * Define metodo para calcular proxima data com intervalo. */ interface Interspacable { diff --git a/app/Support/Calendar/Periodicity/Interval.php b/app/Support/Calendar/Periodicity/Interval.php index ec34c1d43d6..dd3079727ce 100644 --- a/app/Support/Calendar/Periodicity/Interval.php +++ b/app/Support/Calendar/Periodicity/Interval.php @@ -26,6 +26,9 @@ /** * Class Interval + * + * Classe base abstrata para intervalos de periodicidade. + * Fornece metodo para calcular saltos de intervalo. */ abstract class Interval implements Interspacable { diff --git a/app/Support/Calendar/Periodicity/Monthly.php b/app/Support/Calendar/Periodicity/Monthly.php index a2b1112d934..18bb086c765 100644 --- a/app/Support/Calendar/Periodicity/Monthly.php +++ b/app/Support/Calendar/Periodicity/Monthly.php @@ -28,6 +28,9 @@ /** * Class Monthly + * + * Periodicidade mensal. + * Calcula proxima data adicionando meses sem overflow. */ class Monthly extends Interval { diff --git a/app/Support/Calendar/Periodicity/Quarterly.php b/app/Support/Calendar/Periodicity/Quarterly.php index a9cd21b9a1f..cc284fa462a 100644 --- a/app/Support/Calendar/Periodicity/Quarterly.php +++ b/app/Support/Calendar/Periodicity/Quarterly.php @@ -26,6 +26,9 @@ /** * Class Quarterly + * + * Periodicidade trimestral. + * Calcula proxima data adicionando 3 meses. */ final class Quarterly extends Monthly { diff --git a/app/Support/Calendar/Periodicity/Weekly.php b/app/Support/Calendar/Periodicity/Weekly.php index c4252eab93a..b38cb14278d 100644 --- a/app/Support/Calendar/Periodicity/Weekly.php +++ b/app/Support/Calendar/Periodicity/Weekly.php @@ -28,6 +28,9 @@ /** * Class Weekly + * + * Periodicidade semanal. + * Calcula proxima data adicionando semanas. */ class Weekly extends Interval { diff --git a/app/Support/Calendar/Periodicity/Yearly.php b/app/Support/Calendar/Periodicity/Yearly.php index 1cf997c3fea..9c659480c3b 100644 --- a/app/Support/Calendar/Periodicity/Yearly.php +++ b/app/Support/Calendar/Periodicity/Yearly.php @@ -28,6 +28,9 @@ /** * Class Yearly + * + * Periodicidade anual. + * Calcula proxima data adicionando anos sem overflow. */ final class Yearly extends Interval { diff --git a/app/Support/Chart/Budget/FrontpageChartGenerator.php b/app/Support/Chart/Budget/FrontpageChartGenerator.php index f2728f89e5f..49323ab6f90 100644 --- a/app/Support/Chart/Budget/FrontpageChartGenerator.php +++ b/app/Support/Chart/Budget/FrontpageChartGenerator.php @@ -36,6 +36,9 @@ /** * Class FrontpageChartGenerator + * + * Gerador de graficos de orcamento para pagina inicial. + * Gera dados de graficos mostrando gastos, restante e excesso por orcamento. */ class FrontpageChartGenerator { diff --git a/app/Support/Chart/Category/FrontpageChartGenerator.php b/app/Support/Chart/Category/FrontpageChartGenerator.php index c27f13c6866..a63f9889a91 100644 --- a/app/Support/Chart/Category/FrontpageChartGenerator.php +++ b/app/Support/Chart/Category/FrontpageChartGenerator.php @@ -38,6 +38,9 @@ /** * Class FrontpageChartGenerator + * + * Gerador de graficos de categoria para pagina inicial. + * Gera dados de graficos mostrando gastos por categoria. */ class FrontpageChartGenerator { diff --git a/app/Support/Chart/Category/WholePeriodChartGenerator.php b/app/Support/Chart/Category/WholePeriodChartGenerator.php index 344b4b68b39..8f64d8f8ea3 100644 --- a/app/Support/Chart/Category/WholePeriodChartGenerator.php +++ b/app/Support/Chart/Category/WholePeriodChartGenerator.php @@ -33,6 +33,9 @@ /** * Class WholePeriodChartGenerator + * + * Gerador de graficos de categoria para periodo completo. + * Gera dados de graficos mostrando gastos e receitas por categoria ao longo do tempo. */ class WholePeriodChartGenerator { diff --git a/app/Support/Chart/ChartData.php b/app/Support/Chart/ChartData.php index ab03e3dd31c..17693c22d95 100644 --- a/app/Support/Chart/ChartData.php +++ b/app/Support/Chart/ChartData.php @@ -27,6 +27,11 @@ use FireflyIII\Exceptions\FireflyException; /** + * Class ChartData + * + * Classe de dados de graficos (descontinuada). + * Gerencia series de dados para renderizacao de graficos. + * * @deprecated */ class ChartData diff --git a/app/Support/ChartColour.php b/app/Support/ChartColour.php index 9e938b99467..c6b0983f2a8 100644 --- a/app/Support/ChartColour.php +++ b/app/Support/ChartColour.php @@ -24,7 +24,10 @@ namespace FireflyIII\Support; /** - * Class ChartColour. + * Class ChartColour + * + * Classe de suporte para cores de graficos. + * Fornece paleta de cores e metodo para obter cores por indice. */ class ChartColour { diff --git a/app/Support/Cronjobs/AbstractCronjob.php b/app/Support/Cronjobs/AbstractCronjob.php index fd287710ac3..f4fd5b8d486 100644 --- a/app/Support/Cronjobs/AbstractCronjob.php +++ b/app/Support/Cronjobs/AbstractCronjob.php @@ -28,6 +28,9 @@ /** * Class AbstractCronjob + * + * Classe base abstrata para cronjobs. + * Define estrutura comum para tarefas agendadas do sistema. */ abstract class AbstractCronjob { diff --git a/app/Support/Cronjobs/AutoBudgetCronjob.php b/app/Support/Cronjobs/AutoBudgetCronjob.php index f71a4a4da17..1f75821de00 100644 --- a/app/Support/Cronjobs/AutoBudgetCronjob.php +++ b/app/Support/Cronjobs/AutoBudgetCronjob.php @@ -32,6 +32,9 @@ /** * Class AutoBudgetCronjob + * + * Cronjob para criacao automatica de limites de orcamento. + * Executa periodicamente para criar limites de orcamento automaticos. */ class AutoBudgetCronjob extends AbstractCronjob { diff --git a/app/Support/Cronjobs/BillWarningCronjob.php b/app/Support/Cronjobs/BillWarningCronjob.php index aece4d403fe..2b411e525ba 100644 --- a/app/Support/Cronjobs/BillWarningCronjob.php +++ b/app/Support/Cronjobs/BillWarningCronjob.php @@ -33,6 +33,9 @@ /** * Class BillWarningCronjob + * + * Cronjob para notificacoes de faturas. + * Executa periodicamente para enviar alertas sobre faturas proximas do vencimento. */ class BillWarningCronjob extends AbstractCronjob { diff --git a/app/Support/Cronjobs/ExchangeRatesCronjob.php b/app/Support/Cronjobs/ExchangeRatesCronjob.php index f7d80b8033a..aa3c72d654e 100644 --- a/app/Support/Cronjobs/ExchangeRatesCronjob.php +++ b/app/Support/Cronjobs/ExchangeRatesCronjob.php @@ -32,6 +32,9 @@ /** * Class ExchangeRatesCronjob + * + * Cronjob para download de taxas de cambio. + * Executa periodicamente para atualizar taxas de cambio de moedas. */ class ExchangeRatesCronjob extends AbstractCronjob { diff --git a/app/Support/Cronjobs/RecurringCronjob.php b/app/Support/Cronjobs/RecurringCronjob.php index cc6bb7f9018..33886708ae4 100644 --- a/app/Support/Cronjobs/RecurringCronjob.php +++ b/app/Support/Cronjobs/RecurringCronjob.php @@ -33,6 +33,9 @@ /** * Class RecurringCronjob + * + * Cronjob para criacao de transacoes recorrentes. + * Executa periodicamente para criar transacoes baseadas em recorrencias. */ class RecurringCronjob extends AbstractCronjob { diff --git a/app/Support/Cronjobs/UpdateCheckCronjob.php b/app/Support/Cronjobs/UpdateCheckCronjob.php index 6d3cea13ab9..983182a5a6b 100644 --- a/app/Support/Cronjobs/UpdateCheckCronjob.php +++ b/app/Support/Cronjobs/UpdateCheckCronjob.php @@ -31,6 +31,12 @@ use Illuminate\Support\Facades\Log; use Override; +/** + * Class UpdateCheckCronjob + * + * Cronjob para verificacao de atualizacoes. + * Executa periodicamente para verificar novas versoes do Firefly III. + */ class UpdateCheckCronjob extends AbstractCronjob { use UpdateTrait; diff --git a/app/Support/Cronjobs/WebhookCronjob.php b/app/Support/Cronjobs/WebhookCronjob.php index dcac057140a..fe47522e18e 100644 --- a/app/Support/Cronjobs/WebhookCronjob.php +++ b/app/Support/Cronjobs/WebhookCronjob.php @@ -33,6 +33,9 @@ /** * Class WebhookCronjob + * + * Cronjob para envio de mensagens de webhook. + * Executa periodicamente para enviar webhooks pendentes. */ class WebhookCronjob extends AbstractCronjob { diff --git a/app/Support/Debug/Timer.php b/app/Support/Debug/Timer.php index 94e48187b79..1a3c75917ff 100644 --- a/app/Support/Debug/Timer.php +++ b/app/Support/Debug/Timer.php @@ -26,6 +26,12 @@ use Illuminate\Support\Facades\Log; +/** + * Class Timer + * + * Temporizador de depuracao. + * Singleton para medir tempo de execucao de operacoes para fins de depuracao. + */ class Timer { private array $times = []; diff --git a/app/Support/Domain.php b/app/Support/Domain.php index b193717884d..cf1a65369eb 100644 --- a/app/Support/Domain.php +++ b/app/Support/Domain.php @@ -24,7 +24,10 @@ namespace FireflyIII\Support; /** - * Class Domain. + * Class Domain + * + * Classe de suporte para configuracoes de dominio. + * Fornece metodos para obter bindables, acoes e gatilhos de regras. */ class Domain { diff --git a/app/Support/ExpandedForm.php b/app/Support/ExpandedForm.php index e460353ac25..812b69b098a 100644 --- a/app/Support/ExpandedForm.php +++ b/app/Support/ExpandedForm.php @@ -30,7 +30,10 @@ use Throwable; /** - * Class ExpandedForm. + * Class ExpandedForm + * + * Classe de suporte para formularios expandidos. + * Fornece metodos para renderizar campos de formulario com estilos e validacao. */ class ExpandedForm { diff --git a/app/Support/Export/ExportDataGenerator.php b/app/Support/Export/ExportDataGenerator.php index ad0f0b4b712..31e33046d6a 100644 --- a/app/Support/Export/ExportDataGenerator.php +++ b/app/Support/Export/ExportDataGenerator.php @@ -65,6 +65,9 @@ /** * Class ExportDataGenerator + * + * Gerador de dados de exportacao. + * Fornece metodos para exportar contas, faturas, orcamentos, categorias e transacoes em CSV. */ class ExportDataGenerator { diff --git a/app/Support/Facades/AccountForm.php b/app/Support/Facades/AccountForm.php index 2a44acd2bd6..10383761d19 100644 --- a/app/Support/Facades/AccountForm.php +++ b/app/Support/Facades/AccountForm.php @@ -26,7 +26,10 @@ use Illuminate\Support\Facades\Facade; /** - * Class AccountForm. + * Class AccountForm + * + * Facade para formularios de conta. + * Fornece acesso estatico aos metodos de formulario de conta. */ class AccountForm extends Facade { diff --git a/app/Support/Facades/Amount.php b/app/Support/Facades/Amount.php index df49a954a5d..4a2382d3c07 100644 --- a/app/Support/Facades/Amount.php +++ b/app/Support/Facades/Amount.php @@ -25,6 +25,12 @@ use Illuminate\Support\Facades\Facade; +/** + * Class Amount + * + * Facade para formatacao de valores monetarios. + * Fornece acesso estatico aos metodos de formatacao de valores. + */ class Amount extends Facade { /** diff --git a/app/Support/Facades/Balance.php b/app/Support/Facades/Balance.php index 2ea4c669e58..5362ed3f6c3 100644 --- a/app/Support/Facades/Balance.php +++ b/app/Support/Facades/Balance.php @@ -26,6 +26,12 @@ use Illuminate\Support\Facades\Facade; +/** + * Class Balance + * + * Facade para calculos de saldo. + * Fornece acesso estatico aos metodos de calculo de saldo de contas. + */ class Balance extends Facade { /** diff --git a/app/Support/Facades/CurrencyForm.php b/app/Support/Facades/CurrencyForm.php index 528ece371b5..5dbe6482020 100644 --- a/app/Support/Facades/CurrencyForm.php +++ b/app/Support/Facades/CurrencyForm.php @@ -26,7 +26,10 @@ use Illuminate\Support\Facades\Facade; /** - * Class CurrencyForm. + * Class CurrencyForm + * + * Facade para formularios de moeda. + * Fornece acesso estatico aos metodos de formulario de moeda. */ class CurrencyForm extends Facade { diff --git a/app/Support/Facades/ExpandedForm.php b/app/Support/Facades/ExpandedForm.php index 97632697086..c5f373a38cd 100644 --- a/app/Support/Facades/ExpandedForm.php +++ b/app/Support/Facades/ExpandedForm.php @@ -26,7 +26,10 @@ use Illuminate\Support\Facades\Facade; /** - * Class ExpandedForm. + * Class ExpandedForm + * + * Facade para formularios expandidos. + * Fornece acesso estatico aos metodos de formulario expandido. */ class ExpandedForm extends Facade { diff --git a/app/Support/Facades/FireflyConfig.php b/app/Support/Facades/FireflyConfig.php index 3db565a466a..924ce601f51 100644 --- a/app/Support/Facades/FireflyConfig.php +++ b/app/Support/Facades/FireflyConfig.php @@ -25,6 +25,12 @@ use Illuminate\Support\Facades\Facade; +/** + * Class FireflyConfig + * + * Facade para configuracoes do Firefly III. + * Fornece acesso estatico aos metodos de configuracao do sistema. + */ class FireflyConfig extends Facade { /** diff --git a/app/Support/Facades/Navigation.php b/app/Support/Facades/Navigation.php index bb171321a60..7594607c1fd 100644 --- a/app/Support/Facades/Navigation.php +++ b/app/Support/Facades/Navigation.php @@ -27,7 +27,10 @@ use Illuminate\Support\Facades\Facade; /** - * Class Navigation. + * Class Navigation + * + * Facade para navegacao temporal. + * Fornece acesso estatico aos metodos de navegacao de datas e periodos. * * @method Carbon addPeriod(Carbon $theDate, string $repeatFreq, int $skip) * @method array blockPeriods(Carbon $start, Carbon $end, string $range) diff --git a/app/Support/Facades/PiggyBankForm.php b/app/Support/Facades/PiggyBankForm.php index 3dd4c84bda8..3944fae8ab2 100644 --- a/app/Support/Facades/PiggyBankForm.php +++ b/app/Support/Facades/PiggyBankForm.php @@ -26,7 +26,10 @@ use Illuminate\Support\Facades\Facade; /** - * Class PiggyBankForm. + * Class PiggyBankForm + * + * Facade para formularios de cofrinho. + * Fornece acesso estatico aos metodos de formulario de cofrinho. */ class PiggyBankForm extends Facade { diff --git a/app/Support/Facades/Preferences.php b/app/Support/Facades/Preferences.php index 694e94ec967..162c5cf6849 100644 --- a/app/Support/Facades/Preferences.php +++ b/app/Support/Facades/Preferences.php @@ -25,6 +25,12 @@ use Illuminate\Support\Facades\Facade; +/** + * Class Preferences + * + * Facade para preferencias de usuario. + * Fornece acesso estatico aos metodos de preferencias do usuario. + */ class Preferences extends Facade { public function __construct() diff --git a/app/Support/Facades/RuleForm.php b/app/Support/Facades/RuleForm.php index b2aacf783ff..7163604e29d 100644 --- a/app/Support/Facades/RuleForm.php +++ b/app/Support/Facades/RuleForm.php @@ -26,7 +26,10 @@ use Illuminate\Support\Facades\Facade; /** - * Class RuleForm. + * Class RuleForm + * + * Facade para formularios de regra. + * Fornece acesso estatico aos metodos de formulario de regra. */ class RuleForm extends Facade { diff --git a/app/Support/Facades/Steam.php b/app/Support/Facades/Steam.php index e2420fbdfbb..f0eef0825fb 100644 --- a/app/Support/Facades/Steam.php +++ b/app/Support/Facades/Steam.php @@ -25,6 +25,12 @@ use Illuminate\Support\Facades\Facade; +/** + * Class Steam + * + * Facade para utilitarios do Firefly III. + * Fornece acesso estatico aos metodos utilitarios do sistema. + */ class Steam extends Facade { /** diff --git a/app/Support/FireflyConfig.php b/app/Support/FireflyConfig.php index 499b1236024..d57292aedaa 100644 --- a/app/Support/FireflyConfig.php +++ b/app/Support/FireflyConfig.php @@ -33,7 +33,10 @@ use Exception; /** - * Class FireflyConfig. + * Class FireflyConfig + * + * Classe de gerenciamento de configuracoes do Firefly III. + * Fornece metodos para obter, definir e excluir configuracoes do sistema. */ class FireflyConfig { diff --git a/app/Support/Form/AccountForm.php b/app/Support/Form/AccountForm.php index 19a043c76dc..dd398f87b51 100644 --- a/app/Support/Form/AccountForm.php +++ b/app/Support/Form/AccountForm.php @@ -33,10 +33,8 @@ /** * Class AccountForm * - * All form methods that are account related. - * - * TODO describe all methods - * TODO optimize repositories and methods. + * Classe de formulario de conta. + * Fornece metodos para renderizar campos de formulario relacionados a contas. */ class AccountForm { diff --git a/app/Support/Form/CurrencyForm.php b/app/Support/Form/CurrencyForm.php index 88816667d45..e2a07a9d340 100644 --- a/app/Support/Form/CurrencyForm.php +++ b/app/Support/Form/CurrencyForm.php @@ -33,7 +33,8 @@ /** * Class CurrencyForm * - * All currency related form methods. + * Classe de formulario de moeda. + * Fornece metodos para renderizar campos de formulario relacionados a moedas. */ class CurrencyForm { diff --git a/app/Support/Form/FormSupport.php b/app/Support/Form/FormSupport.php index 8240bc45a1e..04d378e36db 100644 --- a/app/Support/Form/FormSupport.php +++ b/app/Support/Form/FormSupport.php @@ -32,6 +32,9 @@ /** * Trait FormSupport + * + * Trait de suporte a formularios. + * Fornece metodos utilitarios para renderizacao de campos de formulario. */ trait FormSupport { diff --git a/app/Support/Form/PiggyBankForm.php b/app/Support/Form/PiggyBankForm.php index 78919b30bf0..5e1dec35b88 100644 --- a/app/Support/Form/PiggyBankForm.php +++ b/app/Support/Form/PiggyBankForm.php @@ -30,7 +30,8 @@ /** * Class PiggyBankForm * - * TODO cleanup and describe. + * Classe de formulario de cofrinho. + * Fornece metodos para renderizar campos de formulario relacionados a cofrinhos. */ class PiggyBankForm { diff --git a/app/Support/Form/RuleForm.php b/app/Support/Form/RuleForm.php index 6baee553bee..50bb46d0ef4 100644 --- a/app/Support/Form/RuleForm.php +++ b/app/Support/Form/RuleForm.php @@ -29,7 +29,9 @@ /** * Class RuleForm - * TODO cleanup and describe + * + * Classe de formulario de regra. + * Fornece metodos para renderizar campos de formulario relacionados a regras. */ class RuleForm { diff --git a/app/Support/Http/Api/AccountBalanceGrouped.php b/app/Support/Http/Api/AccountBalanceGrouped.php index 397146be61d..d3a3e6d5bae 100644 --- a/app/Support/Http/Api/AccountBalanceGrouped.php +++ b/app/Support/Http/Api/AccountBalanceGrouped.php @@ -35,6 +35,9 @@ /** * Class AccountBalanceGrouped + * + * Agrupador de saldo de conta. + * Agrupa transacoes por moeda e periodo para geracao de graficos de saldo. */ class AccountBalanceGrouped { diff --git a/app/Support/Http/Api/AccountFilter.php b/app/Support/Http/Api/AccountFilter.php index b44dc3df6a9..0208c695540 100644 --- a/app/Support/Http/Api/AccountFilter.php +++ b/app/Support/Http/Api/AccountFilter.php @@ -28,6 +28,9 @@ /** * Trait AccountFilter + * + * Trait para filtragem de contas. + * Mapeia tipos de conta para filtragem em requisicoes da API. */ trait AccountFilter { diff --git a/app/Support/Http/Api/ApiSupport.php b/app/Support/Http/Api/ApiSupport.php index 216acd8f442..c386222f5a2 100644 --- a/app/Support/Http/Api/ApiSupport.php +++ b/app/Support/Http/Api/ApiSupport.php @@ -29,6 +29,9 @@ /** * Trait ApiSupport + * + * Trait de suporte a API. + * Fornece metodos auxiliares para graficos de contas de receita e despesa. */ trait ApiSupport { diff --git a/app/Support/Http/Api/CleansChartData.php b/app/Support/Http/Api/CleansChartData.php index 4b02726c1b3..bf6430fa08a 100644 --- a/app/Support/Http/Api/CleansChartData.php +++ b/app/Support/Http/Api/CleansChartData.php @@ -28,6 +28,9 @@ /** * Trait CleansChartData + * + * Trait para limpeza de dados de grafico. + * Valida e normaliza dados de grafico para endpoints da API V2. */ trait CleansChartData { diff --git a/app/Support/Http/Api/CollectsAccountsFromFilter.php b/app/Support/Http/Api/CollectsAccountsFromFilter.php index 7c10a6c1e10..2f71dd78069 100644 --- a/app/Support/Http/Api/CollectsAccountsFromFilter.php +++ b/app/Support/Http/Api/CollectsAccountsFromFilter.php @@ -27,6 +27,12 @@ use FireflyIII\Enums\AccountTypeEnum; use Illuminate\Support\Collection; +/** + * Trait CollectsAccountsFromFilter + * + * Trait para coleta de contas a partir de filtro. + * Obtem lista de contas baseada em parametros de consulta. + */ trait CollectsAccountsFromFilter { /** diff --git a/app/Support/Http/Api/ExchangeRateConverter.php b/app/Support/Http/Api/ExchangeRateConverter.php index 1ff60dbaaa9..3382ce42cde 100644 --- a/app/Support/Http/Api/ExchangeRateConverter.php +++ b/app/Support/Http/Api/ExchangeRateConverter.php @@ -36,6 +36,9 @@ /** * Class ExchangeRateConverter + * + * Conversor de taxa de cambio. + * Converte valores entre moedas usando taxas de cambio armazenadas. */ class ExchangeRateConverter { diff --git a/app/Support/Http/Api/SummaryBalanceGrouped.php b/app/Support/Http/Api/SummaryBalanceGrouped.php index 6fc534b59a6..51e6dc708ce 100644 --- a/app/Support/Http/Api/SummaryBalanceGrouped.php +++ b/app/Support/Http/Api/SummaryBalanceGrouped.php @@ -28,6 +28,12 @@ use FireflyIII\Repositories\Currency\CurrencyRepositoryInterface; use Illuminate\Support\Facades\Log; +/** + * Class SummaryBalanceGrouped + * + * Agrupador de saldo de resumo. + * Agrupa transacoes por moeda para exibicao de resumo de saldo. + */ class SummaryBalanceGrouped { private const string SUM = 'sum'; diff --git a/app/Support/Http/Api/TransactionFilter.php b/app/Support/Http/Api/TransactionFilter.php index f6f13d77a7a..33e326bfd03 100644 --- a/app/Support/Http/Api/TransactionFilter.php +++ b/app/Support/Http/Api/TransactionFilter.php @@ -28,6 +28,9 @@ /** * Trait TransactionFilter + * + * Trait para filtragem de transacoes. + * Mapeia tipos de transacao para filtragem em requisicoes da API. */ trait TransactionFilter { diff --git a/app/Support/Http/Api/ValidatesUserGroupTrait.php b/app/Support/Http/Api/ValidatesUserGroupTrait.php index c33be45a1eb..26f9649644e 100644 --- a/app/Support/Http/Api/ValidatesUserGroupTrait.php +++ b/app/Support/Http/Api/ValidatesUserGroupTrait.php @@ -35,6 +35,9 @@ /** * Trait ValidatesUserGroupTrait + * + * Trait para validacao de grupo de usuario. + * Verifica permissoes de acesso do usuario ao grupo solicitado. */ trait ValidatesUserGroupTrait { diff --git a/app/Support/Http/Controllers/AugumentData.php b/app/Support/Http/Controllers/AugumentData.php index a95a1e6ff24..319c1e6fcd2 100644 --- a/app/Support/Http/Controllers/AugumentData.php +++ b/app/Support/Http/Controllers/AugumentData.php @@ -42,6 +42,9 @@ /** * Trait AugumentData + * + * Trait para aumento de dados. + * Fornece metodos para combinar e agrupar dados de contas, orcamentos e categorias. */ trait AugumentData { diff --git a/app/Support/Http/Controllers/BasicDataSupport.php b/app/Support/Http/Controllers/BasicDataSupport.php index 702b1bbc4c9..a421c8e76d9 100644 --- a/app/Support/Http/Controllers/BasicDataSupport.php +++ b/app/Support/Http/Controllers/BasicDataSupport.php @@ -28,6 +28,9 @@ /** * Trait BasicDataSupport + * + * Trait de suporte a dados basicos. + * Fornece metodos auxiliares para busca de dados em arrays. */ trait BasicDataSupport { diff --git a/app/Support/Http/Controllers/ChartGeneration.php b/app/Support/Http/Controllers/ChartGeneration.php index 47a85c5c836..b9083962971 100644 --- a/app/Support/Http/Controllers/ChartGeneration.php +++ b/app/Support/Http/Controllers/ChartGeneration.php @@ -37,6 +37,9 @@ /** * Trait ChartGeneration + * + * Trait para geracao de graficos. + * Fornece metodos para gerar graficos de saldo de conta. */ trait ChartGeneration { diff --git a/app/Support/Http/Controllers/CreateStuff.php b/app/Support/Http/Controllers/CreateStuff.php index 6ce33985d33..e69ec041efe 100644 --- a/app/Support/Http/Controllers/CreateStuff.php +++ b/app/Support/Http/Controllers/CreateStuff.php @@ -37,6 +37,9 @@ /** * Trait CreateStuff + * + * Trait para criacao de entidades. + * Fornece metodos para criar contas, usuarios e chaves OAuth. */ trait CreateStuff { diff --git a/app/Support/Http/Controllers/CronRunner.php b/app/Support/Http/Controllers/CronRunner.php index c8cf03cfd64..226c3af57eb 100644 --- a/app/Support/Http/Controllers/CronRunner.php +++ b/app/Support/Http/Controllers/CronRunner.php @@ -34,6 +34,9 @@ /** * Trait CronRunner + * + * Trait para execucao de cronjobs. + * Fornece metodos para executar tarefas agendadas do sistema. */ trait CronRunner { diff --git a/app/Support/Http/Controllers/DateCalculation.php b/app/Support/Http/Controllers/DateCalculation.php index 5027a4c69fd..bcea8030bb7 100644 --- a/app/Support/Http/Controllers/DateCalculation.php +++ b/app/Support/Http/Controllers/DateCalculation.php @@ -28,6 +28,9 @@ /** * Trait DateCalculation + * + * Trait para calculos de data. + * Fornece metodos para calcular dias ativos e periodos. */ trait DateCalculation { diff --git a/app/Support/Http/Controllers/GetConfigurationData.php b/app/Support/Http/Controllers/GetConfigurationData.php index 52ce494418a..ca5ba0ca367 100644 --- a/app/Support/Http/Controllers/GetConfigurationData.php +++ b/app/Support/Http/Controllers/GetConfigurationData.php @@ -31,6 +31,9 @@ /** * Trait GetConfigurationData + * + * Trait para obtencao de dados de configuracao. + * Fornece metodos para obter configuracoes de data e passos de introducao. */ trait GetConfigurationData { diff --git a/app/Support/Http/Controllers/ModelInformation.php b/app/Support/Http/Controllers/ModelInformation.php index 65fd6602114..09949839bfc 100644 --- a/app/Support/Http/Controllers/ModelInformation.php +++ b/app/Support/Http/Controllers/ModelInformation.php @@ -36,6 +36,9 @@ /** * Trait ModelInformation + * + * Trait para informacoes de modelo. + * Fornece metodos para obter gatilhos e acoes baseados em modelos. */ trait ModelInformation { diff --git a/app/Support/Http/Controllers/PeriodOverview.php b/app/Support/Http/Controllers/PeriodOverview.php index afbc198ce28..086dc354bf5 100644 --- a/app/Support/Http/Controllers/PeriodOverview.php +++ b/app/Support/Http/Controllers/PeriodOverview.php @@ -39,7 +39,10 @@ use Illuminate\Support\Facades\Log; /** - * Trait PeriodOverview. + * Trait PeriodOverview + * + * Trait para visao geral de periodo. + * Fornece metodos para gerar resumos de transacoes por periodo. * * TODO verify this all works as expected. * diff --git a/app/Support/Http/Controllers/RenderPartialViews.php b/app/Support/Http/Controllers/RenderPartialViews.php index 4c5f8348c66..912a7f076a0 100644 --- a/app/Support/Http/Controllers/RenderPartialViews.php +++ b/app/Support/Http/Controllers/RenderPartialViews.php @@ -41,6 +41,9 @@ /** * Trait RenderPartialViews + * + * Trait para renderizacao de views parciais. + * Fornece metodos para renderizar popups e opcoes de relatorio. */ trait RenderPartialViews { diff --git a/app/Support/Http/Controllers/RequestInformation.php b/app/Support/Http/Controllers/RequestInformation.php index 6c7731b68f5..29ebdc4a2e9 100644 --- a/app/Support/Http/Controllers/RequestInformation.php +++ b/app/Support/Http/Controllers/RequestInformation.php @@ -40,6 +40,9 @@ /** * Trait RequestInformation + * + * Trait para informacoes de requisicao. + * Fornece metodos para obter informacoes da requisicao e validar dados. */ trait RequestInformation { diff --git a/app/Support/Http/Controllers/RuleManagement.php b/app/Support/Http/Controllers/RuleManagement.php index 6b88c3524ce..788f44d2b6c 100644 --- a/app/Support/Http/Controllers/RuleManagement.php +++ b/app/Support/Http/Controllers/RuleManagement.php @@ -32,6 +32,9 @@ /** * Trait RuleManagement + * + * Trait para gerenciamento de regras. + * Fornece metodos para obter gatilhos e acoes de regras anteriores. */ trait RuleManagement { diff --git a/app/Support/Http/Controllers/TransactionCalculation.php b/app/Support/Http/Controllers/TransactionCalculation.php index 17df264ce8b..f92e1d5121f 100644 --- a/app/Support/Http/Controllers/TransactionCalculation.php +++ b/app/Support/Http/Controllers/TransactionCalculation.php @@ -31,6 +31,9 @@ /** * Trait TransactionCalculation + * + * Trait para calculos de transacao. + * Fornece metodos para obter despesas e receitas por categoria, tag e orcamento. */ trait TransactionCalculation { diff --git a/app/Support/Http/Controllers/UserNavigation.php b/app/Support/Http/Controllers/UserNavigation.php index 8fac232ad08..567d0ea9648 100644 --- a/app/Support/Http/Controllers/UserNavigation.php +++ b/app/Support/Http/Controllers/UserNavigation.php @@ -35,6 +35,9 @@ /** * Trait UserNavigation + * + * Trait para navegacao de usuario. + * Fornece metodos para redirecionamento e navegacao entre paginas. */ trait UserNavigation { diff --git a/app/Support/JsonApi/Enrichments/AccountEnrichment.php b/app/Support/JsonApi/Enrichments/AccountEnrichment.php index c1a162d8fc5..1f167dc7dc1 100644 --- a/app/Support/JsonApi/Enrichments/AccountEnrichment.php +++ b/app/Support/JsonApi/Enrichments/AccountEnrichment.php @@ -49,7 +49,9 @@ /** * Class AccountEnrichment * - * This class "enriches" accounts and adds data from other tables and models to each account model. + * Enriquecedor de contas. + * Adiciona dados de outras tabelas e modelos a cada modelo de conta, + * incluindo metadados, notas, localizacoes, saldos e grupos de objetos. */ class AccountEnrichment implements EnrichmentInterface { diff --git a/app/Support/JsonApi/Enrichments/AvailableBudgetEnrichment.php b/app/Support/JsonApi/Enrichments/AvailableBudgetEnrichment.php index b8ad52e31a9..5b547610bd5 100644 --- a/app/Support/JsonApi/Enrichments/AvailableBudgetEnrichment.php +++ b/app/Support/JsonApi/Enrichments/AvailableBudgetEnrichment.php @@ -38,6 +38,12 @@ use Illuminate\Support\Facades\Log; use Override; +/** + * Class AvailableBudgetEnrichment + * + * Enriquecedor de orcamento disponivel. + * Adiciona informacoes de gastos dentro e fora de orcamentos. + */ class AvailableBudgetEnrichment implements EnrichmentInterface { private User $user; diff --git a/app/Support/JsonApi/Enrichments/BudgetEnrichment.php b/app/Support/JsonApi/Enrichments/BudgetEnrichment.php index 5605d7f94a9..a080fa6f46d 100644 --- a/app/Support/JsonApi/Enrichments/BudgetEnrichment.php +++ b/app/Support/JsonApi/Enrichments/BudgetEnrichment.php @@ -19,6 +19,12 @@ use Illuminate\Support\Facades\DB; use Illuminate\Support\Facades\Log; +/** + * Class BudgetEnrichment + * + * Enriquecedor de orcamento. + * Adiciona notas, auto-orcamentos, despesas e grupos de objetos aos orcamentos. + */ class BudgetEnrichment implements EnrichmentInterface { private Collection $collection; diff --git a/app/Support/JsonApi/Enrichments/BudgetLimitEnrichment.php b/app/Support/JsonApi/Enrichments/BudgetLimitEnrichment.php index 787f3c78449..6881d522dfc 100644 --- a/app/Support/JsonApi/Enrichments/BudgetLimitEnrichment.php +++ b/app/Support/JsonApi/Enrichments/BudgetLimitEnrichment.php @@ -17,6 +17,12 @@ use Illuminate\Support\Collection; use Illuminate\Support\Facades\Log; +/** + * Class BudgetLimitEnrichment + * + * Enriquecedor de limite de orcamento. + * Adiciona notas, despesas e informacoes de moeda aos limites de orcamento. + */ class BudgetLimitEnrichment implements EnrichmentInterface { private User $user; diff --git a/app/Support/JsonApi/Enrichments/CategoryEnrichment.php b/app/Support/JsonApi/Enrichments/CategoryEnrichment.php index 39be921a31d..a3676752bea 100644 --- a/app/Support/JsonApi/Enrichments/CategoryEnrichment.php +++ b/app/Support/JsonApi/Enrichments/CategoryEnrichment.php @@ -14,6 +14,12 @@ use Illuminate\Support\Collection; use Illuminate\Support\Facades\Log; +/** + * Class CategoryEnrichment + * + * Enriquecedor de categoria. + * Adiciona notas, gastos, receitas e transferencias as categorias. + */ class CategoryEnrichment implements EnrichmentInterface { private Collection $collection; diff --git a/app/Support/JsonApi/Enrichments/EnrichmentInterface.php b/app/Support/JsonApi/Enrichments/EnrichmentInterface.php index 0ccfb7c0608..fcb55ee0388 100644 --- a/app/Support/JsonApi/Enrichments/EnrichmentInterface.php +++ b/app/Support/JsonApi/Enrichments/EnrichmentInterface.php @@ -29,6 +29,12 @@ use Illuminate\Database\Eloquent\Model; use Illuminate\Support\Collection; +/** + * Interface EnrichmentInterface + * + * Interface para enriquecimento de dados. + * Define metodos para enriquecer colecoes e modelos com dados adicionais. + */ interface EnrichmentInterface { public function enrich(Collection $collection): Collection; diff --git a/app/Support/JsonApi/Enrichments/PiggyBankEnrichment.php b/app/Support/JsonApi/Enrichments/PiggyBankEnrichment.php index 62a0ecb11df..a71028fe483 100644 --- a/app/Support/JsonApi/Enrichments/PiggyBankEnrichment.php +++ b/app/Support/JsonApi/Enrichments/PiggyBankEnrichment.php @@ -20,6 +20,12 @@ use Illuminate\Support\Facades\DB; use Illuminate\Support\Facades\Log; +/** + * Class PiggyBankEnrichment + * + * Enriquecedor de cofrinho. + * Adiciona notas, grupos de objetos, valores atuais e sugestoes de economia aos cofrinhos. + */ class PiggyBankEnrichment implements EnrichmentInterface { private User $user; diff --git a/app/Support/JsonApi/Enrichments/PiggyBankEventEnrichment.php b/app/Support/JsonApi/Enrichments/PiggyBankEventEnrichment.php index 76ea5318f4e..dafe8bbbd3b 100644 --- a/app/Support/JsonApi/Enrichments/PiggyBankEventEnrichment.php +++ b/app/Support/JsonApi/Enrichments/PiggyBankEventEnrichment.php @@ -16,6 +16,12 @@ use Illuminate\Support\Facades\DB; use Illuminate\Support\Facades\Log; +/** + * Class PiggyBankEventEnrichment + * + * Enriquecedor de evento de cofrinho. + * Adiciona informacoes de grupo de transacao e moeda aos eventos de cofrinho. + */ class PiggyBankEventEnrichment implements EnrichmentInterface { private User $user; diff --git a/app/Support/JsonApi/Enrichments/RecurringEnrichment.php b/app/Support/JsonApi/Enrichments/RecurringEnrichment.php index 989e9ea9247..81f6aa0ee80 100644 --- a/app/Support/JsonApi/Enrichments/RecurringEnrichment.php +++ b/app/Support/JsonApi/Enrichments/RecurringEnrichment.php @@ -33,6 +33,12 @@ use Illuminate\Support\Collection; use Illuminate\Support\Facades\Log; +/** + * Class RecurringEnrichment + * + * Enriquecedor de recorrencia. + * Adiciona notas, repeticoes, transacoes e metadados as transacoes recorrentes. + */ class RecurringEnrichment implements EnrichmentInterface { private Collection $collection; diff --git a/app/Support/JsonApi/Enrichments/SubscriptionEnrichment.php b/app/Support/JsonApi/Enrichments/SubscriptionEnrichment.php index 88307e028d8..2e472acb08b 100644 --- a/app/Support/JsonApi/Enrichments/SubscriptionEnrichment.php +++ b/app/Support/JsonApi/Enrichments/SubscriptionEnrichment.php @@ -22,6 +22,12 @@ use Illuminate\Support\Facades\DB; use Illuminate\Support\Facades\Log; +/** + * Class SubscriptionEnrichment + * + * Enriquecedor de assinatura. + * Adiciona notas, grupos de objetos, datas de pagamento e valores as assinaturas. + */ class SubscriptionEnrichment implements EnrichmentInterface { private User $user; diff --git a/app/Support/JsonApi/Enrichments/TransactionGroupEnrichment.php b/app/Support/JsonApi/Enrichments/TransactionGroupEnrichment.php index 0e552281a3f..f736f624f05 100644 --- a/app/Support/JsonApi/Enrichments/TransactionGroupEnrichment.php +++ b/app/Support/JsonApi/Enrichments/TransactionGroupEnrichment.php @@ -43,6 +43,12 @@ use Illuminate\Support\Facades\Log; use Override; +/** + * Class TransactionGroupEnrichment + * + * Enriquecedor de grupo de transacao. + * Adiciona notas, tags, metadados, localizacoes e contagem de anexos aos grupos de transacao. + */ class TransactionGroupEnrichment implements EnrichmentInterface { private array $attachmentCount = []; diff --git a/app/Support/Logging/AuditLogger.php b/app/Support/Logging/AuditLogger.php index 56bd255554e..f83681122a0 100644 --- a/app/Support/Logging/AuditLogger.php +++ b/app/Support/Logging/AuditLogger.php @@ -30,6 +30,9 @@ /** * Class AuditLogger + * + * Logger de auditoria. + * Configura o logger para registrar eventos de auditoria com formatacao personalizada. */ class AuditLogger { diff --git a/app/Support/Logging/AuditProcessor.php b/app/Support/Logging/AuditProcessor.php index 5f8f823c13d..ae0e3d0db39 100644 --- a/app/Support/Logging/AuditProcessor.php +++ b/app/Support/Logging/AuditProcessor.php @@ -28,6 +28,9 @@ /** * Class AuditProcessor + * + * Processador de auditoria. + * Adiciona informacoes de usuario, IP e requisicao aos registros de log de auditoria. */ class AuditProcessor { diff --git a/app/Support/Models/AccountBalanceCalculator.php b/app/Support/Models/AccountBalanceCalculator.php index f4ae008911a..364bf65db1e 100644 --- a/app/Support/Models/AccountBalanceCalculator.php +++ b/app/Support/Models/AccountBalanceCalculator.php @@ -36,9 +36,8 @@ /** * Class AccountBalanceCalculator * - * This class started as a piece of code to create and calculate "account balance" objects, but they - * are at the moment unused. Instead, each transaction gets a before/after balance and an indicator if this - * balance is up-to-date. This class now contains some methods to recalculate those amounts. + * Calculadora de saldo de conta. + * Recalcula saldos de transacoes e contas, mantendo valores antes/depois atualizados. */ class AccountBalanceCalculator { diff --git a/app/Support/Models/BillDateCalculator.php b/app/Support/Models/BillDateCalculator.php index 3d49c867a3d..34d263e2ccb 100644 --- a/app/Support/Models/BillDateCalculator.php +++ b/app/Support/Models/BillDateCalculator.php @@ -28,6 +28,12 @@ use Illuminate\Support\Collection; use Illuminate\Support\Facades\Log; +/** + * Class BillDateCalculator + * + * Calculadora de datas de fatura. + * Calcula datas de pagamento esperadas para faturas recorrentes. + */ class BillDateCalculator { // #8401 we start keeping track of the diff in periods, because if it can't jump over a period (happens often in February) diff --git a/app/Support/Models/ReturnsIntegerIdTrait.php b/app/Support/Models/ReturnsIntegerIdTrait.php index 804b9be3840..bd85ef3e65a 100644 --- a/app/Support/Models/ReturnsIntegerIdTrait.php +++ b/app/Support/Models/ReturnsIntegerIdTrait.php @@ -28,6 +28,9 @@ /** * Trait ReturnsIntegerIdTrait + * + * Trait para retornar ID como inteiro. + * Garante que o atributo ID seja sempre retornado como inteiro. */ trait ReturnsIntegerIdTrait { diff --git a/app/Support/Models/ReturnsIntegerUserIdTrait.php b/app/Support/Models/ReturnsIntegerUserIdTrait.php index a0d2bc79e96..4bf455da510 100644 --- a/app/Support/Models/ReturnsIntegerUserIdTrait.php +++ b/app/Support/Models/ReturnsIntegerUserIdTrait.php @@ -28,6 +28,9 @@ /** * Trait ReturnsIntegerUserIdTrait + * + * Trait para retornar IDs de usuario como inteiro. + * Garante que user_id e user_group_id sejam sempre retornados como inteiros. */ trait ReturnsIntegerUserIdTrait { diff --git a/app/Support/Navigation.php b/app/Support/Navigation.php index d88b01ba38b..864fbcde1c5 100644 --- a/app/Support/Navigation.php +++ b/app/Support/Navigation.php @@ -33,7 +33,10 @@ use Throwable; /** - * Class Navigation. + * Class Navigation + * + * Classe de navegacao temporal. + * Fornece metodos para calculos de periodos, datas e intervalos. */ class Navigation { diff --git a/app/Support/Notifications/UrlValidator.php b/app/Support/Notifications/UrlValidator.php index cd6ffefd87a..5a05effc6e5 100644 --- a/app/Support/Notifications/UrlValidator.php +++ b/app/Support/Notifications/UrlValidator.php @@ -26,6 +26,9 @@ /** * Class UrlValidator + * + * Validador de URL de webhook. + * Valida se uma URL e um webhook valido do Slack ou Discord. */ class UrlValidator { diff --git a/app/Support/NullArrayObject.php b/app/Support/NullArrayObject.php index a1b6b190deb..3db11f36cb8 100644 --- a/app/Support/NullArrayObject.php +++ b/app/Support/NullArrayObject.php @@ -28,6 +28,9 @@ /** * Class NullArrayObject + * + * ArrayObject que retorna null para chaves inexistentes. + * Evita erros ao acessar indices que nao existem no array. */ class NullArrayObject extends ArrayObject { diff --git a/app/Support/Observers/RecalculatesAvailableBudgetsTrait.php b/app/Support/Observers/RecalculatesAvailableBudgetsTrait.php index a6f33660dc8..2c57cf0198d 100644 --- a/app/Support/Observers/RecalculatesAvailableBudgetsTrait.php +++ b/app/Support/Observers/RecalculatesAvailableBudgetsTrait.php @@ -16,6 +16,12 @@ use Spatie\Period\Period; use Spatie\Period\Precision; +/** + * Trait RecalculatesAvailableBudgetsTrait + * + * Recalculo de orcamentos disponiveis. + * Fornece metodos para atualizar orcamentos disponiveis quando limites de orcamento sao alterados. + */ trait RecalculatesAvailableBudgetsTrait { private function updateAvailableBudget(BudgetLimit $budgetLimit): void diff --git a/app/Support/ParseDateString.php b/app/Support/ParseDateString.php index 90a2ac6d88c..f0dc36282cd 100644 --- a/app/Support/ParseDateString.php +++ b/app/Support/ParseDateString.php @@ -34,6 +34,9 @@ /** * Class ParseDateString + * + * Classe de parsing de strings de data. + * Fornece metodos para converter strings em objetos Carbon, incluindo datas relativas. */ class ParseDateString { diff --git a/app/Support/Preferences.php b/app/Support/Preferences.php index 41dbe8f9dd2..d6ecbfc8fe3 100644 --- a/app/Support/Preferences.php +++ b/app/Support/Preferences.php @@ -36,7 +36,10 @@ use Illuminate\Support\Facades\Session; /** - * Class Preferences. + * Class Preferences + * + * Classe de gerenciamento de preferencias de usuario. + * Fornece metodos para obter, definir e excluir preferencias do usuario. */ class Preferences { diff --git a/app/Support/Report/Budget/BudgetReportGenerator.php b/app/Support/Report/Budget/BudgetReportGenerator.php index 3014e97dc4c..83d7ea914c7 100644 --- a/app/Support/Report/Budget/BudgetReportGenerator.php +++ b/app/Support/Report/Budget/BudgetReportGenerator.php @@ -39,7 +39,8 @@ /** * Class BudgetReportGenerator * - * This class is basically a very long for-each loop disguised as a class. It's readable but not really OOP. + * Gerador de relatorio de orcamento. + * Gera dados para relatorios de orcamento incluindo gastos por conta e limites. */ class BudgetReportGenerator { diff --git a/app/Support/Report/Category/CategoryReportGenerator.php b/app/Support/Report/Category/CategoryReportGenerator.php index 91f1470bb82..5cedbb88a5b 100644 --- a/app/Support/Report/Category/CategoryReportGenerator.php +++ b/app/Support/Report/Category/CategoryReportGenerator.php @@ -32,6 +32,9 @@ /** * Class CategoryReportGenerator + * + * Gerador de relatorio de categoria. + * Gera dados para relatorios de categoria incluindo receitas e despesas. */ class CategoryReportGenerator { diff --git a/app/Support/Report/Summarizer/TransactionSummarizer.php b/app/Support/Report/Summarizer/TransactionSummarizer.php index a1ab2abf07d..ed58a125c04 100644 --- a/app/Support/Report/Summarizer/TransactionSummarizer.php +++ b/app/Support/Report/Summarizer/TransactionSummarizer.php @@ -29,6 +29,12 @@ use FireflyIII\User; use Illuminate\Support\Facades\Log; +/** + * Class TransactionSummarizer + * + * Sumarizador de transacoes. + * Agrupa e soma transacoes por moeda e direcao para relatorios. + */ class TransactionSummarizer { private bool $convertToPrimary = false; diff --git a/app/Support/Repositories/Recurring/CalculateRangeOccurrences.php b/app/Support/Repositories/Recurring/CalculateRangeOccurrences.php index 439fd1f50a5..71de3fadb52 100644 --- a/app/Support/Repositories/Recurring/CalculateRangeOccurrences.php +++ b/app/Support/Repositories/Recurring/CalculateRangeOccurrences.php @@ -28,6 +28,9 @@ /** * Trait CalculateRangeOccurrences + * + * Calculo de ocorrencias em intervalo. + * Fornece metodos para calcular ocorrencias de transacoes recorrentes dentro de um intervalo de datas. */ trait CalculateRangeOccurrences { diff --git a/app/Support/Repositories/Recurring/CalculateXOccurrences.php b/app/Support/Repositories/Recurring/CalculateXOccurrences.php index 04f07046d4e..aba5a1ad299 100644 --- a/app/Support/Repositories/Recurring/CalculateXOccurrences.php +++ b/app/Support/Repositories/Recurring/CalculateXOccurrences.php @@ -27,7 +27,10 @@ use Carbon\Carbon; /** - * Class CalculateXOccurrences + * Trait CalculateXOccurrences + * + * Calculo de X ocorrencias. + * Fornece metodos para calcular um numero especifico de ocorrencias de transacoes recorrentes. */ trait CalculateXOccurrences { diff --git a/app/Support/Repositories/Recurring/CalculateXOccurrencesSince.php b/app/Support/Repositories/Recurring/CalculateXOccurrencesSince.php index 215c11bf0a6..21939eac8a9 100644 --- a/app/Support/Repositories/Recurring/CalculateXOccurrencesSince.php +++ b/app/Support/Repositories/Recurring/CalculateXOccurrencesSince.php @@ -28,7 +28,10 @@ use Illuminate\Support\Facades\Log; /** - * Class CalculateXOccurrencesSince + * Trait CalculateXOccurrencesSince + * + * Calculo de ocorrencias desde uma data. + * Fornece metodos para calcular X ocorrencias de transacoes recorrentes a partir de uma data. */ trait CalculateXOccurrencesSince { diff --git a/app/Support/Repositories/Recurring/FiltersWeekends.php b/app/Support/Repositories/Recurring/FiltersWeekends.php index 222879cc298..eea0d5dcdac 100644 --- a/app/Support/Repositories/Recurring/FiltersWeekends.php +++ b/app/Support/Repositories/Recurring/FiltersWeekends.php @@ -31,6 +31,9 @@ /** * Trait FiltersWeekends + * + * Filtro de fins de semana. + * Fornece metodos para ajustar datas de transacoes recorrentes que caem em fins de semana. */ trait FiltersWeekends { diff --git a/app/Support/Repositories/UserGroup/UserGroupInterface.php b/app/Support/Repositories/UserGroup/UserGroupInterface.php index 8a087f4edf2..cc3165c6715 100644 --- a/app/Support/Repositories/UserGroup/UserGroupInterface.php +++ b/app/Support/Repositories/UserGroup/UserGroupInterface.php @@ -29,6 +29,12 @@ use FireflyIII\User; use Illuminate\Contracts\Auth\Authenticatable; +/** + * Interface UserGroupInterface + * + * Interface de grupo de usuario. + * Define o contrato para acesso e verificacao de permissoes de grupo de usuario. + */ interface UserGroupInterface { public function checkUserGroupAccess(UserRoleEnum $role): bool; diff --git a/app/Support/Repositories/UserGroup/UserGroupTrait.php b/app/Support/Repositories/UserGroup/UserGroupTrait.php index 5e5eb6c59ff..772c034dcdb 100644 --- a/app/Support/Repositories/UserGroup/UserGroupTrait.php +++ b/app/Support/Repositories/UserGroup/UserGroupTrait.php @@ -34,6 +34,9 @@ /** * Trait UserGroupTrait + * + * Trait de grupo de usuario. + * Fornece metodos para gerenciar usuario e grupo de usuario em repositorios. */ trait UserGroupTrait { diff --git a/app/Support/Request/AppendsLocationData.php b/app/Support/Request/AppendsLocationData.php index 149898f9868..4341eeb7c51 100644 --- a/app/Support/Request/AppendsLocationData.php +++ b/app/Support/Request/AppendsLocationData.php @@ -26,6 +26,9 @@ /** * Trait AppendsLocationData + * + * Trait para adicionar dados de localizacao. + * Processa e valida dados de latitude, longitude e zoom em requisicoes. */ trait AppendsLocationData { diff --git a/app/Support/Request/ChecksLogin.php b/app/Support/Request/ChecksLogin.php index 9fd2e118838..9475b78865b 100644 --- a/app/Support/Request/ChecksLogin.php +++ b/app/Support/Request/ChecksLogin.php @@ -30,6 +30,9 @@ /** * Trait ChecksLogin + * + * Trait para verificacao de login. + * Verifica autenticacao e permissoes de usuario em requisicoes. */ trait ChecksLogin { diff --git a/app/Support/Request/ConvertsDataTypes.php b/app/Support/Request/ConvertsDataTypes.php index 60e954945a5..ed90105c551 100644 --- a/app/Support/Request/ConvertsDataTypes.php +++ b/app/Support/Request/ConvertsDataTypes.php @@ -36,6 +36,9 @@ /** * Trait ConvertsDataTypes + * + * Trait para conversao de tipos de dados. + * Fornece metodos para converter e limpar dados de requisicoes. */ trait ConvertsDataTypes { diff --git a/app/Support/Request/GetFilterInstructions.php b/app/Support/Request/GetFilterInstructions.php index cd8c68b5687..44a00eb91f9 100644 --- a/app/Support/Request/GetFilterInstructions.php +++ b/app/Support/Request/GetFilterInstructions.php @@ -26,6 +26,12 @@ use FireflyIII\Exceptions\FireflyException; +/** + * Trait GetFilterInstructions + * + * Trait para obtencao de instrucoes de filtro. + * Processa parametros de filtro em requisicoes da API. + */ trait GetFilterInstructions { private const string INVALID_FILTER = '%INVALID_JAMES_%'; diff --git a/app/Support/Request/GetRecurrenceData.php b/app/Support/Request/GetRecurrenceData.php index 50dc0cd8f23..55bcc59a524 100644 --- a/app/Support/Request/GetRecurrenceData.php +++ b/app/Support/Request/GetRecurrenceData.php @@ -26,6 +26,9 @@ /** * Trait GetRecurrenceData + * + * Trait para obtencao de dados de recorrencia. + * Processa dados de transacoes recorrentes em requisicoes. */ trait GetRecurrenceData { diff --git a/app/Support/Request/GetRuleConfiguration.php b/app/Support/Request/GetRuleConfiguration.php index 56ee8742b43..ccc96225348 100644 --- a/app/Support/Request/GetRuleConfiguration.php +++ b/app/Support/Request/GetRuleConfiguration.php @@ -26,6 +26,9 @@ /** * Trait GetRuleConfiguration + * + * Trait para obtencao de configuracao de regras. + * Fornece metodos para obter gatilhos e acoes de regras. */ trait GetRuleConfiguration { diff --git a/app/Support/Request/GetSortInstructions.php b/app/Support/Request/GetSortInstructions.php index 38343b5a15c..62caf16e472 100644 --- a/app/Support/Request/GetSortInstructions.php +++ b/app/Support/Request/GetSortInstructions.php @@ -24,6 +24,12 @@ namespace FireflyIII\Support\Request; +/** + * Trait GetSortInstructions + * + * Trait para obtencao de instrucoes de ordenacao. + * Processa parametros de ordenacao em requisicoes da API. + */ trait GetSortInstructions { final public function getSortInstructions(string $key): array diff --git a/app/Support/Search/AccountSearch.php b/app/Support/Search/AccountSearch.php index f374895c659..ddadf94e46c 100644 --- a/app/Support/Search/AccountSearch.php +++ b/app/Support/Search/AccountSearch.php @@ -33,6 +33,9 @@ /** * Class AccountSearch + * + * Busca de contas. + * Implementa busca de contas por nome, IBAN, numero ou ID. */ class AccountSearch implements GenericSearchInterface { diff --git a/app/Support/Search/GenericSearchInterface.php b/app/Support/Search/GenericSearchInterface.php index 1c765b459e4..8e54fcf18be 100644 --- a/app/Support/Search/GenericSearchInterface.php +++ b/app/Support/Search/GenericSearchInterface.php @@ -28,6 +28,9 @@ /** * Interface GenericSearchInterface + * + * Interface generica de busca. + * Define o contrato para implementacoes de busca no sistema. */ interface GenericSearchInterface { diff --git a/app/Support/Search/OperatorQuerySearch.php b/app/Support/Search/OperatorQuerySearch.php index 69781b2157f..10f72759f4a 100644 --- a/app/Support/Search/OperatorQuerySearch.php +++ b/app/Support/Search/OperatorQuerySearch.php @@ -55,6 +55,9 @@ /** * Class OperatorQuerySearch * + * Busca de transacoes por operadores. + * Implementa busca avancada usando operadores de consulta para filtrar transacoes. + * * @SuppressWarnings("PHPMD.CouplingBetweenObjects") */ class OperatorQuerySearch implements SearchInterface diff --git a/app/Support/Search/QueryParser/Node.php b/app/Support/Search/QueryParser/Node.php index 31412cfdab8..5fa948f8a17 100644 --- a/app/Support/Search/QueryParser/Node.php +++ b/app/Support/Search/QueryParser/Node.php @@ -28,7 +28,10 @@ use Illuminate\Support\Facades\Log; /** - * Base class for all nodes + * Class Node + * + * Classe base para nos de busca. + * Representa um no na arvore de parsing de consultas de busca. */ abstract class Node { diff --git a/app/Support/Search/SearchInterface.php b/app/Support/Search/SearchInterface.php index 7aaef87c680..b7dff05a463 100644 --- a/app/Support/Search/SearchInterface.php +++ b/app/Support/Search/SearchInterface.php @@ -30,6 +30,9 @@ /** * Interface SearchInterface. + * + * Interface de busca de transacoes. + * Define o contrato para implementacoes de busca avancada de transacoes. */ interface SearchInterface { diff --git a/app/Support/Singleton/PreferencesSingleton.php b/app/Support/Singleton/PreferencesSingleton.php index e955a0f5ec4..339e167d674 100644 --- a/app/Support/Singleton/PreferencesSingleton.php +++ b/app/Support/Singleton/PreferencesSingleton.php @@ -4,6 +4,12 @@ namespace FireflyIII\Support\Singleton; +/** + * Class PreferencesSingleton + * + * Singleton de preferencias. + * Armazena preferencias em memoria para acesso rapido durante a requisicao. + */ class PreferencesSingleton { private static ?PreferencesSingleton $instance = null; diff --git a/app/Support/Steam.php b/app/Support/Steam.php index 0d1cca50fad..df5f8c8fc0d 100644 --- a/app/Support/Steam.php +++ b/app/Support/Steam.php @@ -43,7 +43,10 @@ use function Safe\preg_replace; /** - * Class Steam. + * Class Steam + * + * Classe utilitaria principal do Firefly III. + * Fornece metodos para calculos de saldo, formatacao e operacoes diversas. */ class Steam { diff --git a/app/Support/System/GeneratesInstallationId.php b/app/Support/System/GeneratesInstallationId.php index 20cd0a303c1..d070634de97 100644 --- a/app/Support/System/GeneratesInstallationId.php +++ b/app/Support/System/GeneratesInstallationId.php @@ -29,6 +29,9 @@ /** * Trait GeneratesInstallationId + * + * Gerador de ID de instalacao. + * Fornece metodo para gerar e armazenar um ID unico para a instalacao do Firefly III. */ trait GeneratesInstallationId { diff --git a/app/Support/System/OAuthKeys.php b/app/Support/System/OAuthKeys.php index 53e353481f2..5402f51d90e 100644 --- a/app/Support/System/OAuthKeys.php +++ b/app/Support/System/OAuthKeys.php @@ -37,6 +37,9 @@ /** * Class OAuthKeys + * + * Gerenciador de chaves OAuth. + * Gerencia a geracao, armazenamento e restauracao de chaves OAuth do Passport. */ class OAuthKeys { diff --git a/app/Support/Twig/AmountFormat.php b/app/Support/Twig/AmountFormat.php index 3a014e80036..6e3622c4c1f 100644 --- a/app/Support/Twig/AmountFormat.php +++ b/app/Support/Twig/AmountFormat.php @@ -34,7 +34,10 @@ use Override; /** - * Contains all amount formatting routines. + * Class AmountFormat + * + * Extensao Twig para formatacao de valores. + * Fornece filtros e funcoes para formatar valores monetarios em templates. */ class AmountFormat extends AbstractExtension { diff --git a/app/Support/Twig/General.php b/app/Support/Twig/General.php index b2c4fc9bcb4..cf5f9e2e970 100644 --- a/app/Support/Twig/General.php +++ b/app/Support/Twig/General.php @@ -42,7 +42,10 @@ use function Safe\parse_url; /** - * Class TwigSupport. + * Class General + * + * Extensao Twig geral. + * Fornece filtros e funcoes utilitarias para templates Twig. */ class General extends AbstractExtension { diff --git a/app/Support/Twig/Rule.php b/app/Support/Twig/Rule.php index c833745d406..1fda4eac7ef 100644 --- a/app/Support/Twig/Rule.php +++ b/app/Support/Twig/Rule.php @@ -29,7 +29,10 @@ use Override; /** - * Class Rule. + * Class Rule + * + * Extensao Twig para regras. + * Fornece funcoes para listar gatilhos e acoes de regras em templates. */ class Rule extends AbstractExtension { diff --git a/app/Support/Twig/TransactionGroupTwig.php b/app/Support/Twig/TransactionGroupTwig.php index 81cf8db2316..69dd3f05800 100644 --- a/app/Support/Twig/TransactionGroupTwig.php +++ b/app/Support/Twig/TransactionGroupTwig.php @@ -39,6 +39,9 @@ /** * Class TransactionGroupTwig + * + * Extensao Twig para grupos de transacao. + * Fornece funcoes para exibir valores e metadados de transacoes em templates. */ class TransactionGroupTwig extends AbstractExtension { diff --git a/app/Support/Twig/Translation.php b/app/Support/Twig/Translation.php index bb19890ff9e..a50c8e49db0 100644 --- a/app/Support/Twig/Translation.php +++ b/app/Support/Twig/Translation.php @@ -29,7 +29,10 @@ use Override; /** - * Class Budget. + * Class Translation + * + * Extensao Twig para traducao. + * Fornece filtros e funcoes para traducao de textos em templates. */ class Translation extends AbstractExtension { diff --git a/app/Support/Validation/ValidatesAmountsTrait.php b/app/Support/Validation/ValidatesAmountsTrait.php index b33a66c2737..95c45ced0a7 100644 --- a/app/Support/Validation/ValidatesAmountsTrait.php +++ b/app/Support/Validation/ValidatesAmountsTrait.php @@ -24,6 +24,12 @@ namespace FireflyIII\Support\Validation; +/** + * Trait ValidatesAmountsTrait + * + * Trait para validacao de valores. + * Fornece metodos para validar valores monetarios em transacoes. + */ trait ValidatesAmountsTrait { // 19-09-2020: my wedding day diff --git a/app/TransactionRules/Actions/ActionInterface.php b/app/TransactionRules/Actions/ActionInterface.php index 8a1ffdd5ae9..4e9a788d076 100644 --- a/app/TransactionRules/Actions/ActionInterface.php +++ b/app/TransactionRules/Actions/ActionInterface.php @@ -25,6 +25,9 @@ /** * Interface ActionInterface. + * + * Interface para acoes de regras de transacao. + * Define metodo para executar acao em transacao. */ interface ActionInterface { diff --git a/app/TransactionRules/Actions/AddTag.php b/app/TransactionRules/Actions/AddTag.php index 3823f7721f4..4c6abcb2290 100644 --- a/app/TransactionRules/Actions/AddTag.php +++ b/app/TransactionRules/Actions/AddTag.php @@ -33,14 +33,25 @@ /** * Class AddTag. + * + * Acao para adicionar tag a uma transacao. */ class AddTag implements ActionInterface { /** - * TriggerInterface constructor. + * Construtor da acao. + * + * @param RuleAction $action Acao da regra */ public function __construct(private readonly RuleAction $action) {} + /** + * Executa a acao no diario de transacao. + * + * @param array $journal Dados do diario + * + * @return bool True se executado com sucesso + */ public function actOnArray(array $journal): bool { // journal has this tag maybe? diff --git a/app/TransactionRules/Actions/AppendDescription.php b/app/TransactionRules/Actions/AppendDescription.php index 946c4c5def5..68b131a4062 100644 --- a/app/TransactionRules/Actions/AppendDescription.php +++ b/app/TransactionRules/Actions/AppendDescription.php @@ -31,6 +31,8 @@ /** * Class AppendDescription. + * + * Acao para adicionar texto ao final da descricao. * TODO Can be replaced (and migrated) to action "set description" with a prefilled expression */ class AppendDescription implements ActionInterface @@ -38,10 +40,19 @@ class AppendDescription implements ActionInterface use RefreshNotesTrait; /** - * TriggerInterface constructor. + * Construtor da acao. + * + * @param RuleAction $action Acao da regra */ public function __construct(private RuleAction $action) {} + /** + * Executa a acao no diario de transacao. + * + * @param array $journal Dados do diario + * + * @return bool True se executado com sucesso + */ public function actOnArray(array $journal): bool { $this->refreshNotes($journal); diff --git a/app/TransactionRules/Actions/AppendDescriptionToNotes.php b/app/TransactionRules/Actions/AppendDescriptionToNotes.php index 952d27fd3ae..733332add99 100644 --- a/app/TransactionRules/Actions/AppendDescriptionToNotes.php +++ b/app/TransactionRules/Actions/AppendDescriptionToNotes.php @@ -33,6 +33,8 @@ /** * Class AppendDescriptionToNotes + * + * Acao para adicionar descricao as notas da transacao. * TODO Can be replaced (and migrated) to action "set notes" with a prefilled expression */ class AppendDescriptionToNotes implements ActionInterface @@ -40,10 +42,19 @@ class AppendDescriptionToNotes implements ActionInterface use RefreshNotesTrait; /** - * TriggerInterface constructor. + * Construtor da acao. + * + * @param RuleAction $action Acao da regra */ public function __construct(private RuleAction $action) {} + /** + * Executa a acao no diario de transacao. + * + * @param array $journal Dados do diario + * + * @return bool True se executado com sucesso + */ public function actOnArray(array $journal): bool { $this->refreshNotes($journal); diff --git a/app/TransactionRules/Actions/AppendNotes.php b/app/TransactionRules/Actions/AppendNotes.php index c27853d8ed1..69fe83d79c6 100644 --- a/app/TransactionRules/Actions/AppendNotes.php +++ b/app/TransactionRules/Actions/AppendNotes.php @@ -31,6 +31,8 @@ /** * Class AppendNotes. + * + * Acao para adicionar texto ao final das notas. * TODO Can be replaced (and migrated) to action "set notes" with a prefilled expression */ class AppendNotes implements ActionInterface @@ -38,10 +40,19 @@ class AppendNotes implements ActionInterface use RefreshNotesTrait; /** - * TriggerInterface constructor. + * Construtor da acao. + * + * @param RuleAction $action Acao da regra */ public function __construct(private RuleAction $action) {} + /** + * Executa a acao no diario de transacao. + * + * @param array $journal Dados do diario + * + * @return bool True se executado com sucesso + */ public function actOnArray(array $journal): bool { $this->refreshNotes($journal); diff --git a/app/TransactionRules/Actions/AppendNotesToDescription.php b/app/TransactionRules/Actions/AppendNotesToDescription.php index 86c46891b39..e11e9a6bb6e 100644 --- a/app/TransactionRules/Actions/AppendNotesToDescription.php +++ b/app/TransactionRules/Actions/AppendNotesToDescription.php @@ -34,6 +34,8 @@ /** * Class AppendNotesToDescription + * + * Acao para adicionar notas ao final da descricao. * TODO Can be replaced (and migrated) to action "set description" with a prefilled expression */ class AppendNotesToDescription implements ActionInterface @@ -42,10 +44,19 @@ class AppendNotesToDescription implements ActionInterface use RefreshNotesTrait; /** - * TriggerInterface constructor. + * Construtor da acao. + * + * @param RuleAction $action Acao da regra */ public function __construct(private RuleAction $action) {} + /** + * Executa a acao no diario de transacao. + * + * @param array $journal Dados do diario + * + * @return bool True se executado com sucesso + */ public function actOnArray(array $journal): bool { app('log')->debug('Now in AppendNotesToDescription'); diff --git a/app/TransactionRules/Actions/ClearBudget.php b/app/TransactionRules/Actions/ClearBudget.php index 08e7dce7fa4..1b9aca5bac4 100644 --- a/app/TransactionRules/Actions/ClearBudget.php +++ b/app/TransactionRules/Actions/ClearBudget.php @@ -31,14 +31,25 @@ /** * Class ClearBudget. + * + * Acao para remover orcamento de uma transacao. */ class ClearBudget implements ActionInterface { /** - * TriggerInterface constructor. + * Construtor da acao. + * + * @param RuleAction $action Acao da regra */ public function __construct(private readonly RuleAction $action) {} + /** + * Executa a acao no diario de transacao. + * + * @param array $journal Dados do diario + * + * @return bool True se executado com sucesso + */ public function actOnArray(array $journal): bool { /** @var TransactionJournal $object */ diff --git a/app/TransactionRules/Actions/ClearCategory.php b/app/TransactionRules/Actions/ClearCategory.php index 73fa40b3f04..553cd8abcbc 100644 --- a/app/TransactionRules/Actions/ClearCategory.php +++ b/app/TransactionRules/Actions/ClearCategory.php @@ -31,14 +31,25 @@ /** * Class ClearCategory. + * + * Acao para remover categoria de uma transacao. */ class ClearCategory implements ActionInterface { /** - * TriggerInterface constructor. + * Construtor da acao. + * + * @param RuleAction $action Acao da regra */ public function __construct(private readonly RuleAction $action) {} + /** + * Executa a acao no diario de transacao. + * + * @param array $journal Dados do diario + * + * @return bool True se executado com sucesso + */ public function actOnArray(array $journal): bool { /** @var TransactionJournal $object */ diff --git a/app/TransactionRules/Actions/ClearNotes.php b/app/TransactionRules/Actions/ClearNotes.php index 48e770012b5..8f435ff7bec 100644 --- a/app/TransactionRules/Actions/ClearNotes.php +++ b/app/TransactionRules/Actions/ClearNotes.php @@ -32,14 +32,25 @@ /** * Class ClearNotes. + * + * Acao para limpar notas de uma transacao. */ class ClearNotes implements ActionInterface { /** - * TriggerInterface constructor. + * Construtor da acao. + * + * @param RuleAction $action Acao da regra */ public function __construct(private readonly RuleAction $action) {} + /** + * Executa a acao no diario de transacao. + * + * @param array $journal Dados do diario + * + * @return bool True se executado com sucesso + */ public function actOnArray(array $journal): bool { /** @var TransactionJournal $object */ diff --git a/app/TransactionRules/Actions/ConvertToDeposit.php b/app/TransactionRules/Actions/ConvertToDeposit.php index b61599190d6..8ac3f29ebdd 100644 --- a/app/TransactionRules/Actions/ConvertToDeposit.php +++ b/app/TransactionRules/Actions/ConvertToDeposit.php @@ -40,14 +40,25 @@ /** * Class ConvertToDeposit + * + * Acao para converter transacao em deposito. */ class ConvertToDeposit implements ActionInterface { /** - * TriggerInterface constructor. + * Construtor da acao. + * + * @param RuleAction $action Acao da regra */ public function __construct(private readonly RuleAction $action) {} + /** + * Executa a acao no diario de transacao. + * + * @param array $journal Dados do diario + * + * @return bool True se executado com sucesso + */ public function actOnArray(array $journal): bool { $actionValue = $this->action->getValue($journal); diff --git a/app/TransactionRules/Actions/ConvertToTransfer.php b/app/TransactionRules/Actions/ConvertToTransfer.php index ba613d795f3..354a8407b5c 100644 --- a/app/TransactionRules/Actions/ConvertToTransfer.php +++ b/app/TransactionRules/Actions/ConvertToTransfer.php @@ -39,11 +39,15 @@ /** * Class ConvertToTransfer + * + * Acao para converter transacao em transferencia. */ class ConvertToTransfer implements ActionInterface { /** - * TriggerInterface constructor. + * Construtor da acao. + * + * @param RuleAction $action Acao da regra */ public function __construct(private readonly RuleAction $action) {} diff --git a/app/TransactionRules/Actions/ConvertToWithdrawal.php b/app/TransactionRules/Actions/ConvertToWithdrawal.php index 61fba99de40..d93188175c0 100644 --- a/app/TransactionRules/Actions/ConvertToWithdrawal.php +++ b/app/TransactionRules/Actions/ConvertToWithdrawal.php @@ -40,14 +40,25 @@ /** * Class ConvertToWithdrawal + * + * Acao para converter transacao em saque. */ class ConvertToWithdrawal implements ActionInterface { /** - * TriggerInterface constructor. + * Construtor da acao. + * + * @param RuleAction $action Acao da regra */ public function __construct(private readonly RuleAction $action) {} + /** + * Executa a acao no diario de transacao. + * + * @param array $journal Dados do diario + * + * @return bool True se executado com sucesso + */ public function actOnArray(array $journal): bool { $actionValue = $this->action->getValue($journal); diff --git a/app/TransactionRules/Actions/DeleteTransaction.php b/app/TransactionRules/Actions/DeleteTransaction.php index fec4cb3ad4d..298be25362d 100644 --- a/app/TransactionRules/Actions/DeleteTransaction.php +++ b/app/TransactionRules/Actions/DeleteTransaction.php @@ -32,14 +32,25 @@ /** * Class DeleteTransaction. + * + * Acao para excluir uma transacao. */ class DeleteTransaction implements ActionInterface { /** - * TriggerInterface constructor. + * Construtor da acao. + * + * @param RuleAction $action Acao da regra */ public function __construct(private readonly RuleAction $action) {} + /** + * Executa a acao no diario de transacao. + * + * @param array $journal Dados do diario + * + * @return bool True se executado com sucesso + */ public function actOnArray(array $journal): bool { $count = TransactionJournal::where('transaction_group_id', $journal['transaction_group_id'])->count(); diff --git a/app/TransactionRules/Actions/LinkToBill.php b/app/TransactionRules/Actions/LinkToBill.php index b52f278442a..a58864982c4 100644 --- a/app/TransactionRules/Actions/LinkToBill.php +++ b/app/TransactionRules/Actions/LinkToBill.php @@ -34,14 +34,25 @@ /** * Class LinkToBill. + * + * Acao para vincular transacao a uma fatura. */ class LinkToBill implements ActionInterface { /** - * TriggerInterface constructor. + * Construtor da acao. + * + * @param RuleAction $action Acao da regra */ public function __construct(private readonly RuleAction $action) {} + /** + * Executa a acao no diario de transacao. + * + * @param array $journal Dados do diario + * + * @return bool True se executado com sucesso + */ public function actOnArray(array $journal): bool { /** @var User $user */ diff --git a/app/TransactionRules/Actions/MoveDescriptionToNotes.php b/app/TransactionRules/Actions/MoveDescriptionToNotes.php index 62711bf5e6d..9ccaffd98bd 100644 --- a/app/TransactionRules/Actions/MoveDescriptionToNotes.php +++ b/app/TransactionRules/Actions/MoveDescriptionToNotes.php @@ -32,15 +32,26 @@ /** * Class MoveDescriptionToNotes + * + * Acao para mover descricao para as notas da transacao. * TODO Can be replaced (and migrated) to action "set notes" with a prefilled expression */ class MoveDescriptionToNotes implements ActionInterface { /** - * TriggerInterface constructor. + * Construtor da acao. + * + * @param RuleAction $action Acao da regra */ public function __construct(private readonly RuleAction $action) {} + /** + * Executa a acao no diario de transacao. + * + * @param array $journal Dados do diario + * + * @return bool True se executado com sucesso + */ public function actOnArray(array $journal): bool { /** @var null|TransactionJournal $object */ diff --git a/app/TransactionRules/Actions/MoveNotesToDescription.php b/app/TransactionRules/Actions/MoveNotesToDescription.php index 6852f5644bd..8c849397516 100644 --- a/app/TransactionRules/Actions/MoveNotesToDescription.php +++ b/app/TransactionRules/Actions/MoveNotesToDescription.php @@ -32,10 +32,8 @@ /** * Class MoveNotesToDescription - */ - -/** - * Class MoveNotesToDescription + * + * Acao para mover notas para a descricao da transacao. * TODO Can be replaced (and migrated) to action "set notes" with a prefilled expression */ class MoveNotesToDescription implements ActionInterface @@ -43,10 +41,19 @@ class MoveNotesToDescription implements ActionInterface use ConvertsDataTypes; /** - * TriggerInterface constructor. + * Construtor da acao. + * + * @param RuleAction $action Acao da regra */ public function __construct(private RuleAction $action) {} + /** + * Executa a acao no diario de transacao. + * + * @param array $journal Dados do diario + * + * @return bool True se executado com sucesso + */ public function actOnArray(array $journal): bool { /** @var null|TransactionJournal $object */ diff --git a/app/TransactionRules/Actions/PrependDescription.php b/app/TransactionRules/Actions/PrependDescription.php index 37e888ca34a..cb18ca1d336 100644 --- a/app/TransactionRules/Actions/PrependDescription.php +++ b/app/TransactionRules/Actions/PrependDescription.php @@ -30,15 +30,26 @@ /** * Class PrependDescription. + * + * Acao para adicionar texto no inicio da descricao. * TODO Can be replaced (and migrated) to action "set description" with a prefilled expression */ class PrependDescription implements ActionInterface { /** - * TriggerInterface constructor. + * Construtor da acao. + * + * @param RuleAction $action Acao da regra */ public function __construct(private readonly RuleAction $action) {} + /** + * Executa a acao no diario de transacao. + * + * @param array $journal Dados do diario + * + * @return bool True se executado com sucesso + */ public function actOnArray(array $journal): bool { $before = $journal['description']; diff --git a/app/TransactionRules/Actions/PrependNotes.php b/app/TransactionRules/Actions/PrependNotes.php index e4e8249c8b4..5ba64e40c11 100644 --- a/app/TransactionRules/Actions/PrependNotes.php +++ b/app/TransactionRules/Actions/PrependNotes.php @@ -30,15 +30,26 @@ /** * Class PrependNotes. + * + * Acao para adicionar texto no inicio das notas. * TODO Can be replaced (and migrated) to action "set notes" with a prefilled expression */ class PrependNotes implements ActionInterface { /** - * TriggerInterface constructor. + * Construtor da acao. + * + * @param RuleAction $action Acao da regra */ public function __construct(private readonly RuleAction $action) {} + /** + * Executa a acao no diario de transacao. + * + * @param array $journal Dados do diario + * + * @return bool True se executado com sucesso + */ public function actOnArray(array $journal): bool { $dbNote = Note::where('noteable_id', (int) $journal['transaction_journal_id']) diff --git a/app/TransactionRules/Actions/RemoveAllTags.php b/app/TransactionRules/Actions/RemoveAllTags.php index cf5d7ee7830..428869bcfca 100644 --- a/app/TransactionRules/Actions/RemoveAllTags.php +++ b/app/TransactionRules/Actions/RemoveAllTags.php @@ -31,14 +31,25 @@ /** * Class RemoveAllTags. + * + * Acao para remover todas as tags de uma transacao. */ class RemoveAllTags implements ActionInterface { /** - * TriggerInterface constructor. + * Construtor da acao. + * + * @param RuleAction $action Acao da regra */ public function __construct(private readonly RuleAction $action) {} + /** + * Executa a acao no diario de transacao. + * + * @param array $journal Dados do diario + * + * @return bool True se executado com sucesso + */ public function actOnArray(array $journal): bool { DB::table('tag_transaction_journal')->where('transaction_journal_id', $journal['transaction_journal_id'])->delete(); diff --git a/app/TransactionRules/Actions/RemoveTag.php b/app/TransactionRules/Actions/RemoveTag.php index 956835b2e3a..310a28e099a 100644 --- a/app/TransactionRules/Actions/RemoveTag.php +++ b/app/TransactionRules/Actions/RemoveTag.php @@ -32,14 +32,25 @@ /** * Class RemoveTag. + * + * Acao para remover uma tag de uma transacao. */ class RemoveTag implements ActionInterface { /** - * TriggerInterface constructor. + * Construtor da acao. + * + * @param RuleAction $action Acao da regra */ public function __construct(private readonly RuleAction $action) {} + /** + * Executa a acao no diario de transacao. + * + * @param array $journal Dados do diario + * + * @return bool True se executado com sucesso + */ public function actOnArray(array $journal): bool { $name = $this->action->getValue($journal); diff --git a/app/TransactionRules/Actions/SetAmount.php b/app/TransactionRules/Actions/SetAmount.php index c7c2e47518b..0705917f5a2 100644 --- a/app/TransactionRules/Actions/SetAmount.php +++ b/app/TransactionRules/Actions/SetAmount.php @@ -31,15 +31,29 @@ use FireflyIII\Models\TransactionJournal; use FireflyIII\TransactionRules\Traits\RefreshNotesTrait; +/** + * Class SetAmount + * + * Acao para definir o valor de uma transacao. + */ class SetAmount implements ActionInterface { use RefreshNotesTrait; /** - * TriggerInterface constructor. + * Construtor da acao. + * + * @param RuleAction $action Acao da regra */ public function __construct(private RuleAction $action) {} + /** + * Executa a acao no diario de transacao. + * + * @param array $journal Dados do diario + * + * @return bool True se executado com sucesso + */ public function actOnArray(array $journal): bool { $this->refreshNotes($journal); diff --git a/app/TransactionRules/Actions/SetBudget.php b/app/TransactionRules/Actions/SetBudget.php index 54bb75902b5..a1e3a7f639f 100644 --- a/app/TransactionRules/Actions/SetBudget.php +++ b/app/TransactionRules/Actions/SetBudget.php @@ -33,14 +33,25 @@ /** * Class SetBudget. + * + * Acao para definir o orcamento de uma transacao. */ class SetBudget implements ActionInterface { /** - * TriggerInterface constructor. + * Construtor da acao. + * + * @param RuleAction $action Acao da regra */ public function __construct(private readonly RuleAction $action) {} + /** + * Executa a acao no diario de transacao. + * + * @param array $journal Dados do diario + * + * @return bool True se executado com sucesso + */ public function actOnArray(array $journal): bool { /** @var User $user */ diff --git a/app/TransactionRules/Actions/SetCategory.php b/app/TransactionRules/Actions/SetCategory.php index c546dcad1a9..daea6a92720 100644 --- a/app/TransactionRules/Actions/SetCategory.php +++ b/app/TransactionRules/Actions/SetCategory.php @@ -33,14 +33,25 @@ /** * Class SetCategory. + * + * Acao para definir a categoria de uma transacao. */ class SetCategory implements ActionInterface { /** - * TriggerInterface constructor. + * Construtor da acao. + * + * @param RuleAction $action Acao da regra */ public function __construct(private readonly RuleAction $action) {} + /** + * Executa a acao no diario de transacao. + * + * @param array $journal Dados do diario + * + * @return bool True se executado com sucesso + */ public function actOnArray(array $journal): bool { /** @var null|User $user */ diff --git a/app/TransactionRules/Actions/SetDescription.php b/app/TransactionRules/Actions/SetDescription.php index d6cc04fd6a3..0232c7c1372 100644 --- a/app/TransactionRules/Actions/SetDescription.php +++ b/app/TransactionRules/Actions/SetDescription.php @@ -32,16 +32,27 @@ /** * Class SetDescription. + * + * Acao para definir a descricao de uma transacao. */ class SetDescription implements ActionInterface { use RefreshNotesTrait; /** - * TriggerInterface constructor. + * Construtor da acao. + * + * @param RuleAction $action Acao da regra */ public function __construct(private RuleAction $action) {} + /** + * Executa a acao no diario de transacao. + * + * @param array $journal Dados do diario + * + * @return bool True se executado com sucesso + */ public function actOnArray(array $journal): bool { $this->refreshNotes($journal); diff --git a/app/TransactionRules/Actions/SetDestinationAccount.php b/app/TransactionRules/Actions/SetDestinationAccount.php index b749889eb1f..e78ca930360 100644 --- a/app/TransactionRules/Actions/SetDestinationAccount.php +++ b/app/TransactionRules/Actions/SetDestinationAccount.php @@ -36,16 +36,28 @@ /** * Class SetDestinationAccount. + * + * Acao para definir a conta de destino de uma transacao. */ class SetDestinationAccount implements ActionInterface { + /** @var AccountRepositoryInterface Repositorio de contas */ private AccountRepositoryInterface $repository; /** - * TriggerInterface constructor. + * Construtor da acao. + * + * @param RuleAction $action Acao da regra */ public function __construct(private readonly RuleAction $action) {} + /** + * Executa a acao no diario de transacao. + * + * @param array $journal Dados do diario + * + * @return bool True se executado com sucesso + */ public function actOnArray(array $journal): bool { $accountName = $this->action->getValue($journal); diff --git a/app/TransactionRules/Actions/SetDestinationToCashAccount.php b/app/TransactionRules/Actions/SetDestinationToCashAccount.php index 967e07928da..2b36e46f29b 100644 --- a/app/TransactionRules/Actions/SetDestinationToCashAccount.php +++ b/app/TransactionRules/Actions/SetDestinationToCashAccount.php @@ -36,14 +36,25 @@ /** * Class SetDestinationToCashAccount + * + * Acao para definir destino como conta de dinheiro. */ class SetDestinationToCashAccount implements ActionInterface { /** - * TriggerInterface constructor. + * Construtor da acao. + * + * @param RuleAction $action Acao da regra */ public function __construct(private readonly RuleAction $action) {} + /** + * Executa a acao no diario de transacao. + * + * @param array $journal Dados do diario + * + * @return bool True se executado com sucesso + */ public function actOnArray(array $journal): bool { /** @var User $user */ diff --git a/app/TransactionRules/Actions/SetNotes.php b/app/TransactionRules/Actions/SetNotes.php index a3c144fa11a..7f669ebf752 100644 --- a/app/TransactionRules/Actions/SetNotes.php +++ b/app/TransactionRules/Actions/SetNotes.php @@ -30,14 +30,25 @@ /** * Class SetNotes. + * + * Acao para definir as notas de uma transacao. */ class SetNotes implements ActionInterface { /** - * TriggerInterface constructor. + * Construtor da acao. + * + * @param RuleAction $action Acao da regra */ public function __construct(private readonly RuleAction $action) {} + /** + * Executa a acao no diario de transacao. + * + * @param array $journal Dados do diario + * + * @return bool True se executado com sucesso + */ public function actOnArray(array $journal): bool { $dbNote = Note::where('noteable_id', $journal['transaction_journal_id']) diff --git a/app/TransactionRules/Actions/SetSourceAccount.php b/app/TransactionRules/Actions/SetSourceAccount.php index 3eddb9e7c79..7a2d97cc362 100644 --- a/app/TransactionRules/Actions/SetSourceAccount.php +++ b/app/TransactionRules/Actions/SetSourceAccount.php @@ -36,16 +36,28 @@ /** * Class SetSourceAccount. + * + * Acao para definir a conta de origem de uma transacao. */ class SetSourceAccount implements ActionInterface { + /** @var AccountRepositoryInterface Repositorio de contas */ private AccountRepositoryInterface $repository; /** - * TriggerInterface constructor. + * Construtor da acao. + * + * @param RuleAction $action Acao da regra */ public function __construct(private readonly RuleAction $action) {} + /** + * Executa a acao no diario de transacao. + * + * @param array $journal Dados do diario + * + * @return bool True se executado com sucesso + */ public function actOnArray(array $journal): bool { $accountName = $this->action->getValue($journal); diff --git a/app/TransactionRules/Actions/SetSourceToCashAccount.php b/app/TransactionRules/Actions/SetSourceToCashAccount.php index bb83c369081..a8944b29845 100644 --- a/app/TransactionRules/Actions/SetSourceToCashAccount.php +++ b/app/TransactionRules/Actions/SetSourceToCashAccount.php @@ -36,14 +36,25 @@ /** * Class SetSourceToCashAccount + * + * Acao para definir origem como conta de dinheiro. */ class SetSourceToCashAccount implements ActionInterface { /** - * TriggerInterface constructor. + * Construtor da acao. + * + * @param RuleAction $action Acao da regra */ public function __construct(private readonly RuleAction $action) {} + /** + * Executa a acao no diario de transacao. + * + * @param array $journal Dados do diario + * + * @return bool True se executado com sucesso + */ public function actOnArray(array $journal): bool { /** @var User $user */ diff --git a/app/TransactionRules/Actions/SwitchAccounts.php b/app/TransactionRules/Actions/SwitchAccounts.php index e49ea4a19db..783eed4bd89 100644 --- a/app/TransactionRules/Actions/SwitchAccounts.php +++ b/app/TransactionRules/Actions/SwitchAccounts.php @@ -33,14 +33,25 @@ /** * Class SwitchAccounts + * + * Acao para trocar contas de origem e destino em transferencias. */ class SwitchAccounts implements ActionInterface { /** - * TriggerInterface constructor. + * Construtor da acao. + * + * @param RuleAction $action Acao da regra */ public function __construct(private readonly RuleAction $action) {} + /** + * Executa a acao no diario de transacao. + * + * @param array $journal Dados do diario + * + * @return bool True se executado com sucesso + */ public function actOnArray(array $journal): bool { // make object from array (so the data is fresh). diff --git a/app/TransactionRules/Actions/UpdatePiggyBank.php b/app/TransactionRules/Actions/UpdatePiggyBank.php index 64fe735e6a4..053696c2805 100644 --- a/app/TransactionRules/Actions/UpdatePiggyBank.php +++ b/app/TransactionRules/Actions/UpdatePiggyBank.php @@ -35,13 +35,27 @@ use FireflyIII\User; use Illuminate\Support\Facades\Log; +/** + * Class UpdatePiggyBank + * + * Acao para atualizar cofrinho com base em transacao. + */ class UpdatePiggyBank implements ActionInterface { /** - * TriggerInterface constructor. + * Construtor da acao. + * + * @param RuleAction $action Acao da regra */ public function __construct(private readonly RuleAction $action) {} + /** + * Executa a acao no diario de transacao. + * + * @param array $journal Dados do diario + * + * @return bool True se executado com sucesso + */ public function actOnArray(array $journal): bool { $actionValue = $this->action->getValue($journal); diff --git a/app/TransactionRules/Engine/RuleEngineInterface.php b/app/TransactionRules/Engine/RuleEngineInterface.php index 53ee3e1915c..07857294d47 100644 --- a/app/TransactionRules/Engine/RuleEngineInterface.php +++ b/app/TransactionRules/Engine/RuleEngineInterface.php @@ -29,6 +29,9 @@ /** * Interface RuleEngineInterface + * + * Interface para motores de regras de transacao. + * Define metodos para buscar e executar regras. */ interface RuleEngineInterface { diff --git a/app/TransactionRules/Engine/SearchRuleEngine.php b/app/TransactionRules/Engine/SearchRuleEngine.php index f8f8700a7e2..efe1d06b782 100644 --- a/app/TransactionRules/Engine/SearchRuleEngine.php +++ b/app/TransactionRules/Engine/SearchRuleEngine.php @@ -41,6 +41,9 @@ /** * Class SearchRuleEngine + * + * Motor de regras baseado em busca. + * Executa regras usando o motor de busca para encontrar transacoes. */ class SearchRuleEngine implements RuleEngineInterface { diff --git a/app/TransactionRules/Expressions/ActionExpression.php b/app/TransactionRules/Expressions/ActionExpression.php index 6e578c84448..69bf44d79ae 100644 --- a/app/TransactionRules/Expressions/ActionExpression.php +++ b/app/TransactionRules/Expressions/ActionExpression.php @@ -27,8 +27,14 @@ use Symfony\Component\ExpressionLanguage\ExpressionLanguage; use Symfony\Component\ExpressionLanguage\SyntaxError; +/** + * Class ActionExpression + * + * Avaliador de expressoes para acoes de regras. + */ class ActionExpression { + /** @var array Nomes de variaveis disponiveis nas expressoes */ private static array $NAMES = [ // 'transaction_group_id', diff --git a/app/TransactionRules/Expressions/ActionExpressionLanguageProvider.php b/app/TransactionRules/Expressions/ActionExpressionLanguageProvider.php index f1e2758d9f1..6bfb392c48b 100644 --- a/app/TransactionRules/Expressions/ActionExpressionLanguageProvider.php +++ b/app/TransactionRules/Expressions/ActionExpressionLanguageProvider.php @@ -28,10 +28,19 @@ use Symfony\Component\ExpressionLanguage\ExpressionFunctionProviderInterface; /** + * Class ActionExpressionLanguageProvider + * + * Provedor de funcoes para linguagem de expressao de acoes. + * * @SuppressWarnings("PHPMD.UnusedFormalParameter") */ class ActionExpressionLanguageProvider implements ExpressionFunctionProviderInterface { + /** + * Retorna as funcoes disponiveis para expressoes. + * + * @return array Lista de funcoes de expressao + */ public function getFunctions(): array { $function = function ($arguments, $str): string { diff --git a/app/TransactionRules/Factory/ActionFactory.php b/app/TransactionRules/Factory/ActionFactory.php index 23780bce6d8..3674503cd7c 100644 --- a/app/TransactionRules/Factory/ActionFactory.php +++ b/app/TransactionRules/Factory/ActionFactory.php @@ -30,10 +30,12 @@ /** * Class ActionFactory can create actions. + * + * Fabrica para criar instancias de acoes de regras. */ class ActionFactory { - /** @var array array of action types */ + /** @var array Mapa de tipos de acao para classes */ protected static array $actionTypes = []; /** diff --git a/app/TransactionRules/Traits/RefreshNotesTrait.php b/app/TransactionRules/Traits/RefreshNotesTrait.php index a9ab866a8cf..e27fb8dbdc6 100644 --- a/app/TransactionRules/Traits/RefreshNotesTrait.php +++ b/app/TransactionRules/Traits/RefreshNotesTrait.php @@ -28,8 +28,20 @@ use FireflyIII\Models\TransactionJournal; use Illuminate\Support\Facades\Log; +/** + * Trait RefreshNotesTrait + * + * Trait para atualizar notas de transacoes. + */ trait RefreshNotesTrait { + /** + * Atualiza as notas da transacao a partir do banco. + * + * @param array $transaction Dados da transacao + * + * @return array Transacao com notas atualizadas + */ final protected function refreshNotes(array $transaction): array { $transaction['notes'] = ''; diff --git a/app/Transformers/AbstractTransformer.php b/app/Transformers/AbstractTransformer.php index 054173dd0f5..f63286ba8a0 100644 --- a/app/Transformers/AbstractTransformer.php +++ b/app/Transformers/AbstractTransformer.php @@ -29,11 +29,19 @@ /** * Class AbstractTransformer + * + * Classe base abstrata para transformadores de API. */ abstract class AbstractTransformer extends TransformerAbstract { + /** @var ParameterBag Parametros da requisicao */ protected ParameterBag $parameters; + /** + * Obtem os parametros da requisicao. + * + * @return ParameterBag Parametros + */ final public function getParameters(): ParameterBag { return $this->parameters; diff --git a/app/Transformers/AccountTransformer.php b/app/Transformers/AccountTransformer.php index 1f8ff4dadc5..8d2afaf5116 100644 --- a/app/Transformers/AccountTransformer.php +++ b/app/Transformers/AccountTransformer.php @@ -34,11 +34,18 @@ /** * Class AccountTransformer + * + * Transformador de contas para API. */ class AccountTransformer extends AbstractTransformer { + /** @var bool Se deve converter para moeda primaria */ protected bool $convertToPrimary; + + /** @var TransactionCurrency Moeda primaria */ protected TransactionCurrency $primary; + + /** @var AccountRepositoryInterface Repositorio de contas */ protected AccountRepositoryInterface $repository; /** diff --git a/app/Transformers/AttachmentTransformer.php b/app/Transformers/AttachmentTransformer.php index 5611a00d96e..6c2c31c4be7 100644 --- a/app/Transformers/AttachmentTransformer.php +++ b/app/Transformers/AttachmentTransformer.php @@ -29,9 +29,12 @@ /** * Class AttachmentTransformer + * + * Transformador de anexos para API. */ class AttachmentTransformer extends AbstractTransformer { + /** @var AttachmentRepositoryInterface Repositorio de anexos */ private readonly AttachmentRepositoryInterface $repository; /** diff --git a/app/Transformers/AvailableBudgetTransformer.php b/app/Transformers/AvailableBudgetTransformer.php index a019bb99859..9ee2b574d71 100644 --- a/app/Transformers/AvailableBudgetTransformer.php +++ b/app/Transformers/AvailableBudgetTransformer.php @@ -31,10 +31,15 @@ /** * Class AvailableBudgetTransformer + * + * Transformador de orcamentos disponiveis para API. */ class AvailableBudgetTransformer extends AbstractTransformer { + /** @var bool Se deve converter para moeda primaria */ private readonly bool $convertToPrimary; + + /** @var TransactionCurrency Moeda primaria */ private readonly TransactionCurrency $primary; /** diff --git a/app/Transformers/BillTransformer.php b/app/Transformers/BillTransformer.php index 96d47323073..8334cc4b2ac 100644 --- a/app/Transformers/BillTransformer.php +++ b/app/Transformers/BillTransformer.php @@ -30,9 +30,12 @@ /** * Class BillTransformer + * + * Transformador de faturas para API. */ class BillTransformer extends AbstractTransformer { + /** @var TransactionCurrency Moeda primaria */ private readonly TransactionCurrency $primary; /** diff --git a/app/Transformers/BudgetLimitTransformer.php b/app/Transformers/BudgetLimitTransformer.php index 12107e56369..4d09886437e 100644 --- a/app/Transformers/BudgetLimitTransformer.php +++ b/app/Transformers/BudgetLimitTransformer.php @@ -33,14 +33,21 @@ /** * Class BudgetLimitTransformer + * + * Transformador de limites de orcamento para API. */ class BudgetLimitTransformer extends AbstractTransformer { + /** @var array Includes disponiveis */ protected array $availableIncludes = [ 'budget', ]; + + /** @var bool Se deve converter para moeda primaria */ protected bool $convertToPrimary; + + /** @var TransactionCurrency Moeda primaria */ protected TransactionCurrency $primaryCurrency; public function __construct() diff --git a/app/Transformers/BudgetTransformer.php b/app/Transformers/BudgetTransformer.php index 41bfbd13948..494abadd15a 100644 --- a/app/Transformers/BudgetTransformer.php +++ b/app/Transformers/BudgetTransformer.php @@ -33,11 +33,18 @@ /** * Class BudgetTransformer + * + * Transformador de orcamentos para API. */ class BudgetTransformer extends AbstractTransformer { + /** @var bool Se deve converter para moeda primaria */ private readonly bool $convertToPrimary; + + /** @var TransactionCurrency Moeda primaria */ private readonly TransactionCurrency $primaryCurrency; + + /** @var array Tipos de auto-orcamento */ private array $types; /** diff --git a/app/Transformers/CategoryTransformer.php b/app/Transformers/CategoryTransformer.php index 36d25b29212..9c8279d24f9 100644 --- a/app/Transformers/CategoryTransformer.php +++ b/app/Transformers/CategoryTransformer.php @@ -31,9 +31,12 @@ /** * Class CategoryTransformer + * + * Transformador de categorias para API. */ class CategoryTransformer extends AbstractTransformer { + /** @var TransactionCurrency Moeda primaria */ private readonly TransactionCurrency $primaryCurrency; /** diff --git a/app/Transformers/CurrencyTransformer.php b/app/Transformers/CurrencyTransformer.php index 649bbe6fb9e..ca32568f95b 100644 --- a/app/Transformers/CurrencyTransformer.php +++ b/app/Transformers/CurrencyTransformer.php @@ -28,6 +28,8 @@ /** * Class CurrencyTransformer + * + * Transformador de moedas para API. */ class CurrencyTransformer extends AbstractTransformer { diff --git a/app/Transformers/ExchangeRateTransformer.php b/app/Transformers/ExchangeRateTransformer.php index 18566cc69a0..0f843c06aa7 100644 --- a/app/Transformers/ExchangeRateTransformer.php +++ b/app/Transformers/ExchangeRateTransformer.php @@ -27,10 +27,19 @@ use FireflyIII\Models\CurrencyExchangeRate; use Illuminate\Support\Collection; +/** + * Class ExchangeRateTransformer + * + * Transformador de taxas de cambio para API. + */ class ExchangeRateTransformer extends AbstractTransformer { /** - * This method collects meta-data for one or all accounts in the transformer's collection. + * Coleta metadados para objetos na colecao. + * + * @param Collection $objects Colecao de objetos + * + * @return Collection Colecao com metadados */ public function collectMetaData(Collection $objects): Collection { diff --git a/app/Transformers/LinkTypeTransformer.php b/app/Transformers/LinkTypeTransformer.php index f01db6355ca..8e161ecd816 100644 --- a/app/Transformers/LinkTypeTransformer.php +++ b/app/Transformers/LinkTypeTransformer.php @@ -28,6 +28,8 @@ /** * Class LinkTypeTransformer + * + * Transformador de tipos de link para API. */ class LinkTypeTransformer extends AbstractTransformer { diff --git a/app/Transformers/ObjectGroupTransformer.php b/app/Transformers/ObjectGroupTransformer.php index fa38e1d8195..cd208f5e9ae 100644 --- a/app/Transformers/ObjectGroupTransformer.php +++ b/app/Transformers/ObjectGroupTransformer.php @@ -28,10 +28,13 @@ use FireflyIII\Repositories\ObjectGroup\ObjectGroupRepositoryInterface; /** - * Class AccountTransformer + * Class ObjectGroupTransformer + * + * Transformador de grupos de objetos para API. */ class ObjectGroupTransformer extends AbstractTransformer { + /** @var ObjectGroupRepositoryInterface Repositorio de grupos de objetos */ protected ObjectGroupRepositoryInterface $repository; /** diff --git a/app/Transformers/PiggyBankEventTransformer.php b/app/Transformers/PiggyBankEventTransformer.php index a9724ddc575..d84a9c8e12b 100644 --- a/app/Transformers/PiggyBankEventTransformer.php +++ b/app/Transformers/PiggyBankEventTransformer.php @@ -32,10 +32,15 @@ /** * Class PiggyBankEventTransformer + * + * Transformador de eventos de cofrinhos para API. */ class PiggyBankEventTransformer extends AbstractTransformer { + /** @var TransactionCurrency Moeda primaria */ private TransactionCurrency $primaryCurrency; + + /** @var bool Se deve converter para moeda primaria */ private bool $convertToPrimary = false; /** diff --git a/app/Transformers/PiggyBankTransformer.php b/app/Transformers/PiggyBankTransformer.php index 0b3b9205ff5..2f3ed13976f 100644 --- a/app/Transformers/PiggyBankTransformer.php +++ b/app/Transformers/PiggyBankTransformer.php @@ -31,9 +31,12 @@ /** * Class PiggyBankTransformer + * + * Transformador de cofrinhos para API. */ class PiggyBankTransformer extends AbstractTransformer { + /** @var TransactionCurrency Moeda primaria */ private TransactionCurrency $primaryCurrency; /** diff --git a/app/Transformers/PreferenceTransformer.php b/app/Transformers/PreferenceTransformer.php index 78dead23804..109e8688d5e 100644 --- a/app/Transformers/PreferenceTransformer.php +++ b/app/Transformers/PreferenceTransformer.php @@ -28,6 +28,8 @@ /** * Class PreferenceTransformer + * + * Transformador de preferencias para API. */ class PreferenceTransformer extends AbstractTransformer { diff --git a/app/Transformers/RecurrenceTransformer.php b/app/Transformers/RecurrenceTransformer.php index 9f3ce0c5f0b..d5e73444b65 100644 --- a/app/Transformers/RecurrenceTransformer.php +++ b/app/Transformers/RecurrenceTransformer.php @@ -29,7 +29,9 @@ use Illuminate\Support\Facades\Log; /** - * Class RecurringTransactionTransformer + * Class RecurrenceTransformer + * + * Transformador de transacoes recorrentes para API. */ class RecurrenceTransformer extends AbstractTransformer { diff --git a/app/Transformers/RuleGroupTransformer.php b/app/Transformers/RuleGroupTransformer.php index 696eda4fbbd..0baa626d191 100644 --- a/app/Transformers/RuleGroupTransformer.php +++ b/app/Transformers/RuleGroupTransformer.php @@ -28,6 +28,8 @@ /** * Class RuleGroupTransformer + * + * Transformador de grupos de regras para API. */ class RuleGroupTransformer extends AbstractTransformer { diff --git a/app/Transformers/RuleTransformer.php b/app/Transformers/RuleTransformer.php index 8e58a519cb6..726f60c66e2 100644 --- a/app/Transformers/RuleTransformer.php +++ b/app/Transformers/RuleTransformer.php @@ -32,9 +32,12 @@ /** * Class RuleTransformer + * + * Transformador de regras para API. */ class RuleTransformer extends AbstractTransformer { + /** @var RuleRepositoryInterface Repositorio de regras */ private readonly RuleRepositoryInterface $ruleRepository; /** diff --git a/app/Transformers/TagTransformer.php b/app/Transformers/TagTransformer.php index d9222069e9d..442fffcb4b4 100644 --- a/app/Transformers/TagTransformer.php +++ b/app/Transformers/TagTransformer.php @@ -29,6 +29,8 @@ /** * Class TagTransformer + * + * Transformador de tags para API. */ class TagTransformer extends AbstractTransformer { diff --git a/app/Transformers/TransactionGroupTransformer.php b/app/Transformers/TransactionGroupTransformer.php index 93ac1558ab9..85bda0ebe00 100644 --- a/app/Transformers/TransactionGroupTransformer.php +++ b/app/Transformers/TransactionGroupTransformer.php @@ -42,11 +42,18 @@ /** * Class TransactionGroupTransformer + * + * Transformador de grupos de transacoes para API. */ class TransactionGroupTransformer extends AbstractTransformer { + /** @var TransactionGroupRepositoryInterface Repositorio de grupos de transacoes */ private readonly TransactionGroupRepositoryInterface $groupRepos; + + /** @var array Campos de metadados de data */ private readonly array $metaDateFields; + + /** @var array Campos de metadados */ private readonly array $metaFields; /** diff --git a/app/Transformers/TransactionLinkTransformer.php b/app/Transformers/TransactionLinkTransformer.php index 25b83f85972..d0d5374796e 100644 --- a/app/Transformers/TransactionLinkTransformer.php +++ b/app/Transformers/TransactionLinkTransformer.php @@ -29,10 +29,12 @@ /** * Class TransactionLinkTransformer + * + * Transformador de links de transacoes para API. */ class TransactionLinkTransformer extends AbstractTransformer { - /** @var JournalRepositoryInterface */ + /** @var JournalRepositoryInterface Repositorio de diarios */ private $repository; /** diff --git a/app/Transformers/UserGroupTransformer.php b/app/Transformers/UserGroupTransformer.php index 486db212530..fdca5c9e821 100644 --- a/app/Transformers/UserGroupTransformer.php +++ b/app/Transformers/UserGroupTransformer.php @@ -33,11 +33,18 @@ /** * Class UserGroupTransformer + * + * Transformador de grupos de usuarios para API. */ class UserGroupTransformer extends AbstractTransformer { + /** @var array Grupos em uso */ private array $inUse; + + /** @var array Membros dos grupos */ private array $memberships; + + /** @var array Visibilidade de membros */ private array $membershipsVisible; public function __construct() diff --git a/app/Transformers/UserTransformer.php b/app/Transformers/UserTransformer.php index 18dc74d4b65..79625394fe6 100644 --- a/app/Transformers/UserTransformer.php +++ b/app/Transformers/UserTransformer.php @@ -30,9 +30,12 @@ /** * Class UserTransformer + * + * Transformador de usuarios para API. */ class UserTransformer extends AbstractTransformer { + /** @var UserRepositoryInterface Repositorio de usuarios */ private UserRepositoryInterface $repository; /** diff --git a/app/Transformers/WebhookAttemptTransformer.php b/app/Transformers/WebhookAttemptTransformer.php index 2ab04f184ad..76a9e63da3f 100644 --- a/app/Transformers/WebhookAttemptTransformer.php +++ b/app/Transformers/WebhookAttemptTransformer.php @@ -28,6 +28,8 @@ /** * Class WebhookAttemptTransformer + * + * Transformador de tentativas de webhook para API. */ class WebhookAttemptTransformer extends AbstractTransformer { diff --git a/app/Transformers/WebhookMessageTransformer.php b/app/Transformers/WebhookMessageTransformer.php index 24bc25d4c2b..01f7602e7de 100644 --- a/app/Transformers/WebhookMessageTransformer.php +++ b/app/Transformers/WebhookMessageTransformer.php @@ -32,6 +32,8 @@ /** * Class WebhookMessageTransformer + * + * Transformador de mensagens de webhook para API. */ class WebhookMessageTransformer extends AbstractTransformer { diff --git a/app/Transformers/WebhookTransformer.php b/app/Transformers/WebhookTransformer.php index d913b38f3d5..83c1669eb84 100644 --- a/app/Transformers/WebhookTransformer.php +++ b/app/Transformers/WebhookTransformer.php @@ -31,6 +31,8 @@ /** * Class WebhookTransformer + * + * Transformador de webhooks para API. */ class WebhookTransformer extends AbstractTransformer { diff --git a/readme.md b/readme.md index 25a7d39e243..7365c650d91 100644 --- a/readme.md +++ b/readme.md @@ -35,6 +35,9 @@ - [Who's it for?](#whos-it-for) - [The Firefly III eco-system](#the-firefly-iii-eco-system) - [Getting Started](#getting-started) +- [Project Structure](#project-structure) +- [Requirements](#requirements) +- [Installation](#installation) - [Contributing](#contributing) - [Support the development of Firefly III](#support-the-development-of-firefly-iii) - [License](#license) @@ -123,6 +126,102 @@ There are many ways to run Firefly III 8. You can [install it on Lando](https://gist.github.com/ArtisKrumins/ccb24f31d6d4872b57e7c9343a9d1bf0). 9. You can [install it on Yunohost](https://github.com/YunoHost-Apps/firefly-iii). +## Project Structure + +The application follows the Laravel framework structure: + +``` +app/ +├── Api/ # API controllers and requests (V1 and V2) +├── Casts/ # Custom Eloquent attribute casters +├── Console/ # Artisan commands +├── Entities/ # Domain entities +├── Enums/ # Enumeration classes +├── Events/ # Application events +├── Exceptions/ # Custom exception handlers +├── Factory/ # Model factories +├── Generator/ # Report and chart generators +├── Handlers/ # Event handlers +├── Helpers/ # Helper classes +├── Http/ # HTTP controllers, middleware, and requests +├── Jobs/ # Queue jobs +├── Mail/ # Mailable classes +├── Models/ # Eloquent models +├── Notifications/ # Notification classes +├── Providers/ # Service providers +├── Repositories/ # Repository pattern implementations +├── Rules/ # Validation rules +├── Services/ # Business logic services +├── Support/ # Support classes and utilities +├── TransactionRules/ # Transaction rule actions and triggers +└── Transformers/ # API response transformers +``` + +## Requirements + +- PHP 8.3 or higher +- MySQL 8.0+ / MariaDB 10.11+ / PostgreSQL 16+ +- Composer +- Node.js and npm (for frontend assets) +- BCMath PHP Extension +- Ctype PHP Extension +- Fileinfo PHP Extension +- JSON PHP Extension +- Mbstring PHP Extension +- OpenSSL PHP Extension +- PDO PHP Extension +- Tokenizer PHP Extension +- XML PHP Extension +- Intl PHP Extension + +## Installation + +### Using Docker (Recommended) + +```bash +docker-compose up -d +``` + +### Manual Installation + +1. Clone the repository: +```bash +git clone https://github.com/firefly-iii/firefly-iii.git +cd firefly-iii +``` + +2. Install PHP dependencies: +```bash +composer install --no-dev --no-scripts --no-plugins +``` + +3. Copy the environment file: +```bash +cp .env.example .env +``` + +4. Generate application key: +```bash +php artisan key:generate +``` + +5. Configure your database in `.env` file + +6. Run migrations: +```bash +php artisan migrate --seed +``` + +7. Build frontend assets: +```bash +npm install +npm run build +``` + +8. Configure your web server to point to the `public/` directory + +For detailed installation instructions, visit the [official documentation](https://docs.firefly-iii.org/how-to/firefly-iii/installation/self-managed/). + ## Contributing You can contact me at [james@firefly-iii.org](mailto:james@firefly-iii.org), you may open an issue in the [main repository](https://github.com/firefly-iii/firefly-iii) or contact me through [gitter](https://gitter.im/firefly-iii/firefly-iii) and [Mastodon](https://fosstodon.org/@ff3). @@ -189,4 +288,4 @@ The Firefly III logo is made by the excellent Cherie Woo. [sc-vuln-shield]: https://sonarcloud.io/api/project_badges/measure?project=firefly-iii_firefly-iii&metric=vulnerabilities [sc-project-url]: https://sonarcloud.io/dashboard?id=firefly-iii_firefly-iii [bp-badge]: https://bestpractices.coreinfrastructure.org/projects/6335/badge -[bp-url]: https://bestpractices.coreinfrastructure.org/projects/6335 +[bp-url]: https://bestpractices.coreinfrastructure.org/projects/6335