ActionDebugBase Class Reference

Inheritance diagram for ActionDebugBase:

Public Member Functions
	__construct ($args)

Protected Member Functions
	getBinInstance ($bearsamppBins)
	getCommandMapping ()
	getServiceLangConstant ()
	hasContentKey ()
	isSyntaxCheckCommand ($command)

Detailed Description

Class ActionDebugBase

Base class for debugging actions across different services (MySQL, MariaDB, Apache, PostgreSQL). This class provides common functionality for executing debug commands and displaying their output. Child classes need to implement service-specific methods to define their behavior.

Since

2026.2.16

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

Constructor & Destructor Documentation

__construct()

__construct

(

$args

)

Constructor for debug actions.

Parameters

array

$args

An array of arguments where the first element is the command to execute.

This constructor handles the common debugging workflow:

1. Validates arguments
2. Builds the caption based on the command
3. Executes the command and retrieves output
4. Handles syntax check results if applicable
5. Displays output in editor or message box

Since

2026.2.16

Definition at line 75 of file class.action.debugBase.php.

    {
        global $bearsamppLang, $bearsamppBins, $bearsamppTools, $bearsamppWinbinder;
 
        if (isset($args[0]) && !empty($args[0])) {
            $editor = false;
            $msgBoxError = false;
 
            // Build base caption
            $serviceLangConstant = $this->getServiceLangConstant();
            $caption = $bearsamppLang->getValue(Lang::DEBUG) . ' ' .
                       $bearsamppLang->getValue(constant('Lang::' . $serviceLangConstant)) . ' - ';
 
            // Get command mapping and determine caption suffix and editor flag
            $commandMapping = $this->getCommandMapping();
            $command = $args[0];
 
            if (isset($commandMapping[$command])) {
                $config = $commandMapping[$command];
                $caption .= $bearsamppLang->getValue($config['lang']);
                if (isset($config['editor']) && $config['editor']) {
                    $editor = true;
                }
            }
            $caption .= ' (' . $command . ')';
 
            // Execute the command and get output
            $bin = $this->getBinInstance($bearsamppBins);
            $debugOutput = $bin->getCmdLineOutput($command);
 
            // Handle syntax check results (if applicable)
            if ($this->isSyntaxCheckCommand($command)) {
                if ($this->hasContentKey()) {
                    $msgBoxError = !$debugOutput['syntaxOk'];
                    $debugOutput['content'] = $debugOutput['syntaxOk'] ? 'Syntax OK !' : $debugOutput['content'];
                }
            }
 
            // Extract content based on service type
            $content = $this->hasContentKey() && is_array($debugOutput) ? $debugOutput['content'] : $debugOutput;
 
            // Display the output
            if ($editor) {
                Util::openFileContent($caption, $content);
            } else {
                if ($msgBoxError) {
                    $bearsamppWinbinder->messageBoxError($content, $caption);
                } else {
                    $bearsamppWinbinder->messageBoxInfo($content, $caption);
                }
            }
        }
    }

References $bearsamppBins, $bearsamppLang, Lang\DEBUG, getBinInstance(), getCommandMapping(), getServiceLangConstant(), hasContentKey(), isSyntaxCheckCommand(), and Util\openFileContent().

Member Function Documentation

getBinInstance()

getBinInstance ( $bearsamppBins )

abstractprotected

Get the binary instance for this service

Parameters

object

$bearsamppBins

The bins object containing all service binaries

Returns

object The specific binary instance (e.g., BinMysql, BinApache)

Since

2026.2.16

Reimplemented in ActionDebugApache, ActionDebugMariadb, ActionDebugMysql, and ActionDebugPostgresql.

References $bearsamppBins.

Referenced by __construct().

getCommandMapping()

getCommandMapping ( )

abstractprotected

Get the command-to-caption mapping for this service Returns an array where keys are command constants and values are arrays with:

• 'lang': the language constant for the caption
• 'editor': boolean indicating if output should be shown in editor (default: false)

Returns

array Command mapping configuration

Since

2026.2.16

Reimplemented in ActionDebugApache, ActionDebugMariadb, ActionDebugMysql, and ActionDebugPostgresql.

Referenced by __construct(), and isSyntaxCheckCommand().

getServiceLangConstant()

getServiceLangConstant ( )

abstractprotected

Get the service name for language strings (e.g., 'MYSQL', 'APACHE', 'MARIADB', 'POSTGRESQL')

Returns

string The language constant name for the service

Since

2026.2.16

Reimplemented in ActionDebugApache, ActionDebugMariadb, ActionDebugMysql, and ActionDebugPostgresql.

Referenced by __construct().

hasContentKey()

hasContentKey ( )

protected

Check if the debug output has a 'content' key (for services that return arrays) or if it's a direct string (for services like PostgreSQL)

Returns

bool True if output is an array with 'content' key, false if direct string

Since

2026.2.16

Reimplemented in ActionDebugPostgresql.

Definition at line 56 of file class.action.debugBase.php.

    {
        return true;
    }

Referenced by __construct().

isSyntaxCheckCommand()

isSyntaxCheckCommand ( $command )

protected

Check if the given command is a syntax check command

Parameters

string

$command

The command to check

Returns

bool True if it's a syntax check command

Since

2026.2.16

Definition at line 136 of file class.action.debugBase.php.

    {
        $commandMapping = $this->getCommandMapping();
        if (isset($commandMapping[$command])) {
            return isset($commandMapping[$command]['syntaxCheck']) && $commandMapping[$command]['syntaxCheck'];
        }
        return false;
    }

References getCommandMapping().

Referenced by __construct().

---

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

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