ToolPowerShell Class Reference

Inheritance diagram for ToolPowerShell:

Collaboration diagram for ToolPowerShell:

Public Member Functions
	__construct ($id, $type)
	getCols ()
	getConf ()
	getExe ()
	getLaunchExe ()
	getRows ()
	getShell ($args=null)
	getTabTitleComposer ()
	getTabTitleDefault ()
	getTabTitleGhostscript ()
	getTabTitleGit ($repoPath=null)
	getTabTitleMariadb ()
	getTabTitleMysql ()
	getTabTitleNgrok ()
	getTabTitleNodejs ()
	getTabTitlePear ()
	getTabTitlePerl ()
	getTabTitlePostgresql ()
	getTabTitlePowershell ()
	getTabTitlePython ()
	getTabTitleRuby ()
	reload ($id=null, $type=null)
	setVersion ($version)
Public Member Functions inherited from Module
	__toString ()
	getId ()
	getName ()
	getRelease ()
	getType ()
	getVersion ()
	getVersionList ()
	isEnable ()
	update ($sub=0, $showWindow=false)

Data Fields
const	LOCAL_CFG_COLS = 'powershellCols'
const	LOCAL_CFG_CONF = 'powershellConf'
const	LOCAL_CFG_EXE = 'powershellExe'
const	LOCAL_CFG_LAUNCH_EXE = 'powershellLaunchExe'
const	LOCAL_CFG_ROWS = 'powershellRows'
const	ROOT_CFG_VERSION = 'powershellVersion'
Data Fields inherited from Module
	$currentPath
	$rootPath
	$symlinkPath

Private Attributes
	$cols
	$conf
	$exe
	$launchExe
	$rows

Additional Inherited Members
Static Public Member Functions inherited from Module
static	clearMemoryCache ()
static	invalidateConfigCacheForPath ($sourcePath)
Protected Member Functions inherited from Module
	__construct ()
	replace ($key, $value)
	replaceAll ($params)
	updateConfig ($version=null, $sub=0, $showWindow=false)
Protected Attributes inherited from Module
	$bearsamppConf
	$bearsamppConfRaw
	$enable
	$name
	$release = 'N/A'
	$version

Detailed Description

Class ToolPowerShell

This class represents the PowerShell tool in the Bearsampp application. It extends the Module class and provides functionalities specific to PowerShell.

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

Constructor & Destructor Documentation

__construct()

__construct	(		$id,
			$type )

Constructor for the ToolPowerShell class.

Parameters

string	$id	The ID of the module.
string	$type	The type of the module.

Definition at line 71 of file class.tool.powershell.php.

    {
        Log::initClass($this);
        $this->reload($id, $type);
    }

References Module\$id, Module\$type, Log\initClass(), and reload().

Here is the call graph for this function:

Member Function Documentation

getCols()

getCols

(

)

Gets the number of columns for the PowerShell window.

Returns

int The number of columns.

Definition at line 191 of file class.tool.powershell.php.

    {
        return $this->cols;
    }

References $cols.

getConf()

getConf

(

)

Gets the configuration file path for PowerShell.

Returns

string The configuration file path.

Definition at line 171 of file class.tool.powershell.php.

    {
        return $this->conf;
    }

References $conf.

getExe()

getExe

(

)

Gets the executable path for PowerShell.

Returns

string The executable path.

Definition at line 151 of file class.tool.powershell.php.

    {
        return $this->exe;
    }

References $exe.

getLaunchExe()

getLaunchExe

(

)

Gets the launch executable path for PowerShell.

Returns

string The launch executable path.

Definition at line 161 of file class.tool.powershell.php.

    {
        return $this->launchExe;
    }

References $launchExe.

Referenced by getShell().

Here is the caller graph for this function:

getRows()

getRows

(

)

Gets the number of rows for the PowerShell window.

Returns

int The number of rows.

Definition at line 181 of file class.tool.powershell.php.

    {
        return $this->rows;
    }

References $rows.

getShell()

getShell

(

$args = null

)

Gets the shell command to launch PowerShell.

Parameters

string | null

$args

Additional arguments for the shell command.

Returns

string The shell command.

Definition at line 203 of file class.tool.powershell.php.

    {
        if (empty($args)) {
            return 'cmd /c "' . Path::formatWindowsPath($this->launchExe) . '"';
        } else {
            return 'cmd /c ""' . Path::formatWindowsPath($this->getLaunchExe()) . '" & ' . Path::formatWindowsPath($args) . '"';
        }
    }

References Path\formatWindowsPath(), and getLaunchExe().

Here is the call graph for this function:

getTabTitleComposer()

getTabTitleComposer

(

)

Gets the tab title for Composer.

Returns

string The tab title for Composer.

Definition at line 315 of file class.tool.powershell.php.

    {
        global $bearsamppLang, $bearsamppTools;
 
        return $bearsamppLang->getValue(Lang::COMPOSER) . ' ' . $bearsamppTools->getComposer()->getVersion();
    }

References $bearsamppLang, and Lang\COMPOSER.

getTabTitleDefault()

getTabTitleDefault

(

)

Gets the default tab title for PowerShell.

Returns

string The default tab title.

Definition at line 217 of file class.tool.powershell.php.

    {
        return 'Bearsampp PowerShell Console';
    }

getTabTitleGhostscript()

getTabTitleGhostscript

(

)

Gets the tab title for Ghostscript.

Returns

string The tab title for Ghostscript.

Definition at line 363 of file class.tool.powershell.php.

    {
        global $bearsamppLang, $bearsamppTools;
 
        return $bearsamppLang->getValue(Lang::GHOSTSCRIPT) . ' ' . $bearsamppTools->getGhostscript()->getVersion();
    }

References $bearsamppLang, and Lang\GHOSTSCRIPT.

getTabTitleGit()

getTabTitleGit

(

$repoPath = null

)

Gets the tab title for Git.

Parameters

string | null

$repoPath

The repository path.

Returns

string The tab title for Git.

Definition at line 287 of file class.tool.powershell.php.

    {
        global $bearsamppLang, $bearsamppTools;
        $result = $bearsamppLang->getValue(Lang::GIT) . ' ' . $bearsamppTools->getGit()->getVersion();
        if ($repoPath != null) {
            $result .= ' - ' . basename($repoPath);
        }
 
        return $result;
    }

References $bearsamppLang, $result, and Lang\GIT.

getTabTitleMariadb()

getTabTitleMariadb

(

)

Gets the tab title for MariaDB.

Returns

string The tab title for MariaDB.

Definition at line 261 of file class.tool.powershell.php.

    {
        global $bearsamppLang, $bearsamppBins;
 
        return $bearsamppLang->getValue(Lang::MARIADB) . ' ' . $bearsamppBins->getMariadb()->getVersion();
    }

References $bearsamppBins, $bearsamppLang, and Lang\MARIADB.

getTabTitleMysql()

getTabTitleMysql

(

)

Gets the tab title for MySQL.

Returns

string The tab title for MySQL.

Definition at line 249 of file class.tool.powershell.php.

    {
        global $bearsamppLang, $bearsamppBins;
 
        return $bearsamppLang->getValue(Lang::MYSQL) . ' ' . $bearsamppBins->getMysql()->getVersion();
    }

References $bearsamppBins, $bearsamppLang, and Lang\MYSQL.

getTabTitleNgrok()

getTabTitleNgrok

(

)

Gets the tab title for Ngrok.

Returns

string The tab title for Ngrok.

Definition at line 375 of file class.tool.powershell.php.

    {
        global $bearsamppLang, $bearsamppTools;
 
        return $bearsamppLang->getValue(Lang::NGROK) . ' ' . $bearsamppTools->getNgrok()->getVersion();
    }

References $bearsamppLang, and Lang\NGROK.

getTabTitleNodejs()

getTabTitleNodejs

(

)

Gets the tab title for Node.js.

Returns

string The tab title for Node.js.

Definition at line 303 of file class.tool.powershell.php.

    {
        global $bearsamppLang, $bearsamppBins;
 
        return $bearsamppLang->getValue(Lang::NODEJS) . ' ' . $bearsamppBins->getNodejs()->getVersion();
    }

References $bearsamppBins, $bearsamppLang, and Lang\NODEJS.

getTabTitlePear()

getTabTitlePear

(

)

Gets the tab title for PEAR.

Returns

string The tab title for PEAR.

Definition at line 237 of file class.tool.powershell.php.

    {
        global $bearsamppLang, $bearsamppBins;
 
        return $bearsamppLang->getValue(Lang::PEAR) . ' ' . $bearsamppBins->getPhp()->getPearVersion(true);
    }

References $bearsamppBins, $bearsamppLang, and Lang\PEAR.

getTabTitlePerl()

getTabTitlePerl

(

)

Gets the tab title for Perl.

Returns

string The tab title for Perl.

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

    {
        global $bearsamppLang, $bearsamppTools;
 
        return $bearsamppLang->getValue(Lang::PERL) . ' ' . $bearsamppTools->getPerl()->getVersion();
    }

References $bearsamppLang, and Lang\PERL.

getTabTitlePostgresql()

getTabTitlePostgresql

(

)

Gets the tab title for PostgreSQL.

Returns

string The tab title for PostgreSQL.

Definition at line 273 of file class.tool.powershell.php.

    {
        global $bearsamppLang, $bearsamppBins;
 
        return $bearsamppLang->getValue(Lang::POSTGRESQL) . ' ' . $bearsamppBins->getPostgresql()->getVersion();
    }

References $bearsamppBins, $bearsamppLang, and Lang\POSTGRESQL.

getTabTitlePowershell()

getTabTitlePowershell

(

)

Gets the tab title for PowerShell.

Returns

string The tab title for PowerShell.

Definition at line 227 of file class.tool.powershell.php.

    {
        return 'PowerShell';
    }

getTabTitlePython()

getTabTitlePython

(

)

Gets the tab title for Python.

Returns

string The tab title for Python.

Definition at line 327 of file class.tool.powershell.php.

    {
        global $bearsamppLang, $bearsamppTools;
 
        return $bearsamppLang->getValue(Lang::PYTHON) . ' ' . $bearsamppTools->getPython()->getVersion();
    }

References $bearsamppLang, and Lang\PYTHON.

getTabTitleRuby()

getTabTitleRuby

(

)

Gets the tab title for Ruby.

Returns

string The tab title for Ruby.

Definition at line 339 of file class.tool.powershell.php.

    {
        global $bearsamppLang, $bearsamppTools;
 
        return $bearsamppLang->getValue(Lang::RUBY) . ' ' . $bearsamppTools->getRuby()->getVersion();
    }

References $bearsamppLang, and Lang\RUBY.

reload()

reload	(		$id = null,
			$type = null )

Reloads the configuration for the PowerShell tool.

Parameters

string | null	$id	The ID of the module. If null, the current ID is used.
string | null	$type	The type of the module. If null, the current type is used.

Reimplemented from Module.

Definition at line 83 of file class.tool.powershell.php.

    {
        global $bearsamppConfig, $bearsamppLang;
        Log::reloadClass($this);
 
        $this->name    = $bearsamppLang->getValue(Lang::POWERSHELL);
        $this->version = $bearsamppConfig->getRaw(self::ROOT_CFG_VERSION);
        parent::reload($id, $type);
 
        if ($this->bearsamppConfRaw !== false) {
            $this->exe       = $this->symlinkPath . '/' . $this->bearsamppConfRaw[self::LOCAL_CFG_EXE];
            $this->launchExe = $this->symlinkPath . '/' . $this->bearsamppConfRaw[self::LOCAL_CFG_LAUNCH_EXE];
            $this->conf      = $this->symlinkPath . '/' . $this->bearsamppConfRaw[self::LOCAL_CFG_CONF];
            $this->rows      = intval($this->bearsamppConfRaw[self::LOCAL_CFG_ROWS]);
            $this->cols      = intval($this->bearsamppConfRaw[self::LOCAL_CFG_COLS]);
        }
 
        if (!$this->enable) {
            Log::info($this->name . ' is not enabled!');
 
            return;
        }
        if (!is_dir($this->currentPath)) {
            Log::error(sprintf($bearsamppLang->getValue(Lang::ERROR_FILE_NOT_FOUND), $this->name . ' ' . $this->version, $this->currentPath));
        }
        if (!is_dir($this->symlinkPath)) {
            Log::error(sprintf($bearsamppLang->getValue(Lang::ERROR_FILE_NOT_FOUND), $this->name . ' ' . $this->version, $this->symlinkPath));
 
            return;
        }
        if (!is_file($this->bearsamppConf)) {
            Log::error(sprintf($bearsamppLang->getValue(Lang::ERROR_CONF_NOT_FOUND), $this->name . ' ' . $this->version, $this->bearsamppConf));
        }
        if (!is_file($this->exe)) {
            Log::error(sprintf($bearsamppLang->getValue(Lang::ERROR_EXE_NOT_FOUND), $this->name . ' ' . $this->version, $this->exe));
        }
        if (!is_file($this->launchExe)) {
            Log::error(sprintf($bearsamppLang->getValue(Lang::ERROR_EXE_NOT_FOUND), $this->name . ' ' . $this->version, $this->launchExe));
        }
        if (!is_file($this->conf)) {
            Log::error(sprintf($bearsamppLang->getValue(Lang::ERROR_CONF_NOT_FOUND), $this->name . ' ' . $this->version, $this->conf));
        }
        if (!is_numeric($this->rows) || $this->rows <= 0) {
            Log::error(sprintf($bearsamppLang->getValue(Lang::ERROR_INVALID_PARAMETER), self::LOCAL_CFG_ROWS, $this->rows));
        }
        if (!is_numeric($this->cols) || $this->cols <= 0) {
            Log::error(sprintf($bearsamppLang->getValue(Lang::ERROR_INVALID_PARAMETER), self::LOCAL_CFG_COLS, $this->cols));
        }
    }

References $bearsamppConfig, $bearsamppLang, Module\$id, Module\$type, Log\error(), Lang\ERROR_CONF_NOT_FOUND, Lang\ERROR_EXE_NOT_FOUND, Lang\ERROR_FILE_NOT_FOUND, Lang\ERROR_INVALID_PARAMETER, Log\info(), Lang\POWERSHELL, and Log\reloadClass().

Referenced by __construct(), and setVersion().

Here is the call graph for this function:

Here is the caller graph for this function:

setVersion()

setVersion

(

$version

)

Sets the version of the PowerShell tool.

Parameters

string

$version

The version to set.

Reimplemented from Module.

Definition at line 138 of file class.tool.powershell.php.

    {
        global $bearsamppConfig;
        $this->version = $version;
        $bearsamppConfig->replace(self::ROOT_CFG_VERSION, $version);
        $this->reload();
    }

References $bearsamppConfig, Module\$version, and reload().

Here is the call graph for this function:

Field Documentation

$cols

$cols

private

Definition at line 63 of file class.tool.powershell.php.

Referenced by getCols().

$conf

$conf

private

Definition at line 55 of file class.tool.powershell.php.

Referenced by getConf().

$exe

$exe

private

Definition at line 47 of file class.tool.powershell.php.

Referenced by getExe().

$launchExe

$launchExe

private

Definition at line 51 of file class.tool.powershell.php.

Referenced by getLaunchExe().

$rows

$rows

private

Definition at line 59 of file class.tool.powershell.php.

Referenced by getRows().

LOCAL_CFG_COLS

const LOCAL_CFG_COLS = 'powershellCols'

Configuration key for the PowerShell window columns in the local configuration.

Definition at line 42 of file class.tool.powershell.php.

LOCAL_CFG_CONF

const LOCAL_CFG_CONF = 'powershellConf'

Configuration key for the PowerShell configuration file in the local configuration.

Definition at line 30 of file class.tool.powershell.php.

LOCAL_CFG_EXE

const LOCAL_CFG_EXE = 'powershellExe'

Configuration key for the PowerShell executable in the local configuration.

Definition at line 26 of file class.tool.powershell.php.

LOCAL_CFG_LAUNCH_EXE

const LOCAL_CFG_LAUNCH_EXE = 'powershellLaunchExe'

Configuration key for the PowerShell launch executable in the local configuration.

Definition at line 34 of file class.tool.powershell.php.

LOCAL_CFG_ROWS

const LOCAL_CFG_ROWS = 'powershellRows'

Configuration key for the PowerShell window rows in the local configuration.

Definition at line 38 of file class.tool.powershell.php.

ROOT_CFG_VERSION

const ROOT_CFG_VERSION = 'powershellVersion'

Configuration key for the PowerShell version in the root configuration.

Definition at line 21 of file class.tool.powershell.php.

---

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

• E:/Bearsampp-development/sandbox/core/classes/tools/class.tool.powershell.php