Static Public Member Functions
static	process ()

Data Fields
const	ICON_APP = 'app.ico'

const	ICON_COMPOSER = 'composer.ico'

const	ICON_DB = 'db.ico'

const	ICON_GHOSTSCRIPT = 'ghostscript.ico'

const	ICON_GIT = 'git.ico'

const	ICON_NGROK = 'ngrok.ico'

const	ICON_NODEJS = 'nodejs.ico'

const	ICON_PEAR = 'pear.ico'

const	ICON_PERL = 'perl.ico'

const	ICON_POWERSHELL = 'powershell.ico'

const	ICON_PYTHON = 'python.ico'

const	ICON_RUBY = 'ruby.ico'

const	ICON_YARN = 'yarn.ico'

Private Member Functions
	__construct ()

Static Private Member Functions
static	getAppearanceSection ()

static	getBehaviorSection ()

static	getConsoleSection ()

static	getHotkeysSection ()

static	getIncrStr ($size=1)

static	getMouseSection ()

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 ()

static	getTabYarnSection ()

Detailed Description

Class TplConsoleZ

This class is responsible for generating the configuration file for ConsoleZ. It includes methods to define various sections of the configuration such as console settings, appearance, behavior, hotkeys, mouse actions, and tabs.

Definition at line 17 of file class.tpl.consolez.php.

Constructor & Destructor Documentation

◆ __construct()

TplConsoleZ::__construct ( )

private

Private constructor to prevent instantiation.

Definition at line 36 of file class.tpl.consolez.php.

37 {

38 }

Member Function Documentation

◆ getAppearanceSection()

static TplConsoleZ::getAppearanceSection ( )

staticprivate

Generates the XML section for appearance settings.

This method constructs the XML string for the appearance settings of the ConsoleZ configuration. It includes settings for font, window properties, controls, styles, position, and transparency.

Returns: string The XML string representing the appearance settings.

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

    {
        $sectionFont = self::getIncrStr(2) . '<font name="Courier New" size="10" bold="0" italic="0" smoothing="0">' . PHP_EOL .
            self::getIncrStr(3) . '<color use="0" r="0" g="255" b="0"/>' . PHP_EOL .
            self::getIncrStr(2) . '</font>';
 
        $windowSection = self::getIncrStr(2) . '<window ' .
            'title="ConsoleZ" ' .
            'icon="" ' .
            'use_tab_icon="1" ' .
            'use_console_title="0" ' .
            'show_cmd="0" ' .
            'show_cmd_tabs="0" ' .
            'use_tab_title="1" ' .
            'trim_tab_titles="20" ' .
            'trim_tab_titles_right="0"/>';
 
        $controlsSection = self::getIncrStr(2) . '<controls ' .
            'show_menu="0" ' .
            'show_toolbar="1" ' .
            'show_statusbar="1" ' .
            'show_tabs="1" ' .
            'hide_single_tab="1" ' .
            'show_scrollbars="1" ' .
            'flat_scrollbars="0" ' .
            'tabs_on_bottom="0"/>';
 
        $stylesSection = self::getIncrStr(2) . '<styles caption="1" resizable="1" taskbar_button="1" border="1" inside_border="2" tray_icon="0">' . PHP_EOL .
            self::getIncrStr(3) . '<selection_color r="255" g="255" b="255"/>' . PHP_EOL .
            self::getIncrStr(2) . '</styles>';
 
        $positionSection = self::getIncrStr(2) . '<divosition ' .
            'x="-1" ' .
            'y="-1" ' .
            'dock="-1" ' .
            'snap="0" ' .
            'z_order="0" ' .
            'save_position="0"/>';
 
        $transparencySection = self::getIncrStr(2) . '<transparency ' .
            'type="1" ' .
            'active_alpha="240" ' .
            'inactive_alpha="225" ' .
            'r="0" ' .
            'g="0" ' .
            'b="0"/>';
 
        return self::getIncrStr(1) . '<appearance>' . PHP_EOL .
            $sectionFont . PHP_EOL .
            $windowSection . PHP_EOL .
            $controlsSection . PHP_EOL .
            $stylesSection . PHP_EOL .
            $positionSection . PHP_EOL .
            $transparencySection . PHP_EOL .
            self::getIncrStr(1) . '</appearance>';
    }

References getIncrStr().

Referenced by process().

Here is the caller graph for this function:

◆ getBehaviorSection()

static TplConsoleZ::getBehaviorSection ( )

staticprivate

Generates the XML section for behavior settings.

This method constructs the XML string for the behavior settings of the ConsoleZ configuration. It includes settings for copy-paste behavior, scroll behavior, and tab highlight behavior.

Returns: string The XML string representing the behavior settings.

Definition at line 183 of file class.tpl.consolez.php.

    {
        $sectionCopyPaste = self::getIncrStr(2) . '<copy_paste ' .
            'copy_on_select="0" ' .
            'clear_on_copy="1" ' .
            'no_wrap="1" ' .
            'trim_spaces="1" ' .
            'copy_newline_char="0" ' .
            'sensitive_copy="1"/>';
 
        $sectionScroll = self::getIncrStr(2) . '<scroll page_scroll_rows="0"/>';
 
        $sectionTabHighlight = self::getIncrStr(2) . '<tab_highlight flashes="3" stay_highligted="1"/>';
 
        return self::getIncrStr(1) . '<behavior>' . PHP_EOL .
            $sectionCopyPaste . PHP_EOL .
            $sectionScroll . PHP_EOL .
            $sectionTabHighlight . PHP_EOL .
            self::getIncrStr(1) . '</behavior>';
    }

References getIncrStr().

Referenced by process().

Here is the caller graph for this function:

◆ getConsoleSection()

static TplConsoleZ::getConsoleSection ( )

staticprivate

Generates the XML section for console settings.

This method constructs the XML string for the console settings of the ConsoleZ configuration. It includes settings for refresh rates, buffer sizes, and initial directory.

Returns: string The XML string representing the console settings.

Definition at line 70 of file class.tpl.consolez.php.

    {
        global $bearsamppRoot, $bearsamppTools;
 
        $sectionConsoleStart = self::getIncrStr(1) . '<console ' .
            'change_refresh="10" ' .
            'refresh="100" ' .
            'rows="' . $bearsamppTools->getConsoleZ()->getRows() . '" ' .
            'columns="' . $bearsamppTools->getConsoleZ()->getCols() . '" ' .
            'buffer_rows="2048" ' .
            'buffer_columns="0" ' .
            'shell="" ' .
            'init_dir="' . $bearsamppRoot->getRootPath() . '" ' .
            'start_hidden="0" ' .
            'save_size="0">' . PHP_EOL;
 
        $sectionColors = self::getIncrStr(2) . '<colors>' . PHP_EOL .
            self::getIncrStr(3) . '<color id="0" r="39" g="40" b="34"/>' . PHP_EOL .
            self::getIncrStr(3) . '<color id="1" r="88" g="194" b="229"/>' . PHP_EOL .
            self::getIncrStr(3) . '<color id="2" r="88" g="194" b="229"/>' . PHP_EOL .
            self::getIncrStr(3) . '<color id="3" r="198" g="197" b="254"/>' . PHP_EOL .
            self::getIncrStr(3) . '<color id="4" r="168" g="125" b="184"/>' . PHP_EOL .
            self::getIncrStr(3) . '<color id="5" r="243" g="4" b="75"/>' . PHP_EOL .
            self::getIncrStr(3) . '<color id="6" r="243" g="4" b="75"/>' . PHP_EOL .
            self::getIncrStr(3) . '<color id="7" r="238" g="238" b="238"/>' . PHP_EOL .
            self::getIncrStr(3) . '<color id="8" r="124" g="124" b="124"/>' . PHP_EOL .
            self::getIncrStr(3) . '<color id="9" r="3" g="131" b="245"/>' . PHP_EOL .
            self::getIncrStr(3) . '<color id="10" r="141" g="208" b="6"/>' . PHP_EOL .
            self::getIncrStr(3) . '<color id="11" r="88" g="194" b="229"/>' . PHP_EOL .
            self::getIncrStr(3) . '<color id="12" r="168" g="125" b="184"/>' . PHP_EOL .
            self::getIncrStr(3) . '<color id="13" r="243" g="4" b="75"/>' . PHP_EOL .
            self::getIncrStr(3) . '<color id="14" r="204" g="204" b="129"/>' . PHP_EOL .
            self::getIncrStr(3) . '<color id="15" r="255" g="255" b="255"/>' . PHP_EOL .
            self::getIncrStr(2) . '</colors>' . PHP_EOL;
 
        $sectionConsoleEnd = self::getIncrStr(1) . '</console>';
 
        return $sectionConsoleStart . $sectionColors . $sectionConsoleEnd;
    }

References $bearsamppRoot, and getIncrStr().

Referenced by process().

Here is the caller graph for this function:

◆ getHotkeysSection()

static TplConsoleZ::getHotkeysSection ( )

staticprivate

Generates the XML section for hotkeys settings.

This method constructs the XML string for the hotkeys settings of the ConsoleZ configuration. It includes settings for various hotkey combinations and their corresponding commands.

Returns: string The XML string representing the hotkeys settings.

Definition at line 212 of file class.tpl.consolez.php.

    {
        return self::getIncrStr(1) . '<hotkeys use_scroll_lock="0">' . PHP_EOL .
            self::getIncrStr(2) . '<hotkey ctrl="1" shift="0" alt="0" extended="0" code="83" command="settings"/>' . PHP_EOL .
            self::getIncrStr(2) . '<hotkey ctrl="0" shift="0" alt="0" extended="0" code="112" command="help"/>' . PHP_EOL .
            self::getIncrStr(2) . '<hotkey ctrl="0" shift="0" alt="1" extended="0" code="115" command="exit"/>' . PHP_EOL .
            self::getIncrStr(2) . '<hotkey ctrl="1" shift="0" alt="0" extended="0" code="112" command="newtab1"/>' . PHP_EOL .
            self::getIncrStr(2) . '<hotkey ctrl="1" shift="0" alt="0" extended="0" code="113" command="newtab2"/>' . PHP_EOL .
            self::getIncrStr(2) . '<hotkey ctrl="1" shift="0" alt="0" extended="0" code="114" command="newtab3"/>' . PHP_EOL .
            self::getIncrStr(2) . '<hotkey ctrl="1" shift="0" alt="0" extended="0" code="115" command="newtab4"/>' . PHP_EOL .
            self::getIncrStr(2) . '<hotkey ctrl="1" shift="0" alt="0" extended="0" code="116" command="newtab5"/>' . PHP_EOL .
            self::getIncrStr(2) . '<hotkey ctrl="1" shift="0" alt="0" extended="0" code="117" command="newtab6"/>' . PHP_EOL .
            self::getIncrStr(2) . '<hotkey ctrl="1" shift="0" alt="0" extended="0" code="118" command="newtab7"/>' . PHP_EOL .
            self::getIncrStr(2) . '<hotkey ctrl="1" shift="0" alt="0" extended="0" code="119" command="newtab8"/>' . PHP_EOL .
            self::getIncrStr(2) . '<hotkey ctrl="1" shift="0" alt="0" extended="0" code="120" command="newtab9"/>' . PHP_EOL .
            self::getIncrStr(2) . '<hotkey ctrl="1" shift="0" alt="0" extended="0" code="121" command="newtab10"/>' . PHP_EOL .
            self::getIncrStr(2) . '<hotkey ctrl="1" shift="0" alt="0" extended="0" code="49" command="switchtab1"/>' . PHP_EOL .
            self::getIncrStr(2) . '<hotkey ctrl="1" shift="0" alt="0" extended="0" code="50" command="switchtab2"/>' . PHP_EOL .
            self::getIncrStr(2) . '<hotkey ctrl="1" shift="0" alt="0" extended="0" code="51" command="switchtab3"/>' . PHP_EOL .
            self::getIncrStr(2) . '<hotkey ctrl="1" shift="0" alt="0" extended="0" code="52" command="switchtab4"/>' . PHP_EOL .
            self::getIncrStr(2) . '<hotkey ctrl="1" shift="0" alt="0" extended="0" code="53" command="switchtab5"/>' . PHP_EOL .
            self::getIncrStr(2) . '<hotkey ctrl="1" shift="0" alt="0" extended="0" code="54" command="switchtab6"/>' . PHP_EOL .
            self::getIncrStr(2) . '<hotkey ctrl="1" shift="0" alt="0" extended="0" code="55" command="switchtab7"/>' . PHP_EOL .
            self::getIncrStr(2) . '<hotkey ctrl="1" shift="0" alt="0" extended="0" code="56" command="switchtab8"/>' . PHP_EOL .
            self::getIncrStr(2) . '<hotkey ctrl="1" shift="0" alt="0" extended="0" code="57" command="switchtab9"/>' . PHP_EOL .
            self::getIncrStr(2) . '<hotkey ctrl="1" shift="0" alt="0" extended="0" code="48" command="switchtab10"/>' . PHP_EOL .
            self::getIncrStr(2) . '<hotkey ctrl="1" shift="0" alt="0" extended="0" code="9" command="nexttab"/>' . PHP_EOL .
            self::getIncrStr(2) . '<hotkey ctrl="1" shift="1" alt="0" extended="0" code="9" command="prevtab"/>' . PHP_EOL .
            self::getIncrStr(2) . '<hotkey ctrl="1" shift="0" alt="0" extended="0" code="87" command="closetab"/>' . PHP_EOL .
            self::getIncrStr(2) . '<hotkey ctrl="1" shift="0" alt="0" extended="0" code="82" command="renametab"/>' . PHP_EOL .
            self::getIncrStr(2) . '<hotkey ctrl="1" shift="0" alt="0" extended="1" code="45" command="copy"/>' . PHP_EOL .
            self::getIncrStr(2) . '<hotkey ctrl="1" shift="0" alt="0" extended="1" code="46" command="clear_selection"/>' . PHP_EOL .
            self::getIncrStr(2) . '<hotkey ctrl="0" shift="1" alt="0" extended="1" code="45" command="paste"/>' . PHP_EOL .
            self::getIncrStr(2) . '<hotkey ctrl="0" shift="0" alt="0" extended="0" code="0" command="stopscroll"/>' . PHP_EOL .
            self::getIncrStr(2) . '<hotkey ctrl="0" shift="0" alt="0" extended="0" code="0" command="scrollrowup"/>' . PHP_EOL .
            self::getIncrStr(2) . '<hotkey ctrl="0" shift="0" alt="0" extended="0" code="0" command="scrollrowdown"/>' . PHP_EOL .
            self::getIncrStr(2) . '<hotkey ctrl="0" shift="0" alt="0" extended="0" code="0" command="scrollpageup"/>' . PHP_EOL .
            self::getIncrStr(2) . '<hotkey ctrl="0" shift="0" alt="0" extended="0" code="0" command="scrollpagedown"/>' . PHP_EOL .
            self::getIncrStr(2) . '<hotkey ctrl="0" shift="0" alt="0" extended="0" code="0" command="scrollcolleft"/>' . PHP_EOL .
            self::getIncrStr(2) . '<hotkey ctrl="0" shift="0" alt="0" extended="0" code="0" command="scrollcolright"/>' . PHP_EOL .
            self::getIncrStr(2) . '<hotkey ctrl="0" shift="0" alt="0" extended="0" code="0" command="scrollpageleft"/>' . PHP_EOL .
            self::getIncrStr(2) . '<hotkey ctrl="0" shift="0" alt="0" extended="0" code="0" command="scrollpageright"/>' . PHP_EOL .
            self::getIncrStr(2) . '<hotkey ctrl="1" shift="1" alt="0" extended="0" code="112" command="dumpbuffer"/>' . PHP_EOL .
            self::getIncrStr(2) . '<hotkey ctrl="0" shift="0" alt="0" extended="0" code="0" command="activate"/>' . PHP_EOL .
            self::getIncrStr(1) . '</hotkeys>';
    }

References getIncrStr().

Referenced by process().

Here is the caller graph for this function:

◆ getIncrStr()

static TplConsoleZ::getIncrStr ( $size = 1 )

staticprivate

Generates a string of incremented tabs.

This function constructs a string consisting of a specified number of tab characters.

Parameters

int $size The number of tabs to include in the string.

Returns: string The string of incremented tabs.

Definition at line 774 of file class.tpl.consolez.php.

    {
        $result = '';
        for ($i = 0; $i <= $size; $i++) {
            $result .= RETURN_TAB;
        }
        return $result;
    }

References $result, and RETURN_TAB.

Referenced by getAppearanceSection(), getBehaviorSection(), getConsoleSection(), getHotkeysSection(), getMouseSection(), getTab(), and getTabsSection().

Here is the caller graph for this function:

◆ getMouseSection()

static TplConsoleZ::getMouseSection ( )

staticprivate

Generates the XML structure for the mouse section.

This function creates an XML structure defining mouse actions and their corresponding key combinations. It uses the getIncrStr method to format the XML with appropriate indentation.

Returns: string The formatted XML string for the mouse section.

Definition at line 268 of file class.tpl.consolez.php.

    {
        return self::getIncrStr(1) . '<mouse>' . PHP_EOL .
            self::getIncrStr(2) . '<actions>' . PHP_EOL .
            self::getIncrStr(3) . '<action ctrl="0" shift="0" alt="0" button="1" name="copy"/>' . PHP_EOL .
            self::getIncrStr(3) . '<action ctrl="0" shift="1" alt="0" button="1" name="select"/>' . PHP_EOL .
            self::getIncrStr(3) . '<action ctrl="0" shift="0" alt="0" button="3" name="paste"/>' . PHP_EOL .
            self::getIncrStr(3) . '<action ctrl="1" shift="0" alt="0" button="1" name="drag"/>' . PHP_EOL .
            self::getIncrStr(3) . '<action ctrl="0" shift="0" alt="0" button="2" name="menu"/>' . PHP_EOL .
            self::getIncrStr(2) . '</actions>' . PHP_EOL .
            self::getIncrStr(1) . '</mouse>';
    }

References getIncrStr().

Referenced by process().

Here is the caller graph for this function:

◆ getTab()

static TplConsoleZ::getTab	(	$title,
		$icon,
		$shell,
		$initDir )

staticprivate

Generates the HTML structure for a tab in the console.

This function constructs the HTML structure for a tab, including the title, icon, shell command, initial directory, cursor style, and background settings.

Parameters

string	$title	The title of the tab.
string	$icon	The icon for the tab.
string	$shell	The shell command to be executed in the tab.
string	$initDir	The initial directory for the tab.

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

Definition at line 752 of file class.tpl.consolez.php.

    {
        global $bearsamppCore;
        return self::getIncrStr(2) . '<tab title="' . $title . '" icon="' . $bearsamppCore->getIconsPath(false) . '/' . $icon . '" use_default_icon="0">' . PHP_EOL .
            self::getIncrStr(3) . '<console shell="' . $shell . '" init_dir="' . $initDir . '" run_as_user="0" user=""/>' . PHP_EOL .
            self::getIncrStr(3) . '<cursor style="0" r="255" g="255" b="255"/>' . PHP_EOL .
            self::getIncrStr(3) . '<background type="0" r="0" g="0" b="0">' . PHP_EOL .
            self::getIncrStr(4) . '<image file="" relative="0" extend="0" position="0">' . PHP_EOL .
            self::getIncrStr(5) . '<tint opacity="0" r="0" g="0" b="0"/>' . PHP_EOL .
            self::getIncrStr(4) . '</image>' . PHP_EOL .
            self::getIncrStr(3) . '</background>' . PHP_EOL .
            self::getIncrStr(2) . '</tab>';
    }

References $bearsamppCore, and getIncrStr().

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

Here is the caller graph for this function:

◆ getTabCmdSection()

static TplConsoleZ::getTabCmdSection ( )

staticprivate

Generates the XML structure for the command tab section.

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

Returns: string The formatted XML 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 322 of file class.tpl.consolez.php.

    {
        global $bearsamppRoot, $bearsamppTools;
 
        return self::getTab(
                $bearsamppTools->getConsoleZ()->getTabTitleDefault(),
                self::ICON_APP,
                $bearsamppTools->getConsoleZ()->getShell(),
                $bearsamppRoot->getRootPath()
            ) . PHP_EOL;
    }

References $bearsamppRoot, and getTab().

Referenced by getTabsSection().

Here is the caller graph for this function:

◆ getTabComposerSection()

static TplConsoleZ::getTabComposerSection ( )

staticprivate

Generates the XML structure for the Composer tab section.

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

Returns: string The formatted XML 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 550 of file class.tpl.consolez.php.

    {
        global $bearsamppRoot, $bearsamppTools;
 
        $shell = $bearsamppTools->getConsoleZ()->getShell('&quot;' . $bearsamppTools->getComposer()->getExe() . '&quot; -V');
        if (!file_exists($bearsamppTools->getComposer()->getExe())) {
            $shell = $bearsamppTools->getConsoleZ()->getShell('echo ' . $bearsamppTools->getComposer()->getExe() . ' not found');
        }
 
        return self::getTab(
                $bearsamppTools->getConsoleZ()->getTabTitleComposer(),
                self::ICON_COMPOSER,
                $shell,
                $bearsamppRoot->getWwwPath()
            ) . PHP_EOL;
    }

References $bearsamppRoot, and getTab().

Referenced by getTabsSection().

Here is the caller graph for this function:

◆ getTabGhostscriptSection()

static TplConsoleZ::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 HTML 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 692 of file class.tpl.consolez.php.

    {
        global $bearsamppRoot, $bearsamppTools;
 
        $shell = $bearsamppTools->getConsoleZ()->getShell('&quot;' . $bearsamppTools->getGhostscript()->getExeConsole() . '&quot; -v');
        if (!file_exists($bearsamppTools->getGhostscript()->getExeConsole())) {
            $shell = $bearsamppTools->getConsoleZ()->getShell('echo ' . $bearsamppTools->getGhostscript()->getExeConsole() . ' not found');
        }
 
        return self::getTab(
                $bearsamppTools->getConsoleZ()->getTabTitleGhostscript(),
                self::ICON_GHOSTSCRIPT,
                $shell,
                $bearsamppRoot->getWwwPath()
            ) . PHP_EOL;
    }

References $bearsamppRoot, and getTab().

Referenced by getTabsSection().

Here is the caller graph for this function:

◆ getTabGitSection()

static TplConsoleZ::getTabGitSection ( )

staticprivate

Generates the XML structure for the Git tab section.

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

Returns: string The formatted XML 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 493 of file class.tpl.consolez.php.

    {
        global $bearsamppRoot, $bearsamppTools;
 
        $shell = $bearsamppTools->getConsoleZ()->getShell('&quot;' . $bearsamppTools->getGit()->getExe() . '&quot; --version');
        if (!file_exists($bearsamppTools->getGit()->getExe())) {
            $shell = $bearsamppTools->getConsoleZ()->getShell('echo ' . $bearsamppTools->getGit()->getExe() . ' not found');
        }
 
        return self::getTab(
                $bearsamppTools->getConsoleZ()->getTabTitleGit(),
                self::ICON_GIT,
                $shell,
                $bearsamppRoot->getWwwPath()
            ) . PHP_EOL;
    }

References $bearsamppRoot, and getTab().

Referenced by getTabsSection().

Here is the caller graph for this function:

◆ getTabMariadbSection()

static TplConsoleZ::getTabMariadbSection ( )

staticprivate

Generates the XML structure for the MariaDB tab section.

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

Returns: string The formatted XML 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 431 of file class.tpl.consolez.php.

    {
        global $bearsamppBins, $bearsamppTools;
 
        $shell = $bearsamppTools->getConsoleZ()->getShell('&quot;' . $bearsamppBins->getMariadb()->getCliExe() . '&quot; -u' .
            $bearsamppBins->getMariadb()->getRootUser() .
            ($bearsamppBins->getMariadb()->getRootPwd() ? ' -p' : ''));
        if (!file_exists($bearsamppBins->getMariadb()->getCliExe())) {
            $shell = $bearsamppTools->getConsoleZ()->getShell('echo ' . $bearsamppBins->getMariadb()->getCliExe() . ' not found');
        }
 
        return self::getTab(
                $bearsamppTools->getConsoleZ()->getTabTitleMariadb(),
                self::ICON_DB,
                $shell,
                $bearsamppBins->getMariadb()->getSymlinkPath()
            ) . PHP_EOL;
    }

References $bearsamppBins, and getTab().

Referenced by getTabsSection().

Here is the caller graph for this function:

◆ getTabMysqlSection()

static TplConsoleZ::getTabMysqlSection ( )

staticprivate

Generates the XML structure for the MySQL tab section.

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

Returns: string The formatted XML 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 401 of file class.tpl.consolez.php.

    {
        global $bearsamppBins, $bearsamppTools;
 
        $shell = $bearsamppTools->getConsoleZ()->getShell('&quot;' . $bearsamppBins->getMysql()->getCliExe() . '&quot; -u' .
            $bearsamppBins->getMysql()->getRootUser() .
            ($bearsamppBins->getMysql()->getRootPwd() ? ' -p' : ''));
        if (!file_exists($bearsamppBins->getMysql()->getCliExe())) {
            $shell = $bearsamppTools->getConsoleZ()->getShell('echo ' . $bearsamppBins->getMysql()->getCliExe() . ' not found');
        }
 
        return self::getTab(
                $bearsamppTools->getConsoleZ()->getTabTitleMysql(),
                self::ICON_DB,
                $shell,
                $bearsamppBins->getMysql()->getSymlinkPath()
            ) . PHP_EOL;
    }

References $bearsamppBins, and getTab().

Referenced by getTabsSection().

Here is the caller graph for this function:

◆ getTabNgrokSection()

static TplConsoleZ::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 HTML 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 722 of file class.tpl.consolez.php.

    {
        global $bearsamppRoot, $bearsamppTools;
 
        $shell = $bearsamppTools->getConsoleZ()->getShell('&quot;' . $bearsamppTools->getNgrok()->getExe() . '&quot; version');
        if (!file_exists($bearsamppTools->getNgrok()->getExe())) {
            $shell = $bearsamppTools->getConsoleZ()->getShell('echo ' . $bearsamppTools->getNgrok()->getExe() . ' not found');
        }
 
        return self::getTab(
                $bearsamppTools->getConsoleZ()->getTabTitleNgrok(),
                self::ICON_NGROK,
                $shell,
                $bearsamppRoot->getWwwPath()
            ) . PHP_EOL;
    }

References $bearsamppRoot, and getTab().

Referenced by getTabsSection().

Here is the caller graph for this function:

◆ getTabNodejsSection()

static TplConsoleZ::getTabNodejsSection ( )

staticprivate

Generates the XML structure for the Node.js tab section.

This function creates an XML 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 XML 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 522 of file class.tpl.consolez.php.

    {
        global $bearsamppRoot, $bearsamppBins, $bearsamppTools;
 
        $shell = $bearsamppTools->getConsoleZ()->getShell('&quot;' . $bearsamppBins->getNodejs()->getLaunch() . '&quot;');
        if (!file_exists($bearsamppBins->getNodejs()->getLaunch())) {
            $shell = $bearsamppTools->getConsoleZ()->getShell('echo ' . $bearsamppBins->getNodejs()->getLaunch() . ' not found');
        }
 
        return self::getTab(
                $bearsamppTools->getConsoleZ()->getTabTitleNodejs(),
                self::ICON_NODEJS,
                $shell,
                $bearsamppRoot->getWwwPath()
            ) . PHP_EOL;
    }

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

Referenced by getTabsSection().

Here is the caller graph for this function:

◆ getTabPearSection()

static TplConsoleZ::getTabPearSection ( )

staticprivate

Generates the XML structure for the PEAR tab section.

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

Returns: string The formatted XML 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 373 of file class.tpl.consolez.php.

    {
        global $bearsamppBins, $bearsamppTools;
 
        $shell = $bearsamppTools->getConsoleZ()->getShell('&quot;' . $bearsamppBins->getPhp()->getPearExe() . '&quot; -V');
        if (!file_exists($bearsamppBins->getPhp()->getPearExe())) {
            $shell = $bearsamppTools->getConsoleZ()->getShell('echo ' . $bearsamppBins->getPhp()->getPearExe() . ' not found');
        }
 
        return self::getTab(
                $bearsamppTools->getConsoleZ()->getTabTitlePear(),
                self::ICON_PEAR,
                $shell,
                $bearsamppBins->getPhp()->getSymlinkPath() . '/pear'
            ) . PHP_EOL;
    }

References $bearsamppBins, and getTab().

Referenced by getTabsSection().

Here is the caller graph for this function:

◆ getTabPerlSection()

static TplConsoleZ::getTabPerlSection ( )

staticprivate

Generates the XML structure for the Perl tab section.

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

Returns: string The formatted XML 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 662 of file class.tpl.consolez.php.

    {
        global $bearsamppRoot, $bearsamppTools;
 
        $shell = $bearsamppTools->getConsoleZ()->getShell('&quot;' . $bearsamppTools->getPerl()->getExe() . '&quot; -v');
        if (!file_exists($bearsamppTools->getPerl()->getExe())) {
            $shell = $bearsamppTools->getConsoleZ()->getShell('echo ' . $bearsamppTools->getPerl()->getExe() . ' not found');
        }
 
        return self::getTab(
                $bearsamppTools->getConsoleZ()->getTabTitlePerl(),
                self::ICON_PERL,
                $shell,
                $bearsamppRoot->getWwwPath()
            ) . PHP_EOL;
    }

References $bearsamppRoot, and getTab().

Referenced by getTabsSection().

Here is the caller graph for this function:

◆ getTabPostgresqlSection()

static TplConsoleZ::getTabPostgresqlSection ( )

staticprivate

Generates the XML structure for the PostgreSQL tab section.

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

Returns: string The formatted XML 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 461 of file class.tpl.consolez.php.

    {
        global $bearsamppBins, $bearsamppTools;
 
        $shell = $bearsamppTools->getConsoleZ()->getShell('&quot;' . $bearsamppBins->getPostgresql()->getCliExe() . '&quot;' .
            ' -h 127.0.0.1' .
            ' -p ' . $bearsamppBins->getPostgresql()->getPort() .
            ' -U ' . $bearsamppBins->getPostgresql()->getRootUser() .
            ' -d postgres');
        if (!file_exists($bearsamppBins->getPostgresql()->getCliExe())) {
            $shell = $bearsamppTools->getConsoleZ()->getShell('echo ' . $bearsamppBins->getPostgresql()->getCliExe() . ' not found');
        }
 
        return self::getTab(
                $bearsamppTools->getConsoleZ()->getTabTitlePostgresql(),
                self::ICON_DB,
                $shell,
                $bearsamppBins->getPostgresql()->getSymlinkPath()
            ) . PHP_EOL;
    }

References $bearsamppBins, and getTab().

Referenced by getTabsSection().

Here is the caller graph for this function:

◆ getTabPowerShellSection()

static TplConsoleZ::getTabPowerShellSection ( )

staticprivate

Generates the XML structure for the PowerShell tab section.

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

Returns: string The formatted XML 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 345 of file class.tpl.consolez.php.

    {
        global $bearsamppRoot, $bearsamppTools;
 
        $powerShellPath = Util::getPowerShellPath();
        if ($powerShellPath !== false) {
            return self::getTab(
                    $bearsamppTools->getConsoleZ()->getTabTitlePowershell(),
                    self::ICON_POWERSHELL,
                    $powerShellPath,
                    $bearsamppRoot->getRootPath()
                ) . PHP_EOL;
        }
 
        return "";
    }

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

Referenced by getTabsSection().

Here is the caller graph for this function:

◆ getTabPythonSection()

static TplConsoleZ::getTabPythonSection ( )

staticprivate

Generates the XML structure for the Python tab section.

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

Returns: string The formatted XML 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 578 of file class.tpl.consolez.php.

    {
        global $bearsamppRoot, $bearsamppTools;
 
        $shell = $bearsamppTools->getConsoleZ()->getShell('&quot;' . $bearsamppTools->getPython()->getExe() . '&quot; -V');
        if (!file_exists($bearsamppTools->getPython()->getExe())) {
            $shell = $bearsamppTools->getConsoleZ()->getShell('echo ' . $bearsamppTools->getPython()->getExe() . ' not found');
        }
 
        return self::getTab(
                $bearsamppTools->getConsoleZ()->getTabTitlePython(),
                self::ICON_PYTHON,
                $shell,
                $bearsamppRoot->getWwwPath()
            ) . PHP_EOL;
    }

References $bearsamppRoot, and getTab().

Referenced by getTabsSection().

Here is the caller graph for this function:

◆ getTabRubySection()

static TplConsoleZ::getTabRubySection ( )

staticprivate

Generates the XML structure for the Ruby tab section.

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

Returns: string The formatted XML 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 606 of file class.tpl.consolez.php.

    {
        global $bearsamppRoot, $bearsamppTools;
 
        $shell = $bearsamppTools->getConsoleZ()->getShell('&quot;' . $bearsamppTools->getRuby()->getExe() . '&quot; -v');
        if (!file_exists($bearsamppTools->getRuby()->getExe())) {
            $shell = $bearsamppTools->getConsoleZ()->getShell('echo ' . $bearsamppTools->getRuby()->getExe() . ' not found');
        }
 
        return self::getTab(
                $bearsamppTools->getConsoleZ()->getTabTitleRuby(),
                self::ICON_RUBY,
                $shell,
                $bearsamppRoot->getWwwPath()
            ) . PHP_EOL;
    }

References $bearsamppRoot, and getTab().

Referenced by getTabsSection().

Here is the caller graph for this function:

◆ getTabsSection()

static TplConsoleZ::getTabsSection ( )

staticprivate

Generates the XML structure for the tabs section.

This function creates an XML 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, Yarn, and Ngrok.

Returns: string The formatted XML string for the tabs section.

Definition at line 290 of file class.tpl.consolez.php.

    {
        return self::getIncrStr(1) . '<tabs>' . PHP_EOL .
            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::getTabYarnSection() .
            self::getTabNgrokSection() .
            self::getIncrStr(1) . '</tabs>';
    }

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

Referenced by process().

Here is the caller graph for this function:

◆ getTabYarnSection()

static TplConsoleZ::getTabYarnSection ( )

staticprivate

Generates the XML structure for the Yarn tab section.

This function creates an XML structure defining the Yarn tab and its configuration. It retrieves the Yarn executable path and sets the WWW path.

Returns: string The formatted XML string for the Yarn tab section. @global Tools $bearsamppTools The tools object of the application.

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

Definition at line 634 of file class.tpl.consolez.php.

    {
        global $bearsamppRoot, $bearsamppTools;
 
        $shell = $bearsamppTools->getConsoleZ()->getShell('&quot;' . $bearsamppTools->getYarn()->getExe() . '&quot; --version');
        if (!file_exists($bearsamppTools->getYarn()->getExe())) {
            $shell = $bearsamppTools->getConsoleZ()->getShell('echo ' . $bearsamppTools->getYarn()->getExe() . ' not found');
        }
 
        return self::getTab(
                $bearsamppTools->getConsoleZ()->getTabTitleYarn(),
                self::ICON_YARN,
                $shell,
                $bearsamppRoot->getWwwPath()
            ) . PHP_EOL;
    }

References $bearsamppRoot, and getTab().

Referenced by getTabsSection().

Here is the caller graph for this function:

◆ process()

static TplConsoleZ::process ( )

static

Generates the ConsoleZ configuration file.

This method constructs the XML structure for the ConsoleZ configuration by calling various helper methods to generate different sections of the configuration. The resulting XML is then written to the configuration file.

Definition at line 47 of file class.tpl.consolez.php.

    {
        global $bearsamppTools;
        $result = '<?xml version="1.0"?>' . PHP_EOL . '<settings>' . PHP_EOL .
            self::getConsoleSection() . PHP_EOL .
            self::getAppearanceSection() . PHP_EOL .
            self::getBehaviorSection() . PHP_EOL .
            self::getHotkeysSection() . PHP_EOL .
            self::getMouseSection() . PHP_EOL .
            self::getTabsSection() . PHP_EOL .
            '</settings>';
 
        file_put_contents($bearsamppTools->getConsoleZ()->getConf(), $result);
    }

References $result, getAppearanceSection(), getBehaviorSection(), getConsoleSection(), getHotkeysSection(), getMouseSection(), and getTabsSection().

Referenced by ActionReload\__construct().

Here is the caller graph for this function:

Field Documentation

◆ ICON_APP

const TplConsoleZ::ICON_APP = 'app.ico'

Definition at line 19 of file class.tpl.consolez.php.

◆ ICON_COMPOSER

const TplConsoleZ::ICON_COMPOSER = 'composer.ico'

Definition at line 26 of file class.tpl.consolez.php.

◆ ICON_DB

const TplConsoleZ::ICON_DB = 'db.ico'

Definition at line 22 of file class.tpl.consolez.php.

◆ ICON_GHOSTSCRIPT

const TplConsoleZ::ICON_GHOSTSCRIPT = 'ghostscript.ico'

Definition at line 23 of file class.tpl.consolez.php.

◆ ICON_GIT

const TplConsoleZ::ICON_GIT = 'git.ico'

Definition at line 24 of file class.tpl.consolez.php.

◆ ICON_NGROK

const TplConsoleZ::ICON_NGROK = 'ngrok.ico'

Definition at line 31 of file class.tpl.consolez.php.

◆ ICON_NODEJS

const TplConsoleZ::ICON_NODEJS = 'nodejs.ico'

Definition at line 25 of file class.tpl.consolez.php.

◆ ICON_PEAR

const TplConsoleZ::ICON_PEAR = 'pear.ico'

Definition at line 21 of file class.tpl.consolez.php.

◆ ICON_PERL

const TplConsoleZ::ICON_PERL = 'perl.ico'

Definition at line 30 of file class.tpl.consolez.php.

◆ ICON_POWERSHELL

const TplConsoleZ::ICON_POWERSHELL = 'powershell.ico'

Definition at line 20 of file class.tpl.consolez.php.

◆ ICON_PYTHON

const TplConsoleZ::ICON_PYTHON = 'python.ico'

Definition at line 27 of file class.tpl.consolez.php.

◆ ICON_RUBY

const TplConsoleZ::ICON_RUBY = 'ruby.ico'

Definition at line 28 of file class.tpl.consolez.php.

◆ ICON_YARN

const TplConsoleZ::ICON_YARN = 'yarn.ico'

Definition at line 29 of file class.tpl.consolez.php.

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

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

Static Public Member Functions

Data Fields

Private Member Functions

Static Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getAppearanceSection()

◆ getBehaviorSection()

◆ getConsoleSection()

◆ getHotkeysSection()

◆ getIncrStr()

◆ getMouseSection()

◆ getTab()

◆ getTabCmdSection()

◆ getTabComposerSection()

◆ getTabGhostscriptSection()

◆ getTabGitSection()

◆ getTabMariadbSection()

◆ getTabMysqlSection()

◆ getTabNgrokSection()

◆ getTabNodejsSection()

◆ getTabPearSection()

◆ getTabPerlSection()

◆ getTabPostgresqlSection()

◆ getTabPowerShellSection()

◆ getTabPythonSection()

◆ getTabRubySection()

◆ getTabsSection()

◆ getTabYarnSection()

◆ process()

Field Documentation

◆ ICON_APP

◆ ICON_COMPOSER

◆ ICON_DB

◆ ICON_GHOSTSCRIPT

◆ ICON_GIT

◆ ICON_NGROK

◆ ICON_NODEJS

◆ ICON_PEAR

◆ ICON_PERL

◆ ICON_POWERSHELL

◆ ICON_PYTHON

◆ ICON_RUBY

◆ ICON_YARN