opensourcepos/app/Controllers/Item_kits.php

<?php

namespace App\Controllers;

use App\Libraries\Barcode_lib;

use App\Models\Item;
use App\Models\Item_kit;
use App\Models\Item_kit_items;
use CodeIgniter\HTTP\ResponseInterface;
use Config\Services;

class Item_kits extends Secure_Controller
{
    private Item $item;
    private Item_kit $item_kit;
    private Item_kit_items $item_kit_items;

    public function __construct()
    {
        parent::__construct('item_kits');

        $this->item = model(Item::class);
        $this->item_kit = model(Item_kit::class);
        $this->item_kit_items = model(Item_kit_items::class);
    }

    /**
     * Add the total cost and retail price to a passed item_kit retrieving the data from each singular item part of the kit
     */
    private function _add_totals_to_item_kit(object $item_kit): object    // TODO: Hungarian notation
    {
        $kit_item_info = $this->item->get_info($item_kit->kit_item_id ?? $item_kit->item_id);

        $item_kit->total_cost_price = 0;
        $item_kit->total_unit_price = $kit_item_info->unit_price;
        $total_quantity = 0;

        foreach ($this->item_kit_items->get_info($item_kit->item_kit_id) as $item_kit_item) {
            $item_info = $this->item->get_info($item_kit_item['item_id']);
            foreach (get_object_vars($item_info) as $property => $value) {
                $item_info->$property = $value;
            }

            $item_kit->total_cost_price += $item_info->cost_price * $item_kit_item['quantity'];

            if ($item_kit->price_option == PRICE_OPTION_ALL || ($item_kit->price_option == PRICE_OPTION_KIT_STOCK && $item_info->stock_type == HAS_STOCK)) {
                $item_kit->total_unit_price += $item_info->unit_price * $item_kit_item['quantity'];
                $total_quantity += $item_kit_item['quantity'];
            }
        }

        $discount_fraction = bcdiv($item_kit->kit_discount, '100');

        $item_kit->total_unit_price = $item_kit->total_unit_price - round(($item_kit->kit_discount_type == PERCENT)
            ? bcmul($item_kit->total_unit_price, $discount_fraction)
            : $item_kit->kit_discount, totals_decimals(), PHP_ROUND_HALF_UP);

        return $item_kit;
    }

    /**
     * @return string
     */
    public function getIndex(): string
    {
        $data['table_headers'] = get_item_kits_manage_table_headers();

        return view('item_kits/manage', $data);
    }

    /**
     * Returns Item_kit table data rows. This will be called with AJAX.
     */
    public function getSearch(): ResponseInterface
    {
        $search = $this->request->getGet('search') ?? '';
        $limit  = $this->request->getGet('limit', FILTER_SANITIZE_NUMBER_INT);
        $offset = $this->request->getGet('offset', FILTER_SANITIZE_NUMBER_INT);
        $sort   = $this->sanitizeSortColumn(item_kit_headers(), $this->request->getGet('sort', FILTER_SANITIZE_FULL_SPECIAL_CHARS), 'item_kit_id');
        $order  = $this->request->getGet('order', FILTER_SANITIZE_FULL_SPECIAL_CHARS);

        $item_kits = $this->item_kit->search($search, $limit, $offset, $sort, $order);
        $total_rows = $this->item_kit->get_found_rows($search);

        $data_rows = [];
        foreach ($item_kits->getResult() as $item_kit) {
            // Calculate the total cost and retail price of the Kit, so it can be printed out in the manage table
            $item_kit = $this->_add_totals_to_item_kit($item_kit);
            $data_rows[] = get_item_kit_data_row($item_kit);
        }

        return $this->response->setJSON(['total' => $total_rows, 'rows' => $data_rows]);
    }

    /**
     * @return ResponseInterface
     */
    public function suggest_search(): ResponseInterface
    {
        $search = $this->request->getPost('term');
        $suggestions = $this->item_kit->get_search_suggestions($search);

        return $this->response->setJSON($suggestions);
    }

    /**
     * @param int $row_id
     * @return ResponseInterface
     */
    public function getRow(int $row_id): ResponseInterface
    {
        // Calculate the total cost and retail price of the Kit, so it can be added to the table refresh
        $item_kit = $this->_add_totals_to_item_kit($this->item_kit->get_info($row_id));

        return $this->response->setJSON(get_item_kit_data_row($item_kit));
    }

    /**
     * @param int $item_kit_id
     * @return string
     */
    public function getView(int $item_kit_id = NEW_ENTRY): string
    {
        $info = $this->item_kit->get_info($item_kit_id);

        if ($item_kit_id == NEW_ENTRY) {
            $info->price_option = '0';
            $info->print_option = PRINT_ALL;
            $info->kit_item_id = 0;
            $info->item_number = '';
            $info->kit_discount = 0;
        }

        foreach (get_object_vars($info) as $property => $value) {
            $info->$property = $value;
        }

        $data['item_kit_info']  = $info;

        $items = [];

        foreach ($this->item_kit_items->get_info($item_kit_id) as $item_kit_item) {
            $item['kit_sequence'] = $item_kit_item['kit_sequence'];
            $item['name'] = $this->item->get_info($item_kit_item['item_id'])->name;
            $item['item_id'] = $item_kit_item['item_id'];
            $item['quantity'] = $item_kit_item['quantity'];

            $items[] = $item;
        }

        $data['item_kit_items'] = $items;

        $data['selected_kit_item_id'] = $info->kit_item_id;
        $data['selected_kit_item'] = ($item_kit_id > 0 && isset($info->kit_item_id)) ? $info->item_name : '';

        return view("item_kits/form", $data);
    }

    /**
     * @param int $item_kit_id
     * @return ResponseInterface
     */
    public function postSave(int $item_kit_id = NEW_ENTRY): ResponseInterface
    {
        $item_kit_data = [
            'name'              => $this->request->getPost('name'),
            'item_kit_number'   => $this->request->getPost('item_kit_number'),
            'item_id'           => $this->request->getPost('kit_item_id'),
            'kit_discount'      => parse_decimals($this->request->getPost('kit_discount')),
            'kit_discount_type' => $this->request->getPost('kit_discount_type') === null ? PERCENT : intval($this->request->getPost('kit_discount_type')),
            'price_option'      => $this->request->getPost('price_option') === null ? PRICE_ALL : intval($this->request->getPost('price_option')),
            'print_option'      => $this->request->getPost('print_option') === null ? PRINT_ALL : intval($this->request->getPost('print_option')),
            'description'       => $this->request->getPost('description')
        ];

        if ($this->item_kit->save_value($item_kit_data, $item_kit_id)) {
            $new_item = false;
            // New item kit
            if ($item_kit_id == NEW_ENTRY) {
                $item_kit_id = $item_kit_data['item_kit_id'];
                $new_item = true;
            }

            $item_kit_items_array = $this->request->getPost('item_kit_qty') === null ? null : $this->request->getPost('item_kit_qty');

            if ($item_kit_items_array != null) {
                $item_kit_items = [];
                foreach ($item_kit_items_array as $item_id => $item_kit_qty) {
                    $item_kit_items[] = [
                        'item_id'      => $item_id,
                        'quantity'     => $item_kit_qty === null ? 0 : parse_quantity($item_kit_qty),
                        'kit_sequence' => $this->request->getPost("item_kit_seq[$item_id]") === null ? 0 : intval($this->request->getPost("item_kit_seq[$item_id]"))
                    ];
                }
            }

            if (!empty($item_kit_items)) {
                $success = $this->item_kit_items->save_value($item_kit_items, $item_kit_id);
            } else {
                $success = true;
            }

            if ($new_item) {
                return $this->response->setJSON([
                    'success' => $success,
                    'message' => lang('Item_kits.successful_adding') . ' ' . $item_kit_data['name'],
                    'id'      => $item_kit_id
                ]);
            } else {
                return $this->response->setJSON([
                    'success' => $success,
                    'message' => lang('Item_kits.successful_updating') . ' ' . $item_kit_data['name'],
                    'id'      => $item_kit_id
                ]);
            }
        } else { // Failure
            return $this->response->setJSON([
                'success' => false,
                'message' => lang('Item_kits.error_adding_updating') . ' ' . $item_kit_data['name'],
                'id'      => NEW_ENTRY
            ]);
        }
    }

    /**
     * @return ResponseInterface
     */
    public function postDelete(): ResponseInterface
    {
        $item_kits_to_delete = $this->request->getPost('ids', FILTER_SANITIZE_FULL_SPECIAL_CHARS);

        if ($this->item_kit->delete_list($item_kits_to_delete)) {
            return $this->response->setJSON([
                'success' => true,
                'message' => lang('Item_kits.successful_deleted') . ' ' . count($item_kits_to_delete) . ' ' . lang('Item_kits.one_or_multiple')
            ]);
        } else {
            return $this->response->setJSON(['success' => false, 'message' => lang('Item_kits.cannot_be_deleted')]);
        }
    }

    /**
     * Checks the validity of the item kit number. Used in app/Views/item_kits/form.php
     *
     * @return ResponseInterface
     * @noinspection PhpUnused
     */
    public function postCheckItemNumber(): ResponseInterface
    {
        $exists = $this->item_kit->item_number_exists($this->request->getPost('item_kit_number', FILTER_SANITIZE_FULL_SPECIAL_CHARS), $this->request->getPost('item_kit_id', FILTER_SANITIZE_NUMBER_INT));
        return $this->response->setJSON(!$exists ? 'true' : 'false');
    }

    /**
     * AJAX called function that generates barcodes for selected item_kits.
     *
     * @param string $item_kit_ids Colon separated list of item_kit_id values to generate barcodes for.
     * @return string
     * @noinspection PhpUnused
     */
    public function getGenerateBarcodes(string $item_kit_ids): string
    {
        $barcode_lib = new Barcode_lib();
        $result = [];

        $item_kit_ids = explode(':', $item_kit_ids);
        foreach ($item_kit_ids as $item_kid_id) {
            // Calculate the total cost and retail price of the Kit, so it can be added to the barcode text at the bottom
            $item_kit = $this->_add_totals_to_item_kit($this->item_kit->get_info($item_kid_id));

            $item_kid_id = 'KIT ' . urldecode($item_kid_id);

            $result[] = [
                'name'        => $item_kit->name,
                'item_id'     => $item_kid_id,
                'item_number' => $item_kid_id,
                'cost_price'  => $item_kit->total_cost_price,
                'unit_price'  => $item_kit->total_unit_price
            ];
        }

        $data['items'] = $result;
        $barcode_config = $barcode_lib->get_barcode_config();
        // In case the selected barcode type is not Code39 or Code128 we set by default Code128
        // The rationale for this is that EAN codes cannot have strings as seed, so 'KIT ' is not allowed
        if ($barcode_config['barcode_type'] != 'C39' && $barcode_config['barcode_type'] != 'C128') {
            $barcode_config['barcode_type'] = 'C128';
        }
        $data['barcode_config'] = $barcode_config;

        // Display barcodes
        return view("barcodes/barcode_sheet", $data);
    }
}