Budget Planner

Example Code

<?php

class BudgetPlanner {
    private array $income;
    private array $expenses;
    private array $budgetLimits;

    public function __construct() {
        $this->income = [];
        $this->expenses = [];
        $this->budgetLimits = [];
    }

    /
     * Adds an income entry.
     * @param float $amount The amount of income.
     * @param string $source The source of the income (e.g., "Salary", "Freelance").
     */
    public function addIncome(float $amount, string $source): void {
        $this->income[] = [
            'amount' => $amount,
            'source' => $source,
            'date' => date('Y-m-d H:i:s')
        ];
        echo "Income of $" . number_format($amount, 2) . " from " . $source . " added.\n";
    }

    /
     * Adds an expense entry.
     * @param float $amount The amount of the expense.
     * @param string $category The category of the expense (e.g., "Food", "Transport").
     * @param string $description A brief description of the expense.
     */
    public function addExpense(float $amount, string $category, string $description = ''): void {
        $this->expenses[] = [
            'amount' => $amount,
            'category' => $category,
            'description' => $description,
            'date' => date('Y-m-d H:i:s')
        ];
        echo "Expense of $" . number_format($amount, 2) . " for " . $category . " (" . $description . ") added.\n";
    }

    /
     * Sets a budget limit for a specific category.
     * @param string $category The category to set a limit for.
     * @param float $limit The maximum allowed spending for this category.
     */
    public function setBudgetLimit(string $category, float $limit): void {
        $this->budgetLimits[$category] = $limit;
        echo "Budget limit for " . $category . " set to $" . number_format($limit, 2) . ".\n";
    }

    /
     * Calculates the total income.
     * @return float The sum of all income entries.
     */
    private function getTotalIncome(): float {
        return array_sum(array_column($this->income, 'amount'));
    }

    /
     * Calculates the total expenses.
     * @return float The sum of all expense entries.
     */
    private function getTotalExpenses(): float {
        return array_sum(array_column($this->expenses, 'amount'));
    }

    /
     * Provides a summary of the financial situation.
     * @return array An associative array containing total income, total expenses, and balance.
     */
    public function getFinancialSummary(): array {
        $totalIncome = $this->getTotalIncome();
        $totalExpenses = $this->getTotalExpenses();
        $balance = $totalIncome - $totalExpenses;

        return [
            'total_income' => $totalIncome,
            'total_expenses' => $totalExpenses,
            'balance' => $balance
        ];
    }

    /
     * Shows spending per category.
     * @return array An associative array where keys are categories and values are total spending for that category.
     */
    public function getCategorySpending(): array {
        $categorySpending = [];
        foreach ($this->expenses as $expense) {
            $category = $expense['category'];
            $amount = $expense['amount'];
            if (!isset($categorySpending[$category])) {
                $categorySpending[$category] = 0;
            }
            $categorySpending[$category] += $amount;
        }
        return $categorySpending;
    }

    /
     * Checks budget compliance for each category with a set limit.
     * @return array An associative array showing compliance status for each budgeted category.
     */
    public function checkBudgetCompliance(): array {
        $categorySpending = $this->getCategorySpending();
        $compliance = [];

        foreach ($this->budgetLimits as $category => $limit) {
            $spent = $categorySpending[$category] ?? 0;
            $remaining = $limit - $spent;
            $status = ($spent <= $limit) ? 'Under Budget' : 'Over Budget';
            $compliance[$category] = [
                'budget_limit' => $limit,
                'spent' => $spent,
                'remaining' => $remaining,
                'status' => $status
            ];
        }
        return $compliance;
    }
}

// --- Example Usage ---
$myBudget = new BudgetPlanner();

echo "--- Adding Income ---\n";
$myBudget->addIncome(2500.00, "Monthly Salary");
$myBudget->addIncome(150.00, "Freelance Gig");
echo "\n";

echo "--- Adding Expenses ---\n";
$myBudget->addExpense(450.00, "Rent", "Monthly apartment rent");
$myBudget->addExpense(120.50, "Groceries", "Weekly grocery shopping");
$myBudget->addExpense(35.00, "Transport", "Bus pass");
$myBudget->addExpense(60.00, "Entertainment", "Movie night");
$myBudget->addExpense(80.00, "Groceries", "Mid-week top-up");
$myBudget->addExpense(45.00, "Entertainment", "Dinner out");
echo "\n";

echo "--- Setting Budget Limits ---\n";
$myBudget->setBudgetLimit("Rent", 500.00);
$myBudget->setBudgetLimit("Groceries", 200.00);
$myBudget->setBudgetLimit("Transport", 50.00);
$myBudget->setBudgetLimit("Entertainment", 100.00);
echo "\n";

echo "--- Financial Summary ---\n";
$summary = $myBudget->getFinancialSummary();
echo "Total Income: $" . number_format($summary['total_income'], 2) . "\n";
echo "Total Expenses: $" . number_format($summary['total_expenses'], 2) . "\n";
echo "Balance: $" . number_format($summary['balance'], 2) . "\n";
echo "\n";

echo "--- Spending by Category ---\n";
$categorySpending = $myBudget->getCategorySpending();
foreach ($categorySpending as $category => $amount) {
    echo $category . ": $" . number_format($amount, 2) . "\n";
}
echo "\n";

echo "--- Budget Compliance Check ---\n";
$compliance = $myBudget->checkBudgetCompliance();
foreach ($compliance as $category => $data) {
    echo "Category: " . $category . "\n";
    echo "  Budget Limit: $" . number_format($data['budget_limit'], 2) . "\n";
    echo "  Spent: $" . number_format($data['spent'], 2) . "\n";
    echo "  Remaining: $" . number_format($data['remaining'], 2) . "\n";
    echo "  Status: " . $data['status'] . "\n";
    echo "\n";
}

?>