ActionRestartAllServices Class Reference

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

Data Fields
const	GAUGE_PER_SERVICE = 2

Private Member Functions
	getServiceShutdownOrder ()
	getServiceStartupOrder ()

Private Attributes
	$processed = false
	$splash

Detailed Description

Class ActionRestartAllServices Handles restarting all services with a single splash screen showing progress. Stops all services first, then starts them all.

Definition at line 15 of file class.action.restartAllServices.php.

Constructor & Destructor Documentation

__construct()

__construct

(

$args

)

ActionRestartAllServices constructor. Initializes the restarting process, displays the splash screen, and sets up the main loop.

Parameters

array

$args

Command line arguments.

Definition at line 38 of file class.action.restartAllServices.php.

    {
        global $bearsamppCore, $bearsamppLang, $bearsamppBins, $bearsamppWinbinder;
 
        // Count enabled services for progress bar
        $enabledServicesCount = count($bearsamppBins->getServices());
 
        // Start splash screen (2 operations per service: stop + start)
        $this->splash = new Splash();
        $this->splash->init(
            $bearsamppLang->getValue(Lang::MENU_RESTART_SERVICES),
            self::GAUGE_PER_SERVICE * $enabledServicesCount + 1,
            $bearsamppLang->getValue(Lang::LOADING_RESTART_SERVICES)
        );
 
        // Set handler for the splash screen window with 1000ms timeout
        $bearsamppWinbinder->setHandler($this->splash->getWbWindow(), $this, 'processWindow', 1000);
        $bearsamppWinbinder->mainLoop();
        $bearsamppWinbinder->reset();
    }

References $bearsamppBins, $bearsamppCore, $bearsamppLang, Lang\LOADING_RESTART_SERVICES, and Lang\MENU_RESTART_SERVICES.

Member Function Documentation

getServiceShutdownOrder()

getServiceShutdownOrder ( )

private

Get the optimal service shutdown order based on dependencies. Services are ordered to stop dependent services first, then core services. This is the reverse of the startup order.

Returns

array Array of service names in shutdown order

Definition at line 66 of file class.action.restartAllServices.php.

    {
        // Define shutdown order: dependent services first, then core services
        // This prevents connection errors and ensures clean shutdown
        return [
            // Tier 1: Application services (no dependencies on other services)
            BinMailpit::SERVICE_NAME,      // Mail testing tool
            BinMemcached::SERVICE_NAME,    // Caching service
            BinXlight::SERVICE_NAME,       // FTP server
 
            // Tier 2: Database services (web server depends on these)
            BinPostgresql::SERVICE_NAME,   // PostgreSQL database
            BinMariadb::SERVICE_NAME,      // MariaDB database
            BinMysql::SERVICE_NAME,        // MySQL database
 
            // Tier 3: Web server (depends on databases and other services)
            BinApache::SERVICE_NAME,       // Apache web server (stopped last)
        ];
    }

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

Referenced by processWindow().

getServiceStartupOrder()

getServiceStartupOrder ( )

private

Get the optimal service startup order based on dependencies. Services are ordered to start core services first, then dependent services. This is the reverse of the shutdown order.

Returns

array Array of service names in startup order

Definition at line 93 of file class.action.restartAllServices.php.

    {
        // Define startup order: core services first, then dependent services
        // This ensures dependencies are available when needed
        return [
            // Tier 1: Web server (should start first as it's the foundation)
            BinApache::SERVICE_NAME,       // Apache web server (started first)
 
            // Tier 2: Database services (web server may depend on these)
            BinMysql::SERVICE_NAME,        // MySQL database
            BinMariadb::SERVICE_NAME,      // MariaDB database
            BinPostgresql::SERVICE_NAME,   // PostgreSQL database
 
            // Tier 3: Application services (no dependencies on other services)
            BinXlight::SERVICE_NAME,       // FTP server
            BinMemcached::SERVICE_NAME,    // Caching service
            BinMailpit::SERVICE_NAME,      // Mail testing tool
        ];
    }

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

Referenced by processWindow().

processWindow()

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

Processes the splash screen window events. Stops all services in shutdown order, then starts them in startup order with progress updates.

Parameters

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

Definition at line 123 of file class.action.restartAllServices.php.

    {
        global $bearsamppBins, $bearsamppLang, $bearsamppWinbinder;
 
        // Only process once
        if ($this->processed) {
            return;
        }
        $this->processed = true;
 
        // Get all available services
        $allServices = $bearsamppBins->getServices();
 
        // Get optimal shutdown order
        $shutdownOrder = $this->getServiceShutdownOrder();
 
        // First, stop all services in optimal shutdown order
        foreach ($shutdownOrder as $serviceName) {
            // Check if this service exists and is enabled
            if (!isset($allServices[$serviceName])) {
                continue;
            }
 
            $service = $allServices[$serviceName];
            $bin = ServiceHelper::getBinFromServiceName($serviceName, $bearsamppBins);
 
            if ($bin !== null) {
                $name = ServiceHelper::getServiceDisplayName($bin, $service);
 
                $this->splash->incrProgressBar();
                $this->splash->setTextLoading(sprintf($bearsamppLang->getValue(Lang::LOADING_STOP_SERVICE), $name));
 
                // Stop the service
                ServiceHelper::stopService($service);
            }
        }
 
        // Get optimal startup order
        $startupOrder = $this->getServiceStartupOrder();
 
        // Then, start all services in optimal startup order
        foreach ($startupOrder as $serviceName) {
            // Check if this service exists and is enabled
            if (!isset($allServices[$serviceName])) {
                continue;
            }
 
            $service = $allServices[$serviceName];
            $bin = ServiceHelper::getBinFromServiceName($serviceName, $bearsamppBins);
            $syntaxCheckCmd = ServiceHelper::getSyntaxCheckCmd($serviceName);
 
            if ($bin !== null) {
                $name = ServiceHelper::getServiceDisplayName($bin, $service);
 
                $this->splash->incrProgressBar();
                $this->splash->setTextLoading(sprintf($bearsamppLang->getValue(Lang::LOADING_START_SERVICE), $name));
 
                // Start the service
                ServiceHelper::startService($bin, $syntaxCheckCmd, false);
            }
        }
 
        // Final update
        $this->splash->incrProgressBar();
        $this->splash->setTextLoading($bearsamppLang->getValue(Lang::LOADING_COMPLETE));
 
        // Close the splash screen and exit cleanly
        $bearsamppWinbinder->destroyWindow($window);
        $bearsamppWinbinder->reset();
        exit(0);
    }

References $bearsamppBins, $bearsamppLang, exit, ServiceHelper\getBinFromServiceName(), ServiceHelper\getServiceDisplayName(), getServiceShutdownOrder(), getServiceStartupOrder(), ServiceHelper\getSyntaxCheckCmd(), Lang\LOADING_COMPLETE, Lang\LOADING_START_SERVICE, Lang\LOADING_STOP_SERVICE, ServiceHelper\startService(), and ServiceHelper\stopService().

Field Documentation

$processed

$processed = false

private

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

$splash

$splash

private

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

GAUGE_PER_SERVICE

const GAUGE_PER_SERVICE = 2

Gauge value for progress bar increments.

Definition at line 30 of file class.action.restartAllServices.php.

---

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

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