ToolGit Class Reference

Inheritance diagram for ToolGit:

Collaboration diagram for ToolGit:

Public Member Functions
	__construct ($id, $type)
	findRepos ($cache=true)
	getBash ()
	getExe ()
	getRepos ()
	isScanStartup ()
	reload ($id=null, $type=null)
	setScanStartup ($scanStartup)
	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_BASH = 'gitBash'
const	LOCAL_CFG_EXE = 'gitExe'
const	LOCAL_CFG_SCAN_STARTUP = 'gitScanStartup'
const	REPOS_CACHE_FILE = 'reposCache.dat'
const	REPOS_FILE = 'repos.dat'
const	ROOT_CFG_VERSION = 'gitVersion'
Data Fields inherited from Module
	$currentPath
	$rootPath
	$symlinkPath

Protected Member Functions
	updateConfig ($version=null, $sub=0, $showWindow=false)
Protected Member Functions inherited from Module
	__construct ()
	replace ($key, $value)
	replaceAll ($params)

Private Attributes
	$bash
	$exe
	$repos
	$reposCacheFile
	$reposFile
	$scanStartup

Additional Inherited Members
Static Public Member Functions inherited from Module
static	clearMemoryCache ()
static	invalidateConfigCacheForPath ($sourcePath)
Protected Attributes inherited from Module
	$bearsamppConf
	$bearsamppConfRaw
	$enable
	$name
	$release = 'N/A'
	$version

Detailed Description

Class ToolGit

This class represents the Git tool module in the Bearsampp application. It handles the configuration, initialization, and management of Git-related settings and repositories.

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

Constructor & Destructor Documentation

__construct()

__construct	(		$id,
			$type )

Constructs a ToolGit object and initializes the Git tool module.

Parameters

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

Definition at line 77 of file class.tool.git.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

findRepos()

findRepos

(

$cache = true

)

Finds Git repositories either from cache or by scanning the directories.

Parameters

bool

$cache

Whether to use the cached repositories list.

Returns

array The list of found repositories.

Definition at line 188 of file class.tool.git.php.

    {
        $result = array();
 
        if ($cache) {
            if (file_exists($this->reposCacheFile)) {
                $repos = file($this->reposCacheFile);
                foreach ($repos as $repo) {
                    array_push($result, trim($repo));
                }
            }
        } else {
            if (!empty($this->repos)) {
                foreach ($this->repos as $repo) {
                    $foundRepos = Util::findRepos($repo, $repo, '.git/config');
                    if (!empty($foundRepos)) {
                        foreach ($foundRepos as $foundRepo) {
                            array_push($result, $foundRepo);
                        }
                    }
                }
            }
            $strResult = implode(PHP_EOL, $result);
            file_put_contents($this->reposCacheFile, $strResult);
        }
 
        return $result;
    }

References $repos, $result, and Util\findRepos().

Here is the call graph for this function:

getBash()

getBash

(

)

Retrieves the path to the Git Bash executable.

Returns

string The path to the Git Bash executable.

Definition at line 255 of file class.tool.git.php.

    {
        return $this->bash;
    }

References $bash.

Referenced by updateConfig().

Here is the caller graph for this function:

getExe()

getExe

(

)

Retrieves the path to the Git executable.

Returns

string The path to the Git executable.

Definition at line 245 of file class.tool.git.php.

    {
        return $this->exe;
    }

References $exe.

Referenced by updateConfig().

Here is the caller graph for this function:

getRepos()

getRepos

(

)

Retrieves the list of repositories.

Returns

array The list of repositories.

Definition at line 235 of file class.tool.git.php.

    {
        return $this->repos;
    }

References $repos.

isScanStartup()

isScanStartup

(

)

Checks if the Git tool module is set to scan repositories at startup.

Returns

bool True if set to scan at startup, false otherwise.

Definition at line 265 of file class.tool.git.php.

    {
        return $this->scanStartup == Config::ENABLED;
    }

References Config\ENABLED.

reload()

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

Reloads the Git tool module configuration based on the provided ID and type.

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 89 of file class.tool.git.php.

    {
        global $bearsamppRoot, $bearsamppConfig, $bearsamppLang;
        Log::reloadClass($this);
 
        $this->name    = $bearsamppLang->getValue(Lang::GIT);
        $this->version = $bearsamppConfig->getRaw(self::ROOT_CFG_VERSION);
        parent::reload($id, $type);
 
        $this->reposFile      = $this->symlinkPath . '/' . self::REPOS_FILE;
        $this->reposCacheFile = $this->symlinkPath . '/' . self::REPOS_CACHE_FILE;
 
        if ($this->bearsamppConfRaw !== false) {
            $this->exe         = $this->symlinkPath . '/' . $this->bearsamppConfRaw[self::LOCAL_CFG_EXE];
            $this->bash        = $this->symlinkPath . '/' . $this->bearsamppConfRaw[self::LOCAL_CFG_BASH];
            $this->scanStartup = $this->bearsamppConfRaw[self::LOCAL_CFG_SCAN_STARTUP];
        }
 
        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->reposFile)) {
            Log::error(sprintf($bearsamppLang->getValue(Lang::ERROR_CONF_NOT_FOUND), $this->name . ' ' . $this->version, $this->reposFile));
        }
        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->bash)) {
            Log::error(sprintf($bearsamppLang->getValue(Lang::ERROR_EXE_NOT_FOUND), $this->name . ' ' . $this->version, $this->bash));
        }
 
        if (is_file($this->reposFile)) {
            $this->repos  = explode(PHP_EOL, file_get_contents($this->reposFile));
            $rebuildRepos = array();
            foreach ($this->repos as $repo) {
                $repo = trim($repo);
                if (stripos($repo, ':') === false) {
                    $repo = Path::getRootPath() . '/' . $repo;
                }
                if (is_dir($repo)) {
                    $rebuildRepos[] = Path::formatUnixPath($repo);
                } else {
                    Log::warning($this->name . ' repository not found: ' . $repo);
                }
            }
            $this->repos = $rebuildRepos;
        }
    }

References $bearsamppConfig, $bearsamppLang, $bearsamppRoot, Module\$id, Module\$type, Log\error(), Lang\ERROR_CONF_NOT_FOUND, Lang\ERROR_EXE_NOT_FOUND, Lang\ERROR_FILE_NOT_FOUND, Path\formatUnixPath(), Path\getRootPath(), Lang\GIT, Log\info(), Log\reloadClass(), and Log\warning().

Referenced by __construct(), and setVersion().

Here is the call graph for this function:

Here is the caller graph for this function:

setScanStartup()

setScanStartup

(

$scanStartup

)

Sets whether the Git tool module should scan repositories at startup.

Parameters

bool

$scanStartup

True to enable scanning at startup, false to disable.

Definition at line 275 of file class.tool.git.php.

    {
        $this->scanStartup = intval($scanStartup) === Config::ENABLED ? Config::ENABLED : Config::DISABLED;
        Util::replaceInFile($this->bearsamppConf, array(
            '/^' . self::LOCAL_CFG_SCAN_STARTUP . '/' => self::LOCAL_CFG_SCAN_STARTUP . ' = "' . $this->scanStartup . '"'
        ));
    }

References $scanStartup, Config\DISABLED, Config\ENABLED, and Util\replaceInFile().

Here is the call graph for this function:

setVersion()

setVersion

(

$version

)

Sets the version of the Git tool module.

Parameters

string

$version

The version to set.

Reimplemented from Module.

Definition at line 222 of file class.tool.git.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:

updateConfig()

updateConfig ( $version = null, $sub = 0, $showWindow = false )

protected

Updates the Git tool module configuration with a specific version.

Parameters

string | null	$version	The version to update to. If null, the current version is used.
int	$sub	The sub-level for logging indentation.
bool	$showWindow	Whether to show a window during the update process.

Returns

bool True if the update was successful, false otherwise.

Reimplemented from Module.

Definition at line 160 of file class.tool.git.php.

    {
        global $bearsamppWinbinder;
 
        if (!$this->enable) {
            return true;
        }
 
        $version = $version == null ? $this->version : $version;
        Log::debug(($sub > 0 ? str_repeat(' ', 2 * $sub) : '') . 'Update ' . $this->name . ' ' . $version . ' config');
 
        if (file_exists(Path::getModuleSymlinkPath($this) . '/post-install.bat')) {
            $bearsamppWinbinder->exec($this->getBash(), '--no-needs-console --hide --no-cd --command="' . Path::getModuleSymlinkPath($this) . '/post-install.bat"', true);
        }
 
        $bearsamppWinbinder->exec($this->getExe(), 'config --global core.autocrlf false', true);
        $bearsamppWinbinder->exec($this->getExe(), 'config --global core.eol lf', true);
 
        return true;
    }

References Module\$version, Log\debug(), getBash(), getExe(), and Path\getModuleSymlinkPath().

Here is the call graph for this function:

Field Documentation

$bash

$bash

private

Definition at line 65 of file class.tool.git.php.

Referenced by getBash().

$exe

$exe

private

Definition at line 61 of file class.tool.git.php.

Referenced by getExe().

$repos

$repos

private

Definition at line 56 of file class.tool.git.php.

Referenced by findRepos(), and getRepos().

$reposCacheFile

$reposCacheFile

private

Definition at line 52 of file class.tool.git.php.

$reposFile

$reposFile

private

Definition at line 48 of file class.tool.git.php.

$scanStartup

$scanStartup

private

Definition at line 69 of file class.tool.git.php.

Referenced by setScanStartup().

LOCAL_CFG_BASH

const LOCAL_CFG_BASH = 'gitBash'

Configuration key for the Git Bash executable in the local configuration.

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

LOCAL_CFG_EXE

const LOCAL_CFG_EXE = 'gitExe'

Configuration key for the Git executable in the local configuration.

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

LOCAL_CFG_SCAN_STARTUP

const LOCAL_CFG_SCAN_STARTUP = 'gitScanStartup'

Configuration key for the Git scan-at-startup flag in the local configuration.

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

REPOS_CACHE_FILE

const REPOS_CACHE_FILE = 'reposCache.dat'

The file name of the repositories cache.

Definition at line 43 of file class.tool.git.php.

REPOS_FILE

const REPOS_FILE = 'repos.dat'

The file name of the repositories list.

Definition at line 39 of file class.tool.git.php.

ROOT_CFG_VERSION

const ROOT_CFG_VERSION = 'gitVersion'

Configuration key for the Git version in the root configuration.

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

---

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

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