TplPowerShell Class Reference

Static Public Member Functions
static	process ()

Private Member Functions
	__construct ()

Static Private Member Functions
static	getTab ($title, $icon, $shell, $initDir)
static	getTabCmdSection ()
static	getTabComposerSection ()
static	getTabGhostscriptSection ()
static	getTabGitSection ()
static	getTabMariadbSection ()
static	getTabMysqlSection ()
static	getTabNgrokSection ()
static	getTabNodejsSection ()
static	getTabPearSection ()
static	getTabPerlSection ()
static	getTabPostgresqlSection ()
static	getTabPowerShellSection ()
static	getTabPythonSection ()
static	getTabRubySection ()
static	getTabsSection ()

Detailed Description

Class TplPowerShell

This class is responsible for managing PowerShell configuration. It includes methods to define various sections such as tabs for different tools.

Definition at line 16 of file class.tpl.powershell.php.

Constructor & Destructor Documentation

__construct()

__construct ( )

private

Private constructor to prevent instantiation.

Definition at line 40 of file class.tpl.powershell.php.

    {
    }

Member Function Documentation

getTab()

getTab ( $title, $icon, $shell, $initDir )

staticprivate

Generates the structure for a tab.

This function constructs the structure for a tab, including the title, shell command, and initial directory.

Note: Icon parameter is currently unused as native PowerShell consoles do not support custom icons in tab titles. This was a feature of ConsoleZ which is no longer used. To use icons, consider using a terminal emulator like ConEmu, Cmder, or Windows Terminal.

Parameters

string	$title	The title of the tab.
string | null	$icon	The icon for the tab (currently unused).
string	$shell	The shell command to be executed in the tab.
string	$initDir	The initial directory for the tab.

Returns

string The structure for the tab. @global Core $bearsamppCore The core object of the application.

Definition at line 517 of file class.tpl.powershell.php.

    {
        global $bearsamppCore;
        // Icon parameter is ignored as native PowerShell console does not support custom icons
        // Return tab information as a formatted string
        return "Title: $title | Shell: $shell | InitDir: $initDir";
    }

References $bearsamppCore.

Referenced by getTabCmdSection(), getTabComposerSection(), getTabGhostscriptSection(), getTabGitSection(), getTabMariadbSection(), getTabMysqlSection(), getTabNgrokSection(), getTabNodejsSection(), getTabPearSection(), getTabPerlSection(), getTabPostgresqlSection(), getTabPowerShellSection(), getTabPythonSection(), and getTabRubySection().

getTabCmdSection()

getTabCmdSection ( )

staticprivate

Generates the structure for the command tab section.

This function creates a structure defining the command tab and its configuration. It retrieves the tab title and shell command from the PowerShell tool and sets the root path.

Returns

string The formatted string for the command tab section. @global Tools $bearsamppTools The tools object of the application.

@global Root $bearsamppRoot The root object of the application.

Definition at line 95 of file class.tpl.powershell.php.

    {
        global $bearsamppRoot, $bearsamppTools;
 
        return self::getTab(
                $bearsamppTools->getPowerShell()->getTabTitleDefault(),
                null, // self::ICON_APP - Icon not supported in native PowerShell console
                $bearsamppTools->getPowerShell()->getShell(),
                $bearsamppRoot->getRootPath()
            ) . PHP_EOL;
    }

References $bearsamppRoot, and getTab().

Referenced by getTabsSection().

getTabComposerSection()

getTabComposerSection ( )

staticprivate

Generates the structure for the Composer tab section.

This function creates a structure defining the Composer tab and its configuration. It retrieves the Composer executable path and sets the WWW path.

Returns

string The formatted string for the Composer tab section. @global Tools $bearsamppTools The tools object of the application.

@global Root $bearsamppRoot The root object of the application.

Definition at line 323 of file class.tpl.powershell.php.

    {
        global $bearsamppRoot, $bearsamppTools;
 
        $shell = $bearsamppTools->getPowerShell()->getShell('"' . $bearsamppTools->getComposer()->getExe() . '"');
        if (!file_exists($bearsamppTools->getComposer()->getExe())) {
            $shell = $bearsamppTools->getPowerShell()->getShell('echo ' . $bearsamppTools->getComposer()->getExe() . ' not found');
        }
 
        return self::getTab(
                $bearsamppTools->getPowerShell()->getTabTitleComposer(),
                null, // self::ICON_COMPOSER - Icon not supported in native PowerShell console
                $shell,
                $bearsamppRoot->getWwwPath()
            ) . PHP_EOL;
    }

References $bearsamppRoot, and getTab().

Referenced by getTabsSection().

getTabGhostscriptSection()

getTabGhostscriptSection ( )

staticprivate

Generates the tab section for Ghostscript in the console.

This function constructs a shell command to check the version of Ghostscript and verifies if the executable exists. If the executable is not found, it returns a message indicating the absence of the executable. It then creates a tab section with the appropriate title, icon, shell command, and initial directory.

Returns

string The structure for the Ghostscript tab section. @global Tools $bearsamppTools The tools object of the application. @global Root $bearsamppRoot The root object of the application.

Definition at line 453 of file class.tpl.powershell.php.

    {
        global $bearsamppRoot, $bearsamppTools;
 
        $shell = $bearsamppTools->getPowerShell()->getShell('"' . $bearsamppTools->getGhostscript()->getExeConsole() . '"');
        if (!file_exists($bearsamppTools->getGhostscript()->getExeConsole())) {
            $shell = $bearsamppTools->getPowerShell()->getShell('echo ' . $bearsamppTools->getGhostscript()->getExeConsole() . ' not found');
        }
 
        return self::getTab(
                $bearsamppTools->getPowerShell()->getTabTitleGhostscript(),
                null, // self::ICON_GHOSTSCRIPT - Icon not supported in native PowerShell console
                $shell,
                $bearsamppRoot->getWwwPath()
            ) . PHP_EOL;
    }

References $bearsamppRoot, and getTab().

Referenced by getTabsSection().

getTabGitSection()

getTabGitSection ( )

staticprivate

Generates the structure for the Git tab section.

This function creates a structure defining the Git tab and its configuration. It retrieves the Git executable path and sets the WWW path.

Returns

string The formatted string for the Git tab section. @global Tools $bearsamppTools The tools object of the application.

@global Root $bearsamppRoot The root object of the application.

Definition at line 266 of file class.tpl.powershell.php.

    {
        global $bearsamppRoot, $bearsamppTools;
 
        $shell = $bearsamppTools->getPowerShell()->getShell();
        if (!file_exists($bearsamppTools->getGit()->getExe())) {
            $shell = $bearsamppTools->getPowerShell()->getShell('echo ' . $bearsamppTools->getGit()->getExe() . ' not found');
        }
 
        return self::getTab(
                $bearsamppTools->getPowerShell()->getTabTitleGit(),
                null, // self::ICON_GIT - Icon not supported in native PowerShell console
                $shell,
                $bearsamppRoot->getWwwPath()
            ) . PHP_EOL;
    }

References $bearsamppRoot, and getTab().

Referenced by getTabsSection().

getTabMariadbSection()

getTabMariadbSection ( )

staticprivate

Generates the structure for the MariaDB tab section.

This function creates a structure defining the MariaDB tab and its configuration. It retrieves the MariaDB CLI executable path and sets the symlink path.

Returns

string The formatted string for the MariaDB tab section. @global Tools $bearsamppTools The tools object of the application.

@global Bins $bearsamppBins The bins object of the application.

Definition at line 204 of file class.tpl.powershell.php.

    {
        global $bearsamppBins, $bearsamppTools;
 
        $shell = $bearsamppTools->getPowerShell()->getShell('"' . $bearsamppBins->getMariadb()->getCliExe() . '" -u' .
            $bearsamppBins->getMariadb()->getRootUser() .
            ($bearsamppBins->getMariadb()->getRootPwd() ? ' -p' : ''));
        if (!file_exists($bearsamppBins->getMariadb()->getCliExe())) {
            $shell = $bearsamppTools->getPowerShell()->getShell('echo ' . $bearsamppBins->getMariadb()->getCliExe() . ' not found');
        }
 
        return self::getTab(
                $bearsamppTools->getPowerShell()->getTabTitleMariadb(),
                null, // self::ICON_DB - Icon not supported in native PowerShell console
                $shell,
                $bearsamppBins->getMariadb()->getSymlinkPath()
            ) . PHP_EOL;
    }

References $bearsamppBins, and getTab().

Referenced by getTabsSection().

getTabMysqlSection()

getTabMysqlSection ( )

staticprivate

Generates the structure for the MySQL tab section.

This function creates a structure defining the MySQL tab and its configuration. It retrieves the MySQL CLI executable path and sets the symlink path.

Returns

string The formatted string for the MySQL tab section. @global Tools $bearsamppTools The tools object of the application.

@global Bins $bearsamppBins The bins object of the application.

Definition at line 174 of file class.tpl.powershell.php.

    {
        global $bearsamppBins, $bearsamppTools;
 
        $shell = $bearsamppTools->getPowerShell()->getShell('"' . $bearsamppBins->getMysql()->getCliExe() . '" -u' .
            $bearsamppBins->getMysql()->getRootUser() .
            ($bearsamppBins->getMysql()->getRootPwd() ? ' -p' : ''));
        if (!file_exists($bearsamppBins->getMysql()->getCliExe())) {
            $shell = $bearsamppTools->getPowerShell()->getShell('echo ' . $bearsamppBins->getMysql()->getCliExe() . ' not found');
        }
 
        return self::getTab(
                $bearsamppTools->getPowerShell()->getTabTitleMysql(),
                null, // self::ICON_DB - Icon not supported in native PowerShell console
                $shell,
                $bearsamppBins->getMysql()->getSymlinkPath()
            ) . PHP_EOL;
    }

References $bearsamppBins, and getTab().

Referenced by getTabsSection().

getTabNgrokSection()

getTabNgrokSection ( )

staticprivate

Generates the tab section for Ngrok in the console.

This function constructs a shell command to check the version of Ngrok and verifies if the executable exists. If the executable is not found, it returns a message indicating the absence of the executable. It then creates a tab section with the appropriate title, icon, shell command, and initial directory.

Returns

string The structure for the Ngrok tab section. @global Tools $bearsamppTools The tools object of the application. @global Root $bearsamppRoot The root object of the application.

Definition at line 483 of file class.tpl.powershell.php.

    {
        global $bearsamppRoot, $bearsamppTools;
 
        $shell = $bearsamppTools->getPowerShell()->getShell('"' . $bearsamppTools->getNgrok()->getExe() . '"');
        if (!file_exists($bearsamppTools->getNgrok()->getExe())) {
            $shell = $bearsamppTools->getPowerShell()->getShell('echo ' . $bearsamppTools->getNgrok()->getExe() . ' not found');
        }
 
        return self::getTab(
                $bearsamppTools->getPowerShell()->getTabTitleNgrok(),
                null, // self::ICON_NGROK - Icon not supported in native PowerShell console
                $shell,
                $bearsamppRoot->getWwwPath()
            ) . PHP_EOL;
    }

References $bearsamppRoot, and getTab().

Referenced by getTabsSection().

getTabNodejsSection()

getTabNodejsSection ( )

staticprivate

Generates the structure for the Node.js tab section.

This function creates a structure defining the Node.js tab and its configuration. It retrieves the Node.js launch path and sets the WWW path.

Returns

string The formatted string for the Node.js tab section. @global Bins $bearsamppBins The bins object of the application. @global Tools $bearsamppTools The tools object of the application.

@global Root $bearsamppRoot The root object of the application.

Definition at line 295 of file class.tpl.powershell.php.

    {
        global $bearsamppRoot, $bearsamppBins, $bearsamppTools;
 
        $shell = $bearsamppTools->getPowerShell()->getShell('"' . $bearsamppBins->getNodejs()->getLaunch() . '"');
        if (!file_exists($bearsamppBins->getNodejs()->getLaunch())) {
            $shell = $bearsamppTools->getPowerShell()->getShell('echo ' . $bearsamppBins->getNodejs()->getLaunch() . ' not found');
        }
 
        return self::getTab(
                $bearsamppTools->getPowerShell()->getTabTitleNodejs(),
                null, // self::ICON_NODEJS - Icon not supported in native PowerShell console
                $shell,
                $bearsamppRoot->getWwwPath()
            ) . PHP_EOL;
    }

References $bearsamppBins, $bearsamppRoot, and getTab().

Referenced by getTabsSection().

getTabPearSection()

getTabPearSection ( )

staticprivate

Generates the structure for the PEAR tab section.

This function creates a structure defining the PEAR tab and its configuration. It retrieves the PEAR executable path and sets the symlink path.

Returns

string The formatted string for the PEAR tab section. @global Tools $bearsamppTools The tools object of the application.

@global Bins $bearsamppBins The bins object of the application.

Definition at line 146 of file class.tpl.powershell.php.

    {
        global $bearsamppBins, $bearsamppTools;
 
        $shell = $bearsamppTools->getPowerShell()->getShell('"' . $bearsamppBins->getPhp()->getPearExe() . '"');
        if (!file_exists($bearsamppBins->getPhp()->getPearExe())) {
            $shell = $bearsamppTools->getPowerShell()->getShell('echo ' . $bearsamppBins->getPhp()->getPearExe() . ' not found');
        }
 
        return self::getTab(
                $bearsamppTools->getPowerShell()->getTabTitlePear(),
                null, // self::ICON_PEAR - Icon not supported in native PowerShell console
                $shell,
                $bearsamppBins->getPhp()->getSymlinkPath() . '/pear'
            ) . PHP_EOL;
    }

References $bearsamppBins, and getTab().

Referenced by getTabsSection().

getTabPerlSection()

getTabPerlSection ( )

staticprivate

Generates the structure for the Perl tab section.

This function creates a structure defining the Perl tab and its configuration. It retrieves the Perl executable path and sets the WWW path.

Returns

string The formatted string for the Perl tab section. @global Tools $bearsamppTools The tools object of the application.

@global Root $bearsamppRoot The root object of the application.

Definition at line 423 of file class.tpl.powershell.php.

    {
        global $bearsamppRoot, $bearsamppTools;
 
        $shell = $bearsamppTools->getPowerShell()->getShell('"' . $bearsamppTools->getPerl()->getExe() . '"');
        if (!file_exists($bearsamppTools->getPerl()->getExe())) {
            $shell = $bearsamppTools->getPowerShell()->getShell('echo ' . $bearsamppTools->getPerl()->getExe() . ' not found');
        }
 
        return self::getTab(
                $bearsamppTools->getPowerShell()->getTabTitlePerl(),
                null, // self::ICON_PERL - Icon not supported in native PowerShell console
                $shell,
                $bearsamppRoot->getWwwPath()
            ) . PHP_EOL;
    }

References $bearsamppRoot, and getTab().

Referenced by getTabsSection().

getTabPostgresqlSection()

getTabPostgresqlSection ( )

staticprivate

Generates the structure for the PostgreSQL tab section.

This function creates a structure defining the PostgreSQL tab and its configuration. It retrieves the PostgreSQL CLI executable path and sets the symlink path.

Returns

string The formatted string for the PostgreSQL tab section. @global Tools $bearsamppTools The tools object of the application.

@global Bins $bearsamppBins The bins object of the application.

Definition at line 234 of file class.tpl.powershell.php.

    {
        global $bearsamppBins, $bearsamppTools;
 
        $shell = $bearsamppTools->getPowerShell()->getShell('"' . $bearsamppBins->getPostgresql()->getCliExe() . '"' .
            ' -h 127.0.0.1' .
            ' -p ' . $bearsamppBins->getPostgresql()->getPort() .
            ' -U ' . $bearsamppBins->getPostgresql()->getRootUser() .
            ' -d postgres');
        if (!file_exists($bearsamppBins->getPostgresql()->getCliExe())) {
            $shell = $bearsamppTools->getPowerShell()->getShell('echo ' . $bearsamppBins->getPostgresql()->getCliExe() . ' not found');
        }
 
        return self::getTab(
                $bearsamppTools->getPowerShell()->getTabTitlePostgresql(),
                null, // self::ICON_DB - Icon not supported in native PowerShell console
                $shell,
                $bearsamppBins->getPostgresql()->getSymlinkPath()
            ) . PHP_EOL;
    }

References $bearsamppBins, and getTab().

Referenced by getTabsSection().

getTabPowerShellSection()

getTabPowerShellSection ( )

staticprivate

Generates the structure for the PowerShell tab section.

This function creates a structure defining the PowerShell tab and its configuration. It retrieves the PowerShell path and sets the root path.

Returns

string The formatted string for the PowerShell tab section. @global Tools $bearsamppTools The tools object of the application.

@global Root $bearsamppRoot The root object of the application.

Definition at line 118 of file class.tpl.powershell.php.

    {
        global $bearsamppRoot, $bearsamppTools;
 
        $powerShellPath = Util::getPowerShellPath();
        if ($powerShellPath !== false) {
            return self::getTab(
                    $bearsamppTools->getPowerShell()->getTabTitlePowershell(),
                    null, // self::ICON_POWERSHELL - Icon not supported in native PowerShell console
                    $powerShellPath,
                    $bearsamppRoot->getRootPath()
                ) . PHP_EOL;
        }
 
        return "";
    }

References $bearsamppRoot, Util\getPowerShellPath(), and getTab().

Referenced by getTabsSection().

getTabPythonSection()

getTabPythonSection ( )

staticprivate

Generates the structure for the Python tab section.

This function creates a structure defining the Python tab and its configuration. It retrieves the Python executable path and sets the WWW path.

Returns

string The formatted string for the Python tab section. @global Tools $bearsamppTools The tools object of the application.

@global Root $bearsamppRoot The root object of the application.

Definition at line 351 of file class.tpl.powershell.php.

    {
        global $bearsamppRoot, $bearsamppTools;
 
        $shell = $bearsamppTools->getPowerShell()->getShell('"' . $bearsamppTools->getPython()->getExe() . '"');
        if (!file_exists($bearsamppTools->getPython()->getExe())) {
            $shell = $bearsamppTools->getPowerShell()->getShell('echo ' . $bearsamppTools->getPython()->getExe() . ' not found');
        }
 
        return self::getTab(
                $bearsamppTools->getPowerShell()->getTabTitlePython(),
                null, // self::ICON_PYTHON - Icon not supported in native PowerShell console
                $shell,
                $bearsamppRoot->getWwwPath()
            ) . PHP_EOL;
    }

References $bearsamppRoot, and getTab().

Referenced by getTabsSection().

getTabRubySection()

getTabRubySection ( )

staticprivate

Generates the structure for the Ruby tab section.

This function creates a structure defining the Ruby tab and its configuration. It retrieves the Ruby executable path and sets the WWW path.

Returns

string The formatted string for the Ruby tab section. @global Tools $bearsamppTools The tools object of the application.

@global Root $bearsamppRoot The root object of the application.

Definition at line 379 of file class.tpl.powershell.php.

    {
        global $bearsamppRoot, $bearsamppTools;
 
        // Check if Ruby exists first
        if (!file_exists($bearsamppTools->getRuby()->getExe())) {
            $shell = $bearsamppTools->getPowerShell()->getShell('echo ' . $bearsamppTools->getRuby()->getExe() . ' not found');
        } else {
            // Use irb (Interactive Ruby) for an interactive shell
            $rubyDir = dirname($bearsamppTools->getRuby()->getExe());
            $irbExe = $rubyDir . '/irb.bat';
            
            // Check if irb.bat exists, otherwise try irb.cmd or just use ruby with -i flag
            if (file_exists($irbExe)) {
                $shell = $bearsamppTools->getPowerShell()->getShell('"' . $irbExe . '"');
            } elseif (file_exists($rubyDir . '/irb.cmd')) {
                $shell = $bearsamppTools->getPowerShell()->getShell('"' . $rubyDir . '/irb.cmd' . '"');
            } elseif (file_exists($rubyDir . '/irb')) {
                $shell = $bearsamppTools->getPowerShell()->getShell('"' . $rubyDir . '/irb' . '"');
            } else {
                // Fallback to just opening a shell in the Ruby directory
                $shell = $bearsamppTools->getPowerShell()->getShell();
            }
        }
 
        return self::getTab(
                $bearsamppTools->getPowerShell()->getTabTitleRuby(),
                null, // self::ICON_RUBY - Icon not supported in native PowerShell console
                $shell,
                $bearsamppRoot->getWwwPath()
            ) . PHP_EOL;
    }

References $bearsamppRoot, and getTab().

Referenced by getTabsSection().

getTabsSection()

getTabsSection ( )

staticprivate

Generates the tabs section.

This function creates a structure defining various tabs and their configurations. It includes multiple tab sections such as command, PowerShell, PEAR, MySQL, MariaDB, PostgreSQL, Ghostscript, Git, Node.js, Composer, Perl, Python, Ruby and Ngrok.

Returns

string The formatted string for the tabs section.

Definition at line 66 of file class.tpl.powershell.php.

    {
        return self::getTabCmdSection() .
            self::getTabPowerShellSection() .
            self::getTabPearSection() .
            self::getTabMysqlSection() .
            self::getTabMariadbSection() .
            self::getTabPostgresqlSection() .
            self::getTabGhostscriptSection() .
            self::getTabGitSection() .
            self::getTabNodejsSection() .
            self::getTabComposerSection() .
            self::getTabPerlSection() .
            self::getTabPythonSection() .
            self::getTabRubySection() .
            self::getTabNgrokSection();
    }

References getTabCmdSection(), getTabComposerSection(), getTabGhostscriptSection(), getTabGitSection(), getTabMariadbSection(), getTabMysqlSection(), getTabNgrokSection(), getTabNodejsSection(), getTabPearSection(), getTabPerlSection(), getTabPostgresqlSection(), getTabPowerShellSection(), getTabPythonSection(), and getTabRubySection().

process()

process ( )

static

Process PowerShell configuration.

PowerShell 7+ uses profile scripts and Oh My Posh for configuration, not XML like ConsoleZ. This method is maintained for compatibility.

Definition at line 50 of file class.tpl.powershell.php.

    {
        // PowerShell uses profile scripts (Microsoft.PowerShell_profile.ps1)
        // and Oh My Posh for configuration - no processing needed here
        return true;
    }

Referenced by ActionReload\__construct().

---

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

• E:/Bearsampp-development/sandbox/core/classes/tpls/class.tpl.powershell.php