ServiceHelper Class Reference

Static Public Member Functions
static	getAllServiceNames ()
static	getBinFromServiceName ($serviceName, $bearsamppBins)
static	getServiceDisplayName ($bin, $service)
static	getServicePort ($serviceName, $bearsamppBins)
static	getSyntaxCheckCmd ($serviceName, $bearsamppBins=null)
static	hasSyntaxCheck ($serviceName)
static	processServices ($bearsamppBins, callable $callback)
static	restartService ($service)
static	startService ($bin, $syntaxCheckCmd=null, $showErrors=true)
static	stopService ($service)

Static Private Member Functions
static	initializeMappings ($bearsamppBins)

Static Private Attributes
static	$serviceMap = null
static	$syntaxCheckMap = null

Detailed Description

Class ServiceHelper

Utility class for service management operations. Provides centralized methods for service lookup, syntax check commands, and common service operations to eliminate code duplication.

Definition at line 17 of file class.serviceHelper.php.

Member Function Documentation

getAllServiceNames()

getAllServiceNames ( )

static

Get all service names

Returns

array Array of service name constants

Definition at line 161 of file class.serviceHelper.php.

    {
        return [
            BinApache::SERVICE_NAME,
            BinMysql::SERVICE_NAME,
            BinMariadb::SERVICE_NAME,
            BinMailpit::SERVICE_NAME,
            BinMemcached::SERVICE_NAME,
            BinPostgresql::SERVICE_NAME,
            BinXlight::SERVICE_NAME,
        ];
    }

References BinApache\SERVICE_NAME, BinMailpit\SERVICE_NAME, BinMariadb\SERVICE_NAME, BinMemcached\SERVICE_NAME, BinMysql\SERVICE_NAME, BinPostgresql\SERVICE_NAME, and BinXlight\SERVICE_NAME.

getBinFromServiceName()

getBinFromServiceName ( $serviceName, $bearsamppBins )

static

Get binary instance from service name

Parameters

string	$serviceName	The service name
object	$bearsamppBins	The bins object

Returns

object|null The binary instance or null if not found

Definition at line 67 of file class.serviceHelper.php.

    {
        self::initializeMappings($bearsamppBins);
        return isset(self::$serviceMap[$serviceName]) ? self::$serviceMap[$serviceName] : null;
    }

References $bearsamppBins, and initializeMappings().

Referenced by getServicePort(), and processServices().

getServiceDisplayName()

getServiceDisplayName ( $bin, $service )

static

Get service display name (Name + Version + Service Name)

Parameters

object	$bin	The binary instance
object	$service	The service instance

Returns

string The formatted service name

Definition at line 95 of file class.serviceHelper.php.

    {
        return $bin->getName() . ' ' . $bin->getVersion() . ' (' . $service->getName() . ')';
    }

Referenced by ActionRestartAllServices\processWindow(), ActionStartAllServices\processWindow(), and ActionStopAllServices\processWindow().

getServicePort()

getServicePort ( $serviceName, $bearsamppBins )

static

Get port for a service

Parameters

string	$serviceName	The service name
object	$bearsamppBins	The bins object

Returns

int The port number or 0 if not applicable

Definition at line 200 of file class.serviceHelper.php.

    {
        $bin = self::getBinFromServiceName($serviceName, $bearsamppBins);
        if ($bin === null) {
            return 0;
        }
 
        // Different services have different methods to get port
        if (method_exists($bin, 'getPort')) {
            return $bin->getPort();
        } elseif (method_exists($bin, 'getSmtpPort')) {
            return $bin->getSmtpPort();
        }
 
        return 0;
    }

References $bearsamppBins, and getBinFromServiceName().

getSyntaxCheckCmd()

getSyntaxCheckCmd ( $serviceName, $bearsamppBins = null )

static

Get syntax check command for a service

Parameters

string	$serviceName	The service name
object	$bearsamppBins	The bins object (for initialization)

Returns

string|null The syntax check command or null if not applicable

Definition at line 80 of file class.serviceHelper.php.

    {
        if ($bearsamppBins !== null) {
            self::initializeMappings($bearsamppBins);
        }
        return isset(self::$syntaxCheckMap[$serviceName]) ? self::$syntaxCheckMap[$serviceName] : null;
    }

References $bearsamppBins, and initializeMappings().

Referenced by processServices().

hasSyntaxCheck()

hasSyntaxCheck ( $serviceName )

static

Check if a service has syntax check capability

Parameters

string

$serviceName

The service name

Returns

bool True if service supports syntax check

Definition at line 180 of file class.serviceHelper.php.

    {
        if (self::$syntaxCheckMap === null) {
            // Initialize with dummy bins object if needed
            self::$syntaxCheckMap = [
                BinApache::SERVICE_NAME => BinApache::CMD_SYNTAX_CHECK,
                BinMysql::SERVICE_NAME => BinMysql::CMD_SYNTAX_CHECK,
                BinMariadb::SERVICE_NAME => BinMariadb::CMD_SYNTAX_CHECK,
            ];
        }
        return isset(self::$syntaxCheckMap[$serviceName]);
    }

References BinApache\CMD_SYNTAX_CHECK, BinMariadb\CMD_SYNTAX_CHECK, BinMysql\CMD_SYNTAX_CHECK, BinApache\SERVICE_NAME, BinMariadb\SERVICE_NAME, and BinMysql\SERVICE_NAME.

initializeMappings()

initializeMappings ( $bearsamppBins )

staticprivate

Initialize service mappings

Parameters

object

$bearsamppBins

The bins object

Returns

void

Definition at line 37 of file class.serviceHelper.php.

    {
        if (self::$serviceMap === null) {
            self::$serviceMap = [
                BinApache::SERVICE_NAME => $bearsamppBins->getApache(),
                BinMysql::SERVICE_NAME => $bearsamppBins->getMysql(),
                BinMariadb::SERVICE_NAME => $bearsamppBins->getMariadb(),
                BinMailpit::SERVICE_NAME => $bearsamppBins->getMailpit(),
                BinMemcached::SERVICE_NAME => $bearsamppBins->getMemcached(),
                BinPostgresql::SERVICE_NAME => $bearsamppBins->getPostgresql(),
                BinXlight::SERVICE_NAME => $bearsamppBins->getXlight(),
            ];
        }
 
        if (self::$syntaxCheckMap === null) {
            self::$syntaxCheckMap = [
                BinApache::SERVICE_NAME => BinApache::CMD_SYNTAX_CHECK,
                BinMysql::SERVICE_NAME => BinMysql::CMD_SYNTAX_CHECK,
                BinMariadb::SERVICE_NAME => BinMariadb::CMD_SYNTAX_CHECK,
            ];
        }
    }

References $bearsamppBins, BinApache\CMD_SYNTAX_CHECK, BinMariadb\CMD_SYNTAX_CHECK, BinMysql\CMD_SYNTAX_CHECK, BinApache\SERVICE_NAME, BinMailpit\SERVICE_NAME, BinMariadb\SERVICE_NAME, BinMemcached\SERVICE_NAME, BinMysql\SERVICE_NAME, BinPostgresql\SERVICE_NAME, and BinXlight\SERVICE_NAME.

Referenced by getBinFromServiceName(), getSyntaxCheckCmd(), and processServices().

processServices()

processServices ( $bearsamppBins, callable $callback )

static

Process all services with a callback function

Parameters

object	$bearsamppBins	The bins object
callable	$callback	Function to call for each service: function($serviceName, $service, $bin, $syntaxCheckCmd)

Returns

void

Definition at line 107 of file class.serviceHelper.php.

    {
        self::initializeMappings($bearsamppBins);
 
        foreach ($bearsamppBins->getServices() as $serviceName => $service) {
            $bin = self::getBinFromServiceName($serviceName, $bearsamppBins);
            $syntaxCheckCmd = self::getSyntaxCheckCmd($serviceName);
 
            if ($bin !== null) {
                $callback($serviceName, $service, $bin, $syntaxCheckCmd);
            }
        }
    }

References $bearsamppBins, getBinFromServiceName(), getSyntaxCheckCmd(), and initializeMappings().

Referenced by ActionRestartAllServices\processWindow(), ActionStartAllServices\processWindow(), and ActionStopAllServices\processWindow().

restartService()

restartService ( $service )

static

Restart a service

Parameters

object

$service

The service instance

Returns

bool True if service restarted successfully, false otherwise

Definition at line 151 of file class.serviceHelper.php.

    {
        return $service->restart();
    }

startService()

startService ( $bin, $syntaxCheckCmd = null, $showErrors = true )

static

Start a service with optional syntax check

Parameters

object	$bin	The binary instance
string | null	$syntaxCheckCmd	The syntax check command (optional)
bool	$showErrors	Whether to show error messages (default: true)

Returns

bool True if service started successfully, false otherwise

Definition at line 129 of file class.serviceHelper.php.

    {
        return Util::startService($bin, $syntaxCheckCmd, $showErrors);
    }

References Util\startService().

Referenced by ActionRestartAllServices\processWindow(), and ActionStartAllServices\processWindow().

stopService()

stopService ( $service )

static

Stop a service

Parameters

object

$service

The service instance

Returns

bool True if service stopped successfully, false otherwise

Definition at line 140 of file class.serviceHelper.php.

    {
        return $service->stop();
    }

Referenced by ActionRestartAllServices\processWindow(), and ActionStopAllServices\processWindow().

Field Documentation

$serviceMap

$serviceMap = null

staticprivate

Definition at line 23 of file class.serviceHelper.php.

$syntaxCheckMap

$syntaxCheckMap = null

staticprivate

Definition at line 29 of file class.serviceHelper.php.

---

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

• E:/Bearsampp-development/sandbox/core/classes/class.serviceHelper.php