Inheritance diagram for ActionDialogBase:

Public Member Functions
	__construct ($args)
	processWindow ($window, $id, $ctrl, $param1, $param2)

Data Fields
const	GAUGE_DELETE = 2
const	GAUGE_SAVE = 2

Protected Member Functions
	createButtons ($bearsamppWinbinder)
	createFormFields ($bearsamppWinbinder)
	deleteItem ()
	getDeleteConfirmMessage ()
	getDeleteDialogTitle ()
	getDeleteErrorMessage ()
	getDeleteSuccessMessage ()
	getDialogTitle ()
	getFormValues ($bearsamppWinbinder)
	getGaugeDelete ()
	getGaugeSave ()
	getSaveErrorMessage ()
	getSaveSuccessMessage ($values)
	getWindowTitle ()
	handleCustomEvent ($window, $id, $ctrl, $param1, $param2)
	handleDelete ($window)
	handleSave ($window)
	initializeDialog ($args)
	isEditMode ()
	itemExists ($values)
	restartService ()
	saveItem ($values)
	validateInput ($values)

Protected Attributes
	$initValue
	$wbBtnCancel
	$wbBtnDelete
	$wbBtnSave
	$wbProgressBar
	$wbWindow

Detailed Description

Class ActionDialogBase

Base class for dialog-based actions (Add/Edit Alias/Vhost). This class provides common functionality for creating and managing dialog windows with form fields, validation, and save/delete operations.

Definition at line 17 of file class.action.dialogBase.php.

Constructor & Destructor Documentation

◆ __construct()

__construct ( $args )

Constructor for dialog actions

Parameters

array $args Command line arguments

Definition at line 189 of file class.action.dialogBase.php.

    {
        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();
    }

References createButtons(), createFormFields(), getWindowTitle(), and initializeDialog().

Member Function Documentation

◆ createButtons()

createButtons ( $bearsamppWinbinder )

protected

Create standard buttons (Save, Delete, Cancel)

Parameters

object $bearsamppWinbinder The WinBinder instance

Returns: void

Definition at line 225 of file class.action.dialogBase.php.

    {
        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
            );
        }
    }

References $bearsamppLang, Lang\BUTTON_CANCEL, Lang\BUTTON_DELETE, Lang\BUTTON_SAVE, getGaugeSave(), and isEditMode().

Referenced by __construct().

◆ createFormFields()

createFormFields ( $bearsamppWinbinder )

abstractprotected

Create form fields specific to the dialog This method should create all input fields, labels, and buttons

Parameters

object $bearsamppWinbinder The WinBinder instance

Returns: void

Reimplemented in ActionAddAlias, ActionAddVhost, ActionEditAlias, and ActionEditVhost.

Referenced by __construct().

◆ deleteItem()

deleteItem ( )

abstractprotected

Delete the item

Returns: bool True on success, false on failure

Reimplemented in ActionAddAlias, ActionAddVhost, ActionEditAlias, and ActionEditVhost.

Referenced by handleDelete().

◆ getDeleteConfirmMessage()

getDeleteConfirmMessage ( )

abstractprotected

Get delete confirmation message

Returns: string The confirmation message

Reimplemented in ActionAddAlias, ActionAddVhost, ActionEditAlias, and ActionEditVhost.

Referenced by handleDelete().

◆ getDeleteDialogTitle()

getDeleteDialogTitle ( )

abstractprotected

Get the delete dialog title

Returns: string The delete dialog title

Reimplemented in ActionAddAlias, ActionAddVhost, ActionEditAlias, and ActionEditVhost.

Referenced by handleDelete().

◆ getDeleteErrorMessage()

getDeleteErrorMessage ( )

abstractprotected

Get error message after delete failure

Returns: string The error message

Reimplemented in ActionAddAlias, ActionAddVhost, ActionEditAlias, and ActionEditVhost.

Referenced by handleDelete().

◆ getDeleteSuccessMessage()

getDeleteSuccessMessage ( )

abstractprotected

Get success message after delete

Returns: string The success message

Reimplemented in ActionAddAlias, ActionAddVhost, ActionEditAlias, and ActionEditVhost.

Referenced by handleDelete().

◆ getDialogTitle()

getDialogTitle ( )

abstractprotected

Get the dialog title for messages

Returns: string The dialog title

Reimplemented in ActionAddAlias, ActionAddVhost, ActionEditAlias, and ActionEditVhost.

Referenced by handleSave().

◆ getFormValues()

getFormValues ( $bearsamppWinbinder )

abstractprotected

Get the current form values

Parameters

object $bearsamppWinbinder The WinBinder instance

Returns: array Associative array of form values

Reimplemented in ActionAddAlias, ActionAddVhost, ActionEditAlias, and ActionEditVhost.

Referenced by handleSave().

◆ getGaugeDelete()

getGaugeDelete ( )

protected

Get the gauge value for delete operation (can be overridden)

Returns: int The gauge value

Definition at line 52 of file class.action.dialogBase.php.

    {
        return self::GAUGE_DELETE;
    }

Referenced by handleDelete().

◆ getGaugeSave()

getGaugeSave ( )

protected

Get the gauge value for save operation (can be overridden)

Returns: int The gauge value

Reimplemented in ActionEditVhost.

Definition at line 42 of file class.action.dialogBase.php.

    {
        return self::GAUGE_SAVE;
    }

Referenced by createButtons(), and handleSave().

◆ getSaveErrorMessage()

getSaveErrorMessage ( )

abstractprotected

Get error message after save failure

Returns: string The error message

Reimplemented in ActionAddAlias, ActionAddVhost, ActionEditAlias, and ActionEditVhost.

Referenced by handleSave().

◆ getSaveSuccessMessage()

getSaveSuccessMessage ( $values )

abstractprotected

Get success message after save

Parameters

array $values The form values

Returns: string The success message

Reimplemented in ActionAddAlias, ActionAddVhost, ActionEditAlias, and ActionEditVhost.

Referenced by handleSave().

◆ getWindowTitle()

getWindowTitle ( )

abstractprotected

Get the dialog window title

Returns: string The window title

Reimplemented in ActionAddAlias, ActionAddVhost, ActionEditAlias, and ActionEditVhost.

Referenced by __construct().

◆ handleCustomEvent()

handleCustomEvent	(	$window,
		$id,
		$ctrl,
		$param1,
		$param2 )

protected

Handle custom events (can be overridden by child classes)

Parameters

resource	$window	The window resource
int	$id	The control ID
resource	$ctrl	The control resource
mixed	$param1	Additional parameter 1
mixed	$param2	Additional parameter 2

Returns: void

Reimplemented in ActionAddAlias, ActionAddVhost, ActionEditAlias, and ActionEditVhost.

Definition at line 320 of file class.action.dialogBase.php.

    {
        // Default: do nothing
        // Child classes can override to handle specific events
    }

Referenced by processWindow().

◆ handleDelete()

handleDelete ( $window )

protected

Handle delete operation

Parameters

resource $window The window resource

Returns: void

Definition at line 388 of file class.action.dialogBase.php.

    {
        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);
        }
    }

References deleteItem(), getDeleteConfirmMessage(), getDeleteDialogTitle(), getDeleteErrorMessage(), getDeleteSuccessMessage(), getGaugeDelete(), and restartService().

Referenced by processWindow().

◆ handleSave()

handleSave ( $window )

protected

Handle save operation

Parameters

resource $window The window resource

Returns: void

Definition at line 332 of file class.action.dialogBase.php.

    {
        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);
        }
    }

References getDialogTitle(), getFormValues(), getGaugeSave(), getSaveErrorMessage(), getSaveSuccessMessage(), itemExists(), restartService(), saveItem(), and validateInput().

Referenced by processWindow().

◆ initializeDialog()

initializeDialog ( $args )

protected

Initialize the dialog window

Parameters

array $args Command line arguments

Returns: bool True if initialization successful, false otherwise

Reimplemented in ActionEditAlias, and ActionEditVhost.

Definition at line 178 of file class.action.dialogBase.php.

    {
        // To be implemented by child classes if needed
        return true;
    }

Referenced by __construct().

◆ isEditMode()

isEditMode ( )

protected

Check if this is an edit operation (has delete button)

Returns: bool True if edit operation, false if add operation

Definition at line 160 of file class.action.dialogBase.php.

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

Referenced by createButtons(), and processWindow().

◆ itemExists()

itemExists ( $values )

abstractprotected

Check if the item already exists (for add/edit operations)

Parameters

array $values The form values

Returns: bool True if exists, false otherwise

Reimplemented in ActionAddAlias, ActionAddVhost, ActionEditAlias, and ActionEditVhost.

Referenced by handleSave().

◆ processWindow()

processWindow	(	$window,
		$id,
		$ctrl,
		$param1,
		$param2 )

Process window events

Parameters

resource	$window	The window resource
int	$id	The control ID
resource	$ctrl	The control resource
mixed	$param1	Additional parameter 1
mixed	$param2	Additional parameter 2

Returns: void

Definition at line 284 of file class.action.dialogBase.php.

    {
        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);
    }

References WinBinder\CTRL_ID, handleCustomEvent(), handleDelete(), handleSave(), and isEditMode().

◆ restartService()

restartService ( )

abstractprotected

Restart the service after save/delete

Returns: void

Reimplemented in ActionAddAlias, ActionAddVhost, ActionEditAlias, and ActionEditVhost.

Referenced by handleDelete(), and handleSave().

◆ saveItem()

saveItem ( $values )

abstractprotected

Save the item (create or update)

Parameters

array $values The form values

Returns: bool True on success, false on failure

Reimplemented in ActionAddAlias, ActionAddVhost, ActionEditAlias, and ActionEditVhost.

Referenced by handleSave().

◆ validateInput()

validateInput ( $values )

abstractprotected

Validate the form input

Parameters

array $values The form values

Returns: array ['valid' => bool, 'error' => string|null]

Reimplemented in ActionAddAlias, ActionAddVhost, ActionEditAlias, and ActionEditVhost.

Referenced by handleSave().

Field Documentation

◆ $initValue

$initValue

protected

Definition at line 25 of file class.action.dialogBase.php.

◆ $wbBtnCancel

$wbBtnCancel

protected

Definition at line 22 of file class.action.dialogBase.php.

◆ $wbBtnDelete

$wbBtnDelete

protected

Definition at line 23 of file class.action.dialogBase.php.

◆ $wbBtnSave

$wbBtnSave

protected

Definition at line 21 of file class.action.dialogBase.php.

◆ $wbProgressBar

$wbProgressBar

protected

Definition at line 20 of file class.action.dialogBase.php.

◆ $wbWindow

$wbWindow

protected

Definition at line 19 of file class.action.dialogBase.php.

◆ GAUGE_DELETE

const GAUGE_DELETE = 2

Definition at line 28 of file class.action.dialogBase.php.

◆ GAUGE_SAVE

const GAUGE_SAVE = 2

Definition at line 27 of file class.action.dialogBase.php.

The documentation for this class was generated from the following file:

E:/Bearsampp-development/sandbox/core/classes/actions/class.action.dialogBase.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ createButtons()

◆ createFormFields()

◆ deleteItem()

◆ getDeleteConfirmMessage()

◆ getDeleteDialogTitle()

◆ getDeleteErrorMessage()

◆ getDeleteSuccessMessage()

◆ getDialogTitle()

◆ getFormValues()

◆ getGaugeDelete()

◆ getGaugeSave()

◆ getSaveErrorMessage()

◆ getSaveSuccessMessage()

◆ getWindowTitle()

◆ handleCustomEvent()

◆ handleDelete()

◆ handleSave()

◆ initializeDialog()

◆ isEditMode()

◆ itemExists()

◆ processWindow()

◆ restartService()

◆ saveItem()

◆ validateInput()

Field Documentation

◆ $initValue

◆ $wbBtnCancel

◆ $wbBtnDelete

◆ $wbBtnSave

◆ $wbProgressBar

◆ $wbWindow

◆ GAUGE_DELETE

◆ GAUGE_SAVE