opensourcepos/app/Models/Tax_code.php

<?php

namespace App\Models;

use CodeIgniter\Database\ResultInterface;
use CodeIgniter\Model;
use Config\OSPOS;
use stdClass;

/**
 * Tax Code class
 */
class Tax_code extends Model
{
    protected $table = 'tax_codes';
    protected $primaryKey = 'tax_code_id';
    protected $useAutoIncrement = true;
    protected $useSoftDeletes = false;
    protected $allowedFields = [
        'tax_code',
        'tax_code_name',
        'city',
        'state',
        'deleted'
    ];

    /**
     *  Determines if it exists in the table
     */
    public function exists(string $tax_code): bool
    {
        $builder = $this->db->table('tax_codes');
        $builder->where('tax_code', $tax_code);

        return ($builder->get()->getNumRows() == 1);    // TODO: this should be === since getNumRows returns an int
    }

    /**
     *  Gets total of rows
     */
    public function get_total_rows(): int
    {
        $builder = $this->db->table('tax_codes');
        $builder->where('deleted', 0);

        return $builder->countAllResults();
    }

    /**
     * Gets information about the particular record
     */
    public function get_info(?int $tax_code_id): object
    {
        if ($tax_code_id != null) {
            $builder = $this->db->table('tax_codes');

            $builder->where('tax_code_id', $tax_code_id);
            $builder->where('deleted', 0);
            $query = $builder->get();
        }

        if ($tax_code_id != null && $query->getNumRows() === 1) {
            return $query->getRow();
        } else {
            // Get empty base parent object
            $tax_code_obj = new stdClass();

            // Get all the fields from the table
            foreach ($this->db->getFieldNames('tax_codes') as $field) {
                $tax_code_obj->$field = null;
            }
            return $tax_code_obj;
        }
    }

    /**
     *  Returns all rows from the table
     */
    public function get_all(int $rows = 0, int $limit_from = 0, bool $no_deleted = true): ResultInterface    // TODO: $no_deleted should be something like $is_deleted and flip the logic.
    {
        $builder = $this->db->table('tax_codes');
        if ($no_deleted) {
            $builder->where('deleted', 0);
        }

        $builder->orderBy('tax_code_name', 'asc');

        if ($rows > 0) {
            $builder->limit($rows, $limit_from);
        }

        return $builder->get();
    }

    /**
     *  Returns multiple rows
     */
    public function get_multiple_info(array $tax_codes): ResultInterface
    {
        $builder = $this->db->table('tax_codes');
        $builder->whereIn('tax_code', $tax_codes);
        $builder->orderBy('tax_code_name', 'asc');

        return $builder->get();
    }

    /**
     *  Inserts or updates a row
     */
    public function save($tax_code_data): bool
    {
        $builder = $this->db->table('tax_codes');

        if (!$this->exists($tax_code_data['tax_code'])) {
            if ($builder->insert($tax_code_data)) {    // TODO: this should be refactored to return $builder->insert($tax_code_data); in the same way that $builder->update() below is the return.  Look for this in the other save functions as well.
                return true;
            }
            return false;
        }

        $builder->where('tax_code', $tax_code_data['tax_code']);

        return $builder->update($tax_code_data);
    }

    /**
     * Saves changes to the tax codes table
     */
    public function save_tax_codes(array $array_save): bool    // TODO: Need to rename $array_save to probably $tax_codes
    {
        $this->db->transStart();

        $not_to_delete = [];

        foreach ($array_save as $key => $value) {
            // Save or update
            $tax_code_data = [
                'tax_code'      => $value['tax_code'],
                'tax_code_name' => $value['tax_code_name'],
                'city'          => $value['city'],
                'state'         => $value['state'],
                'deleted'       => '0'
            ];
            $this->save($tax_code_data);
            $not_to_delete[] = $tax_code_data['tax_code'];
        }

        // All entries not available in post will be deleted now
        $deleted_tax_codes = $this->get_all()->getResultArray();

        foreach ($deleted_tax_codes as $key => $tax_code_data) {
            if (!in_array($tax_code_data['tax_code'], $not_to_delete)) {
                $this->delete($tax_code_data['tax_code']);
            }
        }

        $this->db->transComplete();
        return $this->db->transStatus();
    }

    /**
     * Deletes a specific tax code
     */
    public function delete($tax_code = null, bool $purge = false): bool
    {
        $builder = $this->db->table('tax_codes');
        $builder->where('tax_code', $tax_code);

        return $builder->update(['deleted' => 1]);
    }

    /**
     * Deletes a list of rows
     */
    public function delete_list(array $tax_codes): bool
    {
        $builder = $this->db->table('tax_codes');
        $builder->whereIn('tax_code', $tax_codes);

        return $builder->update(['deleted' => 1]);
    }

    /**
     * Gets rows
     */
    public function get_found_rows(string $search): int
    {
        return $this->search($search, 0, 0, 'tax_code_name', 'asc', true);
    }

    /**
     *  Perform a search for a set of rows
     */
    public function search(string $search, ?int $rows = 0, ?int $limit_from = 0, ?string $sort = 'tax_code_name', ?string $order = 'asc', ?bool $count_only = false)
    {
        // Set default values
        if ($rows == null) $rows = 0;
        if ($limit_from == null) $limit_from = 0;
        if ($sort == null) $sort = 'tax_code_name';
        if ($order == null) $order = 'asc';
        if ($count_only == null) $count_only = false;

        $builder = $this->db->table('tax_codes AS tax_codes');

        // get_found_rows case
        if ($count_only) {
            $builder->select('COUNT(tax_codes.tax_code) as count');
        }

        $builder->groupStart();
        $builder->like('tax_code_name', $search);
        $builder->orLike('tax_code', $search);
        $builder->groupEnd();
        $builder->where('deleted', 0);

        // get_found_rows case
        if ($count_only) {
            return $builder->get()->getRow()->count;
        }

        $builder->orderBy($sort, $order);

        if ($rows > 0) {
            $builder->limit($rows, $limit_from);
        }

        return $builder->get();
    }

    /**
     * Gets the tax code to use for a given customer
     */
    public function get_sales_tax_code(string $city = '', string $state = '')
    {
        $config = config(OSPOS::class)->settings;

        // If tax code using both city and state cannot be found then try again using just the state
        // If the state tax code cannot be found then try again using blanks for both
        $builder = $this->db->table('tax_codes');
        $builder->where('city', $city);
        $builder->where('state', $state);
        $builder->where('deleted', 0);


        $query = $builder->get();

        if ($query->getNumRows() == 1) {    // TODO: ===
            return $query->getRow()->tax_code_id;
        }

        $builder = $this->db->table('tax_codes');
        $builder->where('city', '');
        $builder->where('state', $state);
        $builder->where('deleted', 0);

        $query = $builder->get();

        if ($query->getNumRows() == 1) {    // TODO: this should be ===
            return $query->getRow()->tax_code_id;
        } else {
            return $config['default_tax_code'];
        }
    }

    /**
     * @param string $search
     * @param int $limit
     * @return array
     */
    public function get_tax_codes_search_suggestions(string $search, int $limit = 25): array
    {
        $suggestions = [];

        $builder = $this->db->table('tax_codes');

        if (!empty($search)) {
            $builder->like('tax_code', $search);
            $builder->orLike('tax_code_name', $search);
        }

        $builder->where('deleted', 0);
        $builder->orderBy('tax_code_name', 'asc');

        foreach ($builder->get()->getResult() as $row) {
            $suggestions[] = ['value' => $row->tax_code_id, 'label' => ($row->tax_code . ' ' . $row->tax_code_name)];
        }

        // Only return $limit suggestions
        if (count($suggestions) > $limit) {
            $suggestions = array_slice($suggestions, 0, $limit);
        }

        return $suggestions;
    }

    /**
     * @return array[]
     */
    public function get_empty_row(): array
    {
        return [
            '0' => [
                'tax_code_id'   => NEW_ENTRY,
                'tax_code'      => '',
                'tax_code_name' => '',
                'city'          => '',
                'state'         => '',
                'deleted'       => 0
            ]
        ];
    }
}