class.action.dialogBase.php

Go to the documentation of this file.

<?php
/*
 * Copyright (c) 2021-2024 Bearsampp
 * License:  GNU General Public License version 3 or later; see LICENSE.txt
 * Author: Bear
 * Website: https://bearsampp.com
 * Github: https://github.com/Bearsampp
 */

abstract class ActionDialogBase
{
    protected $wbWindow;
    protected $wbProgressBar;
    protected $wbBtnSave;
    protected $wbBtnCancel;
    protected $wbBtnDelete;
 
    protected $initValue; // Initial value for edit operations
 
    const GAUGE_SAVE = 2;
    const GAUGE_DELETE = 2;

    abstract protected function getWindowTitle();

    protected function getGaugeSave()
    {
        return self::GAUGE_SAVE;
    }

    protected function getGaugeDelete()
    {
        return self::GAUGE_DELETE;
    }

    abstract protected function createFormFields($bearsamppWinbinder);

    abstract protected function getFormValues($bearsamppWinbinder);

    abstract protected function validateInput($values);

    abstract protected function itemExists($values);

    abstract protected function saveItem($values);

    abstract protected function deleteItem();

    abstract protected function getSaveSuccessMessage($values);

    abstract protected function getSaveErrorMessage();

    abstract protected function getDeleteConfirmMessage();

    abstract protected function getDeleteSuccessMessage();

    abstract protected function getDeleteErrorMessage();

    abstract protected function getDialogTitle();

    abstract protected function getDeleteDialogTitle();

    protected function isEditMode()
    {
        return isset($this->initValue) && !empty($this->initValue);
    }

    abstract protected function restartService();

    protected function initializeDialog($args)
    {
        // To be implemented by child classes if needed
        return true;
    }

    public function __construct($args)
    {
        global $bearsamppWinbinder;
 
        // Initialize dialog (child class can load data, etc.)
        if (!$this->initializeDialog($args)) {
            return;
        }
 
        $bearsamppWinbinder->reset();
        $this->wbWindow = $bearsamppWinbinder->createAppWindow(
            $this->getWindowTitle(),
            490,
            200,
            WBC_NOTIFY,
            WBC_KEYDOWN | WBC_KEYUP
        );
 
        // Create form fields (implemented by child class)
        $this->createFormFields($bearsamppWinbinder);
 
        // Create progress bar and buttons
        $this->createButtons($bearsamppWinbinder);
 
        // Set up event handler
        $bearsamppWinbinder->setHandler($this->wbWindow, $this, 'processWindow');
        $bearsamppWinbinder->mainLoop();
        $bearsamppWinbinder->reset();
    }

    protected function createButtons($bearsamppWinbinder)
    {
        global $bearsamppLang;
 
        $this->wbProgressBar = $bearsamppWinbinder->createProgressBar(
            $this->wbWindow,
            $this->getGaugeSave() + 1,
            15,
            137,
            $this->isEditMode() ? 190 : 275
        );
 
        if ($this->isEditMode()) {
            // Edit mode: Save, Delete, Cancel
            $this->wbBtnSave = $bearsamppWinbinder->createButton(
                $this->wbWindow,
                $bearsamppLang->getValue(Lang::BUTTON_SAVE),
                215,
                132
            );
            $this->wbBtnDelete = $bearsamppWinbinder->createButton(
                $this->wbWindow,
                $bearsamppLang->getValue(Lang::BUTTON_DELETE),
                300,
                132
            );
            $this->wbBtnCancel = $bearsamppWinbinder->createButton(
                $this->wbWindow,
                $bearsamppLang->getValue(Lang::BUTTON_CANCEL),
                385,
                132
            );
        } else {
            // Add mode: Save, Cancel
            $this->wbBtnSave = $bearsamppWinbinder->createButton(
                $this->wbWindow,
                $bearsamppLang->getValue(Lang::BUTTON_SAVE),
                300,
                132
            );
            $this->wbBtnCancel = $bearsamppWinbinder->createButton(
                $this->wbWindow,
                $bearsamppLang->getValue(Lang::BUTTON_CANCEL),
                387,
                132
            );
        }
    }

    public function processWindow($window, $id, $ctrl, $param1, $param2)
    {
        global $bearsamppWinbinder;
 
        // Handle save button
        if ($id == $this->wbBtnSave[WinBinder::CTRL_ID]) {
            $this->handleSave($window);
            return;
        }
 
        // Handle delete button (if in edit mode)
        if ($this->isEditMode() && $id == $this->wbBtnDelete[WinBinder::CTRL_ID]) {
            $this->handleDelete($window);
            return;
        }
 
        // Handle cancel button or window close
        if ($id == IDCLOSE || $id == $this->wbBtnCancel[WinBinder::CTRL_ID]) {
            $bearsamppWinbinder->destroyWindow($window);
            return;
        }
 
        // Handle custom events (implemented by child class)
        $this->handleCustomEvent($window, $id, $ctrl, $param1, $param2);
    }

    protected function handleCustomEvent($window, $id, $ctrl, $param1, $param2)
    {
        // Default: do nothing
        // Child classes can override to handle specific events
    }

    protected function handleSave($window)
    {
        global $bearsamppWinbinder;
 
        $bearsamppWinbinder->setProgressBarMax($this->wbProgressBar, $this->getGaugeSave() + 1);
        $bearsamppWinbinder->incrProgressBar($this->wbProgressBar);
 
        // Get form values
        $values = $this->getFormValues($bearsamppWinbinder);
 
        // Validate input
        $validation = $this->validateInput($values);
        if (!$validation['valid']) {
            $bearsamppWinbinder->messageBoxError(
                $validation['error'],
                $this->getDialogTitle()
            );
            $bearsamppWinbinder->resetProgressBar($this->wbProgressBar);
            return;
        }
 
        // Check if item already exists (for add or rename operations)
        if ($this->itemExists($values)) {
            $bearsamppWinbinder->resetProgressBar($this->wbProgressBar);
            return;
        }
 
        // Save the item
        if ($this->saveItem($values)) {
            $bearsamppWinbinder->incrProgressBar($this->wbProgressBar);
 
            // Restart service
            $this->restartService();
            $bearsamppWinbinder->incrProgressBar($this->wbProgressBar);
 
            // Show success message
            $bearsamppWinbinder->messageBoxInfo(
                $this->getSaveSuccessMessage($values),
                $this->getDialogTitle()
            );
            $bearsamppWinbinder->destroyWindow($window);
        } else {
            $bearsamppWinbinder->messageBoxError(
                $this->getSaveErrorMessage(),
                $this->getDialogTitle()
            );
            $bearsamppWinbinder->resetProgressBar($this->wbProgressBar);
        }
    }

    protected function handleDelete($window)
    {
        global $bearsamppWinbinder;
 
        $bearsamppWinbinder->setProgressBarMax($this->wbProgressBar, $this->getGaugeDelete() + 1);
 
        // Confirm deletion
        $confirm = $bearsamppWinbinder->messageBoxYesNo(
            $this->getDeleteConfirmMessage(),
            $this->getDeleteDialogTitle()
        );
 
        $bearsamppWinbinder->incrProgressBar($this->wbProgressBar);
 
        if ($confirm) {
            if ($this->deleteItem()) {
                $bearsamppWinbinder->incrProgressBar($this->wbProgressBar);
 
                // Restart service
                $this->restartService();
                $bearsamppWinbinder->incrProgressBar($this->wbProgressBar);
 
                // Show success message
                $bearsamppWinbinder->messageBoxInfo(
                    $this->getDeleteSuccessMessage(),
                    $this->getDeleteDialogTitle()
                );
                $bearsamppWinbinder->destroyWindow($window);
            } else {
                $bearsamppWinbinder->messageBoxError(
                    $this->getDeleteErrorMessage(),
                    $this->getDeleteDialogTitle()
                );
                $bearsamppWinbinder->resetProgressBar($this->wbProgressBar);
            }
        } else {
            $bearsamppWinbinder->resetProgressBar($this->wbProgressBar);
        }
    }
}