dbrax / income-expense

src/IncomeExpense.php

<?php


/**
 * Author: Emmanuel Paul Mnzava
 * Twitter: @epmnzava
 * Github:https://github.com/dbrax/income-expense
 * Email: epmnzava@gmail.com
 *
 */

namespace Epmnzava\IncomeExpense;

use Epmnzava\IncomeExpense\Models\Expense;
use Epmnzava\IncomeExpense\Models\ExpenseCategory;
use Epmnzava\IncomeExpense\Models\Income;
use Epmnzava\IncomeExpense\Models\IncomeCategory;
use Epmnzava\IncomeExpense\Models\Ledger;
use Illuminate\Support\Str;

class IncomeExpense extends AccountingData
{


    /**
     * @param int $categoryid
     * @param string $income_title
     * @param int $amount
     * @param string $notes
     * @param string $transaction_id
     * @return Income
     *
     * function to add an income and ledger at the same time
     */
    public function add_income(int $categoryid, string $income_title, int $amount, string $notes = "", $transaction_id = "0"): Income
    {

        $income = $this->newIncome($categoryid, $income_title, $amount, $notes, $transaction_id);

        if ($transaction_id == 0)
            $transaction_id = $this->set_transaction_id($income);


        $ledger = $this->add_transaction_on_ledger($income, "INC", $transaction_id);

        return $income;
    }

    /**
     * @param int $categoryid
     * @param string $income_title
     * @param int $amount

There is no parameter named $income_title. Was it maybe removed?

     * @param string $notes
     * @param string $transaction_id
     * @return Expense
     *
     * function to add expense and to a ledger at the sametime
     */

    public function add_expense(int $categoryid, string $expense_title, int $amount, string $notes = "", $transaction_id = "0"): Expense
    {

        $expense = $this->newExpense($categoryid, $expense_title, $amount, $notes, $transaction_id);

        if ($transaction_id == 0)
            $transaction_id = $this->set_transaction_id($expense);


        $ledger = $this->add_transaction_on_ledger($expense, "EXP", $transaction_id);

        return $expense;
    }


    /**
     * @param $income
     * @return string
     * @throws \Exception
     *
     * function that sets a transaction id
     */

    public function set_transaction_id($income)
    {
        $prefix = config('income-expense.transaction_id_prefix');
        $length = config('income-expense.transaction_id_length');

        $keyspace = '0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ';

        $str = '';

        $max = mb_strlen($keyspace, '8bit') - 1;

        for ($i = 0; $i < $length; ++$i) {
            $str .= $keyspace[random_int(0, $max)];
        }

        return $prefix . $str;
    }

    /**
     * @param int $categoryid
     * @param string $income_title
     * @param int $amount
     * @param string $notes
     * @return Income
     *
     * Unit function that adds income
     */
    private function newIncome(int $categoryid, string $income_title, int $amount, string $notes = ""): Income
    {
        return Income::create([
            "incomecategory" => $categoryid,
            "income_title" => $income_title,
            "amount" => $amount,
            "notes" => $notes,
            "date" => date('Y-m-d')
        ]);
    }

    /**
     * @param $transactionObj
     * @param $type
     * @param $transaction_id
     * @return Ledger
     *
     * unit function that adds a ledger transaction
     */
    public function add_transaction_on_ledger($transactionObj, $type, $transaction_id): Ledger
    {

        $ledger = new Ledger;
        $ledger->transaction_id = $transaction_id;
        $ledger->transaction_type = $type;
        if($type=="INC")
        $ledger->transaction_type_category = $transactionObj->incomecategory;
        else
        $ledger->transaction_type_category = $transactionObj->expense_category;

        $ledger->amount = $transactionObj->amount;
        $ledger->save();
        return $ledger;
    }

    /**
     * @param int $categoryid
     * @param string $expense_title
     * @param int $amount
     * @param string $notes
     * @return Expense
     *
     * A unit function that adds new expense
     */

    private function newExpense(int $categoryid, string $expense_title, int  $amount, string $notes = ""): Expense
    {
        return Expense::create([
            "expense_category" => $categoryid,
            "expense_title" => $expense_title,
            "amount" => $amount,
            "notes" => $notes,
            "date" => date('Y-m-d')
        ]);
    }


    /**
     * @param $categoryname
     * @param $description
     * @return ExpenseCategory
     *
     * A unit function that adds expense category
     */
    public function addExpenseCategory($categoryname, $description): ExpenseCategory
    {
        return  ExpenseCategory::create([
            "category" => $categoryname,
            "description" => $description,
            "slug"=>Str::slug($categoryname, '-'),
            "date" => date('Y-m-d')
        ]);
    }

    /**
     * @param $categoryname
     * @param $description
     * @return IncomeCategory
     *
     * A unit function that adds income category
     */


    public function addIncomeCategory($categoryname, $description): IncomeCategory
    {

        return  IncomeCategory::create([
            "category" => $categoryname,
            "description" => $description,
            "slug"=>Str::slug($categoryname, '-'),
            "date" => date('Y-m-d')
        ]);
    }

    /**
     * @param $expensecategoryid
     * @return Expense
     *
     * Function that return a specific expense category instance by passing in an expense category id
     */
    public function getExpenseCategoryById($expensecategoryid) : ExpenseCategory
    {
        return ExpenseCategory::find($expensecategoryid);
    }


    /**
     * @param $incomecategoryid
     * @return Income
     *
     * Function that returns a particular IncomeCatgory by passing in an incomecategoryid
     */
    public function getIncomeCategoryById($incomecategoryid) : IncomeCategory
    {
        return IncomeCategory::find($incomecategoryid);
    }

    public function deleteExpenseCategory($expensecategoryid)
    {
    }


    public function deleteIncomeCategory($incomecategoryid)
    {
    }


    public function updateExpenseCategory($expensecategoryid)
    {
    }


    public function updateIncomeCategory($incomecategoryid)
    {
    }
}