Inheritance diagram for ActionAddVhost:

Collaboration diagram for ActionAddVhost:

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

Private Attributes
	$wbBtnDocRoot
	$wbInputDocRoot
	$wbInputServerName
	$wbLabelDocRoot
	$wbLabelExp
	$wbLabelServerName

Additional Inherited Members
Public Member Functions inherited from ActionDialogBase
	__construct ($args)
	processWindow ($window, $id, $ctrl, $param1, $param2)
Data Fields inherited from ActionDialogBase
const	GAUGE_DELETE = 2
const	GAUGE_SAVE = 2
Protected Attributes inherited from ActionDialogBase
	$initValue
	$wbBtnCancel
	$wbBtnDelete
	$wbBtnSave
	$wbProgressBar
	$wbWindow

Detailed Description

Class ActionAddVhost Handles the creation of a new virtual host (vhost) in the Bearsampp application.

Definition at line 14 of file class.action.addVhost.php.

Member Function Documentation

◆ createFormFields()

createFormFields ( $bearsamppWinbinder )

protected

Create the form fields for the add vhost dialog.

Parameters

object $bearsamppWinbinder The WinBinder instance.

Returns: void

Reimplemented from ActionDialogBase.

Definition at line 71 of file class.action.addVhost.php.

    {
        global $bearsamppRoot, $bearsamppLang;
 
        $initServerName   = 'test.local';
        $initDocumentRoot = Path::formatWindowsPath(Path::getWwwPath()) . '\\' . $initServerName;
 
        $this->wbLabelServerName = $bearsamppWinbinder->createLabel(
            $this->wbWindow,
            $bearsamppLang->getValue(Lang::VHOST_SERVER_NAME_LABEL) . ' :',
            15,
            15,
            85,
            null,
            WBC_RIGHT
        );
        $this->wbInputServerName = $bearsamppWinbinder->createInputText(
            $this->wbWindow,
            $initServerName,
            105,
            13,
            150,
            null
        );
 
        $this->wbLabelDocRoot = $bearsamppWinbinder->createLabel(
            $this->wbWindow,
            $bearsamppLang->getValue(Lang::VHOST_DOCUMENT_ROOT_LABEL) . ' :',
            15,
            45,
            85,
            null,
            WBC_RIGHT
        );
        $this->wbInputDocRoot = $bearsamppWinbinder->createInputText(
            $this->wbWindow,
            $initDocumentRoot,
            105,
            43,
            190,
            null,
            null,
            WBC_READONLY
        );
        $this->wbBtnDocRoot   = $bearsamppWinbinder->createButton(
            $this->wbWindow,
            $bearsamppLang->getValue(Lang::BUTTON_BROWSE),
            300,
            43,
            110
        );
 
        $this->wbLabelExp = $bearsamppWinbinder->createLabel(
            $this->wbWindow,
            sprintf($bearsamppLang->getValue(Lang::VHOST_EXP_LABEL), $initServerName, $initDocumentRoot),
            15,
            80,
            470,
            50
        );
    }

References $bearsamppLang, $bearsamppRoot, Lang\BUTTON_BROWSE, Path\formatWindowsPath(), Path\getWwwPath(), Lang\VHOST_DOCUMENT_ROOT_LABEL, Lang\VHOST_EXP_LABEL, and Lang\VHOST_SERVER_NAME_LABEL.

Here is the call graph for this function:

◆ deleteItem()

deleteItem ( )

protected

Delete the vhost. Not used in add mode.

Returns: bool Always returns false.

Reimplemented from ActionDialogBase.

Definition at line 220 of file class.action.addVhost.php.

    {
        // Not used in add mode
        return false;
    }

◆ getDeleteConfirmMessage()

getDeleteConfirmMessage ( )

protected

Get the delete confirmation message. Not used in add mode.

Returns: string Empty string.

Reimplemented from ActionDialogBase.

Definition at line 262 of file class.action.addVhost.php.

    {
        // Not used in add mode
        return '';
    }

◆ getDeleteDialogTitle()

getDeleteDialogTitle ( )

protected

Get the delete dialog title.

Returns: string Empty string, not used in add mode.

Reimplemented from ActionDialogBase.

Definition at line 58 of file class.action.addVhost.php.

    {
        // Not used in add mode
        return '';
    }

◆ getDeleteErrorMessage()

getDeleteErrorMessage ( )

protected

Get the error message after delete failure. Not used in add mode.

Returns: string Empty string.

Reimplemented from ActionDialogBase.

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

    {
        // Not used in add mode
        return '';
    }

◆ getDeleteSuccessMessage()

getDeleteSuccessMessage ( )

protected

Get the success message after delete. Not used in add mode.

Returns: string Empty string.

Reimplemented from ActionDialogBase.

Definition at line 273 of file class.action.addVhost.php.

    {
        // Not used in add mode
        return '';
    }

◆ getDialogTitle()

getDialogTitle ( )

protected

Get the dialog title for message boxes.

Returns: string The localized dialog title.

Reimplemented from ActionDialogBase.

Definition at line 46 of file class.action.addVhost.php.

    {
        global $bearsamppLang;
 
        return $bearsamppLang->getValue(Lang::ADD_VHOST_TITLE);
    }

References $bearsamppLang, and Lang\ADD_VHOST_TITLE.

◆ getFormValues()

getFormValues ( $bearsamppWinbinder )

protected

Get the current form values from the input controls.

Parameters

object $bearsamppWinbinder The WinBinder instance.

Returns: array Associative array with 'serverName' and 'documentRoot' keys.

Reimplemented from ActionDialogBase.

Definition at line 140 of file class.action.addVhost.php.

    {
        return [
            'serverName'   => $bearsamppWinbinder->getText($this->wbInputServerName[WinBinder::CTRL_OBJ]),
            'documentRoot' => $bearsamppWinbinder->getText($this->wbInputDocRoot[WinBinder::CTRL_OBJ])
        ];
    }

References WinBinder\CTRL_OBJ.

◆ getSaveErrorMessage()

getSaveErrorMessage ( )

protected

Get the error message after save failure.

Returns: string The localized error message.

Reimplemented from ActionDialogBase.

Definition at line 250 of file class.action.addVhost.php.

    {
        global $bearsamppLang;
 
        return $bearsamppLang->getValue(Lang::VHOST_CREATED_ERROR);
    }

References $bearsamppLang, and Lang\VHOST_CREATED_ERROR.

◆ getSaveSuccessMessage()

getSaveSuccessMessage ( $values )

protected

Get the success message after saving.

Parameters

array $values The form values.

Returns: string The localized success message.

Reimplemented from ActionDialogBase.

Definition at line 233 of file class.action.addVhost.php.

    {
        global $bearsamppLang;
 
        return sprintf(
            $bearsamppLang->getValue(Lang::VHOST_CREATED),
            $values['serverName'],
            $values['serverName'],
            $values['documentRoot']
        );
    }

References $bearsamppLang, and Lang\VHOST_CREATED.

◆ getWindowTitle()

getWindowTitle ( )

protected

Get the dialog window title.

Returns: string The localized window title.

Reimplemented from ActionDialogBase.

Definition at line 34 of file class.action.addVhost.php.

    {
        global $bearsamppLang;
 
        return $bearsamppLang->getValue(Lang::ADD_VHOST_TITLE);
    }

References $bearsamppLang, and Lang\ADD_VHOST_TITLE.

◆ handleCustomEvent()

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

protected

Handle custom window events (server name input change and browse button).

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 from ActionDialogBase.

Definition at line 312 of file class.action.addVhost.php.

    {
        global $bearsamppLang, $bearsamppWinbinder;
 
        $serverName   = $bearsamppWinbinder->getText($this->wbInputServerName[WinBinder::CTRL_OBJ]);
        $documentRoot = $bearsamppWinbinder->getText($this->wbInputDocRoot[WinBinder::CTRL_OBJ]);
 
        // Handle server name input change
        if ($id == $this->wbInputServerName[WinBinder::CTRL_ID]) {
            $bearsamppWinbinder->setText(
                $this->wbLabelExp[WinBinder::CTRL_OBJ],
                sprintf($bearsamppLang->getValue(Lang::VHOST_EXP_LABEL), $serverName, $documentRoot)
            );
            $bearsamppWinbinder->setEnabled(
                $this->wbBtnSave[WinBinder::CTRL_OBJ],
                !empty($serverName)
            );
        }
 
        // Handle browse button
        if ($id == $this->wbBtnDocRoot[WinBinder::CTRL_ID]) {
            $documentRoot = $bearsamppWinbinder->sysDlgPath(
                $window,
                $bearsamppLang->getValue(Lang::VHOST_DOC_ROOT_PATH),
                $documentRoot
            );
            if ($documentRoot && is_dir($documentRoot)) {
                $bearsamppWinbinder->setText($this->wbInputDocRoot[WinBinder::CTRL_OBJ], $documentRoot . '\\');
                $bearsamppWinbinder->setText(
                    $this->wbLabelExp[WinBinder::CTRL_OBJ],
                    sprintf($bearsamppLang->getValue(Lang::VHOST_EXP_LABEL), $serverName, $documentRoot . '\\')
                );
            }
        }
    }

References $bearsamppLang, WinBinder\CTRL_ID, WinBinder\CTRL_OBJ, Lang\VHOST_DOC_ROOT_PATH, and Lang\VHOST_EXP_LABEL.

◆ itemExists()

itemExists ( $values )

protected

Check if a vhost configuration file already exists.

Parameters

array $values The form values.

Returns: bool True if the vhost already exists, false otherwise.

Reimplemented from ActionDialogBase.

Definition at line 176 of file class.action.addVhost.php.

    {
        global $bearsamppRoot, $bearsamppLang, $bearsamppWinbinder;
 
        if (is_file(Path::getVhostsPath() . '/' . $values['serverName'] . '.conf')) {
            $bearsamppWinbinder->messageBoxError(
                sprintf($bearsamppLang->getValue(Lang::VHOST_ALREADY_EXISTS), $values['serverName']),
                $this->getDialogTitle()
            );
 
            return true;
        }
 
        return false;
    }

References $bearsamppLang, $bearsamppRoot, Path\getVhostsPath(), and Lang\VHOST_ALREADY_EXISTS.

Here is the call graph for this function:

◆ restartService()

restartService ( )

protected

Restart the Apache service after saving.

Returns: void

Reimplemented from ActionDialogBase.

Definition at line 295 of file class.action.addVhost.php.

    {
        global $bearsamppBins;
        $bearsamppBins->getApache()->getService()->restart();
    }

References $bearsamppBins.

◆ saveItem()

saveItem ( $values )

protected

Save the vhost configuration file and create an SSL certificate.

Parameters

array $values The form values.

Returns: bool True on success, false on failure.

Reimplemented from ActionDialogBase.

Definition at line 199 of file class.action.addVhost.php.

    {
        global $bearsamppRoot, $bearsamppBins, $bearsamppOpenSsl;
 
        // Create SSL certificate
        if (!$bearsamppOpenSsl->createCrt($values['serverName'])) {
            return false;
        }
 
        // Create vhost configuration file
        return file_put_contents(
                Path::getVhostsPath() . '/' . $values['serverName'] . '.conf',
                $bearsamppBins->getApache()->getVhostContent($values['serverName'], $values['documentRoot'])
            ) !== false;
    }

References $bearsamppBins, $bearsamppRoot, and Path\getVhostsPath().

Here is the call graph for this function:

◆ validateInput()

validateInput ( $values )

protected

Validate the form input.

Parameters

array $values The form values.

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

Reimplemented from ActionDialogBase.

Definition at line 155 of file class.action.addVhost.php.

    {
        global $bearsamppLang;
 
        if (!Util::isValidDomainName($values['serverName'])) {
            return [
                'valid' => false,
                'error' => sprintf($bearsamppLang->getValue(Lang::VHOST_NOT_VALID_DOMAIN), $values['serverName'])
            ];
        }
 
        return ['valid' => true];
    }

References $bearsamppLang, Util\isValidDomainName(), and Lang\VHOST_NOT_VALID_DOMAIN.

Here is the call graph for this function:

Field Documentation

◆ $wbBtnDocRoot

$wbBtnDocRoot

private

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

◆ $wbInputDocRoot

$wbInputDocRoot

private

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

◆ $wbInputServerName

$wbInputServerName

private

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

◆ $wbLabelDocRoot

$wbLabelDocRoot

private

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

◆ $wbLabelExp

$wbLabelExp

private

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

◆ $wbLabelServerName

$wbLabelServerName

private

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

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

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

Protected Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ createFormFields()

◆ deleteItem()

◆ getDeleteConfirmMessage()

◆ getDeleteDialogTitle()

◆ getDeleteErrorMessage()

◆ getDeleteSuccessMessage()

◆ getDialogTitle()

◆ getFormValues()

◆ getSaveErrorMessage()

◆ getSaveSuccessMessage()

◆ getWindowTitle()

◆ handleCustomEvent()

◆ itemExists()

◆ restartService()

◆ saveItem()

◆ validateInput()

Field Documentation

◆ $wbBtnDocRoot

◆ $wbInputDocRoot

◆ $wbInputServerName

◆ $wbLabelDocRoot

◆ $wbLabelExp

◆ $wbLabelServerName